Merge branch 'backport' into work
[dana/openbox.git] / openbox / session.c
index 56ae7ab..758e988 100644 (file)
@@ -33,6 +33,8 @@ GSList *session_desktop_names = NULL;
 void session_startup(gint argc, gchar **argv) {}
 void session_shutdown(gboolean permanent) {}
 GList* session_state_find(struct _ObClient *c) { return NULL; }
+void session_request_logout(gboolean silent) {}
+gboolean session_connected(void) { return FALSE; }
 #else
 
 #include "debug.h"
@@ -104,13 +106,13 @@ void session_startup(gint argc, gchar **argv)
     obt_paths_unref(p), p = NULL;
 
     if (!obt_paths_mkdir_path(dir, 0700)) {
-        g_message(_("Unable to make directory '%s': %s"),
+        g_message(_("Unable to make directory \"%s\": %s"),
                   dir, g_strerror(errno));
     }
 
     if (ob_sm_save_file != NULL) {
         if (ob_sm_restore) {
-            ob_debug_type(OB_DEBUG_SM, "Loading from session file %s\n",
+            ob_debug_type(OB_DEBUG_SM, "Loading from session file %s",
                           ob_sm_save_file);
             session_load_file(ob_sm_save_file);
         }
@@ -158,8 +160,13 @@ void session_shutdown(gboolean permanent)
     }
 }
 
+gboolean session_connected(void)
+{
+    return !!sm_conn;
+}
+
 /*! Connect to the session manager and set up our callback functions */
-static gboolean session_connect()
+static gboolean session_connect(void)
 {
     SmcCallbacks cb;
     gchar *oldid;
@@ -177,7 +184,7 @@ static gboolean session_connect()
 
     /* connect to the server */
     oldid = ob_sm_id;
-    ob_debug_type(OB_DEBUG_SM, "Connecting to SM with id: %s\n",
+    ob_debug_type(OB_DEBUG_SM, "Connecting to SM with id: %s",
                   oldid ? oldid : "(null)");
     sm_conn = SmcOpenConnection(NULL, NULL, 1, 0,
                                 SmcSaveYourselfProcMask |
@@ -187,13 +194,13 @@ static gboolean session_connect()
                                 &cb, oldid, &ob_sm_id,
                                 SM_ERR_LEN-1, sm_err);
     g_free(oldid);
-    ob_debug_type(OB_DEBUG_SM, "Connected to SM with id: %s\n", ob_sm_id);
+    ob_debug_type(OB_DEBUG_SM, "Connected to SM with id: %s", ob_sm_id);
     if (sm_conn == NULL)
-        ob_debug("Failed to connect to session manager: %s\n", sm_err);
+        ob_debug("Failed to connect to session manager: %s", sm_err);
     return sm_conn != NULL;
 }
 
-static void session_setup_program()
+static void session_setup_program(void)
 {
     SmPropValue vals = {
         .value = sm_argv[0],
@@ -206,13 +213,13 @@ static void session_setup_program()
         .vals = &vals
     };
     SmProp *list = ∝
-    ob_debug_type(OB_DEBUG_SM, "Setting program: %s\n", sm_argv[0]);
+    ob_debug_type(OB_DEBUG_SM, "Setting program: %s", sm_argv[0]);
     SmcSetProperties(sm_conn, 1, &list);
     g_free(prop.name);
     g_free(prop.type);
 }
 
-static void session_setup_user()
+static void session_setup_user(void)
 {
     char *user = g_strdup(g_get_user_name());
 
@@ -227,7 +234,7 @@ static void session_setup_user()
         .vals = &vals
     };
     SmProp *list = ∝
-    ob_debug_type(OB_DEBUG_SM, "Setting user: %s\n", user);
+    ob_debug_type(OB_DEBUG_SM, "Setting user: %s", user);
     SmcSetProperties(sm_conn, 1, &list);
     g_free(prop.name);
     g_free(prop.type);
@@ -249,13 +256,13 @@ static void session_setup_restart_style(gboolean restart)
         .vals = &vals
     };
     SmProp *list = ∝
-    ob_debug_type(OB_DEBUG_SM, "Setting restart: %d\n", restart);
+    ob_debug_type(OB_DEBUG_SM, "Setting restart: %d", restart);
     SmcSetProperties(sm_conn, 1, &list);
     g_free(prop.name);
     g_free(prop.type);
 }
 
