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.16 1996/01/24 10:13:56 adam
45 * Bug fix: in function wo_write realloc is used only when memory is already
46 * allocated with malloc.
48 * Revision 1.15 1996/01/24 08:25:32 adam
49 * Buf fix: Uninitialized outbuffer_offset member.
51 * Revision 1.14 1996/01/12 13:08:07 adam
52 * CGI script passes name of lock file to the shell. The server will not close
53 * the response FIFO until this file becomes unlocked. This method handles
54 * cancel operations much better.
56 * Revision 1.13 1996/01/12 10:05:20 adam
57 * If script name ends with ';' HTTP/GET/Expires will be defined.
58 * The cgi interface only reads final handshake if response from
59 * server (shell) was zero-terminated [If it isn't it probably died].
61 * Revision 1.12 1996/01/05 16:35:02 adam
64 * Revision 1.11 1996/01/05 16:21:21 adam
65 * Bug fix: shell (wproto) sometimes closed server FIFO before cgi
66 * program opened it - solution: cgi sends OK when response has been read.
68 * Revision 1.10 1995/12/22 14:21:16 adam
69 * More work on scan. The search.egw script takes care of cached
70 * query page (doesn't always increment nextSetNo). To make new search set
71 * either 'New query' must be selected or the query page must be reloaded.
72 * The msearch script doesn't do this yet, however.
74 * Revision 1.9 1995/11/14 16:31:36 adam
75 * Temporary remove of ccl entry.
77 * Revision 1.8 1995/11/13 15:41:45 adam
79 * Gateway uses record element set names B(rief) and F(ull).
80 * Bug fix. Didn't save idAuthentication correctly.
82 * Revision 1.7 1995/11/10 14:47:32 adam
83 * Plus (+) characters automatically converted to space in forms.
84 * Work on search in multiple targets. Doesn't work well - yet.
85 * Presentation formats enhanced.
87 * Revision 1.6 1995/11/06 10:51:17 adam
88 * End of response marker in response from wsh/wproto to wcgi.
89 * Shells are respawned when necessary.
91 * Revision 1.5 1995/11/02 16:35:37 adam
92 * Bug fixes and select on FIFOs in wcgi - doesn't really work!
94 * Revision 1.4 1995/10/31 16:56:25 adam
95 * Record presentation.
97 * Revision 1.3 1995/10/27 15:12:10 adam
98 * IrTcl incorporated in the gateway.
99 * Better separation of script types.
100 * Z39.50 gateway scripts entered.
102 * Revision 1.2 1995/10/23 16:55:39 adam
103 * A lot of changes - really.
105 * Revision 1.1 1995/10/20 11:49:26 adam
106 * First version of www gateway.
113 #include <sys/time.h>
114 #include <sys/types.h>
115 #include <sys/stat.h>
124 static int wproto_dumpcache(WCLIENT wc, int level);
125 static int wproto_findcache(WCLIENT wc, char *name);
126 static void wproto_uncache(WCLIENT wc, int level);
128 static char *mod = "wproto";
130 void wo_write (WCLIENT wc, const char *s, size_t len)
132 if (wc->outbuffer_offset + len >= wc->outbuffer_size)
135 wc->outbuffer = malloc (wc->outbuffer_size +=
136 ((len >= OUTBUFFER_CHUNK) ? len*2 : OUTBUFFER_CHUNK));
138 wc->outbuffer = realloc(wc->outbuffer, wc->outbuffer_size +=
139 ((len >= OUTBUFFER_CHUNK) ? len*2 : OUTBUFFER_CHUNK));
141 memcpy(wc->outbuffer + wc->outbuffer_offset, s, len);
142 wc->outbuffer_offset += len;
145 void wo_puts (WCLIENT wc, const char *s)
147 wo_write (wc, s, strlen(s));
150 void wo_printf (WCLIENT wc, const char *fmt, ...)
156 vsprintf(tmpbuf, fmt, ap);
161 void wo_clear (WCLIENT wc, const char *type)
163 wc->outbuffer_offset = 0;
165 wo_printf(wc, "Content-type: %s\n\n", type);
168 int wo_puthtml (WCLIENT wc, char *name)
173 wo_clear(wc, "text/html");
174 if (!(f = fopen(name, "r")))
176 wo_printf(wc, "<BR>Failed to open file: %s<BR>", name);
179 while (ch = getc(f), !feof(f))
181 if (wo_putc(wc, ch) < 0)
191 int wo_flush(WCLIENT wc)
195 if (!(wc->outbuffer_offset))
197 towrite = wc->outbuffer_offset;
198 wc->outbuffer_offset = 0;
204 wrote = write(wc->lineout, wc->outbuffer + wc->outbuffer_offset,
208 gw_log (GW_LOG_FATAL|GW_LOG_ERRNO, mod, "write response");
211 gw_log (GW_LOG_DEBUG, mod, "wrote %d bytes", wrote);
212 if (wc->cache_fd >= 0)
213 if (write(wc->cache_fd, wc->outbuffer + wc->outbuffer_offset,
216 gw_log (GW_LOG_FATAL|GW_LOG_ERRNO, mod, "write cache");
222 wc->outbuffer_offset += wrote;
224 wc->outbuffer_offset = 0;
228 int wo_overflow(WCLIENT wc, char ch)
230 gw_log (GW_LOG_DEBUG, mod, "wo_overflow");
231 if (wo_flush(wc) < 0)
233 return wo_putc(wc, ch);
236 int wo_finish(WCLIENT wc)
239 gw_log (GW_LOG_DEBUG, mod, "wo_finish");
242 if (wo_flush(wc) < 0)
245 fd = open (wc->wf_serverf, O_RDONLY);
249 area.l_type = F_RDLCK;
250 area.l_whence = SEEK_SET;
253 fcntl (fd, F_SETLKW, &area);
258 if (wc->cache_fd >= 0)
266 static void descramble(char *t, const char *o)
272 if (*o == '%' && isxdigit(*(o + 1)) && isxdigit(*(o + 2)))
274 sscanf(o + 1, "%2x", &v);
295 static void decode_form(wform_data *form, char *buf)
303 for (p = form[i].name; *buf && *buf != '='; buf++)
308 for (p = tmp; *buf && *buf != '&'; buf++)
311 descramble(form[i].value, tmp);
316 *form[i].name = '\0';
319 char *wgetval(WCLIENT wc, char *name)
323 for (i = 0; *wc->wf_data[i].name; i++)
324 if (!strcmp(name, wc->wf_data[i].name))
325 return wc->wf_data[i].value;
329 int wproto_process(WCLIENT wc, int timeout)
331 int toread, rs, level;
332 char combuf[COMBUF], *p,*t;
334 struct timeval to, *top;
338 gw_log (GW_LOG_DEBUG, mod, "process waiting for input.");
348 FD_SET(wc->linein, &input);
349 /* go through select handle list */
350 while ((rs = select(wc->linein + 1, &input, 0, 0, top)) < 0 &&
355 gw_log (GW_LOG_FATAL|GW_LOG_ERRNO, mod, "select");
360 gw_log (GW_LOG_STAT, mod,
361 "wproto_process returning 0 after %d second timeout.",
363 unlink (wc->wf_serverp);
366 /* determine handle (fifo or user) */
367 if (read(wc->linein, &toread, sizeof(toread)) < sizeof(toread))
369 gw_log (GW_LOG_FATAL|GW_LOG_ERRNO, mod, "wp_proc:len read failed");
372 toread -= sizeof(toread);
373 if (read(wc->linein, combuf, toread) < toread)
375 gw_log (GW_LOG_FATAL|GW_LOG_ERRNO, mod, "wp_proc: data read failed");
379 for (t = wc->wf_serverp; (*t = *p); t++, p++);
381 for (t = wc->wf_serverf; (*t = *p); t++, p++);
383 for (t = wc->wf_parms; (*t = *p); t++, p++);
385 p++; /* we don't deal with envvars yet */
386 decode_form(wc->wf_data, p);
389 gw_log (GW_LOG_DEBUG, mod, "open %s", wc->wf_serverp);
390 if ((wc->lineout = open(wc->wf_serverp, O_WRONLY)) < 0)
392 gw_log (GW_LOG_FATAL|GW_LOG_ERRNO, mod, "open %s",
397 /* look in cache only if request carries no forms data. */
398 if (!*wc->wf_data[0].name && (level = wproto_findcache(wc,
401 gw_log (GW_LOG_DEBUG, mod, "wproto_dumpcache");
402 wproto_dumpcache(wc, level);
413 WCLIENT wproto_init(void)
415 char *val, path2[256];
418 gw_log (GW_LOG_DEBUG, mod, "wproto_init");
419 close(1); /* release us from the wserver */
420 if (!(new = malloc(sizeof(*new))))
422 gw_log (GW_LOG_FATAL|GW_LOG_ERRNO, mod, "malloc");
425 if (!(val = getenv ("GWID")))
427 gw_log (GW_LOG_FATAL, mod, "GWID not set");
430 new->id = atoi (val);
431 sprintf(new->path, "%s/%s/clt%d", FIFOROOT, FIFODIR, new->id);
432 if (mkfifo(new->path, 0666 | S_IFIFO) < 0)
433 gw_log (GW_LOG_WARN|GW_LOG_ERRNO, mod, "mkfifo(%s)", new->path);
434 gw_log (GW_LOG_DEBUG, mod, "Synchronizing with server.");
435 sprintf(path2, "%s/%s/srv%d", FIFOROOT, FIFODIR, getppid());
436 if ((new->lineout = open(path2, O_WRONLY)) < 0)
438 gw_log (GW_LOG_FATAL|GW_LOG_ERRNO, mod, "open out %s", path2);
441 if (write(new->lineout, "OK", 2) < 2)
443 gw_log (GW_LOG_FATAL|GW_LOG_ERRNO, mod, "write");
446 gw_log (GW_LOG_DEBUG, mod, "Synchronized.");
447 if ((new->linein = open(new->path, O_RDONLY)) < 0)
449 gw_log (GW_LOG_FATAL|GW_LOG_ERRNO, mod, "open input %s", new->path);
452 gw_log (GW_LOG_DEBUG, mod, "init. linein=%d lineout=%d",
453 new->linein, new->lineout);
454 /* we put a handle on this so we get a blocking read when no peer */
455 if (open(new->path, O_WRONLY | O_NDELAY) < 0)
457 gw_log (GW_LOG_FATAL|GW_LOG_ERRNO, mod, "open dummy %s", new->path);
461 new->outbuffer_size = 0;
462 new->outbuffer_offset = 0;
463 new->cache_level = -1;
468 static void wproto_uncache(WCLIENT wc, int level)
470 for (;wc->cache_level >= level; wc->cache_level--)
471 unlink(wc->cache[wc->cache_level].path);
474 void wproto_terminate(WCLIENT wc)
478 wproto_uncache(wc, 0);
482 int wproto_cache(WCLIENT wc, int level)
486 if (level > wc->cache_level + 1)
488 gw_log (GW_LOG_FATAL, mod, "Illegal cache level increment.");
491 wproto_uncache(wc, level);
492 p = &wc->cache[++wc->cache_level];
493 sprintf(p->path, "%s/%s/csh%d.%d", FIFOROOT, FIFODIR, wc->id, level);
494 if ((wc->cache_fd = open(p->path, O_WRONLY|O_CREAT|O_TRUNC, 0600)) < 0)
496 gw_log (GW_LOG_FATAL|GW_LOG_ERRNO, mod, "open %s", p->path);
499 strcpy(p->name, wc->wf_parms);
503 static int wproto_findcache(WCLIENT wc, char *name)
507 for (i = 0; i <= wc->cache_level; i++)
508 if (!strcmp(wc->cache[i].name, name))
513 static int wproto_dumpcache(WCLIENT wc, int level)
517 gw_log (GW_LOG_STAT, mod, "Using Cache: %s", wc->cache[level].name);
518 if ((fd = open(wc->cache[level].path, O_RDONLY)) < 0)
520 gw_log (GW_LOG_FATAL, mod, "open (R) %s", wc->cache[level].path);
523 while ((rd = read(fd, wc->outbuffer, OUTBUFFER_CHUNK)) > 0)
524 if (write(wc->lineout, wc->outbuffer, rd) < rd)
526 gw_log (GW_LOG_FATAL|GW_LOG_ERRNO, mod, "write toline");
531 gw_log (GW_LOG_FATAL|GW_LOG_ERRNO, mod, "read");
534 wproto_uncache(wc, level + 1);