Feature remove_current in notification queues

Author: FelipeFTN

docs/dunst.5.pod

@@ -596,7 +596,7 @@ B<Defaults:>
 
 =item * C<mouse_left_click=close_current>
 
-=item * C<mouse_middle_click=do_action, close_current>
+=item * C<mouse_middle_click=do_action, remove_current>
 
 =item * C<mouse_right_click=close_all>
 

dunstrc

@@ -320,13 +320,14 @@
     # * open_url: If the notification has exactly one url, open it. If there are multiple
     #             ones, open the context menu.
     # * close_current: Close current notification.
+    # * remove_current: Remove current notification from history.
     # * close_all: Close all notifications.
     # * context: Open context menu for the notification.
     # * context_all: Open context menu for all notifications.
     # These values can be strung together for each mouse event, and
     # will be executed in sequence.
     mouse_left_click = close_current
-    mouse_middle_click = do_action, close_current
+    mouse_middle_click = do_action, remove_current
     mouse_right_click = close_all
 
 # Experimental features that may or may not work correctly. Do not expect them

src/dbus.c

@@ -1117,6 +1117,63 @@ void signal_notification_closed(struct notification *n, enum reason reason)
         }
 }
 
+void signal_notification_removed(struct notification *n, enum reason reason)
+{
+        if (!n->dbus_valid) {
+                LOG_W("Removing notification with reason '%d' not supported. "
+                      "Notification already closed.", reason);
+                return;
+        }
+
+        if (reason < REASON_MIN || REASON_MAX < reason) {
+                LOG_W("Removing notification with reason '%d' not supported. "
+                      "Closing it with reason '%d'.", reason, REASON_UNDEF);
+                reason = REASON_UNDEF;
+        }
+
+        if (!dbus_conn) {
+                LOG_E("Unable to remove notification: No DBus connection.");
+        }
+
+        GVariant *body = g_variant_new("(uu)", n->id, reason);
+        GError *err = NULL;
+
+        g_dbus_connection_emit_signal(dbus_conn,
+                                      n->dbus_client,
+                                      FDN_PATH,
+                                      FDN_IFAC,
+                                      "NotificationRemoved",
+                                      body,
+                                      &err);
+
+        notification_invalidate_actions(n);
+
+        if (err) {
+                LOG_W("Unable to remove notification: %s", err->message);
+                g_error_free(err);
+        } else {
+                char* reason_string;
+                switch (reason) {
+                        case REASON_TIME:
+                                reason_string="time";
+                                break;
+                        case REASON_USER:
+                                reason_string="user";
+                                break;
+                        case REASON_SIG:
+                                reason_string="signal";
+                                break;
+                        case REASON_UNDEF:
+                                reason_string="undefined";
+                                break;
+                        default:
+                                reason_string="unknown";
+                }
+
+                LOG_D("Queues: Removing notification for reason: %s", reason_string);
+        }
+}
+
 void signal_action_invoked(const struct notification *n, const char *identifier)
 {
         if (!n->dbus_valid) {

src/dbus.h

@@ -19,6 +19,7 @@ enum reason {
 int dbus_init(void);
 void dbus_teardown(int id);
 void signal_notification_closed(struct notification *n, enum reason reason);
+void signal_notification_removed(struct notification *n, enum reason reason);
 void signal_action_invoked(const struct notification *n, const char *identifier);
 void signal_length_propertieschanged(void);
 void signal_history_removed(guint id);

src/input.c

@@ -97,7 +97,7 @@ void input_handle_click(unsigned int button, bool button_down, int mouse_x, int
                         continue;
                 }
 
-                if (act == MOUSE_DO_ACTION || act == MOUSE_CLOSE_CURRENT || act == MOUSE_CONTEXT || act == MOUSE_OPEN_URL) {
+                if (act == MOUSE_DO_ACTION || act == MOUSE_CLOSE_CURRENT || act == MOUSE_REMOVE_CURRENT || act == MOUSE_CONTEXT || act == MOUSE_OPEN_URL) {
                         struct notification *n = get_notification_at(mouse_y);
 
                         if (n) {
@@ -107,6 +107,8 @@ void input_handle_click(unsigned int button, bool button_down, int mouse_x, int
                                         notification_do_action(n);
                                 } else if (act == MOUSE_OPEN_URL) {
                                         notification_open_url(n);
+                                } else if (act == MOUSE_REMOVE_CURRENT) {
+                                        n->marked_for_removal = REASON_USER;
                                 } else {
                                         notification_open_context_menu(n);
                                 }

src/menu.c

@@ -355,6 +355,14 @@ static gboolean context_menu_result_dispatch(gpointer user_data)
                                 queues_notification_close(n, n->marked_for_closure);
                         n->marked_for_closure = 0;
                 }
+
+                // If the notification was marked for removal, remove it from history
+                if (n->marked_for_removal) {
+                        // Don't close notification if context was aborted
+                        // if (dmenu_output != NULL)
+                        queues_notification_remove(n, n->marked_for_removal);
+                        n->marked_for_removal = 0;
+                }
         }
 
         menu_ctx.locked_notifications = NULL;

src/notification.h

@@ -106,6 +106,7 @@ struct notification {
         enum behavior_fullscreen fullscreen; //!< The instruction what to do with it, when desktop enters fullscreen
         bool script_run;        /**< Has the script been executed already? */
         guint8 marked_for_closure;
+        guint8 marked_for_removal; /**< If set, the notification is marked for removal in history */
         bool word_wrap;
         PangoEllipsizeMode ellipsize;
         PangoAlignment alignment;

src/queues.c

@@ -341,13 +341,39 @@ void queues_notification_close_id(gint id, enum reason reason)
         }
 }
 
+void queues_notification_remove_id(gint id, enum reason reason)
+{
+        struct notification *target = NULL;
+
+        GQueue *allqueues[] = { displayed, waiting, history };
+        for (size_t i = 0; i < sizeof(allqueues)/sizeof(GQueue*); i++) {
+                for (GList *iter = g_queue_peek_head_link(allqueues[i]); iter;
+                     iter = iter->next) {
+                        struct notification *n = iter->data;
+                        if (n->id == id) {
+                                g_queue_remove(allqueues[i], n);
+                                target = n;
+                                break;
+                        }
+                }
+        }
+        if (target)
+                signal_notification_removed(target, reason);
+}
+
 /* see queues.h */
 void queues_notification_close(struct notification *n, enum reason reason)
 {
         assert(n != NULL);
         queues_notification_close_id(n->id, reason);
 }
 
+void queues_notification_remove(struct notification *n, enum reason reason)
+{
+        assert(n != NULL);
+        queues_notification_remove_id(n->id, reason);
+}
+
 static void queues_destroy_notification(struct notification *n, gpointer user_data)
 {
         (void)user_data;
@@ -480,6 +506,13 @@ void queues_update(struct dunst_status status, gint64 time)
                         continue;
                 }
 
+                if (n->marked_for_removal) {
+                        queues_notification_remove(n, n->marked_for_removal);
+                        n->marked_for_removal = 0;
+                        iter = nextiter;
+                        continue;
+                }
+
 
                 if (queues_notification_is_finished(n, status, time)) {
                         queues_notification_close(n, REASON_TIME);

src/queues.h

@@ -104,9 +104,32 @@ void queues_notification_close_id(gint id, enum reason reason);
  *
  * @param n (transfer full) The notification to close
  * @param reason The #reason to close
- * */
+ */
 void queues_notification_close(struct notification *n, enum reason reason);
 
+/**
+ * Remove the given notification from all queues
+ *
+ * Sends a signal and removes the selected notification from all queues.
+ *
+ * @param n (transfer full) The notification to remove
+ * @param reason The #reason to remove
+ */
+void queues_notification_remove(struct notification *n, enum reason reason);
+
+/**
+ * Remove the notification that has n->id == id
+ *
+ * Sends a signal and removes the selected notification from all queues.
+ *
+ * @param id The id of the notification to remove
+ * @param reason The #reason to remove
+ *
+ * @post Call wake_up() to synchronize the queues with the UI
+ *       (which closes the notification on screen)
+ */
+void queues_notification_remove_id(gint id, enum reason reason);
+
 /**
  * Removes all notifications from history
  * Returns the number of removed notifications

src/settings.h

@@ -33,7 +33,7 @@ enum sort_type { SORT_TYPE_ID, SORT_TYPE_URGENCY_ASCENDING, SORT_TYPE_URGENCY_DE
 enum vertical_alignment { VERTICAL_TOP, VERTICAL_CENTER, VERTICAL_BOTTOM };
 enum separator_color { SEP_FOREGROUND, SEP_AUTO, SEP_FRAME, SEP_CUSTOM };
 enum follow_mode { FOLLOW_NONE, FOLLOW_MOUSE, FOLLOW_KEYBOARD };
-enum mouse_action { MOUSE_NONE, MOUSE_DO_ACTION, MOUSE_CLOSE_CURRENT,
+enum mouse_action { MOUSE_NONE, MOUSE_DO_ACTION, MOUSE_CLOSE_CURRENT, MOUSE_REMOVE_CURRENT,
         MOUSE_CLOSE_ALL, MOUSE_CONTEXT, MOUSE_CONTEXT_ALL, MOUSE_OPEN_URL,
         MOUSE_ACTION_END = LIST_END /* indicates the end of a list of mouse actions */};
 #ifndef ZWLR_LAYER_SHELL_V1_LAYER_ENUM