Merge pull request #66 from legiz-ru/pandora-deeplink

feat: deeplink import

Author: snakem982

doc/README.en.md

@@ -30,6 +30,18 @@
 - Go to `Settings` → `Enable Authorization` → Restart the app → When the authorization prompt appears, grant
   permission → TUN mode can then be enabled in the app
 
+## Deeplink Profile Import
+
+Pandora-Box supports importing profiles via deeplink URLs, allowing users to easily add subscriptions from external sources.
+
+### URL Scheme
+
+The deeplink uses the custom protocol `pandora-box://` with the following format:
+
+```
+pandora-box://install-config?url=SUBSCRIPTION_URL
+```
+
 ## Note: Px Requires Network Access
 
 - When prompted, click "Allow" to grant network access

doc/README.ru.md

@@ -30,6 +30,18 @@
 - Настройки → Включить авторизацию → Перезапустить приложение → Подтвердить авторизацию в всплывающем окне → Готово
 - После входа в приложение можно активировать режим TUN
 
+## Импорт профилей через Deeplink
+
+Pandora-Box поддерживает импорт профилей через deeplink URL, что позволяет пользователям легко добавлять подписки из внешних источников.
+
+### Схема URL
+
+Deeplink использует пользовательский протокол `pandora-box://` в следующем формате:
+
+```
+pandora-box://install-config?url=SUBSCRIPTION_URL
+```
+
 ## Запрос Px на сетевой доступ
 
 - Просто нажмите "Разрешить"

doc/README.zh-CN.md

@@ -30,6 +30,18 @@
 - 设置 → 开启授权 → 重启软件 → 弹出授权框 → 完成授权
 - 进入软件后即可开启 TUN 模式
 
+## 深度链接配置导入
+
+Pandora-Box 支持通过深度链接 URL 导入配置，让用户可以轻松地从外部来源添加订阅。
+
+### URL 格式
+
+深度链接使用自定义协议 `pandora-box://`，格式如下：
+
+```
+pandora-box://install-config?url=SUBSCRIPTION_URL
+```
+
 ## 提示 Px 需要网络接入
 
 - 点击 “允许” 即可

forge.config.ts

@@ -20,6 +20,12 @@ const config: ForgeConfig = {
             LSMinimumSystemVersion: "10.13.0"
         },
         appBundleId: 'com.snakem982.pandora-box',
+        protocols: [
+            {
+                name: 'Pandora-Box Protocol',
+                schemes: ['pandora-box']
+            }
+        ],
     },
     rebuildConfig: {},
     makers: [
@@ -31,6 +37,43 @@ const config: ForgeConfig = {
                 chooseDirectory: true,
             },
             upgradeCode: 'c1d377b2-2c61-4c5e-8773-8e3c703b8b41',
+            registry: [
+                {
+                    key: 'HKEY_CLASSES_ROOT\\pandora-box',
+                    values: [
+                        {
+                            name: '',
+                            type: 'REG_SZ',
+                            value: 'URL:Pandora-Box Protocol'
+                        },
+                        {
+                            name: 'URL Protocol',
+                            type: 'REG_SZ',
+                            value: ''
+                        }
+                    ]
+                },
+                {
+                    key: 'HKEY_CLASSES_ROOT\\pandora-box\\DefaultIcon',
+                    values: [
+                        {
+                            name: '',
+                            type: 'REG_SZ',
+                            value: '[APPLICATIONROOTDIRECTORY]Pandora-Box.exe,0'
+                        }
+                    ]
+                },
+                {
+                    key: 'HKEY_CLASSES_ROOT\\pandora-box\\shell\\open\\command',
+                    values: [
+                        {
+                            name: '',
+                            type: 'REG_SZ',
+                            value: '"[APPLICATIONROOTDIRECTORY]Pandora-Box.exe" "%1"'
+                        }
+                    ]
+                }
+            ]
         }),
         new MakerDMG({
             icon: 'build/appicon.icns',
@@ -47,6 +90,7 @@ const config: ForgeConfig = {
                 icon: 'build/appicon.png',
                 maintainer: 'snakem982',
                 homepage: 'https://github.com/snakem982/Pandora-Box',
+                mimeType: ['x-scheme-handler/pandora-box']
             }
         })
     ],

src-electron/main.ts

