Issue 5354 - Adds handling for notifications on Opera

lib/notificationHelper.js

 /*
  * This file is part of Adblock Plus <https://adblockplus.org/>,
  * Copyright (C) 2006-present 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 */
 
 "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");
+const {showOptions} = require("options");
 
 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"];
@@ skipping 11 matching lines @@
     startIconAnimation(activeNotification.type);
 }
 
 function getNotificationButtons(notificationType, message)
 {
   let buttons = [];
   if (notificationType == "question")
   {
     buttons.push({
       type: "question",
-      title: ext.i18n.getMessage("overlay_notification_button_yes")
+      title: browser.i18n.getMessage("overlay_notification_button_yes")
     });
     buttons.push({
       type: "question",
-      title: ext.i18n.getMessage("overlay_notification_button_no")
+      title: browser.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")
+          title: browser.i18n.getMessage("notification_open_all")
         }
       ];
     }
     if (!["critical", "relentless"].includes(notificationType))
     {
       buttons.push({
         type: "configure",
-        title: ext.i18n.getMessage("notification_configure")
+        title: browser.i18n.getMessage("notification_configure")
       });
     }
   }
 
   return buttons;
 }
 
 function openNotificationLinks()
 {
   if (activeNotification.links)
   {
     for (let link of activeNotification.links)
-      ext.pages.open(Utils.getDocLink(link));
+      browser.tabs.create({url: Utils.getDocLink(link)});
   }
 }
 
 function notificationButtonClick(buttonIndex)
 {
   if (!(activeButtons && buttonIndex in activeButtons))
     return;
 
   switch (activeButtons[buttonIndex].type)
   {
     case "link":
-      ext.pages.open(Utils.getDocLink(activeNotification.links[buttonIndex]));
+      browser.tabs.create({
+        url: Utils.getDocLink(activeNotification.links[buttonIndex])
+      });
       break;
     case "open-all":
       openNotificationLinks();
       break;
     case "configure":
       Prefs.notifications_showui = true;
-      ext.showOptions(page =>
+      showOptions(page =>
       {
         page.sendMessage({
           type: "app.respond",
           action: "focusSection",
           args: ["notifications"]
         });
       });
       break;
     case "question":
       NotificationStorage.triggerQuestionListeners(activeNotification.id,
@@ skipping 13 matching lines @@
 {
   // 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, wasCleared =>
+    browser.notifications.clear(notificationId, wasCleared =>
     {
       if (wasCleared)
         notificationClosed();
     });
   }
 
-  chrome.notifications.onButtonClicked.addListener(
+  browser.notifications.onButtonClicked.addListener(
     (notificationId, buttonIndex) =>
     {
       notificationButtonClick(buttonIndex);
       clearActiveNotification(notificationId);
     }
   );
-  chrome.notifications.onClicked.addListener(clearActiveNotification);
-  chrome.notifications.onClosed.addListener(notificationClosed);
+  browser.notifications.onClicked.addListener(clearActiveNotification);
+  browser.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 || "").replace(/<\/?(a|strong)>/g, "");
-    let iconUrl = ext.getURL("icons/detailed/abp-128.png");
+    let iconUrl = browser.extension.getURL("icons/detailed/abp-128.png");
     let linkCount = (activeNotification.links || []).length;
 
-    if ("notifications" in chrome)
+    if ("notifications" in browser)
     {
       activeButtons = getNotificationButtons(activeNotification.type,
                                              texts.message);
-      let options = {
+      let notificationOptions = {
         type: "basic",
         title,
         iconUrl,
         message,
         buttons: activeButtons.map(button => ({title: button.title})),
         // We use the highest priority to prevent the notification
         // from closing automatically.
         priority: 2
       };
-      chrome.notifications.create("", options, () =>
+      browser.notifications.create("", notificationOptions, () =>
       {
-        if (chrome.runtime.lastError && chrome.runtime.lastError.message === `
-        Adding buttons to notifications is not supported.`)

[Sebastian Noack, 2017/10/21 21:04:28]

I would skip the check for the error message. If it failed for some reason, we
will just keep getting the same error again once we try without buttons.

But I would add a comment here, that on Opera buttons are not supported, causing
an error here.

[Jon Sonesen, 2017/10/30 22:41:41]

Done.

+        // Opera does not support the addtition of buttons to notifications.

[Sebastian Noack, 2017/11/01 18:45:03]

Typo: addtition

+        // Question type notfications always include buttons.
+        if (browser.runtime.lastError && activeNotification.type != "question")
         {
-          delete options.buttons;

[Jon Sonesen, 2017/10/19 21:59:17]

perhaps it is better to move this down or put all the logic in one control
statement?

[Sebastian Noack, 2017/10/21 21:04:28]

Yeah, I guess this operation makes more sense in the if-branch below.

[Jon Sonesen, 2017/10/30 22:41:41]

Done.

-          if (activeNotification.type != "question")
-            chrome.notifications.create("", options);
+          delete notificationOptions.buttons;
+          browser.notifications.create("", notificationOptions);
         }
       });
     }
     else if ("Notification" in window && activeNotification.type != "question")
     {
       if (linkCount > 0)
-        message += " " + ext.i18n.getMessage("notification_without_buttons");
+      {
+        message += " " + browser.i18n.getMessage(
+          "notification_without_buttons"
+        );
+      }
 
       let widget = new Notification(
         title,
         {
           lang: Utils.appLocale,
           dir: Utils.readingDirection,
           body: message,
           icon: iconUrl
         }
       );
 
       widget.addEventListener("click", openNotificationLinks);
       widget.addEventListener("close", notificationClosed);
     }
     else
     {
       message = title + "\n" + message;
       if (linkCount > 0)
-        message += "\n\n" + ext.i18n.getMessage("notification_with_buttons");
+      {
+        message += "\n\n" + browser.i18n.getMessage(
+          "notification_with_buttons"
+        );
+      }
 
       let approved = confirm(message);
       if (activeNotification.type == "question")
         notificationButtonClick(approved ? 0 : 1);
       else if (approved)
         openNotificationLinks();
     }
   }
   prepareNotificationIconAndPopup();
 
   if (notification.type !== "question")
     NotificationStorage.markAsShown(notification.id);
 }
 
 /**
  * Initializes the notification system.
  */
 exports.initNotifications = () =>
 {
-  if ("notifications" in chrome)
+  if ("notifications" in browser)
     initChromeNotifications();
   initAntiAdblockNotification();
 };
 
 /**
  * Gets the active notification to be shown if any.
  *
  * @return {?object}
  */
 exports.getActiveNotification = () => activeNotification;
@@ skipping 12 matching lines @@
   let methods = displayMethods[notificationType] || defaultDisplayMethods;
   return methods.includes(method);
 };
 
 ext.pages.onLoading.addListener(page =>
 {
   NotificationStorage.showNext(stringifyURL(page.url));
 });
 
 NotificationStorage.addShowListener(showNotification);