optimize run in all frames

Author: HoangTran0410

popup/helpers/utils.js

@@ -6,15 +6,19 @@ const CONTEXTS = [
 ];
 
 export const canClick = (script) => {
-  for (let s of CONTEXTS) {
-    if (typeof script[s]?.onClick === "function") return true;
+  for (let context of CONTEXTS) {
+    for (let fn of injectAllFramesFns(["onClick"])) {
+      if (typeof script[context]?.[fn] === "function") {
+        return true;
+      }
+    }
   }
   return false;
 };
 
 function hasChildFunction(object, excludedNamesSet = new Set()) {
   for (let key in object) {
-    if (key.startsWith("_")) continue;
+    if (key.startsWith("_")) continue; // ignore private member
     if (!object[key]) continue;
     if (excludedNamesSet.has(key)) continue;
     if (typeof object[key] === "function") return true;
@@ -25,19 +29,24 @@ function hasChildFunction(object, excludedNamesSet = new Set()) {
 }
 
 export const canAutoRun = (script) => {
-  let excludedNamesSet = new Set([
-    "onClick",
-    "onInstalled",
-    "onStartup",
-    "onMessage",
-    "contextMenus",
-  ]);
+  let excludedNameSet = new Set(
+    injectAllFramesFns([
+      "onClick",
+      "onInstalled",
+      "onStartup",
+      "onMessage",
+      "contextMenus",
+    ])
+  );
   for (let context of CONTEXTS) {
-    if (hasChildFunction(script[context], excludedNamesSet)) return true;
+    if (hasChildFunction(script[context], excludedNameSet)) return true;
   }
   return false;
 };
 
+// input ["onClick", "abc"] => output ["onClick", "onClick_", "abc", "abc_"]
+const injectAllFramesFns = (fns) => fns.map((key) => [key, key + "_"]).flat();
+
 export const isTitle = (script) => !(canClick(script) || canAutoRun(script));
 
 export async function viewScriptSource(script) {

popup/index.js

@@ -6,7 +6,7 @@ import {
   setActiveScript,
   trackEvent,
   Storage,
-  checkWillRun,
+  checkBlackWhiteList,
   runScriptInTabWithEventChain,
 } from "../scripts/helpers/utils.js";
 import { UfsGlobal } from "../scripts/content-scripts/ufs_global.js";
@@ -402,7 +402,7 @@ async function updateButtonChecker(script, checkmarkContainer, val) {
 
 async function runScript(script) {
   let tab = await getCurrentTab();
-  let willRun = checkWillRun(script, tab.url);
+  let willRun = checkBlackWhiteList(script, tab.url);
   if (willRun) {
     try {
       recentScriptsSaver.add(script);
@@ -411,25 +411,24 @@ async function runScript(script) {
       if (isFunction(script.popupScript?.onClick))
         await script.popupScript.onClick();
 
-      if (isFunction(script.pageScript?.onClick))
-        await runScriptInTabWithEventChain({
-          target: {
-            tabId: tab.id,
-          },
-          scriptIds: [script.id],
-          eventChain: "pageScript.onClick",
-          world: "MAIN",
-        });
-
-      if (isFunction(script.contentScript?.onClick))
-        await runScriptInTabWithEventChain({
-          target: {
-            tabId: tab.id,
-          },
-          scriptIds: [script.id],
-          eventChain: "contentScript.onClick",
-          world: "ISOLATED",
-        });
+      [
+        ["MAIN", "pageScript", "onClick", false],
+        ["MAIN", "pageScript", "onClick_", true],
+        ["ISOLATED", "contentScript", "onClick", false],
+        ["ISOLATED", "contentScript", "onClick_", true],
+      ].forEach(([world, context, func, allFrames]) => {
+        if (isFunction(script?.[context]?.[func])) {
+          runScriptInTabWithEventChain({
+            target: {
+              tabId: tab.id,
+              ...(allFrames ? { allFrames: true } : {}),
+            },
+            scriptIds: [script.id],
+            eventChain: context + "." + func,
+            world: world,
+          });
+        }
+      });
     } catch (e) {
       alert("ERROR: run script " + e);
     }

popup/tabs.js

@@ -704,7 +704,6 @@ const tabs = [
       s.studocu_bypassPreview,
       s.studyphim_unlimited,
       createTitle("--- Unlock function ---", "--- Mở khoá chức năng ---"),
-      s.removeWebLimit,
       s.simpleAllowCopy,
       s.detect_zeroWidthCharacters,
       s.injectScriptToWebsite,

scripts/_test.js

@@ -10,7 +10,7 @@ export default {
   },
 
   popupScript: {
-    onClick: async () => {
+    _onClick: async () => {
       const { UfsGlobal } = await import("./content-scripts/ufs_global.js");
       console.log(UfsGlobal);
     },
@@ -162,6 +162,14 @@ export default {
   },
 
   contentScript: {
+    onClick_: () => {
+      console.log(window.location.href);
+    },
+
+    onDocumentStart_: () => {
+      console.log("____onDocumentStart");
+    },
+
     // text size in KB
     _onClick: () => {
       function formatSize(size, fixed = 0) {

scripts/background-scripts/background_script.js

@@ -170,15 +170,19 @@ function runScriptsBackground(
 function checkWillRun(scriptId, context, eventChain, details) {
   const script = allScripts[scriptId];
   const s = script?.[context];
+
+  let beforeFnName = eventChain.split(".");
+  let fnName = beforeFnName.pop();
+
   let fn = s;
-  eventChain.split(".").forEach((e) => {
-    fn = fn?.[e];
-  });
+  beforeFnName.forEach((e) => (fn = fn?.[e]));
+  fn = fn?.[fnName + "_"] || fn?.[fnName];
+
   if (
     typeof fn === "function" &&
     (!details ||
-      ((s.runInAllFrames || details.frameType == "outermost_frame") &&
-        utils.checkWillRun(script, details.url)))
+      ((fn.name.endsWith("_") || details.frameType == "outermost_frame") &&
+        utils.checkBlackWhiteList(script, details.url)))
   )
     return fn;
 
@@ -318,10 +322,9 @@ function listenNavigation() {
         const { tabId, frameId } = getDetailIds(details);
 
         if (eventChain === "onDocumentStart") {
-          // clear badge cache on main frame
+          // clear badge cache on main frame load
           if (details.frameId === 0) CACHED.badges[tabId] = [];
-          // inject ufs global
-          injectUfsGlobal(tabId, frameId);
+          injectUfsGlobal(tabId, frameId, details);
         }
 
         runScriptsTab(eventChain, MAIN, details);
@@ -389,27 +392,27 @@ function listenMessage() {
   });
 }
 
-function injectUfsGlobal(tabId, frameId) {
+function injectUfsGlobal(tabId, frameId, details) {
   [
-    { files: ["ufs_global.js", "content_script.js"], world: ISOLATED },
-    { files: ["ufs_global.js"], world: MAIN },
-  ].forEach(({ files, world }) => {
+    [["ufs_global.js", "content_script.js"], ISOLATED],
+    [["ufs_global.js"], MAIN],
+  ].forEach(([files, world]) => {
     let paths = files.map((file) => CACHED.path + "content-scripts/" + file);
     utils.runScriptFile({
       target: {
         tabId: tabId,
         frameIds: [frameId],
       },
-      func: (paths, frameId, world) => {
+      func: (paths, frameId, world, url) => {
         paths.forEach((path) => {
           import(path)
-            .then(() => console.log("Ufs import SUCCESS", frameId, world, path))
+            .then(() => console.log("Ufs import SUCCESS", frameId, world, url))
             .catch((e) =>
-              console.error("Ufs import FAILED", frameId, world, e)
+              console.error("Ufs import FAILED", frameId, world, url, e)
             );
         });
       },
-      args: [paths, frameId, world],
+      args: [paths, frameId, world, details.url],
       world: world,
     });
   });

scripts/chongLuaDao.js

@@ -45,15 +45,16 @@ export default {
   },
 
   contentScript: {
+    // TODO analyze all iframes
     onDocumentIdle: (details) => {
-      if (details.frameType === "outermost_frame") analyzeWeb(true);
+      analyzeWeb(true);
     },
 
     onClick: () => analyzeWeb(false),
   },
 
   backgroundScript: {
-    onDocumentStart: async (details, context) => {
+    onDocumentStart_: async (details, context) => {
       if (!cached) await saveBgCache();
       if (!cached) return;
 
@@ -98,7 +99,6 @@ export default {
         });
       }
     },
-    runInAllFrames: true,
 
     runtime: {
       onInStalled: (reason, context) => {

scripts/helpers/utils.js

@@ -9,7 +9,7 @@ const CACHED = {
   userID: null,
 };
 
-export function checkWillRun(script, url = location?.href) {
+export function checkBlackWhiteList(script, url = location?.href) {
   if (!url) return false;
   let hasWhiteList = script.whiteList?.length > 0;
   let hasBlackList = script.blackList?.length > 0;
@@ -293,9 +293,12 @@ export const runScriptInTabWithEventChain = ({
           import(url)
             .then(({ default: script }) => {
               let fn = script;
-              eventChain.split(".").forEach((e) => {
-                fn = fn?.[e];
-              });
+
+              let beforeFnName = eventChain.split(".");
+              let fnName = beforeFnName.pop();
+              beforeFnName.forEach((e) => (fn = fn?.[e]));
+              fn = fn?.[fnName + "_"] || fn?.[fnName]; // higher priority for allframes function
+
               if (typeof fn === "function") {
                 if (!silent)
                   console.log(

scripts/index.js

@@ -148,7 +148,6 @@ import magnify_image from "./magnify_image.js";
 import auto_redirectLargestImageSrc from "./auto_redirectLargestImageSrc.js";
 import textToQrCode from "./textToQrCode.js";
 import insta_anonymousStoryViewer from "./insta_anonymousStoryViewer.js";
-import removeWebLimit from "./removeWebLimit.js";
 import _ufs_statistic from "./_ufs_statistic.js";
 import pip_fullWebsite from "./pip_fullWebsite.js";
 import similarWeb_bypassLimit from "./similarWeb_bypassLimit.js";
@@ -327,7 +326,6 @@ const allScripts = {
   ),
   textToQrCode: addBadge(textToQrCode, BADGES.new),
   insta_anonymousStoryViewer: addBadge(insta_anonymousStoryViewer, BADGES.new),
-  removeWebLimit: addBadge(removeWebLimit, BADGES.hot, BADGES.new),
   _ufs_statistic: _ufs_statistic,
   pip_fullWebsite: addBadge(pip_fullWebsite, BADGES.new),
   similarWeb_bypassLimit: addBadge(similarWeb_bypassLimit, BADGES.new),