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
  89 static WMPropList *sApplications = NULL;
  90 static WMPropList *sCommand;
  91 static WMPropList *sName;
  92 static WMPropList *sHost;
  93 static WMPropList *sWorkspace;
  94 static WMPropList *sShaded;
  95 static WMPropList *sMiniaturized;
  96 static WMPropList *sHidden;
  97 static WMPropList *sGeometry;
  98 static WMPropList *sShortcutMask;
  99
 100 static WMPropList *sDock;
 101 static WMPropList *sYes, *sNo;
 102
 103 static void make_keys(void)
 104 {
 105         if (sApplications != NULL)
 106                 return;
 107
 108         sApplications = WMCreatePLString("Applications");
 109         sCommand = WMCreatePLString("Command");
 110         sName = WMCreatePLString("Name");
 111         sHost = WMCreatePLString("Host");
 112         sWorkspace = WMCreatePLString("Workspace");
 113         sShaded = WMCreatePLString("Shaded");
 114         sMiniaturized = WMCreatePLString("Miniaturized");
 115         sHidden = WMCreatePLString("Hidden");
 116         sGeometry = WMCreatePLString("Geometry");
 117         sDock = WMCreatePLString("Dock");
 118         sShortcutMask = WMCreatePLString("ShortcutMask");
 119
 120         sYes = WMCreatePLString("Yes");
 121         sNo = WMCreatePLString("No");
 122 }
 123
 124 static int getBool(WMPropList * value)
 125 {
 126         char *val;
 127
 128         if (!WMIsPLString(value)) {
 129                 return 0;
 130         }
 131         val = WMGetFromPLString(value);
 132         if (val == NULL)
 133                 return 0;
 134
 135         if ((val[1] == '\0' && (val[0] == 'y' || val[0] == 'Y'))
 136             || strcasecmp(val, "YES") == 0) {
 137
 138                 return 1;
 139         } else if ((val[1] == '\0' && (val[0] == 'n' || val[0] == 'N'))
 140                    || strcasecmp(val, "NO") == 0) {
 141                 return 0;
 142         } else {
 143                 int i;
 144                 if (sscanf(val, "%i", &i) == 1) {
 145                         return (i != 0);
 146                 } else {
 147                         wwarning(_("can't convert \"%s\" to boolean"), val);
 148                         return 0;
 149                 }
 150         }
 151 }
 152
 153 static unsigned getInt(WMPropList * value)
 154 {
 155         char *val;
 156         unsigned n;
 157
 158         if (!WMIsPLString(value))
 159                 return 0;
 160         val = WMGetFromPLString(value);
 161         if (!val)
 162                 return 0;
 163         if (sscanf(val, "%u", &n) != 1)
 164                 return 0;
 165
 166         return n;
 167 }
 168
 169 static WMPropList *makeWindowState(WWindow * wwin, WApplication * wapp)
 170 {
 171         WScreen *scr = wwin->screen_ptr;
 172         Window win;
 173         int i;
 174         unsigned mask;
 175         char *class, *instance, *command = NULL, buffer[512];
 176         WMPropList *win_state, *cmd, *name, *workspace;
 177         WMPropList *shaded, *miniaturized, *hidden, *geometry;
 178         WMPropList *dock, *shortcut;
 179
 180         if (wwin->orig_main_window != None && wwin->orig_main_window != wwin->client_win)
 181                 win = wwin->orig_main_window;
 182         else
 183                 win = wwin->client_win;
 184
 185         command = GetCommandForWindow(win);
 186         if (!command) {
 187                 if (wapp->app_icon && wapp->app_icon->command) {
 188                         command = wmalloc(strlen(wapp->app_icon->command));
 189                         strcpy(command, wapp->app_icon->command);
 190                 } else
 191                         return NULL;
 192         }
 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                 workspace = WMCreatePLString(scr->workspaces[wwin->frame->workspace]->name);
 207
 208                 shaded = wwin->flags.shaded ? sYes : sNo;
 209                 miniaturized = wwin->flags.miniaturized ? sYes : sNo;
 210                 hidden = wwin->flags.hidden ? sYes : sNo;
 211                 snprintf(buffer, sizeof(buffer), "%ix%i+%i+%i",
 212                          wwin->client.width, wwin->client.height, wwin->frame_x, wwin->frame_y);
 213                 geometry = WMCreatePLString(buffer);
 214
 215                 for (mask = 0, i = 0; i < MAX_WINDOW_SHORTCUTS; i++) {
 216                         if (scr->shortcutWindows[i] != NULL &&
 217                             WMGetFirstInArray(scr->shortcutWindows[i], wwin) != WANotFound)
 218                                 mask |= 1 << i;
 219                 }
 220
 221                 snprintf(buffer, sizeof(buffer), "%u", mask);
 222                 shortcut = WMCreatePLString(buffer);
 223
 224                 win_state = WMCreatePLDictionary(sName, name,
 225                                                  sCommand, cmd,
 226                                                  sWorkspace, workspace,
 227                                                  sShaded, shaded,
 228                                                  sMiniaturized, miniaturized,
 229                                                  sHidden, hidden,
 230                                                  sShortcutMask, shortcut, sGeometry, geometry, NULL);
 231
 232                 WMReleasePropList(name);
 233                 WMReleasePropList(cmd);
 234                 WMReleasePropList(workspace);
 235                 WMReleasePropList(geometry);
 236                 WMReleasePropList(shortcut);
 237                 if (wapp && wapp->app_icon && wapp->app_icon->dock) {
 238                         int i;
 239                         char *name = NULL;
 240                         if (wapp->app_icon->dock == scr->dock)
 241                                 name = "Dock";
 242
 243                         /* Try the clips */
 244                         if (name == NULL) {
 245                                 for (i = 0; i < scr->workspace_count; i++)
 246                                         if (scr->workspaces[i]->clip == wapp->app_icon->dock)
 247                                                 break;
 248                                 if (i < scr->workspace_count)
 249                                         name = scr->workspaces[i]->name;
 250                         }
 251                         /* Try the drawers */
 252                         if (name == NULL) {
 253                                 WDrawerChain *dc;
 254                                 for (dc = scr->drawers; dc != NULL; dc = dc->next) {
 255                                         if (dc->adrawer == wapp->app_icon->dock)
 256                                                 break;
 257                                 }
 258                                 assert(dc != NULL);
 259                                 name = dc->adrawer->icon_array[0]->wm_instance;
 260                         }
 261                         dock = WMCreatePLString(name);
 262                         WMPutInPLDictionary(win_state, sDock, dock);
 263                         WMReleasePropList(dock);
 264                 }
 265         } else {
 266                 win_state = NULL;
 267         }
 268
 269         if (instance)
 270                 free(instance);
 271         if (class)
 272                 free(class);
 273         if (command)
 274                 wfree(command);
 275
 276         return win_state;
 277 }
 278
 279 void wSessionSaveState(WScreen * scr)
 280 {
 281         WWindow *wwin = scr->focused_window;
 282         WMPropList *win_info, *wks;
 283         WMPropList *list = NULL;
 284         WMArray *wapp_list = NULL;
 285
 286         make_keys();
 287
 288         if (!scr->session_state) {
 289                 scr->session_state = WMCreatePLDictionary(NULL, NULL);
 290                 if (!scr->session_state)
 291                         return;
 292         }
 293
 294         list = WMCreatePLArray(NULL);
 295
 296         wapp_list = WMCreateArray(16);
 297
 298         while (wwin) {
 299                 WApplication *wapp = wApplicationOf(wwin->main_window);
 300                 Window appId = wwin->orig_main_window;
 301
 302                 if ((wwin->transient_for == None || wwin->transient_for == wwin->screen_ptr->root_win)
 303                     && (WMGetFirstInArray(wapp_list, (void *)appId) == WANotFound
 304                         || WFLAGP(wwin, shared_appicon))
 305                     && !WFLAGP(wwin, dont_save_session)) {
 306                         /* A entry for this application was not yet saved. Save one. */
 307                         win_info = makeWindowState(wwin, wapp);
 308                         if (win_info != NULL) {
 309                                 WMAddToPLArray(list, win_info);
 310                                 WMReleasePropList(win_info);
 311                                 /* If we were successful in saving the info for this window
 312                                  * add the application the window belongs to, to the
 313                                  * application list, so no multiple entries for the same
 314                                  * application are saved.
 315                                  */
 316                                 WMAddToArray(wapp_list, (void *)appId);
 317                         }
 318                 }
 319                 wwin = wwin->prev;
 320         }
 321         WMRemoveFromPLDictionary(scr->session_state, sApplications);
 322         WMPutInPLDictionary(scr->session_state, sApplications, list);
 323         WMReleasePropList(list);
 324
 325         wks = WMCreatePLString(scr->workspaces[scr->current_workspace]->name);
 326         WMPutInPLDictionary(scr->session_state, sWorkspace, wks);
 327         WMReleasePropList(wks);
 328
 329         WMFreeArray(wapp_list);
 330 }
 331
 332 void wSessionClearState(WScreen * scr)
 333 {
 334         make_keys();
 335
 336         if (!scr->session_state)
 337                 return;
 338
 339         WMRemoveFromPLDictionary(scr->session_state, sApplications);
 340         WMRemoveFromPLDictionary(scr->session_state, sWorkspace);
 341 }
 342
 343 static pid_t execCommand(WScreen *scr, char *command)
 344 {
 345         pid_t pid;
 346         char **argv;
 347         int argc;
 348
 349         wtokensplit(command, &argv, &argc);
 350
 351         if (!argc) {
 352                 return 0;
 353         }
 354
 355         pid = fork();
 356         if (pid == 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
 403         value = WMGetFromPLDictionary(win_state, sShaded);
 404         if (value != NULL)
 405                 state->shaded = getBool(value);
 406
 407         value = WMGetFromPLDictionary(win_state, sMiniaturized);
 408         if (value != NULL)
 409                 state->miniaturized = getBool(value);
 410
 411         value = WMGetFromPLDictionary(win_state, sHidden);
 412         if (value != NULL)
 413                 state->hidden = getBool(value);
 414
 415         value = WMGetFromPLDictionary(win_state, sShortcutMask);
 416         if (value != NULL) {
 417                 mask = getInt(value);
 418                 state->window_shortcuts = mask;
 419         }
 420
 421         value = WMGetFromPLDictionary(win_state, sGeometry);
 422         if (value && WMIsPLString(value)) {
 423                 if (!(sscanf(WMGetFromPLString(value), "%ix%i+%i+%i",
 424                              &state->w, &state->h, &state->x, &state->y) == 4 && (state->w > 0 && state->h > 0))) {
 425                         state->w = 0;
 426                         state->h = 0;
 427                 }
 428         }
 429
 430         return state;
 431 }
 432
 433 static inline int is_same(const char *x, const char *y)
 434 {
 435         if ((x == NULL) && (y == NULL))
 436                 return 1;
 437
 438         if ((x == NULL) || (y == NULL))
 439                 return 0;
 440
 441         if (strcmp(x, y) == 0)
 442                 return 1;
 443         else
 444                 return 0;
 445 }
 446
 447 void wSessionRestoreState(WScreen *scr)
 448 {
 449         WSavedState *state;
 450         char *instance, *class, *command;
 451         WMPropList *win_info, *apps, *cmd, *value;
 452         pid_t pid;
 453         int i, count;
 454         WDock *dock;
 455         WAppIcon *btn = NULL;
 456         int j, n, found;
 457         char *tmp;
 458
 459         make_keys();
 460
 461         if (!scr->session_state)
 462                 return;
 463
 464         WMPLSetCaseSensitive(True);
 465
 466         apps = WMGetFromPLDictionary(scr->session_state, sApplications);
 467         if (!apps)
 468                 return;
 469
 470         count = WMGetPropListItemCount(apps);
 471         if (count == 0)
 472                 return;
 473
 474         for (i = 0; i < count; i++) {
 475                 win_info = WMGetFromPLArray(apps, i);
 476
 477                 cmd = WMGetFromPLDictionary(win_info, sCommand);
 478                 if (!cmd || !WMIsPLString(cmd) || !(command = WMGetFromPLString(cmd))) {
 479                         continue;
 480                 }
 481
 482                 value = WMGetFromPLDictionary(win_info, sName);
 483                 if (!value)
 484                         continue;
 485
 486                 ParseWindowName(value, &instance, &class, "session");
 487                 if (!instance && !class)
 488                         continue;
 489
 490                 state = getWindowState(scr, win_info);
 491
 492                 dock = NULL;
 493                 value = WMGetFromPLDictionary(win_info, sDock);
 494                 if (value && WMIsPLString(value) && (tmp = WMGetFromPLString(value)) != NULL) {
 495                         if (sscanf(tmp, "%i", &n) != 1) {
 496                                 if (!strcasecmp(tmp, "DOCK"))
 497                                         dock = scr->dock;
 498
 499                                 /* Try the clips */
 500                                 if (dock == NULL) {
 501                                         for (j = 0; j < scr->workspace_count; j++) {
 502                                                 if (strcmp(scr->workspaces[j]->name, tmp) == 0) {
 503                                                         dock = scr->workspaces[j]->clip;
 504                                                         break;
 505                                                 }
 506                                         }
 507                                 }
 508                                 if (dock == NULL) // Try the drawers
 509                                 {
 510                                         WDrawerChain *dc;
 511                                         for (dc = scr->drawers; dc != NULL; dc = dc->next)
 512                                         {
 513                                                 if (strcmp(dc->adrawer->icon_array[0]->wm_instance, tmp) == 0)
 514                                                 {
 515                                                         dock = dc->adrawer;
 516                                                         break;
 517                                                 }
 518                                         }
 519                                 }
 520                         } else {
 521                                 if (n == 0) {
 522                                         dock = scr->dock;
 523                                 } else if (n > 0 && n <= scr->workspace_count) {
 524                                         dock = scr->workspaces[n - 1]->clip;
 525                                 }
 526                         }
 527                 }
 528
 529                 found = 0;
 530                 if (dock != NULL) {
 531                         for (j = 0; j < dock->max_icons; j++) {
 532                                 btn = dock->icon_array[j];
 533                                 if (btn && is_same(instance, btn->wm_instance) &&
 534                                     is_same(class, btn->wm_class) &&
 535                                     is_same(command, btn->command) &&
 536                                     !btn->launching) {
 537                                         found = 1;
 538                                         break;
 539                                 }
 540                         }
 541                 }
 542
 543                 if (found) {
 544                         wDockLaunchWithState(btn, state);
 545                 } else if ((pid = execCommand(scr, command)) > 0) {
 546                         wWindowAddSavedState(instance, class, command, pid, state);
 547                 } else {
 548                         wfree(state);
 549                 }
 550
 551                 if (instance)
 552                         wfree(instance);
 553                 if (class)
 554                         wfree(class);
 555         }
 556         /* clean up */
 557         WMPLSetCaseSensitive(False);
 558 }
 559
 560 void wSessionRestoreLastWorkspace(WScreen * scr)
 561 {
 562         WMPropList *wks;
 563         int w;
 564         char *value;
 565
 566         make_keys();
 567
 568         if (!scr->session_state)
 569                 return;
 570
 571         WMPLSetCaseSensitive(True);
 572
 573         wks = WMGetFromPLDictionary(scr->session_state, sWorkspace);
 574         if (!wks || !WMIsPLString(wks))
 575                 return;
 576
 577         value = WMGetFromPLString(wks);
 578
 579         if (!value)
 580                 return;
 581
 582         /* clean up */
 583         WMPLSetCaseSensitive(False);
 584
 585         /* Get the workspace number for the workspace name */
 586         w = wGetWorkspaceNumber(scr, value);
 587
 588         if (w != scr->current_workspace && w < scr->workspace_count)
 589                 wWorkspaceChange(scr, w);
 590 }