Issue 2040 - Replaced localStorage with chrome.storage.local

background.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/>.
  */
 
 with(require("filterClasses"))
 {
   this.Filter = Filter;
-  this.RegExpFilter = RegExpFilter;
   this.BlockingFilter = BlockingFilter;
   this.WhitelistFilter = WhitelistFilter;
 }
 with(require("subscriptionClasses"))
 {
   this.Subscription = Subscription;
   this.DownloadableSubscription = DownloadableSubscription;
   this.SpecialSubscription = SpecialSubscription;
 }
 with(require("whitelisting"))
 {
   this.isPageWhitelisted = isPageWhitelisted;
   this.isFrameWhitelisted = isFrameWhitelisted;
   this.processKey = processKey;
   this.getKey = getKey;
 }
 with(require("url"))
 {
   this.stringifyURL = stringifyURL;
   this.isThirdParty = isThirdParty;
   this.extractHostFromFrame = extractHostFromFrame;
 }
 with(require("icon"))
 {
   this.updateIcon = updateIcon;
   this.startIconAnimation = startIconAnimation;
   this.stopIconAnimation = stopIconAnimation;
 }
 var FilterStorage = require("filterStorage").FilterStorage;
+var FilterNotifier = require("filterNotifier").FilterNotifier;
 var ElemHide = require("elemHide").ElemHide;
 var defaultMatcher = require("matcher").defaultMatcher;
 var Prefs = require("prefs").Prefs;
 var Synchronizer = require("synchronizer").Synchronizer;
 var Utils = require("utils").Utils;
 var NotificationStorage = require("notification").Notification;
 var initAntiAdblockNotification = require("antiadblockInit").initAntiAdblockNotification;
 var parseFilters = require("filterValidation").parseFilters;
-
-// Some types cannot be distinguished
-RegExpFilter.typeMap.OBJECT_SUBREQUEST = RegExpFilter.typeMap.OBJECT;
-RegExpFilter.typeMap.MEDIA = RegExpFilter.typeMap.FONT = RegExpFilter.typeMap.OTHER;
+var composeFilters = require("filterComposer").composeFilters;
 
 // Chrome on Linux does not fully support chrome.notifications until version 35
 // https://code.google.com/p/chromium/issues/detail?id=291485
-var canUseChromeNotifications = require("info").platform == "chromium"
-  && "notifications" in chrome
-  && (navigator.platform.indexOf("Linux") == -1 || parseInt(require("info").applicationVersion, 10) > 34);
+var canUseChromeNotifications = (function()
+{
+  var info = require("info");
+  if (info.platform == "chromium" && "notifications" in chrome)
+  {
+    if (navigator.platform.indexOf("Linux") == -1)
+      return true;
+    if (Services.vc.compare(info.applicationVersion, "35") >= 0)
+      return true;
+  }
+  return false;
+})();
 
 var seenDataCorruption = false;
 var filterlistsReinitialized = false;
