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