@browserless.io/browserless 2.32.1 → 2.33.0

package/extensions/ublocklite/js/troubleshooting.js

@@ -0,0 +1,123 @@
+/*******************************************************************************
+
+    uBlock Origin - a comprehensive, efficient content blocker
+    Copyright (C) 2024-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,
+    runtime,
+    sendMessage,
+} from './ext.js';
+
+import { dnr } from './ext-compat.js';
+import { dom } from './dom.js';
+
+/******************************************************************************/
+
+function renderData(data, depth = 0) {
+    const indent = ' '.repeat(depth);
+    if ( Array.isArray(data) ) {
+        const out = [];
+        for ( const value of data ) {
+            out.push(renderData(value, depth));
+        }
+        return out.join('\n');
+    }
+    if ( typeof data !== 'object' || data === null ) {
+        return `${indent}${data}`;
+    }
+    const out = [];
+    for ( const [ name, value ] of Object.entries(data) ) {
+        if ( typeof value === 'object' && value !== null ) {
+            out.push(`${indent}${name}:`);
+            out.push(renderData(value, depth + 1));
+            continue;
+        }
+        out.push(`${indent}${name}: ${value}`);
+    }
+    return out.join('\n');
+}
+
+/******************************************************************************/
+
+export async function getTroubleshootingInfo(siteMode) {
+    const manifest = runtime.getManifest();
+    const [
+        platformInfo,
+        rulesets,
+        defaultMode,
+        userRules,
+        registerContentScriptsReason,
+        unregisterContentScriptsReason,
+    ] = await Promise.all([
+        runtime.getPlatformInfo(),
+        dnr.getEnabledRulesets(),
+        sendMessage({ what: 'getDefaultFilteringMode' }),
+        sendMessage({ what: 'getEffectiveUserRules' }),
+        localRead('$scripting.registerContentScripts'),
+        localRead('$scripting.unregisterContentScripts'),
+    ]);
+    const browser = (( ) => {
+        const extURL = runtime.getURL('');
+        let agent = '';
+        if ( extURL.startsWith('moz-extension:') ) {
+            agent = 'Firefox';
+        } else if ( extURL.startsWith('safari-web-extension:') ) {
+            agent = 'Safari';
+        } else if ( /\bEdg\/\b/.test(navigator.userAgent) ) {
+            agent = 'Edge';
+        } else {
+            agent = 'Chrome';
+        }
+        dom.cl.add('html', agent.toLowerCase());
+        if ( /\bMobile\b/.test(navigator.userAgent) ) {
+            agent += ' Mobile';
+        }
+        const reVersion = new RegExp(`\\b${agent.slice(0,3)}[^/]*/(\\d+)`);
+        const match = reVersion.exec(navigator.userAgent);
+        if ( match ) {
+            agent += ` ${match[1]}`;
+        }
+        agent += ` (${platformInfo.os})`
+        return agent;
+    })();
+    const modes = [ 'no filtering', 'basic', 'optimal', 'complete' ];
+    const filtering = {};
+    if ( siteMode ) {
+        filtering.site = `${modes[siteMode]}`
+    }
+    filtering.default = `${modes[defaultMode]}`;
+    const config = {
+        name: manifest.name,
+        version: manifest.version,
+        browser,
+        filtering,
+    };
+    if ( userRules.length !== 0 ) {
+        config['user rules'] = userRules.length;
+    }
+    config.rulesets = rulesets;
+    if ( registerContentScriptsReason !== undefined ) {
+        config.registerContentScripts = registerContentScriptsReason;
+    }
+    if ( unregisterContentScriptsReason !== undefined ) {
+        config.unregisterContentScripts = unregisterContentScriptsReason;
+    }
+    return renderData(config);
+}

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

