use SmSaveGlobal to log out. this will make apps save their documents or whatever...
[mikachu/openbox.git] / openbox / session.c
index 124ff8b..82e292b 100644 (file)
@@ -24,18 +24,23 @@ struct _ObClient;
 
 GList *session_saved_state = NULL;
 gint session_desktop = -1;
+gint session_num_desktops = 0;
+gboolean session_desktop_layout_present = FALSE;
+ObDesktopLayout session_desktop_layout;
+GSList *session_desktop_names = NULL;
 
 #ifndef USE_SM
 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) {}
 #else
 
 #include "debug.h"
 #include "openbox.h"
 #include "client.h"
 #include "prop.h"
-#include "screen.h"
+#include "focus.h"
 #include "gettext.h"
 #include "parser/parse.h"
 
@@ -56,10 +61,16 @@ static SmcConn  sm_conn;
 static gint     sm_argc;
 static gchar  **sm_argv;
 
+/* Data saved from the first level save yourself */
+typedef struct {
+    ObClient *focus_client;
+    gint      desktop;
+} ObSMSaveData;
+
 static gboolean session_connect();
 
-static void session_load_file(gchar *path);
-static gboolean session_save_to_file();
+static void session_load_file(const gchar *path);
+static gboolean session_save_to_file(const ObSMSaveData *savedata);
 
 static void session_setup_program();
 static void session_setup_user();
@@ -90,14 +101,16 @@ void session_startup(gint argc, gchar **argv)
     dir = g_build_filename(parse_xdg_data_home_path(),
                            "openbox", "sessions", NULL);
     if (!parse_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) {
-        ob_debug_type(OB_DEBUG_SM, "Loading from session file %s\n",
-                      ob_sm_save_file);
-        session_load_file(ob_sm_save_file);
+        if (ob_sm_restore) {
+            ob_debug_type(OB_DEBUG_SM, "Loading from session file %s\n",
+                          ob_sm_save_file);
+            session_load_file(ob_sm_save_file);
+        }
     } else {
         gchar *filename;
 
@@ -129,7 +142,8 @@ void session_shutdown(gboolean permanent)
     if (sm_conn) {
         /* if permanent is true then we will change our session state so that
            the SM won't run us again */
-        session_setup_restart_style(!permanent);
+        if (permanent)
+            session_setup_restart_style(FALSE);
 
         SmcCloseConnection(sm_conn, 0, NULL);
 
@@ -168,8 +182,9 @@ static gboolean session_connect()
                                 SmcSaveCompleteProcMask |
                                 SmcShutdownCancelledProcMask,
                                 &cb, oldid, &ob_sm_id,
-                                SM_ERR_LEN, sm_err);
+                                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);
     if (sm_conn == NULL)
         ob_debug("Failed to connect to session manager: %s\n", sm_err);
     return sm_conn != NULL;
@@ -188,6 +203,7 @@ static void session_setup_program()
         .vals = &vals
     };
     SmProp *list = ∝
+    ob_debug_type(OB_DEBUG_SM, "Setting program: %s\n", sm_argv[0]);
     SmcSetProperties(sm_conn, 1, &list);
     g_free(prop.name);
     g_free(prop.type);
@@ -208,6 +224,7 @@ static void session_setup_user()
         .vals = &vals
     };
     SmProp *list = ∝
+    ob_debug_type(OB_DEBUG_SM, "Setting user: %s\n", user);
     SmcSetProperties(sm_conn, 1, &list);
     g_free(prop.name);
     g_free(prop.type);
@@ -216,7 +233,7 @@ static void session_setup_user()
 
 static void session_setup_restart_style(gboolean restart)
 {
-    char restart_hint = restart ? SmRestartImmediately : SmRestartIfRunning;
+    gchar restart_hint = restart ? SmRestartImmediately : SmRestartIfRunning;
 
     SmPropValue vals = {
         .value = &restart_hint,
@@ -229,6 +246,7 @@ static void session_setup_restart_style(gboolean restart)
         .vals = &vals
     };
     SmProp *list = ∝
+    ob_debug_type(OB_DEBUG_SM, "Setting restart: %d\n", restart);
     SmcSetProperties(sm_conn, 1, &list);
     g_free(prop.name);
     g_free(prop.type);
@@ -249,6 +267,7 @@ static void session_setup_pid()
         .vals = &vals
     };
     SmProp *list = ∝
+    ob_debug_type(OB_DEBUG_SM, "Setting pid: %s\n", pid);
     SmcSetProperties(sm_conn, 1, &list);
     g_free(prop.name);
     g_free(prop.type);
