@browserless.io/browserless 2.32.1-beta-1 → 2.33.0

package/extensions/ublocklite/js/background.js

@@ -31,6 +31,15 @@ import {
     syncWithBrowserPermissions,
 } from './mode-manager.js';
 
+import {
+    addCustomFilter,
+    hasCustomFilters,
+    injectCustomFilters,
+    removeCustomFilter,
+    selectorsFromCustomFilters,
+    uninjectCustomFilters,
+} from './filter-manager.js';
+
 import {
     adminReadEx,
     getAdminRulesets,
@@ -56,7 +65,6 @@ import {
     getEffectiveDynamicRules,
     getEffectiveSessionRules,
     getEffectiveUserRules,
-    getEnabledRulesetsDetails,
     getRulesetDetails,
     patchDefaultRulesets,
     setStrictBlockMode,
@@ -153,14 +161,15 @@ function setDeveloperMode(state) {
 
 function onMessage(request, sender, callback) {
 
+    const tabId = sender?.tab?.id ?? false;
+    const frameId = tabId && (sender?.frameId ?? false);
+
     // Does not require trusted origin.
 
     switch ( request.what ) {
 
     case 'insertCSS': {
-        const tabId = sender?.tab?.id ?? false;
-        const frameId = sender?.frameId ?? false;
-        if ( tabId === false || frameId === false ) { return; }
+        if ( frameId === false ) { return false; }
         browser.scripting.insertCSS({
             css: request.css,
             origin: 'USER',
@@ -172,9 +181,7 @@ function onMessage(request, sender, callback) {
     }
 
     case 'removeCSS': {
-        const tabId = sender?.tab?.id ?? false;
-        const frameId = sender?.frameId ?? false;
-        if ( tabId === false || frameId === false ) { return; }
+        if ( frameId === false ) { return false; }
         browser.scripting.removeCSS({
             css: request.css,
             origin: 'USER',
@@ -186,13 +193,26 @@ function onMessage(request, sender, callback) {
     }
 
     case 'toggleToolbarIcon': {
-        const tabId = sender?.tab?.id ?? false;
         if ( tabId ) {
             toggleToolbarIcon(tabId);
         }
         return false;
     }
 
+    case 'injectCustomFilters':
+        if ( frameId === false ) { return false; }
+        injectCustomFilters(tabId, frameId, request.hostname).then(selectors => {
+            callback(selectors);
+        });
+        return true;
+
+    case 'uninjectCustomFilters':
+        if ( frameId === false ) { return false; }
+        uninjectCustomFilters(tabId, frameId, request.hostname).then(( ) => {
+            callback();
+        });
+        return true;
+
     default:
         break;
     }
@@ -301,24 +321,18 @@ function onMessage(request, sender, callback) {
     case 'popupPanelData': {
         Promise.all([
             hasBroadHostPermissions(),
-            getFilteringMode(request.hostname),
-            getEnabledRulesetsDetails(),
+            getFilteringMode(request.normalHostname),
             adminReadEx('disabledFeatures'),
+            hasCustomFilters(request.hostname),
         ]).then(results => {
-            const [
-                hasOmnipotence,
-                level,
-                rulesetDetails,
-                disabledFeatures,
-            ] = results;
             callback({
-                hasOmnipotence,
-                level,
+                hasOmnipotence: results[0],
+                level: results[1],
                 autoReload: rulesetConfig.autoReload,
-                rulesetDetails,
                 isSideloaded,
                 developerMode: rulesetConfig.developerMode,
-                disabledFeatures,
+                disabledFeatures: results[2],
+                hasCustomFilters: results[3],
             });
         });
         return true;
@@ -432,6 +446,30 @@ function onMessage(request, sender, callback) {
         });
         return true;
 
+    case 'addCustomFilter':
+        addCustomFilter(request.hostname, request.selector).then(modified => {
+            if ( modified !== true ) { return; }
+            return registerInjectables();
+        }).then(( ) => {
+            callback();
+        })
+        return true;
+
+    case 'removeCustomFilter':
+        removeCustomFilter(request.hostname, request.selector).then(modified => {
+            if ( modified !== true ) { return; }
+            return registerInjectables();
+        }).then(( ) => {
+            callback();
+        });
+        return true;
+
+    case 'selectorsFromCustomFilters':
+        selectorsFromCustomFilters(request.hostname).then(selectors => {
+            callback(selectors);
+        });
+        return true;
+
     default:
         break;
     }
@@ -446,7 +484,15 @@ function onCommand(command, tab) {
     case 'enter-zapper-mode': {
         if ( browser.scripting === undefined ) { return; }
         browser.scripting.executeScript({
-            files: [ '/js/scripting/zapper.js' ],
+            files: [ '/js/scripting/tool-overlay.js', '/js/scripting/zapper.js' ],
+            target: { tabId: tab.id },
+        });
+        break;
+    }
+    case 'enter-picker-mode': {
+        if ( browser.scripting === undefined ) { return; }
+        browser.scripting.executeScript({
+            files: [ '/js/scripting/tool-overlay.js', '/js/scripting/picker.js' ],
             target: { tabId: tab.id },
         });
         break;

package/extensions/ublocklite/js/dashboard.js

@@ -19,13 +19,14 @@
     Home: https://github.com/gorhill/uBlock
 */
 
+import { dom, qs$ } from './dom.js';
 import {
     localRead,
     localRemove,
     localWrite,
 } from './ext.js';
 
-import { dom } from './dom.js';
+import { getTroubleshootingInfo } from './troubleshooting.js';
 import { runtime } from './ext.js';
 
 /******************************************************************************/
@@ -52,6 +53,10 @@ localRead('dashboard.activePane').then(pane => {
     dom.body.dataset.pane = pane;
 });
 
+getTroubleshootingInfo().then(config => {
+    qs$('[data-i18n="supportS5H"] + pre').textContent = config;
+});
+
 /******************************************************************************/
 
 export function hashFromIterable(iter) {

package/extensions/ublocklite/js/debug.js

@@ -48,9 +48,8 @@ matchedRules.fill(null);
 let writePtr = 0;
 
 const pruneLongLists = list => {
-    if ( list.length <= 21 ) { return list; }
-    return [ ...list.slice(0, 10), '...', ...list.slice(-10) ];
-    
+    if ( list.length <= 11 ) { return list; }
+    return [ ...list.slice(0, 5), '...', ...list.slice(-5) ];
 };
 
 const getRuleset = async rulesetId => {
@@ -95,8 +94,9 @@ const getRuleDetails = async ruleInfo => {
 /******************************************************************************/
 
 export const getMatchedRules = (( ) => {
-    const noopFn = ( ) => Promise.resolve([]);
-    if ( isSideloaded !== true ) { return noopFn; }
+    if ( isSideloaded !== true ) {
+        return ( ) => Promise.resolve([]);
+    }
 
     if ( isModern ) {
         return async tabId => {
@@ -120,11 +120,11 @@ export const getMatchedRules = (( ) => {
         if ( typeof dnr.getMatchedRules !== 'function' ) { return []; }
         const matchedRules = await dnr.getMatchedRules({ tabId });
         if ( matchedRules instanceof Object === false ) { return []; }
-        const out = [];
-        for ( const ruleInfo of matchedRules.rulesMatchedInfo ) {
-            out.push({ request: ruleInfo.request });
+        const promises = [];
+        for ( const { tabId, rule } of matchedRules.rulesMatchedInfo ) {
+            promises.push(getRuleDetails({ request: { tabId }, rule }));
         }
-        return out;
+        return Promise.all(promises);
     };
 })();
 

package/extensions/ublocklite/js/develop.js

@@ -557,35 +557,33 @@ class Editor {
         },
         token: (stream, state) => {
             if ( stream.sol() ) {
-                if ( stream.match(/^---\s*$/) ) { return 'yamlboundary'; }
-                if ( stream.match(/^# ---\s*$/) ) { return 'yamlboundary comment'; }
-                if ( stream.match(/\.\.\.\s*$/) ) { return 'yamlboundary'; }
+                if ( stream.match(/^---\s*$/) ) { return 'ubol-boundary'; }
+                if ( stream.match(/^# ---\s*$/) ) { return 'ubol-boundary ubol-comment'; }
+                if ( stream.match(/\.\.\.\s*$/) ) { return 'ubol-boundary'; }
             }
             const c = stream.peek();
             if ( c === '#' ) {
                 if ( (stream.pos === 0 || /\s/.test(stream.string.charAt(stream.pos - 1))) ) {
                     stream.skipToEnd();
-                    return 'comment';
+                    return 'ubol-comment';
                 }
             }
-            if ( stream.eatSpace() ) {
-                return null;
-            }
+            if ( stream.eatSpace() ) { return null; }
             const { scope } = state;
             state.scope = 0;
             if ( scope === 0 && stream.match(/^[^:]+(?=:)/) ) {
                 state.scope = 1;
-                return 'keyword';
+                return 'ubol-keyword';
             }
             if ( scope === 1 && stream.match(/^:(?: |$)/) ) {
-                return 'punctuation';
+                return 'ubol-punctuation';
             }
             if ( stream.match(/^- /) ) {
-                return 'punctuation';
+                return 'ubol-punctuation';
             }
             if ( this.editor.streamParserKeywords ) {
                 if ( stream.match(this.editor.streamParserKeywords) ) {
-                    return 'literal';
+                    return 'ubol-literal';
                 }
             }
             if ( stream.match(/^\S+/) ) {
@@ -598,7 +596,11 @@ class Editor {
             commentTokens: { line: '#' },
         },
         tokenTable: [
-            'yamlboundary',
+            'ubol-boundary',
+            'ubol-keyword',
+            'ubol-comment',
+            'ubol-punctuation',
+            'ubol-literal',
         ],
     };
 }

package/extensions/ublocklite/js/ext-compat.js

@@ -20,7 +20,7 @@
 */
 
 export const webext = self.browser || self.chrome;
-export const dnr = webext.declarativeNetRequest;
+export const dnr = webext.declarativeNetRequest || {};
 export const INITIATOR_DOMAINS = 'initiatorDomains';
 export const EXCLUDED_INITIATOR_DOMAINS = 'excludedInitiatorDomains';
 

package/extensions/ublocklite/js/ext.js

@@ -63,6 +63,17 @@ export async function localRemove(key) {
     return browser.storage.local.remove(key);
 }
 
+export async function localKeys() {
+    if ( browser.storage instanceof Object === false ) { return; }
+    if ( browser.storage.local instanceof Object === false ) { return; }
+    if ( browser.storage.local.getKeys ) {
+        return browser.storage.local.getKeys();
+    }
+    const bin = await browser.storage.local.get(null);
+    if ( bin instanceof Object === false ) { return; }
+    return Object.keys(bin);
+}
+
 /******************************************************************************/
 
 export async function sessionRead(key) {

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

@@ -0,0 +1,157 @@
+/*******************************************************************************
+
+    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 {
+    browser,
+    localKeys,
+    localRead,
+    localRemove,
+    localWrite,
+} from './ext.js';
+
+import {
+    intersectHostnameIters,
+    matchesFromHostnames,
+    strArrayEq,
+    subtractHostnameIters,
+} from './utils.js';
+
+/******************************************************************************/
+
+export async function selectorsFromCustomFilters(hostname) {
+    const promises = [];
+    let hn = hostname;
+    while ( hn !== '' ) {
+        promises.push(localRead(`site.${hn}`));
+        const pos = hn.indexOf('.');
+        if ( pos === -1 ) { break; }
+        hn = hn.slice(pos + 1);
+    }
+    const results = await Promise.all(promises);
+    const out = [];
+    for ( let i = 0; i < promises.length; i++ ) {
+        const selectors = results[i];
+        if ( selectors === undefined ) { continue; }
+        selectors.forEach(selector => { out.push(selector.slice(1)); });
+    }
+    return out.sort();
+}
+
+/******************************************************************************/
+
+export async function hasCustomFilters(hostname) {
+    const selectors = await selectorsFromCustomFilters(hostname);
+    return selectors?.length ?? 0;
+}
+
+/******************************************************************************/
+
+export async function injectCustomFilters(tabId, frameId, hostname) {
+    const selectors = await selectorsFromCustomFilters(hostname);
+    if ( selectors.length === 0 ) { return; }
+    await browser.scripting.insertCSS({
+        css: `${selectors.join(',\n')}{display:none!important;}`,
+        origin: 'USER',
+        target: { tabId, frameIds: [ frameId ] },
+    }).catch(reason => {
+        console.log(reason);
+    });
+    return selectors;
+}
+
+/******************************************************************************/
+
+export async function uninjectCustomFilters(tabId, frameId, hostname) {
+    const selectors = await selectorsFromCustomFilters(hostname);
+    if ( selectors.length === 0 ) { return; }
+    return browser.scripting.removeCSS({
+        css: `${selectors.join(',\n')}{display:none!important;}`,
+        origin: 'USER',
+        target: { tabId, frameIds: [ frameId ] },
+    }).catch(reason => {
+        console.log(reason);
+    });
+}
+
+/******************************************************************************/
+
+export async function registerCustomFilters(context) {
+    const storageKeys = await localKeys() || [];
+    const siteKeys = storageKeys.filter(a => a.startsWith('site.'));
+    if ( siteKeys.length === 0 ) { return; }
+
+    const { none } = context.filteringModeDetails;
+    let hostnames = siteKeys.map(a => a.slice(5));
+    if ( none.has('all-urls') ) {
+        const { basic, optimal, complete } = context.filteringModeDetails;
+        hostnames = intersectHostnameIters(hostnames, [
+            ...basic, ...optimal, ...complete
+        ]);
+    } else if ( none.size !== 0 ) {
+        hostnames = [ ...subtractHostnameIters(hostnames, none) ];
+    }
+    if ( hostnames.length === 0 ) { return; }
+
+    const registered = context.before.get('css-user');
+    context.before.delete('css-user'); // Important!
+
+    const directive = {
+        id: 'css-user',
+        js: [ '/js/scripting/css-user.js' ],
+        matches: matchesFromHostnames(hostnames),
+        runAt: 'document_start',
+    };
+
+    if ( registered === undefined ) {
+        context.toAdd.push(directive);
+    } else if ( strArrayEq(registered.matches, directive.matches) === false ) {
+        context.toRemove.push('css-user');
+        context.toAdd.push(directive);
+    }
+}
+
+/******************************************************************************/
+
+export async function addCustomFilter(hostname, selector) {
+    const key = `site.${hostname}`;
+    const selectors = await localRead(key) || [];
+    const filter = `0${selector}`;
+    if ( selectors.includes(filter) ) { return false; }
+    selectors.push(filter);
+    selectors.sort();
+    await localWrite(key, selectors);
+    return true;
+}
+
+/******************************************************************************/
+
+export async function removeCustomFilter(hostname, selector) {
+    const key = `site.${hostname}`;
+    const selectors = await localRead(key);
+    if ( selectors === undefined ) { return false; }
+    const i = selectors.indexOf(`0${selector}`);
+    if ( i === -1 ) { return false; }
+    selectors.splice(i, 1);
+    await selectors.length !== 0
+        ? localWrite(key, selectors)
+        : localRemove(key);
+    return true;
+}

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

@@ -76,12 +76,16 @@ export class ModeEditor {
         }
     }
 
-    sequenceScopes = [
-        `${i18n$('filteringMode0Name')}:`, 'none:',
-        `${i18n$('filteringMode1Name')}:`, 'basic:',
-        `${i18n$('filteringMode2Name')}:`, 'optimal:',
-        `${i18n$('filteringMode3Name')}:`, 'complete:',
-    ];
+    newlineAssistant = {
+        'no filtering:': '  - ',
+        'basic:': '  - ',
+        'optimal:': '  - ',
+        'complete:': '  - ',
+        [`${i18n$('filteringMode0Name')}:`]: '  - ',
+        [`${i18n$('filteringMode1Name')}:`]: '  - ',
+        [`${i18n$('filteringMode2Name')}:`]: '  - ',
+        [`${i18n$('filteringMode3Name')}:`]: '  - ',
+    };
 
     ioAccept = '.json,application/json';
 };