🐛 恢复 GM_openInTab 的 useOpen 选项 #1043 (#1044)

* fix #1043

* mExtScheme

* vitest

* 还是用 useOpen 了

* Update gm_api.ts

* 修改注释说明

* 修改注释说明

* 修改注释说明

* 修改注释说明

* 修改注释说明

* Update gm_api.ts

* 修改注释

* Update gm_api.ts

* typescript fix

* 根据copilot意见修改

* Update gm_api.ts

---------

Co-authored-by: 王一之 <yz@ggnb.top>

Author: cyfung1031

packages/message/server.ts

@@ -100,7 +100,7 @@ export class SenderRuntime {
   }
 }
 
-type ApiFunction = (params: any, con: IGetSender) => Promise<any> | void;
+type ApiFunction = (params: any, con: IGetSender) => Promise<any> | any | void;
 type ApiFunctionSync = (params: any, con: IGetSender) => any;
 type MiddlewareFunction = (params: any, con: IGetSender, next: () => Promise<any> | any) => Promise<any> | any;
 

src/app/service/offscreen/gm_api.ts

@@ -1,16 +1,23 @@
 import { BgGMXhr } from "@App/pkg/utils/xhr/bg_gm_xhr";
 import type { IGetSender, Group } from "@Packages/message/server";
 
+// nativePageXHR 不需要绑定 Offscreen.GMApi 的 this，外部可以直接引用
+export const nativePageXHR = async (details: GMSend.XHRDetails, sender: IGetSender) => {
+  const con = sender.getConnect(); // con can be undefined
+  if (!con) throw new Error("offscreen xmlHttpRequest: Connection is undefined");
+  const bgGmXhr = new BgGMXhr(details, { statusCode: 0, finalUrl: "", responseHeaders: "" }, con);
+  bgGmXhr.do();
+};
+
+// nativePageWindowOpen 不需要绑定 Offscreen.GMApi 的 this，外部可以直接引用
+export const nativePageWindowOpen = (details: { url: string }): boolean => {
+  if (!details || !details.url) throw new Error("offscreen window.open: details.url is undefined");
+  return !!window.open(details.url);
+};
+
 export default class GMApi {
   constructor(private group: Group) {}
 
-  async xmlHttpRequest(details: GMSend.XHRDetails, sender: IGetSender) {
-    const con = sender.getConnect(); // con can be undefined
-    if (!con) throw new Error("offscreen xmlHttpRequest: Connection is undefined");
-    const bgGmXhr = new BgGMXhr(details, { statusCode: 0, finalUrl: "", responseHeaders: "" }, con);
-    bgGmXhr.do();
-  }
-
   textarea: HTMLTextAreaElement = document.createElement("textarea");
 
   clipboardData: { type?: string; data: string } | undefined;
@@ -37,7 +44,8 @@ export default class GMApi {
       this.clipboardData = undefined;
     });
 
-    this.group.on("xmlHttpRequest", this.xmlHttpRequest.bind(this));
+    this.group.on("xmlHttpRequest", nativePageXHR);
+    this.group.on("windowOpen", nativePageWindowOpen);
     this.group.on("setClipboard", this.setClipboard.bind(this));
   }
 }

src/app/service/service_worker/gm_api/gm_api.ts

@@ -10,7 +10,7 @@ import type { ConfirmParam } from "../permission_verify";
 import PermissionVerify, { PermissionVerifyApiGet } from "../permission_verify";
 import { cacheInstance } from "@App/app/cache";
 import { type RuntimeService } from "../runtime";
-import { getIcon, isFirefox, openInCurrentTab, cleanFileName } from "@App/pkg/utils/utils";
+import { getIcon, isFirefox, getCurrentTab, openInCurrentTab, cleanFileName } from "@App/pkg/utils/utils";
 import { type SystemConfig } from "@App/pkg/config/config";
 import i18next, { i18nName } from "@App/locales/locales";
 import FileSystemFactory from "@Packages/filesystem/factory";
@@ -43,6 +43,7 @@ import {
 } from "./gm_xhr";
 import { headerModifierMap, headersReceivedMap } from "./gm_xhr";
 import { BgGMXhr } from "@App/pkg/utils/xhr/bg_gm_xhr";
