Issue 6538, 6781 - Implement support for snippet filters

lib/filterClasses.js

 /*
  * This file is part of Adblock Plus <https://adblockplus.org/>,
  * Copyright (C) 2006-present eyeo GmbH
  *
  * Adblock Plus is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License version 3 as
  * published by the Free Software Foundation.
  *
  * Adblock Plus is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
@@ skipping 168 matching lines @@
   text = text.replace(/[^\S ]+/g, "");
 
   // Don't remove spaces inside comments
   if (/^ *!/.test(text))
     return text.trim();
 
   // Special treatment for content filters, right side is allowed to contain
   // spaces
   if (Filter.contentRegExp.test(text))
   {
-    let [, domains, separator, script] = /^(.*?)(#[@?$]?#?)(.*)$/.exec(text);
-    return domains.replace(/ +/g, "") + separator + script.trim();
+    let [, domains, separator, body] = /^(.*?)(#[@?$]?#?)(.*)$/.exec(text);
+    return domains.replace(/ +/g, "") + separator + body.trim();
   }
 
   // For most regexp filters we strip all spaces, but $csp filter options
   // are allowed to contain single (non trailing) spaces.
   let strippedText = text.replace(/ +/g, "");
   if (!strippedText.includes("$") || !/\bcsp=/i.test(strippedText))
     return strippedText;
 
   let optionsMatch = Filter.optionsRegExp.exec(strippedText);
   if (!optionsMatch)
@@ skipping 789 matching lines @@
 
 WhitelistFilter.prototype = extend(RegExpFilter, {
   type: "whitelist"
 });
 
 /**
  * Base class for content filters
  * @param {string} text see {@link Filter Filter()}
  * @param {string} [domains] Host names or domains the filter should be
  *                           restricted to
- * @param {string} script    Script that should be executed
+ * @param {string} body      The body of the filter
  * @constructor
  * @augments ActiveFilter
  */
-function ContentFilter(text, domains, script)
+function ContentFilter(text, domains, body)
 {
   ActiveFilter.call(this, text, domains || null);
 
-  this.script = script;
+  this.body = body;
 }
 exports.ContentFilter = ContentFilter;
 
 ContentFilter.prototype = extend(ActiveFilter, {
   /**
    * @see ActiveFilter.domainSeparator
    */
   domainSeparator: ",",
 
   /**
-   * Script that should be executed
+   * The body of the filter
    * @type {string}
    */
-  script: null
+  body: null
 });
 
 /**
  * Creates a content filter from a pre-parsed text representation
  *
  * @param {string} text         same as in Filter()
  * @param {string} [domains]
  *   domains part of the text representation
  * @param {string} [type]
- *   rule type, either empty or @ (exception) or ? (emulation rule) or
- *   $ (snippet)
- * @param {string} script
- *   script part of the text representation, either a CSS selector or a snippet
+ *   rule type, either:
+ *     <li>"" for an element hiding filter</li>

[Manish Jethani, 2018/07/11 13:04:26]

Using just "-" doesn't work in the HTML version, but we can use <li> instead.

We should really switch to Markdown in the comments.

[kzar, 2018/07/11 17:17:52]

Acknowledged.

+ *     <li>"@" for an element hiding exception filter</li>
+ *     <li>"?" for an element hiding emulation filter</li>
+ *     <li>"$" for a snippet filter</li>
+ * @param {string} body
+ *   body part of the text representation, either a CSS selector or a snippet
  *   script
  * @return {ElemHideFilter|ElemHideException|
  *          ElemHideEmulationFilter|SnippetFilter|InvalidFilter}
  */
-ContentFilter.fromText = function(text, domains, type, script)
+ContentFilter.fromText = function(text, domains, type, body)
 {
   // We don't allow content filters which have any empty domains.
   // Note: The ContentFilter.prototype.domainSeparator is duplicated here, if
   // that changes this must be changed too.
   if (domains && /(^|,)~?(,|$)/.test(domains))
     return new InvalidFilter(text, "filter_invalid_domain");
 
   if (type == "@")
-    return new ElemHideException(text, domains, script);
+    return new ElemHideException(text, domains, body);
 
   if (type == "$")
-    return new SnippetFilter(text, domains, script);
+    return new SnippetFilter(text, domains, body);
 
   if (type == "?")
   {
     // Element hiding emulation filters are inefficient so we need to make sure
     // that they're only applied if they specify active domains
     if (!/,[^~][^,.]*\.[^,]/.test("," + domains))
       return new InvalidFilter(text, "filter_elemhideemulation_nodomain");
 
-    return new ElemHideEmulationFilter(text, domains, script);
-  }
-
-  return new ElemHideFilter(text, domains, script);
+    return new ElemHideEmulationFilter(text, domains, body);
+  }
+
+  return new ElemHideFilter(text, domains, body);
 };
 
-/*
+/**
  * Base class for element hiding filters
  * @param {string} text see {@link Filter Filter()}
  * @param {string} [domains] see {@link ContentFilter ContentFilter()}
  * @param {string} selector  CSS selector for the HTML elements that should be
  *                           hidden
  * @constructor
  * @augments ContentFilter
  */
 function ElemHideBase(text, domains, selector)
 {
   ContentFilter.call(this, text, domains, selector);
 }
 exports.ElemHideBase = ElemHideBase;
 
 ElemHideBase.prototype = extend(ContentFilter, {
   /**
    * CSS selector for the HTML elements that should be hidden
    * @type {string}
    */
   get selector()
   {
     // Braces are being escaped to prevent CSS rule injection.
-    return this.script.replace("{", "\\7B ").replace("}", "\\7D ");
+    return this.body.replace("{", "\\7B ").replace("}", "\\7D ");
   }
 });
 
 /**
  * Class for element hiding filters
  * @param {string} text see {@link Filter Filter()}
  * @param {string} [domains]  see {@link ElemHideBase ElemHideBase()}
  * @param {string} selector see {@link ElemHideBase ElemHideBase()}
  * @constructor
  * @augments ElemHideBase
@@ skipping 52 matching lines @@
  * @constructor
  * @augments ContentFilter
  */
 function SnippetFilter(text, domains, script)
 {
   ContentFilter.call(this, text, domains, script);
 }
 exports.SnippetFilter = SnippetFilter;
 
 SnippetFilter.prototype = extend(ContentFilter, {
-  type: "snippet"
-});
+  type: "snippet",
+
+  /**
+   * Script that should be executed
+   * @type {string}
+   */
+  get script()
+  {
+    return this.body;
+  }
+});