Blame gio/gfdonotificationbackend.c

Packit ae235b
/*
Packit ae235b
 * Copyright © 2013 Lars Uebernickel
Packit ae235b
 *
Packit ae235b
 * This library is free software; you can redistribute it and/or
Packit ae235b
 * modify it under the terms of the GNU Lesser General Public
Packit ae235b
 * License as published by the Free Software Foundation; either
Packit ae235b
 * version 2.1 of the License, or (at your option) any later version.
Packit ae235b
 *
Packit ae235b
 * This library is distributed in the hope that it will be useful,
Packit ae235b
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
Packit ae235b
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
Packit ae235b
 * Lesser General Public License for more details.
Packit ae235b
 *
Packit ae235b
 * You should have received a copy of the GNU Lesser General
Packit ae235b
 * Public License along with this library; if not, see <http://www.gnu.org/licenses/>.
Packit ae235b
 *
Packit ae235b
 * Authors: Lars Uebernickel <lars@uebernic.de>
Packit ae235b
 */
Packit ae235b
Packit ae235b
#include "config.h"
Packit ae235b
Packit ae235b
#include "gnotificationbackend.h"
Packit ae235b
Packit ae235b
#include "gapplication.h"
Packit ae235b
#include "giomodule-priv.h"
Packit ae235b
#include "gnotification-private.h"
Packit ae235b
#include "gdbusconnection.h"
Packit ae235b
#include "gactiongroup.h"
Packit ae235b
#include "gaction.h"
Packit ae235b
#include "gthemedicon.h"
Packit ae235b
#include "gfileicon.h"
Packit ae235b
#include "gfile.h"
Packit ae235b
#include "gdbusutils.h"
Packit ae235b
Packit ae235b
#define G_TYPE_FDO_NOTIFICATION_BACKEND  (g_fdo_notification_backend_get_type ())
Packit ae235b
#define G_FDO_NOTIFICATION_BACKEND(o)    (G_TYPE_CHECK_INSTANCE_CAST ((o), G_TYPE_FDO_NOTIFICATION_BACKEND, GFdoNotificationBackend))
Packit ae235b
Packit ae235b
typedef struct _GFdoNotificationBackend GFdoNotificationBackend;
Packit ae235b
typedef GNotificationBackendClass       GFdoNotificationBackendClass;
Packit ae235b
Packit ae235b
struct _GFdoNotificationBackend
Packit ae235b
{
Packit ae235b
  GNotificationBackend parent;
Packit ae235b
Packit ae235b
  guint   notify_subscription;
Packit ae235b
  GSList *notifications;
Packit ae235b
};
Packit ae235b
Packit ae235b
GType g_fdo_notification_backend_get_type (void);
Packit ae235b
Packit ae235b
G_DEFINE_TYPE_WITH_CODE (GFdoNotificationBackend, g_fdo_notification_backend, G_TYPE_NOTIFICATION_BACKEND,
Packit ae235b
  _g_io_modules_ensure_extension_points_registered ();
Packit ae235b
  g_io_extension_point_implement (G_NOTIFICATION_BACKEND_EXTENSION_POINT_NAME,
Packit ae235b
                                 g_define_type_id, "freedesktop", 0))
Packit ae235b
Packit ae235b
typedef struct
Packit ae235b
{
Packit ae235b
  GFdoNotificationBackend *backend;
Packit ae235b
  gchar *id;
Packit ae235b
  guint32 notify_id;
Packit ae235b
  gchar *default_action;
Packit ae235b
  GVariant *default_action_target;
Packit ae235b
} FreedesktopNotification;
Packit ae235b
Packit ae235b
Packit ae235b
static void
Packit ae235b
freedesktop_notification_free (gpointer data)
Packit ae235b
{
Packit ae235b
  FreedesktopNotification *n = data;
Packit ae235b
Packit ae235b
  g_free (n->id);
Packit ae235b
  g_free (n->default_action);
Packit ae235b
  if (n->default_action_target)
Packit ae235b
    g_variant_unref (n->default_action_target);
Packit ae235b
Packit ae235b
  g_slice_free (FreedesktopNotification, n);
Packit ae235b
}
Packit ae235b
Packit ae235b
static FreedesktopNotification *
Packit ae235b
g_fdo_notification_backend_find_notification (GFdoNotificationBackend *backend,
Packit ae235b
                                              const gchar             *id)