@@ -271,6 +290,7 @@ static void session_setup_priority()
         .vals = &vals
     };
     SmProp *list = ∝
+    ob_debug_type(OB_DEBUG_SM, "Setting priority: %d\n", priority);
     SmcSetProperties(sm_conn, 1, &list);
     g_free(prop.name);
     g_free(prop.type);
@@ -287,13 +307,15 @@ static void session_setup_clone_command()
         .num_vals = sm_argc,
         .vals = vals
     };
+    SmProp *list = ∝
 
+    ob_debug_type(OB_DEBUG_SM, "Setting clone command: (%d)\n", 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);
     }
 
-    SmProp *list = &prop;
     SmcSetProperties(sm_conn, 1, &list);
     g_free(prop.name);
     g_free(prop.type);
@@ -311,23 +333,29 @@ static void session_setup_restart_command()
         .num_vals = sm_argc + 4,
         .vals = vals
     };
+    SmProp *list = &prop;
 
+    ob_debug_type(OB_DEBUG_SM, "Setting restart command: (%d)\n", 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);
     }
 
-    vals[i].value = g_strdup("--sm-save-file");
-    vals[i].length = strlen("--sm-save-file") + 1;
-    vals[i+1].value = ob_sm_save_file;
-    vals[i+1].length = strlen(ob_sm_save_file) + 1;
+    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);
 
-    vals[i+2].value = g_strdup("--sm-client-id");
-    vals[i+2].length = strlen("--sm-client-id") + 1;
-    vals[i+3].value = ob_sm_id;
-    vals[i+3].length = strlen(ob_sm_id) + 1;
+    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);
 
-    SmProp *list = &prop;
     SmcSetProperties(sm_conn, 1, &list);
     g_free(prop.name);
     g_free(prop.type);
@@ -336,15 +364,31 @@ static void session_setup_restart_command()
     g_free(vals);
 }
 
+static ObSMSaveData *sm_save_get_data()
+{
+    ObSMSaveData *savedata = g_new0(ObSMSaveData, 1);
+    /* save the active desktop and client.
+       we don't bother to preemptively save the other desktop state like
+       number and names of desktops, cuz those shouldn't be changing during
+       the save.. */
+    savedata->focus_client = focus_client;
+    savedata->desktop = screen_desktop;
+    return savedata;
+}
+
 static void sm_save_yourself_2(SmcConn conn, SmPointer data)
 {
     gboolean success;
+    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,
                   "  Saving session to file '%s'\n", ob_sm_save_file);
-    success = session_save_to_file();
+    if (savedata == NULL)
+        savedata = sm_save_get_data();
+    success = session_save_to_file(savedata);
+    g_free(savedata);
 
     /* tell the session manager how to restore this state */
     if (success) session_setup_restart_command();
@@ -357,9 +401,25 @@ static void sm_save_yourself_2(SmcConn conn, SmPointer data)
 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");
-    if (!SmcRequestSaveYourselfPhase2(conn, sm_save_yourself_2, data)) {
+
+    vendor = SmcVendor(sm_conn);
+    ob_debug_type(OB_DEBUG_SM, "Session manager's vendor: %s\n", vendor);
+
+    if (!strcmp(vendor, "KDE")) {
+        /* ksmserver guarantees that phase 1 will complete before allowing any
+           clients interaction, so we can save this sanely here before they
+           get messed up from interaction */
+        savedata = sm_save_get_data();
+    }
+    free(vendor);
+
+    if (!SmcRequestSaveYourselfPhase2(conn, sm_save_yourself_2, savedata)) {
         ob_debug_type(OB_DEBUG_SM, "Requst for phase 2 failed\n");
+        g_free(savedata);
         SmcSaveYourselfDone(conn, FALSE);
     }
 }
@@ -377,10 +437,10 @@ static void sm_save_complete(SmcConn conn, SmPointer data)
 
 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\n");
 }
 
