Issue 1282 - Let user-defined filters override filter lists

lib/matcher.js

 /*
  * This file is part of Adblock Plus <http://adblockplus.org/>,
  * Copyright (C) 2006-2014 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 198 matching lines @@
 
 /**
  * Combines a matcher for blocking and exception rules, automatically sorts
  * rules into two Matcher instances.
  * @constructor
  */
 function CombinedMatcher()
 {
   this.blacklist = new Matcher();
   this.whitelist = new Matcher();
+  this.userBlacklist = new Matcher();
+  this.userWhitelist = new Matcher();
   this.resultCache = Object.create(null);
 }
 exports.CombinedMatcher = CombinedMatcher;
 
 /**
  * Maximal number of matching cache entries to be kept
  * @type Number
  */
 CombinedMatcher.maxCacheEntries = 1000;
 
 CombinedMatcher.prototype =
 {
   /**
    * Matcher for blocking rules.
    * @type Matcher
    */
   blacklist: null,
 
   /**
    * Matcher for exception rules.
    * @type Matcher
    */
   whitelist: null,
 
   /**
+   * Matcher for user-defined blocking rules.
+   * @type Matcher
+   */
+  userBlacklist: null,
+
+  /**
+   * Matcher for user-defined exception rules.
+   * @type Matcher
+   */
+  userWhitelist: null,
+
+  /**
    * Lookup table of previous matchesAny results
    * @type Object
    */
   resultCache: null,
 
   /**
    * Number of entries in resultCache
    * @type Number
    */
   cacheEntries: 0,
 
+  _getMatcher: function(filter)
+  {
+    if (filter.isUserDefined)
+    {
+      if (filter instanceof WhitelistFilter)
+        return this.userWhitelist;
+      else
+        return this.userBlacklist;
+    }
+    else
+    {
+      if (filter instanceof WhitelistFilter)
+        return this.whitelist;
+      else
+        return this.blacklist;
+    }
+  },
+
   /**
    * @see Matcher#clear
    */
   clear: function()
   {
     this.blacklist.clear();
     this.whitelist.clear();
+    this.userBlacklist.clear();
+    this.userWhitelist.clear();
     this.resultCache = Object.create(null);
     this.cacheEntries = 0;
   },
 
   /**
    * @see Matcher#add
    */
   add: function(filter)
   {
-    if (filter instanceof WhitelistFilter)
-      this.whitelist.add(filter);
-    else
-      this.blacklist.add(filter);
+    this._getMatcher(filter).add(filter);
 
     if (this.cacheEntries > 0)
     {
       this.resultCache = Object.create(null);
       this.cacheEntries = 0;
     }
   },
 
   /**
    * @see Matcher#remove
    */
   remove: function(filter)
   {
-    if (filter instanceof WhitelistFilter)
-      this.whitelist.remove(filter);
-    else
-      this.blacklist.remove(filter);
+    this._getMatcher(filter).remove(filter);
 
     if (this.cacheEntries > 0)
     {
       this.resultCache = Object.create(null);
       this.cacheEntries = 0;
     }
   },
 
   /**
    * @see Matcher#findKeyword
    */
   findKeyword: function(filter)
   {
-    if (filter instanceof WhitelistFilter)
-      return this.whitelist.findKeyword(filter);
-    else
-      return this.blacklist.findKeyword(filter);
+    return this._getMatcher(filter).findKeyword(filter);
   },
 
   /**
    * @see Matcher#hasFilter
    */
   hasFilter: function(filter)
   {
-    if (filter instanceof WhitelistFilter)
-      return this.whitelist.hasFilter(filter);
-    else
-      return this.blacklist.hasFilter(filter);
+    return this._getMatcher(filter).hasFilter(filter);
   },
 
   /**
    * @see Matcher#getKeywordForFilter
    */
   getKeywordForFilter: function(filter)
   {
-    if (filter instanceof WhitelistFilter)
-      return this.whitelist.getKeywordForFilter(filter);
-    else
-      return this.blacklist.getKeywordForFilter(filter);
+    return this._getMatcher(filter).getKeywordForFilter(filter);
   },
 
   /**
    * Checks whether a particular filter is slow
    */
   isSlowFilter: function(/**RegExpFilter*/ filter) /**Boolean*/
   {
-    let matcher = (filter instanceof WhitelistFilter ? this.whitelist : this.blacklist);
+    let matcher = this._getMatcher(filter);
     if (matcher.hasFilter(filter))
       return !matcher.getKeywordForFilter(filter);
     else
       return !matcher.findKeyword(filter);
   },
 
   /**
    * Optimized filter matching testing both whitelist and blacklist matchers
-   * simultaneously. For parameters see Matcher.matchesAny().
+   * simultaneously.
    * @see Matcher#matchesAny
    */
-  matchesAnyInternal: function(location, contentType, docDomain, thirdParty, sitekey)
+  matchesAnyInternal: function(blacklist, whitelist, candidates, location, contentType, docDomain, thirdParty, sitekey)
   {
-    let candidates = location.toLowerCase().match(/[a-z0-9%]{3,}/g);
-    if (candidates === null)
-      candidates = [];
-    candidates.push("");
-
     let blacklistHit = null;
     for (let i = 0, l = candidates.length; i < l; i++)
     {
       let substr = candidates[i];
-      if (substr in this.whitelist.filterByKeyword)
+      if (substr in whitelist.filterByKeyword)
       {
-        let result = this.whitelist._checkEntryMatch(substr, location, contentType, docDomain, thirdParty, sitekey);
+        let result = whitelist._checkEntryMatch(substr, location, contentType, docDomain, thirdParty, sitekey);
         if (result)
           return result;
       }
-      if (substr in this.blacklist.filterByKeyword && blacklistHit === null)
-        blacklistHit = this.blacklist._checkEntryMatch(substr, location, contentType, docDomain, thirdParty, sitekey);
+      if (substr in blacklist.filterByKeyword && blacklistHit === null)
+        blacklistHit = blacklist._checkEntryMatch(substr, location, contentType, docDomain, thirdParty, sitekey);
     }
     return blacklistHit;
   },
 
   /**
    * @see Matcher#matchesAny
    */
   matchesAny: function(location, contentType, docDomain, thirdParty, sitekey)
   {
     let key = location + " " + contentType + " " + docDomain + " " + thirdParty + " " + sitekey;
     if (key in this.resultCache)
       return this.resultCache[key];
 
-    let result = this.matchesAnyInternal(location, contentType, docDomain, thirdParty, sitekey);
+    let candidates = location.toLowerCase().match(/[a-z0-9%]{3,}/g);
+    if (candidates === null)
+      candidates = [];
+    candidates.push("");
+
+    let result = (this.matchesAnyInternal(this.userBlacklist, this.userWhitelist, candidates, location, contentType, docDomain, thirdParty, sitekey) ||
+                  this.matchesAnyInternal(this.blacklist,     this.whitelist,     candidates, location, contentType, docDomain, thirdParty, sitekey));
 
     if (this.cacheEntries >= CombinedMatcher.maxCacheEntries)
     {
       this.resultCache = Object.create(null);
       this.cacheEntries = 0;
     }
 
     this.resultCache[key] = result;
     this.cacheEntries++;
 
     return result;
   }
 }
 
 /**
  * Shared CombinedMatcher instance that should usually be used.
  * @type CombinedMatcher
  */
 let defaultMatcher = exports.defaultMatcher = new CombinedMatcher();