@browserless.io/browserless 2.36.0 → 2.37.1

package/extensions/ublocklite/dashboard.html

@@ -25,6 +25,7 @@
             <span class="logo"><img data-i18n-title="extName" src="img/ublock.svg" alt="uBO Lite"></span><!--
          --><button class="tabButton" type="button" data-pane="settings" data-i18n="settingsPageName" tabindex="0"></button><!--
          --><button class="tabButton" type="button" data-pane="rulesets" data-i18n="aboutFilterLists" tabindex="0"></button><!--
+         --><button class="tabButton" type="button" data-pane="filters" data-i18n="customFiltersPageName"tabindex="0"></button><!--
          --><button class="tabButton" type="button" data-pane="develop" data-i18n="developPageName"tabindex="0"></button><!--
          --><button class="tabButton" type="button" data-pane="about" data-i18n="aboutPageName" tabindex="0"></button>
         </nav>
@@ -37,13 +38,6 @@
     </header>
     <!-- -------- -->
     <section data-pane="settings">
-        <div>
-            <h3 data-i18n="behaviorSectionLabel"></h3>
-            <p><label id="autoReload" data-i18n="autoReloadLabel"><span class="input checkbox"><input type="checkbox"><svg viewBox="0 0 24 24"><path d="M1.73,12.91 8.1,19.28 22.79,4.59"/></svg></span>_</label>
-            </p>
-            <p><label id="showBlockedCount" data-i18n="showBlockedCountLabel"><span class="input checkbox"><input type="checkbox"><svg viewBox="0 0 24 24"><path d="M1.73,12.91 8.1,19.28 22.79,4.59"/></svg></span>_</label>
-        </div>
-
         <div>
             <h3 data-i18n="defaultFilteringModeSectionLabel"></h3>
             <p data-i18n="defaultFilteringModeDescription"></p>
@@ -94,15 +88,43 @@
                     <div data-i18n="completeFilteringModeDescription"></div>
                 </label>
             </div>
-            <p><label id="strictBlockMode" data-i18n="enableStrictBlockLabel"><span class="input checkbox"><input type="checkbox"><svg viewBox="0 0 24 24"><path d="M1.73,12.91 8.1,19.28 22.79,4.59"/></svg></span>_</label><legend data-i18n="enableStrictBlockLegend"></legend>
+        </div>
+        <div>
+            <h3 data-i18n="behaviorSectionLabel"></h3>
+            <p><label id="autoReload" data-i18n="autoReloadLabel"><span class="input checkbox"><input type="checkbox"><svg viewBox="0 0 24 24"><path d="M1.73,12.91 8.1,19.28 22.79,4.59"/></svg></span>_</label>
+            </p>
+            <p><label id="showBlockedCount" data-i18n="showBlockedCountLabel"><span class="input checkbox"><input type="checkbox"><svg viewBox="0 0 24 24"><path d="M1.73,12.91 8.1,19.28 22.79,4.59"/></svg></span>_</label>
+            <p data-platform-exclude="safari"><label id="strictBlockMode" data-i18n="enableStrictBlockLabel"><span class="input checkbox"><input type="checkbox"><svg viewBox="0 0 24 24"><path d="M1.73,12.91 8.1,19.28 22.79,4.59"/></svg></span>_</label><legend data-i18n="enableStrictBlockLegend"></legend>
             <p id="developerMode"><label data-i18n="developerModeLabel"><span class="input checkbox"><input type="checkbox"><svg viewBox="0 0 24 24"><path d="M1.73,12.91 8.1,19.28 22.79,4.59"/></svg></span>_</label><legend data-i18n="developerModeLegend"></legend>
         </div>
+        <div>
+            <h3 data-i18n="settingsBackupRestoreLabel">_</h3>
+            <p data-i18n="settingsBackupRestoreSummary">_</p>
+            <p>
+                <button class="iconified dontshrink" type="button"><span class="fa-icon">download-alt</span><span data-i18n="backupButton">_</span><span class="hover"></span></button>
+                <button class="iconified dontshrink" type="button"><span class="fa-icon">upload-alt</span><span data-i18n="restoreButton">_</span><span class="hover"></span></button><input type="file" accept="application/json">
+            </p>
+        </div>
     </section>
     <!-- -------- -->
     <section data-pane="rulesets">
         <div id="lists"></div>
     </section>
     <!-- -------- -->
