Merge pull request #25005 from minetoblend/multiplayer-invites

Add ability to invite players to multiplayer rooms

Author: bdach

osu.Game.Benchmarks/osu.Game.Benchmarks.csproj

@@ -7,7 +7,7 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="BenchmarkDotNet" Version="0.13.8" />
+    <PackageReference Include="BenchmarkDotNet" Version="0.13.9" />
     <PackageReference Include="nunit" Version="3.13.3" />
     <PackageReference Include="NUnit3TestAdapter" Version="4.5.0" />
   </ItemGroup>

osu.Game.Tests/Visual/UserInterface/TestSceneNotificationOverlay.cs

@@ -5,11 +5,13 @@
 using System.Collections.Generic;
 using System.Linq;
 using NUnit.Framework;
+using osu.Framework.Extensions;
 using osu.Framework.Graphics;
 using osu.Framework.Graphics.Containers;
 using osu.Framework.Graphics.Sprites;
 using osu.Framework.Testing;
 using osu.Framework.Utils;
+using osu.Game.Database;
 using osu.Game.Graphics.Sprites;
 using osu.Game.Online.Multiplayer;
 using osu.Game.Overlays;
@@ -31,6 +33,8 @@ public partial class TestSceneNotificationOverlay : OsuManualInputManagerTestSce
 
         public double TimeToCompleteProgress { get; set; } = 2000;
 
+        private readonly UserLookupCache userLookupCache = new TestUserLookupCache();
+
         [SetUp]
         public void SetUp() => Schedule(() =>
         {
@@ -60,6 +64,7 @@ public void TestBasicFlow()
             AddStep(@"simple #2", sendAmazingNotification);
             AddStep(@"progress #1", sendUploadProgress);
             AddStep(@"progress #2", sendDownloadProgress);
+            AddStep(@"User notification", sendUserNotification);
 
             checkProgressingCount(2);
 
@@ -537,6 +542,16 @@ private void sendDownloadProgress()
             progressingNotifications.Add(n);
         }
 
+        private void sendUserNotification()
+        {
+            var user = userLookupCache.GetUserAsync(0).GetResultSafely();
+            if (user == null) return;
+
+            var n = new UserAvatarNotification(user, $"{user.Username} invited you to a multiplayer match!");
+
+            notificationOverlay.Post(n);
+        }
+
         private void sendUploadProgress()
         {
             var n = new ProgressNotification

osu.Game/Localisation/ContextMenuStrings.cs

@@ -19,6 +19,11 @@ public static class ContextMenuStrings
         /// </summary>
         public static LocalisableString ViewBeatmap => new TranslatableString(getKey(@"view_beatmap"), @"View beatmap");
 
+        /// <summary>
+        /// "Invite player"
+        /// </summary>
+        public static LocalisableString InvitePlayer => new TranslatableString(getKey(@"invite_player"), @"Invite player");
+
         private static string getKey(string key) => $@"{prefix}:{key}";
     }
 }

osu.Game/Localisation/NotificationsStrings.cs

@@ -93,6 +93,11 @@ public static class NotificationsStrings
         /// </summary>
         public static LocalisableString YourNameWasMentioned(string username) => new TranslatableString(getKey(@"your_name_was_mentioned"), @"Your name was mentioned in chat by '{0}'. Click to find out why!", username);
 
+        /// <summary>
+        /// "{0} invited you to the multiplayer match &quot;{1}&quot;! Click to join."
+        /// </summary>
+        public static LocalisableString InvitedYouToTheMultiplayer(string username, string roomName) => new TranslatableString(getKey(@"invited_you_to_the_multiplayer"), @"{0} invited you to the multiplayer match ""{1}""! Click to join.", username, roomName);
+
         /// <summary>
         /// "You do not have the beatmap for this replay."
         /// </summary>

osu.Game/Localisation/OnlinePlayStrings.cs

@@ -14,6 +14,16 @@ public static class OnlinePlayStrings
         /// </summary>
         public static LocalisableString SupporterOnlyDurationNotice => new TranslatableString(getKey(@"supporter_only_duration_notice"), @"Playlist durations longer than 2 weeks require an active osu!supporter tag.");
 