Packit ae235b
{
Packit ae235b
  GSList *it;
Packit ae235b
Packit ae235b
  for (it = backend->notifications; it != NULL; it = it->next)
Packit ae235b
    {
Packit ae235b
      FreedesktopNotification *n = it->data;
Packit ae235b
      if (g_str_equal (n->id, id))
Packit ae235b
        return n;
Packit ae235b
    }
Packit ae235b
Packit ae235b
  return NULL;
Packit ae235b
}
Packit ae235b
Packit ae235b
static FreedesktopNotification *
Packit ae235b
g_fdo_notification_backend_find_notification_by_notify_id (GFdoNotificationBackend *backend,
Packit ae235b
                                                           guint32                  id)
Packit ae235b
{
Packit ae235b
  GSList *it;
Packit ae235b
Packit ae235b
  for (it = backend->notifications; it != NULL; it = it->next)
Packit ae235b
    {
Packit ae235b
      FreedesktopNotification *n = it->data;
Packit ae235b
      if (n->notify_id == id)
Packit ae235b
        return n;
Packit ae235b
    }
Packit ae235b
Packit ae235b
  return NULL;
Packit ae235b
}
Packit ae235b
Packit ae235b
static void
Packit ae235b
activate_action (GFdoNotificationBackend *backend,
Packit ae235b
                 const gchar             *name,
Packit ae235b
                 GVariant                *parameter)
Packit ae235b
{
Packit ae235b
  GNotificationBackend *g_backend = G_NOTIFICATION_BACKEND (backend);
Packit ae235b
Packit ae235b
  if (name)
Packit ae235b
    {
Packit ae235b
      if (g_str_has_prefix (name, "app."))
Packit ae235b
        g_action_group_activate_action (G_ACTION_GROUP (g_backend->application), name + 4, parameter);
Packit ae235b
    }
Packit ae235b
  else
Packit ae235b
    {
Packit ae235b
      g_application_activate (g_backend->application);
Packit ae235b
    }
Packit ae235b
}
Packit ae235b
Packit ae235b
static void
Packit ae235b
notify_signal (GDBusConnection *connection,
Packit ae235b
               const gchar     *sender_name,
Packit ae235b
               const gchar     *object_path,
Packit ae235b
               const gchar     *interface_name,
Packit ae235b
               const gchar     *signal_name,
Packit ae235b
               GVariant        *parameters,
Packit ae235b
               gpointer         user_data)
