path: root/src/device-menu-mgr.c

/*
Copyright 2011 Canonical Ltd.

Authors:
    Conor Curran <conor.curran@canonical.com>

This program is free software: you can redistribute it and/or modify it 
under the terms of the GNU General Public License version 3, as published 
by the Free Software Foundation.

This program is distributed in the hope that it will be useful, but 
WITHOUT ANY WARRANTY; without even the implied warranties of 
MERCHANTABILITY, SATISFACTORY QUALITY, or FITNESS FOR A PARTICULAR 
PURPOSE.  See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along 
with this program.  If not, see <http://www.gnu.org/licenses/>.
*/

#include <config.h>

#include <glib.h>
#include <gio/gio.h>

#include <libdbusmenu-glib/client.h>
#include <libdbusmenu-gtk/menuitem.h>

#include "device-menu-mgr.h"
#include "settings-helper.h"
#include "dbus-shared-names.h"
#include "dbusmenu-shared.h"
#include "lock-helper.h"
#include "upower-client.h"

#define UP_ADDRESS    "org.freedesktop.UPower"
#define UP_OBJECT     "/org/freedesktop/UPower"
#define UP_INTERFACE  "org.freedesktop.UPower"

#define EXTRA_LAUNCHER_DIR "/usr/share/indicators/session/applications"

struct _DeviceMenuMgr
{
  GObject parent_instance;
  DbusmenuMenuitem* root_item;
  SessionDbus* session_dbus_interface;  

  GSettings *lockdown_settings;
  GSettings * keybinding_settings;

  DbusmenuMenuitem * hibernate_mi;
  DbusmenuMenuitem * suspend_mi;
  DbusmenuMenuitem * lock_mi;

  DBusGProxy * up_main_proxy;
  DBusGProxy * up_prop_proxy;

  gboolean can_hibernate;
  gboolean can_suspend;
  gboolean allow_hibernate;
  gboolean allow_suspend;

  DBusGProxyCall * suspend_call;
  DBusGProxyCall * hibernate_call;
};

static void setup_up (DeviceMenuMgr* self);
static void device_menu_mgr_rebuild_items (DeviceMenuMgr *self);
static void screensaver_keybinding_changed (GSettings*, const gchar*, gpointer);

G_DEFINE_TYPE (DeviceMenuMgr, device_menu_mgr, G_TYPE_OBJECT);

static void
device_menu_mgr_init (DeviceMenuMgr *self)
{
  self->root_item = dbusmenu_menuitem_new ();  

  self->can_hibernate = TRUE;
  self->can_suspend = TRUE;
  self->allow_hibernate = TRUE;
  self->allow_suspend = TRUE;

  self->lockdown_settings = g_settings_new (LOCKDOWN_SCHEMA);
  g_signal_connect_swapped (self->lockdown_settings, "changed::" LOCKDOWN_KEY_USER, G_CALLBACK(device_menu_mgr_rebuild_items), self);
  g_signal_connect_swapped (self->lockdown_settings, "changed::" LOCKDOWN_KEY_SCREENSAVER, G_CALLBACK(device_menu_mgr_rebuild_items), self);

  self->keybinding_settings = g_settings_new (KEYBINDING_SCHEMA);
  g_signal_connect (self->keybinding_settings, "changed::" KEY_LOCK_SCREEN, G_CALLBACK(screensaver_keybinding_changed), self);

  setup_up(self);  
  g_idle_add(lock_screen_setup, NULL);  
}

static void
device_menu_mgr_dispose (GObject *object)
{
  DeviceMenuMgr * self = DEVICE_MENU_MGR (object);
  g_clear_object (&self->lockdown_settings);
  g_clear_object (&self->keybinding_settings);
  g_clear_object (&self->up_main_proxy);
  g_clear_object (&self->up_prop_proxy);

  G_OBJECT_CLASS (device_menu_mgr_parent_class)->finalize (object);
}

static void
device_menu_mgr_finalize (GObject *object)
{
  G_OBJECT_CLASS (device_menu_mgr_parent_class)->finalize (object);
}

