From 2ca11d458a3ea885ebdae8a033fd0c9eda984317 Mon Sep 17 00:00:00 2001
From: Dean Herbert <pe@ppy.sh>
Date: Fri, 9 Jul 2021 00:53:10 +0900
Subject: [PATCH] Add password to room settings and multiplayer lounge
 interface

---
 .../Multiplayer/IMultiplayerLoungeServer.cs   | 10 +++++++++
 .../Multiplayer/InvalidPasswordException.cs   | 22 +++++++++++++++++++
 .../Online/Multiplayer/MultiplayerClient.cs   |  2 ++
 .../Multiplayer/MultiplayerRoomSettings.cs    |  5 +++++
 4 files changed, 39 insertions(+)
 create mode 100644 osu.Game/Online/Multiplayer/InvalidPasswordException.cs

diff --git a/osu.Game/Online/Multiplayer/IMultiplayerLoungeServer.cs b/osu.Game/Online/Multiplayer/IMultiplayerLoungeServer.cs
index 4640640c5f..a04ec53578 100644
--- a/osu.Game/Online/Multiplayer/IMultiplayerLoungeServer.cs
+++ b/osu.Game/Online/Multiplayer/IMultiplayerLoungeServer.cs
@@ -15,6 +15,16 @@ namespace osu.Game.Online.Multiplayer
         /// </summary>
         /// <param name="roomId">The databased room ID.</param>
         /// <exception cref="InvalidStateException">If the user is already in the requested (or another) room.</exception>
+        /// <exception cref="InvalidPasswordException">If the room required a password.</exception>
         Task<MultiplayerRoom> JoinRoom(long roomId);
+
+        /// <summary>
+        /// Request to join a multiplayer room with a provided password.
+        /// </summary>
+        /// <param name="roomId">The databased room ID.</param>
+        /// <param name="password">The password for the join request.</param>
+        /// <exception cref="InvalidStateException">If the user is already in the requested (or another) room.</exception>
+        /// <exception cref="InvalidPasswordException">If the room provided password was incorrect.</exception>
+        Task<MultiplayerRoom> JoinRoom(long roomId, string password);
     }
 }
diff --git a/osu.Game/Online/Multiplayer/InvalidPasswordException.cs b/osu.Game/Online/Multiplayer/InvalidPasswordException.cs
new file mode 100644
index 0000000000..0441aea287
--- /dev/null
+++ b/osu.Game/Online/Multiplayer/InvalidPasswordException.cs
@@ -0,0 +1,22 @@
+// 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 InvalidPasswordException : HubException
+    {
+        public InvalidPasswordException()
+        {
+        }
+
+        protected InvalidPasswordException(SerializationInfo info, StreamingContext context)
+            : base(info, context)
+        {
+        }
+    }
+}
diff --git a/osu.Game/Online/Multiplayer/MultiplayerClient.cs b/osu.Game/Online/Multiplayer/MultiplayerClient.cs
index 2e65f7cf1c..a9f4dc9e2f 100644
--- a/osu.Game/Online/Multiplayer/MultiplayerClient.cs
+++ b/osu.Game/Online/Multiplayer/MultiplayerClient.cs
@@ -212,6 +212,8 @@ namespace osu.Game.Online.Multiplayer
             return ChangeSettings(new MultiplayerRoomSettings
             {
                 Name = name.GetOr(Room.Settings.Name),
+                // TODO: add changing support
+                Password = Room.Settings.Password,
                 BeatmapID = item.GetOr(existingPlaylistItem).BeatmapID,
                 BeatmapChecksum = item.GetOr(existingPlaylistItem).Beatmap.Value.MD5Hash,
                 RulesetID = item.GetOr(existingPlaylistItem).RulesetID,
diff --git a/osu.Game/Online/Multiplayer/MultiplayerRoomSettings.cs b/osu.Game/Online/Multiplayer/MultiplayerRoomSettings.cs
index ee72df4c10..4e94c5982f 100644
--- a/osu.Game/Online/Multiplayer/MultiplayerRoomSettings.cs
+++ b/osu.Game/Online/Multiplayer/MultiplayerRoomSettings.cs
@@ -36,12 +36,16 @@ namespace osu.Game.Online.Multiplayer
         [Key(6)]
         public long PlaylistItemId { get; set; }
 
+        [Key(7)]
+        public string Password { get; set; } = string.Empty;
+
         public bool Equals(MultiplayerRoomSettings other)
             => BeatmapID == other.BeatmapID
                && BeatmapChecksum == other.BeatmapChecksum
                && RequiredMods.SequenceEqual(other.RequiredMods)
                && AllowedMods.SequenceEqual(other.AllowedMods)
                && RulesetID == other.RulesetID
+               && Password.Equals(other.Password, StringComparison.Ordinal)
                && Name.Equals(other.Name, StringComparison.Ordinal)
                && PlaylistItemId == other.PlaylistItemId;
 
@@ -49,6 +53,7 @@ namespace osu.Game.Online.Multiplayer
                                              + $" Beatmap:{BeatmapID} ({BeatmapChecksum})"
                                              + $" RequiredMods:{string.Join(',', RequiredMods)}"
                                              + $" AllowedMods:{string.Join(',', AllowedMods)}"
+                                             + $" Password:{(string.IsNullOrEmpty(Password) ? "no" : "yes")}"
                                              + $" Ruleset:{RulesetID}"
                                              + $" Item:{PlaylistItemId}";
     }