@@ -448,9 +448,13 @@ function parseNetworkFilter(parser) {
 /******************************************************************************/
 
 export function parseFilters(text) {
+    if ( text.startsWith('---') ) { return; }
+    if ( text.endsWith('---') ) { return; }
+    const lines = text.split(/\n/);
+    if ( lines.some(a => a.startsWith(' ')) ) { return; }
     const rules = [];
     const parser = new sfp.AstFilterParser({ trustedSource: true });
-    for ( const line of text.split(/\n/) ) {
+    for ( const line of lines ) {
         parser.parse(line);
         if ( parser.isNetworkFilter() === false ) { continue; }
         const rule = parseNetworkFilter(parser);

package/extensions/ublocklite/js/unpicker-ui.js

@@ -0,0 +1,164 @@
+/*******************************************************************************
+
+    uBlock Origin - a comprehensive, efficient content blocker
+    Copyright (C) 2025-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 { dom, qs$, qsa$ } from './dom.js';
+import { faIconsInit } from './fa-icons.js';
+import { toolOverlay } from './tool-overlay-ui.js';
+
+/******************************************************************************/
+
+function onMinimizeClicked() {
+    dom.cl.toggle(dom.root, 'minimized');
+}
+
+/******************************************************************************/
+
+function highlight() {
+    const selectors = [];
+    for ( const selectorElem of qsa$('#customFilters .customFilter.on > span.selector') ) {
+        selectors.push(selectorElem.textContent);
+    }
+    if ( selectors.length !== 0 ) {
+        toolOverlay.postMessage({
+            what: 'highlightFromSelector',
+            selector: selectors.join(','),
+            scrollTo: true,
+        });
+    } else {
+        toolOverlay.postMessage({ what: 'unhighlight' });
+    }
+}
+
+/******************************************************************************/
+
+function onFilterClicked(ev) {
+    const target = ev.target;
+    const filterElem = target.closest('.customFilter');
+    if ( filterElem === null ) { return; }
+    const selectorElem = qs$(filterElem, ':scope > span.selector');
+    if ( target === selectorElem ) {
+        if ( dom.cl.has(filterElem, 'on') ) {
+            dom.cl.remove(filterElem, 'on');
+        } else {
+            dom.cl.remove('.customFilter.on', 'on');
+            dom.cl.add(filterElem, 'on');
+        }
+        highlight();
+        return;
+    }
+    const selector = selectorElem.textContent;
+    const trashElem = qs$(filterElem, ':scope > span.remove');
+    if ( target === trashElem ) {
+        dom.cl.add(filterElem, 'removed');
+        dom.cl.remove(filterElem, 'on');
+        toolOverlay.sendMessage({ what: 'removeCustomFilter',
+            hostname: toolOverlay.url.hostname,
+            selector,
+        }).then(( ) => {
+            autoSelectFilter();
+        });
+        return;
+    }
+    const undoElem = qs$(filterElem, ':scope > span.undo');
+    if ( target === undoElem ) {
+        dom.cl.remove(filterElem, 'removed');
+        toolOverlay.sendMessage({ what: 'addCustomFilter',
+            hostname: toolOverlay.url.hostname,
+            selector,
+        }).then(( ) => {
+            dom.cl.remove('.customFilter.on', 'on');
+            dom.cl.add(filterElem, 'on');
+            highlight();
+        });
+        return;
+    }
+}
+
+/******************************************************************************/
+
+function autoSelectFilter() {
+    let filterElem = qs$('.customFilter.on');
+    if ( filterElem !== null ) { return; }
+    filterElem = qs$('.customFilter:not(.removed)');
+    if ( filterElem !== null ) {
+        dom.cl.add(filterElem, 'on');
+    }
+    highlight();
+}
+
+/******************************************************************************/
+
+function populateFilters(selectors) {
+    const container = qs$('#customFilters');
+    dom.clear(container);
+    const rowTemplate = qs$('template#customFilterRow');
+    for ( const selector of selectors ) {
+        const row = rowTemplate.content.cloneNode(true);
+        qs$(row, '.customFilter > span.selector').textContent = selector;
+        container.append(row);
+    }
+    faIconsInit(container);
+    autoSelectFilter();
+}
+
+/******************************************************************************/
+
+async function startUnpicker() {
+    const selectors = await toolOverlay.sendMessage({
+        what: 'selectorsFromCustomFilters',
+        hostname: toolOverlay.url.hostname,
+    })
+    if ( selectors.length === 0 ) {
+        return quitUnpicker();
+    }
+    await toolOverlay.postMessage({ what: 'startTool' });
+    await toolOverlay.postMessage({ what: 'uninjectCustomFilters' });
+    populateFilters(selectors);
+    dom.on('#minimize', 'click', onMinimizeClicked);
+    dom.on('#customFilters', 'click', onFilterClicked);
+    dom.on('#quit', 'click', quitUnpicker);
+}
+
+/******************************************************************************/
+
+async function quitUnpicker() {
+    await toolOverlay.postMessage({ what: 'injectCustomFilters' });
+    toolOverlay.stop();
+}
+
+/******************************************************************************/
+
+function onMessage(msg) {
+    switch ( msg.what ) {
+    case 'startTool':
+        startUnpicker();
+        break;
+    default:
+        break;
+    }
+}
+
+/******************************************************************************/
+
+// Wait for the content script to establish communication
+toolOverlay.start(onMessage);
+
+/******************************************************************************/

package/extensions/ublocklite/js/zapper-ui.js

@@ -19,40 +19,26 @@
     Home: https://github.com/gorhill/uBlock
 */
 
-/******************************************************************************/
-
-const $id = id => document.getElementById(id);
-const $stor = selector => document.querySelector(selector);
-
-const svgRoot = $stor('svg#sea');
-const svgOcean = svgRoot.children[0];
-const svgIslands = svgRoot.children[1];
-const NoPaths = 'M0 0';
-
-let zapperScriptPort;
+import { dom } from './dom.js';
+import { toolOverlay } from './tool-overlay-ui.js';
 
 /******************************************************************************/
 
-const onSvgClicked = function(ev) {
+function onSvgClicked(ev) {
     // If zap mode, highlight element under mouse, this makes the zapper usable
     // on touch screens.
-    zapperScriptPort.postMessage({
+    toolOverlay.postMessage({
         what: 'zapElementAtPoint',
         mx: ev.clientX,
         my: ev.clientY,
         options: {
             stay: true,
-            highlight: ev.target !== svgIslands,
+            highlight: ev.target !== toolOverlay.svgIslands,
         },
     });
-};
-
-/*******************************************************************************
-
-    Swipe right:
-        Remove current highlight
+}
 
-*/
+/******************************************************************************/
 
 const onSvgTouch = (( ) => {
     let startX = 0, startY = 0;
@@ -67,7 +53,6 @@ const onSvgTouch = (( ) => {
         if ( startX === undefined ) { return; }
         const stopX = ev.changedTouches[0].screenX;
         const stopY = ev.changedTouches[0].screenY;
-        const angle = Math.abs(Math.atan2(stopY - startY, stopX - startX));
         const distance = Math.sqrt(
             Math.pow(stopX - startX, 2) +
             Math.pow(stopY - startY, 2)
@@ -76,77 +61,23 @@ const onSvgTouch = (( ) => {
         // - Swipe is not valid; and
         // - The time between start and stop was less than 200ms.
         const duration = ev.timeStamp - t0;
-        if ( distance < 32 && duration < 200 ) {
-            onSvgClicked({
-                type: 'touch',
-                target: ev.target,
-                clientX: ev.changedTouches[0].pageX,
-                clientY: ev.changedTouches[0].pageY,
-            });
-            ev.preventDefault();
-            return;
-        }
-        if ( distance < 64 ) { return; }
-        const angleUpperBound = Math.PI * 0.25 * 0.5;
-        const swipeRight = angle < angleUpperBound;
-        if ( swipeRight === false ) { return; }
-        if ( ev.cancelable ) {
-            ev.preventDefault();
-        }
-        // Swipe right.
-        if ( svgIslands.getAttribute('d') === NoPaths ) { return; }
-        zapperScriptPort.postMessage({
-            what: 'unhighlight'
+        if ( distance >= 32 || duration >= 200 ) { return; }
+        onSvgClicked({
+            type: 'touch',
+            target: ev.target,
+            clientX: ev.changedTouches[0].pageX,
+            clientY: ev.changedTouches[0].pageY,
         });
+        ev.preventDefault();
     };
 })();
 
 /******************************************************************************/
 
-const svgListening = (( ) => {
-    let on = false;
-    let timer;
-    let mx = 0, my = 0;
-
-    const onTimer = ( ) => {
-        timer = undefined;
-        zapperScriptPort.postMessage({
-            what: 'highlightElementAtPoint',
-            mx,
-            my,
-        });
-    };
-
-    const onHover = ev => {
-        mx = ev.clientX;
-        my = ev.clientY;
-        if ( timer === undefined ) {
-            timer = self.requestAnimationFrame(onTimer);
-        }
-    };
-
-    return state => {
-        if ( $stor(':root.mobile') !== null ) { return; }
-        if ( state === on ) { return; }
-        on = state;
-        if ( on ) {
-            document.addEventListener('mousemove', onHover, { passive: true });
-            return;
-        }
-        document.removeEventListener('mousemove', onHover, { passive: true });
-        if ( timer !== undefined ) {
-            self.cancelAnimationFrame(timer);
-            timer = undefined;
-        }
-    };
-})();
-
-/******************************************************************************/
-
-const onKeyPressed = function(ev) {
+function onKeyPressed(ev) {
     // Delete
     if ( ev.key === 'Delete' || ev.key === 'Backspace' ) {
-        zapperScriptPort.postMessage({
+        toolOverlay.postMessage({
             what: 'zapElementAtPoint',
             options: { stay: true },
         });
@@ -157,81 +88,45 @@ const onKeyPressed = function(ev) {
         quitZapper();
         return;
     }
-};
+}
 
 /******************************************************************************/
 
-const onScriptMessage = function(msg) {
-    switch ( msg.what ) {
-    case 'svgPaths': {
-        let { ocean, islands } = msg;
-        ocean += islands;
-        svgOcean.setAttribute('d', ocean);
-        svgIslands.setAttribute('d', islands || NoPaths);
-        break;
-    }
-    default:
-        break;
-    }
-};
-
-/******************************************************************************/
-
-const startZapper = function(port) {
-    zapperScriptPort = port;
-    zapperScriptPort.onmessage = ev => {
-        onScriptMessage(ev.data || {});
-    };
-    zapperScriptPort.onmessageerror = ( ) => {
-        quitZapper();
-    };
-    zapperScriptPort.postMessage({ what: 'start' });
+function startZapper() {
+    toolOverlay.postMessage({ what: 'startTool' });
     self.addEventListener('keydown', onKeyPressed, true);
-    $stor('svg#sea').addEventListener('click', onSvgClicked);
-    $stor('svg#sea').addEventListener('touchstart', onSvgTouch, { passive: true });
-    $stor('svg#sea').addEventListener('touchend', onSvgTouch);
-    $id('quit').addEventListener('click', quitZapper );
-    $id('pick').addEventListener('click', resetZapper );
-    svgListening(true);
-};
-
-/******************************************************************************/
-
-const quitZapper = function() {
+    dom.on('svg#overlay', 'click', onSvgClicked);
+    dom.on('svg#overlay', 'touchstart', onSvgTouch, { passive: true });
+    dom.on('svg#overlay', 'touchend', onSvgTouch);
+    dom.on('#quit', 'click', quitZapper );
+    dom.on('#pick', 'click', resetZapper );
+    toolOverlay.highlightElementUnderMouse(true);
+}
+
+function quitZapper() {
     self.removeEventListener('keydown', onKeyPressed, true);
-    $stor('svg#sea').removeEventListener('click', onSvgClicked);
-    $stor('svg#sea').removeEventListener('touchstart', onSvgTouch, { passive: true });
-    $stor('svg#sea').removeEventListener('touchend', onSvgTouch);
-    $id('quit').removeEventListener('click', quitZapper );
-    $id('pick').removeEventListener('click', resetZapper );
-    svgListening(false);
-    if ( zapperScriptPort ) {
-        zapperScriptPort.postMessage({ what: 'quitZapper' });
-        zapperScriptPort.close();
-        zapperScriptPort.onmessage = null;
-        zapperScriptPort.onmessageerror = null;
-        zapperScriptPort = null;
-    }
-};
+    toolOverlay.stop();
+}
+
+function resetZapper() {
+    toolOverlay.postMessage({ what: 'unhighlight' });
+}
 
 /******************************************************************************/
 
-const resetZapper = function() {
-    zapperScriptPort.postMessage({
-        what: 'unhighlight'
-    });
-};
+function onMessage(msg) {
+    switch ( msg.what ) {
+    case 'startTool':
+        startZapper();
+        break;
+    default:
+        break;
+    }
+}
 
 /******************************************************************************/
 
 // Wait for the content script to establish communication
-
-globalThis.addEventListener('message', ev => {
-    const msg = ev.data || {};
-    if ( msg.what !== 'zapperStart' ) { return; }
-    if ( Array.isArray(ev.ports) === false ) { return; }
-    if ( ev.ports.length === 0 ) { return; }
-    startZapper(ev.ports[0]);
-}, { once: true });
+toolOverlay.start(onMessage);
 
 /******************************************************************************/