static void
device_menu_mgr_class_init (DeviceMenuMgrClass *klass)
{
  GObjectClass* object_class = G_OBJECT_CLASS (klass);
  object_class->dispose = device_menu_mgr_dispose;
  object_class->finalize = device_menu_mgr_finalize;
}

/***
****
***/

static void
update_screensaver_shortcut (DbusmenuMenuitem * menuitem, GSettings * settings)
{
  if (menuitem != NULL)
    {
      gchar * val = g_settings_get_string (settings, KEY_LOCK_SCREEN);
      g_debug ("Keybinding changed to: %s", val);
      dbusmenu_menuitem_property_set_shortcut_string (menuitem, val);
      g_free (val);
    }
}

static void
screensaver_keybinding_changed (GSettings   * settings,
                                const gchar * key  G_GNUC_UNUSED,
                                gpointer      userdata)
{
  update_screensaver_shortcut (DEVICE_MENU_MGR(userdata)->lock_mi, settings);
}


/* Let's put this machine to sleep with some hints on how it should sleep.  */
static void
machine_sleep_with_context (DeviceMenuMgr* self, const gchar* type)
{
  if (self->up_main_proxy == NULL)
    {
      g_warning("Cannot %s because no upower proxy", type);
    }
  else
    {
      dbus_g_proxy_begin_call (self->up_main_proxy, type,
                               NULL, NULL, NULL,
                               G_TYPE_INVALID);
    }
}

static void
machine_sleep_from_suspend (DbusmenuMenuitem * mi        G_GNUC_UNUSED,
                            guint              timestamp G_GNUC_UNUSED,
                            gpointer           userdata)
{
  machine_sleep_with_context (DEVICE_MENU_MGR(userdata), "Suspend");
}

static void
machine_sleep_from_hibernate (DbusmenuMenuitem * mi        G_GNUC_UNUSED,
                              guint              timestamp G_GNUC_UNUSED,
                              gpointer           userdata)
{
  machine_sleep_with_context (DEVICE_MENU_MGR(userdata), "Hibernate");
}

/***
****
***/

static void
rebuild_if_flag_changed (DeviceMenuMgr * mgr, GError * error, gboolean * setme, gboolean value)
{
  if (error != NULL)
    {
      g_warning ("Unable to get information on what's allowed from UPower: %s", error->message);
    }
  else if (*setme != value)
    {
      *setme = value;
      device_menu_mgr_rebuild_items (mgr);
    }
}

/* When allow-suspend changes, rebuild the menus */
static void
allowed_suspend_cb (DBusGProxy * proxy G_GNUC_UNUSED,
                    gboolean     allow_suspend,
                    GError     * error,
                    gpointer     userdata)
{
  DeviceMenuMgr * mgr = DEVICE_MENU_MGR (userdata);
  rebuild_if_flag_changed (mgr, error, &mgr->allow_suspend, allow_suspend);
}

/* When allow-hibernate changes, rebuild the menus */
static void
allowed_hibernate_cb (DBusGProxy * proxy G_GNUC_UNUSED,
                      gboolean     allow_hibernate,
                      GError     * error,
                      gpointer     userdata)
{
  DeviceMenuMgr * mgr = DEVICE_MENU_MGR (userdata);
  rebuild_if_flag_changed (mgr, error, &mgr->allow_hibernate, allow_hibernate);
}


static void
rebuild_if_flag_changed_from_proxy_call (DeviceMenuMgr * mgr, gboolean * setme, DBusGProxy * proxy, DBusGProxyCall * call)
{
  GValue value = {0};
  GError * error = NULL;

  dbus_g_proxy_end_call (proxy, call, &error, G_TYPE_VALUE, &value, G_TYPE_INVALID);
  rebuild_if_flag_changed (mgr, error, setme, g_value_get_boolean (&value));

  g_clear_error (&error);
  g_value_unset (&value);
}

/* When can-suspend changes, rebuild the menus */
static void
suspend_prop_cb (DBusGProxy * proxy, DBusGProxyCall * call, gpointer userdata)
{
  DeviceMenuMgr* self = DEVICE_MENU_MGR (userdata);
  self->suspend_call = NULL;
  rebuild_if_flag_changed_from_proxy_call (self, &self->can_suspend, proxy, call);
}

