@browserless.io/browserless 2.31.1 → 2.32.0

package/extensions/ublocklite/js/mode-parser.js

@@ -0,0 +1,211 @@
+/*******************************************************************************
+
+    uBlock Origin Lite - a comprehensive, MV3-compliant content blocker
+    Copyright (C) 2014-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
+*/
+
+import { i18n$ } from './i18n.js';
+import punycode from './punycode.js';
+
+/******************************************************************************/
+
+function selectParser(scope, modes, node) {
+    const parser = perScopeParsers[scope.join('.')];
+    if ( parser === undefined ) { return false; }
+    return parser(scope, modes, node);
+}
+
+const validModes = [
+    'none',
+    'basic',
+    'optimal',
+    'complete',
+];
+
+const uglyModeNames = {
+    [i18n$('filteringMode0Name')]: 'none',
+    [i18n$('filteringMode1Name')]: 'basic',
+    [i18n$('filteringMode2Name')]: 'optimal',
+    [i18n$('filteringMode3Name')]: 'complete',
+};
+
+const prettyModeNames = {
+    none: i18n$('filteringMode0Name'),
+    basic: i18n$('filteringMode1Name'),
+    optimal: i18n$('filteringMode2Name'),
+    complete: i18n$('filteringMode3Name'),
+};
+
+const perScopeParsers = {
+    '': function(scope, modes, node) {
+        const { key, val } = node;
+        switch ( key ) {
+        case 'none':
+        case 'basic':
+        case 'optimal':
+        case 'complete':
+        case prettyModeNames.none:
+        case prettyModeNames.basic:
+        case prettyModeNames.optimal:
+        case prettyModeNames.complete: {
+            const mode = uglyModeNames[key] || key;
+            if ( val !== undefined ) { return false; }
+            modes[mode] ||= [];
+            scope.push(mode);
+            break;
+        }
+        default:
+            return false;
+        }
+        return true;
+    },
+    none: function(scope, modes, node) {
+        return addHostnameToMode(modes, 'none', node)
+    },
+    basic: function(scope, modes, node) {
+        return addHostnameToMode(modes, 'basic', node)
+    },
+    optimal: function(scope, modes, node) {
+        return addHostnameToMode(modes, 'optimal', node)
+    },
+    complete: function(scope, modes, node) {
+        return addHostnameToMode(modes, 'complete', node)
+    },
+};
+
+const addHostnameToMode = (modes, mode, node) => {
+    if ( node.list !== true ) { return false; }
+    modes[mode].push(punycode.toASCII(node.val));
+};
+
+/******************************************************************************/
+
+function depthFromIndent(line) {
+    const match = /^\s*/.exec(line);
+    const count = match[0].length;
+    if ( (count & 1) !== 0 ) { return -1; }
+    return count / 2;
+}
+
+/******************************************************************************/
+
+function nodeFromLine(line) {
+    const match = reNodeParser.exec(line);
+    const out = {};
+    if ( match === null ) { return out; }
+    if ( match[1] ) {
+        out.list = true;
+    }
+    if ( match[4] ) {
+        out.val = match[4].trim();
+    } else if ( match[3] ) {
+        out.key = match[2];
+        out.val = match[3].trim();
+        if ( out.val === "''" ) { out.val = '' };
+    } else {
+        out.key = match[2];
+    }
+    return out;
+}
+
+const reNodeParser = /^\s*(- )?(?:([^:]+):( \S.*)?|(\S.*))$/;
+
+/******************************************************************************/
+
+export function modesFromText(text, justbad = false) {
+    const lines = [ ...text.split(/\n\r|\r\n|\n|\r/) ];
+    const indices = [];
+    for ( let i = 0; i < lines.length; i++ ) {
+        const line = lines[i].trimEnd();
+        if ( line.trim().startsWith('#') ) { continue; }
+        indices.push(i);
+    }
+    // Discard leading empty lines
+    while ( indices.length !== 0 ) {
+        const s = lines[indices[0]].trim();
+        if ( s.length !== 0 ) { break; }
+        indices.shift();
+    }
+    // Discard trailing empty lines
+    while ( indices.length !== 0 ) {
+        const s = lines[indices.at(-1)].trim();
+        if ( s.length !== 0 ) { break; }
+        indices.pop();
+    }
+    // Parse
+    const modes = {};
+    const bad = [];
+    const scope = [];
+    for ( const i of indices ) {
+        const line = lines[i];
+        const depth = depthFromIndent(line);
+        if ( depth < 0 ) {
+            bad.push(i);
+            continue;
+        }
+        scope.length = depth;
+        const node = nodeFromLine(line);
+        const result = selectParser(scope, modes, node);
+        if ( result === false ) {
+            bad.push(i);
+        }
+    }
+    if ( justbad ) {
+        return bad.length !== 0 ? { bad } : { };
+    }
+    // Ensure all modes are present, and that one mode is the default one
+    const seen = new Map();
+    let defaultMode = '';
+    for ( const mode of validModes ) {
+        modes[mode] = new Set(modes[mode]);
+        if ( modes[mode].has('all-urls') ) {
+            defaultMode = mode;
+        }
+        for ( const hn of modes[mode] ) {
+            if ( seen.has(hn) ) {
+                modes[seen.get(hn)].delete(hn);
+            }
+            seen.set(hn, mode);
+        }
+    }
+    if ( defaultMode === '' ) {
+        defaultMode = 'optimal';
+    }
+    modes[defaultMode].clear();
+    modes[defaultMode].add('all-urls');
+    for ( const mode of validModes ) {
+        modes[mode] = Array.from(modes[mode]);
+    }
+    return { modes };
+}
+
+/******************************************************************************/
+
+export function textFromModes(modes) {
+    const out = [];
+    for ( const mode of validModes ) {
+        const hostnames = modes[mode];
+        if ( hostnames === undefined ) { continue; }
+        out.push(`${prettyModeNames[mode]}:`);
+        for ( const hn of hostnames ) {
+            out.push(`  - ${punycode.toUnicode(hn)}`);
+        }
+    }
+    out.push('');
+    return out.join('\n');
+}

