Issue 431/432 - Remove special handling for the $sitekey option

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 147 matching lines @@
   {
     if (filter.text in this.keywordByFilter)
       return this.keywordByFilter[filter.text];
     else
       return null;
   },
 
   /**
    * Checks whether the entries for a particular keyword match a URL
    */
-  _checkEntryMatch: function(keyword, location, contentType, docDomain, thirdParty)
+  _checkEntryMatch: function(keyword, location, contentType, docDomain, thirdParty, docLocation, siteKey)
   {
     let list = this.filterByKeyword[keyword];
     for (let i = 0; i < list.length; i++)
     {
       let filter = list[i];
-      if (filter.matches(location, contentType, docDomain, thirdParty))
+      if (filter.matches(location, contentType, docDomain, thirdParty, docLocation, siteKey))
         return filter;
     }
     return null;
   },
 
   /**
    * Tests whether the URL matches any of the known filters
    * @param {String} location URL to be tested
    * @param {String} contentType content type identifier of the URL
    * @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} docLocation location the document that loads the URL
+   * @param {String} siteKey public key provided by the document
    * @return {RegExpFilter} matching filter or null
    */
-  matchesAny: function(location, contentType, docDomain, thirdParty)
+  matchesAny: function(location, contentType, docDomain, thirdParty, docLocation, siteKey)
   {
     let candidates = location.toLowerCase().match(/[a-z0-9%]{3,}/g);
     if (candidates === null)
       candidates = [];
     candidates.push("");
     for (let i = 0, l = candidates.length; i < l; i++)
     {
       let substr = candidates[i];
       if (substr in this.filterByKeyword)
       {
-        let result = this._checkEntryMatch(substr, location, contentType, docDomain, thirdParty);
+        let result = this._checkEntryMatch(substr, location, contentType, docDomain, thirdParty, docLocation, siteKey);
         if (result)
           return result;
       }
     }
 
     return null;
   }
 };
 
 /**
  * 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.keys = Object.create(null);
   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,
 
   /**
-   * Exception rules that are limited by public keys, mapped by the corresponding keys.
-   * @type Object
-   */
-  keys: null,
-
-  /**
    * Lookup table of previous matchesAny results
    * @type Object
    */
   resultCache: null,
 
   /**
    * Number of entries in resultCache
    * @type Number
    */
   cacheEntries: 0,
 
   /**
    * @see Matcher#clear
    */
   clear: function()
   {
     this.blacklist.clear();
     this.whitelist.clear();
-    this.keys = Object.create(null);
     this.resultCache = Object.create(null);
     this.cacheEntries = 0;
   },
 
   /**
    * @see Matcher#add
    */
   add: function(filter)
   {
     if (filter instanceof WhitelistFilter)
-    {
-      if (filter.siteKeys)
-      {
-        for (let i = 0; i < filter.siteKeys.length; i++)
-          this.keys[filter.siteKeys[i]] = filter.text;
-      }
-      else
-        this.whitelist.add(filter);
-    }
+      this.whitelist.add(filter);
     else
       this.blacklist.add(filter);
 
     if (this.cacheEntries > 0)
     {
       this.resultCache = Object.create(null);
       this.cacheEntries = 0;
     }
   },
 
   /**
    * @see Matcher#remove
    */
   remove: function(filter)
   {
     if (filter instanceof WhitelistFilter)
-    {
-      if (filter.siteKeys)
-      {
-        for (let i = 0; i < filter.siteKeys.length; i++)
-          delete this.keys[filter.siteKeys[i]];
-      }
-      else
-        this.whitelist.remove(filter);
-    }
+      this.whitelist.remove(filter);
     else
       this.blacklist.remove(filter);
 
     if (this.cacheEntries > 0)
     {
       this.resultCache = Object.create(null);
       this.cacheEntries = 0;
     }
   },
 
@@ skipping 40 matching lines @@
       return !matcher.getKeywordForFilter(filter);
     else
       return !matcher.findKeyword(filter);
   },
 
   /**
    * Optimized filter matching testing both whitelist and blacklist matchers
    * simultaneously. For parameters see Matcher.matchesAny().
    * @see Matcher#matchesAny
    */
-  matchesAnyInternal: function(location, contentType, docDomain, thirdParty)
+  matchesAnyInternal: function(location, contentType, docDomain, thirdParty, docLocation, 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)
       {
-        let result = this.whitelist._checkEntryMatch(substr, location, contentType, docDomain, thirdParty);
+        let result = this.whitelist._checkEntryMatch(substr, location, contentType, docDomain, thirdParty, docLocation, siteKey);
         if (result)
           return result;
       }
       if (substr in this.blacklist.filterByKeyword && blacklistHit === null)
-        blacklistHit = this.blacklist._checkEntryMatch(substr, location, contentType, docDomain, thirdParty);
+        blacklistHit = this.blacklist._checkEntryMatch(substr, location, contentType, docDomain, thirdParty, docLocation, siteKey);
     }
     return blacklistHit;
   },
 
   /**
    * @see Matcher#matchesAny
    */
-  matchesAny: function(location, contentType, docDomain, thirdParty)
+  matchesAny: function(location, contentType, docDomain, thirdParty, docLocation, siteKey)
   {
-    let key = location + " " + contentType + " " + docDomain + " " + thirdParty;
+    let key = location + " " + contentType + " " + docDomain + " " + thirdParty + " " + docLocation + " " + siteKey;
     if (key in this.resultCache)
       return this.resultCache[key];
 
-    let result = this.matchesAnyInternal(location, contentType, docDomain, thirdParty);
+    let result = this.matchesAnyInternal(location, contentType, docDomain, thirdParty, docLocation, siteKey);
 
     if (this.cacheEntries >= CombinedMatcher.maxCacheEntries)
     {
       this.resultCache = Object.create(null);
       this.cacheEntries = 0;
     }
 
     this.resultCache[key] = result;
     this.cacheEntries++;
 
     return result;
-  },
-
-  /**
-   * Looks up whether any filters match the given website key.
-   */
-  matchesByKey: function(/**String*/ location, /**String*/ key, /**String*/ docDomain)
-  {
-    key = key.toUpperCase();
-    if (key in this.keys)
-    {
-      let filter = Filter.knownFilters[this.keys[key]];
-      if (filter && filter.matches(location, "DOCUMENT", docDomain, false))
-        return filter;
-      else
-        return null;
-    }
-    else
-      return null;
   }
 }
 
 /**
  * Shared CombinedMatcher instance that should usually be used.
  * @type CombinedMatcher
  */
 let defaultMatcher = exports.defaultMatcher = new CombinedMatcher();