/* When can-hibernate changes, rebuild the menus */
static void
hibernate_prop_cb (DBusGProxy * proxy, DBusGProxyCall * call, gpointer userdata)
{
  DeviceMenuMgr* self = DEVICE_MENU_MGR (userdata);
  self->hibernate_call = NULL;
  rebuild_if_flag_changed_from_proxy_call (self, &self->can_hibernate, proxy, call);
}

/* A signal that we need to recheck to ensure we can still hibernate and/or suspend */
static void
up_changed_cb (DBusGProxy * proxy, gpointer user_data)
{
  DeviceMenuMgr * self = DEVICE_MENU_MGR(user_data);

  if (self->suspend_call == NULL)
    {
      /* start async call to see if we can hibernate */
      self->suspend_call = dbus_g_proxy_begin_call (self->up_prop_proxy,
                                                    "Get",
                                                    suspend_prop_cb,
                                                    user_data,
                                                    NULL,
                                                    G_TYPE_STRING,
                                                    UP_INTERFACE,
                                                    G_TYPE_STRING,
                                                    "CanSuspend",
                                                    G_TYPE_INVALID,
                                                    G_TYPE_VALUE,
                                                    G_TYPE_INVALID);
    }

    if (self->hibernate_call == NULL)
      {
        /* start async call to see if we can suspend */
        self->hibernate_call = dbus_g_proxy_begin_call (self->up_prop_proxy,
                                                        "Get",
                                                        hibernate_prop_cb,
                                                        user_data,
                                                        NULL,
                                                        G_TYPE_STRING,
                                                        UP_INTERFACE,
                                                        G_TYPE_STRING,
                                                        "CanHibernate",
                                                        G_TYPE_INVALID,
                                                        G_TYPE_VALUE,
                                                        G_TYPE_INVALID);
      }
}

/* This function goes through and sets up what we need for DKp checking.
    We're even setting up the calls for the props we need */
static void
setup_up (DeviceMenuMgr* self)
{
  DBusGConnection * bus = dbus_g_bus_get(DBUS_BUS_SYSTEM, NULL);
  g_return_if_fail (bus != NULL);

  if (self->up_main_proxy == NULL)
    {
      self->up_main_proxy = dbus_g_proxy_new_for_name (bus,
                                                       UP_ADDRESS,
                                                       UP_OBJECT,
                                                       UP_INTERFACE);
    }

  if (self->up_prop_proxy == NULL)
    {
      self->up_prop_proxy = dbus_g_proxy_new_for_name(bus,
                                                      UP_ADDRESS,
                                                      UP_OBJECT,
                                                      DBUS_INTERFACE_PROPERTIES);
      /* Connect to changed signal */
      dbus_g_proxy_add_signal(self->up_main_proxy, "Changed", G_TYPE_INVALID);
      dbus_g_proxy_connect_signal(self->up_main_proxy, "Changed", G_CALLBACK(up_changed_cb), self, NULL);
    }

  /* Force an original "changed" event */
  up_changed_cb(self->up_main_proxy, self);

  /* Check to see if these are getting blocked by PolicyKit */
  org_freedesktop_UPower_suspend_allowed_async(self->up_main_proxy, allowed_suspend_cb, self);
  org_freedesktop_UPower_hibernate_allowed_async(self->up_main_proxy, allowed_hibernate_cb, self);
}

static void
spawn_command_line_async (const char * fmt, ...)
{
  va_list marker;
  va_start (marker, fmt);
  gchar * cmd = g_strdup_vprintf (fmt, marker);
  va_end (marker);
  
  GError * error = NULL; 
  if (!g_spawn_command_line_async (cmd, &error))
    {
      g_warning ("Unable to show \"%s\": %s", cmd, error->message);
    }

  g_clear_error (&error);
  g_free (cmd);
}


/* This is the function to show a dialog on actions that
   can destroy data.  Currently it just calls the GTK version
   but it seems that in the future it should figure out
   what's going on and something better. */
