Merge pull request #8801 from peppy/add-np-command

Add /np (now playing) command support in chat

osu.Game.Tests/Visual/Online/TestSceneNowPlayingCommand.cs

@@ -0,0 +1,85 @@
+// 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 NUnit.Framework;
+using osu.Framework.Allocation;
+using osu.Framework.Graphics;
+using osu.Framework.Testing;
+using osu.Game.Beatmaps;
+using osu.Game.Online.Chat;
+using osu.Game.Rulesets;
+using osu.Game.Users;
+
+namespace osu.Game.Tests.Visual.Online
+{
+    [HeadlessTest]
+    public class TestSceneNowPlayingCommand : OsuTestScene
+    {
+        [Cached(typeof(IChannelPostTarget))]
+        private PostTarget postTarget { get; set; }
+
+        public TestSceneNowPlayingCommand()
+        {
+            Add(postTarget = new PostTarget());
+        }
+
+        [Test]
+        public void TestGenericActivity()
+        {
+            AddStep("Set activity", () => API.Activity.Value = new UserActivity.InLobby());
+
+            AddStep("Run command", () => Add(new NowPlayingCommand()));
+
+            AddAssert("Check correct response", () => postTarget.LastMessage.Contains("is listening"));
+        }
+
+        [Test]
+        public void TestEditActivity()
+        {
+            AddStep("Set activity", () => API.Activity.Value = new UserActivity.Editing(new BeatmapInfo()));
+
+            AddStep("Run command", () => Add(new NowPlayingCommand()));
+
+            AddAssert("Check correct response", () => postTarget.LastMessage.Contains("is editing"));
+        }
+
+        [Test]
+        public void TestPlayActivity()
+        {
+            AddStep("Set activity", () => API.Activity.Value = new UserActivity.SoloGame(new BeatmapInfo(), new RulesetInfo()));
+
+            AddStep("Run command", () => Add(new NowPlayingCommand()));
+
+            AddAssert("Check correct response", () => postTarget.LastMessage.Contains("is playing"));
+        }
+
+        [TestCase(true)]
+        [TestCase(false)]
+        public void TestLinkPresence(bool hasOnlineId)
+        {
+            AddStep("Set activity", () => API.Activity.Value = new UserActivity.InLobby());
+
+            AddStep("Set beatmap", () => Beatmap.Value = new DummyWorkingBeatmap(null, null)
+            {
+                BeatmapInfo = { OnlineBeatmapID = hasOnlineId ? 1234 : (int?)null }
+            });
+
+            AddStep("Run command", () => Add(new NowPlayingCommand()));
+
+            if (hasOnlineId)
+                AddAssert("Check link presence", () => postTarget.LastMessage.Contains("https://osu.ppy.sh/b/1234"));
+            else
+                AddAssert("Check link not present", () => !postTarget.LastMessage.Contains("https://"));
+        }
+
+        public class PostTarget : Component, IChannelPostTarget
+        {
+            public void PostMessage(string text, bool isAction = false, Channel target = null)
+            {
+                LastMessage = text;
+            }
+
+            public string LastMessage { get; private set; }
+        }
+    }
+}

osu.Game/Online/Chat/ChannelManager.cs

@@ -18,7 +18,7 @@ namespace osu.Game.Online.Chat
     /// <summary>
     /// Manages everything channel related
     /// </summary>
-    public class ChannelManager : PollingComponent
+    public class ChannelManager : PollingComponent, IChannelPostTarget
     {
         /// <summary>
         /// The channels the player joins on startup
@@ -204,6 +204,10 @@ namespace osu.Game.Online.Chat
 
             switch (command)
             {
+                case "np":
+                    AddInternal(new NowPlayingCommand());
+                    break;
+
                 case "me":
                     if (string.IsNullOrWhiteSpace(content))
                     {
@@ -234,7 +238,7 @@ namespace osu.Game.Online.Chat
                     break;
 
                 case "help":
-                    target.AddNewMessages(new InfoMessage("Supported commands: /help, /me [action], /join [channel]"));
+                    target.AddNewMessages(new InfoMessage("Supported commands: /help, /me [action], /join [channel], /np"));
                     break;
 
                 default:

osu.Game/Online/Chat/IChannelPostTarget.cs

@@ -0,0 +1,19 @@
+// 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 osu.Framework.Allocation;
+
+namespace osu.Game.Online.Chat
+{
+    [Cached(typeof(IChannelPostTarget))]
+    public interface IChannelPostTarget
+    {
+        /// <summary>
+        /// Posts a message to the currently opened channel.
+        /// </summary>
+        /// <param name="text">The message text that is going to be posted</param>
+        /// <param name="isAction">Is true if the message is an action, e.g.: user is currently eating </param>
+        /// <param name="target">An optional target channel. If null, <see cref="ChannelManager.CurrentChannel"/> will be used.</param>
+        void PostMessage(string text, bool isAction = false, Channel target = null);
+    }
+}

osu.Game/Online/Chat/NowPlayingCommand.cs

@@ -0,0 +1,55 @@
+// 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 osu.Framework.Allocation;
+using osu.Framework.Bindables;
+using osu.Framework.Graphics;
+using osu.Game.Beatmaps;
+using osu.Game.Online.API;
+using osu.Game.Users;
+
+namespace osu.Game.Online.Chat
+{
+    public class NowPlayingCommand : Component
+    {
+        [Resolved]
+        private IChannelPostTarget channelManager { get; set; }
+
+        [Resolved]
+        private IAPIProvider api { get; set; }
+
+        [Resolved]
+        private Bindable<WorkingBeatmap> currentBeatmap { get; set; }
+
+        protected override void LoadComplete()
+        {
+            base.LoadComplete();
+
+            string verb;
+            BeatmapInfo beatmap;
+
+            switch (api.Activity.Value)
+            {
+                case UserActivity.SoloGame solo:
+                    verb = "playing";
+                    beatmap = solo.Beatmap;
+                    break;
+
+                case UserActivity.Editing edit:
+                    verb = "editing";
+                    beatmap = edit.Beatmap;
+                    break;
+
+                default:
+                    verb = "listening to";
+                    beatmap = currentBeatmap.Value.BeatmapInfo;
+                    break;
+            }
+
+            var beatmapString = beatmap.OnlineBeatmapID.HasValue ? $"[https://osu.ppy.sh/b/{beatmap.OnlineBeatmapID} {beatmap}]" : beatmap.ToString();
+
+            channelManager.PostMessage($"is {verb} {beatmapString}", true);
+            Expire();
+        }
+    }
+}

osu.Game/Online/PollingComponent.cs

@@ -3,7 +3,7 @@
 
 using System;
 using System.Threading.Tasks;
-using osu.Framework.Graphics;
+using osu.Framework.Graphics.Containers;
 using osu.Framework.Threading;
 
 namespace osu.Game.Online
@@ -11,7 +11,7 @@ namespace osu.Game.Online
     /// <summary>
     /// A component which requires a constant polling process.
     /// </summary>
-    public abstract class PollingComponent : Component
+    public abstract class PollingComponent : CompositeDrawable // switch away from Component because InternalChildren are used in usages.
     {
         private double? lastTimePolled;