Packit ae235b
{
Packit ae235b
  GFdoNotificationBackend *backend = user_data;
Packit ae235b
  guint32 id = 0;
Packit ae235b
  const gchar *action = NULL;
Packit ae235b
  FreedesktopNotification *n;
Packit ae235b
Packit ae235b
  if (g_str_equal (signal_name, "NotificationClosed") &&
Packit ae235b
      g_variant_is_of_type (parameters, G_VARIANT_TYPE ("(uu)")))
Packit ae235b
    {
Packit ae235b
      g_variant_get (parameters, "(uu)", &id, NULL);
Packit ae235b
    }
Packit ae235b
  else if (g_str_equal (signal_name, "ActionInvoked") &&
Packit ae235b
           g_variant_is_of_type (parameters, G_VARIANT_TYPE ("(us)")))
Packit ae235b
    {
Packit ae235b
      g_variant_get (parameters, "(u&s)", &id, &action);
Packit ae235b
    }
Packit ae235b
  else
Packit ae235b
    return;
Packit ae235b
Packit ae235b
  n = g_fdo_notification_backend_find_notification_by_notify_id (backend, id);
Packit ae235b
  if (n == NULL)
Packit ae235b
    return;
Packit ae235b
Packit ae235b
  if (action)
Packit ae235b
    {
Packit ae235b
      if (g_str_equal (action, "default"))
Packit ae235b
        {
Packit ae235b
          activate_action (backend, n->default_action, n->default_action_target);
Packit ae235b
        }
Packit ae235b
      else
Packit ae235b
        {
Packit ae235b
          gchar *name;
Packit ae235b
          GVariant *target;
Packit ae235b
Packit ae235b
          if (g_action_parse_detailed_name (action, &name, &target, NULL))
Packit ae235b
            {
Packit ae235b
              activate_action (backend, name, target);
Packit ae235b
              g_free (name);
Packit ae235b
              if (target)
Packit ae235b
                g_variant_unref (target);
Packit ae235b
            }
Packit ae235b
        }
Packit ae235b
    }
Packit ae235b
Packit ae235b
  /* Get the notification again in case the action redrew it */
Packit ae235b
  n = g_fdo_notification_backend_find_notification_by_notify_id (backend, id);
Packit ae235b
  if (n != NULL)
Packit ae235b
    {
Packit ae235b
      backend->notifications = g_slist_remove (backend->notifications, n);
Packit ae235b
      freedesktop_notification_free (n);
Packit ae235b
    }
Packit ae235b
}
Packit ae235b
Packit ae235b
/* Converts a GNotificationPriority to an urgency level as defined by
Packit ae235b
 * the freedesktop spec (0: low, 1: normal, 2: critical).
Packit ae235b
 */
Packit ae235b
static guchar
Packit ae235b
urgency_from_priority (GNotificationPriority priority)
Packit ae235b
{
Packit ae235b
  switch (priority)
Packit ae235b
    {
Packit ae235b
    case G_NOTIFICATION_PRIORITY_LOW:
Packit ae235b
      return 0;
Packit ae235b
Packit ae235b
    default:
Packit ae235b
    case G_NOTIFICATION_PRIORITY_NORMAL:
Packit ae235b
    case G_NOTIFICATION_PRIORITY_HIGH:
Packit ae235b
      return 1;
Packit ae235b
Packit ae235b
    case G_NOTIFICATION_PRIORITY_URGENT:
Packit ae235b
      return 2;
Packit ae235b
    }
Packit ae235b
}
Packit ae235b
Packit ae235b
static void
Packit ae235b
call_notify (GDBusConnection     *con,
Packit ae235b
             GApplication        *app,
Packit ae235b
             guint32              replace_id,
Packit ae235b
             GNotification       *notification,
Packit ae235b
             GAsyncReadyCallback  callback,
Packit ae235b
             gpointer             user_data)