-static void session_setup_pid()
+static void session_setup_pid(void)
 {
     gchar *pid = g_strdup_printf("%ld", (glong) getpid());
 
@@ -270,7 +277,7 @@ static void session_setup_pid()
         .vals = &vals
     };
     SmProp *list = ∝
-    ob_debug_type(OB_DEBUG_SM, "Setting pid: %s\n", pid);
+    ob_debug_type(OB_DEBUG_SM, "Setting pid: %s", pid);
     SmcSetProperties(sm_conn, 1, &list);
     g_free(prop.name);
     g_free(prop.type);
@@ -278,7 +285,7 @@ static void session_setup_pid()
 }
 
 /*! This is a gnome-session-manager extension */
-static void session_setup_priority()
+static void session_setup_priority(void)
 {
     gchar priority = 20; /* 20 is a lower prioity to run before other apps */
 
@@ -293,13 +300,13 @@ static void session_setup_priority()
         .vals = &vals
     };
     SmProp *list = ∝
-    ob_debug_type(OB_DEBUG_SM, "Setting priority: %d\n", priority);
+    ob_debug_type(OB_DEBUG_SM, "Setting priority: %d", priority);
     SmcSetProperties(sm_conn, 1, &list);
     g_free(prop.name);
     g_free(prop.type);
 }
 
-static void session_setup_clone_command()
+static void session_setup_clone_command(void)
 {
     gint i;
 
@@ -312,11 +319,11 @@ static void session_setup_clone_command()
     };
     SmProp *list = ∝
 
-    ob_debug_type(OB_DEBUG_SM, "Setting clone command: (%d)\n", sm_argc);
+    ob_debug_type(OB_DEBUG_SM, "Setting clone command: (%d)", sm_argc);
     for (i = 0; i < sm_argc; ++i) {
         vals[i].value = sm_argv[i];
         vals[i].length = strlen(sm_argv[i]) + 1;
-        ob_debug_type(OB_DEBUG_SM, "    %s\n", vals[i].value);
+        ob_debug_type(OB_DEBUG_SM, "    %s", vals[i].value);
     }
 
     SmcSetProperties(sm_conn, 1, &list);
@@ -325,7 +332,7 @@ static void session_setup_clone_command()
     g_free(vals);
 }
 
-static void session_setup_restart_command()
+static void session_setup_restart_command(void)
 {
     gint i;
 
@@ -338,26 +345,26 @@ static void session_setup_restart_command()
     };
     SmProp *list = &prop;
 
-    ob_debug_type(OB_DEBUG_SM, "Setting restart command: (%d)\n", sm_argc+4);
+    ob_debug_type(OB_DEBUG_SM, "Setting restart command: (%d)", sm_argc+4);
     for (i = 0; i < sm_argc; ++i) {
         vals[i].value = sm_argv[i];
         vals[i].length = strlen(sm_argv[i]) + 1;
-        ob_debug_type(OB_DEBUG_SM, "    %s\n", vals[i].value);
+        ob_debug_type(OB_DEBUG_SM, "    %s", vals[i].value);
     }
 
     vals[i].value = g_strdup("--sm-client-id");
     vals[i].length = strlen("--sm-client-id") + 1;
     vals[i+1].value = ob_sm_id;
     vals[i+1].length = strlen(ob_sm_id) + 1;
-    ob_debug_type(OB_DEBUG_SM, "    %s\n", vals[i].value);
-    ob_debug_type(OB_DEBUG_SM, "    %s\n", vals[i+1].value);
+    ob_debug_type(OB_DEBUG_SM, "    %s", vals[i].value);
+    ob_debug_type(OB_DEBUG_SM, "    %s", vals[i+1].value);
 
     vals[i+2].value = g_strdup("--sm-save-file");
     vals[i+2].length = strlen("--sm-save-file") + 1;
     vals[i+3].value = ob_sm_save_file;
     vals[i+3].length = strlen(ob_sm_save_file) + 1;