+        /// <summary>
+        /// "Can&#39;t invite this user as you have blocked them or they have blocked you."
+        /// </summary>
+        public static LocalisableString InviteFailedUserBlocked => new TranslatableString(getKey(@"cant_invite_this_user_as"), @"Can't invite this user as you have blocked them or they have blocked you.");
+
+        /// <summary>
+        /// "Can&#39;t invite this user as they have opted out of non-friend communications."
+        /// </summary>
+        public static LocalisableString InviteFailedUserOptOut => new TranslatableString(getKey(@"cant_invite_this_user_as1"), @"Can't invite this user as they have opted out of non-friend communications.");
+
         private static string getKey(string key) => $@"{prefix}:{key}";
     }
 }

osu.Game/Online/Multiplayer/IMultiplayerClient.cs

@@ -42,6 +42,14 @@ public interface IMultiplayerClient
         /// <param name="user">The user.</param>
         Task UserKicked(MultiplayerRoomUser user);
 
+        /// <summary>
+        /// Signals that the local user has been invited into a multiplayer room.
+        /// </summary>
+        /// <param name="invitedBy">Id of user that invited the player.</param>
+        /// <param name="roomID">Id of the room the user got invited to.</param>
+        /// <param name="password">Password to join the room.</param>
+        Task Invited(int invitedBy, long roomID, string password);
+
         /// <summary>
         /// Signal that the host of the room has changed.
         /// </summary>

osu.Game/Online/Multiplayer/IMultiplayerRoomServer.cs

@@ -99,5 +99,13 @@ public interface IMultiplayerRoomServer
         /// </summary>
         /// <param name="playlistItemId">The item to remove.</param>
         Task RemovePlaylistItem(long playlistItemId);
+
+        /// <summary>
+        /// Invites a player to the current room.
+        /// </summary>
+        /// <param name="userId">The user to invite.</param>
+        /// <exception cref="UserBlockedException">The user has blocked or has been blocked by the invited user.</exception>
+        /// <exception cref="UserBlocksPMsException">The invited user does not accept private messages.</exception>
+        Task InvitePlayer(int userId);
     }
 }

osu.Game/Online/Multiplayer/MultiplayerClient.cs

@@ -23,13 +23,16 @@
 using osu.Game.Rulesets;
 using osu.Game.Rulesets.Mods;
 using osu.Game.Utils;
