src/session.c

   1 /* session.c - session state handling and R6 style session management
   2  *
   3  *  Copyright (c) 1998-2003 Dan Pascu
   4  *  Copyright (c) 1998-2003 Alfredo Kojima
   5  *
   6  *  Window Maker window manager
   7  *
   8  *  This program is free software; you can redistribute it and/or modify
   9  *  it under the terms of the GNU General Public License as published by
  10  *  the Free Software Foundation; either version 2 of the License, or
  11  *  (at your option) any later version.
  12  *
  13  *  This program is distributed in the hope that it will be useful,
  14  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  *  GNU General Public License for more details.
  17  *
  18  *  You should have received a copy of the GNU General Public License along
  19  *  with this program; if not, write to the Free Software Foundation, Inc.,
  20  *  51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  21  */
  22
  23 /*
  24  *
  25  * If defined(XSMP_ENABLED) and session manager is running then
  26  *      do normal stuff
  27  * else
  28  *      do pre-R6 session management stuff (save window state and relaunch)
  29  *
  30  * When doing a checkpoint:
  31  *
  32  * = Without XSMP
  33  * Open "Stop"/status Dialog
  34  * Send SAVE_YOURSELF to clients and wait for reply
  35  * Save restart info
  36  * Save state of clients
  37  *
  38  * = With XSMP
  39  * Send checkpoint request to sm
  40  *
  41  * When exiting:
  42  * -------------
  43  *
  44  * = Without XSMP
  45  *
  46  * Open "Exit Now"/status Dialog
  47  * Send SAVE_YOURSELF to clients and wait for reply
  48  * Save restart info
  49  * Save state of clients
  50  * Send DELETE to all clients
  51  * When no more clients are left or user hit "Exit Now", exit
  52  *
  53  * = With XSMP
  54  *
  55  * Send Shutdown request to session manager
  56  * if SaveYourself message received, save state of clients
  57  * if the Die message is received, exit.
  58  */
  59
  60 #include "wconfig.h"
  61
  62 #include <X11/Xlib.h>
  63 #include <X11/Xutil.h>
  64
  65 #include <stdlib.h>
  66 #include <stdio.h>
  67 #include <string.h>
  68 #include <strings.h>
  69 #include <unistd.h>
  70 #include <time.h>
  71
  72 #include "WindowMaker.h"
  73 #include "screen.h"
  74 #include "window.h"
  75 #include "client.h"
  76 #include "session.h"
  77 #include "framewin.h"
  78 #include "workspace.h"
  79 #include "main.h"
  80 #include "properties.h"
  81 #include "application.h"
  82 #include "appicon.h"
  83 #include "dock.h"
  84 #include "misc.h"
  85
  86 #include <WINGs/WUtil.h>
  87
  88 /** Global **/
  89
  90 extern Atom _XA_WM_SAVE_YOURSELF;
  91
  92 extern Time LastTimestamp;
  93
  94 static WMPropList *sApplications = NULL;
  95 static WMPropList *sCommand;
  96 static WMPropList *sName;
  97 static WMPropList *sHost;
  98 static WMPropList *sWorkspace;
  99 static WMPropList *sShaded;
 100 static WMPropList *sMiniaturized;
 101 static WMPropList *sHidden;
 102 static WMPropList *sGeometry;
 103 static WMPropList *sShortcutMask;
 104
 105 static WMPropList *sDock;
 106 static WMPropList *sYes, *sNo;
 107
 108 static void make_keys(void)
 109 {
 110         if (sApplications != NULL)
 111                 return;
 112
 113         sApplications = WMCreatePLString("Applications");
 114         sCommand = WMCreatePLString("Command");
 115         sName = WMCreatePLString("Name");
 116         sHost = WMCreatePLString("Host");
 117         sWorkspace = WMCreatePLString("Workspace");
 118         sShaded = WMCreatePLString("Shaded");
 119         sMiniaturized = WMCreatePLString("Miniaturized");
 120         sHidden = WMCreatePLString("Hidden");
 121         sGeometry = WMCreatePLString("Geometry");
 122         sDock = WMCreatePLString("Dock");
 123         sShortcutMask = WMCreatePLString("ShortcutMask");
 124
 125         sYes = WMCreatePLString("Yes");
 126         sNo = WMCreatePLString("No");
 127 }
 128
 129 static int getBool(WMPropList * value)
 130 {
 131         char *val;
 132
 133         if (!WMIsPLString(value)) {
 134                 return 0;
 135         }
 136         if (!(val = WMGetFromPLString(value))) {
 137                 return 0;
 138         }
 139
 140         if ((val[1] == '\0' && (val[0] == 'y' || val[0] == 'Y'))
 141             || strcasecmp(val, "YES") == 0) {
 142
 143                 return 1;
 144         } else if ((val[1] == '\0' && (val[0] == 'n' || val[0] == 'N'))
 145                    || strcasecmp(val, "NO") == 0) {
 146                 return 0;
 147         } else {
 148                 int i;
 149                 if (sscanf(val, "%i", &i) == 1) {
 150                         return (i != 0);
 151                 } else {
 152                         wwarning(_("can't convert \"%s\" to boolean"), val);
 153                         return 0;
 154                 }
 155         }
 156 }
 157
 158 static unsigned getInt(WMPropList * value)
 159 {
 160         char *val;
 161         unsigned n;
 162
 163         if (!WMIsPLString(value))
 164                 return 0;
 165         val = WMGetFromPLString(value);
 166         if (!val)
 167                 return 0;
 168         if (sscanf(val, "%u", &n) != 1)
 169                 return 0;
 170
 171         return n;
 172 }
 173
 174 static WMPropList *makeWindowState(WWindow * wwin, WApplication * wapp)
 175 {
 176         WScreen *scr = wwin->screen_ptr;
 177         Window win;
 178         int i;
 179         unsigned mask;
 180         char *class, *instance, *command = NULL, buffer[512];
 181         WMPropList *win_state, *cmd, *name, *workspace;
 182         WMPropList *shaded, *miniaturized, *hidden, *geometry;
 183         WMPropList *dock, *shortcut;
 184
 185         if (wwin->orig_main_window != None && wwin->orig_main_window != wwin->client_win)
 186                 win = wwin->orig_main_window;
 187         else
 188                 win = wwin->client_win;
 189
 190         command = GetCommandForWindow(win);
 191         if (!command)
 192                 return NULL;
 193
 194         if (PropGetWMClass(win, &class, &instance)) {
 195                 if (class && instance)
 196                         snprintf(buffer, sizeof(buffer), "%s.%s", instance, class);
 197                 else if (instance)
 198                         snprintf(buffer, sizeof(buffer), "%s", instance);
 199                 else if (class)
 200                         snprintf(buffer, sizeof(buffer), ".%s", class);
 201                 else
 202                         snprintf(buffer, sizeof(buffer), ".");
 203
 204                 name = WMCreatePLString(buffer);
 205                 cmd = WMCreatePLString(command);
 206                 /*sprintf(buffer, "%d", wwin->frame->workspace+1);
 207                    workspace = WMCreatePLString(buffer); */
 208                 workspace = WMCreatePLString(scr->workspaces[wwin->frame->workspace]->name);
 209                 shaded = wwin->flags.shaded ? sYes : sNo;
 210                 miniaturized = wwin->flags.miniaturized ? sYes : sNo;
 211                 hidden = wwin->flags.hidden ? sYes : sNo;
 212                 snprintf(buffer, sizeof(buffer), "%ix%i+%i+%i",
 213                          wwin->client.width, wwin->client.height, wwin->frame_x, wwin->frame_y);
 214                 geometry = WMCreatePLString(buffer);
 215
 216                 for (mask = 0, i = 0; i < MAX_WINDOW_SHORTCUTS; i++) {
 217                         if (scr->shortcutWindows[i] != NULL &&
 218                             WMGetFirstInArray(scr->shortcutWindows[i], wwin) != WANotFound)
 219                                 mask |= 1 << i;
 220                 }
 221
 222                 snprintf(buffer, sizeof(buffer), "%u", mask);
 223                 shortcut = WMCreatePLString(buffer);
 224
 225                 win_state = WMCreatePLDictionary(sName, name,
 226                                                  sCommand, cmd,
 227                                                  sWorkspace, workspace,
 228                                                  sShaded, shaded,
 229                                                  sMiniaturized, miniaturized,
 230                                                  sHidden, hidden,
 231                                                  sShortcutMask, shortcut, sGeometry, geometry, NULL);
 232
 233                 WMReleasePropList(name);
 234                 WMReleasePropList(cmd);
 235                 WMReleasePropList(workspace);
 236                 WMReleasePropList(geometry);
 237                 WMReleasePropList(shortcut);
 238                 if (wapp && wapp->app_icon && wapp->app_icon->dock) {
 239                         int i;
 240                         char *name = NULL;
 241                         if (wapp->app_icon->dock == scr->dock) {
 242                                 name = "Dock";
 243                         }
 244                         if (name == NULL) // Try the clips
 245                         {
 246                                 for (i = 0; i < scr->workspace_count; i++)
 247                                         if (scr->workspaces[i]->clip == wapp->app_icon->dock)
 248                                                 break;
 249                                 if (i < scr->workspace_count)
 250                                         name = scr->workspaces[i]->name;
 251                         }
 252                         if (name == NULL) // Try the drawers
 253                         {
 254                                 WDrawerChain *dc;
 255                                 for (dc = scr->drawers; dc != NULL; dc = dc->next)
 256                                 {
 257                                         if (dc->adrawer == wapp->app_icon->dock)
 258                                                 break;
 259                                 }
 260                                 assert(dc != NULL);
 261                                 name = dc->adrawer->icon_array[0]->wm_instance;
 262                         }
 263                         dock = WMCreatePLString(name);
 264                         WMPutInPLDictionary(win_state, sDock, dock);
 265                         WMReleasePropList(dock);
 266                 }
 267         } else {
 268                 win_state = NULL;
 269         }
 270
 271         if (instance)
 272                 free(instance);
 273         if (class)
 274                 free(class);
 275         if (command)
 276                 wfree(command);
 277
 278         return win_state;
 279 }
 280
 281 void wSessionSaveState(WScreen * scr)
 282 {
 283         WWindow *wwin = scr->focused_window;
 284         WMPropList *win_info, *wks;
 285         WMPropList *list = NULL;
 286         WMArray *wapp_list = NULL;
 287
 288         make_keys();
 289
 290         if (!scr->session_state) {
 291                 scr->session_state = WMCreatePLDictionary(NULL, NULL);
 292                 if (!scr->session_state)
 293                         return;
 294         }
 295
 296         list = WMCreatePLArray(NULL);
 297
 298         wapp_list = WMCreateArray(16);
 299
 300         while (wwin) {
 301                 WApplication *wapp = wApplicationOf(wwin->main_window);
 302                 Window appId = wwin->orig_main_window;
 303
 304                 if ((wwin->transient_for == None || wwin->transient_for == wwin->screen_ptr->root_win)
 305                     && (WMGetFirstInArray(wapp_list, (void *)appId) == WANotFound
 306                         || WFLAGP(wwin, shared_appicon))
 307                     && !WFLAGP(wwin, dont_save_session)) {
 308                         /* A entry for this application was not yet saved. Save one. */
 309                         if ((win_info = makeWindowState(wwin, wapp)) != NULL) {
 310                                 WMAddToPLArray(list, win_info);
 311                                 WMReleasePropList(win_info);
 312                                 /* If we were succesful in saving the info for this window
 313                                  * add the application the window belongs to, to the
 314                                  * application list, so no multiple entries for the same
 315                                  * application are saved.
 316                                  */
 317                                 WMAddToArray(wapp_list, (void *)appId);
 318                         }
 319                 }
 320                 wwin = wwin->prev;
 321         }
 322         WMRemoveFromPLDictionary(scr->session_state, sApplications);
 323         WMPutInPLDictionary(scr->session_state, sApplications, list);
 324         WMReleasePropList(list);
 325
 326         wks = WMCreatePLString(scr->workspaces[scr->current_workspace]->name);
 327         WMPutInPLDictionary(scr->session_state, sWorkspace, wks);
 328         WMReleasePropList(wks);
 329
 330         WMFreeArray(wapp_list);
 331 }
 332
 333 void wSessionClearState(WScreen * scr)
 334 {
 335         make_keys();
 336
 337         if (!scr->session_state)
 338                 return;
 339
 340         WMRemoveFromPLDictionary(scr->session_state, sApplications);
 341         WMRemoveFromPLDictionary(scr->session_state, sWorkspace);
 342 }
 343
 344 static pid_t execCommand(WScreen *scr, char *command)
 345 {
 346         pid_t pid;
 347         char **argv;
 348         int argc;
 349
 350         wtokensplit(command, &argv, &argc);
 351
 352         if (!argc) {
 353                 return 0;
 354         }
 355
 356         if ((pid = fork()) == 0) {
 357                 char **args;
 358                 int i;
 359
 360                 SetupEnvironment(scr);
 361
 362                 args = malloc(sizeof(char *) * (argc + 1));
 363                 if (!args)
 364                         exit(111);
 365                 for (i = 0; i < argc; i++) {
 366                         args[i] = argv[i];
 367                 }
 368                 args[argc] = NULL;
 369                 execvp(argv[0], args);
 370                 exit(111);
 371         }
 372         while (argc > 0)
 373                 wfree(argv[--argc]);
 374         wfree(argv);
 375         return pid;
 376 }
 377
 378 static WSavedState *getWindowState(WScreen * scr, WMPropList * win_state)
 379 {
 380         WSavedState *state = wmalloc(sizeof(WSavedState));
 381         WMPropList *value;
 382         char *tmp;
 383         unsigned mask;
 384         int i;
 385
 386         state->workspace = -1;
 387         value = WMGetFromPLDictionary(win_state, sWorkspace);
 388         if (value && WMIsPLString(value)) {
 389                 tmp = WMGetFromPLString(value);
 390                 if (sscanf(tmp, "%i", &state->workspace) != 1) {
 391                         state->workspace = -1;
 392                         for (i = 0; i < scr->workspace_count; i++) {
 393                                 if (strcmp(scr->workspaces[i]->name, tmp) == 0) {
 394                                         state->workspace = i;
 395                                         break;
 396                                 }
 397                         }
 398                 } else {
 399                         state->workspace--;
 400                 }
 401         }
 402         if ((value = WMGetFromPLDictionary(win_state, sShaded)) != NULL)
 403                 state->shaded = getBool(value);
 404         if ((value = WMGetFromPLDictionary(win_state, sMiniaturized)) != NULL)
 405                 state->miniaturized = getBool(value);
 406         if ((value = WMGetFromPLDictionary(win_state, sHidden)) != NULL)
 407                 state->hidden = getBool(value);
 408         if ((value = WMGetFromPLDictionary(win_state, sShortcutMask)) != NULL) {
 409                 mask = getInt(value);
 410                 state->window_shortcuts = mask;
 411         }
 412
 413         value = WMGetFromPLDictionary(win_state, sGeometry);
 414         if (value && WMIsPLString(value)) {
 415                 if (!(sscanf(WMGetFromPLString(value), "%ix%i+%i+%i",
 416                              &state->w, &state->h, &state->x, &state->y) == 4 && (state->w > 0 && state->h > 0))) {
 417                         state->w = 0;
 418                         state->h = 0;
 419                 }
 420         }
 421
 422         return state;
 423 }
 424
 425 #define SAME(x, y) (((x) && (y) && !strcmp((x), (y))) || (!(x) && !(y)))
 426
 427 void wSessionRestoreState(WScreen *scr)
 428 {
 429         WSavedState *state;
 430         char *instance, *class, *command;
 431         WMPropList *win_info, *apps, *cmd, *value;
 432         pid_t pid;
 433         int i, count;
 434         WDock *dock;
 435         WAppIcon *btn = NULL;
 436         int j, n, found;
 437         char *tmp;
 438
 439         make_keys();
 440
 441         if (!scr->session_state)
 442                 return;
 443
 444         WMPLSetCaseSensitive(True);
 445
 446         apps = WMGetFromPLDictionary(scr->session_state, sApplications);
 447         if (!apps)
 448                 return;
 449
 450         count = WMGetPropListItemCount(apps);
 451         if (count == 0)
 452                 return;
 453
 454         for (i = 0; i < count; i++) {
 455                 win_info = WMGetFromPLArray(apps, i);
 456
 457                 cmd = WMGetFromPLDictionary(win_info, sCommand);
 458                 if (!cmd || !WMIsPLString(cmd) || !(command = WMGetFromPLString(cmd))) {
 459                         continue;
 460                 }
 461
 462                 value = WMGetFromPLDictionary(win_info, sName);
 463                 if (!value)
 464                         continue;
 465
 466                 ParseWindowName(value, &instance, &class, "session");
 467                 if (!instance && !class)
 468                         continue;
 469
 470                 state = getWindowState(scr, win_info);
 471
 472                 dock = NULL;
 473                 value = WMGetFromPLDictionary(win_info, sDock);
 474                 if (value && WMIsPLString(value) && (tmp = WMGetFromPLString(value)) != NULL) {
 475                         if (sscanf(tmp, "%i", &n) != 1) {
 476                                 if (!strcasecmp(tmp, "DOCK")) {
 477                                         dock = scr->dock;
 478                                 }
 479                                 if (dock == NULL) // Try the clips
 480                                 {
 481                                         for (j = 0; j < scr->workspace_count; j++) {
 482                                                 if (strcmp(scr->workspaces[j]->name, tmp) == 0) {
 483                                                         dock = scr->workspaces[j]->clip;
 484                                                         break;
 485                                                 }
 486                                         }
 487                                 }
 488                                 if (dock == NULL) // Try the drawers
 489                                 {
 490                                         WDrawerChain *dc;
 491                                         for (dc = scr->drawers; dc != NULL; dc = dc->next)
 492                                         {
 493                                                 if (strcmp(dc->adrawer->icon_array[0]->wm_instance, tmp) == 0)
 494                                                 {
 495                                                         dock = dc->adrawer;
 496                                                         break;
 497                                                 }
 498                                         }
 499                                 }
 500                         } else {
 501                                 if (n == 0) {
 502                                         dock = scr->dock;
 503                                 } else if (n > 0 && n <= scr->workspace_count) {
 504                                         dock = scr->workspaces[n - 1]->clip;
 505                                 }
 506                         }
 507                 }
 508
 509                 found = 0;
 510                 if (dock != NULL) {
 511                         for (j = 0; j < dock->max_icons; j++) {
 512                                 btn = dock->icon_array[j];
 513                                 if (btn && SAME(instance, btn->wm_instance) &&
 514                                     SAME(class, btn->wm_class) && SAME(command, btn->command) && !btn->launching) {
 515                                         found = 1;
 516                                         break;
 517                                 }
 518                         }
 519                 }
 520
 521                 if (found) {
 522                         wDockLaunchWithState(dock, btn, state);
 523                 } else if ((pid = execCommand(scr, command)) > 0) {
 524                         wWindowAddSavedState(instance, class, command, pid, state);
 525                 } else {
 526                         wfree(state);
 527                 }
 528
 529                 if (instance)
 530                         wfree(instance);
 531                 if (class)
 532                         wfree(class);
 533         }
 534         /* clean up */
 535         WMPLSetCaseSensitive(False);
 536 }
 537
 538 void wSessionRestoreLastWorkspace(WScreen * scr)
 539 {
 540         WMPropList *wks;
 541         int w;
 542         char *value;
 543
 544         make_keys();
 545
 546         if (!scr->session_state)
 547                 return;
 548
 549         WMPLSetCaseSensitive(True);
 550
 551         wks = WMGetFromPLDictionary(scr->session_state, sWorkspace);
 552         if (!wks || !WMIsPLString(wks))
 553                 return;
 554
 555         value = WMGetFromPLString(wks);
 556
 557         if (!value)
 558                 return;
 559
 560         /* clean up */
 561         WMPLSetCaseSensitive(False);
 562
 563         /* Get the workspace number for the workspace name */
 564         w = wGetWorkspaceNumber(scr, value);
 565
 566         if (w != scr->current_workspace && w < scr->workspace_count)
 567                 wWorkspaceChange(scr, w);
 568 }