@browserless.io/browserless 2.0.0-beta-1

package/extensions/ublock/js/dashboard-common.js

@@ -0,0 +1,215 @@
+/*******************************************************************************
+
+    uBlock Origin - a browser extension to block requests.
+    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
+*/
+
+'use strict';
+
+import { dom } from './dom.js';
+
+/******************************************************************************/
+
+self.uBlockDashboard = self.uBlockDashboard || {};
+
+/******************************************************************************/
+
+// Helper for client panes:
+//   Remove literal duplicate lines from a set based on another set.
+
+self.uBlockDashboard.mergeNewLines = function(text, newText) {
+    // Step 1: build dictionary for existing lines.
+    const fromDict = new Map();
+    let lineBeg = 0;
+    let textEnd = text.length;
+    while ( lineBeg < textEnd ) {
+        let lineEnd = text.indexOf('\n', lineBeg);
+        if ( lineEnd === -1 ) {
+            lineEnd = text.indexOf('\r', lineBeg);
+            if ( lineEnd === -1 ) {
+                lineEnd = textEnd;
+            }
+        }
+        const line = text.slice(lineBeg, lineEnd).trim();
+        lineBeg = lineEnd + 1;
+        if ( line.length === 0 ) { continue; }
+        const hash = line.slice(0, 8);
+        const bucket = fromDict.get(hash);
+        if ( bucket === undefined ) {
+            fromDict.set(hash, line);
+        } else if ( typeof bucket === 'string' ) {
+            fromDict.set(hash, [ bucket, line ]);
+        } else /* if ( Array.isArray(bucket) ) */ {
+            bucket.push(line);
+        }
+    }
+
+    // Step 2: use above dictionary to filter out duplicate lines.
+    const out = [ '' ];
+    lineBeg = 0;
+    textEnd = newText.length;
+    while ( lineBeg < textEnd ) {
+        let lineEnd = newText.indexOf('\n', lineBeg);
+        if ( lineEnd === -1 ) {
+            lineEnd = newText.indexOf('\r', lineBeg);
+            if ( lineEnd === -1 ) {
+                lineEnd = textEnd;
+            }
+        }
+        const line = newText.slice(lineBeg, lineEnd).trim();
+        lineBeg = lineEnd + 1;
+        if ( line.length === 0 ) {
+            if ( out[out.length - 1] !== '' ) {
+                out.push('');
+            }
+            continue;
+        }
+        const bucket = fromDict.get(line.slice(0, 8));
+        if ( bucket === undefined ) {
+            out.push(line);
+            continue;
+        }
+        if ( typeof bucket === 'string' && line !== bucket ) {
+            out.push(line);
+            continue;
+        }
+        if ( bucket.indexOf(line) === -1 ) {
+            out.push(line);
+            /* continue; */
+        }
+    }
+
+    const append = out.join('\n').trim();
+    if ( text !== '' && append !== '' ) {
+        text += '\n\n';
+    }
+    return text + append;
+};
+
+/******************************************************************************/
+
+self.uBlockDashboard.dateNowToSensibleString = function() {
+    const now = new Date(Date.now() - (new Date()).getTimezoneOffset() * 60000);
+    return now.toISOString().replace(/\.\d+Z$/, '')
+                            .replace(/:/g, '.')
+                            .replace('T', '_');
+};
+
+/******************************************************************************/
+
+self.uBlockDashboard.patchCodeMirrorEditor = (function() {
+    let grabFocusTarget;
+
+    const grabFocus = function() {
+        grabFocusTarget.focus();
+        grabFocusTarget = undefined;
+    };
+
+    const grabFocusTimer = vAPI.defer.create(grabFocus);
+
+    const grabFocusAsync = function(cm) {
+        grabFocusTarget = cm;
+        grabFocusTimer.on(1);
+    };
+
+    // https://github.com/gorhill/uBlock/issues/3646
+    const patchSelectAll = function(cm, details) {
+        var vp = cm.getViewport();
+        if ( details.ranges.length !== 1 ) { return; }
+        var range = details.ranges[0],
+            lineFrom = range.anchor.line,
+            lineTo = range.head.line;
+        if ( lineTo === lineFrom ) { return; }
+        if ( range.head.ch !== 0 ) { lineTo += 1; }
+        if ( lineFrom !== vp.from || lineTo !== vp.to ) { return; }
+        details.update([
+            {
+                anchor: { line: 0, ch: 0 },
+                head: { line: cm.lineCount(), ch: 0 }
+            }
+        ]);
+        grabFocusAsync(cm);
+    };
+
+    let lastGutterClick = 0;
+    let lastGutterLine = 0;
+
+    const onGutterClicked = function(cm, line, gutter) {
+        if ( gutter !== 'CodeMirror-linenumbers' ) { return; }
+        grabFocusAsync(cm);
+        const delta = Date.now() - lastGutterClick;
+        // Single click
+        if ( delta >= 500 || line !== lastGutterLine ) {
+            cm.setSelection(
+                { line, ch: 0 },
+                { line: line + 1, ch: 0 }
+            );
+            lastGutterClick = Date.now();
+            lastGutterLine = line;
+            return;
+        }
+        // Double click: select fold-able block or all
+        let lineFrom = 0;
+        let lineTo = cm.lineCount();
+        const foldFn = cm.getHelper({ line, ch: 0 }, 'fold');
+        if ( foldFn instanceof Function ) {
+            const range = foldFn(cm, { line, ch: 0 });
+            if ( range !== undefined ) {
+                lineFrom = range.from.line;
+                lineTo = range.to.line + 1;
+            }
+        }
+        cm.setSelection(
+            { line: lineFrom, ch: 0 },
+            { line: lineTo, ch: 0 },
+            { scroll: false }
+        );
+        lastGutterClick = 0;
+    };
+
+    return function(cm) {
+        if ( cm.options.inputStyle === 'contenteditable' ) {
+            cm.on('beforeSelectionChange', patchSelectAll);
+        }
+        cm.on('gutterClick', onGutterClicked);
+    };
+})();
+
+/******************************************************************************/
+
+self.uBlockDashboard.openOrSelectPage = function(url, options = {}) {
+    let ev;
+    if ( url instanceof MouseEvent ) {
+        ev = url;
+        url = dom.attr(ev.target, 'href');
+    } 
+    const details = Object.assign({ url, select: true, index: -1 }, options);
+    vAPI.messaging.send('default', {
+        what: 'gotoURL',
+        details,
+    });
+    if ( ev ) {
+        ev.preventDefault();
+    }
+};
+
+/******************************************************************************/
+
+// Open links in the proper window
+dom.attr('a', 'target', '_blank');
+dom.attr('a[href*="dashboard.html"]', 'target', '_parent');

