♻️ userScripts / scripting API 调整，增强兼容性 ( 重做 #704 ) (#925)

* userScripts / scripting API 调整，增强兼容性

* 恢复sourceMap处理

* 根据copilot意见修改

---------

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

Author: cyfung1031

src/app/service/service_worker/runtime.ts

@@ -22,6 +22,7 @@ import {
   getMetadataStr,
   getUserConfigStr,
   obtainBlackList,
+  isFirefox,
   sourceMapTo,
 } from "@App/pkg/utils/utils";
 import { cacheInstance } from "@App/app/cache";
@@ -336,8 +337,8 @@ export class RuntimeService {
 
     let registered = false;
     try {
-      const res = await chrome.userScripts.getScripts({ ids: ["scriptcat-content", "scriptcat-inject"] });
-      registered = res.length === 2;
+      const res = await chrome.userScripts.getScripts({ ids: ["scriptcat-inject"] });
+      registered = res.length === 1;
     } finally {
       // 考虑 UserScripts API 不可使用等情况
       runtimeGlobal.registered = registered;
@@ -663,6 +664,7 @@ export class RuntimeService {
       runtimeGlobal.messageFlag = this.generateMessageFlag();
       await Promise.allSettled([
         chrome.userScripts.unregister(),
+        chrome.scripting.unregisterContentScripts(),
         this.localStorageDAO.save({ key: "scriptInjectMessageFlag", value: runtimeGlobal.messageFlag }),
       ]);
     }
@@ -830,34 +832,51 @@ export class RuntimeService {
         // do nothing
       }
     }
-    const retScript: chrome.userScripts.RegisteredUserScript[] = [];
-    const contentJs = await this.getContentJsCode();
-    if (contentJs) {
-      const codeBody = `(function (MessageFlag) {\n${contentJs}\n})('${messageFlag}')`;
-      const code = `${codeBody}${sourceMapTo("scriptcat-content.js")}\n`;
-      retScript.push({
-        id: "scriptcat-content",
-        js: [{ code }],
-        matches: ["<all_urls>"],
-        allFrames: true,
-        runAt: "document_start",
-        world: "USER_SCRIPT",
-        excludeMatches,
-        excludeGlobs,
-      });
-    }
 
+    let retContent: chrome.scripting.RegisteredContentScript[] = [];
+    let retInject: chrome.userScripts.RegisteredUserScript[] = [];
     // inject.js
     const injectJs = await this.getInjectJsCode();
     if (injectJs) {
-      const apiScripts = this.compileInjectUserScript(injectJs, messageFlag, {
+      // 构建inject.js的脚本注册信息
+      retInject = this.compileInjectUserScript(injectJs, messageFlag, {
         excludeMatches,
         excludeGlobs,
       });
-      retScript.push(...apiScripts);
+    }
+    // Note: Chrome does not support file.js?query
+    // 注意：Chrome 不支持 file.js?query
+    if (isFirefox()) {
+      // 使用 URLSearchParams 避免字符编码问题
+      retContent = [
+        {
+          id: "scriptcat-content",
+          js: [`/src/content.js?${new URLSearchParams({ usp_flag: messageFlag })}&usp_end`],
+          matches: ["<all_urls>"],
+          allFrames: true,
+          runAt: "document_start",
+          excludeMatches,
+        } satisfies chrome.scripting.RegisteredContentScript,
+      ];
+    } else {
+      const contentJs = await this.getContentJsCode();
+      if (contentJs) {
+        const codeBody = `(function (MessageFlag) {\n${contentJs}\n})('${messageFlag}')`;
+        const code = `${codeBody}${sourceMapTo("scriptcat-content.js")}\n`;
+        retInject.push({
+          id: "scriptcat-content",
+          js: [{ code }],
+          matches: ["<all_urls>"],
+          allFrames: true,
+          runAt: "document_start",
+          world: "USER_SCRIPT",
+          excludeMatches,
+          excludeGlobs,
+        } satisfies chrome.userScripts.RegisteredUserScript);
+      }
     }
 
-    return retScript;
+    return { content: retContent, inject: retInject };
   }
 
   // 如果是重复注册，需要先调用 unregisterUserscripts
@@ -869,8 +888,8 @@ export class RuntimeService {
     if (runtimeGlobal.registered) {
       // 异常情况
       // 检查scriptcat-content和scriptcat-inject是否存在
-      const res = await chrome.userScripts.getScripts({ ids: ["scriptcat-content", "scriptcat-inject"] });
-      if (res.length === 2) {
+      const res = await chrome.userScripts.getScripts({ ids: ["scriptcat-inject"] });
+      if (res.length === 1) {
         return;
       }
       // scriptcat-content/scriptcat-inject不存在的情况
@@ -894,9 +913,9 @@ export class RuntimeService {
     const particularScriptList = await this.getParticularScriptList(options);
     // getContentAndInjectScript依赖loadScriptMatchInfo
     // 需要等getParticularScriptList完成后再执行
-    const generalScriptList = await this.getContentAndInjectScript(options);
+    const { inject: injectScriptList, content: contentScriptList } = await this.getContentAndInjectScript(options);
 
-    const list: chrome.userScripts.RegisteredUserScript[] = [...particularScriptList, ...generalScriptList];
+    const list: chrome.userScripts.RegisteredUserScript[] = [...particularScriptList, ...injectScriptList];
 
     runtimeGlobal.registered = true;
     try {
@@ -921,6 +940,13 @@ export class RuntimeService {
         }
       }
     }
+    if (contentScriptList.length > 0) {
+      try {
+        await chrome.scripting.registerContentScripts(contentScriptList);
+      } catch (e: any) {
+        this.logger.error("register content.js error", Logger.E(e));
+      }
+    }
   }
 
   // 给指定tab发送消息

src/content.ts

@@ -5,13 +5,19 @@ import { CustomEventMessage } from "@Packages/message/custom_event_message";
 import { Server } from "@Packages/message/server";
 import ContentRuntime from "./app/service/content/content";
 import { ScriptExecutor } from "./app/service/content/script_executor";
-import { randomMessageFlag } from "./pkg/utils/utils";
+import { randomMessageFlag, getUspMessageFlag } from "./pkg/utils/utils";
 import type { Message } from "@Packages/message/types";
 
-/* global MessageFlag  */
+// @ts-ignore
+const MessageFlag: string | null = (typeof arguments === "object" && arguments?.[0]) || getUspMessageFlag();
 
-if (typeof chrome?.runtime?.onMessage?.addListener !== "function") {
-  // Firefox MV3 之类好像没有 chrome.runtime.onMessage.addListener ?
+if (!MessageFlag) {
+  console.error("MessageFlag is unavailable.");
+} else if (typeof chrome?.runtime?.onMessage?.addListener !== "function") {
+  // Firefox userScripts.RegisteredUserScript does not provide chrome.runtime.onMessage.addListener
+  // Firefox scripting.RegisteredContentScript does provide chrome.runtime.onMessage.addListener
+  // Firefox 的 userScripts.RegisteredUserScript 不提供 chrome.runtime.onMessage.addListener
+  // Firefox 的 scripting.RegisteredContentScript 提供 chrome.runtime.onMessage.addListener
   console.error("chrome.runtime.onMessage.addListener is not a function");
 } else {
   // 建立与service_worker页面的连接

src/pkg/utils/utils.ts

@@ -39,6 +39,31 @@ export const deferred = <T = void>(): Deferred<T> => {
   return { promise, resolve, reject };
 };
 
+export const getUspMessageFlag = () => {
+  const s = new Error().stack;
+  if (s) {
+    const search1 = "content.js?usp_flag=";
+    const len1 = search1.length;
+    const idx1 = s.indexOf(search1);
+    if (idx1 > 0) {
+      const search2 = "&usp_end";
+      const idx2 = s.indexOf(search2, idx1 + len1);
+      if (idx2 > 0) {
+        const param = s.substring(idx1 + len1, idx2);
+        try {
+          // 使用 URLSearchParams 避免字符编码问题
+          const uspString = `usp_flag=${param}`;
+          const usp = new URLSearchParams(uspString);
+          if (usp.size === 1) return usp.get("usp_flag") || null;
+        } catch (e) {
+          console.error(e);
+        }
+      }
+    }
+  }
+  return null;
+};
+
 export function isFirefox() {
   //@ts-ignore
   return typeof mozInnerScreenX !== "undefined";
@@ -206,7 +231,7 @@ export async function checkUserScriptsAvailable() {
     // Method call which throws if API permission or toggle is not enabled.
     chrome.userScripts;
     const ret: chrome.userScripts.RegisteredUserScript[] | any = await chrome.userScripts.getScripts({
-      ids: ["scriptcat-content", "undefined-id-3"],
+      ids: ["scriptcat-inject", "undefined-id-3"],
     });
     // 返回结果不是阵列的话表示API不可使用
     if (ret === undefined || ret === null || typeof ret[Symbol.iterator] !== "function") {
@@ -215,10 +240,10 @@ export async function checkUserScriptsAvailable() {
 
     if (ret[0]) {
       // API内部处理实际给予扩展权限才会有返回Script
-      // 含有 "scriptcat-content" 或 "undefined-id-3"
+      // 含有 "scriptcat-inject" 或 "undefined-id-3"
       return true;
     } else {
-      // 没有 "scriptcat-content" 和 "undefined-id-3"
+      // 没有 "scriptcat-inject" 和 "undefined-id-3"
       // 进行 "undefined-id-3" 的注册反注册测试
       // Chrome MV3 的一部分浏览器（如 Vivaldi ）没正确处理 MV3 UserScripts API 权限问题 (API内部处理没有给予扩展权限)
       // 此时会无法注册 (1. register 报错)