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.4  1995/11/06 10:51:18  adam
  45  * End of response marker in response from wsh/wproto to wcgi.
  46  * Shells are respawned when necessary.
  47  *
  48  * Revision 1.3  1995/10/27  15:12:11  adam
  49  * IrTcl incorporated in the gateway.
  50  * Better separation of script types.
  51  * Z39.50 gateway scripts entered.
  52  *
  53  * Revision 1.2  1995/10/23  16:55:41  adam
  54  * A lot of changes - really.
  55  *
  56  * Revision 1.1  1995/10/20  11:49:27  adam
  57  * First version of www gateway.
  58  *
  59  */
  60
  61 #ifndef WPROTO_H
  62 #define WPROTO_H
  63
  64 #include <gw-log.h>
  65 #include <gw-res.h>
  66
  67 #define COMBUF 4096
  68 #define OUTBUFFER_CHUNK 4096
  69
  70 #define FIFOROOT "/tmp"
  71 #define FIFODIR "egw"
  72
  73 typedef struct wform_data
  74 {
  75     char name[20];
  76     char value[512];
  77 } wform_data;
  78
  79 typedef struct cache_data
  80 {
  81     char name[256];
  82     char path[256];
  83 } cache_data;
  84
  85 struct w_select_handle {
  86     int  fd;
  87     struct {
  88         void (*sproc)(int, void *);
  89         void *obj;
  90     } rwx[3];
  91     struct w_select_handle *next;
  92 };
  93
  94 typedef struct wclient_data
  95 {
  96     int id;
  97     wform_data wf_data[100];
  98     char wf_parms[512];
  99     char wf_serverp[512];
 100     char path[512];
 101     int linein;
 102     int lineout;
 103     char *outbuffer;
 104     int outbuffer_size;
 105     int outbuffer_offset;
 106     int cache_level;
 107     cache_data cache[20];
 108     int cache_fd;
 109     struct w_select_handle *select_list;
 110 } *WCLIENT, wclient_data;
 111
 112 #define wo_putc(wc, ch)   \
 113     ((wc)->outbuffer_offset >= OUTBUFFER_CHUNK ? wo_overflow((wc), (ch)) :  \
 114     (*((wc)->outbuffer + (wc)->outbuffer_offset++) = (char) (ch)), 0)
 115
 116 char *wgetval(WCLIENT wc, char *name);
 117 int wproto_process(WCLIENT wc, int timeout);
 118 WCLIENT wproto_init(void);
 119 void wo_printf(WCLIENT wc, const char *fmt, ...);
 120 void wo_clear(WCLIENT wc, char *type);
 121 int wo_finish(WCLIENT wc);
 122 int wo_flush(WCLIENT wc);
 123 int wo_overflow(WCLIENT wc, char ch);
 124 void wproto_terminate(WCLIENT wc);
 125 int wproto_cache(WCLIENT wc, int level);
 126 int wo_puthtml(WCLIENT wc, char *name);
 127 void wo_puts(WCLIENT wc, const char *s);
 128
 129 #endif