Add -blocked directive to urlskip= option

gorhill · gorhill · commit d04dc4c76772 · 2024-10-26T12:56:52.000-04:00
Potentially breaking change: `urlskip=` option will no longer apply by default to blocked network requests, only network requests which are not blocked can be skipped through a `urlskip=` filter. The new `urlskip=` directive `-blocked` can be used to explicitly allow a `urlskip=` filter to also apply to blocked network requests. Example: given the filter `||example.com^`, the filter: ||example.com/path/to/tracker$urlskip=?url Will not prevent strict-blocking when navigating to: https://example.com/path/to/tracker?url=https://example.org/ However, the filter: ||example.com/path/to/tracker$urlskip=-blocked ?url Will cause the strict-blocking to be ignored and allow navigation to proceed to the URL extracted as a result of applying the `urlskip=` filter: https://example.org/ Related discussion: uBlockOrigin/uBlock-issues#3206 (comment)
diff --git a/src/js/benchmarks.js b/src/js/benchmarks.js
@@ -191,7 +191,7 @@ export async function benchmarkStaticNetFiltering(options = {}) {
                     removeparamCount += 1;
                 }
             }
-            if ( sfne.urlSkip(fctxt) ) {
+            if ( sfne.urlSkip(fctxt, false) ) {
                 urlskipCount += 1;
             }
             if ( fctxt.isDocument() ) {
@@ -210,7 +210,7 @@ export async function benchmarkStaticNetFiltering(options = {}) {
             if ( sfne.redirectRequest(redirectEngine, fctxt) ) {
                 redirectCount += 1;
             }
-            if ( fctxt.isRootDocument() && sfne.urlSkip(fctxt) ) {
+            if ( fctxt.isRootDocument() && sfne.urlSkip(fctxt, true) ) {
                 urlskipCount += 1;
             }
         }
diff --git a/src/js/pagestore.js b/src/js/pagestore.js
@@ -943,7 +943,7 @@ const PageStore = class {
             staticNetFilteringEngine.filterQuery(fctxt, directives);
         }
         if ( this.urlSkippableResources.has(fctxt.itype) ) {
-            staticNetFilteringEngine.urlSkip(fctxt, directives);
+            staticNetFilteringEngine.urlSkip(fctxt, false, directives);
         }
         if ( directives.length === 0 ) { return; }
         if ( logger.enabled !== true ) { return; }
diff --git a/src/js/static-net-filtering.js b/src/js/static-net-filtering.js
@@ -5405,6 +5405,9 @@ StaticNetFilteringEngine.prototype.transformRequest = function(fctxt, out = [])
  * 
  * `-uricomponent`: decode the current string as a URI encoded string.
  * 
+ * `-blocked`: allow the redirection of blocked requests. By default, blocked
+ *  requests can't by urlskip'ed.
+ * 
  * At any given step, the currently extracted string may not necessarily be
  * a valid URL, and more transformation steps may be needed to obtain a valid
  * URL once all the steps are applied.
@@ -5423,7 +5426,11 @@ StaticNetFilteringEngine.prototype.transformRequest = function(fctxt, out = [])
  * 
  * */
 
-StaticNetFilteringEngine.prototype.urlSkip = function(fctxt, out = []) {
+StaticNetFilteringEngine.prototype.urlSkip = function(
+    fctxt,
+    blocked,
+    out = []
+) {
     if ( fctxt.redirectURL !== undefined ) { return; }
     const directives = this.matchAndFetchModifiers(fctxt, 'urlskip');
     if ( directives === undefined ) { return; }
@@ -5435,7 +5442,7 @@ StaticNetFilteringEngine.prototype.urlSkip = function(fctxt, out = []) {
         const urlin = fctxt.url;
         const value = directive.value;
         const steps = value.includes(' ') && value.split(/ +/) || [ value ];
-        const urlout = urlSkip(directive, urlin, steps);
+        const urlout = urlSkip(directive, urlin, blocked, steps);
         if ( urlout === undefined ) { continue; }
         if ( urlout === urlin ) { continue; }
         fctxt.redirectURL = urlout;
@@ -5446,8 +5453,9 @@ StaticNetFilteringEngine.prototype.urlSkip = function(fctxt, out = []) {
     return out;
 };
 
-function urlSkip(directive, url, steps) {
+function urlSkip(directive, url, blocked, steps) {
     try {
+        let redirectBlocked = false;
         let urlout = url;
         for ( const step of steps ) {
             const urlin = urlout;
@@ -5481,6 +5489,11 @@ function urlSkip(directive, url, steps) {
                     urlout = self.decodeURIComponent(urlin);
                     continue;
                 }
+                // Enable skip of blocked requests
+                if ( step === '-blocked' ) {
+                    redirectBlocked = true;
+                    continue;
+                }
             }
             // Regex extraction from first capture group
             if ( c0 === 0x2F ) { // /
@@ -5507,6 +5520,7 @@ function urlSkip(directive, url, steps) {
         }
         const urlfinal = new URL(urlout);
         if ( urlfinal.protocol !== 'https:' ) { return; }
+        if ( blocked && redirectBlocked !== true ) { return; }
         return urlout;
     } catch(x) {
     }

Original file line number	Diff line number	Diff line change
`@@ -191,7 +191,7 @@ export async function benchmarkStaticNetFiltering(options = {}) {`
`191`	`191`	`removeparamCount += 1;`
`192`	`192`	`}`
`193`	`193`	`}`
`194`		`- if ( sfne.urlSkip(fctxt) ) {`
	`194`	`+ if ( sfne.urlSkip(fctxt, false) ) {`
`195`	`195`	`urlskipCount += 1;`
`196`	`196`	`}`
`197`	`197`	`if ( fctxt.isDocument() ) {`
`@@ -210,7 +210,7 @@ export async function benchmarkStaticNetFiltering(options = {}) {`
`210`	`210`	`if ( sfne.redirectRequest(redirectEngine, fctxt) ) {`
`211`	`211`	`redirectCount += 1;`
`212`	`212`	`}`
`213`		`- if ( fctxt.isRootDocument() && sfne.urlSkip(fctxt) ) {`
	`213`	`+ if ( fctxt.isRootDocument() && sfne.urlSkip(fctxt, true) ) {`
`214`	`214`	`urlskipCount += 1;`
`215`	`215`	`}`
`216`	`216`	`}`
Original file line number	Diff line number	Diff line change
`@@ -943,7 +943,7 @@ const PageStore = class {`
`943`	`943`	`staticNetFilteringEngine.filterQuery(fctxt, directives);`
`944`	`944`	`}`
`945`	`945`	`if ( this.urlSkippableResources.has(fctxt.itype) ) {`
`946`		`- staticNetFilteringEngine.urlSkip(fctxt, directives);`
	`946`	`+ staticNetFilteringEngine.urlSkip(fctxt, false, directives);`
`947`	`947`	`}`
`948`	`948`	`if ( directives.length === 0 ) { return; }`
`949`	`949`	`if ( logger.enabled !== true ) { return; }`