Issue 3842 - Split up the logic updating the icon and context menu

lib/whitelisting.js

 /*
  * This file is part of Adblock Plus <https://adblockplus.org/>,
  * Copyright (C) 2006-2016 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/>.
  */
 
 /** @module whitelisting */
 
 "use strict";
 
 let {defaultMatcher} = require("matcher");
 let {RegExpFilter} = require("filterClasses");
+let {DownloadableSubscription} = require("subscriptionClasses");
 let {FilterNotifier} = require("filterNotifier");
 let {stringifyURL, getDecodedHostname, extractHostFromFrame, isThirdParty} = require("url");
 let {port} = require("messaging");
 let devtools = require("devtools");
 
 let pagesWithKey = new ext.PageMap();
 
 function match(page, url, typeMask, docDomain, sitekey)
 {
   let thirdParty = !!docDomain && isThirdParty(url, docDomain);
   let urlString = stringifyURL(url);
 
   if (!docDomain)
     docDomain = getDecodedHostname(url);
 
   let filter = defaultMatcher.whitelist.matchesAny(
     urlString, typeMask, docDomain, thirdParty, sitekey
   );
 
   if (filter && devtools)
     devtools.logWhitelistedDocument(
       page, urlString, typeMask, docDomain, filter
     );
 
   return filter;
 }
 
+let checkWhitelisted =
 /**
  * Gets the active whitelisting filter for the document associated
  * with the given page/frame, or null if it's not whitelisted.
  *
  * @param {Page}   page
  * @param {Frame}  [frame]
  * @param {number} [typeMask=RegExpFilter.typeMap.DOCUMENT]
  * @return {?WhitelistFilter}
  */
 exports.checkWhitelisted = function(page, frame, typeMask)
@@ skipping 17 matching lines @@
 
     return filter;
   }
 
   return match(page, page.url, typeMask);
 };
 
 function revalidateWhitelistingState(page)
 {
   FilterNotifier.triggerListeners(
-    "page.WhitelistingStateRevalidate", page,
-    match(page, page.url, RegExpFilter.typeMap.DOCUMENT)
+    "page.WhitelistingStateRevalidate",
+    page, checkWhitelisted(page)
   );
 }
 
-let expectsSave = false;
-FilterNotifier.addListener((action, filter) =>
+let revalidating = false;
+FilterNotifier.addListener((action, arg) =>
 {
   switch (action)
   {
-    case "subscription.added":    // On subscription changes, defer
-    case "subscription.removed":  // revalidation until the changes
-    case "subscription.disabled": // are saved to avoid revalidating the
-    case "subscription.updated":  // whitelisting state unnecessarily often.
-      expectsSave = true;
-      break;
-
-    case "save":
-      if (!expectsSave)
+    case "subscription.added":
+      if (arg instanceof DownloadableSubscription && !arg.lastDownload)
         break;
-      expectsSave = false;
-
+    case "subscription.removed":
+    case "subscription.disabled":
+    case "subscription.updated":
+    case "filter.added":
+    case "filter.removed":
+    case "filter.disabled":
     case "load":
-    case "filter.added":    // On filter changes, revalidate imediatelly
-    case "filter.removed":  // to avoid visible delays when the user
-    case "filter.disabled": // disables/enables the extension for a website.
-      ext.pages.query({}, pages =>
+      if (!revalidating)
       {
-        for (let page of pages)
-          revalidateWhitelistingState(page);
-      });
+        revalidating = true;
+        ext.pages.query({}, pages =>
+        {
+          revalidating = false;
+          for (let page of pages)
+            revalidateWhitelistingState(page);
+        });
+      }
   }
 });
 
 ext.pages.onLoading.addListener(revalidateWhitelistingState);
 
 let getKey =
 /**
  * Gets the public key, previously recorded for the given page
  * and frame, to be considered for the $sitekey filter option.
  *
@@ skipping 62 matching lines @@
   key = key.replace(/=/g, "");
 
   if (verifyKey(key, signature, frame.url))
     recordKey(page, frame.url, key);
 };
 
 port.on("filters.addKey", (message, sender) =>
 {
   processKey(message.token, sender.page, sender.frame);
 });
+
+port.on("filters.isPageWhitelisted", (message, sender) =>
+{
+  return !!checkWhitelisted(sender.page);
+});