extra comma
[mikachu/openbox.git] / openbox / session.c
1 /* -*- indent-tabs-mode: nil; tab-width: 4; c-basic-offset: 4; -*-
2
3    session.c for the Openbox window manager
4    Copyright (c) 2003-2007   Dana Jansens
5
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.
10
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.
15
16    See the COPYING file for a copy of the GNU General Public License.
17 */
18
19 /* This session code is largely inspired by metacity code. */
20
21 #ifndef USE_SM
22
23 #include "session.h"
24 #include "client.h"
25
26 GList *session_saved_state;
27
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) {}
33
34 #else
35
36 #include "debug.h"
37 #include "openbox.h"
38 #include "session.h"
39 #include "client.h"
40 #include "prop.h"
41 #include "gettext.h"
42 #include "parser/parse.h"
43
44 #include <time.h>
45 #include <errno.h>
46 #include <stdio.h>
47
48 #ifdef HAVE_UNISTD_H
49 #  include <sys/types.h>
50 #  include <unistd.h>
51 #endif
52
53 #include <X11/SM/SMlib.h>
54
55 GList *session_saved_state;
56
57 static gboolean    sm_disable;
58 static SmcConn     sm_conn;
59 static gchar      *save_file;
60 static gchar      *sm_id;
61 static gint        sm_argc;
62 static gchar     **sm_argv;
63 static gchar      *sm_sessions_path;
64
65 static void session_load(gchar *path);
66 static gboolean session_save();
67
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);
73
74 static void save_commands()
75 {
76     SmProp *props[2];
77     SmProp prop_cmd = { SmCloneCommand, SmLISTofARRAY8, 1, };
78     SmProp prop_res = { SmRestartCommand, SmLISTofARRAY8 };
79     gint i;
80
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]);
86     }
87
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]);
93     }
94
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);
99
100     props[0] = &prop_res;
101     props[1] = &prop_cmd;
102     SmcSetProperties(sm_conn, 2, props);
103
104     g_free(prop_res.vals);
105     g_free(prop_cmd.vals);
106 }
107
108 static void remove_args(gint *argc, gchar ***argv, gint index, gint num)
109 {
110     gint i;
111
112     for (i = index; i < index + num; ++i)
113         (*argv)[i] = (*argv)[i+num];
114     *argc -= num;
115 }
116
117 static void parse_args(gint *argc, gchar ***argv)
118 {
119     gint i;
120
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"));
125             else {
126                 sm_id = g_strdup((*argv)[i+1]);
127                 remove_args(argc, argv, i, 2);
128                 ++i;
129             }
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"));
133             else {
134                 save_file = g_strdup((*argv)[i+1]);
135                 remove_args(argc, argv, i, 2);
136                 ++i;
137             }
138         } else if (!strcmp((*argv)[i], "--sm-disable")) {
139             sm_disable = TRUE;
140             remove_args(argc, argv, i, 1);
141         }
142     }
143 }
144
145 void session_startup(gint argc, gchar **argv)
146 {
147 #define SM_ERR_LEN 1024
148
149     SmcCallbacks cb;
150     gchar sm_err[SM_ERR_LEN];
151     gint i;
152
153     sm_argc = argc;
154     sm_argv = g_new(gchar*, argc);
155     for (i = 0; i < argc; ++i)
156         sm_argv[i] = argv[i];
157
158     parse_args(&sm_argc, &sm_argv);
159
160     if (sm_disable) {
161         g_free(sm_argv);
162         return;
163     }
164
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_message(_("Unable to make directory '%s': %s"),
169                   sm_sessions_path, g_strerror(errno));
170     }
171
172     if (save_file)
173         session_load(save_file);
174     else {
175         gchar *filename;
176
177         /* this algo is from metacity */
178         filename = g_strdup_printf("%d-%d-%u.obs",
179                                    (gint) time(NULL),
180                                    (gint) getpid(),
181                                    g_random_int());
182         save_file = g_build_filename(sm_sessions_path, filename, NULL);
183         g_free(filename);
184     }
185
186     cb.save_yourself.callback = sm_save_yourself;
187     cb.save_yourself.client_data = NULL;
188
189     cb.die.callback = sm_die;
190     cb.die.client_data = NULL;
191
192     cb.save_complete.callback = sm_save_complete;
193     cb.save_complete.client_data = NULL;
194
195     cb.shutdown_cancelled.callback = sm_shutdown_cancelled;
196     cb.shutdown_cancelled.client_data = NULL;
197
198     sm_conn = SmcOpenConnection(NULL, NULL, 1, 0,
199                                 SmcSaveYourselfProcMask |
200                                 SmcDieProcMask |
201                                 SmcSaveCompleteProcMask |
202                                 SmcShutdownCancelledProcMask,
203                                 &cb, sm_id, &sm_id,
204                                 SM_ERR_LEN, sm_err);
205     if (sm_conn == NULL)
206         ob_debug("Failed to connect to session manager: %s\n", sm_err);
207     else {
208         SmPropValue val_prog;
209         SmPropValue val_uid;
210         SmPropValue val_hint; 
211         SmPropValue val_pri;
212         SmPropValue val_pid;
213         SmProp prop_prog = { SmProgram, SmARRAY8, 1, };
214         SmProp prop_uid = { SmUserID, SmARRAY8, 1, };
215         SmProp prop_hint = { SmRestartStyleHint, SmCARD8, 1, };
216         SmProp prop_pid = { SmProcessID, SmARRAY8, 1, };
217         SmProp prop_pri = { "_GSM_Priority", SmCARD8, 1, };
218         SmProp *props[6];
219         gchar hint, pri;
220         gchar pid[32];
221
222         val_prog.value = sm_argv[0];
223         val_prog.length = strlen(sm_argv[0]);
224
225         val_uid.value = g_strdup(g_get_user_name());
226         val_uid.length = strlen(val_uid.value);
227
228         hint = SmRestartImmediately;
229         val_hint.value = &hint;
230         val_hint.length = 1;
231
232         g_snprintf(pid, sizeof(pid), "%ld", (glong) getpid());
233         val_pid.value = pid;
234         val_pid.length = strlen(pid);
235
236         /* priority with gnome-session-manager, low to run before other apps */
237         pri = 20;
238         val_pri.value = &pri;
239         val_pri.length = 1;
240
241         prop_prog.vals = &val_prog;
242         prop_uid.vals = &val_uid;
243         prop_hint.vals = &val_hint;
244         prop_pid.vals = &val_pid;
245         prop_pri.vals = &val_pri;
246
247         props[0] = &prop_prog;
248         props[1] = &prop_uid;
249         props[2] = &prop_hint;
250         props[3] = &prop_pid;
251         props[4] = &prop_pri;
252
253         SmcSetProperties(sm_conn, 5, props);
254
255         g_free(val_uid.value);
256
257         save_commands();
258     }
259 }
260
261 void session_shutdown(gboolean permanent)
262 {
263     if (sm_disable)
264         return;
265
266     g_free(sm_sessions_path);
267     g_free(save_file);
268     g_free(sm_id);
269     g_free(sm_argv);
270
271     if (sm_conn) {
272         /* if permanent is true then we will change our session state so that
273            the SM won't run us again */
274         if (permanent) {
275             SmPropValue val_hint;
276             SmProp prop_hint = { SmRestartStyleHint, SmCARD8, 1, };
277             SmProp *props[1];
278             gulong hint;
279
280             /* when we exit, we want to reset this to a more friendly state */
281             hint = SmRestartIfRunning;
282             val_hint.value = &hint;
283             val_hint.length = 1;
284
285             prop_hint.vals = &val_hint;
286
287             props[0] = &prop_hint;
288
289             SmcSetProperties(sm_conn, 1, props);
290         }
291
292         SmcCloseConnection(sm_conn, 0, NULL);
293
294         while (session_saved_state) {
295             session_state_free(session_saved_state->data);
296             session_saved_state = g_list_delete_link(session_saved_state,
297                                                      session_saved_state);
298         }
299     }
300 }
301
302 static void sm_save_yourself_phase2(SmcConn conn, SmPointer data)
303 {
304     gboolean success;
305
306     success = session_save();
307     save_commands();
308
309     SmcSaveYourselfDone(conn, success);
310 }
311
312 static void sm_save_yourself(SmcConn conn, SmPointer data, gint save_type,
313                              Bool shutdown, gint interact_style, Bool fast)
314 {
315     if (!SmcRequestSaveYourselfPhase2(conn, sm_save_yourself_phase2, data)) {
316         ob_debug("SAVE YOURSELF PHASE 2 failed\n");
317         SmcSaveYourselfDone(conn, FALSE);
318     }
319 }
320
321 static void sm_die(SmcConn conn, SmPointer data)
322 {
323     ob_exit(0);
324 }
325
326 static void sm_save_complete(SmcConn conn, SmPointer data)
327 {
328 }
329
330 static void sm_shutdown_cancelled(SmcConn conn, SmPointer data)
331 {
332 }
333
334 static gboolean session_save()
335 {
336     FILE *f;
337     GList *it;
338     gboolean success = TRUE;
339
340     f = fopen(save_file, "w");
341     if (!f) {
342         success = FALSE;
343         g_message(_("Unable to save the session to '%s': %s"),
344                   save_file, g_strerror(errno));
345     } else {
346         guint stack_pos = 0;
347
348         fprintf(f, "<?xml version=\"1.0\"?>\n\n");
349         fprintf(f, "<openbox_session id=\"%s\">\n\n", sm_id);
350
351         for (it = stacking_list; it; it = g_list_next(it)) {
352             gint prex, prey, prew, preh;
353             ObClient *c;
354             gchar *t;
355
356             if (WINDOW_IS_CLIENT(it->data))
357                 c = WINDOW_AS_CLIENT(it->data);
358             else
359                 continue;
360
361             if (!client_normal(c))
362                 continue;
363
364             if (!c->sm_client_id)
365                 continue;
366
367             prex = c->area.x;
368             prey = c->area.y;
369             prew = c->area.width;
370             preh = c->area.height;
371             if (c->fullscreen) {
372                 prex = c->pre_fullscreen_area.x;
373                 prey = c->pre_fullscreen_area.x;
374                 prew = c->pre_fullscreen_area.width;
375                 preh = c->pre_fullscreen_area.height;
376             }
377             if (c->max_horz) {
378                 prex = c->pre_max_area.x;
379                 prew = c->pre_max_area.width;
380             }
381             if (c->max_vert) {
382                 prey = c->pre_max_area.y;
383                 preh = c->pre_max_area.height;
384             }
385
386             fprintf(f, "<window id=\"%s\">\n", c->sm_client_id);
387
388             t = g_markup_escape_text(c->name, -1);
389             fprintf(f, "\t<name>%s</name>\n", t);
390             g_free(t);
391
392             t = g_markup_escape_text(c->class, -1);
393             fprintf(f, "\t<class>%s</class>\n", t);
394             g_free(t);
395
396             t = g_markup_escape_text(c->role, -1);
397             fprintf(f, "\t<role>%s</role>\n", t);
398             g_free(t);
399
400             fprintf(f, "\t<desktop>%d</desktop>\n", c->desktop);
401             fprintf(f, "\t<stacking>%d</stacking>\n", stack_pos);
402             fprintf(f, "\t<x>%d</x>\n", prex);
403             fprintf(f, "\t<y>%d</y>\n", prey);
404             fprintf(f, "\t<width>%d</width>\n", prew);
405             fprintf(f, "\t<height>%d</height>\n", preh);
406             if (c->shaded)
407                 fprintf(f, "\t<shaded />\n");
408             if (c->iconic)
409                 fprintf(f, "\t<iconic />\n");
410             if (c->skip_pager)
411                 fprintf(f, "\t<skip_pager />\n");
412             if (c->skip_taskbar)
413                 fprintf(f, "\t<skip_taskbar />\n");
414             if (c->fullscreen)
415                 fprintf(f, "\t<fullscreen />\n");
416             if (c->above)
417                 fprintf(f, "\t<above />\n");
418             if (c->below)
419                 fprintf(f, "\t<below />\n");
420             if (c->max_horz)
421                 fprintf(f, "\t<max_horz />\n");
422             if (c->max_vert)
423                 fprintf(f, "\t<max_vert />\n");
424             fprintf(f, "</window>\n\n");
425
426             ++stack_pos;
427         }
428
429         fprintf(f, "</openbox_session>\n");
430
431         if (fflush(f)) {
432             success = FALSE;
433             g_message(_("Error while saving the session to '%s': %s"),
434                       save_file, g_strerror(errno));
435         }
436         fclose(f);
437     }
438
439     return success;
440 }
441
442 void session_state_free(ObSessionState *state)
443 {
444     if (state) {
445         g_free(state->id);
446         g_free(state->name);
447         g_free(state->class);
448         g_free(state->role);
449
450         g_free(state);
451     }
452 }
453
454 gboolean session_state_cmp(ObSessionState *s, ObClient *c)
455 {
456     return (c->sm_client_id &&
457             !strcmp(s->id, c->sm_client_id) &&
458             !strcmp(s->name, c->name) &&
459             !strcmp(s->class, c->class) &&
460             !strcmp(s->role, c->role));
461 }
462
463 GList* session_state_find(ObClient *c)
464 {
465     GList *it;
466
467     for (it = session_saved_state; it; it = g_list_next(it)) {
468         ObSessionState *s = it->data;
469         if (!s->matched && session_state_cmp(s, c)) {
470             s->matched = TRUE;
471             break;
472         }
473     }
474     return it;
475 }
476
477 static gint stack_sort(const ObSessionState *s1, const ObSessionState *s2)
478 {
479     return s1->stacking - s2->stacking;
480 }
481
482 static void session_load(gchar *path)
483 {
484     xmlDocPtr doc;
485     xmlNodePtr node, n;
486     gchar *id;
487
488     if (!parse_load(path, "openbox_session", &doc, &node))
489         return;
490
491     if (!parse_attr_string("id", node, &id))
492         return;
493     g_free(sm_id);
494     sm_id = id;
495
496     node = parse_find_node("window", node->children);
497     while (node) {
498         ObSessionState *state;
499
500         state = g_new0(ObSessionState, 1);
501
502         if (!parse_attr_string("id", node, &state->id))
503             goto session_load_bail;
504         if (!(n = parse_find_node("name", node->children)))
505             goto session_load_bail;
506         state->name = parse_string(doc, n);
507         if (!(n = parse_find_node("class", node->children)))
508             goto session_load_bail;
509         state->class = parse_string(doc, n);
510         if (!(n = parse_find_node("role", node->children)))
511             goto session_load_bail;
512         state->role = parse_string(doc, n);
513         if (!(n = parse_find_node("stacking", node->children)))
514             goto session_load_bail;
515         state->stacking = parse_int(doc, n);
516         if (!(n = parse_find_node("desktop", node->children)))
517             goto session_load_bail;
518         state->desktop = parse_int(doc, n);
519         if (!(n = parse_find_node("x", node->children)))
520             goto session_load_bail;
521         state->x = parse_int(doc, n);
522         if (!(n = parse_find_node("y", node->children)))
523             goto session_load_bail;
524         state->y = parse_int(doc, n);
525         if (!(n = parse_find_node("width", node->children)))
526             goto session_load_bail;
527         state->w = parse_int(doc, n);
528         if (!(n = parse_find_node("height", node->children)))
529             goto session_load_bail;
530         state->h = parse_int(doc, n);
531
532         state->shaded =
533             parse_find_node("shaded", node->children) != NULL;
534         state->iconic =
535             parse_find_node("iconic", node->children) != NULL;
536         state->skip_pager =
537             parse_find_node("skip_pager", node->children) != NULL;
538         state->skip_taskbar =
539             parse_find_node("skip_taskbar", node->children) != NULL;
540         state->fullscreen =
541             parse_find_node("fullscreen", node->children) != NULL;
542         state->above =
543             parse_find_node("above", node->children) != NULL;
544         state->below =
545             parse_find_node("below", node->children) != NULL;
546         state->max_horz =
547             parse_find_node("max_horz", node->children) != NULL;
548         state->max_vert =
549             parse_find_node("max_vert", node->children) != NULL;
550         
551         /* save this */
552         session_saved_state = g_list_prepend(session_saved_state, state);
553         goto session_load_ok;
554
555     session_load_bail:
556         session_state_free(state);
557
558     session_load_ok:
559
560         node = parse_find_node("window", node->next);
561     }
562
563     /* sort them by their stacking order */
564     session_saved_state = g_list_sort(session_saved_state,
565                                       (GCompareFunc)stack_sort);
566
567     xmlFreeDoc(doc);
568 }
569
570 #endif