Issue 616 - Add $generichide + $genericblock filter options and enforce them.

lib/filterClasses.js

 /*
  * This file is part of Adblock Plus <https://adblockplus.org/>,
  * Copyright (C) 2006-2015 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
  * 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 Adblock Plus.  If not, see <http://www.gnu.org/licenses/>.
  */
 
 /**
  * @fileOverview Definition of Filter class and its subclasses.
  */
 
 let {FilterNotifier} = require("filterNotifier");
+let {Utils} = require("utils");
 
 /**
  * Abstract base class for filters
  *
  * @param {String} text   string representation of the filter
  * @constructor
  */
 function Filter(text)
 {
   this.text = text;
   this.subscriptions = [];
 }
 exports.Filter = Filter;
 
 Filter.prototype =
 {
   /**
    * String representation of the filter
    * @type String
    */
   text: null,
 
   /**
    * Filter subscriptions the filter belongs to
-   * @type Array of Subscription
+   * @type Subscription[]
    */
   subscriptions: null,
 
   /**
    * Serializes the filter to an array of strings for writing out on the disk.
-   * @param {Array of String} buffer  buffer to push the serialization results into
+   * @param {string[]} buffer  buffer to push the serialization results into
    */
   serialize: function(buffer)
   {
     buffer.push("[Filter]");
     buffer.push("text=" + this.text);
   },
 
   toString: function()
   {
     return this.text;
@@ skipping 14 matching lines @@
 /**
  * Regular expression that RegExp filters specified as RegExps should match
  * @type RegExp
  */
 Filter.regexpRegExp = /^(@@)?\/.*\/(?:\$~?[\w\-]+(?:=[^,\s]+)?(?:,~?[\w\-]+(?:=[^,\s]+)?)*)?$/;
 /**
  * Regular expression that options on a RegExp filter should match
  * @type RegExp
  */
 Filter.optionsRegExp = /\$(~?[\w\-]+(?:=[^,\s]+)?(?:,~?[\w\-]+(?:=[^,\s]+)?)*)$/;
+/**
+ * Regular expression that CSS property filters should match
+ * Properties must not contain " or '
+ * @type RegExp
+ */
+Filter.csspropertyRegExp = /\[\-abp\-properties=(["'])([^"']+)\1\]/;
 
 /**
  * Creates a filter of correct type from its text representation - does the basic parsing and
  * calls the right constructor then.
  *
  * @param {String} text   as in Filter()
  * @return {Filter}
  */
 Filter.fromText = function(text)
 {
@@ skipping 53 matching lines @@
   }
   else if (Filter.elemhideRegExp.test(text))
   {
     // Special treatment for element hiding filters, right side is allowed to contain spaces
     let [, domain, separator, selector] = /^(.*?)(#\@?#?)(.*)$/.exec(text);
     return domain.replace(/\s/g, "") + separator + selector.trim();
   }
   else
     return text.replace(/\s/g, "");
 };
+
+/**
+ * Converts filter text into regular expression string
+ * @param {String} text as in Filter()
+ * @return {String} regular expression representation of filter text
+ */
+Filter.toRegExp = function(text)
+{
+  return text
+    .replace(/\*+/g, "*")        // remove multiple wildcards
+    .replace(/\^\|$/, "^")       // remove anchors following separator placeholder
+    .replace(/\W/g, "\\$&")      // escape special symbols
+    .replace(/\\\*/g, ".*")      // replace wildcards by .*
+    // process separator placeholders (all ANSI characters but alphanumeric characters and _%.-)
+    .replace(/\\\^/g, "(?:[\\x00-\\x24\\x26-\\x2C\\x2F\\x3A-\\x40\\x5B-\\x5E\\x60\\x7B-\\x7F]|$)")
+    .replace(/^\\\|\\\|/, "^[\\w\\-]+:\\/+(?!\\/)(?:[^\\/]+\\.)?") // process extended anchor at expression start
+    .replace(/^\\\|/, "^")       // process anchor at expression start
+    .replace(/\\\|$/, "$")       // process anchor at expression end
+    .replace(/^(\.\*)/, "")      // remove leading wildcards
+    .replace(/(\.\*)$/, "");     // remove trailing wildcards
+}
 
 /**
  * Class for invalid filters
  * @param {String} text see Filter()
  * @param {String} reason Reason why this filter is invalid
  * @constructor
  * @augments Filter
  */
 function InvalidFilter(text, reason)
 {
@@ skipping 210 matching lines @@
 
       this.domainSource = null;
     }
 
     Object.defineProperty(this, "domains", {value: domains, enumerable: true});
     return this.domains;
   },
 
   /**
    * Array containing public keys of websites that this filter should apply to
-   * @type Array of String
+   * @type string[]
    */
   sitekeys: null,
 
   /**
    * Checks whether this filter is active on a domain.
    * @param {String} docDomain domain name of the document that loads the URL
    * @param {String} [sitekey] public key provided by the document
    * @return {Boolean} true in case of the filter being active
    */
   isActiveOnDomain: function(docDomain, sitekey)
@@ skipping 38 matching lines @@
 
     if (this.ignoreTrailingDot)
       docDomain = docDomain.replace(/\.+$/, "");
     docDomain = docDomain.toUpperCase();
 
     for (let domain in this.domains)
       if (this.domains[domain] && domain != docDomain && (domain.length <= docDomain.length || domain.indexOf("." + docDomain) != domain.length - docDomain.length - 1))
         return false;
 
     return true;
+  },
+
+  /**
+   * Checks whether this filter is generic or specific
+   */
+  isGeneric: function() /**Boolean*/
+  {
+    return !(this.sitekeys && this.sitekeys.length) &&
+            (!this.domains || this.domains[""]);
   },
 
   /**
    * See Filter.serialize()
    */
   serialize: function(buffer)
   {
     if (this._disabled || this._hitCount || this._lastHit)
     {
       Filter.prototype.serialize.call(this, buffer);
@@ skipping 76 matching lines @@
    * @type RegExp
    */
   get regexp()
   {
     // Despite this property being cached, the getter is called
     // several times on Safari, due to WebKit bug 132872
     let prop = Object.getOwnPropertyDescriptor(this, "regexp");
     if (prop)
       return prop.value;
 
-    // Remove multiple wildcards
-    let source = this.regexpSource
-      .replace(/\*+/g, "*")        // remove multiple wildcards
-      .replace(/\^\|$/, "^")       // remove anchors following separator placeholder
-      .replace(/\W/g, "\\$&")      // escape special symbols
-      .replace(/\\\*/g, ".*")      // replace wildcards by .*
-      // process separator placeholders (all ANSI characters but alphanumeric characters and _%.-)
-      .replace(/\\\^/g, "(?:[\\x00-\\x24\\x26-\\x2C\\x2F\\x3A-\\x40\\x5B-\\x5E\\x60\\x7B-\\x7F]|$)")
-      .replace(/^\\\|\\\|/, "^[\\w\\-]+:\\/+(?!\\/)(?:[^\\/]+\\.)?") // process extended anchor at expression start
-      .replace(/^\\\|/, "^")       // process anchor at expression start
-      .replace(/\\\|$/, "$")       // process anchor at expression end
-      .replace(/^(\.\*)/, "")      // remove leading wildcards
-      .replace(/(\.\*)$/, "");     // remove trailing wildcards
-
+    let source = Filter.toRegExp(this.regexpSource);
     let regexp = new RegExp(source, this.matchCase ? "" : "i");
     Object.defineProperty(this, "regexp", {value: regexp});
     return regexp;
   },
   /**
    * Content types the filter applies to, combination of values from RegExpFilter.typeMap
    * @type Number
    */
   contentType: 0x7FFFFFFF,
   /**
    * Defines whether the filter should distinguish between lower and upper case letters
    * @type Boolean
    */
   matchCase: false,
   /**
    * Defines whether the filter should apply to third-party or first-party content only. Can be null (apply to all content).
    * @type Boolean
    */
   thirdParty: null,
 
   /**
    * String that the sitekey property should be generated from
    * @type String
    */
   sitekeySource: null,
 
   /**
    * Array containing public keys of websites that this filter should apply to
-   * @type Array of String
+   * @type string[]
    */
   get sitekeys()
   {
     // Despite this property being cached, the getter is called
     // several times on Safari, due to WebKit bug 132872
     let prop = Object.getOwnPropertyDescriptor(this, "sitekeys");
     if (prop)
       return prop.value;
 
     let sitekeys = null;
 
     if (this.sitekeySource)
     {
       sitekeys = this.sitekeySource.split("|");
       this.sitekeySource = null;
     }
 
     Object.defineProperty(this, "sitekeys", {value: sitekeys, enumerable: true});
     return this.sitekeys;
   },
 
   /**
    * Tests whether the URL matches this filter
    * @param {String} location URL to be tested
-   * @param {String} contentType content type identifier of the URL
+   * @param {String} typeMask bitmask of content / request types to match
    * @param {String} docDomain domain name of the document that loads the URL
    * @param {Boolean} thirdParty should be true if the URL is a third-party request
    * @param {String} sitekey public key provided by the document
    * @return {Boolean} true in case of a match
    */
-  matches: function(location, contentType, docDomain, thirdParty, sitekey)
-  {
-    if (this.regexp.test(location) &&
-        (RegExpFilter.typeMap[contentType] & this.contentType) != 0 &&
+  matches: function(location, typeMask, docDomain, thirdParty, sitekey)
+  {
+    if (this.contentType & typeMask &&
         (this.thirdParty == null || this.thirdParty == thirdParty) &&
-        this.isActiveOnDomain(docDomain, sitekey))
+        this.isActiveOnDomain(docDomain, sitekey) && this.regexp.test(location))
     {
       return true;
     }
 
     return false;
   }
 };
 
 // Required to optimize Matcher, see also RegExpFilter.prototype.length
 Object.defineProperty(RegExpFilter.prototype, "0",
@@ skipping 63 matching lines @@
         collapse = true;
       else if (option == "~COLLAPSE")
         collapse = false;
       else if (option == "SITEKEY" && typeof value != "undefined")
         sitekeys = value;
       else
         return new InvalidFilter(origText, "Unknown option " + option.toLowerCase());
     }
   }
 
-  if (!blocking && (contentType == null || (contentType & RegExpFilter.typeMap.DOCUMENT)) &&
-      (!options || options.indexOf("DOCUMENT") < 0) && !/^\|?[\w\-]+:/.test(text))
-  {
-    // Exception filters shouldn't apply to pages by default unless they start with a protocol name
-    if (contentType == null)
-      contentType = RegExpFilter.prototype.contentType;
-    contentType &= ~RegExpFilter.typeMap.DOCUMENT;
-  }
-
   try
   {
     if (blocking)
       return new BlockingFilter(origText, text, contentType, matchCase, domains, thirdParty, sitekeys, collapse);
     else
       return new WhitelistFilter(origText, text, contentType, matchCase, domains, thirdParty, sitekeys);
   }
   catch (e)
   {
     return new InvalidFilter(origText, e);
@@ skipping 20 matching lines @@
   FONT: 32768,
 
   BACKGROUND: 4,    // Backwards compat, same as IMAGE
 
   POPUP: 0x10000000,
   GENERICBLOCK: 0x20000000,
   ELEMHIDE: 0x40000000,
   GENERICHIDE: 0x80000000
 };
 
-// ELEMHIDE, POPUP, GENERICHIDE and GENERICBLOCK options shouldn't be there by default
-RegExpFilter.prototype.contentType &= ~(RegExpFilter.typeMap.ELEMHIDE |
+// DOCUMENT, ELEMHIDE, POPUP, GENERICHIDE and GENERICBLOCK options shouldn't
+// be there by default
+RegExpFilter.prototype.contentType &= ~(RegExpFilter.typeMap.DOCUMENT |
+                                        RegExpFilter.typeMap.ELEMHIDE |
                                         RegExpFilter.typeMap.POPUP |
                                         RegExpFilter.typeMap.GENERICHIDE |
                                         RegExpFilter.typeMap.GENERICBLOCK);
 
 /**
  * Class for blocking filters
  * @param {String} text see Filter()
  * @param {String} regexpSource see RegExpFilter()
  * @param {Number} contentType see RegExpFilter()
  * @param {Boolean} matchCase see RegExpFilter()
@@ skipping 91 matching lines @@
 };
 
 /**
  * Creates an element hiding filter from a pre-parsed text representation
  *
  * @param {String} text       same as in Filter()
  * @param {String} domain     domain part of the text representation (can be empty)
  * @param {String} tagName    tag name part (can be empty)
  * @param {String} attrRules  attribute matching rules (can be empty)
  * @param {String} selector   raw CSS selector (can be empty)
- * @return {ElemHideFilter|ElemHideException|InvalidFilter}
+ * @return {ElemHideFilter|ElemHideException|CSSPropertyFilter|InvalidFilter}
  */
 ElemHideBase.fromText = function(text, domain, isException, tagName, attrRules, selector)
 {
   if (!selector)
   {
     if (tagName == "*")
       tagName = "";
 
     let id = null;
     let additional = "";
-    if (attrRules) {
+    if (attrRules)
+    {
       attrRules = attrRules.match(/\([\w\-]+(?:[$^*]?=[^\(\)"]*)?\)/g);
-      for (let rule of attrRules) {
+      for (let rule of attrRules)
+      {
         rule = rule.substr(1, rule.length - 2);
         let separatorPos = rule.indexOf("=");
-        if (separatorPos > 0) {
+        if (separatorPos > 0)
+        {
           rule = rule.replace(/=/, '="') + '"';
           additional += "[" + rule + "]";
         }
-        else {
+        else
+        {
           if (id)
-          {
-            let {Utils} = require("utils");
             return new InvalidFilter(text, Utils.getString("filter_elemhide_duplicate_id"));
-          }
-          else
-            id = rule;
+
+          id = rule;
         }
       }
     }
 
     if (id)
       selector = tagName + "." + id + additional + "," + tagName + "#" + id + additional;
     else if (tagName || additional)
       selector = tagName + additional;
     else
-    {
-      let {Utils} = require("utils");
       return new InvalidFilter(text, Utils.getString("filter_elemhide_nocriteria"));
-    }
-  }
+  }
+
   if (isException)
     return new ElemHideException(text, domain, selector);
-  else
-    return new ElemHideFilter(text, domain, selector);
+
+  let match = Filter.csspropertyRegExp.exec(selector);
+  if (match)
+  {
+    // CSS property filters are inefficient so we need to make sure that
+    // they're only applied if they specify active domains
+    if (!/,[^~][^,.]*\.[^,]/.test("," + domain))
+      return new InvalidFilter(text, Utils.getString("filter_cssproperty_nodomain"));
+
+    return new CSSPropertyFilter(text, domain, selector, match[2],
+      selector.substr(0, match.index),
+      selector.substr(match.index + match[0].length));
+  }
+
+  return new ElemHideFilter(text, domain, selector);
 };
 
 /**
  * Class for element hiding filters
  * @param {String} text see Filter()
  * @param {String} domains  see ElemHideBase()
  * @param {String} selector see ElemHideBase()
  * @constructor
  * @augments ElemHideBase
  */
@@ skipping 19 matching lines @@
 function ElemHideException(text, domains, selector)
 {
   ElemHideBase.call(this, text, domains, selector);
 }
 exports.ElemHideException = ElemHideException;
 
 ElemHideException.prototype =
 {
   __proto__: ElemHideBase.prototype
 };
+
+/**
+ * Class for CSS property filters
+ * @param {String} text           see Filter()
+ * @param {String} domains        see ElemHideBase()
+ * @param {String} selector       see ElemHideBase()
+ * @param {String} regexpSource   see CSSPropertyFilter.regexpSource
+ * @param {String} selectorPrefix see CSSPropertyFilter.selectorPrefix
+ * @param {String} selectorSuffix see CSSPropertyFilter.selectorSuffix
+ * @constructor
+ * @augments ElemHideBase
+ */
+function CSSPropertyFilter(text, domains, selector, regexpSource,
+  selectorPrefix, selectorSuffix)
+{
+  ElemHideBase.call(this, text, domains, selector);
+
+  this.regexpSource = regexpSource;
+  this.selectorPrefix = selectorPrefix;
+  this.selectorSuffix = selectorSuffix;
+}
+exports.CSSPropertyFilter = CSSPropertyFilter;
+
+CSSPropertyFilter.prototype =
+{
+  __proto__: ElemHideBase.prototype,
+
+  /**
+   * Expression from which a regular expression should be generated for matching
+   * CSS properties - for delayed creation of the regexpString property
+   * @type String
+   */
+  regexpSource: null,
+  /**
+   * Substring of CSS selector before properties for the HTML elements that
+   * should be hidden
+   * @type String
+   */
+  selectorPrefix: null,
+  /**
+   * Substring of CSS selector after properties for the HTML elements that
+   * should be hidden
+   * @type String
+   */
+  selectorSuffix: null,
+
+  /**
+   * Raw regular expression string to be used when testing CSS properties
+   * against this filter
+   * @type String
+   */
+  get regexpString()
+  {
+    // Despite this property being cached, the getter is called
+    // several times on Safari, due to WebKit bug 132872
+    let prop = Object.getOwnPropertyDescriptor(this, "regexpString");
+    if (prop)
+      return prop.value;
+
+    let regexp = Filter.toRegExp(this.regexpSource);
+    Object.defineProperty(this, "regexpString", {value: regexp});
+    return regexp;
+  }
+};