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