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