+import { nativePageWindowOpen } from "../../offscreen/gm_api";
 
 let generatedUniqueMarkerIDs = "";
 let generatedUniqueMarkerIDWhen = "";
@@ -912,6 +913,28 @@ export default class GMApi {
   async GM_openInTab(request: GMApiRequest<[string, GMTypes.SWOpenTabOptions]>, sender: IGetSender) {
     const url = request.params[0];
     const options = request.params[1];
+    if (options.useOpen) {
+      const prevTab = await getCurrentTab();
+      // 发送给offscreen页面处理 （使用window.open）
+      let ok;
+      if (typeof window === "object" && typeof window?.open === "function") {
+        // Firefox Background Page
+        ok = nativePageWindowOpen({ url });
+      } else {
+        ok = await sendMessage(this.msgSender, "offscreen/gmApi/windowOpen", { url });
+      }
+      // 注：一般而言，特殊打开的话没有实际 tab id.
+      // ------------------------------------------
+      if (ok) {
+        // 由于window.open强制在前台打开标签，因此获取状态为 { active:true } 的标签即为新标签
+        const tab = await getCurrentTab();
+        const tabId = tab?.id;
+        if (tabId && tabId !== prevTab?.id) return tabId;
+      }
+      // 当新tab被浏览器阻止时 window.open() 会返回 null 视为已经关闭
+      // 似乎在Firefox中禁止在background页面使用window.open()，强制返回null
+      return false;
+    }
     const getNewTabId = async () => {
       const { tabId, windowId } = sender.getExtMessageSender();
       const active = options.active;

src/template/scriptcat.d.tpl

@@ -462,13 +462,34 @@ declare namespace GMTypes {
      * 默认值：false
      */
     pinned?: boolean;
+
+    /**
+     * 使用 `window.open` 打开新标签，而不是 `chrome.tabs.create`
+     * 在打开一些特殊协议的链接时很有用，例如 `vscode://`, `m3u8dl://`
+     * 其他参数在这个打开方式下无效
+     *
+     * 相关：Issue #178 #1043
+     * 默认值：false
+     */
+    useOpen?: boolean;
   }
 
   type SWOpenTabOptions = OpenTabOptions & Required<Pick<OpenTabOptions, "active">>;
 
+  /**
+   * XMLHttpRequest readyState 状态值
+   * @see https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/readyState
+   */
+  type ReadyState =
+    | 0 // UNSENT
+    | 1 // OPENED
+    | 2 // HEADERS_RECEIVED
+    | 3 // LOADING
+    | 4; // DONE
+
   interface XHRResponse {
     finalUrl?: string;
-    readyState?: 0 | 1 | 2 | 3 | 4;
+    readyState?: ReadyState;
     responseHeaders?: string;
     status?: number;
     statusText?: string;
@@ -557,7 +578,14 @@ declare namespace GMTypes {
     // TM/SC 标准回调
     onload?: Listener<object>;
     onerror?: Listener<DownloadError>;
-    onprogress?: Listener<XHRProgress>;
+    onprogress?: Listener<{
+      done: number;
+      lengthComputable: boolean;
+      loaded: number;
+      position?: number;
+      total: number;
+      totalSize: number;
+    }>;
     ontimeout?: (arg1?: any) => void;
   }
 

src/types/scriptcat.d.ts

@@ -462,10 +462,24 @@ declare namespace GMTypes {
      * 默认值：false
      */
     pinned?: boolean;
+
+    /**
+     * 使用 `window.open` 打开新标签，而不是 `chrome.tabs.create`
+     * 在打开一些特殊协议的链接时很有用，例如 `vscode://`, `m3u8dl://`
+     * 其他参数在这个打开方式下无效
+     *
+     * 相关：Issue #178 #1043
+     * 默认值：false
+     */
+    useOpen?: boolean;
   }
 
   type SWOpenTabOptions = OpenTabOptions & Required<Pick<OpenTabOptions, "active">>;
 
+  /**
+   * XMLHttpRequest readyState 状态值
+   * @see https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/readyState
+   */
   type ReadyState =
     | 0 // UNSENT
     | 1 // OPENED