Refactored the abstraction layer to address prerendered pages on Safari caused by leaky abstraction

background.js

 /*
  * This file is part of Adblock Plus <http://adblockplus.org/>,
- * Copyright (C) 2006-2013 Eyeo GmbH
+ * Copyright (C) 2006-2014 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;
+
+  // TODO: The import below isn't necessary anymore with
+  // https://hg.adblockplus.org/adblockplus/rev/7eb29729a72c
+  // However due to https://issues.adblockplus.org/ticket/189
+  // we can't update the subrepo yet. So please remove this
+  // line when the issue was fixed and the subrepo was updated.
+  this.ActiveFilter = ActiveFilter;
 }
 with(require("subscriptionClasses"))
 {
   this.Subscription = Subscription;
   this.DownloadableSubscription = DownloadableSubscription;
 }
 with(require("whitelisting"))
 {
   this.isWhitelisted = isWhitelisted;
   this.isFrameWhitelisted = isFrameWhitelisted;
   this.processKeyException = processKeyException;
 }
 var FilterStorage = require("filterStorage").FilterStorage;
 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 Notification = require("notification").Notification;
+var initAntiAdblockNotification = require("antiadblockInit").initAntiAdblockNotification;
 
 // Some types cannot be distinguished
 RegExpFilter.typeMap.OBJECT_SUBREQUEST = RegExpFilter.typeMap.OBJECT;
 RegExpFilter.typeMap.MEDIA = RegExpFilter.typeMap.FONT = RegExpFilter.typeMap.OTHER;
 
+// 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) > 34);
+
 var isFirstRun = false;
 var seenDataCorruption = false;
 require("filterNotifier").FilterNotifier.addListener(function(action)
 {
   if (action == "load")
   {
     var importingOldData = importOldData();
 
     var addonVersion = require("info").addonVersion;
-    var prevVersion = localStorage.currentVersion;
+    var prevVersion = ext.storage.currentVersion;
     if (prevVersion != addonVersion)
     {
       isFirstRun = !prevVersion;
-      localStorage.currentVersion = addonVersion;
+      ext.storage.currentVersion = addonVersion;
       if (!importingOldData)
         addSubscription(prevVersion);
     }
+
+    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")
+  {
+    ext.pages.query({}, function(pages)
+    {
+      pages.forEach(refreshIconAndContextMenu);
+    });
   }
 });
 
 // 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"];
 
 function removeDeprecatedOptions()
 {
   var deprecatedOptions = ["specialCaseYouTube", "experimental", "disableInlineTextAds"];
   deprecatedOptions.forEach(function(option)
   {
-    if (option in localStorage)
-      delete localStorage[option];
+    if (option in ext.storage)
+      delete ext.storage[option];
   });
 }
 
 // Remove deprecated options before we do anything else.
 removeDeprecatedOptions();
 
 var activeNotification = null;
 
 // Adds or removes browser action icon according to options.
 function refreshIconAndContextMenu(page)
 {
-  if(!/^https?:/.test(page.url))
-    return;
+  var whitelisted = isWhitelisted(page.url);
 
   var iconFilename;
-  if (require("info").platform == "safari")
+  if (whitelisted && require("info").platform != "safari")
     // There is no grayscale version of the icon for whitelisted pages
     // when using Safari, because icons are grayscale already and icons
     // aren't per page in Safari.
-    iconFilename = "icons/abp-16.png"
+    iconFilename = "icons/abp-$size-whitelisted.png";
   else
-  {
-    var excluded = isWhitelisted(page.url);
-    iconFilename = excluded ? "icons/abp-19-whitelisted.png" : "icons/abp-19.png";
-  }
+    iconFilename = "icons/abp-$size.png";
 
   page.browserAction.setIcon(iconFilename);
   iconAnimation.registerPage(page, iconFilename);
 
-  // Set context menu status according to whether the page has a whitelisted domain
-  if (excluded)
+  // show or hide the context menu entry dependent on whether
+  // adblocking is active on that page
+  if (whitelisted || !/^https?:/.test(page.url))
     ext.contextMenus.hideMenuItems();
   else
     ext.contextMenus.showMenuItems();
 }
 
 /**
  * Old versions for Opera stored patterns.ini in the localStorage object, this
  * will import it into FilterStorage properly.
  * @return {Boolean} true if data import is in progress
  */
