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