Skip to content

Commit 7c3e060

Browse files
gorhillgorhill
committed
Implement network filter option replace=
Reference documentation: https://adguard.com/kb/general/ad-filtering/create-own-filters/#replace-modifier This is a network filter option which can only be loaded from a trusted source. Since this filter is about modifying the response body, it currently only works in Firefox. As discussed with filter list maintainers.
1 parent aeff955 commit 7c3e060

File tree

7 files changed

+537
-444
lines changed

7 files changed

+537
-444
lines changed

‎src/js/background.js‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -184,8 +184,8 @@ const µBlock = { // jshint ignore:line
184184

185185
// Read-only
186186
systemSettings: {
187-
compiledMagic: 56, // Increase when compiled format changes
188-
selfieMagic: 56, // Increase when selfie format changes
187+
compiledMagic: 57, // Increase when compiled format changes
188+
selfieMagic: 57, // Increase when selfie format changes
189189
},
190190

191191
// https://github.com/uBlockOrigin/uBlock-issues/issues/759#issuecomment-546654501

‎src/js/benchmarks.js‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -174,6 +174,7 @@ const loadBenchmarkDataset = (( ) => {
174174
let removeparamCount = 0;
175175
let cspCount = 0;
176176
let permissionsCount = 0;
177+
let replaceCount = 0;
177178
for ( let i = 0; i < requests.length; i++ ) {
178179
const request = requests[i];
179180
fctxt.setURL(request.url);
@@ -202,6 +203,9 @@ const loadBenchmarkDataset = (( ) => {
202203
}
203204
}
204205
staticNetFilteringEngine.matchHeaders(fctxt, []);
206+
if ( staticNetFilteringEngine.matchAndFetchModifiers(fctxt, 'replace') ) {
207+
replaceCount += 1;
208+
}
205209
} else if ( redirectEngine !== undefined ) {
206210
if ( staticNetFilteringEngine.redirectRequest(redirectEngine, fctxt) ) {
207211
redirectCount += 1;
@@ -222,6 +226,7 @@ const loadBenchmarkDataset = (( ) => {
222226
`\tremoveparam=: ${removeparamCount}`,
223227
`\tcsp=: ${cspCount}`,
224228
`\tpermissions=: ${permissionsCount}`,
229+
`\treplace=: ${replaceCount}`,
225230
];
226231
const s = output.join('\n');
227232
console.info(s);

‎src/js/filtering-context.js‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -175,6 +175,7 @@ const FilteringContext = class {
175175

176176
fromFilteringContext(other) {
177177
this.realm = other.realm;
178+
this.id = other.id;
178179
this.type = other.type;
179180
this.method = other.method;
180181
this.url = other.url;

‎src/js/html-filtering.js‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -429,15 +429,15 @@ htmlFilteringEngine.retrieve = function(details) {
429429
}
430430
};
431431

432-
htmlFilteringEngine.apply = function(doc, details) {
432+
htmlFilteringEngine.apply = function(doc, details, selectors) {
433433
docRegister = doc;
434434
let modified = false;
435-
for ( const selector of details.selectors.plains ) {
435+
for ( const selector of selectors.plains ) {
436436
if ( applyCSSSelector(details, selector) ) {
437437
modified = true;
438438
}
439439
}
440-
for ( const selector of details.selectors.procedurals ) {
440+
for ( const selector of selectors.procedurals ) {
441441
if ( applyProceduralSelector(details, selector) ) {
442442
modified = true;
443443
}

‎src/js/static-filtering-parser.js‎

Lines changed: 65 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -187,6 +187,7 @@ export const NODE_TYPE_NET_OPTION_NAME_POPUP = iota++;
187187
export const NODE_TYPE_NET_OPTION_NAME_REDIRECT = iota++;
188188
export const NODE_TYPE_NET_OPTION_NAME_REDIRECTRULE = iota++;
189189
export const NODE_TYPE_NET_OPTION_NAME_REMOVEPARAM = iota++;
190+
export const NODE_TYPE_NET_OPTION_NAME_REPLACE = iota++;
190191
export const NODE_TYPE_NET_OPTION_NAME_SCRIPT = iota++;
191192
export const NODE_TYPE_NET_OPTION_NAME_SHIDE = iota++;
192193
export const NODE_TYPE_NET_OPTION_NAME_TO = iota++;
@@ -265,6 +266,7 @@ export const nodeTypeFromOptionName = new Map([
265266
/* synonym */ [ 'rewrite', NODE_TYPE_NET_OPTION_NAME_REDIRECT ],
266267
[ 'redirect-rule', NODE_TYPE_NET_OPTION_NAME_REDIRECTRULE ],
267268
[ 'removeparam', NODE_TYPE_NET_OPTION_NAME_REMOVEPARAM ],
269+
[ 'replace', NODE_TYPE_NET_OPTION_NAME_REPLACE ],
268270
/* synonym */ [ 'queryprune', NODE_TYPE_NET_OPTION_NAME_REMOVEPARAM ],
269271
[ 'script', NODE_TYPE_NET_OPTION_NAME_SCRIPT ],
270272
[ 'shide', NODE_TYPE_NET_OPTION_NAME_SHIDE ],
@@ -597,9 +599,14 @@ const exCharCodeAt = (s, i) => {
597599
return pos >= 0 ? s.charCodeAt(pos) : -1;
598600
};
599601

602+
const toEscapedCharRegex = c => {
603+
const safe = c.replace(/[.*+?^${}()|[\]\\]/g, '\\$&');
604+
return new RegExp(`((?:^|[^\\\\])(?:\\\\\\\\)*)\\\\${safe}`, 'g');
605+
};
606+
600607
/******************************************************************************/
601608

602-
class argListParser {
609+
class ArgListParser {
603610
constructor(separatorChar = ',', mustQuote = false) {
604611
this.separatorChar = this.actualSeparatorChar = separatorChar;
605612
this.separatorCode = this.actualSeparatorCode = separatorChar.charCodeAt(0);
@@ -612,10 +619,10 @@ class argListParser {
612619
this.reWhitespaceStart = /^\s+/;
613620
this.reWhitespaceEnd = /\s+$/;
614621
this.reOddTrailingEscape = /(?:^|[^\\])(?:\\\\)*\\$/;
615-
this.reEscapedDoubleQuote = /((?:^|[^\\])(?:\\\\)*)\\"/g;
616-
this.reEscapedSingleQuote = /((?:^|[^\\])(?:\\\\)*)\\'/g;
617-
this.reEscapedBacktick = /((?:^|[^\\])(?:\\\\)*)\\`/g;
618-
this.reEscapedSeparator = new RegExp(`((?:^|[^\\\\])(?:\\\\\\\\)*)\\\\${this.separatorChar}`, 'g');
622+
this.reEscapedDoubleQuote = toEscapedCharRegex('"');
623+
this.reEscapedSingleQuote = toEscapedCharRegex("'");
624+
this.reEscapedBacktick = toEscapedCharRegex('`');
625+
this.reEscapedSeparator = toEscapedCharRegex(this.separatorChar);
619626
this.unescapedSeparator = `$1${this.separatorChar}`;
620627
}
621628
nextArg(pattern, beg = 0) {
@@ -871,7 +878,7 @@ export class AstFilterParser {
871878
this.rePlainEntity = /^(?:[\da-z][\da-z_-]*\.)+\*$/;
872879
this.reHostsSink = /^[\w%.:\[\]-]+\s+/;
873880
this.reHostsRedirect = /(?:0\.0\.0\.0|broadcasthost|local|localhost(?:\.localdomain)?|ip6-\w+)(?:[^\w.-]|$)/;
874-
this.reNetOptionComma = /,(?!\d*\})/g;
881+
this.reNetOptionComma = /,(?:~?[13a-z-]+(?:=.*?)?|_+)(?:,|$)/;
875882
this.rePointlessLeftAnchor = /^\|\|?\*+/;
876883
this.reIsTokenChar = /^[%0-9A-Za-z]/;
877884
this.rePointlessLeadingWildcards = /^(\*+)[^%0-9A-Za-z\u{a0}-\u{10FFFF}]/u;
@@ -898,7 +905,7 @@ export class AstFilterParser {
898905
this.reGoodRegexToken = /[^\x01%0-9A-Za-z][%0-9A-Za-z]{7,}|[^\x01%0-9A-Za-z][%0-9A-Za-z]{1,6}[^\x01%0-9A-Za-z]/;
899906
this.reBadCSP = /(?:=|;)\s*report-(?:to|uri)\b/;
900907
this.reNoopOption = /^_+$/;
901-
this.scriptletArgListParser = new argListParser(',');
908+
this.scriptletArgListParser = new ArgListParser(',');
902909
}
903910

904911
parse(raw) {
@@ -1414,6 +1421,7 @@ export class AstFilterParser {
14141421
break;
14151422
case NODE_TYPE_NET_OPTION_NAME_REDIRECT:
14161423
case NODE_TYPE_NET_OPTION_NAME_REDIRECTRULE:
1424+
case NODE_TYPE_NET_OPTION_NAME_REPLACE:
14171425
case NODE_TYPE_NET_OPTION_NAME_URLTRANSFORM:
14181426
realBad = isNegated || (isException || hasValue) === false ||
14191427
modifierType !== 0;
@@ -1474,6 +1482,20 @@ export class AstFilterParser {
14741482
realBad = abstractTypeCount || behaviorTypeCount || unredirectableTypeCount;
14751483
break;
14761484
}
1485+
case NODE_TYPE_NET_OPTION_NAME_REPLACE: {
1486+
realBad = abstractTypeCount || behaviorTypeCount || unredirectableTypeCount;
1487+
if ( realBad ) { break; }
1488+
if ( this.options.trustedSource !== true ) {
1489+
this.astError = AST_ERROR_UNTRUSTED_SOURCE;
1490+
realBad = true;
1491+
break;
1492+
}
1493+
if ( this.interactive ) {
1494+
const value = this.getNetOptionValue(NODE_TYPE_NET_OPTION_NAME_REPLACE);
1495+
realBad = parseReplaceValue(value) === undefined;
1496+
}
1497+
break;
1498+
}
14771499
case NODE_TYPE_NET_OPTION_NAME_URLTRANSFORM:
14781500
realBad = abstractTypeCount || behaviorTypeCount || unredirectableTypeCount;
14791501
if ( realBad ) { break; }
@@ -1959,9 +1981,8 @@ export class AstFilterParser {
19591981
}
19601982

19611983
endOfNetOption(s, beg) {
1962-
this.reNetOptionComma.lastIndex = beg;
1963-
const match = this.reNetOptionComma.exec(s);
1964-
return match !== null ? match.index : s.length;
1984+
const match = this.reNetOptionComma.exec(s.slice(beg));
1985+
return match !== null ? beg + match.index : s.length;
19651986
}
19661987

19671988
parseNetOption(parent) {
@@ -2975,6 +2996,39 @@ export function parseHeaderValue(arg) {
29752996
return out;
29762997
}
29772998

2999+
3000+
// https://adguard.com/kb/general/ad-filtering/create-own-filters/#replace-modifier
3001+
3002+
export function parseReplaceValue(s) {
3003+
if ( s.charCodeAt(0) !== 0x2F /* / */ ) { return; }
3004+
const { reEscapedComma, reEscapedDollarSign } = parseReplaceValue;
3005+
const parser = new ArgListParser('/');
3006+
parser.nextArg(s, 1);
3007+
let pattern = s.slice(parser.argBeg, parser.argEnd);
3008+
if ( parser.transform ) {
3009+
pattern = parser.normalizeArg(pattern);
3010+
}
3011+
pattern = pattern
3012+
.replace(reEscapedDollarSign, '$1$$$')
3013+
.replace(reEscapedComma, '$1,');
3014+
parser.nextArg(s, parser.separatorEnd);
3015+
let replacement = s.slice(parser.argBeg, parser.argEnd);
3016+
if ( parser.separatorEnd === parser.separatorBeg ) { return; }
3017+
if ( parser.transform ) {
3018+
replacement = parser.normalizeArg(replacement);
3019+
}
3020+
replacement = replacement
3021+
.replace(reEscapedDollarSign, '$1$$')
3022+
.replace(reEscapedComma, '$1,');
3023+
const flags = s.slice(parser.separatorEnd);
3024+
try {
3025+
return { re: new RegExp(pattern, flags), replacement };
3026+
} catch(_) {
3027+
}
3028+
}
3029+
parseReplaceValue.reEscapedDollarSign = toEscapedCharRegex('$');
3030+
parseReplaceValue.reEscapedComma = toEscapedCharRegex(',');
3031+
29783032
/******************************************************************************/
29793033

29803034
export const netOptionTokenDescriptors = new Map([
@@ -3025,6 +3079,7 @@ export const netOptionTokenDescriptors = new Map([
30253079
/* synonym */ [ 'rewrite', { mustAssign: true } ],
30263080
[ 'redirect-rule', { mustAssign: true } ],
30273081
[ 'removeparam', { } ],
3082+
[ 'replace', { mustAssign: true } ],
30283083
/* synonym */ [ 'queryprune', { } ],
30293084
[ 'script', { canNegate: true } ],
30303085
[ 'shide', { } ],

0 commit comments

Comments
 (0)