-    ob_debug_type(OB_DEBUG_SM, "    %s\n", vals[i+2].value);
-    ob_debug_type(OB_DEBUG_SM, "    %s\n", vals[i+3].value);
+    ob_debug_type(OB_DEBUG_SM, "    %s", vals[i+2].value);
+    ob_debug_type(OB_DEBUG_SM, "    %s", vals[i+3].value);
 
     SmcSetProperties(sm_conn, 1, &list);
     g_free(prop.name);
@@ -367,7 +374,7 @@ static void session_setup_restart_command()
     g_free(vals);
 }
 
-static ObSMSaveData *sm_save_get_data()
+static ObSMSaveData *sm_save_get_data(void)
 {
     ObSMSaveData *savedata = g_new0(ObSMSaveData, 1);
     /* save the active desktop and client.
@@ -385,9 +392,9 @@ static void sm_save_yourself_2(SmcConn conn, SmPointer data)
     ObSMSaveData *savedata = data;
 
     /* save the current state */
-    ob_debug_type(OB_DEBUG_SM, "Session save phase 2 requested\n");
+    ob_debug_type(OB_DEBUG_SM, "Session save phase 2 requested");
     ob_debug_type(OB_DEBUG_SM,
-                  "  Saving session to file '%s'\n", ob_sm_save_file);
+                  "  Saving session to file '%s'", ob_sm_save_file);
     if (savedata == NULL)
         savedata = sm_save_get_data();
     success = session_save_to_file(savedata);
@@ -396,21 +403,35 @@ static void sm_save_yourself_2(SmcConn conn, SmPointer data)
     /* tell the session manager how to restore this state */
     if (success) session_setup_restart_command();
 
-    ob_debug_type(OB_DEBUG_SM, "Saving is done (success = %d)\n", success);
+    ob_debug_type(OB_DEBUG_SM, "Saving is done (success = %d)", success);
     SmcSaveYourselfDone(conn, success);
 }
 
