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