Implemented a new command, egw_clear, to clear http output cache.
[egate.git] / www / wproto.c
index 6bc7cb0..eedbe74 100644 (file)
  * USE OR PERFORMANCE OF THIS SOFTWARE.
  *
  * $Log: wproto.c,v $
- * Revision 1.1  1995/10/20 11:49:26  adam
+ * Revision 1.23  1997/01/27 11:27:14  adam
+ * Implemented a new command, egw_clear, to clear http output cache.
+ * Changed prototype for function wo_clear.
+ *
+ * Revision 1.22  1997/01/24 13:13:11  adam
+ * Implemnted egw_source and added a "raw" option to the URL.
+ * Fixed a bug in the buffering system of wproto; the macro wo_putc could
+ * override memory if it was the first HTML generating function called.
+ *
+ * Revision 1.21  1996/05/23 15:53:11  adam
+ * Bug fix: egw_enc failed on 8-bit chars.
+ * New command: egw_parms.
+ *
+ * Revision 1.20  1996/05/21  14:53:04  adam
+ * Tcl command wform extented; options -raw and -exists added.
+ *
+ * Revision 1.19  1996/03/14  11:48:39  adam
+ * New function egw_prog that returns name of shell.
+ *
+ * Revision 1.18  1996/02/12  10:09:23  adam
+ * New parameter to wproto_init: directory root for the FIFOs (instead
+ * of using preprocessor defines FIFODIR/FIFOROOT).
+ *
+ * Revision 1.17  1996/01/26  09:02:22  adam
+ * Open of client FIFO called with O_NDELAY when reconnecting to shell
+ * in order to prevent serious lock if previous shell died without
+ * unlinking client FIFO.
+ *
+ * Revision 1.16  1996/01/24  10:13:56  adam
+ * Bug fix: in function wo_write realloc is used only when memory is already
+ * allocated with malloc.
+ *
+ * Revision 1.15  1996/01/24  08:25:32  adam
+ * Buf fix: Uninitialized outbuffer_offset member.
+ *
+ * Revision 1.14  1996/01/12  13:08:07  adam
+ * CGI script passes name of lock file to the shell. The server will not close
+ * the response FIFO until this file becomes unlocked. This method handles
+ * cancel operations much better.
+ *
+ * Revision 1.13  1996/01/12  10:05:20  adam
+ * If script name ends with ';' HTTP/GET/Expires will be defined.
+ * The cgi interface only reads final handshake if response from
+ * server (shell) was zero-terminated [If it isn't it probably died].
+ *
+ * Revision 1.12  1996/01/05  16:35:02  adam
+ * Minor changes.
+ *
+ * Revision 1.11  1996/01/05  16:21:21  adam
+ * Bug fix: shell (wproto) sometimes closed server FIFO before cgi
+ * program opened it - solution: cgi sends OK when response has been read.
+ *
+ * Revision 1.10  1995/12/22  14:21:16  adam
+ * More work on scan. The search.egw script takes care of cached
+ * query page (doesn't always increment nextSetNo). To make new search set
+ * either 'New query' must be selected or the query page must be reloaded.
+ * The msearch script doesn't do this yet, however.
+ *
+ * Revision 1.9  1995/11/14  16:31:36  adam
+ * Temporary remove of ccl entry.
+ *
+ * Revision 1.8  1995/11/13  15:41:45  adam
+ * Arrow gifs.
+ * Gateway uses record element set names B(rief) and F(ull).
+ * Bug fix. Didn't save idAuthentication correctly.
+ *
+ * Revision 1.7  1995/11/10  14:47:32  adam
+ * Plus (+) characters automatically converted to space in forms.
+ * Work on search in multiple targets. Doesn't work well - yet.
+ * Presentation formats enhanced.
+ *
+ * Revision 1.6  1995/11/06  10:51:17  adam
+ * End of response marker in response from wsh/wproto to wcgi.
+ * Shells are respawned when necessary.
+ *
+ * Revision 1.5  1995/11/02  16:35:37  adam
+ * Bug fixes and select on FIFOs in wcgi - doesn't really work!
+ *
+ * Revision 1.4  1995/10/31  16:56:25  adam
+ * Record presentation.
+ *
+ * Revision 1.3  1995/10/27  15:12:10  adam
+ * IrTcl incorporated in the gateway.
+ * Better separation of script types.
+ * Z39.50 gateway scripts entered.
+ *
+ * Revision 1.2  1995/10/23  16:55:39  adam
+ * A lot of changes - really.
+ *
+ * Revision 1.1  1995/10/20  11:49:26  adam
  * First version of www gateway.
  *
  */
 
 #include <stdio.h>
+#include <string.h>
 #include <stdlib.h>
 #include <sys/time.h>
 #include <sys/types.h>
 #include <stdarg.h>
 #include <ctype.h>
 #include <errno.h>
+#include <assert.h>
 
 #include "wproto.h"
 
@@ -65,18 +156,24 @@ static void wproto_uncache(WCLIENT wc, int level);
 
 static char *mod = "wproto";
 
-void wo_puts(WCLIENT wc, char *s)
+void wo_write (WCLIENT wc, const char *s, size_t len)
 {
-    int len;
-
-    if (wc->outbuffer_offset + (len = strlen(s)) + 1 > wc->outbuffer_size)
-       wc->outbuffer = realloc(wc->outbuffer, wc->outbuffer_size +=
-       OUTBUFFER_CHUNK);
-    memcpy(wc->outbuffer + wc->outbuffer_offset, s, len + 1);
+    if (wc->outbuffer_offset + len >= wc->outbuffer_size)
+    {
+        assert (wc->outbuffer);
+        wc->outbuffer = realloc(wc->outbuffer, wc->outbuffer_size +=
+               ((len >= OUTBUFFER_CHUNK) ? len*2 : OUTBUFFER_CHUNK));
+    }
+    memcpy(wc->outbuffer + wc->outbuffer_offset, s, len);
     wc->outbuffer_offset += len;
 }
 
-void wo_printf(WCLIENT wc, const char *fmt, ...)
+void wo_puts (WCLIENT wc, const char *s)
+{
+    wo_write (wc, s, strlen(s));
+}
+
+void wo_printf (WCLIENT wc, const char *fmt, ...)
 {
     va_list ap;
     char tmpbuf[4048];
@@ -87,35 +184,11 @@ void wo_printf(WCLIENT wc, const char *fmt, ...)
     va_end(ap);
 }
 
-void wo_clear(WCLIENT wc, char *type)
+void wo_clear (WCLIENT wc)
 {
     if (!wc->outbuffer)
-       wc->outbuffer = malloc(wc->outbuffer_size = OUTBUFFER_CHUNK);
+        wc->outbuffer = malloc (wc->outbuffer_size = OUTBUFFER_CHUNK);
     wc->outbuffer_offset = 0;
-    wo_printf(wc, "Content-type: %s\n\n", type);
-}
-
-int wo_puthtml(WCLIENT wc, char *name)
-{
-    FILE *f; 
-    char ch;
-
-    wo_clear(wc, "text/html");
-    if (!(f = fopen(name, "r")))
-    {
-       wo_printf(wc, "<BR>Failed to open file: %s<BR>", name);
-       return 0;
-    }
-    while (ch = getc(f), !feof(f))
-    {
-       if (wo_putc(wc, ch) < 0)
-       {
-           fclose(f);
-           return -1;
-       }
-    }
-    fclose(f);
-    return 0;
 }
 
 int wo_flush(WCLIENT wc)
@@ -128,13 +201,17 @@ int wo_flush(WCLIENT wc)
     wc->outbuffer_offset = 0;
     for (;;)
     {
+        int w_chunk;
+
+        w_chunk = towrite;
        wrote = write(wc->lineout, wc->outbuffer + wc->outbuffer_offset,
-           towrite);
+           w_chunk);
        if (wrote <= 0)
        {
            gw_log (GW_LOG_FATAL|GW_LOG_ERRNO, mod, "write response");
            return -1;
        }
+        gw_log (GW_LOG_DEBUG, mod, "wrote %d bytes", wrote);
        if (wc->cache_fd >= 0)
            if (write(wc->cache_fd, wc->outbuffer + wc->outbuffer_offset,
                towrite) < 0)
@@ -161,9 +238,24 @@ int wo_overflow(WCLIENT wc, char ch)
 
 int wo_finish(WCLIENT wc)
 {
+    int fd;
     gw_log (GW_LOG_DEBUG, mod, "wo_finish");
+
+    wo_putc (wc, 0);
     if (wo_flush(wc) < 0)
        return -1;
+
+    fd = open (wc->wf_serverf, O_RDONLY);
+    if (fd != -1)
+    {
+        struct flock area;
+        area.l_type = F_RDLCK;
+        area.l_whence = SEEK_SET;
+        area.l_start = 0L;
+        area.l_len = 0L;
+        fcntl (fd, F_SETLKW, &area);
+        close (fd);
+    }
     close(wc->lineout);
     wc->lineout = -1;
     if (wc->cache_fd >= 0)
@@ -184,10 +276,21 @@ static void descramble(char *t, const char *o)
        {
            sscanf(o + 1, "%2x", &v);
            o += 3;
-           *(t++) = (char) v;
+            if (v == '+')
+                *t = ' ';
+            else
+                *t = (char) v;
+            t++;
        }
        else
-           *(t++) = *(o++);
+        {
+            if (*o == '+')
+                *t = ' ';
+            else
+                *t = *o;
+            t++;
+            o++;
+        }
     }
     *t = '\0';
 }
@@ -246,6 +349,7 @@ int wproto_process(WCLIENT wc, int timeout)
            top = 0;
        FD_ZERO(&input);
        FD_SET(wc->linein, &input);
+        /* go through select handle list */
        while ((rs = select(wc->linein + 1, &input, 0, 0, top)) < 0 &&
            errno == EINTR)
            ;
@@ -257,8 +361,9 @@ int wproto_process(WCLIENT wc, int timeout)
        if (rs == 0)
        {
            gw_log (GW_LOG_STAT, mod, 
-                    "wproto_process returning 0 after %d second timeout.",
+                    "select %d second timeout.",
                    timeout);
+            unlink (wc->wf_serverp);
            return 0;
        }
        if (read(wc->linein, &toread, sizeof(toread)) < sizeof(toread))
@@ -275,70 +380,105 @@ int wproto_process(WCLIENT wc, int timeout)
        p = combuf;
        for (t = wc->wf_serverp; (*t = *p); t++, p++);
        p++;
+       for (t = wc->wf_serverf; (*t = *p); t++, p++);
+       p++;
+        for (t = wc->wf_script; *p && *p != '/'; t++, p++)
+            *t = *p;
+        *t = '\0';
+        if (*p)
+            p++;
+        decode_form (wc->wf_parms_var, p);
        for (t = wc->wf_parms; (*t = *p); t++, p++);
        p++;
        p++;         /* we don't deal with envvars yet */
+        wc->raw_data = p;
        decode_form(wc->wf_data, p);
-       if (wc->lineout < 0 && (wc->lineout = open(wc->wf_serverp, O_WRONLY))
-           < 0)
-       {
-           gw_log (GW_LOG_FATAL|GW_LOG_ERRNO, mod, "open %s", wc->wf_serverp);
-           exit(1);
-       }
+       if (wc->lineout < 0)
+        {
+            gw_log (GW_LOG_DEBUG, mod, "open %s", wc->wf_serverp);
+            if ((wc->lineout = open(wc->wf_serverp, O_WRONLY)) < 0)
+           {
+               gw_log (GW_LOG_FATAL|GW_LOG_ERRNO, mod, "open %s", 
+                        wc->wf_serverp);
+               exit(1);
+           }
+        }
        /* look in cache only if request carries no forms data. */
        if (!*wc->wf_data[0].name && (level = wproto_findcache(wc,
            wc->wf_parms)) >= 0)
        {
+           gw_log (GW_LOG_DEBUG, mod, "wproto_dumpcache");
            wproto_dumpcache(wc, level);
            wo_finish(wc);
+            
        }
        else
+        {
            return 1;
+        }
     }
 }
 