package/extensions/ublock/js/dashboard.js

@@ -0,0 +1,166 @@
+/*******************************************************************************
+
+    uBlock Origin - a browser extension to block requests.
+    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
+*/
+
+'use strict';
+
+import { dom, qs$ } from './dom.js';
+
+/******************************************************************************/
+
+const discardUnsavedData = function(synchronous = false) {
+    const paneFrame = qs$('#iframe');
+    const paneWindow = paneFrame.contentWindow;
+    if (
+        typeof paneWindow.hasUnsavedData !== 'function' ||
+        paneWindow.hasUnsavedData() === false
+    ) {
+        return true;
+    }
+
+    if ( synchronous ) {
+        return false;
+    }
+
+    return new Promise(resolve => {
+        const modal = qs$('#unsavedWarning');
+        dom.cl.add(modal, 'on');
+        modal.focus();
+
+        const onDone = status => {
+            dom.cl.remove(modal, 'on');
+            dom.off(document, 'click', onClick, true);
+            resolve(status);
+        };
+
+        const onClick = ev => {
+            const target = ev.target;
+            if ( target.matches('[data-i18n="dashboardUnsavedWarningStay"]') ) {
+                return onDone(false);
+            }
+            if ( target.matches('[data-i18n="dashboardUnsavedWarningIgnore"]') ) {
+                return onDone(true);
+            }
+            if ( qs$(modal, '[data-i18n="dashboardUnsavedWarning"]').contains(target) ) {
+                return;
+            }
+            onDone(false);
+        };
+
+        dom.on(document, 'click', onClick, true);
+    });
+};
+
+const loadDashboardPanel = function(pane, first) {
+    const tabButton = qs$(`[data-pane="${pane}"]`);
+    if ( tabButton === null || dom.cl.has(tabButton, 'selected') ) { return; }
+    const loadPane = ( ) => {
+        self.location.replace(`#${pane}`);
+        dom.cl.remove('.tabButton.selected', 'selected');
+        dom.cl.add(tabButton, 'selected');
+        tabButton.scrollIntoView();
+        qs$('#iframe').contentWindow.location.replace(pane);
+        if ( pane !== 'no-dashboard.html' ) {
+            vAPI.localStorage.setItem('dashboardLastVisitedPane', pane);
+        }
+    };
+    if ( first ) {
+        return loadPane();
+    }
+    const r = discardUnsavedData();
+    if ( r === false ) { return; }
+    if ( r === true ) { return loadPane(); }
+    r.then(status => {
+        if ( status === false ) { return; }
+        loadPane();
+    });
+};
+
+const onTabClickHandler = function(ev) {
+    loadDashboardPanel(dom.attr(ev.target, 'data-pane'));
+};
+
+if ( self.location.hash.slice(1) === 'no-dashboard.html' ) {
+    dom.cl.add(dom.body, 'noDashboard');
+}
+
+(async ( ) => {
+    // Wait for uBO's main process to be ready
+    await new Promise(resolve => {
+        const check = async ( ) => {
+            try {
+                const response = await vAPI.messaging.send('dashboard', {
+                    what: 'readyToFilter'
+                });
+                if ( response ) { return resolve(true); }
+                const iframe = qs$('#iframe');
+                if ( iframe.src !== '' ) {
+                    iframe.src = '';
+                }
+            } catch(ex) {
+            }
+            vAPI.defer.once(250).then(( ) => check());
+        };
+        check();
+    });
+
+    dom.cl.remove(dom.body, 'notReady');
+
+    const results = await Promise.all([
+        // https://github.com/uBlockOrigin/uBlock-issues/issues/106
+        vAPI.messaging.send('dashboard', { what: 'dashboardConfig' }),
+        vAPI.localStorage.getItemAsync('dashboardLastVisitedPane'),
+    ]);
+
+    {
+        const details = results[0] || {};
+        if ( details.noDashboard ) {
+            self.location.hash = '#no-dashboard.html';
+            dom.cl.add(dom.body, 'noDashboard');
+        } else if ( self.location.hash === '#no-dashboard.html' ) {
+            self.location.hash = '';
+        }
+    }
+
+    {
+        let pane = results[1] || null;
+        if ( self.location.hash !== '' ) {
+            pane = self.location.hash.slice(1) || null;
+        }
+        loadDashboardPanel(pane !== null ? pane : 'settings.html', true);
+
+        dom.on('.tabButton', 'click', onTabClickHandler);
+
+        // https://developer.mozilla.org/en-US/docs/Web/API/Window/beforeunload_event
+        dom.on(self, 'beforeunload', ( ) => {
+            if ( discardUnsavedData(true) ) { return; }
+            event.preventDefault();
+            event.returnValue = '';
+        });
+
+        // https://developer.mozilla.org/en-US/docs/Web/API/Window/beforeunload_event
+        dom.on(self, 'hashchange', ( ) => {
+            const pane = self.location.hash.slice(1);
+            if ( pane === '' ) { return; }
+            loadDashboardPanel(pane);
+        });
+
+    }
+})();

