⚡️ GM注入优化 (#517)

* 简单代码清理

* 定义 IGM_Base

* 重构 GM Api 内部代码处理

* __methodInject__ 处理内部化

* 优化注入代码

* 增加 testMode、integrity内部化

* 🧪 修复单元测试

* 🧪 添加sandbox的this测试

* 代码修正

* 简化代码，更清晰

* 修正ScriptCat this行为

* 改用=>避免.call

* 单元测试修正

* 🧪 补充this单元测试

* 调整代码

---------

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

Author: cyfung1031

src/app/service/content/create_context.ts

@@ -1,112 +1,65 @@
 import { type ScriptRunResource } from "@App/app/repo/scripts";
 import { v4 as uuidv4 } from "uuid";
-import type { ApiValue } from "./types";
 import type { Message } from "@Packages/message/types";
 import EventEmitter from "eventemitter3";
 import { GMContextApiGet } from "./gm_context";
 import { GM_Base } from "./gm_api";
 
-// 设置api依赖
-function setDepend(context: { [key: string]: any }, apiVal: ApiValue) {
-  if (apiVal.param.depend) {
-    for (let i = 0; i < apiVal.param.depend.length; i += 1) {
-      const value = apiVal.param.depend[i];
-      const dependApi = GMContextApiGet(value);
-      if (!dependApi) {
-        return;
-      }
-      if (value.startsWith("GM.")) {
-        const [, t] = value.split(".");
-        (<{ [key: string]: any }>context.GM)[t] = dependApi.api.bind(context);
-      } else {
-        context[value] = dependApi.api.bind(context);
-      }
-      setDepend(context, dependApi);
-    }
-  }
-}
-
 // 构建沙盒上下文
-export function createContext(scriptRes: ScriptRunResource, GMInfo: any, envPrefix: string, message: Message): GM_Base {
+export function createContext(
+  scriptRes: ScriptRunResource,
+  GMInfo: any,
+  envPrefix: string,
+  message: Message,
+  scriptGrants: Set<string>
+) {
   // 按照GMApi构建
   const valueChangeListener = new Map<number, { name: string; listener: GMTypes.ValueChangeListener }>();
   const EE: EventEmitter = new EventEmitter();
-  const context: GM_Base & { [key: string]: any } = new GM_Base(envPrefix, message, scriptRes, valueChangeListener, EE);
-  Object.assign(context, {
+  const context = GM_Base.create({
+    prefix: envPrefix,
+    message,
+    scriptRes,
+    valueChangeListener,
+    EE,
     runFlag: uuidv4(),
     eventId: 10000,
     GM: { info: GMInfo },
     GM_info: GMInfo,
     window: {
       onurlchange: null,
     },
+    grantSet: new Set(),
   });
-  if (scriptRes.metadata.grant) {
-    const GM_cookie = function (action: string) {
-      return (
-        details: GMTypes.CookieDetails,
-        done: (cookie: GMTypes.Cookie[] | any, error: any | undefined) => void
-      ) => {
-        return context["GM_cookie"](action, details, done);
-      };
-    };
-    // 处理GM.与GM_，将GM_与GM.都复制一份
-    const grant: string[] = [];
-    scriptRes.metadata.grant.forEach((val) => {
-      if (val.startsWith("GM_")) {
-        const t = val.slice(3);
-        grant.push(`GM.${t}`);
-      } else if (val.startsWith("GM.")) {
-        grant.push(val);
-      }
-      grant.push(val);
-    });
-    // 去重
-    const uniqueGrant = new Set(grant);
-    uniqueGrant.forEach((val) => {
-      const api = GMContextApiGet(val);
-      if (!api) {
-        return;
+  const __methodInject__ = (grant: string): boolean => {
+    const grantSet: Set<string> = context.grantSet;
+    const s = GMContextApiGet(grant);
+    if (!s) return false; // @grant 的定义未实作，略过 (返回 false 表示 @grant 不存在)
+    if (grantSet.has(grant)) return true; // 重覆的@grant，略过 (返回 true 表示 @grant 存在)
+    grantSet.add(grant);
+    for (const t of s) {
+      const fnKeyArray = t.fnKey.split(".");
+      const m = fnKeyArray.length - 1;
+      let g = context;
+      for (let i = 0; i < m; i++) {
+        const part = fnKeyArray[i];
+        g = g[part] || (g[part] = {});
       }
-      if (/^(GM|window)\./.test(val)) {
-        const [n, t] = val.split(".");
-        if (t === "cookie") {
-          const createGMCookePromise = (action: string) => {
-            return (details: GMTypes.CookieDetails = {}) => {
-              return new Promise((resolve, reject) => {
-                const fn = GM_cookie(action);
-                fn(details, function (cookie, error) {
-                  if (error) {
-                    reject(error);
-                  } else {
-                    resolve(cookie);
-                  }
-                });
-              });
-            };
-          };
-          context[n][t] = {
-            list: createGMCookePromise("list"),
-            delete: createGMCookePromise("delete"),
-            set: createGMCookePromise("set"),
-          };
-          context["GM_cookie"] = api.api.bind(context);
-        } else {
-          (<{ [key: string]: any }>context[n])[t] = api.api.bind(context);
+      const finalPart = fnKeyArray[m];
+      if (g[finalPart]) continue;
+      g[finalPart] = t.api.bind(context);
+      const depend = t?.param?.depend;
+      if (depend) {
+        for (const grant of depend) {
+          __methodInject__(grant);
         }
-      } else if (val === "GM_cookie") {
-        // 特殊处理GM_cookie.list之类
-        context[val] = api.api.bind(context);
-
-        context[val].list = GM_cookie("list");
-        context[val].delete = GM_cookie("delete");
-        context[val].set = GM_cookie("set");
-      } else {
-        context[val] = api.api.bind(context);
       }
-      setDepend(context, api);
-    });
+    }
+    return true;
+  };
+  for (const grant of scriptGrants) {
+    __methodInject__(grant);
   }
   context.unsafeWindow = window;
-  return <GM_Base>context;
+  return context;
 }

src/app/service/content/exec_script.test.ts

@@ -12,14 +12,12 @@ const scriptRes = {
   id: 0,
   name: "test",
   metadata: {
+    grant: ["none"],
     version: ["1.0.0"],
   },
   code: "console.log('test')",
   sourceCode: "sourceCode",
   value: {},
-  grantMap: {
-    none: true,
-  },
 } as unknown as ScriptRunResource;
 const envInfo: GMInfoEnv = {
   sandboxMode: "raw",
@@ -32,7 +30,7 @@ const envInfo: GMInfoEnv = {
 };
 
 // @ts-ignore
-const noneExec = new ExecScript(scriptRes, undefined, undefined, undefined, envInfo, undefined);
+const noneExec = new ExecScript(scriptRes, undefined, undefined, undefined, envInfo);
 
 const scriptRes2 = {
   id: 0,
@@ -43,26 +41,27 @@ const scriptRes2 = {
   code: "console.log('test')",
   sourceCode: "sourceCode",
   value: {},
-  grantMap: {},
 } as unknown as ScriptRunResource;
 
 // @ts-ignore
-const sandboxExec = new ExecScript(scriptRes2, undefined, undefined, undefined, envInfo, undefined);
+const sandboxExec = new ExecScript(scriptRes2, undefined, undefined, undefined, envInfo);
 
 describe("GM_info", () => {
   it("none", async () => {
-    scriptRes.code = "return GM_info";
+    scriptRes.code = "return {_this:this,GM_info};";
     noneExec.scriptFunc = compileScript(compileScriptCode(scriptRes));
     const ret = await noneExec.exec();
-    expect(ret.version).toEqual(ExtVersion);
-    expect(ret.script.version).toEqual("1.0.0");
+    expect(ret.GM_info.version).toEqual(ExtVersion);
+    expect(ret.GM_info.script.version).toEqual("1.0.0");
+    expect(ret._this).toEqual(global);
   });
   it("sandbox", async () => {
-    scriptRes2.code = "return GM_info";
+    scriptRes2.code = "return {_this:this,GM_info};";
     sandboxExec.scriptFunc = compileScript(compileScriptCode(scriptRes2));
     const ret = await sandboxExec.exec();
-    expect(ret.version).toEqual(ExtVersion);
-    expect(ret.script.version).toEqual("1.0.0");
+    expect(ret.GM_info.version).toEqual(ExtVersion);
+    expect(ret.GM_info.script.version).toEqual("1.0.0");
+    expect(ret._this).toEqual(sandboxExec.proxyContent);
   });
 });
 
@@ -129,3 +128,58 @@ describe("sandbox", () => {
     expect(ret).toEqual("3");
   });
 });
+
+describe("this", () => {
+  it("onload", async () => {
+    scriptRes2.code = `onload = ()=>{};return onload;`;
+    sandboxExec.scriptFunc = compileScript(compileScriptCode(scriptRes2));
+    const ret = await sandboxExec.exec();
+    expect(ret).toEqual(expect.any(Function));
+    // global.onload
+    expect(global.onload).toBeNull();
+  });
+  it("this.onload", async () => {
+    scriptRes2.code = `this.onload = () => "ok"; return this.onload;`;
+    sandboxExec.scriptFunc = compileScript(compileScriptCode(scriptRes2));
+    const ret = await sandboxExec.exec();
+    expect(ret).toEqual(expect.any(Function));
+    // global.onload
+    expect(global.onload).toBeNull();
+  });
+  it("undefined variable", async () => {
+    scriptRes2.code = `return typeof testVar;`;
+    sandboxExec.scriptFunc = compileScript(compileScriptCode(scriptRes2));
+    const ret = await sandboxExec.exec();
+    expect(ret).toEqual("undefined");
+  });
+  it("undefined variable in global", async () => {
+    scriptRes2.code = `return testVar;`;
+    sandboxExec.scriptFunc = compileScript(compileScriptCode(scriptRes2));
+    // 在沙盒中访问未定义的变量会抛出错误
+    try {
+      await sandboxExec.exec();
+      // 如果没有抛出错误，测试应该失败
+      expect.fail("Expected an error to be thrown when accessing undefined variable");
+    } catch (e: any) {
+      expect(e.message).toContain("testVar is not defined");
+    }
+  });
+});
+
+describe("none this", () => {
+  it("onload", async () => {
+    scriptRes2.code = `onload = ()=>{};return onload;`;
+    noneExec.scriptFunc = compileScript(compileScriptCode(scriptRes2));
+    const ret = await noneExec.exec();
+    expect(ret).toEqual(expect.any(Function));
+    // global.onload
+    expect(global.onload).toEqual(expect.any(Function));
+    global.onload = null; // 清理全局变量
+  });
+  it("this.test", async () => {
+    scriptRes2.code = `this.test = "ok";return this.test;`;
+    noneExec.scriptFunc = compileScript(compileScriptCode(scriptRes2));
+    const ret = await noneExec.exec();
+    expect(ret).toEqual("ok");
+  });
+});

src/app/service/content/exec_script.ts

@@ -7,7 +7,7 @@ import type { Message } from "@Packages/message/types";
 import type { ScriptLoadInfo } from "../service_worker/types";
 import type { ValueUpdateData } from "./types";
 import { evaluateGMInfo } from "./gm_info";
-import { type GM_Base } from "./gm_api";
+import { type IGM_Base } from "./gm_api";
 
 // 执行脚本,控制脚本执行与停止
 export default class ExecScript {
@@ -17,44 +17,47 @@ export default class ExecScript {
 
   logger: Logger;
 
-  proxyContent: any;
+  proxyContent: typeof globalThis;
 
-  sandboxContent?: GM_Base;
+  sandboxContent?: IGM_Base & { [key: string]: any };
 
-  GM_info: any;
+  named?: { [key: string]: any };
 
   constructor(
     scriptRes: ScriptLoadInfo,
     envPrefix: "content" | "offscreen",
     message: Message,
     code: string | ScriptFunc,
     envInfo: GMInfoEnv,
-    thisContext?: { [key: string]: any }
+    globalInjection?: { [key: string]: any } // 主要是全域API. @grant none 时无效
   ) {
     this.scriptRes = scriptRes;
     this.logger = LoggerCore.getInstance().logger({
       component: "exec",
       uuid: this.scriptRes.uuid,
       name: this.scriptRes.name,
     });
-    this.GM_info = evaluateGMInfo(envInfo, this.scriptRes);
+    const GM_info = evaluateGMInfo(envInfo, this.scriptRes);
     // 构建脚本资源
     if (typeof code === "string") {
       this.scriptFunc = compileScript(code);
     } else {
       this.scriptFunc = code;
     }
-    const grantMap: { [key: string]: boolean } = {};
-    scriptRes.metadata.grant?.forEach((key) => {
-      grantMap[key] = true;
-    });
-    if (grantMap.none) {
+    const grantSet = new Set(scriptRes.metadata.grant || []);
+    if (grantSet.has("none")) {
       // 不注入任何GM api
       this.proxyContent = global;
+      // ScriptCat行为：GM.info 和 GM_info 同时注入
+      // 不改变Context情况下，以 named 传多於一个全域变量
+      this.named = {GM: {info: GM_info}, GM_info};
     } else {
       // 构建脚本GM上下文
-      this.sandboxContent = createContext(scriptRes, this.GM_info, envPrefix, message);
-      this.proxyContent = proxyContext(global, this.sandboxContent, thisContext);
+      this.sandboxContent = createContext(scriptRes, GM_info, envPrefix, message, grantSet);
+      if (globalInjection) {
+        Object.assign(this.sandboxContent, globalInjection);
+      }
+      this.proxyContent = proxyContext(global, this.sandboxContent);
     }
   }
 
@@ -67,9 +70,14 @@ export default class ExecScript {
     this.sandboxContent?.valueUpdate(data);
   }
 
+  /**
+   * @see {@link compileScriptCode}
+   * @returns
+   */
   exec() {
     this.logger.debug("script start");
-    return this.scriptFunc.apply(this.proxyContent, [this.proxyContent, this.GM_info]);
+    const context = this.proxyContent;
+    return this.scriptFunc.call(context, this.named, this.scriptRes.name);
   }
 
   stop() {