Show notifications on startup

lib/ui.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
@@ skipping 11 matching lines @@
 let {Prefs} = require("prefs");
 let {Policy} = require("contentPolicy");
 let {FilterListener} = require("filterListener");
 let {FilterStorage} = require("filterStorage");
 let {FilterNotifier} = require("filterNotifier");
 let {RequestNotifier} = require("requestNotifier");
 let {Filter} = require("filterClasses");
 let {Subscription, SpecialSubscription, DownloadableSubscription} = require("subscriptionClasses");
 let {Synchronizer} = require("synchronizer");
 let {KeySelector} = require("keySelector");
+let {Notification} = require("notification");
 
 /**
  * Filter corresponding with "disable on site" menu item (set in fillIconMent()).
  * @type Filter
  */
 let siteWhitelist = null;
 /**
  * Filter corresponding with "disable on site" menu item (set in fillIconMenu()).
  * @type Filter
  */
@@ skipping 215 matching lines @@
 
     this.timer.cancel();
     this.timer = null;
 
     if (!onShutdown.done)
       this.callback();
   },
   QueryInterface: XPCOMUtils.generateQI([Ci.nsIObserver, Ci.nsISupportsWeakReference])
 }
 
+/**
+ * Timer used to delay notification handling.
+ * @type nsITimer
+ */
+let notificationTimer = null;
+
 let UI = exports.UI =
 {
   /**
    * Gets called on startup, initializes UI integration.
    */
   init: function()
   {
     // We should call initDone once both overlay and filters are loaded
     let overlayLoaded = false;
     let filtersLoaded = false;
@@ skipping 136 matching lines @@
       {
         for (let window in this.applicationWindows)
           this.updateStatusbarIcon(window);
       }
     }.bind(this));
     FilterNotifier.addListener(function(action)
     {
       if (/^(filter|subscription)\.(added|removed|disabled|updated)$/.test(action) || action == "load")
         this.updateState();
     }.bind(this));
+
+    notificationTimer = Cc["@mozilla.org/timer;1"].createInstance(Ci.nsITimer);
+    notificationTimer.initWithCallback(this._showNextNotification.bind(this),
+                                       3 * 60 * 1000, Ci.nsITimer.TYPE_ONE_SHOT);
+    onShutdown.add(function() notificationTimer.cancel());

[Wladimir Palant, 2013/07/20 07:18:07]

We need to verify that this doesn't cause an error if the timer already fired.

[Felix Dahlke, 2013/07/20 23:00:51]

I haven't see us do that in other places, so it seems to be fine, does it? The
docs don't say anything about whether cancelling an already fired one shot timer
should be a problem, nor does it seem to be possible to figure out if a timer
has already been fired. So I suppose I'd have to manually remove the shutdown
handler then.

Just tested this by closing Firefox after the notification has been shown. No
errors or anything, so it seems to be fine.

[Wladimir Palant, 2013/07/21 11:30:17]

I other places we are using repeating timers, not one-time timers.
The way to test this would be to disable Adblock Plus - it's extension shutdown,
not the browser shutdown ;)

Either way, I verified that nsITimer.cancel() doesn't throw errors even when
called multiple times.

   },
 
   /**
    * Will be set to true after the check whether first-run actions should run
    * has been performed.
    * @type Boolean
    */
   firstRunDone: false,
 
   /**
@@ skipping 1474 matching lines @@
   hideContributeButton: function(/**Window*/ window)
   {
     Prefs.hideContributeButton = true;
 
     for each (let id in ["abp-status-contributebutton", "abp-toolbar-contributebutton", "abp-menuitem-contributebutton"])
     {
       let button = window.document.getElementById(id);
       if (button)
         button.hidden = true;
     }
+  },
+
+  _showNextNotification: function(notification)
+  {
+    let window = null;
+    for (window in this.applicationWindows)
+      break;
+
+    if (!window)
+      return;
+
+    let button = window.document.getElementById("abp-toolbarbutton")
+      || window.document.getElementById("abp-status");
+    if (!button)
+      return;
+
+    let notification = Notification.getNextToShow();
+    if (!notification)
+      return;
+
+    this._showNotification(window, button, notification);
+  },
+
+  _showNotification: function(window, button, notification)
+  {
+    function insertMessage(element, text, links)
+    {
+      let match = /^(.*?)<(a|strong)>(.*?)<\/\2>(.*)$/.exec(text);
+      if (!match)
+      {
+        element.appendChild(window.document.createTextNode(text));
+        return;
+      }
+
+      let [_, before, tagName, value, after] = match;
+
+      insertMessage(element, before, links);
+
+      let newElement = window.document.createElementNS("http://www.w3.org/1999/xhtml", tagName);
+      if (tagName === "a" && links && links.length)
+        newElement.setAttribute("href", links.shift());
+      insertMessage(newElement, value, links);
+      element.appendChild(newElement);
+
+      insertMessage(element, after, links);
+    }
+
+    let texts = Notification.getLocalizedTexts(notification);
+    let titleElement = window.document.getElementById("abp-notification-title");
+    titleElement.setAttribute("value", texts.title);
+    let messageElement = window.document.getElementById("abp-notification-message");
+    let docLinks = [];
+    for each (let link in notification.links)
+      docLinks.push(Utils.getDocLink(link));
+    insertMessage(messageElement, texts.message, docLinks);
+
+    let links = window.document.querySelectorAll("#abp-notification-message a");
+    for each (let link in links)
+    {
+      let url = link.href;
+      let ui = this;
+      link.onclick = function(event)
+      {
+        event.preventDefault();
+        event.stopPropagation();
+        if (!/^https?:\/\//.test(url))
+        {
+          Cu.reportError("Illegal link scheme in URL: " + url);
+          return;
+        }

[Wladimir Palant, 2013/07/20 07:18:07]

The URL no longer comes from server so we can just assume that it is safe - this
code isn't required now.

+        ui.loadInBrowser(url, window);
+      };
+    }
+
+    let panel = window.document.getElementById("abp-notification");
+    panel.openPopup(button, "bottomcenter topcenter", 0, 0, false, false, null);
   }
 };
 UI.onPopupShowing = UI.onPopupShowing.bind(UI);
 UI.onKeyPress = UI.onKeyPress.bind(UI);
 UI.onIconClick = UI.onIconClick.bind(UI);
 UI.onToolbarCustomization = UI.onToolbarCustomization.bind(UI);
 UI.init();
 
 /**
  * List of event handers to be registered for each window. For each event
@@ skipping 16 matching lines @@
   ["abp-command-contribute", "command", UI.openContributePage.bind(UI)],
   ["abp-command-contribute-hide", "command", UI.hideContributeButton.bind(UI)]
 ];
 
 onShutdown.add(function()
 {
   for (let window in UI.applicationWindows)
     if (UI.isBottombarOpen(window))
       UI.toggleBottombar(window);
 });