static void
show_dialog (DbusmenuMenuitem * mi, guint timestamp, gchar * type)
{
#ifdef HAVE_GTKLOGOUTHELPER
  gchar * helper = g_build_filename(LIBEXECDIR, "gtk-logout-helper", NULL);
#else
  gchar * helper = g_build_filename("gnome-session-quit", NULL);
#endif  /* HAVE_GTKLOGOUTHELPER */
  spawn_command_line_async ("%s --%s", helper, type);
  g_free (helper);
}

static void
device_menu_mgr_build_static_items (DeviceMenuMgr* self, gboolean greeter_mode)
{
  const char * name;
  DbusmenuMenuitem * mi;
  DbusmenuMenuitem * logout_mi = NULL;
  DbusmenuMenuitem * shutdown_mi = NULL;

  /* About this computer */
  name = _("About This Computer");
  mi = dbusmenu_menuitem_new ();
  dbusmenu_menuitem_property_set (mi, DBUSMENU_MENUITEM_PROP_LABEL, name);
  dbusmenu_menuitem_child_append (self->root_item, mi);
  g_signal_connect_swapped (mi, DBUSMENU_MENUITEM_SIGNAL_ITEM_ACTIVATED,
                            G_CALLBACK(spawn_command_line_async), "gnome-control-center info");

  /* ubuntu help */
  name = _("Ubuntu Help");
  mi = dbusmenu_menuitem_new ();
  dbusmenu_menuitem_property_set (mi, DBUSMENU_MENUITEM_PROP_LABEL, name);
  dbusmenu_menuitem_child_append (self->root_item, mi);
  g_signal_connect_swapped (mi, DBUSMENU_MENUITEM_SIGNAL_ITEM_ACTIVATED,
                            G_CALLBACK(spawn_command_line_async), "yelp");
 
  /* system settings */
  if (!greeter_mode)
    {
      /* separator */ 
      mi = dbusmenu_menuitem_new();
      dbusmenu_menuitem_property_set (mi, DBUSMENU_MENUITEM_PROP_TYPE, DBUSMENU_CLIENT_TYPES_SEPARATOR);
      dbusmenu_menuitem_child_append (self->root_item, mi);

      /* system settings... */
      name = _("System Settings…");
      mi = dbusmenu_menuitem_new ();
      dbusmenu_menuitem_property_set (mi, DBUSMENU_MENUITEM_PROP_LABEL, name);
      dbusmenu_menuitem_child_append (self->root_item, mi);
      g_signal_connect_swapped (mi, DBUSMENU_MENUITEM_SIGNAL_ITEM_ACTIVATED,
                                G_CALLBACK(spawn_command_line_async), "gnome-control-center");
    }

  // Session control  
  if (!greeter_mode)
    {
      const gboolean can_lockscreen = !g_settings_get_boolean (self->lockdown_settings, LOCKDOWN_KEY_SCREENSAVER);

      /* separator */ 
      mi = dbusmenu_menuitem_new();
      dbusmenu_menuitem_property_set (mi, DBUSMENU_MENUITEM_PROP_TYPE, DBUSMENU_CLIENT_TYPES_SEPARATOR);
      dbusmenu_menuitem_child_append (self->root_item, mi);

      /* lock screen */
      if (can_lockscreen)
        {
          name = _("Lock Screen");
          self->lock_mi = mi = dbusmenu_menuitem_new();
          dbusmenu_menuitem_property_set (mi, DBUSMENU_MENUITEM_PROP_LABEL, name);
          update_screensaver_shortcut (mi, self->keybinding_settings);
          dbusmenu_menuitem_child_append (self->root_item, mi);
          g_signal_connect (G_OBJECT(mi), DBUSMENU_MENUITEM_SIGNAL_ITEM_ACTIVATED,
                            G_CALLBACK(lock_screen), NULL);
        }

      /* logout */
      name = supress_confirmations() ? _("Log Out") : _("Log Out\342\200\246");
      logout_mi = mi = dbusmenu_menuitem_new();
      dbusmenu_menuitem_property_set (mi, DBUSMENU_MENUITEM_PROP_LABEL, name);
      dbusmenu_menuitem_property_set_bool (mi, DBUSMENU_MENUITEM_PROP_VISIBLE, show_logout());
      dbusmenu_menuitem_child_append(self->root_item, mi);
      g_signal_connect (G_OBJECT(mi), DBUSMENU_MENUITEM_SIGNAL_ITEM_ACTIVATED,
                        G_CALLBACK(show_dialog), "logout");
    }

  /* suspend */
  if (self->can_suspend && self->allow_suspend)
    {
      name = _("Suspend");
      self->suspend_mi = mi = dbusmenu_menuitem_new();
      dbusmenu_menuitem_property_set (mi, DBUSMENU_MENUITEM_PROP_LABEL, name);
      dbusmenu_menuitem_child_append (self->root_item, mi);
      g_signal_connect (G_OBJECT(mi), DBUSMENU_MENUITEM_SIGNAL_ITEM_ACTIVATED,
                        G_CALLBACK(machine_sleep_from_suspend), self);
    }

  /* hibernate */
  if (self->can_hibernate && self->allow_hibernate)
    {
      name = _("Hibernate");
      self->hibernate_mi = mi = dbusmenu_menuitem_new();
      dbusmenu_menuitem_property_set (mi, DBUSMENU_MENUITEM_PROP_LABEL, name);
      dbusmenu_menuitem_child_append(self->root_item, mi);
      g_signal_connect (G_OBJECT(mi), DBUSMENU_MENUITEM_SIGNAL_ITEM_ACTIVATED,
                        G_CALLBACK(machine_sleep_from_hibernate), self);
    }
 
  /* shut down */ 
  name = supress_confirmations() ? _("Shut Down") : _("Shut Down\342\200\246");
  shutdown_mi = mi = dbusmenu_menuitem_new();
  dbusmenu_menuitem_property_set (mi, DBUSMENU_MENUITEM_PROP_LABEL, name);
  dbusmenu_menuitem_property_set_bool (mi, DBUSMENU_MENUITEM_PROP_VISIBLE, show_shutdown());
  dbusmenu_menuitem_child_append (self->root_item, mi);
  g_signal_connect (G_OBJECT(mi), DBUSMENU_MENUITEM_SIGNAL_ITEM_ACTIVATED,
#ifdef HAVE_GTKLOGOUTHELPER
                    G_CALLBACK(show_dialog), "shutdown");
#else
                    G_CALLBACK(show_dialog), "power-off");
