[adblockpluschrome] Issue 4764 - Added "relentless" notification that shows up in intervals

lib/notificationHelper.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 notificationHelper */
 
-let {startIconAnimation, stopIconAnimation} = require("icon");
-let {Utils} = require("utils");
-let {Notification: NotificationStorage} = require("notification");
-let {stringifyURL} = require("url");
-let {initAntiAdblockNotification} = require("antiadblockInit");
+"use strict";
+
+const {startIconAnimation, stopIconAnimation} = require("icon");
+const {Utils} = require("utils");
+const {Notification: NotificationStorage} = require("notification");
+const {stringifyURL} = require("url");
+const {initAntiAdblockNotification} = require("antiadblockInit");
+const {Prefs} = require("prefs");
 
 let activeNotification = null;
 let activeButtons = null;
 let defaultDisplayMethods = ["popup"];
 let displayMethods = Object.create(null);
 displayMethods.critical = ["icon", "notification", "popup"];
 displayMethods.question = ["notification"];
 displayMethods.normal = ["notification"];
 displayMethods.relentless = ["notification"];
 displayMethods.information = ["icon", "popup"];
 
-// Chrome on Linux does not fully support chrome.notifications until version 35
-// https://code.google.com/p/chromium/issues/detail?id=291485
-let canUseChromeNotifications = (function()
-{
-  let 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;
-})();
-
 function prepareNotificationIconAndPopup()
 {
   let animateIcon = shouldDisplay("icon", activeNotification.type);
-  activeNotification.onClicked = function()
+  activeNotification.onClicked = () =>
   {
     if (animateIcon)
       stopIconAnimation();
     notificationClosed();
   };
   if (animateIcon)
     startIconAnimation(activeNotification.type);
 }
 
 function getNotificationButtons(notificationType, message)
@@ skipping 27 matching lines @@
     let maxButtons = (notificationType == "critical") ? 2 : 1;
     if (buttons.length > maxButtons)
     {
       buttons = [
         {
           type: "open-all",
           title: ext.i18n.getMessage("notification_open_all")
         }
       ];
     }
     if (["critical", "relentless"].indexOf(notificationType) == -1)

[Sebastian Noack, 2017/01/05 12:46:11]

Using indexOf() for membership checks seems unnecessary here. The following
seems much easier to read to me (and is also faster if it would matter):

 if (notificationType != "critical" && notificationType != "relentless")
   ...

Also note that arrays also have an includes() method which would still be better
than using indexOf(). Or you could use a Set and it's has() method, which would
be most appropriate if you have a container that you only use for membership
checks. Though for simplicity, I'd prefer to use simple comparision logic here,
as indicated above.

[wspee, 2017/01/05 15:19:27]

Done.

     {
       buttons.push({
         type: "configure",
         title: ext.i18n.getMessage("notification_configure")
       });
     }
   }
 
   return buttons;
 }
@@ skipping 15 matching lines @@
   switch (activeButtons[buttonIndex].type)
   {
     case "link":
       ext.pages.open(Utils.getDocLink(activeNotification.links[buttonIndex]));
       break;
     case "open-all":
       openNotificationLinks();
       break;
     case "configure":
       Prefs.notifications_showui = true;
-      ext.showOptions(function(page)
+      ext.showOptions(page =>
       {
         page.sendMessage({
           type: "app.respond",
           action: "focusSection",
           args: ["notifications"]
         });
       });
       break;
     case "question":
       NotificationStorage.triggerQuestionListeners(activeNotification.id, buttonIndex == 0);
       NotificationStorage.markAsShown(activeNotification.id);
       activeNotification.onClicked();
       break;
   }
 }
 
 function notificationClosed()
 {
   activeNotification = 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)
+    chrome.notifications.clear(notificationId, wasCleared =>
     {
       if (wasCleared)
         notificationClosed();
     });
   }
 
-  chrome.notifications.onButtonClicked.addListener(function(notificationId, buttonIndex)
+  chrome.notifications.onButtonClicked.addListener((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 (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 linkCount = (activeNotification.links || []).length;
 
-    if (canUseChromeNotifications)
+    if ("notifications" in chrome)
     {
       activeButtons = getNotificationButtons(activeNotification.type, texts.message);
       chrome.notifications.create("", {
         type: "basic",
         title: title,
         iconUrl: iconUrl,
         message: message,
         buttons: activeButtons.map(button => ({title: button.title})),
         priority: 2 // We use the highest priority to prevent the notification from closing automatically
       });
@@ skipping 24 matching lines @@
 
       let approved = confirm(message);
       if (activeNotification.type == "question")
         notificationButtonClick(approved ? 0 : 1);
       else if (approved)
         openNotificationLinks();
     }
   }
   prepareNotificationIconAndPopup();
 
   if (notification.type !== "question")

[Sebastian Noack, 2017/01/05 12:46:11]

As per the Mozilla coding style guide
(https://developer.mozilla.org/en-US/docs/Mozilla/Developer_guide/Coding_Style...)
which is referenced in our coding style guide
(https://adblockplus.org/coding-style#javascript), we prefer != over !==.

[wspee, 2017/01/05 15:19:27]

Done.

     NotificationStorage.markAsShown(notification.id);
 };
 
 /**
  * Initializes the notification system.
  */
-exports.initNotifications = function()
-{
-  if (canUseChromeNotifications)
+exports.initNotifications = () =>
+{
+  if ("notifications" in chrome)
     initChromeNotifications();
   initAntiAdblockNotification();
 };
 
 /**
  * Gets the active notification to be shown if any.
  *
  * @return {?object}
  */
-exports.getActiveNotification = function()
-{
-  return activeNotification;
-};
+exports.getActiveNotification = () => activeNotification;
 
 let shouldDisplay =
 /**
  * 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 = function(method, notificationType)
+exports.shouldDisplay = (method, notificationType) =>
 {
   let methods = displayMethods[notificationType] || defaultDisplayMethods;
   return methods.indexOf(method) > -1;
 };
 
 ext.pages.onLoading.addListener(page =>
 {
   NotificationStorage.showNext(stringifyURL(page.url));
 });
 
 NotificationStorage.addShowListener(showNotification);