1
0
mirror of https://github.com/gorhill/uBlock.git synced 2024-11-16 23:42:39 +01:00
uBlock/platform/mv3/extension/js/utils.js
Raymond Hill c7b54af0a2
[mv3] Add minimal ability to diagnose ruleset issue
A new icon has been added to the popup panel, to open a popup
window with a terse list of DNR events for the current tab, in
reverse chronological order (most recent DNR event appears at
the top).

The new ability is available only when the extension is sideloaded,
as per `declarativeNetRequestFeedback` documentation. Ref:
https://developer.chrome.com/docs/extensions/reference/api/declarativeNetRequest#event-onRuleMatchedDebug

Purposefully minimal, so as to have something rather than nothing
when having to diagnose filtering issue with the DNR API. Example:
https://github.com/uBlockOrigin/uBOL-home/issues/156

The content of the popup window does not dynamically update, force
a refresh (F5) to get the most recent DNR events. This might be
improved in the future.

The DNR event buffer is not persisted, so the buffer is empty when
service worker is restarted. This might be improved in the future
by using session storage API.

There is no output filtering ability in this first draft. This
might be improved in the future.

DNR rules are reported. The filter from which a DNR rule
originates is not reported. Given that the rulesets are optimized
after conversion from original filter lists to reduce the DNR rule
count, this is unlikely to ever be possible.
2024-07-29 14:54:46 -04:00

135 lines
4.1 KiB
JavaScript

/*******************************************************************************
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
*/
/******************************************************************************/
function parsedURLromOrigin(origin) {
try {
return new URL(origin);
} catch(ex) {
}
}
/******************************************************************************/
const toBroaderHostname = hn => {
if ( hn === '*' ) { return ''; }
const pos = hn.indexOf('.');
return pos !== -1 ? hn.slice(pos+1) : '*';
};
/******************************************************************************/
// Is hna descendant hostname of hnb?
const isDescendantHostname = (hna, hnb) => {
if ( hnb === 'all-urls' ) { return true; }
if ( hna.endsWith(hnb) === false ) { return false; }
if ( hna === hnb ) { return false; }
return hna.charCodeAt(hna.length - hnb.length - 1) === 0x2E /* '.' */;
};
const isDescendantHostnameOfIter = (hna, iterb) => {
const setb = iterb instanceof Set ? iterb : new Set(iterb);
if ( setb.has('all-urls') || setb.has('*') ) { return true; }
let hn = hna;
while ( hn ) {
const pos = hn.indexOf('.');
if ( pos === -1 ) { break; }
hn = hn.slice(pos + 1);
if ( setb.has(hn) ) { return true; }
}
return false;
};
const intersectHostnameIters = (itera, iterb) => {
const setb = iterb instanceof Set ? iterb : new Set(iterb);
if ( setb.has('all-urls') || setb.has('*') ) { return Array.from(itera); }
const out = [];
for ( const hna of itera ) {
if ( setb.has(hna) || isDescendantHostnameOfIter(hna, setb) ) {
out.push(hna);
}
}
return out;
};
const subtractHostnameIters = (itera, iterb) => {
const setb = iterb instanceof Set ? iterb : new Set(iterb);
if ( setb.has('all-urls') || setb.has('*') ) { return []; }
const out = [];
for ( const hna of itera ) {
if ( setb.has(hna) ) { continue; }
if ( isDescendantHostnameOfIter(hna, setb) ) { continue; }
out.push(hna);
}
return out;
};
/******************************************************************************/
const matchesFromHostnames = hostnames => {
const out = [];
for ( const hn of hostnames ) {
if ( hn === '*' || hn === 'all-urls' ) {
out.length = 0;
out.push('<all_urls>');
break;
}
out.push(`*://*.${hn}/*`);
}
return out;
};
const hostnamesFromMatches = origins => {
const out = [];
for ( const origin of origins ) {
if ( origin === '<all_urls>' ) {
out.push('all-urls');
continue;
}
const match = /^\*:\/\/(?:\*\.)?([^/]+)\/\*/.exec(origin);
if ( match === null ) { continue; }
out.push(match[1]);
}
return out;
};
/******************************************************************************/
export const broadcastMessage = message => {
const bc = new self.BroadcastChannel('uBOL');
bc.postMessage(message);
};
/******************************************************************************/
export {
parsedURLromOrigin,
toBroaderHostname,
isDescendantHostname,
isDescendantHostnameOfIter,
intersectHostnameIters,
subtractHostnameIters,
matchesFromHostnames,
hostnamesFromMatches,
};