Move the notification code out of imWindows.jsm (new ibNotifications.jsm module).

--HG--
rename : im/modules/imWindows.jsm => im/modules/ibNotifications.jsm

im/modules/Makefile.in

@@ -43,6 +43,7 @@ include $(DEPTH)/config/autoconf.mk
 
 EXTRA_JS_MODULES = \
 	ibCore.jsm \
+	ibNotifications.jsm \
 	imContentSink.jsm \
 	imServices.jsm \
 	imSmileys.jsm \

im/modules/ibCore.jsm

@@ -41,6 +41,7 @@ const EXPORTED_SYMBOLS = ["Core"];
 const {classes: Cc, interfaces: Ci, utils: Cu} = Components;
 Cu.import("resource:///modules/imServices.jsm");
 Cu.import("resource:///modules/imWindows.jsm");
+Cu.import("resource:///modules/ibNotifications.jsm");
 
 var Core = {
   _events: [
@@ -113,6 +114,7 @@ var Core = {
     }
 
     Conversations.init();
+    Notifications.init();
 
     this._events.forEach(function (aTopic) {
       Services.obs.addObserver(Core, aTopic, false);

im/modules/ibNotifications.jsm

@@ -0,0 +1,121 @@
+/* ***** BEGIN LICENSE BLOCK *****
+ * Version: MPL 1.1/GPL 2.0/LGPL 2.1
+ *
+ * The contents of this file are subject to the Mozilla Public License Version
+ * 1.1 (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ * http://www.mozilla.org/MPL/
+ *
+ * Software distributed under the License is distributed on an "AS IS" basis,
+ * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
+ * for the specific language governing rights and limitations under the
+ * License.
+ *
+ * The Original Code is the Instantbird messenging client, released
+ * 2009.
+ *
+ * The Initial Developer of the Original Code is
+ * Florian QUEZE <florian@instantbird.org>.
+ * Portions created by the Initial Developer are Copyright (C) 2009
+ * the Initial Developer. All Rights Reserved.
+ *
+ * Contributor(s):
+ *
+ * Alternatively, the contents of this file may be used under the terms of
+ * either the GNU General Public License Version 2 or later (the "GPL"), or
+ * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
+ * in which case the provisions of the GPL or the LGPL are applicable instead
+ * of those above. If you wish to allow use of your version of this file only
+ * under the terms of either the GPL or the LGPL, and not to allow others to
+ * use your version of this file under the terms of the MPL, indicate your
+ * decision by deleting the provisions above and replace them with the notice
+ * and other provisions required by the GPL or the LGPL. If you do not delete
+ * the provisions above, a recipient may use your version of this file under
+ * the terms of any one of the MPL, the GPL or the LGPL.
+ *
+ * ***** END LICENSE BLOCK ***** */
+
+const EXPORTED_SYMBOLS = ["Notifications"];
+
+Components.utils.import("resource:///modules/imServices.jsm");
+Components.utils.import("resource:///modules/imWindows.jsm");
+
+var Notifications = {
+  get ellipsis () {
+    let ellipsis = "[\u2026]";
+
+    try {
+      ellipsis =
+        Services.prefs.getComplexValue("intl.ellipsis",
+                                       Components.interfaces.nsIPrefLocalizedString).data;
+    } catch (e) { }
+    return ellipsis;
+  },
+
+  _showMessageNotification: function (aMessage) {
+    // Get the hidden window. We need it to create a DOM node.
+    let win = Components.classes["@mozilla.org/appshell/appShellService;1"]
+                        .getService(Components.interfaces.nsIAppShellService)
+                        .hiddenDOMWindow;
+
+    // Put the message content into a div node.
+    let xhtmlElement = win.document.createElementNS("http://www.w3.org/1999/xhtml", "div");
+    xhtmlElement.innerHTML = aMessage.message;
+
+    // Convert the div node content to plain text.
+    let encoder =
+      Components.classes["@mozilla.org/layout/documentEncoder;1?type=text/plain"]
+                .createInstance(Components.interfaces.nsIDocumentEncoder);
+    encoder.init(win.document, "text/plain", 0);
+    encoder.setNode(xhtmlElement);
+    let messageText = encoder.encodeToString().replace(/\s+/g, " ");
+
+    // Crop the end of the text if needed.
+    if (messageText.length > 50)
+      messageText = messageText.substr(0, 50) + this.ellipsis;
+
+    // Use the buddy icon if available for the icon of the notification.
+    let icon;
+    let conv = aMessage.conversation;
+    if (!conv.isChat) {
+      let buddy = conv.buddy;
+      if (buddy)
+        icon = buddy.buddyIconFilename;
+    }
+    if (!icon)
+      icon = "chrome://instantbird/skin/newMessage.png";
+
+    // Prepare an observer to focus the conversation if the
+    // notification is clicked.
+    let observer = {
+      observe: function(aSubject, aTopic, aData) {
+        if (aTopic == "alertclickcallback")
+          Conversations.focusConversation(aMessage.conversation);
+      }
+    };
+
+    // Finally show the notification!
+    Components.classes["@mozilla.org/alerts-service;1"]
+              .getService(Components.interfaces.nsIAlertsService)
+              .showAlertNotification(icon, aMessage.alias || aMessage.who,
+                                     messageText, true, "", observer);
+  },
+
+  init: function() {
+    Services.obs.addObserver(Notifications, "new-text", false);
+  },
+
+  _notificationPrefName: "messenger.options.notifyOfNewMessages",
+  observe: function(aSubject, aTopic, aData) {
+    if (aTopic != "new-text")
+      return;
+
+    if (!aSubject.incoming || aSubject.system ||
+        (aSubject.conversation.isChat && !aSubject.containsNick))
+      return;
+
+    if (!Conversations.isConversationWindowFocused() &&
+        Services.prefs.getBoolPref(this._notificationPrefName))
+      this._showMessageNotification(aSubject);
+  }
+};

im/modules/imWindows.jsm

@@ -99,7 +99,6 @@ var Conversations = {
   },
   _windows: [],
   _getAttentionPrefName: "messenger.options.getAttentionOnNewMessages",
-  _notificationPrefName: "messenger.options.notifyOfNewMessages",
   registerWindow: function(aWindow) {
     if (this._windows.indexOf(aWindow) == -1)
       this._windows.unshift(aWindow);
@@ -138,6 +137,8 @@ var Conversations = {
       delete this._purpleConv[aConversation.conv.id];
   },
 
+  isConversationWindowFocused: function()
+    this._windows.length > 0 && this._windows[0].document.hasFocus(),
   focusConversation: function(aConv) {
     let id = aConv.id;
     if (id in this._purpleConv) {
@@ -166,66 +167,6 @@ var Conversations = {
     this._clearUnreadCount();
   },
 
-  get ellipsis () {
-    let ellipsis = "[\u2026]";
-
-    try {
-      ellipsis =
-        Services.prefs.getComplexValue("intl.ellipsis",
-                                       Components.interfaces.nsIPrefLocalizedString).data;
-    } catch (e) { }
-    return ellipsis;
-  },
-
-  _showMessageNotification: function (aMessage) {
-    // Get the hidden window. We need it to create a DOM node.
-    let win = Components.classes["@mozilla.org/appshell/appShellService;1"]
-                        .getService(Components.interfaces.nsIAppShellService)
-                        .hiddenDOMWindow;
-
-    // Put the message content into a div node.
-    let xhtmlElement = win.document.createElementNS("http://www.w3.org/1999/xhtml", "div");
-    xhtmlElement.innerHTML = aMessage.message;
-
-    // Convert the div node content to plain text.
-    let encoder =
-      Components.classes["@mozilla.org/layout/documentEncoder;1?type=text/plain"]
-                .createInstance(Components.interfaces.nsIDocumentEncoder);
-    encoder.init(win.document, "text/plain", 0);
-    encoder.setNode(xhtmlElement);
-    let messageText = encoder.encodeToString().replace(/\s+/g, " ");
-
-    // Crop the end of the text if needed.
-    if (messageText.length > 50)
-      messageText = messageText.substr(0, 50) + this.ellipsis;
-
-    // Use the buddy icon if available for the icon of the notification.
-    let icon;
-    let conv = aMessage.conversation;
-    if (!conv.isChat) {
-      let buddy = conv.buddy;
-      if (buddy)
-        icon = buddy.buddyIconFilename;
-    }
-    if (!icon)
-      icon = "chrome://instantbird/skin/newMessage.png";
-
-    // Prepare an observer to focus the conversation if the
-    // notification is clicked.
-    let observer = {
-      observe: function(aSubject, aTopic, aData) {
-        if (aTopic == "alertclickcallback")
-          Conversations.focusConversation(aMessage.conversation);
-      }
-    };
-
-    // Finally show the notification!
-    Components.classes["@mozilla.org/alerts-service;1"]
-              .getService(Components.interfaces.nsIAlertsService)
-              .showAlertNotification(icon, aMessage.alias || aMessage.who,
-                                     messageText, true, "", observer);
-  },
-
   init: function() {
     let os = Services.obs;
     ["new-text",
@@ -294,11 +235,8 @@ var Conversations = {
           (!aSubject.conversation.isChat || aSubject.containsNick)) {
         if (Services.prefs.getBoolPref(this._getAttentionPrefName))
           conv.ownerDocument.defaultView.getAttention();
-        if (!this._windows[0].document.hasFocus()) {
+        if (!this.isConversationWindowFocused())
           this._incrementUnreadCount();
-          if (Services.prefs.getBoolPref(this._notificationPrefName))
-            this._showMessageNotification(aSubject);
-        }
       }
     }
   }