+    <section data-pane="filters">
+        <ul class="hostnames"></ul>
+        <aside>
+            <details class="importFromText"><summary data-i18n="customFiltersImportExportLabel">_</summary>
+                <div><textarea spellcheck="false" placeholder="customFiltersImportTextareaPlaceholder"></textarea></div>
+                <p>
+                    <button class="iconified dontshrink" type="button"><span class="fa-icon">check</span><span data-i18n="addButton">_</span><span class="hover"></span></button>
+                    <button class="iconified dontshrink" type="button"><span class="fa-icon">download-alt</span><span data-i18n="importAndAppendButton">_</span><span class="hover"></span></button>
+                    <button class="iconified dontshrink" type="button"><span class="fa-icon">upload-alt</span><span data-i18n="exportButton">_</span><span class="hover"></span></button><input type="file" accept="text/plain">
+                </p>
+            </details>
+        </aside>
+    </section>
+    <!-- -------- -->
     <section data-pane="develop">
         <div>
             <p>
@@ -150,8 +172,7 @@
         </div>
     </section>
     <!-- -------- -->
-    <div id="templates">
-        <div class="listEntries"></div>
+    <template id="listEntryLeaf">
         <div class="listEntry" data-role="leaf">
             <span class="detailbar">
                 <label><span class="input checkbox"><input type="checkbox"><svg viewBox="0 0 24 24"><path d="M1.73,12.91 8.1,19.28 22.79,4.59"/></svg></span><span class="listname forinput"></span>
@@ -161,6 +182,8 @@
                 </span>
             </span>
         </div>
+    </template>
+    <template id="listEntryNode">
         <div class="listEntry expandable" data-role="node">
             <span class="detailbar">
                 <label><span class="input checkbox"><input type="checkbox"><svg viewBox="0 0 24 24"><path d="M1.73,12.91 8.1,19.28 22.79,4.59"/></svg></span><span class="listname forinput"></span></label>
@@ -168,6 +191,8 @@
                 <span class="fa-icon listExpander">angle-up</span>
             </span>
         </div>
+    </template>
+    <template id="listEntryRoot">
         <div class="listEntry expandable" data-role="rootnode">
             <div class="detailbar">
                 <h3 class="listname"></h3>
@@ -175,7 +200,18 @@
                 <span class="fa-icon listExpander">angle-up</span>
             </div>
         </div>
-    </div>
+    </template>
+    <template id="listEntries">
+        <div class="listEntries"></div>
+    </template>
+    <template id="customFiltersHostname">
+        <li class="hostname"><div><span class="hostname" spellcheck="false" contenteditable="plaintext-only" data-pretty="" data-ugly=""></span><span class="remove fa-icon">trash-o</span><span class="undo fa-icon">undo</span></div>
+        <ul class="selectors"></ul>
+        </li>
+    </template>
+    <template id="customFiltersSelector">
+        <li class="selector"><div><span class="selector" spellcheck="false" contenteditable="plaintext-only" data-pretty="" data-ugly=""></span><span class="remove fa-icon">trash-o</span><span class="undo fa-icon">undo</span></div></li>
+    </template>
     <template class="io-panel">
         <span class="io-panel">
             <button id="apply" class="preferred iconified" type="button" disabled><span class="fa-icon">save</span><span data-i18n="saveButton">_</span><span class="hover"></span></button>
@@ -209,6 +245,7 @@
 <script src="js/i18n.js" type="module"></script>
 <script src="js/dashboard.js" type="module"></script>
 <script src="js/settings.js" type="module"></script>
+<script src="js/filter-manager-ui.js" type="module"></script>
 <script src="js/develop.js" type="module"></script>
 
 </body>

package/extensions/ublocklite/js/background.js

