Add trusted-replace-outbound-text scriptlet

gorhill · gorhill · commit 21e1ee30ee36 · 2024-04-01T11:27:19.000-04:00
Related issue: uBlockOrigin/uBlock-issues#3157 Paremeters: - `pattern`: a string or regex to match in the outbound text. If not provided or empty, the scriptlet will only log the outbound text without modifying it. - `replacement`: the replacement string for the matched part.
diff --git a/assets/resources/scriptlets.js b/assets/resources/scriptlets.js
@@ -4704,3 +4704,38 @@ function trustedReplaceArgument(
 }
 
 /******************************************************************************/
+
+builtinScriptlets.push({
+    name: 'trusted-replace-outbound-text.js',
+    requiresTrust: true,
+    fn: trustedReplaceOutboundText,
+    dependencies: [
+        'proxy-apply.fn',
+        'safe-self.fn',
+    ],
+});
+function trustedReplaceOutboundText(
+    propChain = '',
+    pattern = '',
+    replacement = ''
+) {
+    if ( propChain === '' ) { return; }
+    const safe = safeSelf();
+    const logPrefix = safe.makeLogPrefix('trusted-replace-outbound-text', propChain, pattern, replacement);
+    const rePattern = safe.patternToRegex(pattern);
+    const reflector = proxyApplyFn(propChain, function(...args) {
+        const textBefore = reflector(...args);
+        const textAfter = pattern !== ''
+            ? textBefore.replace(rePattern, replacement)
+            : textBefore;
+        if ( textAfter !== textBefore ) {
+            safe.uboLog(logPrefix, 'Matched and replaced');
+        }
+        if ( safe.logLevel > 1 || pattern === '' ) {
+            safe.uboLog(logPrefix, 'Outbound text:\n', textAfter);
+        }
+        return textAfter;
+    });
+}
+
+/******************************************************************************/
