Issue 2738 - Make RegExpFilter.matches() take a bit mask instead of content type string

lib/contentPolicy.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 Content policy implementation, responsible for blocking things.
  */
 
 Cu.import("resource://gre/modules/XPCOMUtils.jsm");
 Cu.import("resource://gre/modules/Services.jsm");
 
 let {Utils} = require("utils");
 let {Prefs} = require("prefs");
 let {FilterStorage} = require("filterStorage");
-let {BlockingFilter, WhitelistFilter} = require("filterClasses");
+let {BlockingFilter, WhitelistFilter, RegExpFilter} = require("filterClasses");
 let {defaultMatcher} = require("matcher");
 let {objectMouseEventHander} = require("objectTabs");
 let {RequestNotifier} = require("requestNotifier");
 let {ElemHide} = require("elemHide");
 
 /**
  * List of explicitly supported content types
  * @type string[]
  */
 let contentTypes = ["OTHER", "SCRIPT", "IMAGE", "STYLESHEET", "OBJECT", "SUBDOCUMENT", "DOCUMENT", "XMLHTTPREQUEST", "OBJECT_SUBREQUEST", "FONT", "MEDIA"];
@@ skipping 21 matching lines @@
    */
   type: {},
 
   /**
    * Map of content type names by their identifiers (reverse of type map).
    * @type Object
    */
   typeDescr: {},
 
   /**
+   * Map of numerical content types with their corresponding masks
+   * @type Object
+   */
+  typeMask: {},
+
+  /**
    * Map of localized content type names by their identifiers.
    * @type Object
    */
   localizedDescr: {},
 
   /**
    * Lists the non-visual content types.
    * @type Object
    */
   nonVisual: {},
@@ skipping 12 matching lines @@
     // type constant by type description and type description by type constant
     let iface = Ci.nsIContentPolicy;
     for (let typeName of contentTypes)
     {
       if ("TYPE_" + typeName in iface)
       {
         let id = iface["TYPE_" + typeName];
         this.type[typeName] = id;
         this.typeDescr[id] = typeName;
         this.localizedDescr[id] = Utils.getString("type_label_" + typeName.toLowerCase());
+        this.typeMask[id] = RegExpFilter.toTypeMask(typeName);
       }
     }
 
     this.type.ELEMHIDE = 0xFFFD;
     this.typeDescr[0xFFFD] = "ELEMHIDE";
     this.localizedDescr[0xFFFD] = Utils.getString("type_label_elemhide");
+    this.typeMask[0xFFFD] = RegExpFilter.toTypeMask("ELEMHIDE");
 
     this.type.POPUP = 0xFFFE;
     this.typeDescr[0xFFFE] = "POPUP";
     this.localizedDescr[0xFFFE] = Utils.getString("type_label_popup");
+    this.typeMask[0xFFFE] = RegExpFilter.toTypeMask("POPUP");
+
+    this.defaultTypeMask = RegExpFilter.toTypeMask("");

[Wladimir Palant, 2015/07/10 21:07:00]

It's a bit mask - the default is always 0.

[kzar, 2015/07/12 13:59:39]

Egad, that was stupid of me.
Done.

 
     for (let type of nonVisualTypes)
       this.nonVisual[this.type[type]] = true;
 
     // whitelisted URL schemes
     for (let scheme of Prefs.whitelistschemes.toLowerCase().split(" "))
       this.whitelistSchemes[scheme] = true;
 
     // Generate class identifier used to collapse node and register corresponding
     // stylesheet.
@@ skipping 70 matching lines @@
     let locationText = location.spec;
     if (!match && contentType == Policy.type.ELEMHIDE)
     {
       let testWnd = wnd;
       let parentWndLocation = getWindowLocation(testWnd);
       while (true)
       {
         let testWndLocation = parentWndLocation;
         parentWndLocation = (testWnd == testWnd.parent ? testWndLocation : getWindowLocation(testWnd.parent));
         let parentDocDomain = getHostname(parentWndLocation);
-        match = defaultMatcher.matchesAny(testWndLocation, "ELEMHIDE", parentDocDomain, false, sitekey);
+        match = defaultMatcher.matchesAny(testWndLocation, Policy.typeMask[Policy.type.ELEMHIDE], parentDocDomain, false, sitekey);
         if (match instanceof WhitelistFilter)
         {
           FilterStorage.increaseHitCount(match, wnd);
           RequestNotifier.addNodeData(testWnd.document, topWnd, contentType, parentDocDomain, false, testWndLocation, match);
           return true;
         }
 
         if (testWnd.parent == testWnd)
           break;
         else
@@ skipping 13 matching lines @@
         FilterStorage.increaseHitCount(exception, wnd);
         RequestNotifier.addNodeData(node, topWnd, contentType, docDomain, false, locationText, exception);
         return true;
       }
     }
 
     let thirdParty = (contentType == Policy.type.ELEMHIDE ? false : isThirdParty(location, docDomain));
 
     if (!match && Prefs.enabled)
     {
-      match = defaultMatcher.matchesAny(locationText, Policy.typeDescr[contentType] || "", docDomain, thirdParty, sitekey);
+      match = defaultMatcher.matchesAny(locationText, Policy.typeMask[contentType] || Policy.defaultTypeMask, docDomain, thirdParty, sitekey);

[Wladimir Palant, 2015/07/10 21:07:00]

This cannot possibly return a match if type mask is 0, why even bother calling?
How about changing the condition above to |!match && Prefs.enabled &&
contentType in Policy.typeMask|?

[kzar, 2015/07/12 13:59:39]

Done.

       if (match instanceof BlockingFilter && node.ownerDocument && !(contentType in Policy.nonVisual))
       {
         let prefCollapse = (match.collapse != null ? match.collapse : !Prefs.fastcollapse);
         if (collapse || prefCollapse)
           schedulePostProcess(node);
       }
 
       // Track mouse events for objects
       if (!match && contentType == Policy.type.OBJECT && node.nodeType == Ci.nsIDOMNode.ELEMENT_NODE)
       {
@@ skipping 38 matching lines @@
       return null;
 
     if (!parentUrl)
       parentUrl = url;
 
     // Ignore fragment identifier
     let index = url.indexOf("#");
     if (index >= 0)
       url = url.substring(0, index);
 
-    let result = defaultMatcher.matchesAny(url, "DOCUMENT", getHostname(parentUrl), false, sitekey);
+    let result = defaultMatcher.matchesAny(url, Policy.typeMask[Policy.type.DOCUMENT], getHostname(parentUrl), false, sitekey);
     return (result instanceof WhitelistFilter ? result : null);
   },
 
   /**
    * Checks whether the page loaded in a window is whitelisted for indication in the UI.
    * @param wnd {nsIDOMWindow}
    * @return {Filter} matching exception rule or null if not whitelisted
    */
   isWindowWhitelisted: function(wnd)
   {
@@ skipping 480 matching lines @@
   if (!wnd || wnd.closed)
     return;
 
   if (entry.type == Policy.type.OBJECT)
   {
     node.removeEventListener("mouseover", objectMouseEventHander, true);
     node.removeEventListener("mouseout", objectMouseEventHander, true);
   }
   Policy.processNode(wnd, node, entry.type, Utils.makeURI(entry.location), true);
 }