2 * Copyright (c) 1995, the EUROPAGATE consortium (see below).
4 * The EUROPAGATE consortium members are:
6 * University College Dublin
7 * Danmarks Teknologiske Videnscenter
8 * An Chomhairle Leabharlanna
9 * Consejo Superior de Investigaciones Cientificas
11 * Permission to use, copy, modify, distribute, and sell this software and
12 * its documentation, in whole or in part, for any purpose, is hereby granted,
15 * 1. This copyright and permission notice appear in all copies of the
16 * software and its documentation. Notices of copyright or attribution
17 * which appear at the beginning of any file must remain unchanged.
19 * 2. The names of EUROPAGATE or the project partners may not be used to
20 * endorse or promote products derived from this software without specific
21 * prior written permission.
23 * 3. Users of this software (implementors and gateway operators) agree to
24 * inform the EUROPAGATE consortium of their use of the software. This
25 * information will be used to evaluate the EUROPAGATE project and the
26 * software, and to plan further developments. The consortium may use
27 * the information in later publications.
29 * 4. Users of this software agree to make their best efforts, when
30 * documenting their use of the software, to acknowledge the EUROPAGATE
31 * consortium, and the role played by the software in their work.
33 * THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT WARRANTY OF ANY KIND,
34 * EXPRESS, IMPLIED, OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY
35 * WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
36 * IN NO EVENT SHALL THE EUROPAGATE CONSORTIUM OR ITS MEMBERS BE LIABLE
37 * FOR ANY SPECIAL, INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES OF
38 * ANY KIND, OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA
39 * OR PROFITS, WHETHER OR NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND
40 * ON ANY THEORY OF LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE
41 * USE OR PERFORMANCE OF THIS SOFTWARE.
44 * Revision 1.18 1996/03/14 11:48:37 adam
45 * New function egw_prog that returns name of shell.
47 * Revision 1.17 1996/02/26 10:36:15 adam
48 * Better error handling when (re)spawn of the shell fails.
50 * Revision 1.16 1996/02/12 10:10:29 adam
51 * Resource/config system used by the gateway.
53 * Revision 1.15 1996/01/26 09:02:20 adam
54 * Open of client FIFO called with O_NDELAY when reconnecting to shell
55 * in order to prevent serious lock if previous shell died without
56 * unlinking client FIFO.
58 * Revision 1.14 1996/01/12 13:08:06 adam
59 * CGI script passes name of lock file to the shell. The server will not close
60 * the response FIFO until this file becomes unlocked. This method handles
61 * cancel operations much better.
63 * Revision 1.13 1996/01/12 10:05:17 adam
64 * If script name ends with ';' HTTP/GET/Expires will be defined.
65 * The cgi interface only reads final handshake if response from
66 * server (shell) was zero-terminated [If it isn't it probably died].
68 * Revision 1.12 1996/01/09 10:46:49 adam
69 * New defines: LOGDIR/EGWDIR/CGIDIR set in Makefile.
71 * Revision 1.11 1996/01/08 08:42:19 adam
74 * Revision 1.10 1996/01/05 16:21:20 adam
75 * Bug fix: shell (wproto) sometimes closed server FIFO before cgi
76 * program opened it - solution: cgi sends OK when response has been read.
78 * Revision 1.9 1995/12/20 16:31:33 adam
79 * Bug fix: shell might terminate even though new request was initiated
80 * by the cgi interface program.
81 * Work on more simple user interface and Europagate buttons.
83 * Revision 1.8 1995/11/08 16:14:35 adam
84 * Many improvements and bug fixes.
85 * First version that ran on dtbsun.
87 * Revision 1.7 1995/11/08 12:42:18 adam
88 * Added descriptive text field in target info.
89 * Added authentication field in target info.
91 * Revision 1.6 1995/11/06 17:44:22 adam
92 * State reestablised when shell restarts. History of previous
95 * Revision 1.5 1995/11/06 10:51:15 adam
96 * End of response marker in response from wsh/wproto to wcgi.
97 * Shells are respawned when necessary.
99 * Revision 1.4 1995/11/02 16:35:37 adam
100 * Bug fixes and select on FIFOs in wcgi - doesn't really work!
102 * Revision 1.3 1995/10/31 16:56:24 adam
103 * Record presentation.
105 * Revision 1.2 1995/10/23 16:55:36 adam
106 * A lot of changes - really.
108 * Revision 1.1 1995/10/20 11:49:25 adam
109 * First version of www gateway.
117 #include <sys/stat.h>
118 #include <sys/time.h>
119 #include <sys/types.h>
121 #include <sys/select.h>
128 static char *prog = "cgi";
130 static char serverp[256] = {'\0'};
131 static char serverf[256] = {'\0'};
132 static GW_DB gw_db = NULL;
134 static void fatal(char *p)
136 printf("Content-type: text/html\n\n<HTML><HEAD><TITLE>Server Failure</TITLE></HEAD>\n");
137 printf("<BODY>%s</BODY>\n", p);
147 static int spawn (char *sprog, int id)
153 sprintf (envstr, "GWID=%d", id);
155 sprintf(path, "%s/%s", EGWDIR, sprog);
159 gw_log (GW_LOG_FATAL|GW_LOG_ERRNO, prog, "fork");
160 fatal ("Internal error in server");
165 gw_log (GW_LOG_DEBUG, prog, "execl %s", path);
166 execl (path, sprog, 0);
167 gw_log (GW_LOG_FATAL|GW_LOG_ERRNO, prog, "execl %s", path);
168 fd = open (serverp, O_WRONLY);
181 static void print_environ (void)
183 extern char **environ;
186 for (i = 0; environ[i]; i++)
187 gw_log (GW_LOG_DEBUG, prog, "e: %s", environ[i]);
192 * NOTE: In the (perhaps odd) terminology used within this software,
193 * the 'server' is the present program, which is executed by the httpd
194 * server. The 'client' is the process running outside.
195 * Protocol is long(len)<serverfifo>\0<extrapath>\0<envvars>\0<INFO>\0
199 char clientp[256], *path_info, *p, *operation, *t;
204 int linein = -1, lineout, data, gw_id;
207 fatal ("Couldn't change directory to " EGWDIR);
209 gw_log_file (GW_LOG_ALL, "egwcgi_log");
211 gw_log_level (GW_LOG_ALL);
213 gw_log_session (getpid());
214 gw_log (GW_LOG_STAT, prog, "Europagate www cgi server");
215 cgiRes = gw_res_init ();
216 gw_res_merge (cgiRes, "egw.res");
219 gw_log_level (gw_log_mask_str (
220 gw_res_get (cgiRes, "log.level", "default")));
222 fifoDir = gw_res_get (cgiRes, "fifo.dir", "/tmp/egw");
224 /* Create fifo directory if it doesn't exist already */
225 if (access(fifoDir, R_OK|W_OK) < 0 && mkdir(fifoDir, 0777) < 0)
227 gw_log (GW_LOG_FATAL|GW_LOG_ERRNO, prog, "Failed to create %s",
229 fatal("Internal error in server.");
231 /* Delete server FIFO if it does exist */
232 sprintf(serverp, "%s/srv%d", fifoDir, getpid());
233 if (access(serverp, R_OK|W_OK) == 0)
235 if (unlink(serverp) < 0)
237 gw_log (GW_LOG_FATAL|GW_LOG_ERRNO, prog,
238 "Failed to delete stale fifo.");
239 fatal("Internal error in server.");
242 gw_log (GW_LOG_WARN, prog, "Removed stale server fifo.");
244 /* Make server FIFO */
245 if (mkfifo(serverp, 0666 | S_IFIFO) < 0)
247 gw_log (GW_LOG_FATAL|GW_LOG_ERRNO, prog, "mkfifo(%s)", serverp);
248 fatal("Internal error in server.");
250 /* The httpd server must pass PATH_INFO */
251 if (!(path_info = getenv("PATH_INFO")))
253 gw_log (GW_LOG_FATAL, prog, "Must set PATH_INFO.");
254 fatal("Internal error in server.");
256 /* Create lock file that ensures the server (shell) doesn't */
257 /* terminate before we have read the whole response */
258 sprintf (serverf, "%s/srf%d", fifoDir, getpid ());
259 gw_log (GW_LOG_DEBUG, prog, "open w %s", serverf);
260 serverf_fd = open (serverf, O_WRONLY|O_CREAT|O_TRUNC, 0666);
261 if (serverf_fd == -1)
263 gw_log (GW_LOG_FATAL|GW_LOG_ERRNO, prog, "open (%s)", serverf);
264 fatal("Internal error in server.");
269 area.l_type = F_WRLCK;
270 area.l_whence = SEEK_SET;
273 fcntl (serverf_fd, F_SETLK, &area);
275 /* Read first part of path_info. Either it is a numeric session id */
276 /* or it is the name of a backend shell. */
277 operation = ++path_info;
278 while (*path_info && *path_info != '/')
281 *(path_info++) = '\0';
282 gw_log (GW_LOG_DEBUG, prog, "www.db open");
283 if (!(gw_db = gw_db_open (EGWDIR "/www.db", 1, 1)))
285 gw_log (GW_LOG_FATAL, prog, "gw_db_open");
288 gw_log (GW_LOG_DEBUG, prog, "www.db ok");
289 /* Is operation a backend shell (new session) ? */
290 if ((gw_id = atoi(operation)) <= 0)
295 /* Get new unique id */
296 gw_id = gw_db_seq_no (gw_db);
297 sprintf (gw_id_str, "%d", gw_id);
299 /* Spawn backend shell (server) */
300 spawn(operation, gw_id);
301 r = gw_db_insert (gw_db, gw_id_str, strlen(gw_id_str)+1,
302 operation, strlen(operation)+1);
305 gw_log (GW_LOG_FATAL, prog, "gw_db_insert: %d", r);
309 gw_log (GW_LOG_DEBUG, prog, "Synchronizing with client");
310 if ((linein = open(serverp, O_RDONLY)) < 0)
312 gw_log (GW_LOG_FATAL|GW_LOG_ERRNO, prog, "open r %s", serverp);
313 fatal("Internal error in server.");
315 if (read(linein, combuf, 2) < 2 || strcmp(combuf, "OK"))
317 gw_log (GW_LOG_FATAL, prog, "Failed to synchronize with client");
318 fatal("Internal error in server");
320 gw_log (GW_LOG_DEBUG, prog, "Synchronized");
321 sprintf(clientp, "%s/clt%d", fifoDir, gw_id);
322 gw_log (GW_LOG_DEBUG, prog, "open w %s", clientp);
323 lineout = open (clientp, O_WRONLY);
325 else /* A session is continued */
327 sprintf(clientp, "%s/clt%d", fifoDir, gw_id);
328 gw_log (GW_LOG_DEBUG, prog, "open w|n %s", clientp);
329 /* Open the FIFO in O_NDELAY-mode: This prevents blocking */
330 /* even though the shell died without unlinking the FIFO */
331 /* On the other hand, if the shell is running, it will never */
332 /* close this FIFO */
333 lineout = open (clientp, O_WRONLY|O_NDELAY);
335 /* If open of clientp failed, the shell is not running, so we */
336 /* invoke it again */
344 sprintf (gw_id_str, "%d", gw_id);
345 r = gw_db_lookup (gw_db, gw_id_str, strlen(gw_id_str)+1,
346 &sprog, &sprog_size);
349 gw_log (GW_LOG_FATAL, prog, "gw_db_lookup %s", gw_id_str);
350 fatal("Internal error in server");
352 gw_log (GW_LOG_DEBUG|GW_LOG_ERRNO, prog, "open r %s restart", clientp);
353 spawn (sprog, gw_id);
354 gw_log (GW_LOG_DEBUG, prog, "Synchronizing with client");
355 if ((linein = open(serverp, O_RDONLY)) < 0)
357 gw_log (GW_LOG_FATAL|GW_LOG_ERRNO, prog, "open %s", serverp);
358 fatal("Internal error in server");
360 if (read(linein, combuf, 2) < 2 || strcmp(combuf, "OK"))
362 gw_log (GW_LOG_FATAL, prog, "Failed to synchronize with client.");
363 fatal("Internal error in server");
365 gw_log (GW_LOG_DEBUG, prog, "Synchronized.");
366 if ((lineout = open(clientp, O_WRONLY)) < 0)
368 gw_log (GW_LOG_FATAL|GW_LOG_ERRNO, prog, "%s", clientp);
369 fatal("Internal error in server");
373 gw_log (GW_LOG_DEBUG, prog, "Decoding user data");
374 p = combuf + sizeof(data);
379 strcpy (p, path_info);
380 gw_log (GW_LOG_STAT, prog, "P:%s", p);
382 *(p++) = '\0'; /* no envvars tranferred at present */
383 if ((t = getenv("CONTENT_LENGTH")) && (data = atoi(t)) > 0)
388 j = read(0, p + i, data - i);
391 gw_log (GW_LOG_ERRNO|GW_LOG_FATAL, prog,
392 "Failed to read input");
393 fatal("Internal error in server");
397 gw_log (GW_LOG_ERRNO, prog, "Failed to read input");
398 fatal("Internal error in server");
403 else if ((t = getenv("QUERY_STRING")))
409 gw_log (GW_LOG_DEBUG, prog, "C:%s", p);
412 memcpy(combuf, &data, sizeof(data));
413 gw_log (GW_LOG_DEBUG, prog, "Writing data");
414 if (write(lineout, combuf, data) < data)
416 gw_log (GW_LOG_FATAL|GW_LOG_ERRNO, prog, "write");
417 fatal("Internal server error");
421 gw_log (GW_LOG_DEBUG, prog, "open r %s", serverp);
422 if ((linein = open(serverp, O_RDONLY)) < 0)
424 gw_log (GW_LOG_FATAL|GW_LOG_ERRNO, prog, "open %s", serverp);
425 fatal("Internal error in server");
428 gw_log (GW_LOG_DEBUG, prog, "Reading response");
430 while ((data = read(linein, combuf, COMBUF)) > 0)
432 gw_log (GW_LOG_DEBUG, prog, "Got %d bytes", data);
433 if (combuf[data-1] == '\0')
435 if (write(1, combuf, data) < data)
437 gw_log (GW_LOG_FATAL|GW_LOG_ERRNO, prog, "write");
443 gw_log (GW_LOG_FATAL|GW_LOG_ERRNO, prog, "read");
448 if (close (serverf_fd))
450 gw_log (GW_LOG_FATAL|GW_LOG_ERRNO, prog, "close %s", serverf);
454 if (write(1, combuf, data) < data)
456 gw_log (GW_LOG_FATAL|GW_LOG_ERRNO, prog, "write");
461 gw_log (GW_LOG_DEBUG, prog, "Cleaning up.");