www/wproto.c

   1 /*
   2  * Copyright (c) 1995, the EUROPAGATE consortium (see below).
   3  *
   4  * The EUROPAGATE consortium members are:
   5  *
   6  *    University College Dublin
   7  *    Danmarks Teknologiske Videnscenter
   8  *    An Chomhairle Leabharlanna
   9  *    Consejo Superior de Investigaciones Cientificas
  10  *
  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,
  13  * provided that:
  14  *
  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.
  18  *
  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.
  22  *
  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.
  28  *
  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.
  32  *
  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.
  42  *
  43  * $Log: wproto.c,v $
  44  * Revision 1.25  1997/02/10 10:15:38  adam
  45  * Bug fix: egw_source <file> <var> didn't work properly.
  46  *
  47  * Revision 1.24  1997/01/31 11:16:00  adam
  48  * Enhanced the egw_source command. An optional parameter specifies the
  49  * name of a variable in which the HTML output is stored.
  50  *
  51  * Revision 1.23  1997/01/27 11:27:14  adam
  52  * Implemented a new command, egw_clear, to clear http output cache.
  53  * Changed prototype for function wo_clear.
  54  *
  55  * Revision 1.22  1997/01/24 13:13:11  adam
  56  * Implemnted egw_source and added a "raw" option to the URL.
  57  * Fixed a bug in the buffering system of wproto; the macro wo_putc could
  58  * override memory if it was the first HTML generating function called.
  59  *
  60  * Revision 1.21  1996/05/23 15:53:11  adam
  61  * Bug fix: egw_enc failed on 8-bit chars.
  62  * New command: egw_parms.
  63  *
  64  * Revision 1.20  1996/05/21  14:53:04  adam
  65  * Tcl command wform extented; options -raw and -exists added.
  66  *
  67  * Revision 1.19  1996/03/14  11:48:39  adam
  68  * New function egw_prog that returns name of shell.
  69  *
  70  * Revision 1.18  1996/02/12  10:09:23  adam
  71  * New parameter to wproto_init: directory root for the FIFOs (instead
  72  * of using preprocessor defines FIFODIR/FIFOROOT).
  73  *
  74  * Revision 1.17  1996/01/26  09:02:22  adam
  75  * Open of client FIFO called with O_NDELAY when reconnecting to shell
  76  * in order to prevent serious lock if previous shell died without
  77  * unlinking client FIFO.
  78  *
  79  * Revision 1.16  1996/01/24  10:13:56  adam
  80  * Bug fix: in function wo_write realloc is used only when memory is already
  81  * allocated with malloc.
  82  *
  83  * Revision 1.15  1996/01/24  08:25:32  adam
  84  * Buf fix: Uninitialized outbuffer_offset member.
  85  *
  86  * Revision 1.14  1996/01/12  13:08:07  adam
  87  * CGI script passes name of lock file to the shell. The server will not close
  88  * the response FIFO until this file becomes unlocked. This method handles
  89  * cancel operations much better.
  90  *
  91  * Revision 1.13  1996/01/12  10:05:20  adam
  92  * If script name ends with ';' HTTP/GET/Expires will be defined.
  93  * The cgi interface only reads final handshake if response from
  94  * server (shell) was zero-terminated [If it isn't it probably died].
  95  *
  96  * Revision 1.12  1996/01/05  16:35:02  adam
  97  * Minor changes.
  98  *
  99  * Revision 1.11  1996/01/05  16:21:21  adam
 100  * Bug fix: shell (wproto) sometimes closed server FIFO before cgi
 101  * program opened it - solution: cgi sends OK when response has been read.
 102  *
 103  * Revision 1.10  1995/12/22  14:21:16  adam
 104  * More work on scan. The search.egw script takes care of cached
 105  * query page (doesn't always increment nextSetNo). To make new search set
 106  * either 'New query' must be selected or the query page must be reloaded.
 107  * The msearch script doesn't do this yet, however.
 108  *
 109  * Revision 1.9  1995/11/14  16:31:36  adam
 110  * Temporary remove of ccl entry.
 111  *
 112  * Revision 1.8  1995/11/13  15:41:45  adam
 113  * Arrow gifs.
 114  * Gateway uses record element set names B(rief) and F(ull).
 115  * Bug fix. Didn't save idAuthentication correctly.
 116  *
 117  * Revision 1.7  1995/11/10  14:47:32  adam
 118  * Plus (+) characters automatically converted to space in forms.
 119  * Work on search in multiple targets. Doesn't work well - yet.
 120  * Presentation formats enhanced.
 121  *
 122  * Revision 1.6  1995/11/06  10:51:17  adam
 123  * End of response marker in response from wsh/wproto to wcgi.
 124  * Shells are respawned when necessary.
 125  *
 126  * Revision 1.5  1995/11/02  16:35:37  adam
 127  * Bug fixes and select on FIFOs in wcgi - doesn't really work!
 128  *
 129  * Revision 1.4  1995/10/31  16:56:25  adam
 130  * Record presentation.
 131  *
 132  * Revision 1.3  1995/10/27  15:12:10  adam
 133  * IrTcl incorporated in the gateway.
 134  * Better separation of script types.
 135  * Z39.50 gateway scripts entered.
 136  *
 137  * Revision 1.2  1995/10/23  16:55:39  adam
 138  * A lot of changes - really.
 139  *
 140  * Revision 1.1  1995/10/20  11:49:26  adam
 141  * First version of www gateway.
 142  *
 143  */
 144
 145 #include <stdio.h>
 146 #include <string.h>
 147 #include <stdlib.h>
 148 #include <sys/time.h>
 149 #include <sys/types.h>
 150 #include <sys/stat.h>
 151 #include <fcntl.h>
 152 #include <unistd.h>
 153 #include <stdarg.h>
 154 #include <ctype.h>
 155 #include <errno.h>
 156 #include <assert.h>
 157
 158 #include "wproto.h"
 159
 160 static int wproto_dumpcache(WCLIENT wc, int level);
 161 static int wproto_findcache(WCLIENT wc, char *name);
 162 static void wproto_uncache(WCLIENT wc, int level);
 163
 164 static char *mod = "wproto";
 165
 166 void wo_expand (WCLIENT wc, size_t len)
 167 {
 168     assert (wc->outbuffer);
 169     wc->outbuffer = realloc(wc->outbuffer, wc->outbuffer_size +=
 170           ((len >= OUTBUFFER_CHUNK) ? len*2 : OUTBUFFER_CHUNK));
 171 }
 172
 173 void wo_write (WCLIENT wc, const char *s, size_t len)
 174 {
 175     if (wc->outbuffer_offset + len >= wc->outbuffer_size)
 176         wo_expand (wc, len);
 177     memcpy(wc->outbuffer + wc->outbuffer_offset, s, len);
 178     wc->outbuffer_offset += len;
 179 }
 180
 181 void wo_puts (WCLIENT wc, const char *s)
 182 {
 183     wo_write (wc, s, strlen(s));
 184 }
 185
 186 void wo_printf (WCLIENT wc, const char *fmt, ...)
 187 {
 188     va_list ap;
 189     char tmpbuf[4048];
 190
 191     va_start(ap, fmt);
 192     vsprintf(tmpbuf, fmt, ap);
 193     wo_puts(wc, tmpbuf);
 194     va_end(ap);
 195 }
 196
 197 void wo_clear (WCLIENT wc)
 198 {
 199     if (!wc->outbuffer)
 200         wc->outbuffer = malloc (wc->outbuffer_size = OUTBUFFER_CHUNK);
 201     wc->outbuffer_offset = 0;
 202 }
 203
 204 int wo_flush(WCLIENT wc)
 205 {
 206     int wrote, towrite;
 207
 208     if (!(wc->outbuffer_offset))
 209         return 0;
 210     towrite = wc->outbuffer_offset;
 211     wc->outbuffer_offset = 0;
 212     for (;;)
 213     {
 214         int w_chunk;
 215
 216         w_chunk = towrite;
 217         wrote = write(wc->lineout, wc->outbuffer + wc->outbuffer_offset,
 218             w_chunk);
 219         if (wrote <= 0)
 220         {
 221             gw_log (GW_LOG_FATAL|GW_LOG_ERRNO, mod, "write response");
 222             return -1;
 223         }
 224         gw_log (GW_LOG_DEBUG, mod, "wrote %d bytes", wrote);
 225         if (wc->cache_fd >= 0)
 226             if (write(wc->cache_fd, wc->outbuffer + wc->outbuffer_offset,
 227                 towrite) < 0)
 228             {
 229                 gw_log (GW_LOG_FATAL|GW_LOG_ERRNO, mod, "write cache");
 230                 return -1;
 231             }
 232         towrite -= wrote;
 233         if (!towrite)
 234             break;
 235         wc->outbuffer_offset += wrote;
 236     }
 237     wc->outbuffer_offset = 0;
 238     return 0;
 239 }
 240
 241 int wo_overflow(WCLIENT wc, char ch)
 242 {
 243     gw_log (GW_LOG_DEBUG, mod, "wo_overflow");
 244     if (wc->save_level)
 245         wo_expand (wc, 0);
 246     else if (wo_flush(wc) < 0)
 247         return -1;
 248     return wo_putc(wc, ch);
 249 }
 250
 251 int wo_finish(WCLIENT wc)
 252 {
 253     int fd;
 254     gw_log (GW_LOG_DEBUG, mod, "wo_finish");
 255
 256     wo_putc (wc, 0);
 257     if (wo_flush(wc) < 0)
 258         return -1;
 259
 260     fd = open (wc->wf_serverf, O_RDONLY);
 261     if (fd != -1)
 262     {
 263         struct flock area;
 264         area.l_type = F_RDLCK;
 265         area.l_whence = SEEK_SET;
 266         area.l_start = 0L;
 267         area.l_len = 0L;
 268         fcntl (fd, F_SETLKW, &area);
 269         close (fd);
 270     }
 271     close(wc->lineout);
 272     wc->lineout = -1;
 273     if (wc->cache_fd >= 0)
 274     {
 275         close(wc->cache_fd);
 276         wc->cache_fd = -1;
 277     }
 278     return 0;
 279 }
 280
 281 static void descramble(char *t, const char *o)
 282 {
 283     unsigned int v;
 284
 285     while (*o)
 286     {
 287         if (*o == '%' && isxdigit(*(o + 1)) && isxdigit(*(o + 2)))
 288         {
 289             sscanf(o + 1, "%2x", &v);
 290             o += 3;
 291             if (v == '+')
 292                 *t = ' ';
 293             else
 294                 *t = (char) v;
 295             t++;
 296         }
 297         else
 298         {
 299             if (*o == '+')
 300                 *t = ' ';
 301             else
 302                 *t = *o;
 303             t++;
 304             o++;
 305         }
 306     }
 307     *t = '\0';
 308 }
 309
 310 static void decode_form(wform_data *form, char *buf)
 311 {
 312     int i = 0;
 313     char *p;
 314     char tmp[512];
 315
 316     while (*buf)
 317     {
 318         for (p = form[i].name; *buf && *buf != '='; buf++)
 319             *(p++) = *buf;
 320         *p = '\0';
 321         if (*buf)
 322             buf++;
 323         for (p = tmp; *buf && *buf != '&'; buf++)
 324             *(p++) = *buf;
 325         *p = '\0';
 326         descramble(form[i].value, tmp);
 327         if (*buf)
 328             buf++;
 329         i++;
 330     }
 331     *form[i].name = '\0';
 332 }
 333
 334 char *wgetval(WCLIENT wc, char *name)
 335 {
 336     int i;
 337
 338     for (i = 0; *wc->wf_data[i].name; i++)
 339         if (!strcmp(name, wc->wf_data[i].name))
 340             return wc->wf_data[i].value;
 341     return 0;
 342 }
 343
 344 int wproto_process(WCLIENT wc, int timeout)
 345 {
 346     int toread, rs, level;
 347     char combuf[COMBUF], *p,*t;
 348     fd_set input;
 349     struct timeval to, *top;
 350
 351     for (;;)
 352     {
 353         gw_log (GW_LOG_DEBUG, mod, "process waiting for input.");
 354         if (timeout > 0)
 355         {
 356             to.tv_usec = 0;
 357             to.tv_sec = timeout;
 358             top = &to;
 359         }
 360         else
 361             top = 0;
 362         FD_ZERO(&input);
 363         FD_SET(wc->linein, &input);
 364         /* go through select handle list */
 365         while ((rs = select(wc->linein + 1, &input, 0, 0, top)) < 0 &&
 366             errno == EINTR)
 367             ;
 368         if (rs < 0)
 369         {
 370             gw_log (GW_LOG_FATAL|GW_LOG_ERRNO, mod, "select");
 371             return -1;
 372         }
 373         if (rs == 0)
 374         {
 375             gw_log (GW_LOG_STAT, mod,
 376                     "select %d second timeout.",
 377                     timeout);
 378             unlink (wc->wf_serverp);
 379             return 0;
 380         }
 381         if (read(wc->linein, &toread, sizeof(toread)) < sizeof(toread))
 382         {
 383             gw_log (GW_LOG_FATAL|GW_LOG_ERRNO, mod, "wp_proc:len read failed");
 384             exit(1);
 385         }
 386         toread -= sizeof(toread);
 387         if (read(wc->linein, combuf, toread) < toread)
 388         {
 389             gw_log (GW_LOG_FATAL|GW_LOG_ERRNO, mod, "wp_proc: data read failed");
 390             exit(1);
 391         }
 392         p = combuf;
 393         for (t = wc->wf_serverp; (*t = *p); t++, p++);
 394         p++;
 395         for (t = wc->wf_serverf; (*t = *p); t++, p++);
 396         p++;
 397         for (t = wc->wf_script; *p && *p != '/'; t++, p++)
 398             *t = *p;
 399         *t = '\0';
 400         if (*p)
 401             p++;
 402         decode_form (wc->wf_parms_var, p);
 403         for (t = wc->wf_parms; (*t = *p); t++, p++);
 404         p++;
 405         p++;         /* we don't deal with envvars yet */
 406         wc->raw_data = p;
 407         decode_form(wc->wf_data, p);
 408         if (wc->lineout < 0)
 409         {
 410             gw_log (GW_LOG_DEBUG, mod, "open %s", wc->wf_serverp);
 411             if ((wc->lineout = open(wc->wf_serverp, O_WRONLY)) < 0)
 412             {
 413                 gw_log (GW_LOG_FATAL|GW_LOG_ERRNO, mod, "open %s",
 414                         wc->wf_serverp);
 415                 exit(1);
 416             }
 417         }
 418         /* look in cache only if request carries no forms data. */
 419         if (!*wc->wf_data[0].name && (level = wproto_findcache(wc,
 420             wc->wf_parms)) >= 0)
 421         {
 422             gw_log (GW_LOG_DEBUG, mod, "wproto_dumpcache");
 423             wproto_dumpcache(wc, level);
 424             wo_finish(wc);
 425
 426         }
 427         else
 428         {
 429             return 1;
 430         }
 431     }
 432 }
 433
 434 WCLIENT wproto_init (const char *fifoDir, const char *prog)
 435 {
 436     char *val, path2[256];
 437     wclient_data *newp;
 438
 439     gw_log (GW_LOG_DEBUG, mod, "wproto_init");
 440     close(1);    /* release us from the wserver */
 441     if (!(newp = malloc(sizeof(*newp))))
 442     {
 443         gw_log (GW_LOG_FATAL|GW_LOG_ERRNO, mod, "malloc");
 444         exit (1);
 445     }
 446     if (!(val = getenv ("GWID")))
 447     {
 448         gw_log (GW_LOG_FATAL, mod, "GWID not set");
 449         exit (1);
 450     }
 451     if (!(newp->prog = malloc (strlen(prog)+1)))
 452     {
 453         gw_log (GW_LOG_FATAL|GW_LOG_ERRNO, mod, "malloc");
 454         exit (1);
 455     }
 456     strcpy (newp->prog, prog);
 457     newp->fifoDir = fifoDir;
 458     newp->id = atoi (val);
 459     sprintf(newp->path, "%s/clt%d", newp->fifoDir, newp->id);
 460     if (mkfifo(newp->path, 0666 | S_IFIFO) < 0)
 461         gw_log (GW_LOG_WARN|GW_LOG_ERRNO, mod, "mkfifo(%s)", newp->path);
 462     gw_log (GW_LOG_DEBUG, mod, "Synchronizing with server.");
 463     sprintf(path2, "%s/srv%d", newp->fifoDir, getppid());
 464     if ((newp->lineout = open(path2, O_WRONLY)) < 0)
 465     {
 466         gw_log (GW_LOG_FATAL|GW_LOG_ERRNO, mod, "open out %s", path2);
 467         exit(1);
 468     }
 469     if (write(newp->lineout, "OK", 2) < 2)
 470     {
 471         gw_log (GW_LOG_FATAL|GW_LOG_ERRNO, mod, "write");
 472         exit(1);
 473     }
 474     gw_log (GW_LOG_DEBUG, mod, "Synchronized.");
 475     if ((newp->linein = open(newp->path, O_RDONLY)) < 0)
 476     {
 477         gw_log (GW_LOG_FATAL|GW_LOG_ERRNO, mod, "open input %s", newp->path);
 478         exit(1);
 479     }
 480     gw_log (GW_LOG_DEBUG, mod, "init. linein=%d lineout=%d",
 481             newp->linein, newp->lineout);
 482     /* we put a handle on this so we get a blocking read when no peer */
 483     if (open(newp->path, O_WRONLY | O_NDELAY) < 0)
 484     {
 485         gw_log (GW_LOG_FATAL|GW_LOG_ERRNO, mod, "open dummy %s", newp->path);
 486         exit(1);
 487     }
 488     newp->outbuffer = 0;
 489     newp->outbuffer_size = 0;
 490     newp->outbuffer_offset = 0;
 491     newp->cache_level = -1;
 492     newp->cache_fd = -1;
 493     newp->save_level = 0;
 494     return newp;
 495 }
 496
 497 static void wproto_uncache(WCLIENT wc, int level)
 498 {
 499     for (;wc->cache_level >= level; wc->cache_level--)
 500         unlink(wc->cache[wc->cache_level].path);
 501 }
 502
 503 void wproto_terminate(WCLIENT wc)
 504 {
 505     free (wc->prog);
 506     close(wc->linein);
 507     unlink(wc->path);
 508     wproto_uncache(wc, 0);
 509     free(wc);
 510 }
 511
 512 int wproto_cache(WCLIENT wc, int level)
 513 {
 514     cache_data *p;
 515
 516     if (level > wc->cache_level + 1)
 517     {
 518         gw_log (GW_LOG_FATAL, mod, "Illegal cache level increment.");
 519         exit(1);
 520     }
 521     wproto_uncache(wc, level);
 522     p = &wc->cache[++wc->cache_level];
 523     sprintf(p->path, "%s/csh%d.%d", wc->fifoDir, wc->id, level);
 524     if ((wc->cache_fd = open(p->path, O_WRONLY|O_CREAT|O_TRUNC, 0600)) < 0)
 525     {
 526         gw_log (GW_LOG_FATAL|GW_LOG_ERRNO, mod, "open %s", p->path);
 527         return -1;
 528     }
 529     strcpy(p->name, wc->wf_parms);
 530     return 0;
 531 }
 532
 533 static int wproto_findcache(WCLIENT wc, char *name)
 534 {
 535     int i;
 536
 537     for (i = 0; i <= wc->cache_level; i++)
 538         if (!strcmp(wc->cache[i].name, name))
 539             return i;
 540     return -1;
 541 }
 542
 543 int wproto_save_push (WCLIENT wc)
 544 {
 545     wc->save_level++;
 546     return wc->outbuffer_offset;
 547 }
 548
 549 char *wproto_save_pop (WCLIENT wc, int offset)
 550 {
 551     char *cp;
 552     if (!wc->save_level)
 553         return NULL;
 554     --(wc->save_level);
 555     assert (offset <= wc->outbuffer_offset);
 556     cp = wc->outbuffer + offset;
 557     wc->outbuffer[wc->outbuffer_offset] = '\0';
 558     wc->outbuffer_offset = offset;
 559     return cp;
 560 }
 561
 562 static int wproto_dumpcache(WCLIENT wc, int level)
 563 {
 564     int fd, rd;
 565
 566     gw_log (GW_LOG_STAT, mod, "Using Cache: %s", wc->cache[level].name);
 567     if ((fd = open(wc->cache[level].path, O_RDONLY)) < 0)
 568     {
 569         gw_log (GW_LOG_FATAL, mod, "open (R) %s", wc->cache[level].path);
 570         return -1;
 571     }
 572     while ((rd = read(fd, wc->outbuffer, OUTBUFFER_CHUNK)) > 0)
 573         if (write(wc->lineout, wc->outbuffer, rd) < rd)
 574         {
 575             gw_log (GW_LOG_FATAL|GW_LOG_ERRNO, mod, "write toline");
 576             return -1;
 577         }
 578     if (rd < 0)
 579     {
 580         gw_log (GW_LOG_FATAL|GW_LOG_ERRNO, mod, "read");
 581         return -1;
 582     }
 583     wproto_uncache(wc, level + 1);
 584     return 0;
 585 }