#endif  /* HAVE_GTKLOGOUTHELPER */

  RestartShutdownLogoutMenuItems * restart_shutdown_logout_mi = g_new0 (RestartShutdownLogoutMenuItems, 1);
  restart_shutdown_logout_mi->logout_mi = logout_mi;
  restart_shutdown_logout_mi->shutdown_mi = shutdown_mi;

  update_menu_entries(restart_shutdown_logout_mi);
}

static void
device_menu_mgr_rebuild_items (DeviceMenuMgr* self)
{
  dbusmenu_menuitem_property_set_bool (self->hibernate_mi,
                                       DBUSMENU_MENUITEM_PROP_VISIBLE,
                                       self->can_hibernate && self->allow_hibernate);
  dbusmenu_menuitem_property_set_bool (self->suspend_mi,
                                       DBUSMENU_MENUITEM_PROP_VISIBLE,
                                       self->can_suspend && self->allow_suspend);
}                                       

DbusmenuMenuitem*
device_mgr_get_root_item (DeviceMenuMgr* self)
{
  return self->root_item;
}

/*
 * Clean Entry Point 
 */
DeviceMenuMgr* device_menu_mgr_new (SessionDbus* session_dbus, gboolean greeter_mode)
{
  DeviceMenuMgr* device_mgr = g_object_new (DEVICE_TYPE_MENU_MGR, NULL);
  device_mgr->session_dbus_interface = session_dbus;
  device_menu_mgr_build_static_items (device_mgr, greeter_mode);
  return device_mgr;
}