Ported over anti-adblock message notification

background.js

 /*
  * This file is part of Adblock Plus <http://adblockplus.org/>,
  * Copyright (C) 2006-2013 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.ActiveFilter = ActiveFilter;
   this.RegExpFilter = RegExpFilter;
   this.BlockingFilter = BlockingFilter;
   this.WhitelistFilter = WhitelistFilter;
 }
 with(require("subscriptionClasses"))
 {
   this.Subscription = Subscription;
   this.DownloadableSubscription = DownloadableSubscription;
 }
 with(require("whitelisting"))
@@ skipping 24 matching lines @@
 
     var addonVersion = require("info").addonVersion;
     var prevVersion = localStorage.currentVersion;
     if (prevVersion != addonVersion)
     {
       isFirstRun = !prevVersion;
       localStorage.currentVersion = addonVersion;
       if (!importingOldData)
         addSubscription(prevVersion);
     }
+
+    initAntiAdblockNotification();
   }
 
   // update browser actions when whitelisting might have changed,
   // due to loading filters or saving filter changes
   if (action == "load" || action == "save")
   {
     ext.windows.getAll(function(windows)
     {
       for (var i = 0; i < windows.length; i++)
       {
@@ skipping 119 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.windows.getLastFocused(function(win)
     {
       win.openTab(ext.getURL("firstRun.html"));
     });
   }
@@ skipping 18 matching lines @@
 
           notifyUser();
       }
     }, false);
     request.send(null);
   }
   else
     notifyUser();
 }
 
+function initAntiAdblockNotification()

[Felix Dahlke, 2014/03/18 14:21:41]

This is pretty much the same code we have in Firefox, I think we should reuse
it.

[Thomas Greiner, 2014/03/19 13:45:40]

Done.

+{
+  var notification = {
+    id: "antiadblock",
+    type: "question",
+    title: ext.i18n.getMessage("global_notification_antiadblock_title"),
+    message: ext.i18n.getMessage("global_notification_antiadblock_message"),
+    urlFilters: []
+  };
+
+  function notificationListener(approved)
+  {
+    var subscription = Subscription.fromURL(Prefs.subscriptions_antiadblockurl);
+    if (subscription.url in FilterStorage.knownSubscriptions)
+      subscription.disabled = !approved;
+  }
+
+  function addAntiAdblockNotification(subscription)
+  {
+    var urlFilters = [];
+    subscription.filters.forEach(function(filter)
+    {
+      if (filter instanceof ActiveFilter)
+        for (var domain in filter.domains)
+          if (domain && urlFilters.indexOf(domain) == -1)
+            urlFilters.push(domain);
+    });
+    notification.urlFilters = urlFilters;
+    Notification.addNotification(notification);
+    Notification.addQuestionListener(notification.id, notificationListener);
+  }
+
+  function removeAntiAdblockNotification()
+  {
+    Notification.removeNotification(notification);
+    Notification.removeQuestionListener(notification.id, notificationListener);
+  }
+
+  var subscription = Subscription.fromURL(Prefs.subscriptions_antiadblockurl);
+  if (subscription.lastDownload && subscription.disabled)
+    addAntiAdblockNotification(subscription);
+
+  FilterNotifier.addListener(function(action, value, newItem, oldItem)
+  {
+    if (!/^subscription\.(updated|removed|disabled)$/.test(action) || value.url != Prefs.subscriptions_antiadblockurl)
+      return;
+
+    if (action == "subscription.updated")
+      addAntiAdblockNotification(value);
+    else if (action == "subscription.removed" || (action == "subscription.disabled" && !value.disabled))
+      removeAntiAdblockNotification();
+  });
+}
+
 function setContextMenu()
 {
   if (Prefs.shouldShowBlockElementMenu)
   {
     // Register context menu item
     ext.contextMenus.addMenuItem(ext.i18n.getMessage("block_element"), ["image", "video", "audio"], function(srcUrl, tab)
     {
       if (srcUrl)
         tab.sendMessage({type: "clickhide-new-filter", filter: srcUrl});
     });
@@ skipping 41 matching lines @@
   });
 }
 
 function prepareNotificationIconAndPopup()
 {
   activeNotification.onClicked = function()
   {
     iconAnimation.stop();
     activeNotification = null;
   };
-  iconAnimation.update(activeNotification.severity);
+  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(id, index)
 {
-  if (activeNotification.links && activeNotification.links[index])
+  if (activeNotification.type === "question")
+  {
+    Notification.triggerQuestionListeners(activeNotification.id, index === 0);
+    Notification.markAsShown(activeNotification.id);
+    activeNotification.onClicked();
+  }
+  else if (activeNotification.links && activeNotification.links[index])
   {
     ext.windows.getLastFocused(function(win)
     {
       win.openTab(Utils.getDocLink(activeNotification.links[index]));
     });
   }
 }
 
 function showNotification(notification)
 {
+  if (activeNotification && activeNotification.id === notification.id)
+    return;
+  
   activeNotification = notification;
-  if (activeNotification.severity === "critical")
+  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();
-      notification.addEventListener("close", prepareNotificationIconAndPopup, false);
+      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 ("browserNotifications" in ext) 
+    
+    // Chrome on Linux does not fully support chrome.notifications yet
+    // https://code.google.com/p/chromium/issues/detail?id=291485
+    if (chrome && "notifications" in chrome && navigator.platform.indexOf("Linux") === -1)
     {
       var opts = {
         type: "basic",
         title: title,
         message: message,
         iconUrl: iconUrl,
-        buttons: []
+        buttons: [],
+        priority: 2 // We use the highest priority to prevent the notification from closing automatically
       };
-      var regex = /<a>(.*?)<\/a>/g;
-      var plainMessage = texts.message || "";
-      var match;
-      while (match = regex.exec(plainMessage))
-        opts.buttons.push({title: match[1]});
+      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]});
+      }
       
-      var notification = ext.browserNotifications;
-      notification.create("", opts, function() {});
-      notification.onClosed.addListener(prepareNotificationIconAndPopup);
-      notification.onButtonClicked.addListener(notificationButtonClick);
+      chrome.notifications.create("", opts, function() {});
+      chrome.notifications.onButtonClicked.addListener(notificationButtonClick);
     }
-    else if (hasWebkitNotifications && "createNotification" in webkitNotifications)
+    else if (hasWebkitNotifications && "createNotification" in webkitNotifications && activeNotification.type !== "question")
     {
       if (hasLinks)
         message += " " + ext.i18n.getMessage("notification_without_buttons");
         
       var notification = webkitNotifications.createNotification(iconUrl, title, message);
       notification.show();
-      notification.addEventListener("close", prepareNotificationIconAndPopup, false);
       notification.addEventListener("click", openNotificationLinks, false);
     }
     else
     {
       var message = title + "\n" + message;
       if (hasLinks)
         message += "\n\n" + ext.i18n.getMessage("notification_with_buttons");
         
-      if (confirm(message))
+      var approved = confirm(message);
+      if (activeNotification.type === "question")
+        notificationButtonClick(null, approved ? 0 : 1);
+      else if (approved)
         openNotificationLinks();
-      prepareNotificationIconAndPopup();
     }
   }
-  else
-    prepareNotificationIconAndPopup();
+  prepareNotificationIconAndPopup();
 }
 
 ext.onMessage.addListener(function (msg, sender, sendResponse)
 {
   switch (msg.type)
   {
     case "get-selectors":
       var selectors = null;
 
       if (!isFrameWhitelisted(sender.tab, sender.frame, "DOCUMENT") &&
@@ skipping 89 matching lines @@
   tab.sendMessage({type: "clickhide-deactivate"});
   refreshIconAndContextMenu(tab);
 });
 
 setTimeout(function()
 {
   var notificationToShow = Notification.getNextToShow();
   if (notificationToShow)
     showNotification(notificationToShow);
 }, 3 * 60 * 1000);