Allow to specify notification's hints

Desktop Notifications Specification [1] specifies that hints can be
used to provide extra data to a notification server.

A new command line option --hint allows to add a hint to the
notification to display.
This option can be used multiple times, one for each hint to add.
--hint option format is name:value.

The new 'hints' command allow to specify hints in 'listen' mode.
Same format that in the command line option is used.
Several hints can be passed by separating them by '\n'.

Hints of value type '(iiibiiay)' are not supported.
This value type is used to pass a raw data image as a hint value.

This new change is useful for implementing the NotificationSource [2]
GNOME Goal.
A application using zenity and having a desktop file, can now specify
that it is a notification emitter and it's notifications can be
filtered in the new Notifications GNOME control panel pane.

[1] http://people.gnome.org/~mccann/docs/notification-spec/notification-spec-latest.html#hints
[2] https://live.gnome.org/GnomeGoals/NotificationSource

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

3 files changed, 148 insertions, 0 deletions

diff --git a/src/notification.c b/src/notification.c
index 0a36e09e..3a552026 100644
--- a/src/notification.c
+++ b/src/notification.c
@@ -35,7 +35,10 @@
 #include "zenity.h"
 #include "util.h"
 
+#define MAX_HINTS 16
+
 static char *icon_file;
+static GHashTable *notification_hints;
 
 static void
 on_notification_default_action (NotifyNotification *n,
@@ -52,6 +55,117 @@ on_notification_default_action (NotifyNotification *n,
   gtk_main_quit ();
 }
 
+static GHashTable *
+zenity_notification_parse_hints_array (gchar **hints)
+{
+  GHashTable *result;
+  gchar** pair;
+  int i;
+
+  result = g_hash_table_new_full (g_str_hash,
+                                  g_str_equal,
+                                  g_free,
+                                  g_free);
+
+  for(i = 0; i < g_strv_length (hints); i++) {
+    pair = g_strsplit (hints[i], ":", 2);
+    g_hash_table_replace (result, g_strdup (pair[0]), g_strdup (pair[1]));
+    g_strfreev (pair);
+  }
+  if (g_hash_table_size (result) == 0) {
+    g_hash_table_unref (result);
+    return NULL;
+  } else {
+    return result;
+  }
+}
+
+static GHashTable *
+zenity_notification_parse_hints (gchar *hints)
+{
+  GHashTable *result;
+  gchar** hint_array;
+
+  hint_array = g_strsplit (g_strcompress (hints), "\n", MAX_HINTS);
+  result = zenity_notification_parse_hints_array (hint_array);
+  g_strfreev (hint_array);
+  return result;
+}
+
+static void
+zenity_notification_set_hint(gpointer key, gpointer value, gpointer user_data)
+{
+  NotifyNotification *notification;
+  gchar *hint_name;
+  GVariant *hint_value;
+
+  gchar *string_value;
+  gboolean boolean_value;
+  gint32 int_value;
+  guchar byte_value;
+
+  hint_name = (gchar *) key;
+  string_value = (gchar *) value;
+  notification = (NotifyNotification *) user_data;
+
+  if ((g_ascii_strcasecmp ("action-icons", hint_name) == 0)
+      || (g_ascii_strcasecmp ("resident", hint_name) == 0)
+      || (g_ascii_strcasecmp ("suppress-sound", hint_name) == 0)
+      || (g_ascii_strcasecmp ("transient", hint_name) == 0)) {
+    /* boolean hints */
+    if (g_ascii_strcasecmp ("true", string_value) == 0) {
+      boolean_value = TRUE;
+    } else if (g_ascii_strcasecmp ("false", string_value) == 0) {
+      boolean_value = FALSE;
+    } else {
+      g_printerr (_("Invalid value for a boolean typed hint.\nSupported values are 'true' or 'false'.\n"));
+      return;
+    }
+    hint_value = g_variant_new_boolean (boolean_value);
+  } else if ((g_ascii_strcasecmp ("category", hint_name) == 0)
+             || (g_ascii_strcasecmp ("desktop-entry", hint_name) == 0)
+             || (g_ascii_strcasecmp ("image-path", hint_name) == 0)
+             || (g_ascii_strcasecmp ("image_path", hint_name) == 0)
+             || (g_ascii_strcasecmp ("sound-file", hint_name) == 0)
+             || (g_ascii_strcasecmp ("sound-name", hint_name) == 0)) {
+    /* string hints */
+    hint_value = g_variant_new_string (string_value);
+  } else if ((g_ascii_strcasecmp ("image-data", hint_name) == 0)
+             || (g_ascii_strcasecmp ("image_data", hint_name) == 0)
+             || (g_ascii_strcasecmp ("icon-data", hint_name) == 0)) {
+    /* (iibiiay) */
+    g_printerr (_("Unsupported hint. Skipping.\n"));
+    return;
+  } else if ((g_ascii_strcasecmp ("x", hint_name) == 0)
+             || (g_ascii_strcasecmp ("y", hint_name) == 0)) {
+    /* int hints */
+    int_value = (gint32) g_ascii_strtoll (string_value, NULL, 0);
+    hint_value = g_variant_new_int32 (int_value);
+  } else if ((g_ascii_strcasecmp ("urgency", hint_name) == 0)) {
+    /* byte hints */
+    byte_value = (guchar) g_ascii_strtoll (string_value, NULL, 0);
+    hint_value = g_variant_new_byte (byte_value);
+  } else {
+    /* unknown hints */
+    g_printerr (_("Unknown hint name. Skipping.\n"));
+    return;
+  }
+
+  notify_notification_set_hint (notification,
+                                hint_name,
+                                hint_value);
+}
+
+static void
+zenity_notification_set_hints (NotifyNotification *notification, GHashTable *hints)
+{
+  if (hints == NULL) {
+    return;
+  }
+
+  g_hash_table_foreach (hints, zenity_notification_set_hint, notification);
+}
+
 static gboolean
 zenity_notification_handle_stdin (GIOChannel *channel,
 				  GIOCondition condition,
@@ -104,6 +218,11 @@ zenity_notification_handle_stdin (GIOChannel *channel,
       if (!g_ascii_strcasecmp (command, "icon")) {
         g_free (icon_file);
         icon_file = g_strdup (value);
+      } else if (!g_ascii_strcasecmp (command, "hints")) {
+        if (notification_hints != NULL) {
+          g_hash_table_unref (notification_hints);
+        }
+        notification_hints = zenity_notification_parse_hints (value);
       } else if (!g_ascii_strcasecmp (command, "message")) {
         /* display a notification bubble */
         if (!g_utf8_validate (value, -1, NULL)) {
@@ -129,6 +248,8 @@ zenity_notification_handle_stdin (GIOChannel *channel,
 
           g_strfreev (message);
 
+          zenity_notification_set_hints (notif, notification_hints);
+
           notify_notification_show (notif, &error);
           if (error) {
             g_warning ("Error showing notification: %s", error->message);
@@ -147,6 +268,9 @@ zenity_notification_handle_stdin (GIOChannel *channel,
           notif = notify_notification_new (value,
                                            NULL,
                                            icon_file);
+
+          zenity_notification_set_hints (notif, notification_hints);
+
           notify_notification_show (notif, &error);
           if (error) {
             g_warning ("Error showing notification: %s", error->message);
@@ -192,6 +316,7 @@ zenity_notification (ZenityData *data, ZenityNotificationData *notification_data
 {
   GError *error;
   NotifyNotification *notification;
+  GHashTable *notification_hints;
 
   /* create the notification widget */
   if (!notify_is_initted ()) {
@@ -218,6 +343,11 @@ zenity_notification (ZenityData *data, ZenityNotificationData *notification_data
                                     data,
                                     NULL);
 
+    /* set the notification hints for the displayed notification */
+    notification_hints = zenity_notification_parse_hints_array (notification_data->notification_hints);
+    zenity_notification_set_hints(notification, notification_hints);
+    g_hash_table_unref (notification_hints);
+
     /* Show icon and wait */
     error = NULL;
     if (!notify_notification_show (notification, &error)) {
@@ -236,4 +366,5 @@ zenity_notification (ZenityData *data, ZenityNotificationData *notification_data
 
   gtk_main ();
 }
+
 #endif
diff --git a/src/option.c b/src/option.c
index 13275d1c..2ca9f1d7 100644
--- a/src/option.c
+++ b/src/option.c
@@ -86,6 +86,7 @@ static gboolean zenity_list_imagelist;
 /* Notification Dialog Options */
 static gboolean zenity_notification_active;
 static gboolean zenity_notification_listen;
+static gchar  **zenity_notification_hints;
 #endif
 
 /* Progress Dialog Options */
@@ -652,6 +653,15 @@ static GOptionEntry notification_options[] = {
     N_("Listen for commands on stdin"),
     NULL
   },
+  {
+    "hint",
+    '\0',
+    G_OPTION_FLAG_NOALIAS,
+    G_OPTION_ARG_STRING_ARRAY,
+    &zenity_notification_hints,
+    N_("Set the notification hints"),
+    N_("TEXT")
+  },
   { 
     NULL 
   }
@@ -1243,6 +1253,11 @@ zenity_option_free (void) {
   if (zenity_list_hide_column)
     g_free (zenity_list_hide_column);
 
+#ifdef HAVE_LIBNOTIFY
+  if (zenity_notification_hints)
+    g_strfreev (zenity_notification_hints);
+#endif
+
   if (zenity_text_font)
     g_free (zenity_text_font);
   if (zenity_text_checkbox)
@@ -1801,6 +1816,7 @@ zenity_notification_post_callback (GOptionContext *context,
   if (results->mode == MODE_NOTIFICATION) {
     results->notification_data->notification_text = zenity_general_dialog_text;
     results->notification_data->listen = zenity_notification_listen;
+    results->notification_data->notification_hints = zenity_notification_hints;
   } else {
     if (zenity_notification_listen)
       zenity_option_error (zenity_option_get_name (notification_options, &zenity_notification_listen),
diff --git a/src/zenity.h b/src/zenity.h
index 4c941290..7018800f 100644
--- a/src/zenity.h
+++ b/src/zenity.h
@@ -136,6 +136,7 @@ typedef struct {
 typedef struct {
   gchar   *notification_text;
   gboolean listen;
+  gchar  **notification_hints;
 } ZenityNotificationData;
 #endif