Issue 6908 - Pass updated subscription's old filters as an event argument

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
  * 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/>.
  */
 
 "use strict";
 
 /**
  * @fileOverview Component synchronizing filter storage with Matcher
  *               instances and ElemHide.
  */
 
 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 {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,
+       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;
 
@@ skipping 43 matching lines @@
   QueryInterface: XPCOMUtils.generateQI(
     [Ci.nsISupportsWeakReference, Ci.nsIObserver]
   )
 };
 
 /**
  * Initializes filter listener on startup, registers the necessary hooks.
  */
 function init()
 {
-  FilterNotifier.on("filter.hitCount", onFilterHitCount);
-  FilterNotifier.on("filter.lastHit", onFilterLastHit);
-  FilterNotifier.on("filter.added", onFilterAdded);
-  FilterNotifier.on("filter.removed", onFilterRemoved);
-  FilterNotifier.on("filter.disabled", onFilterDisabled);
-  FilterNotifier.on("filter.moved", onGenericChange);
-
-  FilterNotifier.on("subscription.added", onSubscriptionAdded);
-  FilterNotifier.on("subscription.removed", onSubscriptionRemoved);
-  FilterNotifier.on("subscription.disabled", onSubscriptionDisabled);
-  FilterNotifier.on("subscription.updated", onSubscriptionUpdated);
-  FilterNotifier.on("subscription.moved", onGenericChange);
-  FilterNotifier.on("subscription.title", onGenericChange);
-  FilterNotifier.on("subscription.fixedTitle", onGenericChange);
-  FilterNotifier.on("subscription.homepage", onGenericChange);
-  FilterNotifier.on("subscription.downloadStatus", onGenericChange);
-  FilterNotifier.on("subscription.lastCheck", onGenericChange);
-  FilterNotifier.on("subscription.errors", onGenericChange);
-
-  FilterNotifier.on("load", onLoad);
-  FilterNotifier.on("save", onSave);
+  filterNotifier.on("filter.hitCount", onFilterHitCount);
+  filterNotifier.on("filter.lastHit", onFilterLastHit);
+  filterNotifier.on("filter.added", onFilterAdded);
+  filterNotifier.on("filter.removed", onFilterRemoved);
+  filterNotifier.on("filter.disabled", onFilterDisabled);
+  filterNotifier.on("filter.moved", onGenericChange);
+
+  filterNotifier.on("subscription.added", onSubscriptionAdded);
+  filterNotifier.on("subscription.removed", onSubscriptionRemoved);
+  filterNotifier.on("subscription.disabled", onSubscriptionDisabled);
+  filterNotifier.on("subscription.updated", onSubscriptionUpdated);
+  filterNotifier.on("subscription.moved", onGenericChange);
+  filterNotifier.on("subscription.title", onGenericChange);
+  filterNotifier.on("subscription.fixedTitle", onGenericChange);
+  filterNotifier.on("subscription.homepage", onGenericChange);
+  filterNotifier.on("subscription.downloadStatus", onGenericChange);
+  filterNotifier.on("subscription.lastCheck", onGenericChange);
+  filterNotifier.on("subscription.errors", onGenericChange);
+
+  filterNotifier.on("load", onLoad);
+  filterNotifier.on("save", onSave);
 
   FilterStorage.loadFromDisk();
 
   Services.obs.addObserver(HistoryPurgeObserver,
                            "browser:purge-session-history", true);
   onShutdown.add(() =>
   {
     Services.obs.removeObserver(HistoryPurgeObserver,
                                 "browser:purge-session-history");
   });
 }
 init();
 
 /**
  * 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++)
-  {
-    let subscription = filter.subscriptions[i];
-
+  for (let subscription of filter.subscriptions)
+  {
     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 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++)
+    for (let subscription of filter.subscriptions)
     {
-      if (!filter.subscriptions[i].disabled)
+      if (!subscription.disabled)
       {
         hasEnabled = true;
         break;
       }
     }
     if (hasEnabled)
       return;
   }
 
   if (filter instanceof RegExpFilter)
     defaultMatcher.remove(filter);
   else if (filter instanceof ElemHideBase)
   {
-    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
@@ skipping 102 matching lines @@
   FilterListener.setDirty(1);
 }
 
 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;
 }