Issue 616 - Add specificOnly parameter to matchesAny

lib/matcher.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
@@ 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, sitekey, specificOnly)
+  _checkEntryMatch: function(keyword, location, typeMask, docDomain, thirdParty, sitekey, specificOnly)
   {
     let list = this.filterByKeyword[keyword];
     for (let i = 0; i < list.length; i++)
     {
       let filter = list[i];
-      if (filter.matches(location, contentType, docDomain, thirdParty, sitekey) &&

[Sebastian Noack, 2015/03/12 11:36:21]

Since the filter match is certainly the most expensive operation here, how about
performing the other checks first?

[Sebastian Noack, 2015/03/12 11:36:21]

This is a very long chain of conditions. How about splitting them in two
if-statements using the continue-statement?

[kzar, 2015/03/12 17:08:09]

Done.

[kzar, 2015/03/12 17:08:09]

Done.

-          (!specificOnly || filter instanceof WhitelistFilter ||
-           !(!filter.domains || filter.domains[""])))

[Sebastian Noack, 2015/03/12 11:36:21]

Isn't this the same as (filter.domains && !filter.domains[""])?

[kzar, 2015/03/12 17:08:09]

Done.

+
+      if (specificOnly && filter.isGeneric() &&
+          !(filter instanceof WhitelistFilter))
+        continue;
+
+      if (filter.matches(location, typeMask, docDomain, thirdParty, 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} 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
    * @param {Boolean} specificOnly should be true if generic matches should be ignored
    * @return {RegExpFilter} matching filter or null
    */
-  matchesAny: function(location, contentType, docDomain, thirdParty, sitekey, specificOnly)
+  matchesAny: function(location, typeMask, docDomain, thirdParty, sitekey, specificOnly)
   {
     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, sitekey, specificOnly);
+        let result = this._checkEntryMatch(substr, location, typeMask, docDomain, thirdParty, sitekey, specificOnly);
         if (result)
           return result;
       }
     }
 
     return null;
   }
 };
 
 /**
@@ skipping 129 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, sitekey, specificOnly)
+  matchesAnyInternal: function(location, typeMask, docDomain, thirdParty, sitekey, specificOnly)
   {
     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, sitekey);
+        let result = this.whitelist._checkEntryMatch(substr, location, typeMask, 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, specificOnly);
+        blacklistHit = this.blacklist._checkEntryMatch(substr, location, typeMask, docDomain, thirdParty, sitekey, specificOnly);
     }
     return blacklistHit;
   },
 
   /**
    * @see Matcher#matchesAny
    */
-  matchesAny: function(location, contentType, docDomain, thirdParty, sitekey, specificOnly)
-  {
-    let key = location + " " + contentType + " " + docDomain + " " + thirdParty + " " + sitekey + " " + specificOnly;
+  matchesAny: function(location, typeMask, docDomain, thirdParty, sitekey, specificOnly)
+  {
+    let key = location + " " + typeMask + " " + docDomain + " " + thirdParty + " " + sitekey + " " + specificOnly;
     if (key in this.resultCache)
       return this.resultCache[key];
 
-    let result = this.matchesAnyInternal(location, contentType, docDomain, thirdParty, sitekey, specificOnly);
+    let result = this.matchesAnyInternal(location, typeMask, docDomain, thirdParty, sitekey, specificOnly);
 
     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();