cut-n-paste/smclient/eggsmclient.c

   1 /*
   2  * Copyright (C) 2007 Novell, Inc.
   3  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Library General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2 of the License, or (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Library General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Library General Public
  15  * License along with this library; if not, write to the
  16  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  17  * Boston, MA 02111-1307, USA.
  18  */
  19
  20 #include "config.h"
  21
  22 #include <string.h>
  23 #include <glib/gi18n.h>
  24
  25 #include "eggsmclient.h"
  26 #include "eggsmclient-private.h"
  27
  28 static void egg_sm_client_debug_handler (const char *log_domain,
  29                                          GLogLevelFlags log_level,
  30                                          const char *message,
  31                                          gpointer user_data);
  32
  33 enum {
  34   SAVE_STATE,
  35   QUIT_REQUESTED,
  36   QUIT_CANCELLED,
  37   QUIT,
  38   LAST_SIGNAL
  39 };
  40
  41 static guint signals[LAST_SIGNAL] = { 0 };
  42
  43 struct _EggSMClientPrivate {
  44   GKeyFile *state_file;
  45 };
  46
  47 #define EGG_SM_CLIENT_GET_PRIVATE(o) (G_TYPE_INSTANCE_GET_PRIVATE ((o), EGG_TYPE_SM_CLIENT, EggSMClientPrivate))
  48
  49 G_DEFINE_TYPE (EggSMClient, egg_sm_client, G_TYPE_OBJECT)
  50
  51 static EggSMClient *global_client;
  52 static EggSMClientMode global_client_mode = EGG_SM_CLIENT_MODE_NORMAL;
  53
  54 static void
  55 egg_sm_client_init (EggSMClient *client)
  56 {
  57   ;
  58 }
  59
  60 static void
  61 egg_sm_client_class_init (EggSMClientClass *klass)
  62 {
  63   GObjectClass *object_class = G_OBJECT_CLASS (klass);
  64
  65   g_type_class_add_private (klass, sizeof (EggSMClientPrivate));
  66
  67   /**
  68    * EggSMClient::save_state:
  69    * @client: the client
  70    * @state_file: a #GKeyFile to save state information into
  71    *
  72    * Emitted when the session manager has requested that the
  73    * application save information about its current state. The
  74    * application should save its state into @state_file, and then the
  75    * session manager may then restart the application in a future
  76    * session and tell it to initialize itself from that state.
  77    *
  78    * You should not save any data into @state_file's "start group"
  79    * (ie, the %NULL group). Instead, applications should save their
  80    * data into groups with names that start with the application name,
  81    * and libraries that connect to this signal should save their data
  82    * into groups with names that start with the library name.
  83    *
  84    * Alternatively, rather than (or in addition to) using @state_file,
  85    * the application can save its state by calling
  86    * egg_sm_client_set_restart_command() during the processing of this
  87    * signal (eg, to include a list of files to open).
  88    **/
  89   signals[SAVE_STATE] =
  90     g_signal_new ("save_state",
  91                   G_OBJECT_CLASS_TYPE (object_class),
  92                   G_SIGNAL_RUN_LAST,
  93                   G_STRUCT_OFFSET (EggSMClientClass, save_state),
  94                   NULL, NULL,
  95                   g_cclosure_marshal_VOID__POINTER,
  96                   G_TYPE_NONE,
  97                   1, G_TYPE_POINTER);
  98
  99   /**
 100    * EggSMClient::quit_requested:
 101    * @client: the client
 102    *
 103    * Emitted when the session manager requests that the application
 104    * exit (generally because the user is logging out). The application
 105    * should decide whether or not it is willing to quit (perhaps after
 106    * asking the user what to do with documents that have unsaved
 107    * changes) and then call egg_sm_client_will_quit(), passing %TRUE
 108    * or %FALSE to give its answer to the session manager. (It does not
 109    * need to give an answer before returning from the signal handler;
 110    * it can interact with the user asynchronously and then give its
 111    * answer later on.) If the application does not connect to this
 112    * signal, then #EggSMClient will automatically return %TRUE on its
 113    * behalf.
 114    *
 115    * The application should not save its session state as part of
 116    * handling this signal; if the user has requested that the session
 117    * be saved when logging out, then ::save_state will be emitted
 118    * separately.
 119    *
 120    * If the application agrees to quit, it should then wait for either
 121    * the ::quit_cancelled or ::quit signals to be emitted.
 122    **/
 123   signals[QUIT_REQUESTED] =
 124     g_signal_new ("quit_requested",
 125                   G_OBJECT_CLASS_TYPE (object_class),
 126                   G_SIGNAL_RUN_LAST,
 127                   G_STRUCT_OFFSET (EggSMClientClass, quit_requested),
 128                   NULL, NULL,
 129                   g_cclosure_marshal_VOID__VOID,
 130                   G_TYPE_NONE,
 131                   0);
 132
 133   /**
 134    * EggSMClient::quit_cancelled:
 135    * @client: the client
 136    *
 137    * Emitted when the session manager decides to cancel a logout after
 138    * the application has already agreed to quit. After receiving this
 139    * signal, the application can go back to what it was doing before
 140    * receiving the ::quit_requested signal.
 141    **/
 142   signals[QUIT_CANCELLED] =
 143     g_signal_new ("quit_cancelled",
 144                   G_OBJECT_CLASS_TYPE (object_class),
 145                   G_SIGNAL_RUN_LAST,
 146                   G_STRUCT_OFFSET (EggSMClientClass, quit_cancelled),
 147                   NULL, NULL,
 148                   g_cclosure_marshal_VOID__VOID,
 149                   G_TYPE_NONE,
 150                   0);
 151
 152   /**
 153    * EggSMClient::quit:
 154    * @client: the client
 155    *
 156    * Emitted when the session manager wants the application to quit
 157    * (generally because the user is logging out). The application
 158    * should exit as soon as possible after receiving this signal; if
 159    * it does not, the session manager may choose to forcibly kill it.
 160    *
 161    * Normally a GUI application would only be sent a ::quit if it
 162    * agreed to quit in response to a ::quit_requested signal. However,
 163    * this is not guaranteed; in some situations the session manager
 164    * may decide to end the session without giving applications a
 165    * chance to object.
 166    **/
 167   signals[QUIT] =
 168     g_signal_new ("quit",
 169                   G_OBJECT_CLASS_TYPE (object_class),
 170                   G_SIGNAL_RUN_LAST,
 171                   G_STRUCT_OFFSET (EggSMClientClass, quit),
 172                   NULL, NULL,
 173                   g_cclosure_marshal_VOID__VOID,
 174                   G_TYPE_NONE,
 175                   0);
 176 }
 177
 178 static gboolean sm_client_disable = FALSE;
 179 static char *sm_client_state_file = NULL;
 180 static char *sm_client_id = NULL;
 181
 182 static GOptionEntry entries[] = {
 183   { "sm-client-disable", 0, 0,
 184     G_OPTION_ARG_NONE, &sm_client_disable,
 185     N_("Disable connection to session manager"), NULL },
 186   { "sm-client-state-file", 0, 0,
 187     G_OPTION_ARG_STRING, &sm_client_state_file,
 188     N_("Specify file containing saved configuration"), N_("FILE") },
 189   { "sm-client-id", 0, 0,
 190     G_OPTION_ARG_STRING, &sm_client_id,
 191     N_("Specify session management ID"), N_("ID") },
 192   { NULL }
 193 };
 194
 195 static gboolean
 196 sm_client_post_parse_func (GOptionContext  *context,
 197                            GOptionGroup    *group,
 198                            gpointer         data,
 199                            GError         **error)
 200 {
 201   EggSMClient *client = egg_sm_client_get ();
 202
 203   if (EGG_SM_CLIENT_GET_CLASS (client)->startup)
 204     EGG_SM_CLIENT_GET_CLASS (client)->startup (client, sm_client_id);
 205   return TRUE;
 206 }
 207
 208 /**
 209  * egg_sm_client_get_option_group:
 210  *
 211  * Creates a %GOptionGroup containing the session-management-related
 212  * options. You should add this group to the application's
 213  * %GOptionContext if you want to use #EggSMClient.
 214  *
 215  * Return value: the %GOptionGroup
 216  **/
 217 GOptionGroup *
 218 egg_sm_client_get_option_group (void)
 219 {
 220   GOptionGroup *group;
 221
 222   /* Use our own debug handler for the "EggSMClient" domain. */
 223   g_log_set_handler (G_LOG_DOMAIN, G_LOG_LEVEL_DEBUG,
 224                      egg_sm_client_debug_handler, NULL);
 225
 226   group = g_option_group_new ("sm-client",
 227                               _("Session Management Options"),
 228                               _("Show Session Management options"),
 229                               NULL, NULL);
 230   g_option_group_add_entries (group, entries);
 231   g_option_group_set_parse_hooks (group, NULL, sm_client_post_parse_func);
 232
 233   return group;
 234 }
 235
 236 /**
 237  * egg_sm_client_set_mode:
 238  * @mode: an #EggSMClient mode
 239  *
 240  * Sets the "mode" of #EggSMClient as follows:
 241  *
 242  *    %EGG_SM_CLIENT_MODE_DISABLED: Session management is completely
 243  *    disabled. The application will not even connect to the session
 244  *    manager. (egg_sm_client_get() will still return an #EggSMClient,
 245  *    but it will just be a dummy object.)
 246  *
 247  *    %EGG_SM_CLIENT_MODE_NO_RESTART: The application will connect to
 248  *    the session manager (and thus will receive notification when the
 249  *    user is logging out, etc), but will request to not be
 250  *    automatically restarted with saved state in future sessions.
 251  *
 252  *    %EGG_SM_CLIENT_MODE_NORMAL: The default. #EggSMCLient will
 253  *    function normally.
 254  *
 255  * This must be called before the application's main loop begins.
 256  **/
 257 void
 258 egg_sm_client_set_mode (EggSMClientMode mode)
 259 {
 260   global_client_mode = mode;
 261 }
 262
 263 /**
 264  * egg_sm_client_get_mode:
 265  *
 266  * Gets the global #EggSMClientMode. See egg_sm_client_set_mode()
 267  * for details.
 268  *
 269  * Return value: the global #EggSMClientMode
 270  **/
 271 EggSMClientMode
 272 egg_sm_client_get_mode (void)
 273 {
 274   return global_client_mode;
 275 }
 276
 277 /**
 278  * egg_sm_client_get:
 279  *
 280  * Returns the master #EggSMClient for the application.
 281  *
 282  * On platforms that support saved sessions (ie, POSIX/X11), the
 283  * application will only request to be restarted by the session
 284  * manager if you call egg_set_desktop_file() to set an application
 285  * desktop file. In particular, if the desktop file contains the key
 286  * "X
 287  *
 288  * Return value: the master #EggSMClient.
 289  **/
 290 EggSMClient *
 291 egg_sm_client_get (void)
 292 {
 293   if (!global_client)
 294     {
 295       if (global_client_mode != EGG_SM_CLIENT_MODE_DISABLED &&
 296           !sm_client_disable)
 297         {
 298 #if defined (GDK_WINDOWING_WIN32)
 299           global_client = egg_sm_client_win32_new ();
 300 #elif defined (GDK_WINDOWING_QUARTZ)
 301           global_client = egg_sm_client_osx_new ();
 302 #else
 303           /* If both D-Bus and XSMP are compiled in, try D-Bus first
 304            * and fall back to XSMP if D-Bus session management isn't
 305            * available.
 306            */
 307 # ifdef EGG_SM_CLIENT_BACKEND_DBUS
 308           global_client = egg_sm_client_dbus_new ();
 309 # endif
 310 # ifdef EGG_SM_CLIENT_BACKEND_XSMP
 311           if (!global_client)
 312             global_client = egg_sm_client_xsmp_new ();
 313 # endif
 314 #endif
 315         }
 316
 317       /* Fallback: create a dummy client, so that callers don't have
 318        * to worry about a %NULL return value.
 319        */
 320       if (!global_client)
 321         global_client = g_object_new (EGG_TYPE_SM_CLIENT, NULL);
 322     }
 323
 324   return global_client;
 325 }
 326
 327 /**
 328  * egg_sm_client_is_resumed:
 329  * @client: the client
 330  *
 331  * Checks whether or not the current session has been resumed from
 332  * a previous saved session. If so, the application should call
 333  * egg_sm_client_get_state_file() and restore its state from the
 334  * returned #GKeyFile.
 335  *
 336  * Return value: %TRUE if the session has been resumed
 337  **/
 338 gboolean
 339 egg_sm_client_is_resumed (EggSMClient *client)
 340 {
 341   g_return_val_if_fail (client == global_client, FALSE);
 342
 343   return sm_client_state_file != NULL;
 344 }
 345
 346 /**
 347  * egg_sm_client_get_state_file:
 348  * @client: the client
 349  *
 350  * If the application was resumed by the session manager, this will
 351  * return the #GKeyFile containing its state from the previous
 352  * session.
 353  *
 354  * Note that other libraries and #EggSMClient itself may also store
 355  * state in the key file, so if you call egg_sm_client_get_groups(),
 356  * on it, the return value will likely include groups that you did not
 357  * put there yourself. (It is also not guaranteed that the first
 358  * group created by the application will still be the "start group"
 359  * when it is resumed.)
 360  *
 361  * Return value: the #GKeyFile containing the application's earlier
 362  * state, or %NULL on error. You should not free this key file; it
 363  * is owned by @client.
 364  **/
 365 GKeyFile *
 366 egg_sm_client_get_state_file (EggSMClient *client)
 367 {
 368   EggSMClientPrivate *priv = EGG_SM_CLIENT_GET_PRIVATE (client);
 369   char *state_file_path;
 370   GError *err = NULL;
 371
 372   g_return_val_if_fail (client == global_client, NULL);
 373
 374   if (!sm_client_state_file)
 375     return NULL;
 376   if (priv->state_file)
 377     return priv->state_file;
 378
 379   if (!strncmp (sm_client_state_file, "file://", 7))
 380     state_file_path = g_filename_from_uri (sm_client_state_file, NULL, NULL);
 381   else
 382     state_file_path = g_strdup (sm_client_state_file);
 383
 384   priv->state_file = g_key_file_new ();
 385   if (!g_key_file_load_from_file (priv->state_file, state_file_path, 0, &err))
 386     {
 387       g_warning ("Could not load SM state file '%s': %s",
 388                  sm_client_state_file, err->message);
 389       g_clear_error (&err);
 390       g_key_file_free (priv->state_file);
 391       priv->state_file = NULL;
 392     }
 393
 394   g_free (state_file_path);
 395   return priv->state_file;
 396 }
 397
 398 /**
 399  * egg_sm_client_set_restart_command:
 400  * @client: the client
 401  * @argc: the length of @argv
 402  * @argv: argument vector
 403  *
 404  * Sets the command used to restart @client if it does not have a
 405  * .desktop file that can be used to find its restart command.
 406  *
 407  * This can also be used when handling the ::save_state signal, to
 408  * save the current state via an updated command line. (Eg, providing
 409  * a list of filenames to open when the application is resumed.)
 410  **/
 411 void
 412 egg_sm_client_set_restart_command (EggSMClient  *client,
 413                                    int           argc,
 414                                    const char  **argv)
 415 {
 416   g_return_if_fail (EGG_IS_SM_CLIENT (client));
 417
 418   if (EGG_SM_CLIENT_GET_CLASS (client)->set_restart_command)
 419     EGG_SM_CLIENT_GET_CLASS (client)->set_restart_command (client, argc, argv);
 420 }
 421
 422 /**
 423  * egg_sm_client_will_quit:
 424  * @client: the client
 425  * @will_quit: whether or not the application is willing to quit
 426  *
 427  * This MUST be called in response to the ::quit_requested signal, to
 428  * indicate whether or not the application is willing to quit. The
 429  * application may call it either directly from the signal handler, or
 430  * at some later point (eg, after asynchronously interacting with the
 431  * user).
 432  *
 433  * If the application does not connect to ::quit_requested,
 434  * #EggSMClient will call this method on its behalf (passing %TRUE
 435  * for @will_quit).
 436  *
 437  * After calling this method, the application should wait to receive
 438  * either ::quit_cancelled or ::quit.
 439  **/
 440 void
 441 egg_sm_client_will_quit (EggSMClient *client,
 442                          gboolean     will_quit)
 443 {
 444   g_return_if_fail (EGG_IS_SM_CLIENT (client));
 445
 446   if (EGG_SM_CLIENT_GET_CLASS (client)->will_quit)
 447     EGG_SM_CLIENT_GET_CLASS (client)->will_quit (client, will_quit);
 448 }
 449
 450 /**
 451  * egg_sm_client_end_session:
 452  * @style: a hint at how to end the session
 453  * @request_confirmation: whether or not the user should get a chance
 454  * to confirm the action
 455  *
 456  * Requests that the session manager end the current session. @style
 457  * indicates how the session should be ended, and
 458  * @request_confirmation indicates whether or not the user should be
 459  * given a chance to confirm the logout/reboot/shutdown. Both of these
 460  * flags are merely hints though; the session manager may choose to
 461  * ignore them.
 462  *
 463  * Return value: %TRUE if the request was sent; %FALSE if it could not
 464  * be (eg, because it could not connect to the session manager).
 465  **/
 466 gboolean
 467 egg_sm_client_end_session (EggSMClientEndStyle  style,
 468                            gboolean             request_confirmation)
 469 {
 470   EggSMClient *client = egg_sm_client_get ();
 471
 472   g_return_val_if_fail (EGG_IS_SM_CLIENT (client), FALSE);
 473
 474   if (EGG_SM_CLIENT_GET_CLASS (client)->end_session)
 475     {
 476       return EGG_SM_CLIENT_GET_CLASS (client)->end_session (client, style,
 477                                                             request_confirmation);
 478     }
 479   else
 480     return FALSE;
 481 }
 482
 483 /* Signal-emitting callbacks from platform-specific code */
 484
 485 GKeyFile *
 486 egg_sm_client_save_state (EggSMClient *client)
 487 {
 488   GKeyFile *state_file;
 489   char *group;
 490
 491   g_return_val_if_fail (client == global_client, NULL);
 492
 493   state_file = g_key_file_new ();
 494
 495   g_debug ("Emitting save_state");
 496   g_signal_emit (client, signals[SAVE_STATE], 0, state_file);
 497   g_debug ("Done emitting save_state");
 498
 499   group = g_key_file_get_start_group (state_file);
 500   if (group)
 501     {
 502       g_free (group);
 503       return state_file;
 504     }
 505   else
 506     {
 507       g_key_file_free (state_file);
 508       return NULL;
 509     }
 510 }
 511
 512 void
 513 egg_sm_client_quit_requested (EggSMClient *client)
 514 {
 515   g_return_if_fail (client == global_client);
 516
 517   if (!g_signal_has_handler_pending (client, signals[QUIT_REQUESTED], 0, FALSE))
 518     {
 519       g_debug ("Not emitting quit_requested because no one is listening");
 520       egg_sm_client_will_quit (client, TRUE);
 521       return;
 522     }
 523
 524   g_debug ("Emitting quit_requested");
 525   g_signal_emit (client, signals[QUIT_REQUESTED], 0);
 526   g_debug ("Done emitting quit_requested");
 527 }
 528
 529 void
 530 egg_sm_client_quit_cancelled (EggSMClient *client)
 531 {
 532   g_return_if_fail (client == global_client);
 533
 534   g_debug ("Emitting quit_cancelled");
 535   g_signal_emit (client, signals[QUIT_CANCELLED], 0);
 536   g_debug ("Done emitting quit_cancelled");
 537 }
 538
 539 void
 540 egg_sm_client_quit (EggSMClient *client)
 541 {
 542   g_return_if_fail (client == global_client);
 543
 544   g_debug ("Emitting quit");
 545   g_signal_emit (client, signals[QUIT], 0);
 546   g_debug ("Done emitting quit");
 547
 548   /* FIXME: should we just call gtk_main_quit() here? */
 549 }
 550
 551 static void
 552 egg_sm_client_debug_handler (const char *log_domain,
 553                              GLogLevelFlags log_level,
 554                              const char *message,
 555                              gpointer user_data)
 556 {
 557   static int debug = -1;
 558
 559   if (debug < 0)
 560     debug = (g_getenv ("EGG_SM_CLIENT_DEBUG") != NULL);
 561
 562   if (debug)
 563     g_log_default_handler (log_domain, log_level, message, NULL);
 564 }