src/session.c

   1 /* session.c - session state handling and R6 style session management
   2  *
   3  *  Copyright (c) 1998 Dan Pascu
   4  *  Copyright (c) 1998, 1999 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
  19  *  along with this program; if not, write to the Free Software
  20  *  Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307,
  21  *  USA.
  22  */
  23
  24
  25 /*
  26  *
  27  * If defined(XSMP_ENABLED) and session manager is running then
  28  *      do normal stuff
  29  * else
  30  *      do pre-R6 session management stuff (save window state and relaunch)
  31  *
  32  * When doing a checkpoint:
  33  *
  34  * = Without XSMP
  35  * Open "Stop"/status Dialog
  36  * Send SAVE_YOURSELF to clients and wait for reply
  37  * Save restart info
  38  * Save state of clients
  39  *
  40  * = With XSMP
  41  * Send checkpoint request to sm
  42  *
  43  * When exiting:
  44  * -------------
  45  *
  46  * = Without XSMP
  47  *
  48  * Open "Exit Now"/status Dialog
  49  * Send SAVE_YOURSELF to clients and wait for reply
  50  * Save restart info
  51  * Save state of clients
  52  * Send DELETE to all clients
  53  * When no more clients are left or user hit "Exit Now", exit
  54  *
  55  * = With XSMP
  56  *
  57  * Send Shutdown request to session manager
  58  * if SaveYourself message received, save state of clients
  59  * if the Die message is received, exit.
  60  */
  61
  62 #include "wconfig.h"
  63
  64 #include <X11/Xlib.h>
  65 #include <X11/Xutil.h>
  66
  67 #ifdef XSMP_ENABLED
  68 #include <X11/SM/SMlib.h>
  69 #endif
  70
  71 #include <stdlib.h>
  72 #include <stdio.h>
  73 #include <string.h>
  74 #include <unistd.h>
  75 #include <time.h>
  76
  77
  78 #include "WindowMaker.h"
  79 #include "screen.h"
  80 #include "window.h"
  81 #include "client.h"
  82 #include "session.h"
  83 #include "wcore.h"
  84 #include "framewin.h"
  85 #include "workspace.h"
  86 #include "funcs.h"
  87 #include "properties.h"
  88 #include "application.h"
  89 #include "appicon.h"
  90
  91
  92 #include "dock.h"
  93
  94
  95 #include <WINGs/WUtil.h>
  96
  97 /** Global **/
  98
  99 extern Atom _XA_WM_SAVE_YOURSELF;
 100
 101 extern Time LastTimestamp;
 102
 103 #ifdef XSMP_ENABLED
 104
 105 extern int wScreenCount;
 106
 107 /* requested for SaveYourselfPhase2 */
 108 static Bool sWaitingPhase2 = False;
 109
 110 static SmcConn sSMCConn = NULL;
 111
 112 static WMHandlerID sSMInputHandler = NULL;
 113
 114 /* our SM client ID */
 115 static char *sClientID = NULL;
 116 #endif
 117
 118
 119 static WMPropList *sApplications = NULL;
 120 static WMPropList *sCommand;
 121 static WMPropList *sName;
 122 static WMPropList *sHost;
 123 static WMPropList *sWorkspace;
 124 static WMPropList *sShaded;
 125 static WMPropList *sMiniaturized;
 126 static WMPropList *sHidden;
 127 static WMPropList *sGeometry;
 128 static WMPropList *sShortcutMask;
 129
 130 static WMPropList *sDock;
 131
 132 static WMPropList *sYes, *sNo;
 133
 134
 135 static void
 136 make_keys()
 137 {
 138     if (sApplications!=NULL)
 139         return;
 140
 141     sApplications = WMCreatePLString("Applications");
 142     sCommand = WMCreatePLString("Command");
 143     sName = WMCreatePLString("Name");
 144     sHost = WMCreatePLString("Host");
 145     sWorkspace = WMCreatePLString("Workspace");
 146     sShaded = WMCreatePLString("Shaded");
 147     sMiniaturized = WMCreatePLString("Miniaturized");
 148     sHidden = WMCreatePLString("Hidden");
 149     sGeometry = WMCreatePLString("Geometry");
 150     sDock = WMCreatePLString("Dock");
 151     sShortcutMask = WMCreatePLString("ShortcutMask");
 152
 153     sYes = WMCreatePLString("Yes");
 154     sNo = WMCreatePLString("No");
 155 }
 156
 157
 158
 159 static int
 160 getBool(WMPropList *value)
 161 {
 162     char *val;
 163
 164     if (!WMIsPLString(value)) {
 165         return 0;
 166     }
 167     if (!(val = WMGetFromPLString(value))) {
 168         return 0;
 169     }
 170
 171     if ((val[1]=='\0' && (val[0]=='y' || val[0]=='Y'))
 172         || strcasecmp(val, "YES")==0) {
 173
 174         return 1;
 175     } else if ((val[1]=='\0' && (val[0]=='n' || val[0]=='N'))
 176              || strcasecmp(val, "NO")==0) {
 177         return 0;
 178     } else {
 179         int i;
 180         if (sscanf(val, "%i", &i)==1) {
 181             return (i!=0);
 182         } else {
 183             wwarning(_("can't convert \"%s\" to boolean"), val);
 184             return 0;
 185         }
 186     }
 187 }
 188
 189
 190 static unsigned
 191 getInt(WMPropList *value)
 192 {
 193     char *val;
 194     unsigned n;
 195
 196     if (!WMIsPLString(value))
 197         return 0;
 198     val = WMGetFromPLString(value);
 199     if (!val)
 200         return 0;
 201     if (sscanf(val, "%u", &n) != 1)
 202         return 0;
 203
 204     return n;
 205 }
 206
 207
 208
 209 static WMPropList*
 210 makeWindowState(WWindow *wwin, WApplication *wapp)
 211 {
 212     WScreen *scr = wwin->screen_ptr;
 213     Window win;
 214     int argc;
 215     char **argv;
 216     int i;
 217     unsigned mask;
 218     char *class, *instance, *command=NULL, buffer[512];
 219     WMPropList *win_state, *cmd, *name, *workspace;
 220     WMPropList *shaded, *miniaturized, *hidden, *geometry;
 221     WMPropList *dock, *shortcut;
 222
 223     if (wwin->main_window!=None && wwin->main_window!=wwin->client_win)
 224         win = wwin->main_window;
 225     else
 226         win = wwin->client_win;
 227
 228     if (XGetCommand(dpy, win, &argv, &argc) && argc>0) {
 229         command = wtokenjoin(argv, argc);
 230         XFreeStringList(argv);
 231     }
 232     if (!command)
 233         return NULL;
 234
 235     if (PropGetWMClass(win, &class, &instance)) {
 236         if (class && instance)
 237             snprintf(buffer, sizeof(buffer), "%s.%s", instance, class);
 238         else if (instance)
 239             snprintf(buffer, sizeof(buffer), "%s", instance);
 240         else if (class)
 241             snprintf(buffer, sizeof(buffer), ".%s", class);
 242         else
 243             snprintf(buffer, sizeof(buffer), ".");
 244
 245         name = WMCreatePLString(buffer);
 246         cmd = WMCreatePLString(command);
 247         /*sprintf(buffer, "%d", wwin->frame->workspace+1);
 248         workspace = WMCreatePLString(buffer);*/
 249         workspace = WMCreatePLString(scr->workspaces[wwin->frame->workspace]->name);
 250         shaded = wwin->flags.shaded ? sYes : sNo;
 251         miniaturized = wwin->flags.miniaturized ? sYes : sNo;
 252         hidden = wwin->flags.hidden ? sYes : sNo;
 253         snprintf(buffer, sizeof(buffer), "%ix%i+%i+%i",
 254                  wwin->client.width, wwin->client.height,
 255                 wwin->frame_x, wwin->frame_y);
 256         geometry = WMCreatePLString(buffer);
 257
 258         for (mask = 0, i = 0; i < MAX_WINDOW_SHORTCUTS; i++) {
 259             if (scr->shortcutWindows[i] != NULL &&
 260                 WMGetFirstInArray(scr->shortcutWindows[i], wwin) != WANotFound) {
 261                 mask |= 1<<i;
 262             }
 263         }
 264
 265         snprintf(buffer, sizeof(buffer), "%u", mask);
 266         shortcut = WMCreatePLString(buffer);
 267
 268         win_state = WMCreatePLDictionary(sName, name,
 269                                                 sCommand, cmd,
 270                                                 sWorkspace, workspace,
 271                                                 sShaded, shaded,
 272                                                 sMiniaturized, miniaturized,
 273                                                 sHidden, hidden,
 274                                                 sShortcutMask, shortcut,
 275                                                 sGeometry, geometry,
 276                                                 NULL);
 277
 278         WMReleasePropList(name);
 279         WMReleasePropList(cmd);
 280         WMReleasePropList(workspace);
 281         WMReleasePropList(geometry);
 282         WMReleasePropList(shortcut);
 283         if (wapp && wapp->app_icon && wapp->app_icon->dock) {
 284             int i;
 285             char *name;
 286             if (wapp->app_icon->dock == scr->dock) {
 287                 name="Dock";
 288             } else {
 289                 for(i=0; i<scr->workspace_count; i++)
 290                     if(scr->workspaces[i]->clip == wapp->app_icon->dock)
 291                         break;
 292                 assert( i < scr->workspace_count);
 293                 /*n = i+1;*/
 294                 name = scr->workspaces[i]->name;
 295             }
 296             dock = WMCreatePLString(name);
 297             WMPutInPLDictionary(win_state, sDock, dock);
 298             WMReleasePropList(dock);
 299         }
 300     } else {
 301         win_state = NULL;
 302     }
 303
 304     if (instance) XFree(instance);
 305     if (class) XFree(class);
 306     if (command) wfree(command);
 307
 308     return win_state;
 309 }
 310
 311
 312 void
 313 wSessionSaveState(WScreen *scr)
 314 {
 315     WWindow *wwin = scr->focused_window;
 316     WMPropList *win_info, *wks;
 317     WMPropList *list=NULL;
 318     WMArray *wapp_list=NULL;
 319
 320
 321     make_keys();
 322
 323     if (!scr->session_state) {
 324         scr->session_state = WMCreatePLDictionary(NULL, NULL, NULL);
 325         if (!scr->session_state)
 326             return;
 327     }
 328
 329     list = WMCreatePLArray(NULL);
 330
 331     wapp_list = WMCreateArray(16);
 332
 333     while (wwin) {
 334         WApplication *wapp=wApplicationOf(wwin->main_window);
 335
 336         if (wwin->transient_for==None
 337             && WMGetFirstInArray(wapp_list, wapp)==WANotFound
 338             && !WFLAGP(wwin, dont_save_session)) {
 339             /* A entry for this application was not yet saved. Save one. */
 340             if ((win_info = makeWindowState(wwin, wapp))!=NULL) {
 341                 WMAddToPLArray(list, win_info);
 342                 WMReleasePropList(win_info);
 343                 /* If we were succesful in saving the info for this window
 344                  * add the application the window belongs to, to the
 345                  * application list, so no multiple entries for the same
 346                  * application are saved.
 347                  */
 348                 WMAddToArray(wapp_list, wapp);
 349             }
 350         }
 351         wwin = wwin->prev;
 352     }
 353     WMRemoveFromPLDictionary(scr->session_state, sApplications);
 354     WMPutInPLDictionary(scr->session_state, sApplications, list);
 355     WMReleasePropList(list);
 356
 357     wks = WMCreatePLString(scr->workspaces[scr->current_workspace]->name);
 358     WMPutInPLDictionary(scr->session_state, sWorkspace, wks);
 359     WMReleasePropList(wks);
 360
 361     WMFreeArray(wapp_list);
 362 }
 363
 364
 365 void
 366 wSessionClearState(WScreen *scr)
 367 {
 368     make_keys();
 369
 370     if (!scr->session_state)
 371         return;
 372
 373     WMRemoveFromPLDictionary(scr->session_state, sApplications);
 374     WMRemoveFromPLDictionary(scr->session_state, sWorkspace);
 375 }
 376
 377
 378 static pid_t
 379 execCommand(WScreen *scr, char *command, char *host)
 380 {
 381     pid_t pid;
 382     char **argv;
 383     int argc;
 384
 385     wtokensplit(command, &argv, &argc);
 386
 387     if (argv==NULL) {
 388         return 0;
 389     }
 390
 391     if ((pid=fork())==0) {
 392         char **args;
 393         int i;
 394
 395         SetupEnvironment(scr);
 396
 397         args = malloc(sizeof(char*)*(argc+1));
 398         if (!args)
 399             exit(111);
 400         for (i=0; i<argc; i++) {
 401             args[i] = argv[i];
 402         }
 403         args[argc] = NULL;
 404         execvp(argv[0], args);
 405         exit(111);
 406     }
 407     while (argc > 0)
 408         wfree(argv[--argc]);
 409     wfree(argv);
 410     return pid;
 411 }
 412
 413
 414 static WSavedState*
 415 getWindowState(WScreen *scr, WMPropList *win_state)
 416 {
 417     WSavedState *state = wmalloc(sizeof(WSavedState));
 418     WMPropList *value;
 419     char *tmp;
 420     unsigned mask;
 421     int i;
 422
 423     memset(state, 0, sizeof(WSavedState));
 424     state->workspace = -1;
 425     value = WMGetFromPLDictionary(win_state, sWorkspace);
 426     if (value && WMIsPLString(value)) {
 427         tmp = WMGetFromPLString(value);
 428         if (sscanf(tmp, "%i", &state->workspace)!=1) {
 429             state->workspace = -1;
 430             for (i=0; i < scr->workspace_count; i++) {
 431                 if (strcmp(scr->workspaces[i]->name, tmp)==0) {
 432                     state->workspace = i;
 433                     break;
 434                 }
 435             }
 436         } else {
 437             state->workspace--;
 438         }
 439     }
 440     if ((value = WMGetFromPLDictionary(win_state, sShaded))!=NULL)
 441         state->shaded = getBool(value);
 442     if ((value = WMGetFromPLDictionary(win_state, sMiniaturized))!=NULL)
 443         state->miniaturized = getBool(value);
 444     if ((value = WMGetFromPLDictionary(win_state, sHidden))!=NULL)
 445         state->hidden = getBool(value);
 446     if ((value = WMGetFromPLDictionary(win_state, sShortcutMask))!=NULL) {
 447         mask = getInt(value);
 448         state->window_shortcuts = mask;
 449     }
 450
 451     value = WMGetFromPLDictionary(win_state, sGeometry);
 452     if (value && WMIsPLString(value)) {
 453         if (!(sscanf(WMGetFromPLString(value), "%ix%i+%i+%i",
 454                    &state->w, &state->h, &state->x, &state->y)==4 &&
 455               (state->w>0 && state->h>0))) {
 456             state->w = 0;
 457             state->h = 0;
 458         }
 459     }
 460
 461     return state;
 462 }
 463
 464
 465 #define SAME(x, y) (((x) && (y) && !strcmp((x), (y))) || (!(x) && !(y)))
 466
 467 void
 468 wSessionRestoreState(WScreen *scr)
 469 {
 470     WSavedState *state;
 471     char *instance, *class, *command, *host;
 472     WMPropList *win_info, *apps, *cmd, *value;
 473     pid_t pid;
 474     int i, count;
 475     WDock *dock;
 476     WAppIcon *btn=NULL;
 477     int j, n, found;
 478     char *tmp;
 479
 480     make_keys();
 481
 482     if (!scr->session_state)
 483         return;
 484
 485     WMPLSetCaseSensitive(True);
 486
 487     apps = WMGetFromPLDictionary(scr->session_state, sApplications);
 488     if (!apps)
 489         return;
 490
 491     count = WMGetPropListItemCount(apps);
 492     if (count==0)
 493         return;
 494
 495     for (i=0; i<count; i++) {
 496         win_info = WMGetFromPLArray(apps, i);
 497
 498         cmd = WMGetFromPLDictionary(win_info, sCommand);
 499         if (!cmd || !WMIsPLString(cmd) || !(command = WMGetFromPLString(cmd))) {
 500             continue;
 501         }
 502
 503         value = WMGetFromPLDictionary(win_info, sName);
 504         if (!value)
 505             continue;
 506
 507         ParseWindowName(value, &instance, &class, "session");
 508         if (!instance && !class)
 509             continue;
 510
 511         value = WMGetFromPLDictionary(win_info, sHost);
 512         if (value && WMIsPLString(value))
 513             host = WMGetFromPLString(value);
 514         else
 515             host = NULL;
 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                 } else {
 526                     for (j=0; j < scr->workspace_count; j++) {
 527                         if (strcmp(scr->workspaces[j]->name, tmp)==0) {
 528                             dock = scr->workspaces[j]->clip;
 529                             break;
 530                         }
 531                     }
 532                 }
 533             } else {
 534                 if (n == 0) {
 535                     dock = scr->dock;
 536                 } else if (n>0 && n<=scr->workspace_count) {
 537                     dock = scr->workspaces[n-1]->clip;
 538                 }
 539             }
 540         }
 541
 542         found = 0;
 543         if (dock!=NULL) {
 544             for (j=0; j<dock->max_icons; j++) {
 545                 btn = dock->icon_array[j];
 546                 if (btn && SAME(instance, btn->wm_instance) &&
 547                     SAME(class, btn->wm_class) &&
 548                     SAME(command, btn->command) &&
 549                     !btn->launching) {
 550                     found = 1;
 551                     break;
 552                 }
 553             }
 554         }
 555
 556         if (found) {
 557             wDockLaunchWithState(dock, btn, state);
 558         } else if ((pid = execCommand(scr, command, host)) > 0) {
 559             wWindowAddSavedState(instance, class, command, pid, state);
 560         } else {
 561             wfree(state);
 562         }
 563
 564         if (instance) wfree(instance);
 565         if (class) wfree(class);
 566     }
 567     /* clean up */
 568     WMPLSetCaseSensitive(False);
 569 }
 570
 571
 572 void
 573 wSessionRestoreLastWorkspace(WScreen *scr)
 574 {
 575     WMPropList *wks;
 576     int w, i;
 577     char *tmp;
 578
 579     make_keys();
 580
 581     if (!scr->session_state)
 582         return;
 583
 584     WMPLSetCaseSensitive(True);
 585
 586     wks = WMGetFromPLDictionary(scr->session_state, sWorkspace);
 587     if (!wks || !WMIsPLString(wks))
 588         return;
 589
 590     tmp = WMGetFromPLString(wks);
 591
 592     /* clean up */
 593     WMPLSetCaseSensitive(False);
 594
 595     if (sscanf(tmp, "%i", &w)!=1) {
 596         w = -1;
 597         for (i=0; i < scr->workspace_count; i++) {
 598             if (strcmp(scr->workspaces[i]->name, tmp)==0) {
 599                 w = i;
 600                 break;
 601             }
 602         }
 603     } else {
 604         w--;
 605     }
 606
 607     if (w!=scr->current_workspace && w<scr->workspace_count) {
 608         wWorkspaceChange(scr, w);
 609     }
 610 }
 611
 612
 613 static void
 614 clearWaitingAckState(WScreen *scr)
 615 {
 616     WWindow *wwin;
 617     WApplication *wapp;
 618
 619     for (wwin = scr->focused_window; wwin != NULL; wwin = wwin->prev) {
 620         wwin->flags.waiting_save_ack = 0;
 621         if (wwin->main_window != None) {
 622             wapp = wApplicationOf(wwin->main_window);
 623             if (wapp)
 624                 wapp->main_window_desc->flags.waiting_save_ack = 0;
 625         }
 626     }
 627 }
 628
 629
 630 void
 631 wSessionSaveClients(WScreen *scr)
 632 {
 633
 634 }
 635
 636
 637 /*
 638  * With XSMP, this job is done by smproxy
 639  */
 640 void
 641 wSessionSendSaveYourself(WScreen *scr)
 642 {
 643     WWindow *wwin;
 644     int count;
 645
 646     /* freeze client interaction with clients */
 647     XGrabKeyboard(dpy, scr->root_win, False, GrabModeAsync, GrabModeAsync,
 648                   CurrentTime);
 649     XGrabPointer(dpy, scr->root_win, False, ButtonPressMask|ButtonReleaseMask,
 650                  GrabModeAsync, GrabModeAsync, scr->root_win, None,
 651                  CurrentTime);
 652
 653     clearWaitingAckState(scr);
 654
 655     count = 0;
 656
 657     /* first send SAVE_YOURSELF for everybody */
 658     for (wwin = scr->focused_window; wwin != NULL; wwin = wwin->prev) {
 659         WWindow *mainWin;
 660
 661         mainWin = wWindowFor(wwin->main_window);
 662
 663         if (mainWin) {
 664             /* if the client is a multi-window client, only send message
 665              * to the main window */
 666             wwin = mainWin;
 667         }
 668
 669         /* make sure the SAVE_YOURSELF flag is up-to-date */
 670         PropGetProtocols(wwin->client_win, &wwin->protocols);
 671
 672         if (wwin->protocols.SAVE_YOURSELF) {
 673             if (!wwin->flags.waiting_save_ack) {
 674                 wClientSendProtocol(wwin, _XA_WM_SAVE_YOURSELF, LastTimestamp);
 675
 676                 wwin->flags.waiting_save_ack = 1;
 677                 count++;
 678             }
 679         } else {
 680             wwin->flags.waiting_save_ack = 0;
 681         }
 682     }
 683
 684     /* then wait for acknowledge */
 685     while (count > 0) {
 686
 687     }
 688
 689     XUngrabPointer(dpy, CurrentTime);
 690     XUngrabKeyboard(dpy, CurrentTime);
 691     XFlush(dpy);
 692 }
 693
 694
 695 #ifdef XSMP_ENABLED
 696 /*
 697  * With full session management support, the part of WMState
 698  * that store client window state will become obsolete (maybe we can reuse
 699  *                                                      the old code too),
 700  * but we still need to store state info like the dock and workspaces.
 701  * It is better to keep dock/wspace info in WMState because the user
 702  * might want to keep the dock configuration while not wanting to
 703  * resume a previously saved session.
 704  * So, wmaker specific state info can be saved in
 705  * ~/GNUstep/.AppInfo/WindowMaker/statename.state
 706  * Its better to not put it in the defaults directory because:
 707  * - its not a defaults file (having domain names like wmaker0089504baa
 708  * in the defaults directory wouldn't be very neat)
 709  * - this state file is not meant to be edited by users
 710  *
 711  * The old session code will become obsolete. When wmaker is
 712  * compiled with R6 sm support compiled in, it'll be better to
 713  * use a totally rewritten state saving code, but we can keep
 714  * the current code for when XSMP_ENABLED is not compiled in.
 715  *
 716  * This will be confusing to old users (well get lots of "SAVE_SESSION broke!"
 717  * messages), but it'll be better.
 718  *
 719  * -readme
 720  */
 721
 722
 723 static char*
 724 getWindowRole(Window window)
 725 {
 726     XTextProperty prop;
 727     static Atom atom = 0;
 728
 729     if (!atom)
 730         atom = XInternAtom(dpy, "WM_WINDOW_ROLE", False);
 731
 732     if (XGetTextProperty(dpy, window, &prop, atom)) {
 733         if (prop.encoding == XA_STRING && prop.format == 8 && prop.nitems > 0)
 734             return prop.value;
 735     }
 736
 737     return NULL;
 738 }
 739
 740
 741 /*
 742  *
 743  * Saved Info:
 744  *
 745  * WM_WINDOW_ROLE
 746  *
 747  * WM_CLASS.instance
 748  * WM_CLASS.class
 749  * WM_NAME
 750  * WM_COMMAND
 751  *
 752  * geometry
 753  * state = (miniaturized, shaded, etc)
 754  * attribute
 755  * workspace #
 756  * app state = (which dock, hidden)
 757  * window shortcut #
 758  */
 759
 760 static WMPropList*
 761 makeAppState(WWindow *wwin)
 762 {
 763     WApplication *wapp;
 764     WMPropList *state;
 765     WScreen *scr = wwin->screen_ptr;
 766
 767     state = WMCreatePLArray(NULL, NULL);
 768
 769     wapp = wApplicationOf(wwin->main_window);
 770
 771     if (wapp) {
 772         if (wapp->app_icon && wapp->app_icon->dock) {
 773
 774             if (wapp->app_icon->dock == scr->dock) {
 775                 WMAddToPLArray(state, WMCreatePLString("Dock"));
 776             } else {
 777                 int i;
 778
 779                 for(i=0; i<scr->workspace_count; i++)
 780                     if(scr->workspaces[i]->clip == wapp->app_icon->dock)
 781                         break;
 782
 783                 assert(i < scr->workspace_count);
 784
 785                 WMAddToPLArray(state,
 786                                      WMCreatePLString(scr->workspaces[i]->name));
 787             }
 788         }
 789
 790         WMAddToPLArray(state, WMCreatePLString(wapp->hidden ? "1" : "0"));
 791     }
 792
 793     return state;
 794 }
 795
 796
 797
 798 Bool
 799 wSessionGetStateFor(WWindow *wwin, WSessionData *state)
 800 {
 801     char *str;
 802     WMPropList *slist;
 803     WMPropList *elem;
 804     WMPropList *value;
 805     int index = 0;
 806
 807     index = 3;
 808
 809     /* geometry */
 810     value = WMGetFromPLArray(slist, index++);
 811     str = WMGetFromPLString(value);
 812
 813     sscanf(str, "%i %i %i %i %i %i", &state->x, &state->y,
 814            &state->width, &state->height,
 815            &state->user_changed_width, &state->user_changed_height);
 816
 817
 818     /* state */
 819     value = WMGetFromPLArray(slist, index++);
 820     str = WMGetFromPLString(value);
 821
 822     sscanf(str, "%i %i %i", &state->miniaturized, &state->shaded,
 823            &state->maximized);
 824
 825
 826     /* attributes */
 827     value = WMGetFromPLArray(slist, index++);
 828     str = WMGetFromPLString(value);
 829
 830     getAttributeState(str, &state->mflags, &state->flags);
 831
 832
 833     /* workspace */
 834     value = WMGetFromPLArray(slist, index++);
 835     str = WMGetFromPLString(value);
 836
 837     sscanf(str, "%i", &state->workspace);
 838
 839
 840     /* app state (repeated for all windows of the app) */
 841     value = WMGetFromPLArray(slist, index++);
 842     str = WMGetFromPLString(value);
 843
 844     /* ???? */
 845
 846     /* shortcuts */
 847     value = WMGetFromPLArray(slist, index++);
 848     str = WMGetFromPLString(value);
 849
 850     sscanf(str, "%i", &state->shortcuts);
 851 }
 852
 853
 854
 855 static WMPropList*
 856 makeAttributeState(WWindow *wwin)
 857 {
 858     unsigned int data1, data2;
 859     char buffer[256];
 860
 861 #define W_FLAG(wwin, FLAG)      ((wwin)->defined_user_flags.FLAG \
 862                                         ? (wwin)->user_flags.FLAG : -1)
 863
 864     snprintf(buffer, sizeof(buffer),
 865             "%i %i %i %i %i %i %i %i %i %i %i %i %i %i %i %i %i %i %i %i %i %i %i",
 866             W_FLAG(no_titlebar),
 867             W_FLAG(no_resizable),
 868             W_FLAG(no_closable),
 869             W_FLAG(no_miniaturizable),
 870             W_FLAG(no_resizebar),
 871             W_FLAG(no_close_button),
 872             W_FLAG(no_miniaturize_button),
 873             /*
 874             W_FLAG(broken_close),
 875             W_FLAG(kill_close),
 876              */
 877             W_FLAG(no_shadeable),
 878             W_FLAG(omnipresent),
 879             W_FLAG(skip_window_list),
 880             W_FLAG(floating),
 881             W_FLAG(sunken),
 882             W_FLAG(no_bind_keys),
 883             W_FLAG(no_bind_mouse),
 884             W_FLAG(no_hide_others),
 885             W_FLAG(no_appicon),
 886             W_FLAG(dont_move_off),
 887             W_FLAG(no_focusable),
 888             W_FLAG(always_user_icon),
 889             W_FLAG(start_miniaturized),
 890             W_FLAG(start_hidden),
 891             W_FLAG(start_maximized),
 892             W_FLAG(dont_save_session),
 893             W_FLAG(emulate_appicon));
 894
 895     return WMCreatePLString(buffer);
 896 }
 897
 898
 899 static void
 900 appendStringInArray(WMPropList *array, char *str)
 901 {
 902     WMPropList *val;
 903
 904     val = WMCreatePLString(str);
 905     WMAddToPLArray(array, val);
 906     WMReleasePropList(val);
 907 }
 908
 909
 910 static WMPropList*
 911 makeClientState(WWindow *wwin)
 912 {
 913     WMPropList *state;
 914     WMPropList *tmp;
 915     char *str;
 916     char buffer[512];
 917     int i;
 918     unsigned shortcuts;
 919
 920     state = WMCreatePLArray(NULL, NULL);
 921
 922     /* WM_WINDOW_ROLE */
 923     str = getWindowRole(wwin->client_win);
 924     if (!str)
 925         appendStringInArray(state, "");
 926     else {
 927         appendStringInArray(state, str);
 928         XFree(str);
 929     }
 930
 931     /* WM_CLASS.instance */
 932     appendStringInArray(state, wwin->wm_instance);
 933
 934     /* WM_CLASS.class */
 935     appendStringInArray(state, wwin->wm_class);
 936
 937     /* WM_NAME */
 938     if (wwin->flags.wm_name_changed)
 939         appendStringInArray(state, "");
 940     else
 941         appendStringInArray(state, wwin->frame->name);
 942
 943     /* geometry */
 944     snprintf(buffer, sizeof(buffer), "%i %i %i %i %i %i", wwin->frame_x, wwin->frame_y,
 945             wwin->client.width, wwin->client.height,
 946             wwin->flags.user_changed_width, wwin->flags.user_changed_height);
 947     appendStringInArray(state, buffer);
 948
 949     /* state */
 950     snprintf(buffer, sizeof(buffer), "%i %i %i", wwin->flags.miniaturized,
 951             wwin->flags.shaded, wwin->flags.maximized);
 952     appendStringInArray(state, buffer);
 953
 954     /* attributes */
 955     tmp = makeAttributeState(wwin);
 956     WMAddToPLArray(state, tmp);
 957     WMReleasePropList(tmp);
 958
 959     /* workspace */
 960     snprintf(buffer, sizeof(buffer), "%i", wwin->frame->workspace);
 961     appendStringInArray(state, buffer);
 962
 963     /* app state (repeated for all windows of the app) */
 964     tmp = makeAppState(wwin);
 965     WMAddToPLArray(state, tmp);
 966     WMReleasePropList(tmp);
 967
 968     /* shortcuts */
 969     shortcuts = 0;
 970     for (i = 0; i < MAX_WINDOW_SHORTCUTS; i++) {
 971         if (scr->shortcutWindow[i] == wwin) {
 972             shortcuts |= 1 << i;
 973         }
 974     }
 975     snprintf(buffer, sizeof(buffer), "%ui", shortcuts);
 976     appendStringInArray(tmp, buffer);
 977
 978     return state;
 979 }
 980
 981
 982 static void
 983 smSaveYourselfPhase2Proc(SmcConn smc_conn, SmPointer client_data)
 984 {
 985     SmProp props[4];
 986     SmPropValue prop1val, prop2val, prop3val, prop4val;
 987     char **argv = (char**)client_data;
 988     int argc;
 989     int i, j;
 990     Bool ok = False;
 991     char *statefile = NULL;
 992     char *prefix;
 993     Bool gsPrefix = False;
 994     char *discardCmd = NULL;
 995     time_t t;
 996     WMPropList *state, *plState;
 997     int len;
 998
 999 #ifdef DEBUG1
1000     puts("received SaveYourselfPhase2 SM message");
1001 #endif
1002
1003     /* save session state */
1004
1005     /* the file that will contain the state */
1006     prefix = getenv("SM_SAVE_DIR");
1007     if (!prefix) {
1008         prefix = wusergnusteppath();
1009         if (prefix)
1010             gsPrefix = True;
1011     }
1012     if (!prefix) {
1013         prefix = getenv("HOME");
1014     }
1015     if (!prefix)
1016         prefix = ".";
1017
1018     len = strlen(prefix)+64;
1019     statefile = malloc(len);
1020     if (!statefile) {
1021         wwarning(_("out of memory while saving session state"));
1022         goto fail;
1023     }
1024
1025     t = time();
1026     i = 0;
1027     do {
1028         if (gsPrefix)
1029             snprintf(statefile, len, "%s/.AppInfo/WindowMaker/wmaker.%l%i.state",
1030                     prefix, t, i);
1031         else
1032             snprintf(statefile, len, "%s/wmaker.%l%i.state", prefix, t, i);
1033         i++;
1034     } while (access(F_OK, statefile)!=-1);
1035
1036     /* save the states of all windows we're managing */
1037     state = WMCreatePLArray(NULL, NULL);
1038
1039     /*
1040      * Format:
1041      *
1042      * state_file ::= dictionary with version_info ; state
1043      * version_info ::= 'version' = '1';
1044      * state ::= 'state' = array of screen_info
1045      * screen_info ::= array of (screen number, window_info, window_info, ...)
1046      * window_info ::=
1047      */
1048     for (i=0; i<wScreenCount; i++) {
1049         WScreen *scr;
1050         WWindow *wwin;
1051         char buf[32];
1052         WMPropList *pscreen;
1053
1054         scr = wScreenWithNumber(i);
1055
1056         snprintf(buf, sizeof(buf), "%i", scr->screen);
1057         pscreen = WMCreatePLArray(WMCreatePLString(buf), NULL);
1058
1059         wwin = scr->focused_window;
1060         while (wwin) {
1061             WMPropList *pwindow;
1062
1063             pwindow = makeClientState(wwin);
1064             WMAddToPLArray(pscreen, pwindow);
1065
1066             wwin = wwin->prev;
1067         }
1068
1069         WMAddToPLArray(state, pscreen);
1070     }
1071
1072     plState = WMCreatePLDictionary(WMCreatePLString("Version"),
1073                                           WMCreatePLString("1.0"),
1074                                           WMCreatePLString("Screens"),
1075                                           state, NULL);
1076
1077     WMWritePropListToFile(plState, statefile, False);
1078
1079     WMReleasePropList(plState);
1080
1081     /* set the remaining properties that we didn't set at
1082      * startup time */
1083
1084     for (argc=0, i=0; argv[i]!=NULL; i++) {
1085         if (strcmp(argv[i], "-clientid")==0
1086             || strcmp(argv[i], "-restore")==0) {
1087             i++;
1088         } else {
1089             argc++;
1090         }
1091     }
1092
1093     prop[0].name = SmRestartCommand;
1094     prop[0].type = SmLISTofARRAY8;
1095     prop[0].vals = malloc(sizeof(SmPropValue)*(argc+4));
1096     prop[0].num_vals = argc+4;
1097
1098     prop[1].name = SmCloneCommand;
1099     prop[1].type = SmLISTofARRAY8;
1100     prop[1].vals = malloc(sizeof(SmPropValue)*(argc));
1101     prop[1].num_vals = argc;
1102
1103     if (!prop[0].vals || !prop[1].vals) {
1104         wwarning(_("end of memory while saving session state"));
1105         goto fail;
1106     }
1107
1108     for (j=0, i=0; i<argc+4; i++) {
1109         if (strcmp(argv[i], "-clientid")==0
1110             || strcmp(argv[i], "-restore")==0) {
1111             i++;
1112         } else {
1113             prop[0].vals[j].value = argv[i];
1114             prop[0].vals[j].length = strlen(argv[i]);
1115             prop[1].vals[j].value = argv[i];
1116             prop[1].vals[j].length = strlen(argv[i]);
1117             j++;
1118         }
1119     }
1120     prop[0].vals[j].value = "-clientid";
1121     prop[0].vals[j].length = 9;
1122     j++;
1123     prop[0].vals[j].value = sClientID;
1124     prop[0].vals[j].length = strlen(sClientID);
1125     j++;
1126     prop[0].vals[j].value = "-restore";
1127     prop[0].vals[j].length = 11;
1128     j++;
1129     prop[0].vals[j].value = statefile;
1130     prop[0].vals[j].length = strlen(statefile);
1131
1132     {
1133         int len = strlen(statefile)+8;
1134
1135         discardCmd = malloc(len);
1136         if (!discardCmd)
1137             goto fail;
1138         snprintf(discardCmd, len, "rm %s", statefile);
1139     }
1140     prop[2].name = SmDiscardCommand;
1141     prop[2].type = SmARRAY8;
1142     prop[2].vals[0] = discardCmd;
1143     prop[2].num_vals = 1;
1144
1145     SmcSetProperties(sSMCConn, 3, prop);
1146
1147     ok = True;
1148 fail:
1149     SmcSaveYourselfDone(smc_conn, ok);
1150
1151     if (prop[0].vals)
1152         wfree(prop[0].vals);
1153     if (prop[1].vals)
1154         wfree(prop[1].vals);
1155     if (discardCmd)
1156         wfree(discardCmd);
1157
1158     if (!ok) {
1159         remove(statefile);
1160     }
1161     if (statefile)
1162         wfree(statefile);
1163 }
1164
1165
1166 static void
1167 smSaveYourselfProc(SmcConn smc_conn, SmPointer client_data, int save_type,
1168                    Bool shutdown, int interact_style, Bool fast)
1169 {
1170 #ifdef DEBUG1
1171     puts("received SaveYourself SM message");
1172 #endif
1173
1174     if (!SmcRequestSaveYourselfPhase2(smc_conn, smSaveYourselfPhase2Proc,
1175                                       client_data)) {
1176
1177         SmcSaveYourselfDone(smc_conn, False);
1178         sWaitingPhase2 = False;
1179     } else {
1180 #ifdef DEBUG1
1181         puts("successfull request of SYS phase 2");
1182 #endif
1183         sWaitingPhase2 = True;
1184     }
1185 }
1186
1187
1188 static void
1189 smDieProc(SmcConn smc_conn, SmPointer client_data)
1190 {
1191 #ifdef DEBUG1
1192     puts("received Die SM message");
1193 #endif
1194
1195     wSessionDisconnectManager();
1196
1197     Shutdown(WSExitMode, True);
1198 }
1199
1200
1201
1202 static void
1203 smSaveCompleteProc(SmcConn smc_conn)
1204 {
1205     /* it means that we can resume doing things that can change our state */
1206 #ifdef DEBUG1
1207     puts("received SaveComplete SM message");
1208 #endif
1209 }
1210
1211
1212 static void
1213 smShutdownCancelledProc(SmcConn smc_conn, SmPointer client_data)
1214 {
1215     if (sWaitingPhase2) {
1216
1217         sWaitingPhase2 = False;
1218
1219         SmcSaveYourselfDone(smc_conn, False);
1220     }
1221 }
1222
1223
1224 static void
1225 iceMessageProc(int fd, int mask, void *clientData)
1226 {
1227     IceConn iceConn = (IceConn)clientData;
1228
1229     IceProcessMessages(iceConn, NULL, NULL);
1230 }
1231
1232
1233 static void
1234 iceIOErrorHandler(IceConnection ice_conn)
1235 {
1236     /* This is not fatal but can mean the session manager exited.
1237      * If the session manager exited normally we would get a
1238      * Die message, so this probably means an abnormal exit.
1239      * If the sm was the last client of session, then we'll die
1240      * anyway, otherwise we can continue doing our stuff.
1241      */
1242     wwarning(_("connection to the session manager was lost"));
1243     wSessionDisconnectManager();
1244 }
1245
1246
1247 void
1248 wSessionConnectManager(char **argv, int argc)
1249 {
1250     IceConn iceConn;
1251     char *previous_id = NULL;
1252     char buffer[256];
1253     SmcCallbacks callbacks;
1254     unsigned long mask;
1255     char uid[32];
1256     char pid[32];
1257     SmProp props[4];
1258     SmPropValue prop1val, prop2val, prop3val, prop4val;
1259     char restartStyle;
1260     int i;
1261
1262     mask = SmcSaveYourselfProcMask|SmcDieProcMask|SmcSaveCompleteProcMask
1263         |SmcShutdownCancelledProcMask;
1264
1265     callbacks.save_yourself.callback = smSaveYourselfProc;
1266     callbacks.save_yourself.client_data = argv;
1267
1268     callbacks.die.callback = smDieProc;
1269     callbacks.die.client_data = NULL;
1270
1271     callbacks.save_complete.callback = smSaveCompleteProc;
1272     callbacks.save_complete.client_data = NULL;
1273
1274     callbacks.shutdown_cancelled.callback = smShutdownCancelledProc;
1275     callbacks.shutdown_cancelled.client_data = NULL;
1276
1277     for (i=0; i<argc; i++) {
1278         if (strcmp(argv[i], "-clientid")==0) {
1279             previous_id = argv[i+1];
1280             break;
1281         }
1282     }
1283
1284     /* connect to the session manager */
1285     sSMCConn = SmcOpenConnection(NULL, NULL, SmProtoMajor, SmProtoMinor,
1286                                  mask, &callbacks, previous_id,
1287                                  &sClientID, 255, buffer);
1288     if (!sSMCConn) {
1289         return;
1290     }
1291 #ifdef DEBUG1
1292     puts("connected to the session manager");
1293 #endif
1294
1295 /*    IceSetIOErrorHandler(iceIOErrorHandler);*/
1296
1297     /* check for session manager clients */
1298     iceConn = SmcGetIceConnection(smcConn);
1299
1300     if (fcntl(IceConnectionNumber(iceConn), F_SETFD, FD_CLOEXEC) < 0) {
1301         wsyserror("error setting close-on-exec flag for ICE connection");
1302     }
1303
1304     sSMInputHandler = WMAddInputHandler(IceConnectionNumber(iceConn),
1305                                         WIReadMask, iceMessageProc, iceConn);
1306
1307     /* setup information about ourselves */
1308
1309     /* program name */
1310     prop1val.value = argv[0];
1311     prop1val.length = strlen(argv[0]);
1312     prop[0].name = SmProgram;
1313     prop[0].type = SmARRAY8;
1314     prop[0].num_vals = 1;
1315     prop[0].vals = &prop1val;
1316
1317     /* The XSMP doc from X11R6.1 says it contains the user name,
1318      * but every client implementation I saw places the uid # */
1319     snprintf(uid, sizeof(uid), "%i", getuid());
1320     prop2val.value = uid;
1321     prop2val.length = strlen(uid);
1322     prop[1].name = SmUserID;
1323     prop[1].type = SmARRAY8;
1324     prop[1].num_vals = 1;
1325     prop[1].vals = &prop2val;
1326
1327     /* Restart style. We should restart only if we were running when
1328      * the previous session finished. */
1329     restartStyle = SmRestartIfRunning;
1330     prop3val.value = &restartStyle;
1331     prop3val.length = 1;
1332     prop[2].name = SmRestartStyleHint;
1333     prop[2].type = SmCARD8;
1334     prop[2].num_vals = 1;
1335     prop[2].vals = &prop3val;
1336
1337     /* Our PID. Not required but might be usefull */
1338     snprintf(pid, sizeof(pid), "%i", getpid());
1339     prop4val.value = pid;
1340     prop4val.length = strlen(pid);
1341     prop[3].name = SmProcessID;
1342     prop[3].type = SmARRAY8;
1343     prop[3].num_vals = 1;
1344     prop[3].vals = &prop4val;
1345
1346     /* we'll set the rest of the hints later */
1347
1348     SmcSetProperties(sSMCConn, 4, props);
1349
1350 }
1351
1352
1353 void
1354 wSessionDisconnectManager(void)
1355 {
1356     if (sSMCConn) {
1357         WMDeleteInputHandler(sSMInputHandler);
1358         sSMInputHandler = NULL;
1359
1360         SmcCloseConnection(sSMCConn, 0, NULL);
1361         sSMCConn = NULL;
1362     }
1363 }
1364
1365 void
1366 wSessionRequestShutdown(void)
1367 {
1368     /* request a shutdown to the session manager */
1369     if (sSMCConn)
1370         SmcRequestSaveYourself(sSMCConn, SmSaveBoth, True, SmInteractStyleAny,
1371                                False, True);
1372 }
1373
1374
1375 Bool
1376 wSessionIsManaged(void)
1377 {
1378     return sSMCConn!=NULL;
1379 }
1380
1381 #endif /* !XSMP_ENABLED */