notificationDaemon: group sources based on a combination of pid and title

That way different system notifications, such as the ones about battery power
and the ones about software updates, are shown with separate message tray
sources.

https://bugzilla.gnome.org/show_bug.cgi?id=664138

js/ui/notificationDaemon.js

@@ -94,7 +94,7 @@ const NotificationDaemon = new Lang.Class({
         this._dbusImpl = Gio.DBusExportedObject.wrapJSObject(NotificationDaemonIface, this);
         this._dbusImpl.export(Gio.DBus.session, '/org/freedesktop/Notifications');
 
-        this._sources = {};
+        this._sources = [];
         this._senderToPid = {};
         this._notifications = {};
         this._busProxy = new Bus();
@@ -152,14 +152,30 @@ const NotificationDaemon = new Lang.Class({
         }
     },
 
+    _lookupSource: function(title, pid, trayIcon) {
+        for (let i = 0; i < this._sources.length; i++) {
+            let source = this._sources[i];
+            if (source.pid == pid &&
+                (source.initialTitle == title || source.trayIcon || trayIcon))
+                return source;
+        }
+        return null;
+    },
+
     // Returns the source associated with ndata.notification if it is set.
-    // Otherwise, returns the source associated with the pid if one is
+    // Otherwise, returns the source associated with the title and pid if
-    // stored in this._sources and the notification is not transient.
+    // such source is stored in this._sources and the notification is not
-    // Otherwise, creates a new source as long as pid is provided.
+    // transient. If the existing or requested source is associated with
+    // a tray icon and passed in pid matches a pid of an existing source,
+    // the title match is ignored to enable representing a tray icon and
+    // notifications from the same application with a single source.
+    //
+    // If no existing source is found, a new source is created as long as
+    // pid is provided.
     //
     // Either a pid or ndata.notification is needed to retrieve or
     // create a source.
-    _getSource: function(title, pid, ndata, sender) {
+    _getSource: function(title, pid, ndata, sender, trayIcon) {
         if (!pid && !(ndata && ndata.notification))
             return null;
 
@@ -176,20 +192,24 @@ const NotificationDaemon = new Lang.Class({
         // with a transient one from the same sender, so we
         // always create a new source object for new transient notifications
         // and never add it to this._sources .
-        if (!isForTransientNotification && this._sources[pid]) {
+        if (!isForTransientNotification) {
-            let source = this._sources[pid];
+            let source = this._lookupSource(title, pid, trayIcon);
+            if (source) {
                 source.setTitle(title);
                 return source;
             }
+        }
 
-        let source = new Source(title, pid, sender);
+        let source = new Source(title, pid, sender, trayIcon);
         source.setTransient(isForTransientNotification);
 
         if (!isForTransientNotification) {
-            this._sources[pid] = source;
+            this._sources.push(source);
             source.connect('destroy', Lang.bind(this,
                 function() {
-                    delete this._sources[pid];
+                    let index = this._sources.indexOf(source);
+                    if (index >= 0)
+                        this._sources.splice(index, 1);
                 }));
         }
 
@@ -268,7 +288,7 @@ const NotificationDaemon = new Lang.Class({
         let sender = invocation.get_sender();
         let pid = this._senderToPid[sender];
 
-        let source = this._getSource(appName, pid, ndata, sender);
+        let source = this._getSource(appName, pid, ndata, sender, null);
 
         if (source) {
             this._notifyForSource(source, ndata);
@@ -294,7 +314,7 @@ const NotificationDaemon = new Lang.Class({
             }
 
             let [pid] = result;
-            source = this._getSource(appName, pid, ndata, sender);
+            source = this._getSource(appName, pid, ndata, sender, null);
 
             // We only store sender-pid entries for persistent sources.
             // Removing the entries once the source is destroyed
@@ -443,8 +463,8 @@ const NotificationDaemon = new Lang.Class({
         if (!tracker.focus_app)
             return;
 
-        for (let id in this._sources) {
+        for (let i = 0; i < this._sources.length; i++) {
-            let source = this._sources[id];
+            let source = this._sources[i];
             if (source.app == tracker.focus_app) {
                 source.destroyNonResidentNotifications();
                 return;
@@ -463,12 +483,11 @@ const NotificationDaemon = new Lang.Class({
     },
 
     _onTrayIconAdded: function(o, icon) {
-        let source = this._getSource(icon.title || icon.wm_class || _("Unknown"), icon.pid, null, null);
+        let source = this._getSource(icon.title || icon.wm_class || _("Unknown"), icon.pid, null, null, icon);
-        source.setTrayIcon(icon);
     },
 
     _onTrayIconRemoved: function(o, icon) {
-        let source = this._sources[icon.pid];
+        let source = this._lookupSource(icon.pid, null, true);
         if (source)
             source.destroy();
     }
@@ -478,10 +497,12 @@ const Source = new Lang.Class({
     Name: 'NotificationDaemonSource',
     Extends: MessageTray.Source,
 
-    _init: function(title, pid, sender) {
+    _init: function(title, pid, sender, trayIcon) {
         this.parent(title);
 
-        this._pid = pid;
+        this.initialTitle = title;
+
+        this.pid = pid;
         if (sender)
             this._nameWatcherId = Gio.DBus.session.watch_name(sender,
                                                               Gio.BusNameWatcherFlags.NONE,
@@ -495,7 +516,12 @@ const Source = new Lang.Class({
             this.title = this.app.get_name();
         else
             this.useNotificationIcon = true;
-        this._trayIcon = null;
+
+        this.trayIcon = trayIcon;
+        if (this.trayIcon) {
+           this._setSummaryIcon(this.trayIcon);
+           this.useNotificationIcon = false;
+        }
     },
 
     _onNameVanished: function() {
@@ -522,7 +548,7 @@ const Source = new Lang.Class({
     },
 
     handleSummaryClick: function() {
-        if (!this._trayIcon)
+        if (!this.trayIcon)
             return false;
 
         let event = Clutter.get_current_event();
@@ -543,11 +569,11 @@ const Source = new Lang.Class({
             let id = global.connect('notify::stage-input-mode', Lang.bind(this,
                 function () {
                     global.disconnect(id);
-                    this._trayIcon.click(event);
+                    this.trayIcon.click(event);
                 }));
             Main.overview.hide();
         } else {
-            this._trayIcon.click(event);
+            this.trayIcon.click(event);
         }
         return true;
     },
@@ -556,31 +582,25 @@ const Source = new Lang.Class({
         if (this.app)
             return;
 
-        this.app = Shell.WindowTracker.get_default().get_app_from_pid(this._pid);
+        this.app = Shell.WindowTracker.get_default().get_app_from_pid(this.pid);
         if (!this.app)
             return;
 
         // Only override the icon if we were previously using
         // notification-based icons (ie, not a trayicon) or if it was unset before
-        if (!this._trayIcon) {
+        if (!this.trayIcon) {
             this.useNotificationIcon = false;
             this._setSummaryIcon(this.app.create_icon_texture (this.ICON_SIZE));
         }
     },
 
-    setTrayIcon: function(icon) {
-        this._setSummaryIcon(icon);
-        this.useNotificationIcon = false;
-        this._trayIcon = icon;
-    },
-
     open: function(notification) {
         this.destroyNonResidentNotifications();
         this.openApp();
     },
 
     _lastNotificationRemoved: function() {
-        if (!this._trayIcon)
+        if (!this.trayIcon)
             this.destroy();
     },