package/extensions/ublocklite/js/redirect-resources.js

@@ -0,0 +1,192 @@
+/*******************************************************************************
+
+    uBlock Origin - a comprehensive, efficient content blocker
+    Copyright (C) 2015-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
+*/
+
+/******************************************************************************/
+
+// The resources referenced below are found in ./web_accessible_resources/
+//
+// The content of the resources which declare a `data` property will be loaded
+// in memory, and converted to a suitable internal format depending on the
+// type of the loaded data. The `data` property allows for manual injection
+// through `+js(...)`, or for redirection to a data: URI when a redirection
+// to a web accessible resource is not desirable.
+
+export default new Map([
+    [ '1x1.gif', {
+        alias: '1x1-transparent.gif',
+        data: 'blob',
+    } ],
+    [ '2x2.png', {
+        alias: '2x2-transparent.png',
+        data: 'blob',
+    } ],
+    [ '3x2.png', {
+        alias: '3x2-transparent.png',
+        data: 'blob',
+    } ],
+    [ '32x32.png', {
+        alias: '32x32-transparent.png',
+        data: 'blob',
+    } ],
+    [ 'amazon_ads.js', {
+        alias: 'amazon-adsystem.com/aax2/amzn_ads.js',
+        data: 'text',
+    } ],
+    [ 'amazon_apstag.js', {
+    } ],
+    [ 'ampproject_v0.js', {
+        alias: 'ampproject.org/v0.js',
+    } ],  
+    [ 'chartbeat.js', {
+        alias: 'static.chartbeat.com/chartbeat.js',
+    } ],
+    [ 'click2load.html', {
+        params: [ 'aliasURL', 'url' ],
+    } ],
+    [ 'doubleclick_instream_ad_status.js', {
+        alias: 'doubleclick.net/instream/ad_status.js',
+        data: 'text',
+    } ],
+    [ 'empty', {
+        data: 'text',   // Important!
+    } ],
+    [ 'fingerprint2.js', {
+        data: 'text',
+    } ],
+    [ 'fingerprint3.js', {
+        data: 'text',
+    } ],
+    [ 'google-analytics_analytics.js', {
+        alias: [
+            'google-analytics.com/analytics.js',
+            'googletagmanager_gtm.js',
+            'googletagmanager.com/gtm.js'
+        ],
+        data: 'text',
+    } ],
+    [ 'google-analytics_cx_api.js', {
+        alias: 'google-analytics.com/cx/api.js',
+    } ],
+    [ 'google-analytics_ga.js', {
+        alias: 'google-analytics.com/ga.js',
+        data: 'text',
+    } ],
+    [ 'google-analytics_inpage_linkid.js', {
+        alias: 'google-analytics.com/inpage_linkid.js',
+    } ],
+    [ 'google-ima.js', {
+        alias: 'google-ima3',                       /* adguard compatibility */
+    } ],
+    [ 'googlesyndication_adsbygoogle.js', {
+        alias: [
+            'googlesyndication.com/adsbygoogle.js',
+            'googlesyndication-adsbygoogle',        /* adguard compatibility */
+        ],
+        data: 'text',
+    } ],
+    [ 'googletagservices_gpt.js', {
+        alias: [
+            'googletagservices.com/gpt.js',
+            'googletagservices-gpt',                /* adguard compatibility */
+        ],
+        data: 'text',
+    } ],
+    [ 'hd-main.js', {
+    } ],
+    [ 'nobab.js', {
+        alias: [ 'bab-defuser.js', 'prevent-bab.js' ],
+        data: 'text',
+    } ],
+    [ 'nobab2.js', {
+        data: 'text',
+    } ],
+    [ 'noeval.js', {
+        data: 'text',
+    } ],
+    [ 'noeval-silent.js', {
+        alias: 'silent-noeval.js',
+        data: 'text',
+    } ],
+    [ 'nofab.js', {
+        alias: 'fuckadblock.js-3.2.0',
+        data: 'text',
+    } ],
+    [ 'noop-0.1s.mp3', {
+        alias: [ 'noopmp3-0.1s', 'abp-resource:blank-mp3' ],
+        data: 'blob',
+    } ],
+    [ 'noop-0.5s.mp3', {
+    } ],
+    [ 'noop-1s.mp4', {
+        alias: [ 'noopmp4-1s', 'abp-resource:blank-mp4' ],
+        data: 'blob',
+    } ],
+    [ 'noop.css', {
+        data: 'text',
+    } ],
+    [ 'noop.html', {
+        alias: 'noopframe',
+    } ],
+    [ 'noop.js', {
+        alias: [ 'noopjs', 'abp-resource:blank-js' ],
+        data: 'text',
+    } ],
+    [ 'noop.json', {
+        alias: [ 'noopjson' ],
+        data: 'text',
+    } ],
+    [ 'noop.txt', {
+        alias: 'nooptext',
+        data: 'text',
+    } ],
+    [ 'noop-vast2.xml', {
+        alias: 'noopvast-2.0',
+        data: 'text',
+    } ],
+    [ 'noop-vast3.xml', {
+        alias: 'noopvast-3.0',
+        data: 'text',
+    } ],
+    [ 'noop-vast4.xml', {
+        alias: 'noopvast-4.0',
+        data: 'text',
+    } ],
+    [ 'noop-vmap1.xml', {
+        alias: [ 'noop-vmap1.0.xml', 'noopvmap-1.0' ],
+        data: 'text',
+    } ],
+    [ 'outbrain-widget.js', {
+        alias: 'widgets.outbrain.com/outbrain.js',
+    } ],
+    [ 'popads.js', {
+        alias: [ 'popads.net.js', 'prevent-popads-net.js' ],
+        data: 'text',
+    } ],
+    [ 'popads-dummy.js', {
+        data: 'text',
+    } ],
+    [ 'prebid-ads.js', {
+        data: 'text',
+    } ],
+    [ 'scorecardresearch_beacon.js', {
+        alias: 'scorecardresearch.com/beacon.js',
+    } ],
+]);