-static gboolean session_save_to_file()
+static gboolean session_save_to_file(const ObSMSaveData *savedata)
 {
     FILE *f;
     GList *it;
@@ -389,13 +449,35 @@ static gboolean session_save_to_file()
     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");
         fprintf(f, "<openbox_session>\n\n");
 
-        fprintf(f, "<desktop>%d</desktop>\n", screen_desktop);
+        fprintf(f, "<desktop>%d</desktop>\n", savedata->desktop);
+
+        fprintf(f, "<numdesktops>%d</numdesktops>\n", screen_num_desktops);
+
+        fprintf(f, "<desktoplayout>\n");
+        fprintf(f, "  <orientation>%d</orientation>\n",
+                screen_desktop_layout.orientation);
+        fprintf(f, "  <startcorner>%d</startcorner>\n",
+                screen_desktop_layout.start_corner);
+        fprintf(f, "  <columns>%d</columns>\n",
+                screen_desktop_layout.columns);
+        fprintf(f, "  <rows>%d</rows>\n",
+                screen_desktop_layout.rows);
+        fprintf(f, "</desktoplayout>\n");
+
+        if (screen_desktop_names) {
+            gint i;
+
+            fprintf(f, "<desktopnames>\n");
+            for (i = 0; screen_desktop_names[i]; ++i)
+                fprintf(f, "  <name>%s</name>\n", screen_desktop_names[i]);
+            fprintf(f, "</desktopnames>\n");
+        }
 
         /* they are ordered top to bottom in stacking order */
         for (it = stacking_list; it; it = g_list_next(it)) {
@@ -412,10 +494,16 @@ static gboolean session_save_to_file()
                 continue;
 
             if (!c->sm_client_id) {
-                ob_debug_type(OB_DEBUG_SM, "Client %s does not have a client "
-                              "id set, so we can't save its state\n",
+                ob_debug_type(OB_DEBUG_SM, "Client %s does not have a "
+                              "session id set\n",
                               c->title);
-                continue;
+                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",
+                                  c->title);
+                    continue;
+                }
             }
 
             ob_debug_type(OB_DEBUG_SM, "Saving state for client %s\n",
@@ -440,7 +528,10 @@ static gboolean session_save_to_file()
                 preh = c->pre_max_area.height;
             }
 
-            fprintf(f, "<window id=\"%s\">\n", c->sm_client_id);
+            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);
 
             t = g_markup_escape_text(c->name, -1);
             fprintf(f, "\t<name>%s</name>\n", t);
@@ -454,6 +545,8 @@ static gboolean session_save_to_file()
             fprintf(f, "\t<role>%s</role>\n", t);
             g_free(t);
 
+            fprintf(f, "\t<windowtype>%d</windowtype>\n", c->type);
+
             fprintf(f, "\t<desktop>%d</desktop>\n", c->desktop);
             fprintf(f, "\t<x>%d</x>\n", prex);
             fprintf(f, "\t<y>%d</y>\n", prey);
@@ -479,7 +572,7 @@ static gboolean session_save_to_file()
                 fprintf(f, "\t<max_vert />\n");
             if (c->undecorated)
                 fprintf(f, "\t<undecorated />\n");
-            if (client_focused(c))
+            if (savedata->focus_client == c)
                 fprintf(f, "\t<focused />\n");
             fprintf(f, "</window>\n\n");
         }
@@ -488,7 +581,7 @@ static gboolean session_save_to_file()
 
         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);
@@ -501,6 +594,7 @@ static void session_state_free(ObSessionState *state)
 {
     if (state) {
         g_free(state->id);
+        g_free(state->command);
         g_free(state->name);
         g_free(state->class);
         g_free(state->role);
@@ -516,15 +610,31 @@ static gboolean session_state_cmp(ObSessionState *s, ObClient *c)
     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",
+                  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);
-    return (c->sm_client_id &&
-            !strcmp(s->id, c->sm_client_id) &&
-            !strcmp(s->name, c->name) &&
-            !strcmp(s->class, c->class) &&
-            !strcmp(s->role, c->role));
+    ob_debug_type(OB_DEBUG_SM, "  state type: %d \n", s->type);
+    ob_debug_type(OB_DEBUG_SM, "  state command: %s \n",
+                  s->command ? s->command : "(null)");
+
+    if ((c->sm_client_id && s->id && !strcmp(c->sm_client_id, s->id)) ||
+        (c->wm_command && s->command && !strcmp(c->wm_command, s->command)))
+    {
+        return (!strcmp(s->name, c->name) &&
+                !strcmp(s->class, c->class) &&
+                !strcmp(s->role, c->role) &&
+                /* the check for type is to catch broken clients, like
+                   firefox, which open a different window on startup
+                   with the same info as the one we saved. only do this
+                   check for old windows that dont use xsmp, others should
+                   know better ! */
+                (!s->command || c->type == s->type));
+    }
+    return FALSE;
 }
 
 GList* session_state_find(ObClient *c)
