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