mirror of
https://github.com/gorhill/uBlock.git
synced 2024-11-10 09:07:54 +01:00
85c68116bd
In the static network filtering engine (snfe), the
compiling-related code was spread across two classes.
This commit makes it so that all the compiling-related
code is in FilterCompiler class, which clear purpose is
to compile raw filters into a form which can be persisted
and later fed to the snfe with no parsing overhead.
To compile raw static network filter, the new approach is:
snfe.createCompiler(parser);
Then for each single raw filter to compile:
compiler.compile(parser, writer);
The caller is responsible to keep a reference to the
compiler instance for as long as it is needed. This removes
the need for the clunky code used to keep an instance of
compiler alive in the snfe.
Additionally, snfe.tokenHistograms() has been moved to
benchmarks.js, as it has no dependency on the snfe, it's
just a utility function.
126 lines
3.9 KiB
JavaScript
126 lines
3.9 KiB
JavaScript
/*******************************************************************************
|
|
|
|
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 './lib/publicsuffixlist/publicsuffixlist.js';
|
|
import './lib/punycode.js';
|
|
|
|
import globals from './js/globals.js';
|
|
import staticNetFilteringEngine from './js/static-net-filtering.js';
|
|
import { FilteringContext } from './js/filtering-context.js';
|
|
import { LineIterator } from './js/text-utils.js';
|
|
import { StaticFilteringParser } from './js/static-filtering-parser.js';
|
|
|
|
import {
|
|
CompiledListReader,
|
|
CompiledListWriter
|
|
} from './js/static-filtering-io.js';
|
|
|
|
/******************************************************************************/
|
|
|
|
function compileList(rawText, writer) {
|
|
const lineIter = new LineIterator(rawText);
|
|
const parser = new StaticFilteringParser(true);
|
|
const compiler = staticNetFilteringEngine.createCompiler(parser);
|
|
|
|
parser.setMaxTokenLength(staticNetFilteringEngine.MAX_TOKEN_LENGTH);
|
|
|
|
while ( lineIter.eot() === false ) {
|
|
let line = lineIter.next();
|
|
|
|
while ( line.endsWith(' \\') ) {
|
|
if ( lineIter.peek(4) !== ' ' ) { break; }
|
|
line = line.slice(0, -2).trim() + lineIter.next().trim();
|
|
}
|
|
parser.analyze(line);
|
|
|
|
if ( parser.shouldIgnore() ) { continue; }
|
|
if ( parser.category !== parser.CATStaticNetFilter ) { continue; }
|
|
if ( parser.patternHasUnicode() && parser.toASCII() === false ) {
|
|
continue;
|
|
}
|
|
if ( compiler.compile(parser, writer) ) { continue; }
|
|
if ( compiler.error !== undefined ) {
|
|
console.info(JSON.stringify({
|
|
realm: 'message',
|
|
type: 'error',
|
|
text: compiler.error
|
|
}));
|
|
}
|
|
}
|
|
|
|
return writer.toString();
|
|
}
|
|
|
|
function applyList(name, raw) {
|
|
const writer = new CompiledListWriter();
|
|
writer.properties.set('name', name);
|
|
const compiled = compileList(raw, writer);
|
|
const reader = new CompiledListReader(compiled);
|
|
staticNetFilteringEngine.fromCompiled(reader);
|
|
}
|
|
|
|
function enableWASM(path) {
|
|
return Promise.all([
|
|
globals.publicSuffixList.enableWASM(`${path}/lib/publicsuffixlist`),
|
|
staticNetFilteringEngine.enableWASM(`${path}/js`),
|
|
]);
|
|
}
|
|
|
|
function pslInit(raw) {
|
|
if ( typeof raw !== 'string' || raw.trim() === '' ) {
|
|
console.info('Unable to populate public suffix list');
|
|
return;
|
|
}
|
|
globals.publicSuffixList.parse(raw, globals.punycode.toASCII);
|
|
console.info('Public suffix list populated');
|
|
}
|
|
|
|
function restart(lists) {
|
|
// Remove all filters
|
|
reset();
|
|
|
|
if ( Array.isArray(lists) && lists.length !== 0 ) {
|
|
// Populate filtering engine with filter lists
|
|
for ( const { name, raw } of lists ) {
|
|
applyList(name, raw);
|
|
}
|
|
// Commit changes
|
|
staticNetFilteringEngine.freeze();
|
|
staticNetFilteringEngine.optimize();
|
|
}
|
|
|
|
return staticNetFilteringEngine;
|
|
}
|
|
|
|
function reset() {
|
|
staticNetFilteringEngine.reset();
|
|
}
|
|
|
|
export {
|
|
FilteringContext,
|
|
enableWASM,
|
|
pslInit,
|
|
restart,
|
|
};
|