package/extensions/ublocklite/js/ro-dnr-editor.js

@@ -0,0 +1,95 @@
+/*******************************************************************************
+
+    uBlock Origin Lite - a comprehensive, MV3-compliant content blocker
+    Copyright (C) 2014-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
+*/
+
+import { DNREditor } from './dnr-editor.js';
+import { i18n$ } from './i18n.js';
+import { sendMessage } from './ext.js';
+import { textFromRules } from './dnr-parser.js';
+
+/******************************************************************************/
+
+export class ReadOnlyDNREditor extends DNREditor {
+    async getText(hint) {
+        if ( hint === 'dnr.ro.dynamic' ) {
+            const rules = await sendMessage({ what: 'getEffectiveDynamicRules' });
+            if ( Array.isArray(rules) === false ) { return; }
+            this.id = 'dynamic';
+            this.count = rules.length;
+            return textFromRules(rules, { keepId: true });
+        }
+        if ( hint === 'dnr.ro.session' ) {
+            const rules = await sendMessage({ what: 'getEffectiveSessionRules' });
+            if ( Array.isArray(rules) === false ) { return; }
+            this.id = 'session';
+            this.count = rules.length;
+            return textFromRules(rules, { keepId: true });
+        }
+        const match = /^dnr\.ro\.(.+)$/.exec(hint);
+        if ( match === null ) { return; }
+        this.id = match[1];
+        const allRulesetDetails = await sendMessage({ what: 'getRulesetDetails' });
+        const rulesetDetails = allRulesetDetails.find(a => a.id === this.id);
+        if ( rulesetDetails === undefined ) { return; }
+        const realms = {
+            plain: 'main',
+            regex: 'regex',
+            redirect: 'redirect',
+            modifyHeaders: 'modify-headers',
+            removeparam: 'removeparam',
+        };
+        const promises = [];
+        for ( const [ realm, dir ] of Object.entries(realms) ) {
+            if ( Boolean(rulesetDetails.rules?.[realm]) === false ) { continue; }
+            promises.push(
+                fetch(`./rulesets/${dir}/${this.id}.json`).then(response => response.json())
+            );
+        }
+        const parts = await Promise.all(promises);
+        const allRules = [];
+        for ( const rules of parts ) {
+            for ( const rule of rules ) {
+                allRules.push(rule);
+            }
+        }
+        this.count = allRules.length;
+        return textFromRules(allRules, { keepId: true });
+    }
+
+    on(editor) {
+        if ( typeof this.count !== 'number' ) {
+            return editor.updateSummaryPanel(null);
+        }
+        const template = document.querySelector('template.ro-summary-panel');
+        const fragment = template.content.cloneNode(true);
+        const root = fragment.querySelector('.summary-panel');
+        root.textContent = i18n$('dnrRulesCountInfo')
+            .replace('{count}', (this.count || 0).toLocaleString())
+        editor.updateSummaryPanel(root);
+    }
+
+    off(editor) {
+        editor.updateSummaryPanel(null);
+    }
+
+    exportToFile(text) {
+        return super.exportToFile(text, `${this.id}-dnr-ruleset.json`);
+    }
+};

