src/session.c

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