@@ -1,4 +1,4 @@
-import {app, BrowserWindow, BrowserWindowConstructorOptions, session} from 'electron';
+import {app, BrowserWindow, BrowserWindowConstructorOptions, ipcMain, session} from 'electron';
 import path from 'node:path';
 import {startServer, storeInfo} from "./server";
 import {doQuit, initTray, showWindow} from "./tray";
@@ -11,7 +11,15 @@ import {isBootAutoLaunch, updateAutoLaunchRegistration, waitForNetworkReady} fro
 const isDev = !app.isPackaged;
 
 // 主窗口
-let mainWindow: BrowserWindow;
+let mainWindow: BrowserWindow | null = null;
+
+// 深度链接相关
+const DEEP_LINK_SCHEME = 'pandora-box';
+const DEEP_LINK_HOST_INSTALL = 'install-config';
+const DEEP_LINK_EVENT = 'import-profile-from-deeplink';
+const DEEP_LINK_READY_EVENT = 'deeplink-handler-ready';
+const pendingDeepLinks: string[] = [];
+let deepLinkHandlerReady = false;
 // 屏蔽安全警告
 process.env["ELECTRON_DISABLE_SECURITY_WARNINGS"] = "true";
 const createWindow = (isBoot: boolean) => {
@@ -44,6 +52,7 @@ const createWindow = (isBoot: boolean) => {
         };
     }
 
+    deepLinkHandlerReady = false;
     mainWindow = new BrowserWindow(windowOptions);
 
     // 隐藏菜单栏
@@ -62,6 +71,14 @@ const createWindow = (isBoot: boolean) => {
         log.error('页面加载失败:', err);
     });
 
+    mainWindow.webContents.on('did-start-loading', () => {
+        deepLinkHandlerReady = false;
+    });
+
+    mainWindow.webContents.on('did-finish-load', () => {
+        processPendingDeepLinks();
+    });
+
     // 页面加载完成再显示，避免白屏
     mainWindow.webContents.once('did-finish-load', () => {
         if (isBoot) {
@@ -72,8 +89,77 @@ const createWindow = (isBoot: boolean) => {
             log.info('页面加载成功');
         }
     });
+
+    mainWindow.on('closed', () => {
+        deepLinkHandlerReady = false;
+        mainWindow = null;
+    });
+};
+
+const isDeepLinkUrl = (arg: string | undefined): arg is string => {
+    return typeof arg === 'string' && arg.startsWith(`${DEEP_LINK_SCHEME}://`);
+};
+
+const processPendingDeepLinks = () => {
+    if (!mainWindow || mainWindow.isDestroyed() || !deepLinkHandlerReady) {
+        return;
+    }
+
+    if (pendingDeepLinks.length === 0) {
+        return;
+    }
+
+    const queue = pendingDeepLinks.splice(0, pendingDeepLinks.length);
+    showWindow();
+
+    for (const url of queue) {
+        if (!url) {
+            continue;
+        }
+
+        log.info('处理深度链接队列:', url);
+        mainWindow.webContents.send(DEEP_LINK_EVENT, {rawUrl: url});
+    }
 };
 
