// Copyright (c) ppy Pty Ltd . Licensed under the MIT Licence. // See the LICENCE file in the repository root for full licence text. using System; using osu.Framework.Allocation; using osu.Framework.Bindables; using osu.Framework.Extensions.ObjectExtensions; using osu.Framework.Graphics; using osu.Framework.Graphics.Sprites; using osu.Framework.Screens; using osu.Game.Online.API; using osu.Game.Online.Metadata; using osu.Game.Online.Multiplayer; using osu.Game.Online.Notifications.WebSocket; using osu.Game.Online.Spectator; using osu.Game.Overlays; using osu.Game.Overlays.Notifications; using osu.Game.Screens.OnlinePlay; namespace osu.Game.Online { /// /// Handles various scenarios where connection is lost and we need to let the user know what and why. /// public partial class OnlineStatusNotifier : Component { private readonly Func getCurrentScreen; private INotificationsClient notificationsClient = null!; [Resolved] private MultiplayerClient multiplayerClient { get; set; } = null!; [Resolved] private SpectatorClient spectatorClient { get; set; } = null!; [Resolved] private MetadataClient metadataClient { get; set; } = null!; [Resolved] private INotificationOverlay? notificationOverlay { get; set; } private IBindable apiState = null!; private IBindable multiplayerState = null!; private IBindable spectatorState = null!; /// /// This flag will be set to true when the user has been notified so we don't show more than one notification. /// private bool userNotified; public OnlineStatusNotifier(Func getCurrentScreen) { this.getCurrentScreen = getCurrentScreen; } [BackgroundDependencyLoader] private void load(IAPIProvider api) { apiState = api.State.GetBoundCopy(); notificationsClient = api.NotificationsClient; multiplayerState = multiplayerClient.IsConnected.GetBoundCopy(); spectatorState = spectatorClient.IsConnected.GetBoundCopy(); notificationsClient.MessageReceived += notifyAboutForcedDisconnection; multiplayerClient.Disconnecting += notifyAboutForcedDisconnection; spectatorClient.Disconnecting += notifyAboutForcedDisconnection; metadataClient.Disconnecting += notifyAboutForcedDisconnection; } protected override void LoadComplete() { base.LoadComplete(); apiState.BindValueChanged(state => { if (state.NewValue == APIState.Online) { userNotified = false; return; } if (userNotified) return; if (state.NewValue == APIState.Offline && getCurrentScreen() is OnlinePlayScreen) { userNotified = true; notificationOverlay?.Post(new SimpleErrorNotification { Icon = FontAwesome.Solid.ExclamationCircle, Text = "Connection to API was lost. Can't continue with online play." }); } }); multiplayerState.BindValueChanged(connected => Schedule(() => { if (connected.NewValue) { userNotified = false; return; } if (userNotified) return; if (multiplayerClient.Room != null) { userNotified = true; notificationOverlay?.Post(new SimpleErrorNotification { Icon = FontAwesome.Solid.ExclamationCircle, Text = "Connection to the multiplayer server was lost. Exiting multiplayer." }); } })); spectatorState.BindValueChanged(_ => { // TODO: handle spectator server failure somehow? }); } private void notifyAboutForcedDisconnection() { if (userNotified) return; userNotified = true; notificationOverlay?.Post(new SimpleErrorNotification { Icon = FontAwesome.Solid.ExclamationCircle, Text = "You have been logged out on this device due to a login to your account on another device." }); } private void notifyAboutForcedDisconnection(SocketMessage obj) { if (obj.Event != @"logout") return; if (userNotified) return; userNotified = true; notificationOverlay?.Post(new SimpleErrorNotification { Icon = FontAwesome.Solid.ExclamationCircle, Text = "You have been logged out due to a change to your account. Please log in again." }); } protected override void Dispose(bool isDisposing) { base.Dispose(isDisposing); if (notificationsClient.IsNotNull()) notificationsClient.MessageReceived += notifyAboutForcedDisconnection; if (spectatorClient.IsNotNull()) spectatorClient.Disconnecting -= notifyAboutForcedDisconnection; if (multiplayerClient.IsNotNull()) multiplayerClient.Disconnecting -= notifyAboutForcedDisconnection; if (metadataClient.IsNotNull()) metadataClient.Disconnecting -= notifyAboutForcedDisconnection; } } }