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 247 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 137 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));
 
-    let timer = Cc["@mozilla.org/timer;1"].createInstance(Ci.nsITimer);

[Wladimir Palant, 2013/07/19 15:17:52]

Sure, we do:

  onShutdown.add(function() timer.cancel());

But there is more: this timer will likely be cancelled automatically because the
corresponding object is garbage collected. We need to keep a reference to that
timer.

[Felix Dahlke, 2013/07/19 17:07:01]

Done.

-    timer.initWithCallback(function()
-    {
-      let notificationToShow = Notification.getNextToShow();
-      if (notificationToShow)
-        this._showNotification(notificationToShow);
-    }.bind(this), 3 * 60 * 1000, Ci.nsITimer.TYPE_ONE_SHOT);
+    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());
   },
 
   /**
    * Will be set to true after the check whether first-run actions should run
    * has been performed.
    * @type Boolean
    */
   firstRunDone: false,
 
   /**
@@ skipping 1476 matching lines @@
     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;
     }
   },
 
-  _showNotification: function(notification)
+  _showNextNotification: function(notification)
   {
     let window = null;
     for (window in this.applicationWindows)
       break;
 
     if (!window)
       return;

[Wladimir Palant, 2013/07/19 15:17:52]

We already marked the notification as shown at this point. It would make sense
to check the prerequisites first and only call Notification.getNextToShow()
then.

[Felix Dahlke, 2013/07/19 17:07:01]

Done.

 
     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 message = texts.message.replace(/<(\/?)a(.*?)>/g, "<$1html:a$2>");
-    messageElement.innerHTML = 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();
@@ skipping 32 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);
 });