Packit ae235b
{
Packit ae235b
  GVariantBuilder action_builder;
Packit ae235b
  guint n_buttons;
Packit ae235b
  guint i;
Packit ae235b
  GVariantBuilder hints_builder;
Packit ae235b
  GIcon *icon;
Packit ae235b
  GVariant *parameters;
Packit ae235b
  const gchar *body;
Packit ae235b
  guchar urgency;
Packit ae235b
Packit ae235b
  g_variant_builder_init (&action_builder, G_VARIANT_TYPE_STRING_ARRAY);
Packit ae235b
  if (g_notification_get_default_action (notification, NULL, NULL))
Packit ae235b
    {
Packit ae235b
      g_variant_builder_add (&action_builder, "s", "default");
Packit ae235b
      g_variant_builder_add (&action_builder, "s", "");
Packit ae235b
    }
Packit ae235b
Packit ae235b
  n_buttons = g_notification_get_n_buttons (notification);
Packit ae235b
  for (i = 0; i < n_buttons; i++)
Packit ae235b
    {
Packit ae235b
      gchar *label;
Packit ae235b
      gchar *action;
Packit ae235b
      GVariant *target;
Packit ae235b
      gchar *detailed_name;
Packit ae235b
Packit ae235b
      g_notification_get_button (notification, i, &label, &action, &target);
Packit ae235b
      detailed_name = g_action_print_detailed_name (action, target);
Packit ae235b
Packit ae235b
      /* Actions named 'default' collide with libnotify's naming of the
Packit ae235b
       * default action. Rewriting them to something unique is enough,
Packit ae235b
       * because those actions can never be activated (they aren't
Packit ae235b
       * prefixed with 'app.').
Packit ae235b
       */
Packit ae235b
      if (g_str_equal (detailed_name, "default"))
Packit ae235b
        {
Packit ae235b
          g_free (detailed_name);
Packit ae235b
          detailed_name = g_dbus_generate_guid ();
Packit ae235b
        }
Packit ae235b
Packit ae235b
      g_variant_builder_add_value (&action_builder, g_variant_new_take_string (detailed_name));
Packit ae235b
      g_variant_builder_add_value (&action_builder, g_variant_new_take_string (label));
Packit ae235b
Packit ae235b
      g_free (action);
Packit ae235b
      if (target)
Packit ae235b
        g_variant_unref (target);
Packit ae235b
    }
Packit ae235b
Packit ae235b
  g_variant_builder_init (&hints_builder, G_VARIANT_TYPE ("a{sv}"));
Packit ae235b
  g_variant_builder_add (&hints_builder, "{sv}", "desktop-entry",
Packit ae235b
                         g_variant_new_string (g_application_get_application_id (app)));
Packit ae235b
  urgency = urgency_from_priority (g_notification_get_priority (notification));
Packit ae235b
  g_variant_builder_add (&hints_builder, "{sv}", "urgency", g_variant_new_byte (urgency));
Packit ae235b
  icon = g_notification_get_icon (notification);
Packit ae235b
  if (icon != NULL)
Packit ae235b
    {
Packit ae235b
      if (G_IS_FILE_ICON (icon))
Packit ae235b
        {
Packit ae235b
           GFile *file;
Packit ae235b
Packit ae235b
           file = g_file_icon_get_file (G_FILE_ICON (icon));
Packit ae235b
           g_variant_builder_add (&hints_builder, "{sv}", "image-path",
Packit ae235b
                                  g_variant_new_take_string (g_file_get_path (file)));
Packit ae235b
        }
Packit ae235b
      else if (G_IS_THEMED_ICON (icon))
Packit ae235b
        {
Packit ae235b
           const gchar* const* icon_names = g_themed_icon_get_names(G_THEMED_ICON (icon));
Packit ae235b
           /* Take first name from GThemedIcon */
Packit ae235b
           g_variant_builder_add (&hints_builder, "{sv}", "image-path",
Packit ae235b
                                  g_variant_new_string (icon_names[0]));
Packit ae235b
        }
Packit ae235b
    }
Packit ae235b
Packit ae235b
  body = g_notification_get_body (notification);
Packit ae235b
Packit ae235b
  parameters = g_variant_new ("(susssasa{sv}i)",
Packit ae235b
                              "",           /* app name */
Packit ae235b
                              replace_id,
Packit ae235b
                              "",           /* app icon */
Packit ae235b
                              g_notification_get_title (notification),
Packit ae235b
                              body ? body : "",
Packit ae235b
                              &action_builder,
Packit ae235b
                              &hints_builder,
Packit ae235b
                              -1);          /* expire_timeout */
Packit ae235b
Packit ae235b
  g_dbus_connection_call (con, "org.freedesktop.Notifications", "/org/freedesktop/Notifications",
Packit ae235b
                          "org.freedesktop.Notifications", "Notify",
Packit ae235b
                          parameters, G_VARIANT_TYPE ("(u)"),
Packit ae235b
                          G_DBUS_CALL_FLAGS_NONE, -1, NULL,
Packit ae235b
                          callback, user_data);
Packit ae235b
}
Packit ae235b
Packit ae235b
static void
Packit ae235b
notification_sent (GObject      *source_object,
Packit ae235b
                   GAsyncResult *result,
Packit ae235b
                   gpointer      user_data)