+using osu.Game.Localisation;
 
 namespace osu.Game.Online.Multiplayer
 {
     public abstract partial class MultiplayerClient : Component, IMultiplayerClient, IMultiplayerRoomServer
     {
         public Action<Notification>? PostNotification { protected get; set; }
 
+        public Action<Room, string>? PresentMatch { protected get; set; }
+
         /// <summary>
         /// Invoked when any change occurs to the multiplayer room.
         /// </summary>
@@ -260,6 +263,8 @@ public Task LeaveRoom()
 
         protected abstract Task LeaveRoomInternal();
 
+        public abstract Task InvitePlayer(int userId);
+
         /// <summary>
         /// Change the current <see cref="MultiplayerRoom"/> settings.
         /// </summary>
@@ -440,6 +445,38 @@ Task IMultiplayerClient.UserKicked(MultiplayerRoomUser user)
             return handleUserLeft(user, UserKicked);
         }
 
+        async Task IMultiplayerClient.Invited(int invitedBy, long roomID, string password)
+        {
+            APIUser? apiUser = await userLookupCache.GetUserAsync(invitedBy).ConfigureAwait(false);
+            Room? apiRoom = await getRoomAsync(roomID).ConfigureAwait(false);
+
+            if (apiUser == null || apiRoom == null) return;
+
+            PostNotification?.Invoke(
+                new UserAvatarNotification(apiUser, NotificationsStrings.InvitedYouToTheMultiplayer(apiUser.Username, apiRoom.Name.Value))
+                {
+                    Activated = () =>
+                    {
+                        PresentMatch?.Invoke(apiRoom, password);
+                        return true;
+                    }
+                }
+            );
+
+            Task<Room?> getRoomAsync(long id)
+            {
+                TaskCompletionSource<Room?> taskCompletionSource = new TaskCompletionSource<Room?>();
+
+                var request = new GetRoomRequest(id);
+                request.Success += room => taskCompletionSource.TrySetResult(room);
+                request.Failure += _ => taskCompletionSource.TrySetResult(null);
+
+                API.Queue(request);
+
+                return taskCompletionSource.Task;
+            }
+        }
+
         private void addUserToAPIRoom(MultiplayerRoomUser user)
         {
             Debug.Assert(APIRoom != null);

osu.Game/Online/Multiplayer/OnlineMultiplayerClient.cs

@@ -12,6 +12,8 @@
 using osu.Framework.Bindables;
 using osu.Game.Online.API;
 using osu.Game.Online.Rooms;
+using osu.Game.Overlays.Notifications;
+using osu.Game.Localisation;
 
 namespace osu.Game.Online.Multiplayer
 {
@@ -50,6 +52,7 @@ private void load(IAPIProvider api)
                     connection.On<MultiplayerRoomUser>(nameof(IMultiplayerClient.UserJoined), ((IMultiplayerClient)this).UserJoined);
                     connection.On<MultiplayerRoomUser>(nameof(IMultiplayerClient.UserLeft), ((IMultiplayerClient)this).UserLeft);
                     connection.On<MultiplayerRoomUser>(nameof(IMultiplayerClient.UserKicked), ((IMultiplayerClient)this).UserKicked);
+                    connection.On<int, long, string>(nameof(IMultiplayerClient.Invited), ((IMultiplayerClient)this).Invited);
                     connection.On<int>(nameof(IMultiplayerClient.HostChanged), ((IMultiplayerClient)this).HostChanged);
                     connection.On<MultiplayerRoomSettings>(nameof(IMultiplayerClient.SettingsChanged), ((IMultiplayerClient)this).SettingsChanged);
                     connection.On<int, MultiplayerUserState>(nameof(IMultiplayerClient.UserStateChanged), ((IMultiplayerClient)this).UserStateChanged);
@@ -106,6 +109,32 @@ protected override Task LeaveRoomInternal()
             return connection.InvokeAsync(nameof(IMultiplayerServer.LeaveRoom));
         }
 
+        public override async Task InvitePlayer(int userId)
+        {
+            if (!IsConnected.Value)
+                return;
+
+            Debug.Assert(connection != null);
+
+            try
+            {
+                await connection.InvokeAsync(nameof(IMultiplayerServer.InvitePlayer), userId).ConfigureAwait(false);
+            }
+            catch (HubException exception)
+            {
+                switch (exception.GetHubExceptionMessage())
+                {
+                    case UserBlockedException.MESSAGE:
+                        PostNotification?.Invoke(new SimpleErrorNotification { Text = OnlinePlayStrings.InviteFailedUserBlocked });
+                        break;
+
+                    case UserBlocksPMsException.MESSAGE:
+                        PostNotification?.Invoke(new SimpleErrorNotification { Text = OnlinePlayStrings.InviteFailedUserOptOut });
+                        break;
+                }
+            }
+        }
+
         public override Task TransferHost(int userId)
         {
             if (!IsConnected.Value)

osu.Game/Online/Multiplayer/UserBlockedException.cs

@@ -0,0 +1,25 @@
+// Copyright (c) ppy Pty Ltd <contact@ppy.sh>. Licensed under the MIT Licence.
+// See the LICENCE file in the repository root for full licence text.
+
+using System;
+using System.Runtime.Serialization;
+using Microsoft.AspNetCore.SignalR;
+
+namespace osu.Game.Online.Multiplayer
+{
+    [Serializable]
+    public class UserBlockedException : HubException
+    {
+        public const string MESSAGE = @"Cannot perform action due to user being blocked.";
+
+        public UserBlockedException()
+            : base(MESSAGE)
+        {
+        }
+
+        protected UserBlockedException(SerializationInfo info, StreamingContext context)
+            : base(info, context)
+        {
+        }
+    }
+}

osu.Game/Online/Multiplayer/UserBlocksPMsException.cs

@@ -0,0 +1,25 @@
+// Copyright (c) ppy Pty Ltd <contact@ppy.sh>. Licensed under the MIT Licence.
+// See the LICENCE file in the repository root for full licence text.
+
+using System;
+using System.Runtime.Serialization;
+using Microsoft.AspNetCore.SignalR;
+
+namespace osu.Game.Online.Multiplayer
+{
+    [Serializable]
+    public class UserBlocksPMsException : HubException
+    {
+        public const string MESSAGE = "Cannot perform action because user has disabled non-friend communications.";
+
+        public UserBlocksPMsException()
+            : base(MESSAGE)
+        {
+        }
+
+        protected UserBlocksPMsException(SerializationInfo info, StreamingContext context)
+            : base(info, context)
+        {
+        }
+    }
+}

osu.Game/OsuGame.cs

@@ -46,6 +46,7 @@
 using osu.Game.Localisation;
 using osu.Game.Online;
 using osu.Game.Online.Chat;
+using osu.Game.Online.Rooms;
 using osu.Game.Overlays;
 using osu.Game.Overlays.BeatmapListing;
 using osu.Game.Overlays.Music;
@@ -58,6 +59,7 @@
 using osu.Game.Scoring;
 using osu.Game.Screens;
 using osu.Game.Screens.Menu;
+using osu.Game.Screens.OnlinePlay.Multiplayer;
 using osu.Game.Screens.Play;
 using osu.Game.Screens.Ranking;
 using osu.Game.Screens.Select;
@@ -643,6 +645,24 @@ public void PresentBeatmap(IBeatmapSetInfo beatmap, Predicate<BeatmapInfo> diffi
             });
         }
 
+        /// <summary>
+        /// Join a multiplayer match immediately.
+        /// </summary>
+        /// <param name="room">The room to join.</param>
+        /// <param name="password">The password to join the room, if any is given.</param>
+        public void PresentMultiplayerMatch(Room room, string password)
+        {
+            PerformFromScreen(screen =>
+            {
+                if (!(screen is Multiplayer multiplayer))
+                    screen.Push(multiplayer = new Multiplayer());
+
+                multiplayer.Join(room, password);
+            });
+            // TODO: We should really be able to use `validScreens: new[] { typeof(Multiplayer) }` here
+            // but `PerformFromScreen` doesn't understand nested stacks.
+        }
+
         /// <summary>
         /// Present a score's replay immediately.
         /// The user should have already requested this interactively.
@@ -853,6 +873,7 @@ protected override void LoadComplete()
             ScoreManager.PresentImport = items => PresentScore(items.First().Value);
 
             MultiplayerClient.PostNotification = n => Notifications.Post(n);
+            MultiplayerClient.PresentMatch = PresentMultiplayerMatch;
 
             // make config aware of how to lookup skins for on-screen display purposes.
             // if this becomes a more common thing, tracked settings should be reconsidered to allow local DI.

osu.Game/Overlays/Dashboard/CurrentlyPlayingDisplay.cs

@@ -119,7 +119,7 @@ private void onPlayingUsersChanged(object sender, NotifyCollectionChangedEventAr
                     {
                         users.GetUserAsync(userId).ContinueWith(task =>
                         {
-                            var user = task.GetResultSafely();
+                            APIUser user = task.GetResultSafely();
 
                             if (user == null)
                                 return;
@@ -130,6 +130,9 @@ private void onPlayingUsersChanged(object sender, NotifyCollectionChangedEventAr
                                 if (!playingUsers.Contains(user.Id))
                                     return;
 
+                                // TODO: remove this once online state is being updated more correctly.
+                                user.IsOnline = true;
+
                                 userFlow.Add(createUserPanel(user));
                             });
                         });

osu.Game/Overlays/NotificationOverlay.cs

@@ -113,7 +113,8 @@ private void load()
                                     RelativeSizeAxes = Axes.X,
                                     Children = new[]
                                     {
-                                        new NotificationSection(AccountsStrings.NotificationsTitle, new[] { typeof(SimpleNotification) }),
+                                        // The main section adds as a catch-all for notifications which don't group into other sections.
+                                        new NotificationSection(AccountsStrings.NotificationsTitle),
                                         new NotificationSection(NotificationsStrings.RunningTasks, new[] { typeof(ProgressNotification) }),
                                     }
                                 }
@@ -205,7 +206,8 @@ private void addPermanently(Notification notification)
             var ourType = notification.GetType();
             int depth = notification.DisplayOnTop ? -runningDepth : runningDepth;
 
-            var section = sections.Children.First(s => s.AcceptedNotificationTypes.Any(accept => accept.IsAssignableFrom(ourType)));
+            var section = sections.Children.FirstOrDefault(s => s.AcceptedNotificationTypes?.Any(accept => accept.IsAssignableFrom(ourType)) == true)
+                          ?? sections.First();
 
             section.Add(notification, depth);