package/extensions/ublocklite/js/ruleset-manager.js

@@ -306,19 +306,30 @@ async function updateDynamicRules() {
     if ( dynamicRegexCount !== 0 ) {
         ubolLog(`Using ${dynamicRegexCount}/${dnr.MAX_NUMBER_OF_REGEX_RULES} dynamic regex-based DNR rules`);
     }
-    return Promise.all([
-        dnr.updateDynamicRules({ addRules, removeRuleIds }).then(( ) => {
-            if ( removeRuleIds.length !== 0 ) {
-                ubolLog(`Remove ${removeRuleIds.length} dynamic DNR rules`);
-            }
-            if ( addRules.length !== 0 ) {
-                ubolLog(`Add ${addRules.length} dynamic DNR rules`);
-            }
-        }).catch(reason => {
-            console.error(`updateDynamicRules() / ${reason}`);
-        }),
-        updateSessionRules(),
-    ]);
+    try {
+        await dnr.updateDynamicRules({ addRules, removeRuleIds });
+        if ( removeRuleIds.length !== 0 ) {
+            ubolLog(`Remove ${removeRuleIds.length} dynamic DNR rules`);
+        }
+        if ( addRules.length !== 0 ) {
+            ubolLog(`Add ${addRules.length} dynamic DNR rules`);
+        }
+    } catch(reason) {
+        console.error(`updateDynamicRules() / ${reason}`);
+    }
+    await updateSessionRules();
+}
+
+/******************************************************************************/
+
+async function getEffectiveDynamicRules() {
+    const allRules = await dnr.getDynamicRules();
+    const dynamicRules = [];
+    for ( const rule of allRules ) {
+        if ( rule.id >= USER_RULES_BASE_RULE_ID ) { continue; }
+        dynamicRules.push(rule);
+    }
+    return dynamicRules;
 }
 
 /******************************************************************************/
@@ -441,16 +452,29 @@ async function updateSessionRules() {
     if ( sessionRegexCount !== 0 ) {
         ubolLog(`Using ${sessionRegexCount}/${dnr.MAX_NUMBER_OF_REGEX_RULES} session regex-based DNR rules`);
     }
-    return dnr.updateSessionRules({ addRules, removeRuleIds }).then(( ) => {
+    try {
+        await dnr.updateSessionRules({ addRules, removeRuleIds });
         if ( removeRuleIds.length !== 0 ) {
             ubolLog(`Remove ${removeRuleIds.length} session DNR rules`);
         }
         if ( addRules.length !== 0 ) {
             ubolLog(`Add ${addRules.length} session DNR rules`);
         }
-    }).catch(reason => {
+    } catch(reason) {
         console.error(`updateSessionRules() / ${reason}`);
-    });
+    }
+}
+
+/******************************************************************************/
+
+async function getEffectiveSessionRules() {
+    const allRules = await dnr.getSessionRules();
+    const sessionRules = [];
+    for ( const rule of allRules ) {
+        if ( rule.id >= USER_RULES_BASE_RULE_ID ) { continue; }
+        sessionRules.push(rule);
+    }
+    return sessionRules;
 }
 
 /******************************************************************************/
@@ -751,6 +775,8 @@ export {
     enableRulesets,
     excludeFromStrictBlock,
     filteringModesToDNR,
+    getEffectiveDynamicRules,
+    getEffectiveSessionRules,
     getEffectiveUserRules,
     getEnabledRulesetsDetails,
     getRulesetDetails,