PoC: integration with ghostery/adblocker#4499 and uBo origin

.tool-versions

@@ -1 +1,2 @@
 nodejs 22.4.1
+deno 2.0.3

README.md

@@ -58,6 +58,6 @@ Ghostery relies on [contributions](https://github.com/ghostery/ghostery-extensio
 
 ## License
 
-[MPL-2.0](https://www.mozilla.org/en-US/MPL/2.0/) Copyright 2017-present Ghostery GmbH. All rights reserved.
+[GPL-3.0](https://www.gnu.org/licenses/gpl-3.0.en.html/) Copyright 2017-present Ghostery GmbH. All rights reserved.
 
 See [LICENSE](LICENSE)

package.json

@@ -19,6 +19,7 @@
     "locales": "npm run locales:setup && npm run locales.src",
     "xcode-export-locales": "rm -rf ./xcode/en.xcloc && xcodebuild -exportLocalizations -project ./xcode/Ghostery.xcodeproj -localizationPath ./xcode",
     "release": "./scripts/release.sh",
+    "update-scriptlets": "deno scripts/update-scriptlets.js --tagName 1.61.3b4 > ./src/rule_resources/scriptlets.js",
     "package": "./scripts/package.sh"
   },
   "devDependencies": {
@@ -66,5 +67,5 @@
     "email": "info@ghostery.com",
     "url": "https://www.ghostery.com"
   },
-  "license": "MPL-2.0"
+  "license": "GPL-3.0"
 }

scripts/build.js

@@ -211,6 +211,13 @@
   resolve(options.outDir, 'rule_resources', 'engine-trackerdb.dat'),
 );
 
+// copy scriptlets
+cpSync(
+  resolve(options.srcDir, 'rule_resources', 'scriptlets.js'),
+  resolve(options.outDir, 'rule_resources', 'scriptlets.js'),
+);
+
+
 // copy managed storage configuration
 if (manifest.storage?.managed_schema) {
   const path = resolve(options.srcDir, manifest.storage.managed_schema);

scripts/update-scriptlets.js

@@ -0,0 +1,70 @@
+// To be run in Deno
+
+const tagName = process.argv.includes('--tagName')
+  ? process.argv[process.argv.findIndex((o) => o === '--tagName') + 1]
+  : false;
+
+if (!tagName) {
+  throw new Error('pass argument --tagName <TAG_NAME>');
+}
+
+const { builtinScriptlets: scriptlets } = await import(
+  `https://raw.githubusercontent.com/gorhill/uBlock/${tagName}/src/js/resources/scriptlets.js`
+);
+
+console.log(`/*******************************************************************************
+
+    uBlock Origin - a comprehensive, efficient content blocker
+    Copyright (C) 2019-present Raymond Hill
+
+    This program is free software: you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with this program.  If not, see {http://www.gnu.org/licenses/}.
+
+    Home: https://github.com/gorhill/uBlock
+
+*/
+const scriptlets = {};
+${scriptlets
+  .map((scriptlet) => {
+    // Make full function
+    const fnLiteral = scriptlet.fn.toString();
+    if (fnLiteral.startsWith('class ')) {
+      return fnLiteral;
+    }
+
+    // Extract function call name
+    const callNameEndsAt = fnLiteral.indexOf('(');
+    if (callNameEndsAt === -1) {
+      return '';
+    }
+    const callName = fnLiteral.slice('function '.length, callNameEndsAt);
+
+    // Handle aliases
+    const names = [scriptlet.name];
+    if (scriptlet.aliases !== undefined) {
+      for (const alias of scriptlet.aliases) {
+        names.push(alias);
+      }
+    }
+
+    return `${fnLiteral}
+const __${callName} = {
+  callName: "${callName}",
+  dependencies: ${JSON.stringify(scriptlet.dependencies || [])},
+  fn: ${callName},
+};
+${names.map((name) => `scriptlets["${name}"] = __${callName};`).join('\n')}`;
+  })
+  .join('\n\n')}
+
+export default scriptlets;`);

src/background/adblocker.js

@@ -27,6 +27,7 @@ import { debugMode } from '/utils/debug.js';
 
 import { tabStats, updateTabStats } from './stats.js';
 import { getException } from './exceptions.js';
+import { default as scriptlets } from '../rule_resources/scriptlets.js';
 
 let options = Options;
 
@@ -260,7 +261,7 @@ async function injectCosmetics(details, config) {
   const isBootstrap = config.bootstrap;
 
   {
-    const cosmetics = engine.getCosmeticsFilters({
+    const { matches, allowGenericHides } = engine.matchCosmeticFilters({
       domain,
       hostname,
       url,
@@ -281,12 +282,72 @@ async function injectCosmetics(details, config) {
       getRulesFromDOM: !isBootstrap,
     });
 
-    if (isBootstrap && cosmetics.scripts.length > 0) {
-      injectScriptlets(cosmetics.scripts, tabId, frameId);
+    // Scriptlet sources including all dependencies
+    const includes = new Set();
+    // A list of call signatures extracted from filters
+    const signatures = [];
+    for (const match of matches) {
+      if (
+        match.exception !== undefined ||
+        match.filter.isScriptInject() === false
+      ) {
+        continue;
+      }
+
+      const parsed = match.filter.parseScript();
+      if (parsed === undefined) {
+        continue;
+      }
+
+      const scriptlet = scriptlets[parsed.name];
+      if (scriptlet === undefined) {
+        continue;
+      }
+
+      includes.add(scriptlet.fn.toString());
+
+      const resolves = [...scriptlet.dependencies];
+      while (resolves.length > 0) {
+        const dependency = scriptlets[resolves.shift()];
+        includes.add(dependency.fn.toString());
+
+        // Flatten dependencies of dependencies to resovles queue.
+        if (dependency !== undefined) {
+          resolves.push(...dependency.dependencies);
+        }
+      }
+
+      signatures.push(
+        `${scriptlet.callName}(${JSON.stringify(scriptlet.args)});`,
+      );
+    }
+
+    if (signatures.length !== 0) {
+      let script = '';
+      for (const include of includes) {
+        script += include + '\n';
+      }
+      for (const signature of signatures) {
+        script += signature + '\n';
+      }
+
+      injectScriptlets(script, tabId, frameId);
     }
 
-    if (cosmetics.styles) {
-      injectStyles(cosmetics.styles, tabId, frameId);
+    const { styles } = engine.injectCosmeticFilters({
+      url,
+
+      injectStyles: true,
+      injectScriptlets: false,
+      injectExtended: isBootstrap,
+      injectPureHasSafely: isBootstrap,
+
+      allowGenericHides,
+      getBaseRules: false,
+    });
+
+    if (styles) {
+      injectStyles(styles, tabId, frameId);
     }
   }
 

src/background/index.js

@@ -30,3 +30,5 @@ import './reporting/index.js';
 import './telemetry/index.js';
 
 import './devtools.js';
+import scriptlets from '../rule_resources/scriptlets.js';
+globalThis.scriptlets = scriptlets;