+const enqueueDeepLink = (url: string) => {
+    pendingDeepLinks.push(url);
+    processPendingDeepLinks();
+};
+
+function handleDeepLink(url: string) {
+    const trimmed = url?.trim();
+    if (!trimmed) {
+        return;
+    }
+
+    try {
+        const parsedUrl = new URL(trimmed);
+        if (parsedUrl.protocol !== `${DEEP_LINK_SCHEME}:`) {
+            return;
+        }
+
+        const host = parsedUrl.hostname || parsedUrl.host;
+        if (host && host.toLowerCase() === DEEP_LINK_HOST_INSTALL) {
+            log.info('收到深度链接:', trimmed);
+            enqueueDeepLink(trimmed);
+        } else {
+            log.warn('未知深度链接:', trimmed);
+        }
+    } catch (error) {
+        log.error('解析深度链接失败:', error);
+    }
+}
+
+ipcMain.on(DEEP_LINK_READY_EVENT, (event) => {
+    if (!mainWindow || event.sender !== mainWindow.webContents) {
+        return;
+    }
+
+    deepLinkHandlerReady = true;
+    processPendingDeepLinks();
+});
+
 // 等待 backend 传来的 port 和 secret
 let resolveReady: () => void;
 const waitForReady = new Promise<void>((resolve) => {
@@ -100,17 +186,50 @@ const agents = [
     }
 ];
 
+const registerDeepLinkProtocol = () => {
+    try {
+        if (process.defaultApp && process.argv.length >= 2) {
+            const exePath = process.execPath;
+            const resolvedPath = path.resolve(process.argv[1]);
+            app.setAsDefaultProtocolClient(DEEP_LINK_SCHEME, exePath, [resolvedPath]);
+        } else if (!app.isDefaultProtocolClient(DEEP_LINK_SCHEME)) {
+            app.setAsDefaultProtocolClient(DEEP_LINK_SCHEME);
+        }
+    } catch (error) {
+        log.error('注册深度链接协议失败:', error);
+    }
+};
+
+for (const arg of process.argv) {
+    if (isDeepLinkUrl(arg)) {
+        pendingDeepLinks.push(arg);
+    }
+}
+
 // 单例模式
 const gotTheLock = app.requestSingleInstanceLock();
 if (!gotTheLock) {
     doQuit()
 } else {
     // 试图启动第二个应用实例
-    app.on('second-instance', showWindow);
+    app.on('second-instance', (_event, commandLine) => {
+        const urls = commandLine.filter(isDeepLinkUrl);
+        if (urls.length > 0) {
+            urls.forEach(handleDeepLink);
+        }
+        showWindow();
+    });
 
     // 监听应用被激活
     app.on('activate', showWindow);
 
+    if (process.platform === 'darwin') {
+        app.on('open-url', (event, url) => {
+            event.preventDefault();
+            handleDeepLink(url);
+        });
+    }
+
     app.whenReady().then(async () => {
         // 判断是否开机启动
         const isBoot = await isBootAutoLaunch();
@@ -139,6 +258,8 @@ if (!gotTheLock) {
         // 等待后端启动
         await waitForReady;
 
+        registerDeepLinkProtocol();
+
         // 设置请求头 Referer
         const agent = agents[Math.floor(Math.random() * agents.length)];
         session.defaultSession.webRequest.onBeforeSendHeaders((details, callback) => {
@@ -156,4 +277,4 @@ if (!gotTheLock) {
         // 更新开机自启路径
         await updateAutoLaunchRegistration()
     });
-}
+}

src-electron/preload.ts

@@ -14,6 +14,18 @@ contextBridge.exposeInMainWorld('pxTray', {
     emit: (name, ...value) => ipcRenderer.send('px_' + name, ...value)
 });
 
+// 深度链接相关
+contextBridge.exposeInMainWorld('pxDeepLink', {
+    onImportProfile: (callback) => {
+        // 移除旧监听器，确保只注册一次
+        ipcRenderer.removeAllListeners('import-profile-from-deeplink');
+        ipcRenderer.on('import-profile-from-deeplink', (_event, data) => callback(data));
+    },
+    notifyReady: () => {
+        ipcRenderer.send('deeplink-handler-ready');
+    }
+});
+
 
 // 缓存接口
 contextBridge.exposeInMainWorld('pxStore', {

src/locales/en.yaml

@@ -158,6 +158,12 @@ profiles:
   switch:
     ing: Switching...
     success: Switch success
+  deeplink:
+    importing: Importing profile...
+    import-success: Profile imported successfully
+    import-failed: Failed to import profile
+    invalid-url: Invalid profile URL
+    invalid-url-format: Invalid URL format, must be HTTP or HTTPS
 
 rule:
   title: Rule

src/locales/ru.yaml

@@ -158,6 +158,12 @@ profiles:
   switch:
     ing: Переключение...
     success: Переключено успешно
+  deeplink:
+    importing: Импорт профиля...
+    import-success: Профиль успешно импортирован
+    import-failed: Не удалось импортировать профиль
+    invalid-url: Неверный URL профиля
+    invalid-url-format: Неверный формат URL, должен быть HTTP или HTTPS
 
 rule:
   title: Правило

src/locales/zh.yaml

@@ -158,6 +158,12 @@ profiles:
   switch:
     ing: 切换中。。。
     success: 切换成功
+  deeplink:
+    importing: 正在导入配置。。。
+    import-success: 配置导入成功
+    import-failed: 配置导入失败
+    invalid-url: 无效的配置链接
+    invalid-url-format: 配置链接格式错误，必须是 HTTP 或 HTTPS
 
 rule:
   title: 规则