2 * Copyright (c) 1995, the EUROPAGATE consortium (see below).
4 * The EUROPAGATE consortium members are:
6 * University College Dublin
7 * Danmarks Teknologiske Videnscenter
8 * An Chomhairle Leabharlanna
9 * Consejo Superior de Investigaciones Cientificas
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,
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.
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.
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.
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.
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.
44 * Revision 1.16 1997/12/15 15:05:03 adam
45 * Enhanced the code that deals with FORM variables.
47 * Revision 1.15 1997/02/10 10:15:40 adam
48 * Bug fix: egw_source <file> <var> didn't work properly.
50 * Revision 1.14 1997/01/31 11:16:01 adam
51 * Enhanced the egw_source command. An optional parameter specifies the
52 * name of a variable in which the HTML output is stored.
54 * Revision 1.13 1997/01/27 11:27:15 adam
55 * Implemented a new command, egw_clear, to clear http output cache.
56 * Changed prototype for function wo_clear.
58 * Revision 1.12 1997/01/24 13:13:12 adam
59 * Implemnted egw_source and added a "raw" option to the URL.
60 * Fixed a bug in the buffering system of wproto; the macro wo_putc could
61 * override memory if it was the first HTML generating function called.
63 * Revision 1.11 1996/05/23 15:53:11 adam
64 * Bug fix: egw_enc failed on 8-bit chars.
65 * New command: egw_parms.
67 * Revision 1.10 1996/05/21 14:53:04 adam
68 * Tcl command wform extented; options -raw and -exists added.
70 * Revision 1.9 1996/03/14 11:48:39 adam
71 * New function egw_prog that returns name of shell.
73 * Revision 1.8 1996/02/12 10:09:25 adam
74 * New parameter to wproto_init: directory root for the FIFOs (instead
75 * of using preprocessor defines FIFODIR/FIFOROOT).
77 * Revision 1.7 1996/01/24 08:26:55 adam
78 * All tcl commands prefixed with egw_ (except the html command).
80 * Revision 1.6 1996/01/12 13:08:07 adam
81 * CGI script passes name of lock file to the shell. The server will not close
82 * the response FIFO until this file becomes unlocked. This method handles
83 * cancel operations much better.
85 * Revision 1.5 1996/01/12 10:05:21 adam
86 * If script name ends with ';' HTTP/GET/Expires will be defined.
87 * The cgi interface only reads final handshake if response from
88 * server (shell) was zero-terminated [If it isn't it probably died].
90 * Revision 1.4 1995/11/06 10:51:18 adam
91 * End of response marker in response from wsh/wproto to wcgi.
92 * Shells are respawned when necessary.
94 * Revision 1.3 1995/10/27 15:12:11 adam
95 * IrTcl incorporated in the gateway.
96 * Better separation of script types.
97 * Z39.50 gateway scripts entered.
99 * Revision 1.2 1995/10/23 16:55:41 adam
100 * A lot of changes - really.
102 * Revision 1.1 1995/10/20 11:49:27 adam
103 * First version of www gateway.
114 #define OUTBUFFER_CHUNK 4096
116 typedef struct wform_data
120 struct wform_data *next;
123 typedef struct cache_data
129 struct w_select_handle {
132 void (*sproc)(int, void *);
135 struct w_select_handle *next;
138 typedef struct wclient_data
144 wform_data *wf_parms_var;
146 char wf_serverp[1024];
147 char wf_serverf[1024];
148 char wf_script[1024];
154 int outbuffer_offset;
156 cache_data cache[20];
158 struct w_select_handle *select_list;
161 } *WCLIENT, wclient_data;
163 #define wo_putc(wc, ch) \
164 ((wc)->outbuffer_offset>=(wc)->outbuffer_size ? wo_overflow((wc), (ch)): \
165 (*((wc)->outbuffer + (wc)->outbuffer_offset++) = (char) (ch)), 0)
167 char *wgetval (WCLIENT wc, char *name);
169 /* wproto_process: wait for one request from egwcgi. returns <=0 on
170 timeout; returns >0 otherwise. */
171 int wproto_process (WCLIENT wc, int timeout);
173 /* wproto_init: initializes communication with egwcgi. */
174 WCLIENT wproto_init (const char *fifoDir, const char *prog);
176 void wo_printf (WCLIENT wc, const char *fmt, ...);
177 void wo_clear (WCLIENT wc);
178 int wo_finish (WCLIENT wc);
179 int wo_flush (WCLIENT wc);
180 int wo_overflow (WCLIENT wc, char ch);
181 void wproto_terminate (WCLIENT wc);
182 int wproto_cache (WCLIENT wc, int level);
183 void wo_puts (WCLIENT wc, const char *s);
184 void wo_write (WCLIENT wc, const char *s, size_t len);
186 int wproto_save_push (WCLIENT wc);
187 char *wproto_save_pop (WCLIENT wc, int offset);