Packit ae235b
{
Packit ae235b
  FreedesktopNotification *n = user_data;
Packit ae235b
  GVariant *val;
Packit ae235b
  GError *error = NULL;
Packit ae235b
  static gboolean warning_printed = FALSE;
Packit ae235b
Packit ae235b
  val = g_dbus_connection_call_finish (G_DBUS_CONNECTION (source_object), result, &error);
Packit ae235b
  if (val)
Packit ae235b
    {
Packit ae235b
      g_variant_get (val, "(u)", &n->notify_id);
Packit ae235b
      g_variant_unref (val);
Packit ae235b
    }
Packit ae235b
  else
Packit ae235b
    {
Packit ae235b
      if (!warning_printed)
Packit ae235b
        {
Packit ae235b
          g_warning ("unable to send notifications through org.freedesktop.Notifications: %s",
Packit ae235b
                     error->message);
Packit ae235b
          warning_printed = TRUE;
Packit ae235b
        }
Packit ae235b
Packit ae235b
      n->backend->notifications = g_slist_remove (n->backend->notifications, n);
Packit ae235b
      freedesktop_notification_free (n);
Packit ae235b
Packit ae235b
      g_error_free (error);
Packit ae235b
    }
Packit ae235b
}
Packit ae235b
Packit ae235b
static void
Packit ae235b
g_fdo_notification_backend_dispose (GObject *object)
Packit ae235b
{
Packit ae235b
  GFdoNotificationBackend *backend = G_FDO_NOTIFICATION_BACKEND (object);
Packit ae235b
Packit ae235b
  if (backend->notify_subscription)
Packit ae235b
    {
Packit ae235b
      GDBusConnection *session_bus;
Packit ae235b
Packit ae235b
      session_bus = G_NOTIFICATION_BACKEND (backend)->dbus_connection;
Packit ae235b
      g_dbus_connection_signal_unsubscribe (session_bus, backend->notify_subscription);
Packit ae235b
      backend->notify_subscription = 0;
Packit ae235b
    }
Packit ae235b
Packit ae235b
  if (backend->notifications)
Packit ae235b
    {
Packit ae235b
      g_slist_free_full (backend->notifications, freedesktop_notification_free);
Packit ae235b
      backend->notifications = NULL;
Packit ae235b
    }
Packit ae235b
Packit ae235b
  G_OBJECT_CLASS (g_fdo_notification_backend_parent_class)->dispose (object);
Packit ae235b
}
Packit ae235b
Packit ae235b
static gboolean
Packit ae235b
g_fdo_notification_backend_is_supported (void)
Packit ae235b
{
Packit ae235b
  /* This is the fallback backend with the lowest priority. To avoid an
Packit ae235b
   * unnecessary synchronous dbus call to check for
Packit ae235b
   * org.freedesktop.Notifications, this function always succeeds. A
Packit ae235b
   * warning will be printed when sending the first notification fails.
Packit ae235b
   */
Packit ae235b
  return TRUE;
Packit ae235b
}
Packit ae235b
Packit ae235b
static void
Packit ae235b
g_fdo_notification_backend_send_notification (GNotificationBackend *backend,
Packit ae235b
                                              const gchar          *id,
Packit ae235b
                                              GNotification        *notification)