-require("filterNotifier").FilterNotifier.addListener(function(action)
-{
-  if (action == "load")
-  {
-    ext.storage.get(["currentVersion"], function(items)
-    {
-      var addonVersion = require("info").addonVersion;
-      var prevVersion = items.currentVersion;
-
-      // There are no filters stored so we need to reinitialize all filterlists
-      if (!FilterStorage.firstRun && FilterStorage.subscriptions.length === 0)
-      {
-        filterlistsReinitialized = true;
-        prevVersion = null;
-      }
-
-      if (prevVersion != addonVersion || FilterStorage.firstRun)
-      {
-        seenDataCorruption = prevVersion && FilterStorage.firstRun;
-        ext.storage.set("currentVersion", addonVersion);
-        addSubscription(prevVersion);
-      }
-
-      // The "Hide placeholders" option has been removed from the UI in 1.8.8.1285
-      // So we reset the option for users updating from older versions.
-      if (prevVersion && Services.vc.compare(prevVersion, "1.8.8.1285") < 0)
-        Prefs.hidePlaceholders = true;
-    });
+
+function init()
+{
+  var filtersLoaded = false;
+  var prefsLoaded = false;
+
+  var checkLoaded = function()
+  {
+    if (!filtersLoaded || !prefsLoaded)
+      return;
+
+    var info = require("info");
+    var previousVersion = Prefs.currentVersion;
+
+    // There are no filters stored so we need to reinitialize all filterlists
+    if (!FilterStorage.firstRun && FilterStorage.subscriptions.length === 0)
+    {
+      filterlistsReinitialized = true;
+      previousVersion = null;
+    }
+
+    if (previousVersion != info.addonVersion || FilterStorage.firstRun)
+    {
+      seenDataCorruption = previousVersion && FilterStorage.firstRun;
+      Prefs.currentVersion = info.addonVersion;
+      addSubscription(previousVersion);
+    }
+
+    // The "Hide placeholders" option has been removed from the UI in 1.8.8.1285
+    // So we reset the option for users updating from older versions.
+    if (previousVersion && Services.vc.compare(previousVersion, "1.8.8.1285") < 0)
+      Prefs.hidePlaceholders = true;
 
     if (canUseChromeNotifications)
       initChromeNotifications();
     initAntiAdblockNotification();
-  }
-
-  // update browser actions when whitelisting might have changed,
-  // due to loading filters or saving filter changes
-  if (action == "load" || action == "save")
+
+    // Update browser actions and context menus when whitelisting might have
+    // changed. That is now when initally loading the filters and later when
+    // importing backups or saving filter changes.
+    FilterNotifier.addListener(function(action)
+    {
+      if (action == "load" || action == "save")
+        refreshIconAndContextMenuForAllPages();
+    });
     refreshIconAndContextMenuForAllPages();
-});
+  };
+
+  var onFilterAction = function(action)
+  {
+    if (action == "load")
+    {
+      FilterNotifier.removeListener(onFilterAction);
+      filtersLoaded = true;
+      checkLoaded();
+    }
+  };
+
+  var onPrefsLoaded = function()
+  {
+    Prefs.onLoaded.removeListener(onPrefsLoaded);
+    prefsLoaded = true;
+    checkLoaded();
+  };
+
+  FilterNotifier.addListener(onFilterAction);
+  Prefs.onLoaded.addListener(onPrefsLoaded);
+}
+init();
 
 // Special-case domains for which we cannot use style-based hiding rules.
 // See http://crbug.com/68705.
 var noStyleRulesHosts = ["mail.google.com", "mail.yahoo.com", "www.google.com"];
 
 var htmlPages = new ext.PageMap();
 var activeNotification = null;
 
 var contextMenuItem = {
   title: ext.i18n.getMessage("block_element"),
@@ skipping 119 matching lines @@
 
           notifyUser();
       }
     }, false);
     request.send(null);
   }
   else
     notifyUser();
 }
 
-Prefs.addListener(function(name)
+Prefs.onChanged.addListener(function(name)
 {
   if (name == "shouldShowBlockElementMenu")
     refreshIconAndContextMenuForAllPages();
 });
 
 function prepareNotificationIconAndPopup()
 {
   var animateIcon = (activeNotification.type !== "question");
   activeNotification.onClicked = function()
   {
@@ skipping 85 matching lines @@
 {
   if (activeNotification && activeNotification.id === notification.id)
     return;
 
   activeNotification = notification;
   if (activeNotification.type === "critical" || activeNotification.type === "question")
   {
     var texts = NotificationStorage.getLocalizedTexts(notification);
     var title = texts.title || "";
     var message = texts.message ? texts.message.replace(/<\/?(a|strong)>/g, "") : "";
-    var iconUrl = ext.getURL("icons/abp-128.png");
+    var iconUrl = ext.getURL("icons/detailed/abp-128.png");
     var hasLinks = activeNotification.links && activeNotification.links.length > 0;
 
     if (canUseChromeNotifications)
     {
       var opts = {
         type: "basic",
         title: title,
         message: message,
         buttons: [],
         priority: 2 // We use the highest priority to prevent the notification from closing automatically
@@ skipping 171 matching lines @@
         page.sendMessage(msg);
       });
       break;
     case "add-sitekey":
       processKey(msg.token, sender.page, sender.frame);
       break;
     case "report-html-page":
       htmlPages.set(sender.page, null);
       refreshIconAndContextMenu(sender.page);
       break;
+    case "compose-filters":
+      sendResponse(composeFilters({
+        tagName: msg.tagName,
+        id: msg.id,
+        src: msg.src,
+        style: msg.style,
+        classes: msg.classes,
+        urls: msg.urls,
+        type: msg.mediatype,
+        baseURL: msg.baseURL,
+        page: sender.page,
+        frame: sender.frame
+      }));
+      break;
     case "forward":
       if (sender.page)
       {
         if (msg.expectsResponse)
         {
           sender.page.sendMessage(msg.payload, sendResponse);
           return true;
         }
 
         sender.page.sendMessage(msg.payload);
       }
       break;
   }
 });
 
 // update icon when page changes location
 ext.pages.onLoading.addListener(function(page)
 {
   page.sendMessage({type: "clickhide-deactivate"});
   refreshIconAndContextMenu(page);
 });
 
 setTimeout(function()
 {
   var notificationToShow = NotificationStorage.getNextToShow();
   if (notificationToShow)
     showNotification(notificationToShow);
 }, 3 * 60 * 1000);