Merge pull request #602 from MoYingJi/prot

✨ feat: 部分支持通过 orpheus 协议唤起 SPlayer

Author: imsyy

electron-builder.config.ts

@@ -45,6 +45,13 @@ const config: Configuration = {
         arch: ["x64", "arm64"],
       },
     ],
+    // 注册协议
+    protocols: [
+      {
+        name: "Orpheus Protocol",
+        schemes: ["orpheus"],
+      },
+    ],
   },
   // NSIS 安装器配置
   nsis: {
@@ -90,6 +97,13 @@ const config: Configuration = {
         "Application requests access to the user's Documents folder.",
       NSDownloadsFolderUsageDescription:
         "Application requests access to the user's Downloads folder.",
+      // 注册协议
+      CFBundleURLTypes: [
+        {
+          CFBundleURLName: "Orpheus Protocol",
+          CFBundleURLSchemes: ["orpheus"],
+        },
+      ],
     },
     // 是否启用应用程序的 Notarization（苹果的安全审核）
     notarize: false,
@@ -153,6 +167,13 @@ const config: Configuration = {
     maintainer: "imsyy.top",
     // 应用程序类别
     category: "Audio;Music;AudioVideo;",
+    // 桌面项
+    desktop: {
+      entry: {
+        // 注册协议
+        MimeType: "x-scheme-handler/orpheus;",
+      },
+    },
   },
   // AppImage 特定配置
   appImage: {

electron/main/index.ts

@@ -11,6 +11,7 @@ import initAppServer from "../server";
 import loadWindow from "./windows/load-window";
 import mainWindow from "./windows/main-window";
 import initIpc from "./ipc";
+import { trySendCustomProtocol, registerCustomProtocol } from "./utils/protocol";
 
 // 屏蔽报错
 process.env.ELECTRON_DISABLE_SECURITY_WARNINGS = "true";
@@ -42,11 +43,13 @@ class MainProcess {
     // 监听应用事件
     this.handleAppEvents();
     // Electron 初始化完成后
-    // 某些API只有在此事件发生后才能使用
+    // 某些 API 只有在此事件发生后才能使用
     app.whenReady().then(async () => {
       processLog.info("🚀 Application Process Startup");
       // 设置应用程序名称
       electronApp.setAppUserModelId("com.imsyy.splayer");
+      // 注册自定义协议
+      registerCustomProtocol();
       // 启动主服务进程
       await initAppServer();
       // 启动窗口
@@ -77,7 +80,8 @@ class MainProcess {
 
     // 自定义协议
     app.on("open-url", (_, url) => {
-      processLog.log("Received custom protocol URL:", url);
+      processLog.log("🔗 Received custom protocol URL:", url);
+      trySendCustomProtocol(url)
     });
 
     // 将要退出

electron/main/utils/protocol.ts

@@ -0,0 +1,30 @@
+import { app } from "electron";
+import { processLog } from "../logger";
+import mainWindow from "../windows/main-window";
+
+export const registerCustomProtocol = () => {
+  app.setAsDefaultProtocolClient("orpheus");
+  processLog.info("🔗 Registered custom protocol");
+};
+
+export const trySendCustomProtocol = (str: string): boolean => {
+  try {
+    if (str.startsWith("orpheus://")) {
+      mainWindow.getWin()!.webContents.send("protocol-url", str);
+      return true;
+    }
+    return false;
+  } catch (e) {
+    processLog.error("❌ Failed to send protocol url", e);
+    return false;
+  }
+}
+
+export const processProtocolFromCommand = (command: string[]): boolean => {
+  // 这里第一个参数是程序名称 忽略此 仅遍历参数
+  for (let i = 1; i < command.length; i++) {
+    const arg = command[i];
+    if (trySendCustomProtocol(arg)) return true;
+  }
+  return false;
+}

electron/main/utils/single-lock.ts

@@ -1,6 +1,7 @@
 import { app } from "electron";
 import { systemLog } from "../logger";
 import mainWindow from "../windows/main-window";
+import { processProtocolFromCommand } from "./protocol";
 
 /**
  * 初始化单实例锁
@@ -16,8 +17,12 @@ export const initSingleLock = (): boolean => {
   }
   // 当第二个实例启动时触发
   else {
-    app.on("second-instance", () => {
-      systemLog.warn("❌ 第二个实例将要启动");
+    app.on("second-instance", (_, commandLine) => {
+      if (!processProtocolFromCommand(commandLine)) {
+        systemLog.warn("❌ 第二个实例将要启动");
+      } else {
+        systemLog.info("🚀 第二个实例将要启动，通过 Custom Protocol");
+      }
       mainWindow.getWin()?.show();
     });
   }

scripts/dev.mjs

@@ -61,7 +61,16 @@ const startElectronVite = () => {
   // 设置 Node.js 选项
   env.NODE_OPTIONS = "--max-old-space-size=4096";
 
-  const electronVite = spawn("electron-vite", ["dev"], {
+  // 传递给 electron-vite 的参数
+  const runArgs = ["dev"];
+  // 前两个参数分别是 node 和此脚本的路径，丢弃其
+  const args = process.argv.slice(2);
+  // 添加参数
+  if (args.length > 0) {
+    runArgs.push(...args);
+  }
+
+  const electronVite = spawn("electron-vite", runArgs, {
     stdio: "inherit",
     shell: true,
     env,

src/utils/initIpc.ts

@@ -6,6 +6,7 @@ import { usePlayer } from "./player";
 import { cloneDeep } from "lodash-es";
 import songManager from "./songManager";
 import { SettingType } from "@/types/main";
+import { handleProtocolUrl } from "@/utils/protocal";
 
 // 关闭更新状态
 const closeUpdateStatus = () => {
@@ -82,6 +83,11 @@ const initIpc = () => {
       closeUpdateStatus();
       window.$message.error("更新过程出现错误");
     });
+    // 协议数据
+    window.electron.ipcRenderer.on("protocol-url", (_, url) => {
+      console.log("📡 Received protocol url:", url);
+      handleProtocolUrl(url)
+    });
   } catch (error) {
     console.log(error);
   }

src/utils/protocal.ts

@@ -0,0 +1,62 @@
+import { songDetail } from "@/api/song";
+import { formatSongsList } from "@/utils/format";
+import { usePlayer } from "@/utils/player";
+
+class OrpheusData {
+  constructor(type: string, id: number, cmd: string) {
+    this.type = type;
+    this.id = id;
+    this.cmd = cmd;
+  }
+
+  type: string;
+  id: number;
+  cmd: string;
+}
+
+export const handleProtocolUrl = (url: string) => {
+  switch (true) {
+    case url.startsWith("orpheus://"):
+      handleOpenOrpheus(url);
+      break;
+    default:
+      break;
+  }
+}
+
+
+
+export const handleOpenOrpheus = async (url: string) => {
+  const data = parseOrpheus(url);
+  if (!data) return;
+  console.log("🚀 Open Orpheus:", data);
+
+  if (data.cmd === "play" && data.type === "song") {
+    const player = usePlayer();
+    const result = await songDetail(data.id);
+    const song = formatSongsList(result.songs)[0];
+    player.addNextSong(song, true);
+  } else {
+    console.log("❌ Unsupported Command or Type:", data);
+  }
+};
+
+const parseOrpheus = (url: string): OrpheusData | undefined => {
+  // 这里的协议是从网页端打开官方客户端的协议
+  // 形如 `orpheus://eyJ0eXBlIjoic29uZyIsImlkIjoiMTgyNjM2MTcxMiIsImNtZCI6InBsYXkifQ==`
+  // URI 的 Path 部分是 Base64 编码过的，解码后得到 Json
+  // 形如 `{"type":"song","id":"1826361712","cmd":"play"}`
+
+  if (!url.startsWith("orpheus://")) return;
+  const path = url.replace("orpheus://", "");
+  const jsonString = atob(path);
+  let data: OrpheusData;
+  try {
+    const json = JSON.parse(jsonString);
+    data = new OrpheusData(json.type, json.id, json.cmd);
+  } catch (e) {
+    console.error("❌ Invalid Data:", e);
+    return;
+  }
+  return data;
+}