Merge pull request #607 from MoYingJi/prot

feat(protocol): 在设置中选择是否注册协议

Author: imsyy

electron/main/index.ts

@@ -11,7 +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";
+import { trySendCustomProtocol } from "./utils/protocol";
 
 // 屏蔽报错
 process.env.ELECTRON_DISABLE_SECURITY_WARNINGS = "true";
@@ -48,8 +48,6 @@ class MainProcess {
       processLog.info("🚀 Application Process Startup");
       // 设置应用程序名称
       electronApp.setAppUserModelId("com.imsyy.splayer");
-      // 注册自定义协议
-      registerCustomProtocol();
       // 启动主服务进程
       await initAppServer();
       // 启动窗口

electron/main/ipc/index.ts

@@ -7,6 +7,7 @@ import initThumbarIpc from "./ipc-thumbar";
 import initTrayIpc from "./ipc-tray";
 import initUpdateIpc from "./ipc-update";
 import initWindowsIpc from "./ipc-window";
+import initProtocolIpc from "./ipc-protocol";
 
 /**
  * 初始化全部 IPC 通信
@@ -22,6 +23,7 @@ const initIpc = (): void => {
   initStoreIpc();
   initThumbarIpc();
   initShortcutIpc();
+  initProtocolIpc();
 };
 
 export default initIpc;

electron/main/ipc/ipc-protocol.ts

@@ -0,0 +1,16 @@
+import { app, ipcMain } from "electron";
+import { processLog } from "../logger";
+
+const initProtocolIpc = (): void => {
+  ipcMain.on("register-protocol", (_, protocol: string) => {
+    app.setAsDefaultProtocolClient(protocol)
+    processLog.info("🔗 Registered custom protocol", protocol);
+  })
+
+  ipcMain.on("unregister-protocol", (_, protocol: string) => {
+    app.removeAsDefaultProtocolClient(protocol)
+    processLog.info("🔗 Unregistered custom protocol", protocol);
+  })
+}
+
+export default initProtocolIpc;

electron/main/utils/protocol.ts

@@ -1,15 +1,5 @@
-import { app } from "electron";
-import { processLog } from "../logger";
 import mainWindow from "../windows/main-window";
-
-/**
- * 注册自定义协议
- * 用于在外部打开应用时传递 URL 参数
- */
-export const registerCustomProtocol = () => {
-  app.setAsDefaultProtocolClient("orpheus");
-  processLog.info("🔗 Registered custom protocol");
-};
+import { processLog } from "../logger";
 
 /**
  * 尝试发送自定义协议 URL 到主窗口

src/components/Setting/GeneralSetting.vue

@@ -315,6 +315,15 @@
         </div>
         <n-switch v-model:value="settingStore.preventSleep" class="set" :round="false" />
       </n-card>
+      <n-card class="set-item">
+        <div class="label">
+          <n-text class="name">通过 Orpheus 协议唤起本应用</n-text>
+          <n-text class="tip" :depth="3">
+            该协议通常用于官方网页端唤起官方客户端， 启用后可能导致官方客户端无法被唤起
+          </n-text>
+        </div>
+        <n-switch v-model:value="settingStore.registryProtocol.orpheus" class="set" :round="false" @update:value="orpheusChange" />
+      </n-card>
       <n-card class="set-item">
         <div class="label">
           <n-text class="name">自动检查更新</n-text>
@@ -334,6 +343,7 @@ import songManager from "@/utils/songManager";
 import { isEmpty } from "lodash-es";
 import themeColor from "@/assets/data/themeColor.json";
 import { openSidebarHideManager, openHomePageSectionManager } from "@/utils/modal";
+import { sendRegisterProtocol } from "@/utils/protocol";
 
 const dataStore = useDataStore();
 const musicStore = useMusicStore();
@@ -441,6 +451,11 @@ const themeGlobalColorChange = (val: boolean) => {
   if (val) songManager.getCoverColor(musicStore.songCover);
 };
 
+// 注册或取消注册协议
+const orpheusChange = async (isRegistry: boolean) => {
+  sendRegisterProtocol("orpheus", isRegistry)
+};
+
 onMounted(() => {
   if (isElectron) {
     getAllSystemFonts();

src/main.ts

@@ -13,6 +13,8 @@ import initIpc from "@/utils/initIpc";
 import "@/style/main.scss";
 import "@/style/animate.scss";
 import "github-markdown-css/github-markdown.css";
+import { useSettingStore } from "@/stores";
+import { sendRegisterProtocol } from "@/utils/protocol";
 
 // 初始化 ipc
 initIpc();
@@ -31,3 +33,7 @@ app.directive("throttle", throttleDirective);
 app.directive("visible", visibleDirective);
 // app
 app.mount("#app");
+
+// 根据设置判断是否要注册协议
+const settings = useSettingStore();
+sendRegisterProtocol("orpheus", settings.registryProtocol.orpheus);

src/stores/setting.ts

@@ -221,6 +221,10 @@ export interface SettingState {
     visible: boolean;
     order: number;
   }>;
+  /** 自定义协议注册 **/
+  registryProtocol: {
+    orpheus: boolean;
+  };
 }
 
 export const useSettingStore = defineStore("setting", {
@@ -333,6 +337,9 @@ export const useSettingStore = defineStore("setting", {
       { key: "radio", name: "推荐播客", visible: true, order: 4 },
       { key: "album", name: "新碟上架", visible: true, order: 5 },
     ],
+    registryProtocol: {
+      orpheus: false,
+    },
   }),
   getters: {
     /**

src/utils/initIpc.ts

@@ -6,7 +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";
+import { handleProtocolUrl } from "@/utils/protocol";
 
 // 关闭更新状态
 const closeUpdateStatus = () => {

src/utils/protocal.ts src/utils/protocol.tssrc/utils/protocal.ts renamed to src/utils/protocol.ts

@@ -14,6 +14,19 @@ class OrpheusData {
   cmd: string;
 }
 
+/**
+ * 发送 注册/取消注册 协议的 Ipc
+ * @param protocol 协议名
+ * @param register true 则注册，false 则取消注册
+ */
+export const sendRegisterProtocol = (protocol: string, register: boolean = true) => {
+  if (register) {
+    window.electron.ipcRenderer.send("register-protocol", protocol);
+  } else {
+    window.electron.ipcRenderer.send("unregister-protocol", protocol);
+  }
+};
+
 export const handleProtocolUrl = (url: string) => {
   switch (true) {
     case url.startsWith("orpheus://"):