From a218183fa992c1930277714840555424c0ec174e Mon Sep 17 00:00:00 2001
From: "Vlad G." <b100dian@gmail.com>
Date: Sun, 20 Oct 2024 22:58:01 +0300
Subject: [PATCH] Cleaner notifications (#49)

* Cleaner notifications

* Honor sticky; stale import

* Update AppSettingsPage.qml

clarifying
---
 qml/components/HydrogenNotifier.qml | 238 ----------------------------
 qml/harbour-hydrogen.qml            |  52 +++++-
 qml/pages/AppSettingsPage.qml       |   6 +-
 3 files changed, 48 insertions(+), 248 deletions(-)
 delete mode 100644 qml/components/HydrogenNotifier.qml

diff --git a/qml/components/HydrogenNotifier.qml b/qml/components/HydrogenNotifier.qml
deleted file mode 100644
index a562930..0000000
--- a/qml/components/HydrogenNotifier.qml
+++ /dev/null
@@ -1,238 +0,0 @@
-import QtQuick 2.2  // not 2.0, because Instantiator
-import QtQml 2.2  // for Instantiator
-import Sailfish.Silica 1.0
-import Nemo.Notifications 1.0
-
-Item { id: root
-    /*! ListModel to serve as an input to the factory */
-    property alias messages: factory.model
-
-    /*! Emitted when a Notification hsa been published */
-    signal messagePublished(string msgid)
-
-    /*!
-     * Creates and publishes a new notification.
-     * Convenience function to quickly publish a notification.
-     */
-    function quickNotification( message ) { addNotification( undefined, message, undefined, message, undefined, undefined, false ) }
-
-    /*!
-     * Creates and publishes a new notification.
-     * Convenience function to quickly publish a notification.
-     */
-    function quickNumberedNotification( message, count ) { addNotification( undefined, message, undefined, message, count, undefined, false ) }
-
-
-    /*!
-     * Creates and publishes a new notification.
-     *
-     * At least the shortMessage parameter should be supplied.
-     * If uid is specified, it can be used in removeNotification later.
-     *
-     * Both "title" parameters default to "Notification" if not specified.
-     *
-     * The count parameter will be passed as itemCount property to the Notification
-     *
-     * If hold is set, the Notification is not published immediately, and must
-     * be published later by calling publishNotification()
-     */
-    function addNotification( shortTitle, shortMessage,
-                              title, message,
-                              count,
-                              uid,
-                              hold
-                            ) {
-        // we can't write to uid, so copy it to a local variable
-        const msgid = (uid) ? uid : Qt.md5([ Date.now(), Math.random(), title, message, shortTitle, shortMessage, count].join())
-
-        // wait for the instantiator to create the object, set properties through function
-        var conn = factory.objectAdded.connect(createNewNotification)
-
-        // add new thing to model, this should trigger creation of a new
-        // notification.
-        messages.append({"mid": msgid})
-        return msgid
-
-        /* Set properties and optionally publish
-         * need a named function here so we can disconnect() again.
-         */
-        function createNewNotification(idx, obj) {
-            console.assert(shortMessage, "Warning: we should have at least a message body")
-
-            obj.summary        = (title)      ? title      : qsTr("Notification")
-            obj.previewSummary = (shortTitle) ? shortTitle : qsTr("Notification")
-
-            if (message)        obj.body           = message
-            if (shortMessage)   obj.previewBody    = shortMessage
-            if (count)          obj.itemCount      = count
-            // store our id for sending back on notification click
-            obj.internalId = msgid
-
-            if (!hold) {
-                obj.publish()
-                messagePublished(msgid)
-            }
-            // disconnect ourselves again.
-            factory.objectAdded.disconnect(createNewNotification)
-        }
-
-    }
-
-    /*! Publishes a Notification
-     * uid is the internal uid from the "messages" model
-     */
-    function publishNotification(uid) {
-        for (var i = 0; i<messages.count; i++) {
-            var o = messages.get(i);
-            if (o.mid === uid) {
-                var n = factory.objectAt(i)
-                console.assert(n, "BUG: retrieved an invalid object from factory.")
-                console.debug("Publishing notification", uid)
-                n.publish()
-                messagePublished(uid)
-            }
-        }
-    }
-
-    /*! Updates Notification contents
-     * uid is the internal uid from the "messages" model
-     * parameters is an object having the updated parameters
-     * unless hold is true, changes will be published immediately
-     */
-    function updateNotification(uid, parms, hold) {
-        for (var i = 0; i<messages.count; i++) {
-            var o = messages.get(i);
-            if (o.mid === uid) {
-                // if any of the keys in parms exists in the notification,
-                // update the notification
-                var n = factory.objectAt(i)
-                console.assert(n, "BUG: retrieved an invalid object from factory.")
-                var keys = Object.keys(parms)
-                keys.forEach(function(k) {
-                    if (n[k]) { n[k] = parms[k] }
-                })
-                // update published notification:
-                if (!hold) {
-                    n.publish()
-                    messagePublished(uid)
-                }
-            }
-        }
-    }
-
-    /*! Removes a Notification.
-     *
-     * looks for the uid in the messages model, removes it if found
-     * This should destroy the object in the factory, which will delete the message
-     */
-    function removeNotification(uid) {
-        for (var i = 0; i<messages.count; i++) {
-            var o = messages.get(i);
-            if (o.mid === uid) messages.remove(i,1)
-        }
-    }
-
-    /*! Removes all Notifications and restarts the factory. */
-    function removeAll() {
-        factory.active = false;
-        messages.clear();
-        factory.countChanged.connect(function() {
-            if (!factory.active && (factory.count == 0)) factory.active = true;
-        })
-    }
-
-    Instantiator { id: factory
-        asynchronous: true
-        delegate: template
-        model: ListModel{}
-
-        // remove notifications from eventview on destruction
-        onObjectRemoved: function(idx, obj) {
-            obj.close()
-        }
-    }
-
-    Component { id: template; Notification {
-         property string internalId
-         category: "im.received"
-         appName: "Hydrogen"  // app name is not translated
-         appIcon: "image://theme/harbour-hydrogen"
-         //summary: "Notification summary"
-         //body: "Notification body"
-         //previewSummary: "Notification preview summary"
-         //previewBody: "Notification preview body"
-         //itemCount: 5
-         //timestamp: "2013-02-20 18:21:00"
-         remoteActions: [ {
-             // invoked when the user clicks the notification item
-             "name":     "default",
-             "displayName": qsTr("Open Conversation"),
-             "icon":     "icon-lock-chat",
-             "service":  "org.github.hydrogen-sailfishos.harbour-hydrogen.hydrogen",
-             "path":     "/hydrogen/ui",
-             "iface":    "org.github.HydrogenSailfishOS.Hydrogen.ui",
-             "method":   "fromNotification",
-             "arguments": [ internalId, replacesId ]
-         },
-         {
-             // invoked when the user clicks the app notification group
-             "name": "app",
-             "service":  "org.github.hydrogen-sailfishos.harbour-hydrogen.hydrogen",
-             "path":     "/hydrogen/ui",
-             "iface":    "org.github.HydrogenSailfishOS.Hydrogen.ui",
-             "method":   "activate",
-         } ]
-         onClicked: console.log("Clicked")
-         onClosed: console.log("Closed, reason: " + reason)
-     }}
-
-    /* ########## Internal testing stuff below ############# */
-
-    function runTests() { testItem.runTests() }
-    Item{ id: testItem
-        function runTests() {
-            var uid = Qt.md5(Math.random())
-            console.debug("Notification test started")
-            notifier.quickNumberedNotification( "Test Numbered Message", Math.floor(Math.random() * 25));
-            notifier.quickNotification( "Quick Test" )
-            notifier.addNotification( "Short Title", "Short Message",
-                "Added Title", "Added Message",
-                undefined,
-                uid,
-                false)
-            testTimer.uid = uid
-            testTimer.start()
-        }
-        Timer { id: testTimer
-            property string uid
-            repeat: false
-            onTriggered: {
-                console.debug("Notification test timer fired")
-                notifier.updateNotification(uid, {
-                    "summary":          "Updated Notification summary",
-                    "body":             "Updated Notification body",
-                    "previewSummary":   "Updated Notification preview summary",
-                    "previewBody":      "Updated Notification preview body",
-                })
-                uid = Qt.md5(Math.random())
-                // hold notification:
-                notifier.addNotification( "Hold Short Title", "Hold Short Message",
-                    "Hold Title", "Hold Message",
-                    undefined,
-                    uid,
-                    true)
-            testTimer2.uid = uid
-            testTimer2.start()
-            }
-        }
-        Timer { id: testTimer2
-            property string uid
-            interval: 2000
-            repeat: false
-            onTriggered: {
-                console.debug("Notification test timer 2 fired")
-                notifier.publishNotification(uid)
-            }
-        }
-    }
-}
diff --git a/qml/harbour-hydrogen.qml b/qml/harbour-hydrogen.qml
index d2000d3..04df865 100644
--- a/qml/harbour-hydrogen.qml
+++ b/qml/harbour-hydrogen.qml
@@ -11,28 +11,36 @@ import Sailfish.WebView 1.0
 import Sailfish.WebEngine 1.0
 import Nemo.DBus 2.0
 import Nemo.Configuration 1.0
+import Nemo.Notifications 1.0
 import io.thp.pyotherside 1.5
 import "cover"
-import "components"
 
 ApplicationWindow {
     id: app
     cover: Component { HydrogenCover {} }
 
     allowedOrientations: Orientation.All
-    property int notificationCount: 0
-    property int oldUnreadCount: 0
     property var openingArgument
     property bool isSettingsAvailable: true
+
+    property int notificationCount: 0
+    property int oldUnreadCount: 0
     onNotificationCountChanged: {
-        if (oldUnreadCount < notificationCount && Qt.application.state !== Qt.ApplicationActive) {
-            notifier.quickNumberedNotification( "New Messages", notificationCount )
+        if (oldUnreadCount < notificationCount && appConfig.showNotifications) {
+            var tryToBeSilent = Qt.application.state == Qt.ApplicationActive;
+            var message = notificationComponent.createObject(null, {
+                'previewSummary': tryToBeSilent ? null: qsTr("New hydrogen message."),
+                'isTransient': !appConfig.stickyNotifications,
+                'urgency': tryToBeSilent ? Notification.Low : Notification.Normal,
+                'itemCount': notificationCount,
+                'replacesId': appConfig.lastNotificationId
+            })
+            message.publish()
+            appConfig.lastNotificationId = message.replacesId
         }
         oldUnreadCount = notificationCount
     }
 
-    HydrogenNotifier { id: notifier }
-
     /* Array of objects: {name: "Name", count: 5}
 
        These messages will be shown on the cover with an optional
@@ -164,6 +172,35 @@ ApplicationWindow {
         }
     }
 
+    Component {
+        id: notificationComponent;
+        Notification {
+            appName: "Hydrogen"
+            appIcon: "image://theme/harbour-hydrogen"
+            summary: qsTr("New messages")
+            category: "im.received"
+            remoteActions: [
+                {
+                     // invoked when the user clicks the notification item
+                     "name":     "default",
+                     "displayName": qsTr("Open Conversation"),
+                     "icon":     "icon-lock-chat",
+                     "service":  dbuslistener.service,
+                     "path":     dbuslistener.path,
+                     "iface":    dbuslistener.iface,
+                     "method":   "fromNotification"
+                 },
+                 {
+                     // invoked when the user clicks the app notification group
+                     "name": "app",
+                     "service":  dbuslistener.service,
+                     "path":     dbuslistener.path,
+                     "iface":    dbuslistener.iface,
+                     "method":   "activate",
+                 }]
+        }
+    }
+
     // application settings:
     property alias appConfig: appConfig
     property alias wvConfig:  wvConfig
@@ -178,6 +215,7 @@ ApplicationWindow {
         property bool showNotifications: true
         property bool stickyNotifications: false
         property bool showFunFacts: true
+        property int lastNotificationId: 42
     }
     ConfigurationGroup  {
         id: wvConfig
diff --git a/qml/pages/AppSettingsPage.qml b/qml/pages/AppSettingsPage.qml
index 58aec4b..e0a09b6 100644
--- a/qml/pages/AppSettingsPage.qml
+++ b/qml/pages/AppSettingsPage.qml
@@ -41,9 +41,9 @@ Page {
                 enabled: notifysw.checked
                 checked: appConfig.stickyNotifications
                 text: qsTr("Sticky notifications")
-                description: qsTr("If enabled, the app will update a single " +
-                                  "notification (as opposed to sending a new " +
-                                  "one each time).")
+                description: qsTr("If enabled, when the app has a notification " +
+                                  "it will also be present in the events view. " +
+                                  "Otherwise it is transient.")
                 onClicked: appConfig.stickyNotifications =
                            !appConfig.stickyNotifications
             }