@@ skipping 62 matching lines @@
     {
       subscription.title = "Allow non-intrusive advertising";
       FilterStorage.addSubscription(subscription);
       if (subscription instanceof DownloadableSubscription && !subscription.lastDownload)
         Synchronizer.execute(subscription);
     }
     else
       addAcceptable = false;
   }
 
+  // Add "anti-adblock messages" subscription
+  var subscription = Subscription.fromURL(Prefs.subscriptions_antiadblockurl);
+  if (subscription)
+  {
+    subscription.disabled = true;
+    FilterStorage.addSubscription(subscription);
+    if (subscription instanceof DownloadableSubscription && !subscription.lastDownload)
+      Synchronizer.execute(subscription);
+  }
+
   if (!addSubscription && !addAcceptable)
     return;
 
   function notifyUser()
   {
     ext.pages.open(ext.getURL("firstRun.html"));
   }
 
   if (addSubscription)
   {
@@ skipping 44 matching lines @@
 });
 setContextMenu();
 
 /**
   * Opens options page or focuses an existing one, within the last focused window.
   * @param {Function} callback  function to be called with the
                                 Page object of the options page
   */
 function openOptions(callback)
 {
   ext.pages.query({lastFocusedWindow: true}, function(pages)

[Wladimir Palant, 2014/04/04 14:00:35]

The compat info for Chrome needs to be changed - lastFocusedWindow parameter is
only supported since Chrome 19, currently we still allow Chrome 18.

[Sebastian Noack, 2014/04/07 13:15:25]

Done.

   {
     var optionsUrl = ext.getURL("options.html");
 
     for (var i = 0; i < pages.length; i++)
     {
       var page = pages[i];
       if (page.url == optionsUrl)
       {
         page.activate();
         if (callback)
           callback(page);
         return;
       }
     }
 
     ext.pages.open(optionsUrl, callback);

[Wladimir Palant, 2014/04/04 14:00:35]

Won't this break abp: links? The add-subscription message handler will now open
the tab and forward the message to it immediately - the tab might not be loaded
at that point and won't be able to handle the message.

[Sebastian Noack, 2014/04/07 13:15:25]

It was wishful thinking, that the callback passed to chrome.tabs.create(), isn't
called before the tab is loaded and ready to receive messages. But you are
right, this isn't the case. I have addressed that inside ext.pages.open().

   });
 }
 
 function prepareNotificationIconAndPopup()
 {
+  var animateIcon = (activeNotification.type !== "question");
   activeNotification.onClicked = function()
   {
-    iconAnimation.stop();
-    activeNotification = null;
+    if (animateIcon)
+      iconAnimation.stop();
+    notificationClosed();
   };
-
-  iconAnimation.update(activeNotification.severity);
+  if (animateIcon)
+    iconAnimation.update(activeNotification.type);
+}
+
+function openNotificationLinks() 
+{
+  if (activeNotification.links)
+  {
+    activeNotification.links.forEach(function(link)
+    {
+      ext.windows.getLastFocused(function(win)
+      {
+        win.openTab(Utils.getDocLink(link));
+      });
+    });
+  }
+}
+
+function notificationButtonClick(buttonIndex)
+{
+  if (activeNotification.type === "question")
+  {
+    Notification.triggerQuestionListeners(activeNotification.id, buttonIndex === 0);
+    Notification.markAsShown(activeNotification.id);
+    activeNotification.onClicked();
+  }
+  else if (activeNotification.links && activeNotification.links[buttonIndex])
+  {
+    ext.windows.getLastFocused(function(win)
+    {
+      win.openTab(Utils.getDocLink(activeNotification.links[buttonIndex]));
+    });
+  }
+}
+
+function notificationClosed()
+{
+  activeNotification = null;
+}
+
+function imgToBase64(url, callback)
+{
+  var canvas = document.createElement("canvas"),
+  ctx = canvas.getContext("2d"),
+  img = new Image;
+  img.src = url;
+  img.onload = function()
+  {
+    canvas.height = img.height;
+    canvas.width = img.width;
+    ctx.drawImage(img, 0, 0);
+    callback(canvas.toDataURL("image/png"));
+    canvas = null;
+  };
+}
+
+function initChromeNotifications()
+{
+  // Chrome hides notifications in notification center when clicked so we need to clear them
+  function clearActiveNotification(notificationId)
+  {
+    if (activeNotification && activeNotification.type != "question" && !("links" in activeNotification))
+      return;
+
+    chrome.notifications.clear(notificationId, function(wasCleared)
+    {
+      if (wasCleared)
+        notificationClosed();
+    });
+  }
+
+  chrome.notifications.onButtonClicked.addListener(function(notificationId, buttonIndex)
+  {
+    notificationButtonClick(buttonIndex);
+    clearActiveNotification(notificationId);
+  });
+  chrome.notifications.onClicked.addListener(clearActiveNotification);
+  chrome.notifications.onClosed.addListener(notificationClosed);
 }
 
 function showNotification(notification)
 {
+  if (activeNotification && activeNotification.id === notification.id)
+    return;
+  
   activeNotification = notification;
-
-  if (activeNotification.severity === "critical"
-      && typeof webkitNotifications !== "undefined")
-  {
-    var notification = webkitNotifications.createHTMLNotification("notification.html");
-    notification.show();
-    notification.addEventListener("close", prepareNotificationIconAndPopup);
-  }
-  else
-    prepareNotificationIconAndPopup();
+  if (activeNotification.type === "critical" || activeNotification.type === "question")
+  {
+    var hasWebkitNotifications = typeof webkitNotifications !== "undefined";
+    if (hasWebkitNotifications && "createHTMLNotification" in webkitNotifications)
+    {
+      var notification = webkitNotifications.createHTMLNotification("notification.html");
+      notification.show();
+      prepareNotificationIconAndPopup();
+      return;
+    }
+    
+    var texts = Notification.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 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
+      };
+      if (activeNotification.type === "question")
+      {
+        opts.buttons.push({title: ext.i18n.getMessage("overlay_notification_button_yes")});
+        opts.buttons.push({title: ext.i18n.getMessage("overlay_notification_button_no")});
+      }
+      else
+      {
+        var regex = /<a>(.*?)<\/a>/g;
+        var plainMessage = texts.message || "";
+        var match;
+        while (match = regex.exec(plainMessage))
+          opts.buttons.push({title: match[1]});
+      }
+      
+      imgToBase64(iconUrl, function(iconData)
+      {
+        opts["iconUrl"] = iconData;
+        chrome.notifications.create("", opts, function() {});
+      });
+    }
+    else if (hasWebkitNotifications && "createNotification" in webkitNotifications && activeNotification.type !== "question")
+    {
+      if (hasLinks)
+        message += " " + ext.i18n.getMessage("notification_without_buttons");
+
+      imgToBase64(iconUrl, function(iconData)
+      {
+        var notification = webkitNotifications.createNotification(iconData, title, message);
+        notification.show();
+        notification.addEventListener("click", openNotificationLinks, false);
+        notification.addEventListener("close", notificationClosed, false);
+      });
+    }
+    else
+    {
+      var message = title + "\n" + message;
+      if (hasLinks)
+        message += "\n\n" + ext.i18n.getMessage("notification_with_buttons");
+        
+      var approved = confirm(message);
+      if (activeNotification.type === "question")
+        notificationButtonClick(approved ? 0 : 1);
+      else if (approved)
+        openNotificationLinks();
+    }
+  }
+  prepareNotificationIconAndPopup();
 }
 
 ext.onMessage.addListener(function (msg, sender, sendResponse)
 {
   switch (msg.type)
   {
     case "get-selectors":
       var selectors = null;
 
       if (!isFrameWhitelisted(sender.page, sender.frame, "DOCUMENT") &&
@@ skipping 76 matching lines @@
         // sendResponse asynchronously
         return true;
       }
       break;
     default:
       sendResponse({});
       break;
   }
 });
 
-// Show icon as browser action for all pages that already exist
-ext.pages.query({}, function(pages)
-{
-  pages.forEach(refreshIconAndContextMenu);
-});
-
-// Update icon for new loaded pages
+// update icon when page changes location
 ext.pages.onLoading.addListener(function(page)
 {
   page.sendMessage({type: "clickhide-deactivate"});
   refreshIconAndContextMenu(page);
 });
 
 setTimeout(function()
 {
   var notificationToShow = Notification.getNextToShow();
   if (notificationToShow)
     showNotification(notificationToShow);
 }, 3 * 60 * 1000);