1 /* -*- indent-tabs-mode: nil; tab-width: 4; c-basic-offset: 4; -*-
3 session.c for the Openbox window manager
4 Copyright (c) 2003 Ben Jansens
6 This program is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2 of the License, or
9 (at your option) any later version.
11 This program is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 See the COPYING file for a copy of the GNU General Public License.
19 /* This session code is largely inspired by metacity code. */
26 GList *session_saved_state;
28 void session_startup(gint argc, gchar **argv) {}
29 void session_shutdown(gboolean permanent) {}
30 GList* session_state_find(ObClient *c) { return NULL; }
31 gboolean session_state_cmp(ObSessionState *s, ObClient *c) { return FALSE; }
32 void session_state_free(ObSessionState *state) {}
42 #include "parser/parse.h"
49 # include <sys/types.h>
53 #include <X11/SM/SMlib.h>
55 GList *session_saved_state;
57 static gboolean sm_disable;
58 static SmcConn sm_conn;
59 static gchar *save_file;
62 static gchar **sm_argv;
63 static gchar *sm_sessions_path;
65 static void session_load(gchar *path);
66 static gboolean session_save();
68 static void sm_save_yourself(SmcConn conn, SmPointer data, gint save_type,
69 Bool shutdown, gint interact_style, Bool fast);
70 static void sm_die(SmcConn conn, SmPointer data);
71 static void sm_save_complete(SmcConn conn, SmPointer data);
72 static void sm_shutdown_cancelled(SmcConn conn, SmPointer data);
74 static void save_commands()
77 SmProp prop_cmd = { SmCloneCommand, SmLISTofARRAY8, 1, };
78 SmProp prop_res = { SmRestartCommand, SmLISTofARRAY8, };
81 prop_cmd.vals = g_new(SmPropValue, sm_argc);
82 prop_cmd.num_vals = sm_argc;
83 for (i = 0; i < sm_argc; ++i) {
84 prop_cmd.vals[i].value = sm_argv[i];
85 prop_cmd.vals[i].length = strlen(sm_argv[i]);
88 prop_res.vals = g_new(SmPropValue, sm_argc + 2);
89 prop_res.num_vals = sm_argc + 2;
90 for (i = 0; i < sm_argc; ++i) {
91 prop_res.vals[i].value = sm_argv[i];
92 prop_res.vals[i].length = strlen(sm_argv[i]);
95 prop_res.vals[i].value = "--sm-save-file";
96 prop_res.vals[i++].length = strlen("--sm-save-file");
97 prop_res.vals[i].value = save_file;
98 prop_res.vals[i++].length = strlen(save_file);
100 props[0] = &prop_res;
101 props[1] = &prop_cmd;
102 SmcSetProperties(sm_conn, 2, props);
104 g_free(prop_res.vals);
105 g_free(prop_cmd.vals);
108 static void remove_args(gint *argc, gchar ***argv, gint index, gint num)
112 for (i = index; i < index + num; ++i)
113 (*argv)[i] = (*argv)[i+num];
117 static void parse_args(gint *argc, gchar ***argv)
121 for (i = 1; i < *argc; ++i) {
122 if (!strcmp((*argv)[i], "--sm-client-id")) {
123 if (i == *argc - 1) /* no args left */
124 g_printerr(_("--sm-client-id requires an argument\n"));
126 sm_id = g_strdup((*argv)[i+1]);
127 remove_args(argc, argv, i, 2);
130 } else if (!strcmp((*argv)[i], "--sm-save-file")) {
131 if (i == *argc - 1) /* no args left */
132 g_printerr(_("--sm-save-file requires an argument\n"));
134 save_file = g_strdup((*argv)[i+1]);
135 remove_args(argc, argv, i, 2);
138 } else if (!strcmp((*argv)[i], "--sm-disable")) {
140 remove_args(argc, argv, i, 1);
145 void session_startup(gint argc, gchar **argv)
147 #define SM_ERR_LEN 1024
150 gchar sm_err[SM_ERR_LEN];
154 sm_argv = g_new(gchar*, argc);
155 for (i = 0; i < argc; ++i)
156 sm_argv[i] = argv[i];
158 parse_args(&sm_argc, &sm_argv);
165 sm_sessions_path = g_build_filename(parse_xdg_data_home_path(),
166 "openbox", "sessions", NULL);
167 if (!parse_mkdir_path(sm_sessions_path, 0700))
168 g_warning(_("Unable to make directory '%s': %s"),
169 sm_sessions_path, g_strerror(errno));
172 session_load(save_file);
176 /* this algo is from metacity */
177 filename = g_strdup_printf("%d-%d-%u.obs",
181 save_file = g_build_filename(sm_sessions_path, filename, NULL);
185 cb.save_yourself.callback = sm_save_yourself;
186 cb.save_yourself.client_data = NULL;
188 cb.die.callback = sm_die;
189 cb.die.client_data = NULL;
191 cb.save_complete.callback = sm_save_complete;
192 cb.save_complete.client_data = NULL;
194 cb.shutdown_cancelled.callback = sm_shutdown_cancelled;
195 cb.shutdown_cancelled.client_data = NULL;
197 sm_conn = SmcOpenConnection(NULL, NULL, 1, 0,
198 SmcSaveYourselfProcMask |
200 SmcSaveCompleteProcMask |
201 SmcShutdownCancelledProcMask,
205 ob_debug("Failed to connect to session manager: %s\n", sm_err);
207 SmPropValue val_prog;
209 SmPropValue val_hint;
212 SmProp prop_prog = { SmProgram, SmARRAY8, 1, };
213 SmProp prop_uid = { SmUserID, SmARRAY8, 1, };
214 SmProp prop_hint = { SmRestartStyleHint, SmCARD8, 1, };
215 SmProp prop_pid = { SmProcessID, SmARRAY8, 1, };
216 SmProp prop_pri = { "_GSM_Priority", SmCARD8, 1, };
221 val_prog.value = sm_argv[0];
222 val_prog.length = strlen(sm_argv[0]);
224 val_uid.value = g_strdup(g_get_user_name());
225 val_uid.length = strlen(val_uid.value);
227 hint = SmRestartImmediately;
228 val_hint.value = &hint;
231 g_snprintf(pid, sizeof(pid), "%ld", (glong) getpid());
233 val_pid.length = strlen(pid);
235 /* priority with gnome-session-manager, low to run before other apps */
237 val_pri.value = &pri;
240 prop_prog.vals = &val_prog;
241 prop_uid.vals = &val_uid;
242 prop_hint.vals = &val_hint;
243 prop_pid.vals = &val_pid;
244 prop_pri.vals = &val_pri;
246 props[0] = &prop_prog;
247 props[1] = &prop_uid;
248 props[2] = &prop_hint;
249 props[3] = &prop_pid;
250 props[4] = &prop_pri;
252 SmcSetProperties(sm_conn, 5, props);
254 g_free(val_uid.value);
260 void session_shutdown(gboolean permanent)
265 g_free(sm_sessions_path);
271 /* if permanent is true then we will change our session state so that
272 the SM won't run us again */
274 SmPropValue val_hint;
275 SmProp prop_hint = { SmRestartStyleHint, SmCARD8, 1, };
279 /* when we exit, we want to reset this to a more friendly state */
280 hint = SmRestartIfRunning;
281 val_hint.value = &hint;
284 prop_hint.vals = &val_hint;
286 props[0] = &prop_hint;
288 SmcSetProperties(sm_conn, 1, props);
291 SmcCloseConnection(sm_conn, 0, NULL);
293 while (session_saved_state) {
294 session_state_free(session_saved_state->data);
295 session_saved_state = g_list_delete_link(session_saved_state,
296 session_saved_state);
301 static void sm_save_yourself_phase2(SmcConn conn, SmPointer data)
305 success = session_save();
308 SmcSaveYourselfDone(conn, success);
311 static void sm_save_yourself(SmcConn conn, SmPointer data, gint save_type,
312 Bool shutdown, gint interact_style, Bool fast)
314 if (!SmcRequestSaveYourselfPhase2(conn, sm_save_yourself_phase2, data)) {
315 ob_debug("SAVE YOURSELF PHASE 2 failed\n");
316 SmcSaveYourselfDone(conn, FALSE);
320 static void sm_die(SmcConn conn, SmPointer data)
325 static void sm_save_complete(SmcConn conn, SmPointer data)
329 static void sm_shutdown_cancelled(SmcConn conn, SmPointer data)
333 static gboolean session_save()
337 gboolean success = TRUE;
339 f = fopen(save_file, "w");
342 g_warning("unable to save the session to %s: %s",
343 save_file, g_strerror(errno));
347 fprintf(f, "<?xml version=\"1.0\"?>\n\n");
348 fprintf(f, "<openbox_session id=\"%s\">\n\n", sm_id);
350 for (it = stacking_list; it; it = g_list_next(it)) {
351 gint prex, prey, prew, preh;
355 if (WINDOW_IS_CLIENT(it->data))
356 c = WINDOW_AS_CLIENT(it->data);
360 if (!client_normal(c))
363 if (!c->sm_client_id)
368 prew = c->area.width;
369 preh = c->area.height;
371 prex = c->pre_fullscreen_area.x;
372 prey = c->pre_fullscreen_area.x;
373 prew = c->pre_fullscreen_area.width;
374 preh = c->pre_fullscreen_area.height;
377 prex = c->pre_max_area.x;
378 prew = c->pre_max_area.width;
381 prey = c->pre_max_area.y;
382 preh = c->pre_max_area.height;
385 fprintf(f, "<window id=\"%s\">\n", c->sm_client_id);
387 t = g_markup_escape_text(c->name, -1);
388 fprintf(f, "\t<name>%s</name>\n", t);
391 t = g_markup_escape_text(c->class, -1);
392 fprintf(f, "\t<class>%s</class>\n", t);
395 t = g_markup_escape_text(c->role, -1);
396 fprintf(f, "\t<role>%s</role>\n", t);
399 fprintf(f, "\t<desktop>%d</desktop>\n", c->desktop);
400 fprintf(f, "\t<stacking>%d</stacking>\n", stack_pos);
401 fprintf(f, "\t<x>%d</x>\n", prex);
402 fprintf(f, "\t<y>%d</y>\n", prey);
403 fprintf(f, "\t<width>%d</width>\n", prew);
404 fprintf(f, "\t<height>%d</height>\n", preh);
406 fprintf(f, "\t<shaded />\n");
408 fprintf(f, "\t<iconic />\n");
410 fprintf(f, "\t<skip_pager />\n");
412 fprintf(f, "\t<skip_taskbar />\n");
414 fprintf(f, "\t<fullscreen />\n");
416 fprintf(f, "\t<above />\n");
418 fprintf(f, "\t<below />\n");
420 fprintf(f, "\t<max_horz />\n");
422 fprintf(f, "\t<max_vert />\n");
423 fprintf(f, "</window>\n\n");
428 fprintf(f, "</openbox_session>\n");
432 g_warning("error while saving the session to %s: %s",
433 save_file, g_strerror(errno));
441 void session_state_free(ObSessionState *state)
446 g_free(state->class);
453 gboolean session_state_cmp(ObSessionState *s, ObClient *c)
455 return (c->sm_client_id &&
456 !strcmp(s->id, c->sm_client_id) &&
457 !strcmp(s->name, c->name) &&
458 !strcmp(s->class, c->class) &&
459 !strcmp(s->role, c->role));
462 GList* session_state_find(ObClient *c)
466 for (it = session_saved_state; it; it = g_list_next(it)) {
467 ObSessionState *s = it->data;
468 if (!s->matched && session_state_cmp(s, c)) {
476 static gint stack_sort(const ObSessionState *s1, const ObSessionState *s2)
478 return s1->stacking - s2->stacking;
481 static void session_load(gchar *path)
487 if (!parse_load(path, "openbox_session", &doc, &node))
490 if (!parse_attr_string("id", node, &id))
495 node = parse_find_node("window", node->children);
497 ObSessionState *state;
499 state = g_new0(ObSessionState, 1);
501 if (!parse_attr_string("id", node, &state->id))
502 goto session_load_bail;
503 if (!(n = parse_find_node("name", node->children)))
504 goto session_load_bail;
505 state->name = parse_string(doc, n);
506 if (!(n = parse_find_node("class", node->children)))
507 goto session_load_bail;
508 state->class = parse_string(doc, n);
509 if (!(n = parse_find_node("role", node->children)))
510 goto session_load_bail;
511 state->role = parse_string(doc, n);
512 if (!(n = parse_find_node("stacking", node->children)))
513 goto session_load_bail;
514 state->stacking = parse_int(doc, n);
515 if (!(n = parse_find_node("desktop", node->children)))
516 goto session_load_bail;
517 state->desktop = parse_int(doc, n);
518 if (!(n = parse_find_node("x", node->children)))
519 goto session_load_bail;
520 state->x = parse_int(doc, n);
521 if (!(n = parse_find_node("y", node->children)))
522 goto session_load_bail;
523 state->y = parse_int(doc, n);
524 if (!(n = parse_find_node("width", node->children)))
525 goto session_load_bail;
526 state->w = parse_int(doc, n);
527 if (!(n = parse_find_node("height", node->children)))
528 goto session_load_bail;
529 state->h = parse_int(doc, n);
532 parse_find_node("shaded", node->children) != NULL;
534 parse_find_node("iconic", node->children) != NULL;
536 parse_find_node("skip_pager", node->children) != NULL;
537 state->skip_taskbar =
538 parse_find_node("skip_taskbar", node->children) != NULL;
540 parse_find_node("fullscreen", node->children) != NULL;
542 parse_find_node("above", node->children) != NULL;
544 parse_find_node("below", node->children) != NULL;
546 parse_find_node("max_horz", node->children) != NULL;
548 parse_find_node("max_vert", node->children) != NULL;
551 session_saved_state = g_list_prepend(session_saved_state, state);
552 goto session_load_ok;
555 session_state_free(state);
559 node = parse_find_node("window", node->next);
562 /* sort them by their stacking order */
563 session_saved_state = g_list_sort(session_saved_state,
564 (GCompareFunc)stack_sort);