package/extensions/ublock/js/devtools.js

@@ -0,0 +1,184 @@
+/*******************************************************************************
+
+    uBlock Origin - a browser extension to block requests.
+    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
+*/
+
+/* global CodeMirror, uBlockDashboard */
+
+'use strict';
+
+import { dom, qs$ } from './dom.js';
+
+/******************************************************************************/
+
+const reFoldable = /^ *(?=\+ \S)/;
+
+/******************************************************************************/
+
+CodeMirror.registerGlobalHelper(
+    'fold',
+    'ubo-dump',
+    ( ) => true,
+    (cm, start) => {
+        const startLineNo = start.line;
+        const startLine = cm.getLine(startLineNo);
+        let endLineNo = startLineNo;
+        let endLine = startLine;
+        const match = reFoldable.exec(startLine);
+        if ( match === null ) { return; }
+        const foldCandidate = '  ' + match[0];
+        const lastLineNo = cm.lastLine();
+        let nextLineNo = startLineNo + 1;
+        while ( nextLineNo < lastLineNo ) {
+            const nextLine = cm.getLine(nextLineNo);
+            // TODO: use regex to find folding end
+            if ( nextLine.startsWith(foldCandidate) === false && nextLine !== ']' ) {
+                if ( startLineNo >= endLineNo ) { return; }
+                return {
+                    from: CodeMirror.Pos(startLineNo, startLine.length),
+                    to: CodeMirror.Pos(endLineNo, endLine.length)
+                };
+            }
+            endLine = nextLine;
+            endLineNo = nextLineNo;
+            nextLineNo += 1;
+        }
+    }
+);
+
+const cmEditor = new CodeMirror(qs$('#console'), {
+    autofocus: true,
+    foldGutter: true,
+    gutters: [ 'CodeMirror-linenumbers', 'CodeMirror-foldgutter' ],
+    lineNumbers: true,
+    lineWrapping: true,
+    mode: 'ubo-dump',
+    styleActiveLine: true,
+    undoDepth: 5,
+});
+
+uBlockDashboard.patchCodeMirrorEditor(cmEditor);
+
+/******************************************************************************/
+
+function log(text) {
+    cmEditor.replaceRange(text.trim() + '\n\n', { line: 0, ch: 0 });
+}
+
+/******************************************************************************/
+
+dom.on('#console-clear', 'click', ( ) => {
+    cmEditor.setValue('');
+});
+
+dom.on('#console-fold', 'click', ( ) => {
+    const unfolded = [];
+    let maxUnfolded = -1;
+    cmEditor.eachLine(handle => {
+        const match = reFoldable.exec(handle.text);
+        if ( match === null ) { return; }
+        const depth = match[0].length;
+        const line = handle.lineNo();
+        const isFolded = cmEditor.isFolded({ line, ch: handle.text.length });
+        if ( isFolded === true ) { return; }
+        unfolded.push({ line, depth });
+        maxUnfolded = Math.max(maxUnfolded, depth);
+    });
+    if ( maxUnfolded === -1 ) { return; }
+    cmEditor.startOperation();
+    for ( const details of unfolded ) {
+        if ( details.depth !== maxUnfolded ) { continue; }
+        cmEditor.foldCode(details.line, null, 'fold');
+    }
+    cmEditor.endOperation();
+});
+
+dom.on('#console-unfold', 'click', ( ) => {
+    const folded = [];
+    let minFolded = Number.MAX_SAFE_INTEGER;
+    cmEditor.eachLine(handle => {
+        const match = reFoldable.exec(handle.text);
+        if ( match === null ) { return; }
+        const depth = match[0].length;
+        const line = handle.lineNo();
+        const isFolded = cmEditor.isFolded({ line, ch: handle.text.length });
+        if ( isFolded !== true ) { return; }
+        folded.push({ line, depth });
+        minFolded = Math.min(minFolded, depth);
+    });
+    if ( minFolded === Number.MAX_SAFE_INTEGER ) { return; }
+    cmEditor.startOperation();
+    for ( const details of folded ) {
+        if ( details.depth !== minFolded ) { continue; }
+        cmEditor.foldCode(details.line, null, 'unfold');
+    }
+    cmEditor.endOperation();
+});
+
+dom.on('#snfe-dump', 'click', ev => {
+    const button = ev.target;
+    dom.attr(button, 'disabled', '');
+    vAPI.messaging.send('dashboard', {
+        what: 'snfeDump',
+    }).then(result => {
+        log(result);
+        dom.attr(button, 'disabled', null);
+    });
+});
+
+dom.on('#snfe-todnr', 'click', ev => {
+    const button = ev.target;
+    dom.attr(button, 'disabled', '');
+    vAPI.messaging.send('dashboard', {
+        what: 'snfeToDNR',
+    }).then(result => {
+        log(result);
+        dom.attr(button, 'disabled', null);
+    });
+});
+
+vAPI.messaging.send('dashboard', {
+    what: 'getAppData',
+}).then(appData => {
+    if ( appData.canBenchmark !== true ) { return; }
+    dom.attr('#snfe-benchmark', 'disabled', null);
+    dom.on('#snfe-benchmark', 'click', ev => {
+        const button = ev.target;
+        dom.attr(button, 'disabled', '');
+        vAPI.messaging.send('dashboard', {
+            what: 'snfeBenchmark',
+        }).then(result => {
+            log(result);
+            dom.attr(button, 'disabled', null);
+        });
+    });
+});
+
+dom.on('#cfe-dump', 'click', ev => {
+    const button = ev.target;
+    dom.attr(button, 'disabled', '');
+    vAPI.messaging.send('dashboard', {
+        what: 'cfeDump',
+    }).then(result => {
+        log(result);
+        dom.attr(button, 'disabled', null);
+    });
+});
+
+/******************************************************************************/