@@ -541,10 +651,11 @@ GList* session_state_find(ObClient *c)
     return it;
 }
 
-static void session_load_file(gchar *path)
+static void session_load_file(const gchar *path)
 {
     xmlDocPtr doc;
-    xmlNodePtr node, n;
+    xmlNodePtr node, n, m;
+    GList *it, *inext;
 
     if (!parse_load(path, "openbox_session", &doc, &node))
         return;
@@ -552,6 +663,31 @@ static void session_load_file(gchar *path)
     if ((n = parse_find_node("desktop", node->children)))
         session_desktop = parse_int(doc, n);
 
+    if ((n = parse_find_node("numdesktops", node->children)))
+        session_num_desktops = parse_int(doc, n);
+
+    if ((n = parse_find_node("desktoplayout", node->children))) {
+        /* make sure they are all there for it to be valid */
+        if ((m = parse_find_node("orientation", n->children)))
+            session_desktop_layout.orientation = parse_int(doc, m);
+        if (m && (m = parse_find_node("startcorner", n->children)))
+            session_desktop_layout.start_corner = parse_int(doc, m);
+        if (m && (m = parse_find_node("columns", n->children)))
+            session_desktop_layout.columns = parse_int(doc, m);
+        if (m && (m = parse_find_node("rows", n->children)))
+            session_desktop_layout.rows = parse_int(doc, m);
+        session_desktop_layout_present = m != NULL;
+    }
+
+    if ((n = parse_find_node("desktopnames", node->children))) {
+        for (m = parse_find_node("name", n->children); m;
+             m = parse_find_node("name", m->next))
+        {
+            session_desktop_names = g_slist_append(session_desktop_names,
+                                                   parse_string(doc, m));
+        }
+    }
+
     for (node = parse_find_node("window", node->children); node != NULL;
          node = parse_find_node("window", node->next))
     {
@@ -560,6 +696,7 @@ static void session_load_file(gchar *path)
         state = g_new0(ObSessionState, 1);
 
         if (!parse_attr_string("id", node, &state->id))
+            if (!parse_attr_string("command", node, &state->command))
             goto session_load_bail;
         if (!(n = parse_find_node("name", node->children)))
             goto session_load_bail;
@@ -570,6 +707,9 @@ static void session_load_file(gchar *path)
         if (!(n = parse_find_node("role", node->children)))
             goto session_load_bail;
         state->role = parse_string(doc, n);
+        if (!(n = parse_find_node("windowtype", node->children)))
+            goto session_load_bail;
+        state->type = parse_int(doc, n);
         if (!(n = parse_find_node("desktop", node->children)))
             goto session_load_bail;
         state->desktop = parse_int(doc, n);
@@ -608,7 +748,7 @@ static void session_load_file(gchar *path)
             parse_find_node("undecorated", node->children) != NULL;
         state->focused =
             parse_find_node("focused", node->children) != NULL;
-        
+
         /* 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);
@@ -618,7 +758,67 @@ static void session_load_file(gchar *path)
         session_state_free(state);
     }
 
+    /* Remove any duplicates.  This means that if two windows (or more) are
+       saved with the same session state, we won't restore a session for any
+       of them because we don't know what window to put what on. AHEM FIREFOX.
+
+       This is going to be an O(2^n) kind of operation unfortunately.
+    */
+    for (it = session_saved_state; it; it = inext) {
+        GList *jt, *jnext;
+        gboolean founddup = FALSE;
+        ObSessionState *s1 = it->data;
+
+        inext = g_list_next(it);
+
+        for (jt = g_list_next(it); jt; jt = jnext) {
+            ObSessionState *s2 = jt->data;
+            gboolean match;
+
+            jnext = g_list_next(jt);
+
+            if (s1->id && s2->id)
+                match = strcmp(s1->id, s2->id) == 0;
+            else if (s1->command && s2->command)
+                match = strcmp(s1->command, s2->command) == 0;
+            else
+                match = FALSE;
+
+            if (match &&
+                !strcmp(s1->name, s2->name) &&
+                !strcmp(s1->class, s2->class) &&
+                !strcmp(s1->role, s2->role))
+            {
+                session_state_free(s2);
+                session_saved_state =
+                    g_list_delete_link(session_saved_state, jt);
+                founddup = TRUE;
+            }
+        }
+
+        if (founddup) {
+            session_state_free(s1);
+            session_saved_state = g_list_delete_link(session_saved_state, it);
+        }
+    }
+
     xmlFreeDoc(doc);
 }
 
+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