www/wproto.h

   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.h,v $
  44  * Revision 1.9  1996/03/14 11:48:39  adam
  45  * New function egw_prog that returns name of shell.
  46  *
  47  * Revision 1.8  1996/02/12  10:09:25  adam
  48  * New parameter to wproto_init: directory root for the FIFOs (instead
  49  * of using preprocessor defines FIFODIR/FIFOROOT).
  50  *
  51  * Revision 1.7  1996/01/24  08:26:55  adam
  52  * All tcl commands prefixed with egw_ (except the html command).
  53  *
  54  * Revision 1.6  1996/01/12  13:08:07  adam
  55  * CGI script passes name of lock file to the shell. The server will not close
  56  * the response FIFO until this file becomes unlocked. This method handles
  57  * cancel operations much better.
  58  *
  59  * Revision 1.5  1996/01/12  10:05:21  adam
  60  * If script name ends with ';' HTTP/GET/Expires will be defined.
  61  * The cgi interface only reads final handshake if response from
  62  * server (shell) was zero-terminated [If it isn't it probably died].
  63  *
  64  * Revision 1.4  1995/11/06  10:51:18  adam
  65  * End of response marker in response from wsh/wproto to wcgi.
  66  * Shells are respawned when necessary.
  67  *
  68  * Revision 1.3  1995/10/27  15:12:11  adam
  69  * IrTcl incorporated in the gateway.
  70  * Better separation of script types.
  71  * Z39.50 gateway scripts entered.
  72  *
  73  * Revision 1.2  1995/10/23  16:55:41  adam
  74  * A lot of changes - really.
  75  *
  76  * Revision 1.1  1995/10/20  11:49:27  adam
  77  * First version of www gateway.
  78  *
  79  */
  80
  81 #ifndef WPROTO_H
  82 #define WPROTO_H
  83
  84 #include <gw-log.h>
  85 #include <gw-res.h>
  86
  87 #define COMBUF 4096
  88 #define OUTBUFFER_CHUNK 4096
  89
  90 typedef struct wform_data
  91 {
  92     char name[20];
  93     char value[512];
  94 } wform_data;
  95
  96 typedef struct cache_data
  97 {
  98     char name[256];
  99     char path[256];
 100 } cache_data;
 101
 102 struct w_select_handle {
 103     int  fd;
 104     struct {
 105         void (*sproc)(int, void *);
 106         void *obj;
 107     } rwx[3];
 108     struct w_select_handle *next;
 109 };
 110
 111 typedef struct wclient_data
 112 {
 113     int id;
 114     char *prog;
 115     wform_data wf_data[100];
 116     char wf_parms[512];
 117     char wf_serverp[512];
 118     char wf_serverf[512];
 119     char path[512];
 120     int linein;
 121     int lineout;
 122     char *outbuffer;
 123     int outbuffer_size;
 124     int outbuffer_offset;
 125     int cache_level;
 126     cache_data cache[20];
 127     int cache_fd;
 128     struct w_select_handle *select_list;
 129     const char *fifoDir;
 130 } *WCLIENT, wclient_data;
 131
 132 #define wo_putc(wc, ch)   \
 133     ((wc)->outbuffer_offset >= OUTBUFFER_CHUNK ? wo_overflow((wc), (ch)) :  \
 134     (*((wc)->outbuffer + (wc)->outbuffer_offset++) = (char) (ch)), 0)
 135
 136 char *wgetval (WCLIENT wc, char *name);
 137 int wproto_process (WCLIENT wc, int timeout);
 138 WCLIENT wproto_init (const char *fifoDir, const char *prog);
 139 void wo_printf (WCLIENT wc, const char *fmt, ...);
 140 void wo_clear (WCLIENT wc, const char *type);
 141 int wo_finish (WCLIENT wc);
 142 int wo_flush (WCLIENT wc);
 143 int wo_overflow (WCLIENT wc, char ch);
 144 void wproto_terminate (WCLIENT wc);
 145 int wproto_cache (WCLIENT wc, int level);
 146 int wo_puthtml (WCLIENT wc, char *name);
 147 void wo_puts (WCLIENT wc, const char *s);
 148 void wo_write (WCLIENT wc, const char *s, size_t len);
 149
 150 #endif