-
 static void sm_save_yourself(SmcConn conn, SmPointer data, gint save_type,
                              Bool shutdown, gint interact_style, Bool fast)
 {
     ObSMSaveData *savedata = NULL;
     gchar *vendor;
 
-    ob_debug_type(OB_DEBUG_SM, "Session save requested\n");
+#ifdef DEBUG
+    {
+        const gchar *sname =
+            (save_type == SmSaveLocal ? "SmSaveLocal" :
+             (save_type == SmSaveGlobal ? "SmSaveGlobal" :
+              (save_type == SmSaveBoth ? "SmSaveBoth" : "INVALID!!")));
+        ob_debug_type(OB_DEBUG_SM, "Session save requested, type %s", sname);
+    }
+#endif
+
+    if (save_type == SmSaveGlobal) {
+        /* we have no data to save.  we only store state to get back to where
+           we were, we don't keep open writable files or anything */
+        SmcSaveYourselfDone(conn, TRUE);
+        return;
+    }
 
     vendor = SmcVendor(sm_conn);
-    ob_debug_type(OB_DEBUG_SM, "Session manager's vendor: %s\n", vendor);
+    ob_debug_type(OB_DEBUG_SM, "Session manager's vendor: %s", vendor);
 
     if (!strcmp(vendor, "KDE")) {
         /* ksmserver guarantees that phase 1 will complete before allowing any
@@ -421,7 +442,7 @@ static void sm_save_yourself(SmcConn conn, SmPointer data, gint save_type,
     free(vendor);
 
     if (!SmcRequestSaveYourselfPhase2(conn, sm_save_yourself_2, savedata)) {
-        ob_debug_type(OB_DEBUG_SM, "Requst for phase 2 failed\n");
+        ob_debug_type(OB_DEBUG_SM, "Requst for phase 2 failed");
         g_free(savedata);
         SmcSaveYourselfDone(conn, FALSE);
     }
@@ -429,18 +450,18 @@ static void sm_save_yourself(SmcConn conn, SmPointer data, gint save_type,
 
 static void sm_die(SmcConn conn, SmPointer data)
 {
-    ob_debug_type(OB_DEBUG_SM, "Die requested\n");
+    ob_debug_type(OB_DEBUG_SM, "Die requested");
     ob_exit(0);
 }
 
 static void sm_save_complete(SmcConn conn, SmPointer data)
 {
-    ob_debug_type(OB_DEBUG_SM, "Save complete\n");
+    ob_debug_type(OB_DEBUG_SM, "Save complete");
 }
 
 static void sm_shutdown_cancelled(SmcConn conn, SmPointer data)
 {
-    ob_debug_type(OB_DEBUG_SM, "Shutdown cancelled\n");
+    ob_debug_type(OB_DEBUG_SM, "Shutdown cancelled");
 }
 
 static gboolean session_save_to_file(const ObSMSaveData *savedata)
@@ -452,7 +473,7 @@ static gboolean session_save_to_file(const ObSMSaveData *savedata)
     f = fopen(ob_sm_save_file, "w");
     if (!f) {
         success = FALSE;
-        g_message(_("Unable to save the session to '%s': %s"),
+        g_message(_("Unable to save the session to \"%s\": %s"),
                   ob_sm_save_file, g_strerror(errno));
     } else {
         fprintf(f, "<?xml version=\"1.0\"?>\n\n");
@@ -475,10 +496,14 @@ static gboolean session_save_to_file(const ObSMSaveData *savedata)
 
         if (screen_desktop_names) {
             gint i;
+            gchar *t;
 
             fprintf(f, "<desktopnames>\n");
-            for (i = 0; screen_desktop_names[i]; ++i)
-                fprintf(f, "  <name>%s</name>\n", screen_desktop_names[i]);
+            for (i = 0; screen_desktop_names[i]; ++i){
+                t = g_markup_escape_text(screen_desktop_names[i], -1);
+                fprintf(f, "  <name>%s</name>\n", t);
+                g_free(t);
+            }
             fprintf(f, "</desktopnames>\n");
         }
 
@@ -498,18 +523,18 @@ static gboolean session_save_to_file(const ObSMSaveData *savedata)
 
             if (!c->sm_client_id) {
                 ob_debug_type(OB_DEBUG_SM, "Client %s does not have a "
-                              "session id set\n",
+                              "session id set",
                               c->title);
                 if (!c->wm_command) {
                     ob_debug_type(OB_DEBUG_SM, "Client %s does not have an "
                                   "oldskool wm_command set either. We won't "
-                                  "be saving its data\n",
+                                  "be saving its data",
                                   c->title);
                     continue;
                 }
             }
 
-            ob_debug_type(OB_DEBUG_SM, "Saving state for client %s\n",
+            ob_debug_type(OB_DEBUG_SM, "Saving state for client %s",
                           c->title);
 
             prex = c->area.x;
@@ -533,8 +558,11 @@ static gboolean session_save_to_file(const ObSMSaveData *savedata)
 
             if (c->sm_client_id)
                 fprintf(f, "<window id=\"%s\">\n", c->sm_client_id);
-            else
-                fprintf(f, "<window command=\"%s\">\n", c->wm_command);
+            else {
+                t = g_markup_escape_text(c->wm_command, -1);
+                fprintf(f, "<window command=\"%s\">\n", t);
+                g_free(t);
+            }
 
             t = g_markup_escape_text(c->name, -1);
             fprintf(f, "\t<name>%s</name>\n", t);
@@ -584,7 +612,7 @@ static gboolean session_save_to_file(const ObSMSaveData *savedata)
 
         if (fflush(f)) {
             success = FALSE;
-            g_message(_("Error while saving the session to '%s': %s"),
+            g_message(_("Error while saving the session to \"%s\": %s"),
                       ob_sm_save_file, g_strerror(errno));
         }
         fclose(f);
@@ -608,20 +636,20 @@ static void session_state_free(ObSessionState *state)
 
 static gboolean session_state_cmp(ObSessionState *s, ObClient *c)
 {
-    ob_debug_type(OB_DEBUG_SM, "Comparing client against saved state: \n");
-    ob_debug_type(OB_DEBUG_SM, "  client id: %s \n", c->sm_client_id);
-    ob_debug_type(OB_DEBUG_SM, "  client name: %s \n", c->name);
-    ob_debug_type(OB_DEBUG_SM, "  client class: %s \n", c->class);
-    ob_debug_type(OB_DEBUG_SM, "  client role: %s \n", c->role);
-    ob_debug_type(OB_DEBUG_SM, "  client type: %d \n", c->type);
-    ob_debug_type(OB_DEBUG_SM, "  client command: %s \n",
+    ob_debug_type(OB_DEBUG_SM, "Comparing client against saved state: ");
+    ob_debug_type(OB_DEBUG_SM, "  client id: %s ", c->sm_client_id);
+    ob_debug_type(OB_DEBUG_SM, "  client name: %s ", c->name);
+    ob_debug_type(OB_DEBUG_SM, "  client class: %s ", c->class);
+    ob_debug_type(OB_DEBUG_SM, "  client role: %s ", c->role);
+    ob_debug_type(OB_DEBUG_SM, "  client type: %d ", c->type);
+    ob_debug_type(OB_DEBUG_SM, "  client command: %s ",
                   c->wm_command ? c->wm_command : "(null)");
-    ob_debug_type(OB_DEBUG_SM, "  state id: %s \n", s->id);
-    ob_debug_type(OB_DEBUG_SM, "  state name: %s \n", s->name);
-    ob_debug_type(OB_DEBUG_SM, "  state class: %s \n", s->class);
-    ob_debug_type(OB_DEBUG_SM, "  state role: %s \n", s->role);
-    ob_debug_type(OB_DEBUG_SM, "  state type: %d \n", s->type);
-    ob_debug_type(OB_DEBUG_SM, "  state command: %s \n",
+    ob_debug_type(OB_DEBUG_SM, "  state id: %s ", s->id);
+    ob_debug_type(OB_DEBUG_SM, "  state name: %s ", s->name);
+    ob_debug_type(OB_DEBUG_SM, "  state class: %s ", s->class);
+    ob_debug_type(OB_DEBUG_SM, "  state role: %s ", s->role);
+    ob_debug_type(OB_DEBUG_SM, "  state type: %d ", s->type);
+    ob_debug_type(OB_DEBUG_SM, "  state command: %s ",
                   s->command ? s->command : "(null)");
 
     if ((c->sm_client_id && s->id && !strcmp(c->sm_client_id, s->id)) ||
@@ -663,6 +691,7 @@ static void session_load_file(const gchar *path)
     i = obt_parse_instance_new();
 
     if (!obt_parse_load_file(i, path, "openbox_session")) {
+        ob_debug_type(OB_DEBUG_SM, "ERROR: session file is missing root node");
         obt_parse_instance_unref(i);
         return;
     }
@@ -696,6 +725,7 @@ static void session_load_file(const gchar *path)
         }
     }
 
+    ob_debug_type(OB_DEBUG_SM, "loading windows");
     for (node = obt_parse_find_node(node->children, "window"); node != NULL;
          node = obt_parse_find_node(node->next, "window"))
     {
@@ -760,9 +790,11 @@ static void session_load_file(const gchar *path)
         /* save this. they are in the file in stacking order, so preserve
            that order here */
         session_saved_state = g_list_append(session_saved_state, state);
+        ob_debug_type(OB_DEBUG_SM, "loaded %s", state->name);
         continue;
 
     session_load_bail:
+        ob_debug_type(OB_DEBUG_SM, "loading FAILED");
         session_state_free(state);
     }
 
@@ -797,6 +829,7 @@ static void session_load_file(const gchar *path)
                 !strcmp(s1->class, s2->class) &&
                 !strcmp(s1->role, s2->role))
             {
+                ob_debug_type(OB_DEBUG_SM, "removing duplicate %s", s2->name);
                 session_state_free(s2);
                 session_saved_state =
                     g_list_delete_link(session_saved_state, jt);
@@ -805,6 +838,7 @@ static void session_load_file(const gchar *path)
         }
 
         if (founddup) {
+            ob_debug_type(OB_DEBUG_SM, "removing duplicate %s", s1->name);
             session_state_free(s1);
             session_saved_state = g_list_delete_link(session_saved_state, it);
         }
@@ -813,4 +847,20 @@ static void session_load_file(const gchar *path)
     obt_parse_instance_unref(i);
 }
 
+void session_request_logout(gboolean silent)
+{
+    if (sm_conn) {
+        SmcRequestSaveYourself(sm_conn,
+                               SmSaveGlobal,
+                               TRUE, /* logout */
+                               (silent ?
+                                SmInteractStyleNone : SmInteractStyleAny),
+                               TRUE,  /* if false, with GSM, it shows the old
+                                         logout prompt */
+                               TRUE); /* global */
+    }
+    else
+        g_message(_("Not connected to a session manager"));
+}
+
 #endif