Skip to content

Commit

Permalink
Add support for special exception filter #@#+js()
Browse files Browse the repository at this point in the history 
The purpose is to wholly disable scriptlet injection
for a given site without having to create exceptions
for all matching scriptlet injection filters.

The following exception filter will cause scriptlet
injection to be wholly disable for `example.com`:

    `example.com#@#+js()`

Or to disable scriptlet injection everywhere:

    `#@#+js()`

The following form is meaningless and will be
ignored:

    `example.com##+js()`
  • Loading branch information
@gorhill
gorhill committed Aug 17, 2019
1 parent 1ac016b commit bf3c925
Show file tree
Hide file tree
Showing 2 changed files with 86 additions and 46 deletions.
68 changes: 33 additions & 35 deletions src/js/cosmetic-filtering.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1127,41 +1127,39 @@ FilterContainer.prototype.getFilterCount = function() {

/******************************************************************************/

FilterContainer.prototype.benchmark = function() {
µb.loadBenchmarkDataset().then(requests => {
if ( Array.isArray(requests) === false || requests.length === 0 ) {
console.info('No requests found to benchmark');
return;
}
console.info(`Benchmarking cosmeticFilteringEngine.matchString()...`);
const details = {
tabId: undefined,
frameId: undefined,
hostname: '',
domain: '',
entity: '',
};
const options = {
noCosmeticFiltering: false,
noGenericCosmeticFiltering: false,
};
let count = 0;
const t0 = self.performance.now();
for ( let i = 0; i < requests.length; i++ ) {
const request = requests[i];
if ( request.cpt !== 'document' ) { continue; }
count += 1;
details.hostname = µb.URI.hostnameFromURI(request.url);
details.domain = µb.URI.domainFromHostname(details.hostname);
details.entity = µb.URI.entityFromDomain(details.domain);
void this.retrieveSpecificSelectors(details, options);
}
const t1 = self.performance.now();
const dur = t1 - t0;
console.info(`Evaluated ${count} requests in ${dur.toFixed(0)} ms`);
console.info(`\tAverage: ${(dur / count).toFixed(3)} ms per request`);
});
return 'ok';
FilterContainer.prototype.benchmark = async function() {
const requests = await µb.loadBenchmarkDataset();
if ( Array.isArray(requests) === false || requests.length === 0 ) {
console.info('No requests found to benchmark');
return;
}
console.info('Benchmarking cosmeticFilteringEngine.retrieveSpecificSelectors()...');
const details = {
tabId: undefined,
frameId: undefined,
hostname: '',
domain: '',
entity: '',
};
const options = {
noCosmeticFiltering: false,
noGenericCosmeticFiltering: false,
};
let count = 0;
const t0 = self.performance.now();
for ( let i = 0; i < requests.length; i++ ) {
const request = requests[i];
if ( request.cpt !== 'document' ) { continue; }
count += 1;
details.hostname = µb.URI.hostnameFromURI(request.url);
details.domain = µb.URI.domainFromHostname(details.hostname);
details.entity = µb.URI.entityFromDomain(details.domain);
void this.retrieveSpecificSelectors(details, options);
}
const t1 = self.performance.now();
const dur = t1 - t0;
console.info(`Evaluated ${count} requests in ${dur.toFixed(0)} ms`);
console.info(`\tAverage: ${(dur / count).toFixed(3)} ms per request`);
};

/******************************************************************************/
Expand Down
64 changes: 53 additions & 11 deletions src/js/scriptlet-filtering.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,6 @@
const µb = µBlock,
duplicates = new Set(),
scriptletCache = new µb.MRUCache(32),
scriptletsRegister = new Map(),
exceptionsRegister = new Set(),
reEscapeScriptArg = /[\\'"]/g;

let acceptedCount = 0,
Expand Down Expand Up @@ -289,6 +287,11 @@
// Only exception filters are allowed to be global.
const normalized = normalizeRawFilter(parsed.suffix);

// Tokenless is meaningful only for exception filters.
if ( normalized === '+js()' && parsed.exception === false ) {
return;
}

if ( parsed.hostnames.length === 0 ) {
if ( parsed.exception ) {
writer.push([ 32, '', 1, normalized ]);
Expand Down Expand Up @@ -358,7 +361,7 @@
}

const scriptlets = new Set();
const exceptions = exceptionsRegister;
const exceptions = new Set();

scriptletDB.retrieve(
hostname,
Expand All @@ -370,17 +373,27 @@
[ scriptlets, exceptions ]
);
}
if ( scriptlets.size === 0 ) { return; }

for ( const rawToken of scriptlets ) {
lookupScriptlet(rawToken, reng, scriptletsRegister);
const loggerEnabled = µb.logger.enabled;

// Wholly disable scriptlet injection?
if ( exceptions.has('') ) {
if ( loggerEnabled ) {
logOne(true, '', request);
}
return;
}

if ( scriptletsRegister.size === 0 ) { return; }
const scriptletToCodeMap = new Map();
for ( const rawToken of scriptlets ) {
lookupScriptlet(rawToken, reng, scriptletToCodeMap);
}
if ( scriptletToCodeMap.size === 0 ) { return; }

// Return an array of scriptlets, and log results if needed.
const out = [];
const loggerEnabled = µb.logger.enabled;
for ( const [ rawToken, code ] of scriptletsRegister ) {
for ( const [ rawToken, code ] of scriptletToCodeMap ) {
const isException = exceptions.has(rawToken);
if ( isException === false ) {
out.push(code);
Expand All @@ -390,9 +403,6 @@
}
}

scriptletsRegister.clear();
exceptionsRegister.clear();

if ( out.length === 0 ) { return; }

if ( µb.hiddenSettings.debugScriptlets ) {
Expand Down Expand Up @@ -454,6 +464,38 @@
scriptletDB = new µb.staticExtFilteringEngine.HostnameBasedDB(1, selfie);
};

api.benchmark = async function() {
const requests = await µb.loadBenchmarkDataset();
if ( Array.isArray(requests) === false || requests.length === 0 ) {
console.info('No requests found to benchmark');
return;
}
console.info('Benchmarking scriptletFilteringEngine.retrieve()...');
const details = {
domain: '',
entity: '',
hostname: '',
tabId: 0,
url: '',
};
let count = 0;
const t0 = self.performance.now();
for ( let i = 0; i < requests.length; i++ ) {
const request = requests[i];
if ( request.cpt !== 'document' ) { continue; }
count += 1;
details.url = request.url;
details.hostname = µb.URI.hostnameFromURI(request.url);
details.domain = µb.URI.domainFromHostname(details.hostname);
details.entity = µb.URI.entityFromDomain(details.domain);
void this.retrieve(details);
}
const t1 = self.performance.now();
const dur = t1 - t0;
console.info(`Evaluated ${count} requests in ${dur.toFixed(0)} ms`);
console.info(`\tAverage: ${(dur / count).toFixed(3)} ms per request`);
};

return api;
})();

Expand Down

0 comments on commit bf3c925

Please sign in to comment.