@@ -22,6 +22,7 @@
 import {
     MODE_BASIC,
     MODE_OPTIMAL,
+    defaultFilteringModes,
     getDefaultFilteringMode,
     getFilteringMode,
     getFilteringModeDetails,
@@ -32,11 +33,13 @@ import {
 } from './mode-manager.js';
 
 import {
-    addCustomFilter,
+    addCustomFilters,
+    customFiltersFromHostname,
+    getAllCustomFilters,
     hasCustomFilters,
     injectCustomFilters,
-    removeCustomFilter,
-    selectorsFromCustomFilters,
+    removeAllCustomFilters,
+    removeCustomFilters,
     startCustomFilters,
     terminateCustomFilters,
 } from './filter-manager.js';
@@ -61,9 +64,18 @@ import {
     webextFlavor,
 } from './ext.js';
 
+import {
+    defaultConfig,
+    loadRulesetConfig,
+    process,
+    rulesetConfig,
+    saveRulesetConfig,
+} from './config.js';
+
 import {
     enableRulesets,
     excludeFromStrictBlock,
+    getDefaultRulesetsFromEnv,
     getEffectiveDynamicRules,
     getEffectiveSessionRules,
     getEffectiveUserRules,
@@ -76,6 +88,7 @@ import {
 } from './ruleset-manager.js';
 
 import {
+    getConsoleOutput,
     getMatchedRules,
     isSideloaded,
     toggleDeveloperMode,
@@ -83,15 +96,7 @@ import {
     ubolLog,
 } from './debug.js';
 
-import {
-    loadRulesetConfig,
-    process,
-    rulesetConfig,
-    saveRulesetConfig,
-} from './config.js';
-
 import { dnr } from './ext-compat.js';
-import { getTroubleshootingInfo } from './troubleshooting.js';
 import { registerInjectables } from './scripting-manager.js';
 import { toggleToolbarIcon } from './action.js';
 
@@ -109,18 +114,6 @@ function getCurrentVersion() {
     return runtime.getManifest().version;
 }
 
-// The goal is just to be able to find out whether a specific version is older
-// than another one.
-
-function intFromVersion(version) {
-    const match = /^(\d+)\.(\d+)\.(\d+)$/.exec(version);
-    if ( match === null ) { return 0; }
-    const year = parseInt(match[1], 10);
-    const monthday = parseInt(match[2], 10);
-    const min = parseInt(match[3], 10);
-    return (year - 2022) * (1232 * 2400) + monthday * 2400 + min;
-}
-
 /******************************************************************************/
 
 async function onPermissionsRemoved() {
@@ -282,6 +275,19 @@ function onMessage(request, sender, callback) {
         return true;
     }
 
+    case 'getDefaultConfig':
+        getDefaultRulesetsFromEnv().then(rulesets => {
+            callback({
+                autoReload: defaultConfig.autoReload,
+                developerMode: defaultConfig.developerMode,
+                showBlockedCount: defaultConfig.showBlockedCount,
+                strictBlockMode: defaultConfig.strictBlockMode,
+                rulesets,
+                filteringModes: Object.assign(defaultFilteringModes),
+            });
+        });
+        return true;
+
     case 'getOptionsPageData':
         Promise.all([
             hasBroadHostPermissions(),
@@ -319,6 +325,12 @@ function onMessage(request, sender, callback) {
         });
         return true;
 
+    case 'getEnabledRulesets':
+        dnr.getEnabledRulesets().then(rulesets => {
+            callback(rulesets);
+        });
+        return true;
+
     case 'getRulesetDetails':
         getRulesetDetails().then(rulesetDetails => {
             callback(Array.from(rulesetDetails.values()));
@@ -487,8 +499,8 @@ function onMessage(request, sender, callback) {
         });
         return true;
 
-    case 'addCustomFilter':
-        addCustomFilter(request.hostname, request.selector).then(modified => {
+    case 'addCustomFilters':
+        addCustomFilters(request.hostname, request.selectors).then(modified => {
             if ( modified !== true ) { return; }
             return registerInjectables();
         }).then(( ) => {
@@ -496,8 +508,17 @@ function onMessage(request, sender, callback) {
         })
         return true;
 
-    case 'removeCustomFilter':
-        removeCustomFilter(request.hostname, request.selector).then(modified => {
+    case 'removeCustomFilters':
+        removeCustomFilters(request.hostname, request.selectors).then(modified => {
+            if ( modified !== true ) { return; }
+            return registerInjectables();
+        }).then(( ) => {
+            callback();
+        });
+        return true;
+
+    case 'removeAllCustomFilters':
+        removeAllCustomFilters(request.hostname).then(modified => {
             if ( modified !== true ) { return; }
             return registerInjectables();
         }).then(( ) => {
@@ -505,18 +526,22 @@ function onMessage(request, sender, callback) {
         });
         return true;
 
-    case 'selectorsFromCustomFilters':
-        selectorsFromCustomFilters(request.hostname).then(selectors => {
+    case 'customFiltersFromHostname':
+        customFiltersFromHostname(request.hostname).then(selectors => {
             callback(selectors);
         });
         return true;
 
-    case 'getTroubleshootingInfo':
-        getTroubleshootingInfo(request.siteMode).then(info => {
-            callback(info);
+    case 'getAllCustomFilters':
+        getAllCustomFilters().then(data => {
+            callback(data);
         });
         return true;
 
+    case 'getConsoleOutput':
+        callback(getConsoleOutput());
+        break;
+
     default:
         break;
     }
@@ -566,13 +591,6 @@ async function startSession() {
     // obsolete ruleset to remove.
     if ( isNewVersion ) {
         ubolLog(`Version change: ${rulesetConfig.version} => ${currentVersion}`);
-        // https://github.com/uBlockOrigin/uBOL-home/issues/428#issuecomment-3172663563
-        if ( webextFlavor === 'safari' && rulesetConfig.strictBlockMode ) {
-            const before = intFromVersion(rulesetConfig.version);
-            if ( before <= intFromVersion('2025.804.2359') ) {
-                rulesetConfig.strictBlockMode = false;
-            }
-        }
         rulesetConfig.version = currentVersion;
         await patchDefaultRulesets();
         saveRulesetConfig();

package/extensions/ublocklite/js/backup-restore.js

@@ -0,0 +1,153 @@
+/*******************************************************************************
+
+    uBlock Origin Lite - a comprehensive, MV3-compliant content blocker
+    Copyright (C) 2022-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 {
+    localRead, localRemove, localWrite,
+    runtime,
+    sendMessage,
+} from './ext.js';
+
+/******************************************************************************/
+
+export async function backupToObject(currentConfig) {
+    const out = {};
+    const manifest = runtime.getManifest();
+    out.version = manifest.versionName ?? manifest.version;
+    const defaultConfig = await sendMessage({ what: 'getDefaultConfig' });
+    if ( currentConfig.autoReload !== defaultConfig.autoReload ) {
+        out.autoReload = currentConfig.autoReload;
+    }
+    if ( currentConfig.developerMode !== defaultConfig.developerMode ) {
+        out.developerMode = currentConfig.developerMode;
+    }
+    if ( currentConfig.showBlockedCount !== defaultConfig.showBlockedCount ) {
+        out.showBlockedCount = currentConfig.showBlockedCount;
+    }
+    if ( currentConfig.strictBlockMode !== defaultConfig.strictBlockMode ) {
+        out.strictBlockMode = currentConfig.strictBlockMode;
+    }
+    const { enabledRulesets } = currentConfig;
+    const customRulesets = [];
+    for ( const id of enabledRulesets ) {
+        if ( defaultConfig.rulesets.includes(id) ) { continue; }
+        customRulesets.push(`+${id}`);
+    }
+    for ( const id of defaultConfig.rulesets ) {
+        if ( enabledRulesets.includes(id) ) { continue; }
+        customRulesets.push(`-${id}`);
+    }
+    if ( customRulesets.length !== 0 ) {
+        out.rulesets = customRulesets;
+    }
+    out.filteringModes = await sendMessage({ what: 'getFilteringModeDetails' });
+    const customFilters = await sendMessage({ what: 'getAllCustomFilters' });
+    const filters = [];
+    for ( const [ hostname, selectors ] of customFilters ) {
+        for ( const selector of selectors ) {
+            filters.push(`${hostname}##${selector}`);
+        }
+    }
+    if ( filters.length !== 0 ) {
+        out.cosmeticFilters = filters;
+    }
+    const dnrRules = await localRead('userDnrRules');
+    if ( typeof dnrRules === 'string' && dnrRules.length !== 0 ) {
+        out.dnrRules = dnrRules.split(/\n+/);
+    }
+    return out;
+}
+
+/******************************************************************************/
+
+export async function restoreFromObject(targetConfig) {
+    const defaultConfig = await sendMessage({ what: 'getDefaultConfig' });
+
+    await sendMessage({
+        what: 'setAutoReload',
+        state: targetConfig.autoReload ?? defaultConfig.autoReload
+    });
+
+    await sendMessage({
+        what: 'setShowBlockedCount',
+        state: targetConfig.showBlockedCount ?? defaultConfig.showBlockedCount
+    });
+
+    await sendMessage({
+        what: 'setDeveloperMode',
+        state: targetConfig.developerMode ?? defaultConfig.developerMode
+    });
+
+    await sendMessage({
+        what: 'setStrictBlockMode',
+        state: targetConfig.strictBlockMode ?? defaultConfig.strictBlockMode
+    });
+
+    const enabledRulesets = new Set(defaultConfig.rulesets);
+    for ( const entry of targetConfig.rulesets || [] ) {
+        const id = entry.slice(1);
+        if ( entry.startsWith('+') ) {
+            enabledRulesets.add(id);
+        } else if ( entry.startsWith('-') ) {
+            enabledRulesets.delete(id);
+        }
+    }
+    await sendMessage({
+        what: 'applyRulesets',
+        enabledRulesets: Array.from(enabledRulesets),
+    });
+
+    await sendMessage({
+        what: 'setFilteringModeDetails',
+        modes: targetConfig.filteringModes ?? defaultConfig.filteringModes,
+    });
+
+    await sendMessage({ what: 'removeAllCustomFilters', hostname: '*' });
+    const hostnameMap = new Map();
+    for ( const line of targetConfig.cosmeticFilters ?? [] ) {
+        const i = line.indexOf('##');
+        if ( i === -1 ) { continue; }
+        const hostname = line.slice(0, i);
+        if ( hostname === '' ) { continue; }
+        const selector = line.slice(i+2);
+        if ( selector === '' ) { continue; }
+        const selectors = hostnameMap.get(hostname) || [];
+        if ( selectors.length === 0 ) {
+            hostnameMap.set(hostname, selectors)
+        }
+        selectors.push(selector);
+    }
+    const promises = [];
+    for ( const [ hostname, selectors ] of hostnameMap ) {
+        promises.push(
+            sendMessage({ what: 'addCustomFilters', hostname, selectors })
+        );
+    }
+    await Promise.all(promises);
+
+    const dnrRules = targetConfig.dnrRules ?? [];
+    if ( dnrRules.length !== 0 ) {
+        await localWrite('userDnrRules', dnrRules.join('\n'));
+    } else {
+        await localRemove('userDnrRules');
+    }
+    await sendMessage({ what: 'updateUserDnrRules' });
+
+}

package/extensions/ublocklite/js/config.js

@@ -37,6 +37,8 @@ export const rulesetConfig = {
     hasBroadHostPermissions: true,
 };
 
+export const defaultConfig = Object.assign({}, rulesetConfig);
+
 export const process = {
     firstRun: false,
     wakeupRun: false,

package/extensions/ublocklite/js/dashboard.js

@@ -21,15 +21,17 @@
 
 import { dom, qs$ } from './dom.js';
 import {
-    localRead,
-    localRemove,
-    localWrite,
+    localRead, localRemove, localWrite,
     runtime,
-    sendMessage,
+    webextFlavor,
 } from './ext.js';
+import { faIconsInit } from './fa-icons.js';
+import { i18n } from './i18n.js';
 
 /******************************************************************************/
 
+dom.body.dataset.platform = webextFlavor;
+
 {
     const manifest = runtime.getManifest();
     dom.text('#aboutNameVer', `${manifest.name} ${manifest.version}`);
@@ -55,7 +57,9 @@ localRead('dashboard.activePane').then(pane => {
 // Update troubleshooting on-demand
 const tsinfoObserver = new IntersectionObserver(entries => {
     if ( entries.every(a => a.isIntersecting === false) ) { return; }
-    sendMessage({ what: 'getTroubleshootingInfo' }).then(config => {
+    import('./troubleshooting.js').then(module => {
+        return module.getTroubleshootingInfo();
+    }).then(config => {
         qs$('[data-i18n="supportS5H"] + pre').textContent = config;
     });
 });
@@ -63,7 +67,21 @@ tsinfoObserver.observe(qs$('[data-i18n="supportS5H"] + pre'));
 
 /******************************************************************************/
 
+export function nodeFromTemplate(templateId, nodeSelector) {
+    const template = qs$(`template#${templateId}`);
+    const fragment = template.content.cloneNode(true);
+    const node = nodeSelector !== undefined
+        ? qs$(fragment, nodeSelector)
+        : fragment.firstElementChild;
+    faIconsInit(node);
+    i18n.render(node);
+    return node;
+}
+
+/******************************************************************************/
+
 export function hashFromIterable(iter) {
+    if ( Boolean(iter) === false ) { return ''; }
     return Array.from(iter).sort().join('\n');
 }
 

package/extensions/ublocklite/js/develop.js

@@ -517,7 +517,7 @@ class Editor {
     importFromFile() {
         const editor = this.editor;
         if ( typeof editor.importFromFile !== 'function' ) { return; }
-        const input = qs$('input[type="file"]');
+        const input = qs$('section[data-pane="develop"] input[type="file"]');
         input.accept = editor.ioAccept || '';
         input.onchange = ev => {
             input.onchange = null;
@@ -619,15 +619,6 @@ async function start() {
     });
 }
 
-let observer = new IntersectionObserver(entries => {
-    for ( const entry of entries ) {
-        if ( entry.isIntersecting === false ) { continue; }
-        start();
-        observer.disconnect();
-        observer = null;
-        break;
-    }
-});
-observer.observe(qs$('section[data-pane="develop"]'));
+dom.onFirstShown(start, qs$('section[data-pane="develop"]'));
 
 /******************************************************************************/

package/extensions/ublocklite/js/dom.js

@@ -156,6 +156,16 @@ class dom {
             elem.removeEventListener(type, callback, options);
         }
     }
+
+    static onFirstShown(fn, elem) {
+        let observer = new IntersectionObserver(entries => {
+            if ( entries.every(a => a.isIntersecting === false) ) { return; }
+            try { fn(); } catch { }
+            observer.disconnect();
+            observer = undefined;
+        });
+        observer.observe(elem);
+    }
 }
 
 dom.cl = class {

package/extensions/ublocklite/js/filter-lists.js

@@ -20,9 +20,9 @@
 */
 
 import { dom, qs$, qsa$ } from './dom.js';
+import { hashFromIterable, nodeFromTemplate } from './dashboard.js';
 import { i18n, i18n$ } from './i18n.js';
 import { localRead, localWrite, sendMessage } from './ext.js';
-import { hashFromIterable } from './dashboard.js';
 
 /******************************************************************************/
 
@@ -162,16 +162,16 @@ export function renderFilterLists(rulesetData) {
 
     const createListEntry = (listDetails, depth) => {
         if ( listDetails.lists === undefined ) {
-            return dom.clone('#templates .listEntry[data-role="leaf"]');
+            return nodeFromTemplate('listEntryLeaf', '.listEntry');
         }
         if ( depth !== 0 ) {
-            return dom.clone('#templates .listEntry[data-role="node"]');
+            return nodeFromTemplate('listEntryNode', '.listEntry');
         }
-        return dom.clone('#templates .listEntry[data-role="rootnode"]');
+        return nodeFromTemplate('listEntryRoot', '.listEntry');
     };
 
     const createListEntries = (parentkey, listTree, depth = 0) => {
-        const listEntries = dom.clone('#templates .listEntries');
+        const listEntries = nodeFromTemplate('listEntries', '.listEntries');
         const treeEntries = Object.entries(listTree);
         if ( depth !== 0 ) {
             const reEmojis = /\p{Emoji}+/gu;