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