-WCLIENT wproto_init(void)
+WCLIENT wproto_init (const char *fifoDir, const char *prog)
 {
-    char path2[256];
-    wclient_data *new;
+    char *val, path2[256];
+    wclient_data *newp;
 
     gw_log (GW_LOG_DEBUG, mod, "wproto_init");
     close(1);    /* release us from the wserver */
-    new = malloc(sizeof(*new));
-    sprintf(new->path, "%s/%s/clt%d", FIFOROOT, FIFODIR, getpid());
-    if (mkfifo(new->path, 0666 | S_IFIFO) < 0)
+    if (!(newp = malloc(sizeof(*newp))))
     {
-       gw_log (GW_LOG_FATAL|GW_LOG_ERRNO, mod, "mkfifo(%s)", new->path);
-       exit(1);
+        gw_log (GW_LOG_FATAL|GW_LOG_ERRNO, mod, "malloc");
+        exit (1);
+    }
+    if (!(val = getenv ("GWID")))
+    {
+        gw_log (GW_LOG_FATAL, mod, "GWID not set");
+        exit (1);
+    }
+    if (!(newp->prog = malloc (strlen(prog)+1)))
+    {
+        gw_log (GW_LOG_FATAL|GW_LOG_ERRNO, mod, "malloc");
+        exit (1);
     }
+    strcpy (newp->prog, prog);
+    newp->fifoDir = fifoDir;
+    newp->id = atoi (val);
+    sprintf(newp->path, "%s/clt%d", newp->fifoDir, newp->id);
+    if (mkfifo(newp->path, 0666 | S_IFIFO) < 0)
+       gw_log (GW_LOG_WARN|GW_LOG_ERRNO, mod, "mkfifo(%s)", newp->path);
     gw_log (GW_LOG_DEBUG, mod, "Synchronizing with server.");
-    sprintf(path2, "%s/%s/srv%d", FIFOROOT, FIFODIR, getppid());
-    if ((new->lineout = open(path2, O_WRONLY)) < 0)
+    sprintf(path2, "%s/srv%d", newp->fifoDir, getppid());
+    if ((newp->lineout = open(path2, O_WRONLY)) < 0)
     {
-       gw_log (GW_LOG_FATAL|GW_LOG_ERRNO, mod, "open %s", path2);
+       gw_log (GW_LOG_FATAL|GW_LOG_ERRNO, mod, "open out %s", path2);
        exit(1);
     }
-    if (write(new->lineout, "OK", 2) < 2)
+    if (write(newp->lineout, "OK", 2) < 2)
     {
        gw_log (GW_LOG_FATAL|GW_LOG_ERRNO, mod, "write");
        exit(1);
     }
     gw_log (GW_LOG_DEBUG, mod, "Synchronized.");
-    if ((new->linein = open(new->path, O_RDONLY)) < 0)
+    if ((newp->linein = open(newp->path, O_RDONLY)) < 0)
     {
-       gw_log (GW_LOG_FATAL|GW_LOG_ERRNO, mod, "open input handle %s", new->path);
+       gw_log (GW_LOG_FATAL|GW_LOG_ERRNO, mod, "open input %s", newp->path);
        exit(1);
     }
+    gw_log (GW_LOG_DEBUG, mod, "init. linein=%d lineout=%d",
+            newp->linein, newp->lineout);
     /* we put a handle on this so we get a blocking read when no peer */
-    if (open(new->path, O_WRONLY | O_NDELAY) < 0)
+    if (open(newp->path, O_WRONLY | O_NDELAY) < 0)
     {
-       gw_log (GW_LOG_FATAL|GW_LOG_ERRNO, mod, "open dummy %s", new->path);
+       gw_log (GW_LOG_FATAL|GW_LOG_ERRNO, mod, "open dummy %s", newp->path);
        exit(1);
     }
-    new->outbuffer = 0;
-    new->cache_level = -1;
-    new->cache_fd = -1;
-    return new;
+    newp->outbuffer = 0;
+    newp->outbuffer_size = 0;
+    newp->outbuffer_offset = 0;
+    newp->cache_level = -1;
+    newp->cache_fd = -1;
+    return newp;
 }
 
 static void wproto_uncache(WCLIENT wc, int level)
@@ -349,6 +489,7 @@ static void wproto_uncache(WCLIENT wc, int level)
 
 void wproto_terminate(WCLIENT wc)
 {
+    free (wc->prog);
     close(wc->linein);
     unlink(wc->path);
     wproto_uncache(wc, 0);
@@ -366,7 +507,7 @@ int wproto_cache(WCLIENT wc, int level)
     }
     wproto_uncache(wc, level);
     p = &wc->cache[++wc->cache_level];
-    sprintf(p->path, "%s/%s/csh%d.%d", FIFOROOT, FIFODIR, getpid(), level);
+    sprintf(p->path, "%s/csh%d.%d", wc->fifoDir, wc->id, level);
     if ((wc->cache_fd = open(p->path, O_WRONLY|O_CREAT|O_TRUNC, 0600)) < 0)
     {
        gw_log (GW_LOG_FATAL|GW_LOG_ERRNO, mod, "open %s", p->path);