Packit ae235b
{
Packit ae235b
  GFdoNotificationBackend *self = G_FDO_NOTIFICATION_BACKEND (backend);
Packit ae235b
  FreedesktopNotification *n;
Packit ae235b
Packit ae235b
  if (self->notify_subscription == 0)
Packit ae235b
    {
Packit ae235b
      self->notify_subscription =
Packit ae235b
        g_dbus_connection_signal_subscribe (backend->dbus_connection,
Packit ae235b
                                            "org.freedesktop.Notifications",
Packit ae235b
                                            "org.freedesktop.Notifications", NULL,
Packit ae235b
                                            "/org/freedesktop/Notifications", NULL,
Packit ae235b
                                            G_DBUS_SIGNAL_FLAGS_NONE,
Packit ae235b
                                            notify_signal, backend, NULL);
Packit ae235b
    }
Packit ae235b
Packit ae235b
  n = g_fdo_notification_backend_find_notification (self, id);
Packit ae235b
  if (n == NULL)
Packit ae235b
    {
Packit ae235b
      n = g_slice_new0 (FreedesktopNotification);
Packit ae235b
      n->backend = self;
Packit ae235b
      n->id = g_strdup (id);
Packit ae235b
      n->notify_id = 0;
Packit ae235b
Packit ae235b
      n->backend->notifications = g_slist_prepend (n->backend->notifications, n);
Packit ae235b
    }
Packit ae235b
  else
Packit ae235b
    {
Packit ae235b
      /* Only clear default action. All other fields are still valid */
Packit ae235b
      g_clear_pointer (&n->default_action, g_free);
Packit ae235b
      g_clear_pointer (&n->default_action_target, g_variant_unref);
Packit ae235b
    }
Packit ae235b
Packit ae235b
  g_notification_get_default_action (notification, &n->default_action, &n->default_action_target);
Packit ae235b
Packit ae235b
  call_notify (backend->dbus_connection, backend->application, n->notify_id, notification, notification_sent, n);
Packit ae235b
}
Packit ae235b
Packit ae235b
static void
Packit ae235b
g_fdo_notification_backend_withdraw_notification (GNotificationBackend *backend,
Packit ae235b
                                                  const gchar          *id)
Packit ae235b
{
Packit ae235b
  GFdoNotificationBackend *self = G_FDO_NOTIFICATION_BACKEND (backend);
Packit ae235b
  FreedesktopNotification *n;
Packit ae235b
Packit ae235b
  n = g_fdo_notification_backend_find_notification (self, id);
Packit ae235b
  if (n)
Packit ae235b
    {
Packit ae235b
      if (n->notify_id > 0)
Packit ae235b
        {
Packit ae235b
          g_dbus_connection_call (backend->dbus_connection,
Packit ae235b
                                  "org.freedesktop.Notifications",
Packit ae235b
                                  "/org/freedesktop/Notifications",
Packit ae235b
                                  "org.freedesktop.Notifications", "CloseNotification",
Packit ae235b
                                  g_variant_new ("(u)", n->notify_id), NULL,
Packit ae235b
                                  G_DBUS_CALL_FLAGS_NONE, -1, NULL, NULL, NULL);
Packit ae235b
        }
Packit ae235b
Packit ae235b
      self->notifications = g_slist_remove (self->notifications, n);
Packit ae235b
      freedesktop_notification_free (n);
Packit ae235b
    }
Packit ae235b
}
Packit ae235b
Packit ae235b
static void
Packit ae235b
g_fdo_notification_backend_init (GFdoNotificationBackend *backend)
Packit ae235b
{
Packit ae235b
}
Packit ae235b
Packit ae235b
static void
Packit ae235b
g_fdo_notification_backend_class_init (GFdoNotificationBackendClass *class)
Packit ae235b
{
Packit ae235b
  GObjectClass *object_class = G_OBJECT_CLASS (class);
Packit ae235b
  GNotificationBackendClass *backend_class = G_NOTIFICATION_BACKEND_CLASS (class);
Packit ae235b
Packit ae235b
  object_class->dispose = g_fdo_notification_backend_dispose;
Packit ae235b
Packit ae235b
  backend_class->is_supported = g_fdo_notification_backend_is_supported;
Packit ae235b
  backend_class->send_notification = g_fdo_notification_backend_send_notification;
Packit ae235b
  backend_class->withdraw_notification = g_fdo_notification_backend_withdraw_notification;
Packit ae235b
}