2 * CDE - Common Desktop Environment
4 * Copyright (c) 1993-2012, The Open Group. All rights reserved.
6 * These libraries and programs are free software; you can
7 * redistribute them and/or modify them under the terms of the GNU
8 * Lesser General Public License as published by the Free Software
9 * Foundation; either version 2 of the License, or (at your option)
12 * These libraries and programs are distributed in the hope that
13 * they will be useful, but WITHOUT ANY WARRANTY; without even the
14 * implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
15 * PURPOSE. See the GNU Lesser General Public License for more
18 * You should have received a copy of the GNU Lesser General Public
19 * License along with these libraries and programs; if not, write
20 * to the Free Software Foundation, Inc., 51 Franklin Street, Fifth
21 * Floor, Boston, MA 02110-1301 USA
23 /* $TOG: SmDB.c /main/5 1998/07/23 18:11:31 mgreess $ */
25 * (c) Copyright 1996 Digital Equipment Corporation.
26 * (c) Copyright 1996 Hewlett-Packard Company.
27 * (c) Copyright 1996 International Business Machines Corp.
28 * (c) Copyright 1996 Sun Microsystems, Inc.
29 * (c) Copyright 1996 Novell, Inc.
30 * (c) Copyright 1996 FUJITSU LIMITED.
31 * (c) Copyright 1996 Hitachi.
40 #define RESOURCE_BUF_SZ 1024
41 #define CLIENT_ID_SZ 20
43 typedef struct _ClientDBRec
45 XrmDatabase xrmDB; /* Xrm resource database. */
46 Boolean openForInput; /* True if input, False if output. */
48 char *xrmDBFileName; /* Filename, for openForInput == False. */
52 /* Below used if openForInput. */
53 char **XSMPClients; /* malloc'd array of XSMP client IDs. */
54 int nXSMPClients; /* number of XSMP clients. */
55 int nextXSMPClientIndex; /* index of next XSMP client to Get;
56 * also used as sequence # for Put. */
58 char **proxyClients; /* malloc'd array of Proxy client IDs. */
59 int nProxyClients; /* number of Proxy clients. */
60 int nextProxyClientIndex; /* index of next Proxy client to Get;
61 * also used as sequence # for Put. */
64 static Boolean xrmInitialized = False;
65 static XrmName XSMPName[2];
66 static XrmClass XSMPClass[2];
67 static XrmName proxyName[2];
68 static XrmClass proxyClass[2];
69 static XrmQuark anyQuark;
70 static char *resourceBuf = NULL;
71 static char *clientIDBuf = NULL;
74 char *versionStr = ".version";
75 char *dtsessionIDStr = ".dtsessionID";
77 /* Strings for XSMP clients. */
78 static char *clientStr = "!\nClient.%s";
79 static char *programStr = "%s.Program";
80 static char *cwdStr = "%s.Cwd";
81 static char *restartCmdStr = "%s.RestartCommand";
82 static char *cloneCmdStr = "%s.CloneCommand";
83 static char *discardCmdStr = "%s.DiscardCommand";
84 static char *environmentStr = "%s.Environment";
85 static char *restartHintStr = "%s.RestartHint";
86 static char *sessionIDStr = "%s.SessionID";
88 /* Strings for Proxy clients. */
89 static char *proxyStr = "!\nProxyClient.%s";
90 static char *commandStr = "%s.Command";
92 /* Common resources (XSMP and Proxy). */
93 static char *clientHostStr = "%s.ClientHost";
94 static char *screenNumStr = "%s.ScreenNum";
96 static void _initXrm(void);
97 static Bool _countProc(XrmDatabase *, XrmBindingList, XrmQuarkList,
98 XrmRepresentation *, XrmValue *, XPointer);
99 static Bool _fillClientIDProc(XrmDatabase *, XrmBindingList, XrmQuarkList,
100 XrmRepresentation *, XrmValue *, XPointer);
101 static Bool _fillStringArrayProc(XrmDatabase *, XrmBindingList, XrmQuarkList,
102 XrmRepresentation *, XrmValue *, XPointer);
103 static Boolean _getStringResource(XrmDatabase, char *,
104 char *, char **, char *);
105 static Boolean _getIntResource(XrmDatabase, char *, char *, int *, int);
106 static Boolean _getStringArrayResource(XrmDatabase, char *, char *,
108 static void _freeStringArray(char **);
109 static Boolean _putStringResource(ClientDBRec *, char *, char *, char *);
110 static Boolean _putIntResource(ClientDBRec *, char *, char *, int);
111 static Boolean _putStringArrayResource(ClientDBRec *, char *, char *, char **);
112 static char *_tmpFileName(char *);
119 XrmInitialize(); /* Just in case. */
121 anyQuark = XrmStringToQuark("?");
122 XSMPName[0] = proxyName[0] = anyQuark;
123 XSMPClass[0] = XrmStringToClass("Client");
124 proxyClass[0] = XrmStringToClass("ProxyClient");
125 XSMPName[1] = XSMPClass[1] =
126 proxyName[1] = proxyClass[1] = NULLQUARK;
127 xrmInitialized = True;
132 _countProc(XrmDatabase *clientDB, XrmBindingList bindingList,
133 XrmQuarkList quarkList, XrmRepresentation *reps,
134 XrmValue *value, XPointer uData)
136 int *countP = (int *)uData;
144 _fillClientIDProc(XrmDatabase *clientDB, XrmBindingList bindingList,
145 XrmQuarkList quarkList, XrmRepresentation *reps,
146 XrmValue *value, XPointer uData)
148 char ***idListPtr = (char ***)uData;
149 char **clientIDPtr = *idListPtr;
151 *clientIDPtr = (char *)value->addr;
158 _fillStringArrayProc(XrmDatabase *clientDB, XrmBindingList bindingList,
159 XrmQuarkList quarkList, XrmRepresentation *reps,
160 XrmValue *value, XPointer uData)
162 char **stringsPtr = (char **)uData;
165 /* Our index into this string array is at quarkList[2]. */
166 if ((indexStr = XrmQuarkToString(quarkList[2])) == (char *)NULL)
169 if ((stringsPtr[atoi(indexStr)] = XtNewString((char *)value->addr))
177 _getStringResource(XrmDatabase xrmDB, char *fmtStr,
178 char *clientID, char **resourcePtr, char *defaultVal)
181 XrmValue resourceValue;
183 if (NULL == resourceBuf) resourceBuf = XtMalloc(RESOURCE_BUF_SZ);
184 sprintf(resourceBuf, fmtStr, clientID);
185 if (XrmGetResource(xrmDB, resourceBuf, resourceBuf,
186 &resourceType, &resourceValue))
188 if ((*resourcePtr = XtNewString(resourceValue.addr)) == (char *)NULL)
194 *resourcePtr = defaultVal;
199 _getIntResource(XrmDatabase xrmDB, char *fmtStr,
200 char *clientID, int *resourcePtr, int defaultVal)
203 XrmValue resourceValue;
205 if (NULL == resourceBuf) resourceBuf = XtMalloc(RESOURCE_BUF_SZ);
206 sprintf(resourceBuf, fmtStr, clientID);
207 *resourcePtr = (XrmGetResource(xrmDB, resourceBuf, resourceBuf,
208 &resourceType, &resourceValue)) ?
209 atoi(resourceValue.addr) : defaultVal;
215 _getStringArrayResource(XrmDatabase xrmDB, char *fmtStr,
216 char *clientID, char ***resourcePtr,
219 XrmQuark resourceName[3];
220 XrmQuark resourceClass[3];
222 XrmValue resourceValue;
225 resourceName[0] = resourceName[1] = anyQuark;
226 resourceName[2] = NULLQUARK;
228 if (NULL == resourceBuf) resourceBuf = XtMalloc(RESOURCE_BUF_SZ);
229 sprintf(resourceBuf, fmtStr, clientID);
230 XrmStringToQuarkList(resourceBuf, resourceClass);
233 XrmEnumerateDatabase(xrmDB, resourceName, resourceClass,
234 XrmEnumOneLevel, _countProc,
235 (XPointer)&nStrings);
242 if ((stringsPtr = (char **)XtMalloc((nStrings + 1) * sizeof(char *)))
246 /* Initialize array entries to NULL so free can work. */
247 /* NOTE: Final entry (nStrings) will remain NULL. */
248 for (i = 0; i <= nStrings; i++)
249 stringsPtr[i] = (char *)NULL;
251 if (XrmEnumerateDatabase(xrmDB,
252 resourceName, resourceClass,
253 XrmEnumOneLevel, _fillStringArrayProc,
254 (XPointer)stringsPtr))
256 for (i = 0; i < nStrings; i++)
257 XtFree(stringsPtr[i]);
258 XtFree((char *)stringsPtr);
262 *resourcePtr = stringsPtr;
266 *resourcePtr = defaultVal;
271 _freeStringArray(char **stringsPtr)
277 for (i = 0; stringsPtr[i] != (char *)NULL; i++)
278 XtFree(stringsPtr[i]);
280 XtFree((char *)stringsPtr);
285 _putStringResource(ClientDBRec *clientDB, char *fmtStr, char *clientID,
288 if (resourceVal != (char *)NULL)
290 if (NULL == clientIDBuf) clientIDBuf = XtMalloc(RESOURCE_BUF_SZ);
291 sprintf(clientIDBuf, fmtStr, clientID);
292 if (fprintf(clientDB->xrmDBFile, "%s: %s\n", clientIDBuf, resourceVal)
301 _putIntResource(ClientDBRec *clientDB, char *fmtStr, char *clientID,
304 if (NULL == clientIDBuf) clientIDBuf = XtMalloc(RESOURCE_BUF_SZ);
305 sprintf(clientIDBuf, fmtStr, clientID);
306 if (fprintf(clientDB->xrmDBFile, "%s: %d\n", clientIDBuf, resourceVal)
314 _putStringArrayResource(ClientDBRec *clientDB, char *fmtStr, char *clientID,
319 if (resourceVal != (char **)NULL)
321 for (i = 0; resourceVal[i] != (char *)NULL; i++)
323 if (NULL == clientIDBuf) clientIDBuf = XtMalloc(RESOURCE_BUF_SZ);
324 sprintf(clientIDBuf, fmtStr, clientID);
325 if (fprintf(clientDB->xrmDBFile, "%s.%d: %s\n",
326 clientIDBuf, i, resourceVal[i]) < 0)
335 _tmpFileName(char *fileName)
337 int fileNameLen = strlen(fileName);
339 (char *)XtMalloc((fileNameLen + 20) * sizeof(char));
341 if (newFileName != (char *)NULL)
344 char *ptr = &(newFileName[fileNameLen]);
346 strcpy(newFileName, fileName);
348 /* Hm. I suppose if a couple billion versions of this file exist */
349 /* we could loop forever, but that's not likely. */
352 sprintf(ptr, "%d", i);
353 if (access(newFileName, F_OK) != 0)
362 OpenInputClientDB(char *fileName,
366 ClientDBRec *inputDB;
369 XrmValue resourceValue;
371 *version = (char *)NULL;
372 *dtsessionID = (char *)NULL;
376 if ((fileName == (char *)NULL) ||
377 ((inputDB = (ClientDBRec *)XtMalloc(sizeof(ClientDBRec)))
378 == (ClientDBRec *)NULL))
379 return (ClientDB)NULL;
381 if ((inputDB->xrmDB = XrmGetFileDatabase(fileName))
382 == (XrmDatabase)NULL)
384 XtFree((char *)inputDB);
385 return (ClientDB)NULL;
388 inputDB->openForInput = True;
389 inputDB->XSMPClients = inputDB->proxyClients = (char **)NULL;
390 inputDB->nXSMPClients = inputDB->nProxyClients = 0;
391 inputDB->nextXSMPClientIndex = inputDB->nextProxyClientIndex = 0;
393 /* Count the number of XSMP and Proxy clients. */
394 XrmEnumerateDatabase(inputDB->xrmDB, XSMPName, XSMPClass,
395 XrmEnumOneLevel, _countProc,
396 (XPointer)&inputDB->nXSMPClients);
397 XrmEnumerateDatabase(inputDB->xrmDB, proxyName, proxyClass,
398 XrmEnumOneLevel, _countProc,
399 (XPointer)&inputDB->nProxyClients);
401 /* Allocate space for the client IDs and fill from database. */
402 if (inputDB->nXSMPClients > 0)
404 if ((inputDB->XSMPClients =
405 (char **)XtMalloc(inputDB->nXSMPClients * sizeof(char *)))
408 XrmDestroyDatabase(inputDB->xrmDB);
409 XtFree((char *)inputDB);
410 return (ClientDB)NULL;
413 tmpPtr = inputDB->XSMPClients;
414 XrmEnumerateDatabase(inputDB->xrmDB, XSMPName, XSMPClass,
415 XrmEnumOneLevel, _fillClientIDProc,
418 if (inputDB->nProxyClients > 0)
420 if ((inputDB->proxyClients =
421 (char **)XtMalloc(inputDB->nProxyClients * sizeof(char *)))
424 XrmDestroyDatabase(inputDB->xrmDB);
425 XtFree((char *)inputDB->XSMPClients);
426 XtFree((char *)inputDB);
427 return (ClientDB)NULL;
430 tmpPtr = inputDB->proxyClients;
431 XrmEnumerateDatabase(inputDB->xrmDB, proxyName, proxyClass,
432 XrmEnumOneLevel, _fillClientIDProc,
436 if ((!XrmGetResource(inputDB->xrmDB, versionStr, versionStr,
437 &resourceType, &resourceValue)) ||
438 ((*version = XtNewString(resourceValue.addr)) == (char *)NULL) ||
439 (!XrmGetResource(inputDB->xrmDB, dtsessionIDStr, dtsessionIDStr,
440 &resourceType, &resourceValue)) ||
441 ((*dtsessionID = XtNewString(resourceValue.addr)) == (char *)NULL))
446 *version = (char *)NULL;
448 XrmDestroyDatabase(inputDB->xrmDB);
449 XtFree((char *)inputDB->XSMPClients);
450 XtFree((char *)inputDB->proxyClients);
451 XtFree((char *)inputDB);
452 return (ClientDB)NULL;
455 return (ClientDB)inputDB;
459 OpenOutputClientDB(char *fileName,
463 ClientDBRec *outputDB;
467 if ((fileName == (char *)NULL) ||
468 (version == (char *)NULL) ||
469 (dtsessionID == (char *)NULL) ||
470 ((outputDB = (ClientDBRec *)XtMalloc(sizeof(ClientDBRec)))
471 == (ClientDBRec *)NULL))
472 return (ClientDB)NULL;
474 outputDB->xrmDB = (XrmDatabase)NULL;
475 outputDB->openForInput = False;
476 outputDB->nextXSMPClientIndex = 0;
477 outputDB->nextProxyClientIndex = 0;
479 /* Save current DB to tmp file in case we need to restore later. */
480 if (((outputDB->xrmDBFileName = XtNewString(fileName)) == (char *)NULL) ||
481 ((outputDB->tmpDBFileName = _tmpFileName(fileName)) == (char *)NULL))
483 if (outputDB->xrmDBFileName != (char *)NULL)
484 XtFree(outputDB->xrmDBFileName);
485 XtFree((char *)outputDB);
486 return (ClientDB)NULL;
489 if ((rename(fileName, outputDB->tmpDBFileName) != 0) &&
492 XtFree(outputDB->xrmDBFileName);
493 XtFree(outputDB->tmpDBFileName);
494 XtFree((char *)outputDB);
495 return (ClientDB)NULL;
498 /* Open fileName for writing. */
499 if ((outputDB->xrmDBFile = fopen(fileName, "w")) == (FILE *)NULL)
502 rv = rename(outputDB->tmpDBFileName, fileName);
503 XtFree(outputDB->xrmDBFileName);
504 XtFree(outputDB->tmpDBFileName);
505 XtFree((char *)outputDB);
506 return (ClientDB)NULL;
509 /* Store version and session ID. */
510 fprintf(outputDB->xrmDBFile, "! dtsession.db\n!\n%s: %s\n",
511 versionStr, version);
512 fprintf(outputDB->xrmDBFile, "%s: %s\n", dtsessionIDStr, dtsessionID);
514 return (ClientDB)outputDB;
518 GetXSMPClientDBRec(ClientDB inputDBPtr)
520 ClientDBRec *inputDB = (ClientDBRec *)inputDBPtr;
521 XSMPClientDBRecPtr clientPtr;
524 if ((inputDB == (ClientDBRec *)NULL) ||
525 (!inputDB->openForInput) ||
526 (inputDB->nextXSMPClientIndex >= inputDB->nXSMPClients) ||
527 ((clientPtr = (XSMPClientDBRecPtr)XtMalloc(sizeof(XSMPClientDBRec)))
528 == (XSMPClientDBRecPtr)NULL))
530 return (XSMPClientDBRecPtr)NULL;
533 clientID = inputDB->XSMPClients[inputDB->nextXSMPClientIndex];
535 /* Initialize pointers so Free is easy. */
536 clientPtr->clientId = (char *)NULL;
537 clientPtr->clientHost = clientPtr->program =
538 clientPtr->cwd = (char *)NULL;
539 clientPtr->restartCommand = clientPtr->cloneCommand =
540 clientPtr->discardCommand = clientPtr->environment = (char **)NULL;
542 /* Retrieve resources from the database. */
543 if (!_getStringResource(inputDB->xrmDB, sessionIDStr, clientID,
544 &clientPtr->clientId, (char *)NULL) ||
545 !_getStringResource(inputDB->xrmDB, clientHostStr, clientID,
546 &clientPtr->clientHost, (char *)NULL) ||
547 !_getStringResource(inputDB->xrmDB, programStr, clientID,
548 &clientPtr->program, (char *)NULL) ||
549 !_getStringResource(inputDB->xrmDB, cwdStr, clientID,
550 &clientPtr->cwd, (char *)NULL) ||
551 !_getIntResource(inputDB->xrmDB, screenNumStr, clientID,
552 &clientPtr->screenNum, 0) ||
553 !_getStringArrayResource(inputDB->xrmDB, restartCmdStr, clientID,
554 &clientPtr->restartCommand, (char **)NULL) ||
555 !_getStringArrayResource(inputDB->xrmDB, cloneCmdStr, clientID,
556 &clientPtr->cloneCommand, (char **)NULL) ||
557 !_getStringArrayResource(inputDB->xrmDB, discardCmdStr, clientID,
558 &clientPtr->discardCommand, (char **)NULL) ||
559 !_getStringArrayResource(inputDB->xrmDB, environmentStr, clientID,
560 &clientPtr->environment, (char **)NULL) ||
561 !_getIntResource(inputDB->xrmDB, restartHintStr, clientID,
562 (int *)&clientPtr->restartHint, 0))
564 FreeXSMPClientDBRec(clientPtr);
565 return (XSMPClientDBRecPtr)NULL;
568 clientPtr->next = (XSMPClientDBRec *)NULL;
570 inputDB->nextXSMPClientIndex++;
576 GetProxyClientDBRec(ClientDB inputDBPtr)
578 ClientDBRec *inputDB = (ClientDBRec *)inputDBPtr;
579 ProxyClientDBRecPtr clientPtr;
582 if ((inputDB == (ClientDBRec *)NULL) ||
583 (!inputDB->openForInput) ||
584 (inputDB->nextProxyClientIndex >= inputDB->nProxyClients) ||
585 ((clientPtr = (ProxyClientDBRecPtr)XtMalloc(sizeof(ProxyClientDBRec)))
586 == (ProxyClientDBRecPtr)NULL))
588 return (ProxyClientDBRecPtr)NULL;
591 clientID = inputDB->proxyClients[inputDB->nextProxyClientIndex];
593 /* Initialize pointers so Free is easy. */
594 clientPtr->clientHost = (char *)NULL;
595 clientPtr->command = (char **)NULL;
597 /* Retrieve resources from the database. */
598 if (!_getStringResource(inputDB->xrmDB, clientHostStr, clientID,
599 &clientPtr->clientHost, (char *)NULL) ||
600 !_getStringArrayResource(inputDB->xrmDB, commandStr, clientID,
601 &clientPtr->command, (char **)NULL) ||
602 !_getIntResource(inputDB->xrmDB, screenNumStr, clientID,
603 &clientPtr->screenNum, 0))
605 FreeProxyClientDBRec(clientPtr);
606 return (ProxyClientDBRecPtr)NULL;
609 inputDB->nextProxyClientIndex++;
615 PutXSMPClientDBRec(ClientDB outputDBPtr,
616 XSMPClientDBRecPtr clientPtr)
618 ClientDBRec *outputDB = (ClientDBRec *)outputDBPtr;
619 char clientID[CLIENT_ID_SZ];
621 if ((outputDB == (ClientDBRec *)NULL) ||
622 (outputDB->openForInput) ||
623 (clientPtr == (XSMPClientDBRecPtr)NULL) ||
624 (clientPtr->clientId == (char *)NULL))
627 sprintf(clientID, "C%d", outputDB->nextXSMPClientIndex++);
629 if (!_putStringResource(outputDB, clientStr, clientID, clientID) ||
630 !_putStringResource(outputDB, sessionIDStr, clientID,
631 clientPtr->clientId) ||
632 !_putStringResource(outputDB, clientHostStr, clientID,
633 clientPtr->clientHost) ||
634 !_putStringResource(outputDB, programStr, clientID,
635 clientPtr->program) ||
636 !_putStringResource(outputDB, cwdStr, clientID,
638 !_putIntResource(outputDB, screenNumStr, clientID,
639 clientPtr->screenNum) ||
640 !_putStringArrayResource(outputDB, restartCmdStr, clientID,
641 clientPtr->restartCommand) ||
642 !_putStringArrayResource(outputDB, cloneCmdStr, clientID,
643 clientPtr->cloneCommand) ||
644 !_putStringArrayResource(outputDB, discardCmdStr, clientID,
645 clientPtr->discardCommand) ||
646 !_putStringArrayResource(outputDB, environmentStr, clientID,
647 clientPtr->environment) ||
648 !_putIntResource(outputDB, restartHintStr, clientID,
649 (int)clientPtr->restartHint))
656 PutProxyClientDBRec(ClientDB outputDBPtr,
657 ProxyClientDBRecPtr clientPtr)
659 ClientDBRec *outputDB = (ClientDBRec *)outputDBPtr;
660 char clientID[CLIENT_ID_SZ];
662 if ((outputDB == (ClientDBRec *)NULL) ||
663 (outputDB->openForInput) ||
664 (clientPtr == (ProxyClientDBRecPtr)NULL))
667 sprintf(clientID, "PC%d", outputDB->nextProxyClientIndex++);
669 if (!_putStringResource(outputDB, proxyStr, clientID, clientID) ||
670 !_putStringResource(outputDB, clientHostStr, clientID,
671 clientPtr->clientHost) ||
672 !_putStringArrayResource(outputDB, commandStr, clientID,
673 clientPtr->command) ||
674 !_putIntResource(outputDB, screenNumStr, clientID,
675 clientPtr->screenNum))
682 CloseClientDB(ClientDB clientDBPtr, Boolean writeDB)
684 ClientDBRec *clientDB = (ClientDBRec *)clientDBPtr;
686 if (clientDB == (ClientDBRec *)NULL)
690 if (clientDB->openForInput)
692 XtFree((char *)clientDB->XSMPClients);
693 XtFree((char *)clientDB->proxyClients);
694 XrmDestroyDatabase(clientDB->xrmDB);
695 XtFree((char *)clientDB);
700 /* Otherwise, output. */
703 /* Close file and remove temp DB. */
704 fclose(clientDB->xrmDBFile);
705 unlink(clientDB->tmpDBFileName);
710 /* Close file and remove it; restore original DB. */
711 fclose(clientDB->xrmDBFile);
712 rv = rename(clientDB->tmpDBFileName, clientDB->xrmDBFileName);
715 XtFree(clientDB->xrmDBFileName);
716 XtFree(clientDB->tmpDBFileName);
717 XtFree((char *)clientDB);
723 FreeXSMPClientDBRec(XSMPClientDBRecPtr clientPtr)
725 if (clientPtr != (XSMPClientDBRecPtr)NULL)
727 XtFree(clientPtr->clientId);
728 XtFree(clientPtr->clientHost);
729 XtFree(clientPtr->program);
730 XtFree(clientPtr->cwd);
732 _freeStringArray(clientPtr->restartCommand);
733 _freeStringArray(clientPtr->cloneCommand);
734 _freeStringArray(clientPtr->discardCommand);
735 _freeStringArray(clientPtr->environment);
737 XtFree((char *)clientPtr);
742 FreeProxyClientDBRec(ProxyClientDBRecPtr clientPtr)
744 if (clientPtr != (ProxyClientDBRecPtr)NULL)
746 XtFree(clientPtr->clientHost);
748 _freeStringArray(clientPtr->command);
750 XtFree((char *)clientPtr);