♻️ 优化引导与脚本站外部调用等功能

CodFrm · CodFrm · commit 223da3090484 · 2025-04-28T15:22:52.000+08:00
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "scriptcat",
-  "version": "0.17.0-alpha.3",
+  "version": "0.17.0-alpha.4",
   "description": "脚本猫,一个可以执行用户脚本的浏览器扩展,万物皆可脚本化,让你的浏览器可以做更多的事情!",
   "author": "CodFrm",
   "license": "GPLv3",
diff --git a/src/app/migrate.ts b/src/app/migrate.ts
@@ -113,7 +113,6 @@ function renameField() {
         if (subscribe.length) {
           await Promise.all(
             subscribe.map((s: Subscribe) => {
-              console.log("1234", s);
               const { url, name, code, author, scripts, metadata, status, createtime, updatetime, checktime } = s;
               return subscribeDAO.save({
                 url,
diff --git a/src/app/service/content/content.ts b/src/app/service/content/content.ts
@@ -23,6 +23,7 @@ export default class ContentRuntime {
       // 转发给inject
       return sendMessage(this.msg, "inject/runtime/valueUpdate", data);
     });
+    forwardMessage("serviceWorker", "script/isInstalled", this.server, this.extSend);
     forwardMessage(
       "serviceWorker",
       "runtime/gmApi",
diff --git a/src/app/service/content/inject.ts b/src/app/service/content/inject.ts
@@ -4,6 +4,8 @@ import ExecScript, { ValueUpdateData } from "./exec_script";
 import { addStyle, ScriptFunc } from "./utils";
 import { getStorageName } from "@App/pkg/utils/utils";
 import { EmitEventRequest } from "../service_worker/runtime";
+import { ExternalWhitelist } from "@App/app/const";
+import { sendMessage } from "@Packages/message/client";
 
 export class InjectRuntime {
   execList: ExecScript[] = [];
@@ -44,6 +46,40 @@ export class InjectRuntime {
           val.valueUpdate(data);
         });
     });
+    // 注入允许外部调用
+    this.externalMessage();
+  }
+
+  externalMessage() {
+    // 对外接口白名单
+    let msg = this.msg;
+    for (let i = 0; i < ExternalWhitelist.length; i += 1) {
+      if (window.location.host.endsWith(ExternalWhitelist[i])) {
+        // 注入
+        (<{ external: any }>(<unknown>window)).external = window.external || {};
+        (<
+          {
+            external: {
+              Scriptcat: {
+                isInstalled: (name: string, namespace: string, callback: any) => void;
+              };
+            };
+          }
+        >(<unknown>window)).external.Scriptcat = {
+          async isInstalled(name: string, namespace: string, callback: any) {
+            const resp = await sendMessage(msg, "content/script/isInstalled", {
+              name,
+              namespace,
+            });
+            callback(resp);
+          },
+        };
+        (<{ external: { Tampermonkey: any } }>(<unknown>window)).external.Tampermonkey = (<
+          { external: { Scriptcat: any } }
+        >(<unknown>window)).external.Scriptcat;
+        break;
+      }
+    }
   }
 
   execScript(script: ScriptRunResouce, scriptFunc: ScriptFunc) {
diff --git a/src/app/service/service_worker/index.ts b/src/app/service/service_worker/index.ts
@@ -9,6 +9,8 @@ import { PopupService } from "./popup";
 import { SystemConfig } from "@App/pkg/config/config";
 import { SynchronizeService } from "./synchronize";
 import { SubscribeService } from "./subscribe";
+import { ExtServer, ExtVersion } from "@App/app/const";
+import { systemConfig } from "@App/pages/store/global";
 
 export type InstallSource = "user" | "system" | "sync" | "subscribe" | "vscode";
 
@@ -78,8 +80,17 @@ export default class ServiceWorkerManager {
         case "checkSubscribeUpdate":
           subscribe.checkSubscribeUpdate();
           break;
+        case "checkUpdate":
+          // 检查扩展更新
+          this.checkUpdate();
+          break;
       }
     });
+    // 8小时检查一次扩展更新
+    chrome.alarms.create("checkUpdate", {
+      delayInMinutes: 0,
+      periodInMinutes: 8 * 60,
+    });
 
     // 监听配置变化
     this.mq.subscribe("systemConfigChange", (msg) => {
@@ -96,4 +107,18 @@ export default class ServiceWorkerManager {
       synchronize.cloudSyncConfigChange(config);
     });
   }
+
+  checkUpdate() {
+    fetch(`${ExtServer}api/v1/system/version?version=${ExtVersion}`)
+      .then((resp) => resp.json())
+      .then((resp: { data: { notice: string; version: string } }) => {
+        systemConfig.getCheckUpdate().then((items) => {
+          if (items.notice !== resp.data.notice) {
+            systemConfig.setCheckUpdate(Object.assign(resp.data, { isRead: false }));
+          } else {
+            systemConfig.setCheckUpdate(Object.assign(resp.data, { isRead: items.isRead }));
+          }
+        });
+      });
+  }
 }
diff --git a/src/app/service/service_worker/runtime.ts b/src/app/service/service_worker/runtime.ts
@@ -15,7 +15,7 @@ import { subscribeScriptDelete, subscribeScriptEnable, subscribeScriptInstall }
 import { ScriptService } from "./script";
 import { runScript, stopScript } from "../offscreen/client";
 import { getRunAt } from "./utils";
-import { randomString } from "@App/pkg/utils/utils";
+import { InfoNotification, isUserScriptsAvailable, randomString } from "@App/pkg/utils/utils";
 import Cache from "@App/app/cache";
 import { dealPatternMatches, UrlMatch } from "@App/pkg/utils/match";
 import { ExtensionContentMessageSend } from "@Packages/message/extension_message";
@@ -27,6 +27,8 @@ import LoggerCore from "@App/app/logger/core";
 import PermissionVerify from "./permission_verify";
 import { SystemConfig } from "@App/pkg/config/config";
 import { ResourceService } from "./resource";
+import { LocalStorageDAO } from "@App/app/repo/localStorage";
+import i18n from "@App/locales/locales";
 
 // 为了优化性能，存储到缓存时删除了code、value与resource
 export interface ScriptMatchInfo extends ScriptRunResouce {
@@ -49,6 +51,8 @@ export class RuntimeService {
   scriptCustomizeMatch: UrlMatch<string> = new UrlMatch<string>();
   scriptMatchCache: Map<string, ScriptMatchInfo> | null | undefined;
 
+  isEnableDeveloperMode = false;
+
   constructor(
     private systemConfig: SystemConfig,
     private group: Group,
@@ -70,6 +74,34 @@ export class RuntimeService {
     this.group.on("runScript", this.runScript.bind(this));
     this.group.on("pageLoad", this.pageLoad.bind(this));
 
+    // 检查是否开启了开发者模式
+    this.isEnableDeveloperMode = isUserScriptsAvailable();
+    if (!this.isEnableDeveloperMode) {
+      // 未开启加上警告引导
+      // 判断是否首次
+      const localStorage = new LocalStorageDAO();
+      localStorage.get("firstShowDeveloperMode").then((res) => {
+        if (!res) {
+          localStorage.save({
+            key: "firstShowDeveloperMode",
+            value: true,
+          });
+          // 打开页面
+          chrome.tabs.create({
+            url: `https://docs.scriptcat.org/docs/use/open-dev/`,
+          });
+        }
+      });
+      chrome.action.setBadgeBackgroundColor({
+        color: "#ff8c00",
+      });
+      chrome.action.setBadgeTextColor({
+        color: "#ffffff",
+      });
+      chrome.action.setBadgeText({
+        text: "!",
+      });
+    }
     // 读取inject.js注入页面
     this.registerInjectScript();
     // 监听脚本开启
@@ -434,7 +466,7 @@ export class RuntimeService {
     this.addScriptMatch(scriptMatchInfo);
 
     // 如果脚本开启, 则注册脚本
-    if (script.status === SCRIPT_STATUS_ENABLE) {
+    if (this.isEnableDeveloperMode && script.status === SCRIPT_STATUS_ENABLE) {
       if (!scriptRes.metadata["noframes"]) {
         registerScript.allFrames = true;
       }
@@ -462,7 +494,7 @@ export class RuntimeService {
   }
 
   async unregistryPageScript(uuid: string) {
-    if (!(await Cache.getInstance().get("registryScript:" + uuid))) {
+    if (!this.isEnableDeveloperMode || !(await Cache.getInstance().get("registryScript:" + uuid))) {
       return;
     }
     chrome.userScripts.unregister(
diff --git a/src/app/service/service_worker/script.ts b/src/app/service/service_worker/script.ts
@@ -21,6 +21,7 @@ import { ResourceService } from "./resource";
 import { ValueService } from "./value";
 import { compileScriptCode } from "../content/utils";
 import { SystemConfig } from "@App/pkg/config/config";
+import i18n, { localePath } from "@App/locales/locales";
 
 export class ScriptService {
   logger: Logger;
@@ -59,50 +60,55 @@ export class ScriptService {
         // 读取脚本url内容, 进行安装
         const logger = this.logger.with({ url: targetUrl });
         logger.debug("install script");
-        this.openInstallPageByUrl(targetUrl, "user").catch((e) => {
-          logger.error("install script error", Logger.E(e));
-          // 如果打开失败, 则重定向到安装页
-          chrome.scripting.executeScript({
-            target: { tabId: req.tabId },
-            func: function () {
-              history.back();
-            },
-          });
-          // 并不再重定向当前url
-          chrome.declarativeNetRequest.updateDynamicRules(
-            {
-              removeRuleIds: [2],
-              addRules: [
-                {
-                  id: 2,
-                  priority: 1,
-                  action: {
-                    type: chrome.declarativeNetRequest.RuleActionType.ALLOW,
+        this.openInstallPageByUrl(targetUrl, "user")
+          .catch((e) => {
+            logger.error("install script error", Logger.E(e));
+            // 不再重定向当前url
+            chrome.declarativeNetRequest.updateDynamicRules(
+              {
+                removeRuleIds: [2],
+                addRules: [
+                  {
+                    id: 2,
+                    priority: 1,
+                    action: {
+                      type: chrome.declarativeNetRequest.RuleActionType.ALLOW,
+                    },
+                    condition: {
+                      regexFilter: targetUrl,
+                      resourceTypes: [chrome.declarativeNetRequest.ResourceType.MAIN_FRAME],
+                      requestMethods: [chrome.declarativeNetRequest.RequestMethod.GET],
+                    },
                   },
-                  condition: {
-                    regexFilter: targetUrl,
-                    resourceTypes: [chrome.declarativeNetRequest.ResourceType.MAIN_FRAME],
-                    requestMethods: [chrome.declarativeNetRequest.RequestMethod.GET],
-                  },
-                },
-              ],
-            },
-            () => {
-              if (chrome.runtime.lastError) {
-                console.error(chrome.runtime.lastError);
+                ],
+              },
+              () => {
+                if (chrome.runtime.lastError) {
+                  console.error(chrome.runtime.lastError);
+                }
               }
-            }
-          );
-        });
+            );
+          })
+          .finally(() => {
+            // 回退到到安装页
+            chrome.scripting.executeScript({
+              target: { tabId: req.tabId },
+              func: function () {
+                history.back();
+              },
+            });
+          });
       },
       {
         urls: [
-          "https://docs.scriptcat.org/docs/script_installation",
+          "https://docs.scriptcat.org/docs/script_installation/",
+          "https://docs.scriptcat.org/en/docs/script_installation/",
           "https://www.tampermonkey.net/script_installation.php",
         ],
         types: ["main_frame"],
       }
     );
+    // 获取i18n
     // 重定向到脚本安装页
     chrome.declarativeNetRequest.updateDynamicRules(
       {
@@ -114,7 +120,7 @@ export class ScriptService {
             action: {
               type: chrome.declarativeNetRequest.RuleActionType.REDIRECT,
               redirect: {
-                regexSubstitution: "https://docs.scriptcat.org/docs/script_installation#url=\\0",
+                regexSubstitution: `https://docs.scriptcat.org${localePath}/docs/script_installation/#url=\\0`,
               },
             },
             condition: {
@@ -479,6 +485,15 @@ export class ScriptService {
     return this.checkUpdate(uuid, "user");
   }
 
+  isInstalled({ name, namespace }: { name: string; namespace: string }) {
+    return this.scriptDAO.findByNameAndNamespace(name, namespace).then((script) => {
+      if (script) {
+        return { installed: true, version: script.metadata.version && script.metadata.version[0] };
+      }
+      return { installed: false };
+    });
+  }
+
   init() {
     this.listenerScriptInstall();
 
@@ -494,6 +509,7 @@ export class ScriptService {
     this.group.on("resetMatch", this.resetMatch.bind(this));
     this.group.on("resetExclude", this.resetExclude.bind(this));
     this.group.on("requestCheckUpdate", this.requestCheckUpdate.bind(this));
+    this.group.on("isInstalled", this.isInstalled.bind(this));
 
     // 定时检查更新, 每10分钟检查一次
     chrome.alarms.create("checkScriptUpdate", {
diff --git a/src/locales/locales.ts b/src/locales/locales.ts
@@ -27,10 +27,15 @@ i18n.use(initReactI18next).init({
   },
 });
 
+export let localePath = "";
+
 chrome.i18n.getAcceptLanguages((lngs) => {
-  systemConfig.getLanguage().then((lng) => {
+  systemConfig.getLanguage(lngs).then((lng) => {
     i18n.changeLanguage(lng);
     dayjs.locale(lng.toLocaleLowerCase());
+    if (lng !== "zh-CN") {
+      localePath = "en";
+    }
   });
 });
 
diff --git a/src/locales/zh-CN/translation.json b/src/locales/zh-CN/translation.json
@@ -368,5 +368,6 @@
   "eslint_config_format_error": "eslint配置格式错误",
   "export_success": "导出成功",
   "get_backup_dir_url_failed": "获取备份目录地址失败",
-  "get_backup_files_failed": "获取备份文件失败"
+  "get_backup_files_failed": "获取备份文件失败",
+  "develop_mode_guide": "检测到当前未开启开发者模式，您的脚本无法正常使用，<a href=\"https://docs.scriptcat.org/docs/use/open-dev/\" target=\"black\" style=\"color: var(--color-text-1)\">👉点我了解如何开启</a>"
 }
diff --git a/src/manifest.json b/src/manifest.json
@@ -1,7 +1,7 @@
 {
   "manifest_version": 3,
   "name": "__MSG_scriptcat__",
-  "version": "0.17.0.1004",
+  "version": "0.17.0.1005",
   "author": "CodFrm",
   "description": "__MSG_scriptcat_description__",
   "options_ui": {
diff --git a/src/pages/components/CodeEditor/index.tsx b/src/pages/components/CodeEditor/index.tsx
@@ -39,11 +39,9 @@ const CodeEditor: React.ForwardRefRenderFunction<{ editor: editor.IStandaloneCod
   }, []);
 
   useEffect(() => {
-    console.log("1231", code);
     if (diffCode === undefined || code === undefined || !div.current) {
       return () => {};
     }
-    console.log("1232");
     let edit: editor.IStandaloneDiffEditor | editor.IStandaloneCodeEditor;
     const inlineDiv = document.getElementById(id) as HTMLDivElement;
     // @ts-ignore
diff --git a/src/pages/options/routes/script/ScriptEditor.tsx b/src/pages/options/routes/script/ScriptEditor.tsx
diff --git a/src/pages/popup/App.tsx b/src/pages/popup/App.tsx
diff --git a/src/pkg/config/config.ts b/src/pkg/config/config.ts
diff --git a/src/pkg/utils/utils.ts b/src/pkg/utils/utils.ts

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "scriptcat",`
`3`		`- "version": "0.17.0-alpha.3",`
	`3`	`+ "version": "0.17.0-alpha.4",`
`4`	`4`	`"description": "脚本猫,一个可以执行用户脚本的浏览器扩展,万物皆可脚本化,让你的浏览器可以做更多的事情!",`
`5`	`5`	`"author": "CodFrm",`
`6`	`6`	`"license": "GPLv3",`
Original file line number	Diff line number	Diff line change
`@@ -368,5 +368,6 @@`
`368`	`368`	`"eslint_config_format_error": "eslint配置格式错误",`
`369`	`369`	`"export_success": "导出成功",`
`370`	`370`	`"get_backup_dir_url_failed": "获取备份目录地址失败",`
`371`		`- "get_backup_files_failed": "获取备份文件失败"`
	`371`	`+ "get_backup_files_failed": "获取备份文件失败",`
	`372`	`+ "develop_mode_guide": "检测到当前未开启开发者模式，您的脚本无法正常使用，<a href=\"https://docs.scriptcat.org/docs/use/open-dev/\" target=\"black\" style=\"color: var(--color-text-1)\">👉点我了解如何开启</a>"`
`372`	`373`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`{`
`2`	`2`	`"manifest_version": 3,`
`3`	`3`	`"name": "__MSG_scriptcat__",`
`4`		`- "version": "0.17.0.1004",`
	`4`	`+ "version": "0.17.0.1005",`
`5`	`5`	`"author": "CodFrm",`
`6`	`6`	`"description": "__MSG_scriptcat_description__",`
`7`	`7`	`"options_ui": {`