Issue 6665 - Split out element hiding exceptions into their own module

lib/filterListener.js

 /*
  * This file is part of Adblock Plus <https://adblockplus.org/>,
  * Copyright (C) 2006-present 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 12 matching lines @@
  */
 
 const {Services} = Cu.import("resource://gre/modules/Services.jsm", {});
 const {XPCOMUtils} = Cu.import("resource://gre/modules/XPCOMUtils.jsm", {});
 
 const {FilterStorage} = require("./filterStorage");
 const {FilterNotifier} = require("./filterNotifier");
 const {ElemHide} = require("./elemHide");
 const {ElemHideEmulation} = require("./elemHideEmulation");
 const {ElemHideExceptions} = require("./elemHideExceptions");
+const {Snippets} = require("./snippets");
 const {defaultMatcher} = require("./matcher");
 const {ActiveFilter, RegExpFilter,
-       ElemHideBase, ElemHideEmulationFilter,
-       ElemHideException} = require("./filterClasses");
+       ElemHideBase, ElemHideFilter, ElemHideEmulationFilter,
+       SnippetFilter} = require("./filterClasses");
+const {SpecialSubscription} = require("./subscriptionClasses");
 const {Prefs} = require("prefs");
 
 /**
  * Increases on filter changes, filters will be saved if it exceeds 1.
  * @type {number}
  */
 let isDirty = 0;
 
 /**
  * This object can be used to change properties of the filter change listeners.
@@ skipping 86 matching lines @@
  * Notifies Matcher instances or ElemHide object about a new filter
  * if necessary.
  * @param {Filter} filter filter that has been added
  */
 function addFilter(filter)
 {
   if (!(filter instanceof ActiveFilter) || filter.disabled)
     return;
 
   let hasEnabled = false;
+  let allowSnippets = false;
   for (let i = 0; i < filter.subscriptions.length; i++)
   {
-    if (!filter.subscriptions[i].disabled)
+    let subscription = filter.subscriptions[i];
+
+    if (!subscription.disabled)
+    {
       hasEnabled = true;
+
+      // Allow snippets to be executed only by the circumvention lists or the
+      // user's own filters.
+      if (subscription.type == "circumvention" ||
+          subscription instanceof SpecialSubscription)
+      {
+        allowSnippets = true;
+        break;
+      }
+    }
   }
   if (!hasEnabled)
     return;
 
   if (filter instanceof RegExpFilter)
     defaultMatcher.add(filter);
   else if (filter instanceof ElemHideBase)
   {
-    if (filter instanceof ElemHideException)
-      ElemHideExceptions.add(filter);
-    if (filter instanceof ElemHideEmulationFilter)
+    if (filter instanceof ElemHideFilter)
+      ElemHide.add(filter);
+    else if (filter instanceof ElemHideEmulationFilter)
       ElemHideEmulation.add(filter);
     else
-      ElemHide.add(filter);
-  }
+      ElemHideExceptions.add(filter);
+  }
+  else if (allowSnippets && filter instanceof SnippetFilter)
+    Snippets.add(filter);
 }
 
 /**
  * Notifies Matcher instances or ElemHide object about removal of a filter
  * if necessary.
  * @param {Filter} filter filter that has been removed
  */
 function removeFilter(filter)
 {
   if (!(filter instanceof ActiveFilter))
     return;
 
   if (!filter.disabled)
   {
     let hasEnabled = false;
     for (let i = 0; i < filter.subscriptions.length; i++)
     {
       if (!filter.subscriptions[i].disabled)
+      {
         hasEnabled = true;
+        break;
+      }
     }
     if (hasEnabled)
       return;
   }
 
   if (filter instanceof RegExpFilter)
     defaultMatcher.remove(filter);
   else if (filter instanceof ElemHideBase)
   {
-    if (filter instanceof ElemHideException)
-      ElemHideExceptions.remove(filter);
-    if (filter instanceof ElemHideEmulationFilter)
+    if (filter instanceof ElemHideFilter)
+      ElemHide.remove(filter);
+    else if (filter instanceof ElemHideEmulationFilter)
       ElemHideEmulation.remove(filter);
     else
-      ElemHide.remove(filter);
-  }
+      ElemHideExceptions.remove(filter);
+  }
+  else if (filter instanceof SnippetFilter)
+    Snippets.remove(filter);
 }
 
 const primes = [101, 109, 131, 149, 163, 179, 193, 211, 229, 241];
 
 function addFilters(filters)
 {
   // We add filters using pseudo-random ordering. Reason is that ElemHide will
   // assign consecutive filter IDs that might be visible to the website. The
   // randomization makes sure that no conclusion can be made about the actual
   // filters applying there. We have ten prime numbers to use as iteration step,
@@ skipping 27 matching lines @@
   FilterListener.setDirty(1);
 
   if (!subscription.disabled)
     subscription.filters.forEach(removeFilter);
 }
 
 function onSubscriptionDisabled(subscription, newValue)
 {
   FilterListener.setDirty(1);
 
-  if (subscription.url in FilterStorage.knownSubscriptions)
+  if (FilterStorage.knownSubscriptions.has(subscription.url))
   {
     if (newValue == false)
       addFilters(subscription.filters);
     else
       subscription.filters.forEach(removeFilter);
   }
 }
 
 function onSubscriptionUpdated(subscription)
 {
   FilterListener.setDirty(1);
 
-  if (subscription.url in FilterStorage.knownSubscriptions &&
-      !subscription.disabled)
+  if (!subscription.disabled &&
+      FilterStorage.knownSubscriptions.has(subscription.url))
   {
     subscription.oldFilters.forEach(removeFilter);
     addFilters(subscription.filters);
   }
 }
 
 function onFilterHitCount(filter, newValue)
 {
   if (newValue == 0)
     FilterListener.setDirty(0);
@@ skipping 38 matching lines @@
 }
 
 function onLoad()
 {
   isDirty = 0;
 
   defaultMatcher.clear();
   ElemHide.clear();
   ElemHideEmulation.clear();
   ElemHideExceptions.clear();
+  Snippets.clear();
   for (let subscription of FilterStorage.subscriptions)
   {
     if (!subscription.disabled)
       addFilters(subscription.filters);
   }
 }
 
 function onSave()
 {
   isDirty = 0;
 }