Handle osu:// scheme links via IPC in desktop game

Author: bdach

osu.Desktop/OsuGameDesktop.cs

@@ -1,8 +1,6 @@
 // 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.
 
-#nullable disable
-
 using System;
 using System.Collections.Generic;
 using System.Diagnostics;
@@ -22,23 +20,26 @@
 using osu.Desktop.Windows;
 using osu.Framework.Threading;
 using osu.Game.IO;
+using osu.Game.IPC;
 
 namespace osu.Desktop
 {
     internal class OsuGameDesktop : OsuGame
     {
-        public OsuGameDesktop(string[] args = null)
+        private OsuSchemeLinkIPCChannel? osuSchemeLinkIPCChannel;
+
+        public OsuGameDesktop(string[]? args = null)
             : base(args)
         {
         }
 
-        public override StableStorage GetStorageForStableInstall()
+        public override StableStorage? GetStorageForStableInstall()
         {
             try
             {
                 if (Host is DesktopGameHost desktopHost)
                 {
-                    string stablePath = getStableInstallPath();
+                    string? stablePath = getStableInstallPath();
                     if (!string.IsNullOrEmpty(stablePath))
                         return new StableStorage(stablePath, desktopHost);
                 }
@@ -51,11 +52,11 @@ public override StableStorage GetStorageForStableInstall()
             return null;
         }
 
-        private string getStableInstallPath()
+        private string? getStableInstallPath()
         {
             static bool checkExists(string p) => Directory.Exists(Path.Combine(p, "Songs")) || File.Exists(Path.Combine(p, "osu!.cfg"));
 
-            string stableInstallPath;
+            string? stableInstallPath;
 
             if (OperatingSystem.IsWindows())
             {
@@ -83,15 +84,15 @@ private string getStableInstallPath()
         }
 
         [SupportedOSPlatform("windows")]
-        private string getStableInstallPathFromRegistry()
+        private string? getStableInstallPathFromRegistry()
         {
-            using (RegistryKey key = Registry.ClassesRoot.OpenSubKey("osu"))
+            using (RegistryKey? key = Registry.ClassesRoot.OpenSubKey("osu"))
                 return key?.OpenSubKey(@"shell\open\command")?.GetValue(string.Empty)?.ToString()?.Split('"')[1].Replace("osu!.exe", "");
         }
 
         protected override UpdateManager CreateUpdateManager()
         {
-            string packageManaged = Environment.GetEnvironmentVariable("OSU_EXTERNAL_UPDATE_PROVIDER");
+            string? packageManaged = Environment.GetEnvironmentVariable("OSU_EXTERNAL_UPDATE_PROVIDER");
 
             if (!string.IsNullOrEmpty(packageManaged))
                 return new NoActionUpdateManager();
@@ -118,6 +119,8 @@ protected override void LoadComplete()
                 LoadComponentAsync(new GameplayWinKeyBlocker(), Add);
 
             LoadComponentAsync(new ElevatedPrivilegesChecker(), Add);
+
+            osuSchemeLinkIPCChannel = new OsuSchemeLinkIPCChannel(Host, this);
         }
 
         public override void SetHost(GameHost host)
@@ -135,7 +138,7 @@ public override void SetHost(GameHost host)
         }
 
         private readonly List<string> importableFiles = new List<string>();
-        private ScheduledDelegate importSchedule;
+        private ScheduledDelegate? importSchedule;
 
         private void fileDrop(string[] filePaths)
         {
@@ -168,5 +171,11 @@ private void handlePendingImports()
                 Task.Factory.StartNew(() => Import(paths), TaskCreationOptions.LongRunning);
             }
         }
+
+        protected override void Dispose(bool isDisposing)
+        {
+            base.Dispose(isDisposing);
+            osuSchemeLinkIPCChannel?.Dispose();
+        }
     }
 }

osu.Desktop/Program.cs

@@ -11,6 +11,7 @@
 using osu.Framework.Development;
 using osu.Framework.Logging;
 using osu.Framework.Platform;
+using osu.Game;
 using osu.Game.IPC;
 using osu.Game.Tournament;
 using Squirrel;
@@ -65,19 +66,8 @@ public static void Main(string[] args)
             {
                 if (!host.IsPrimaryInstance)
                 {
-                    if (args.Length > 0 && args[0].Contains('.')) // easy way to check for a file import in args
-                    {
-                        var importer = new ArchiveImportIPCChannel(host);
-
-                        foreach (string file in args)
-                        {
-                            Console.WriteLine(@"Importing {0}", file);
-                            if (!importer.ImportAsync(Path.GetFullPath(file, cwd)).Wait(3000))
-                                throw new TimeoutException(@"IPC took too long to send");
-                        }
-
+                    if (trySendIPCMessage(host, cwd, args))
                         return;
-                    }
 
                     // we want to allow multiple instances to be started when in debug.
                     if (!DebugUtils.IsDebugBuild)
@@ -108,6 +98,34 @@ public static void Main(string[] args)
             }
         }
 
+        private static bool trySendIPCMessage(IIpcHost host, string cwd, string[] args)
+        {
+            if (args.Length == 1 && args[0].StartsWith(OsuGameBase.OSU_PROTOCOL, StringComparison.Ordinal))
+            {
+                var osuSchemeLinkHandler = new OsuSchemeLinkIPCChannel(host);
+                if (!osuSchemeLinkHandler.HandleLinkAsync(args[0]).Wait(3000))
+                    throw new IPCTimeoutException(osuSchemeLinkHandler.GetType());
+
+                return true;
+            }
+
+            if (args.Length > 0 && args[0].Contains('.')) // easy way to check for a file import in args
+            {
+                var importer = new ArchiveImportIPCChannel(host);
+
+                foreach (string file in args)
+                {
+                    Console.WriteLine(@"Importing {0}", file);
+                    if (!importer.ImportAsync(Path.GetFullPath(file, cwd)).Wait(3000))
+                        throw new IPCTimeoutException(importer.GetType());
+                }
+
+                return true;
+            }
+
+            return false;
+        }
+
         [SupportedOSPlatform("windows")]
         private static void setupSquirrel()
         {

osu.Game/IPC/IPCTimeoutException.cs

@@ -0,0 +1,15 @@
+// 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;
+
+namespace osu.Game.IPC
+{
+    public class IPCTimeoutException : TimeoutException
+    {
+        public IPCTimeoutException(Type channelType)
+            : base($@"IPC took too long to send message via channel {channelType}")
+        {
+        }
+    }
+}