Issue 3024 - Added opt-out to Chrome notifications

lib/notificationHelper.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
@@ skipping 40 matching lines @@
 {
   let animateIcon = shouldDisplay("icon", activeNotification.type);
   activeNotification.onClicked = function()
   {
     if (animateIcon)
       stopIconAnimation();
     notificationClosed();
   };
   if (animateIcon)
     startIconAnimation(activeNotification.type);
+}
+
+function getNotificationButtons(notificationType, message)
+{
+  let buttons = [];
+  if (notificationType == "question")
+  {
+    buttons.push({
+      type: "question",
+      title: ext.i18n.getMessage("overlay_notification_button_yes")
+    });
+    buttons.push({
+      type: "question",
+      title: ext.i18n.getMessage("overlay_notification_button_no")
+    });
+  }
+  else
+  {
+    let regex = /<a>(.*?)<\/a>/g;
+    let match;
+    while (match = regex.exec(message))
+    {
+      buttons.push({
+        type: "link",
+        title: match[1]
+      });
+    }
+
+    // Chrome only allows two notification buttons so we need to fall back
+    // to a single button to open all links if there are more than two.
+    let maxButtons = (notificationType == "critical") ? 2 : 1;
+    if (buttons.length > maxButtons)
+    {
+      buttons = [
+        {
+          type: "open-all",
+          title: ext.i18n.getMessage("notification_open_all")
+        }
+      ];
+    }
+    if (notificationType != "critical")
+    {
+      buttons.push({
+        type: "configure",
+        title: ext.i18n.getMessage("notification_configure")
+      });
+    }
+  }
+
+  return buttons;
 }
 
 function openNotificationLinks()
 {
   if (activeNotification.links)
   {
     for (let link of activeNotification.links)

[Sebastian Noack, 2015/09/11 14:51:00]

This one is unrelated.

       ext.pages.open(Utils.getDocLink(link));
   }
 }
 
 function notificationButtonClick(buttonIndex)
 {
   switch (activeButtons[buttonIndex].type)
   {
     case "link":
       ext.pages.open(Utils.getDocLink(activeNotification.links[buttonIndex]));
@@ skipping 69 matching lines @@
   if (activeNotification && activeNotification.id == notification.id)
     return;
 
   activeNotification = notification;
   if (shouldDisplay("notification", activeNotification.type))
   {
     let texts = NotificationStorage.getLocalizedTexts(notification);
     let title = texts.title || "";
     let message = texts.message ? texts.message.replace(/<\/?(a|strong)>/g, "") : "";
     let iconUrl = ext.getURL("icons/detailed/abp-128.png");
-    let hasLinks = activeNotification.links && activeNotification.links.length > 0;

[Sebastian Noack, 2015/09/11 13:09:55]

I actually preferred the way you did it before using <|| []>. This isn't a
hotspot where you have to care about creating unnecessary objects.

[Thomas Greiner, 2015/09/11 14:03:44]

Done. Note that I merely reverted the changes from my previous patch here so
this is what's currently in the extension.

+    let linkCount = (activeNotification.links || []).length;
 
     if (canUseChromeNotifications)
     {
-      activeButtons = [];

[Sebastian Noack, 2015/09/11 13:09:55]

This function is becoming quite long. How about moving the logic to a separate
function getNotificationButtons()? I don't have a strong opinion here though.

[Thomas Greiner, 2015/09/11 14:03:44]

Done. I agree, should make it easier to comprehend.

+      activeButtons = getNotificationButtons(activeNotification.type, texts.message);
       let opts = {
         type: "basic",
         title: title,
         message: message,
-        buttons: [],
+        buttons: activeButtons.map(button => ({title: button.title})),
         priority: 2 // We use the highest priority to prevent the notification from closing automatically
       };
-      if (activeNotification.type == "question")
-      {
-        activeButtons.push({
-          type: "question",
-          title: ext.i18n.getMessage("overlay_notification_button_yes")
-        });
-        activeButtons.push({
-          type: "question",
-          title: ext.i18n.getMessage("overlay_notification_button_no")
-        });
-      }
-      else
-      {
-        let regex = /<a>(.*?)<\/a>/g;
-        let match;
-        while (match = regex.exec(texts.message))
-        {
-          activeButtons.push({
-            type: "link",
-            title: match[1]
-          });
-        }
-
-        // Chrome only allows two notification buttons so we need to fall back
-        // to a single button to open all links if there are more than two.
-        let maxButtons = (activeNotification.type == "critical") ? 2 : 1;
-        if (activeButtons.length > maxButtons)
-        {
-          activeButtons = [
-            {
-              type: "open-all",
-              title: ext.i18n.getMessage("notification_open_all")
-            }
-          ];
-        }
-        if (activeNotification.type != "critical")
-        {
-          activeButtons.push({
-            type: "configure",
-            title: ext.i18n.getMessage("notification_configure")
-          });
-        }
-      }
 
       imgToBase64(iconUrl, function(iconData)
       {
-        opts.buttons = activeButtons.map(function(button)

[Sebastian Noack, 2015/09/11 13:09:55]

Why not a for-of loop?

[Thomas Greiner, 2015/09/11 14:03:44]

No particular reason.

The way I use it now in the new patch, however, helps us avoid the creation of a
temporary variable.

[Sebastian Noack, 2015/09/11 14:15:39]

I see. However, much better with an arrow function now.

-        {
-          return {title: button.title};
-        });
         opts.iconUrl = iconData;
         chrome.notifications.create("", opts, function() {});
       });
     }
     else if ("Notification" in window && activeNotification.type != "question")
     {
-      if (hasLinks)
+      if (linkCount > 0)
         message += " " + ext.i18n.getMessage("notification_without_buttons");
 
       imgToBase64(iconUrl, function(iconData)
       {
         let notification = new Notification(
           title,
           {
             lang: Utils.appLocale,
             dir: ext.i18n.getMessage("@@bidi_dir"),
             body: message,
             icon: iconData
           }
         );
 
         notification.addEventListener("click", openNotificationLinks);
         notification.addEventListener("close", notificationClosed);
       });
     }
     else
     {
       let message = title + "\n" + message;
-      if (hasLinks)
+      if (linkCount > 0)
         message += "\n\n" + ext.i18n.getMessage("notification_with_buttons");
 
       let approved = confirm(message);
       if (activeNotification.type == "question")
         notificationButtonClick(approved ? 0 : 1);
       else if (approved)
         openNotificationLinks();
     }
   }
   prepareNotificationIconAndPopup();
@@ skipping 22 matching lines @@
 /**
  * Gets the active notification to be shown if any.
  *
  * @return {?object}
  */
 exports.getActiveNotification = function()
 {
   return activeNotification;
 };
 
+let shouldDisplay =

[Sebastian Noack, 2015/09/11 14:51:00]

This one is unrelated.

 /**
  * Determines whether a given display method should be used for a
  * specified notification type.
  * 
  * @param {string} method Display method: icon, notification or popup
  * @param {string} notificationType
  * @return {boolean}
  */
-exports.shouldDisplay = shouldDisplay;
-function shouldDisplay(method, notificationType)
+exports.shouldDisplay = function(method, notificationType)
 {
   let methods = displayMethods[notificationType] || defaultDisplayMethods;
   return methods.indexOf(method) > -1;
 }
 
 NotificationStorage.addShowListener(showNotification);