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.17 1996/03/15 14:43:26 adam
45 * Function egw_wait returns 'cancel' if new request is pending (user
46 * has cancelled); or egw_wait returns 'timeout' on timeout.
48 * Revision 1.16 1996/02/29 15:40:23 adam
49 * New function w_interp_irtcl_get that returns Tcl interpreter of
52 * Revision 1.15 1996/02/21 14:58:01 adam
53 * Modified to use ir_tcl_select_set.
55 * Revision 1.14 1996/02/12 10:10:31 adam
56 * Resource/config system used by the gateway.
58 * Revision 1.13 1996/01/24 08:26:54 adam
59 * All tcl commands prefixed with egw_ (except the html command).
61 * Revision 1.12 1996/01/12 10:05:18 adam
62 * If script name ends with ';' HTTP/GET/Expires will be defined.
63 * The cgi interface only reads final handshake if response from
64 * server (shell) was zero-terminated [If it isn't it probably died].
66 * Revision 1.11 1996/01/09 16:16:49 adam
67 * Port to OSF/1. Gif references moved from /gif/ to /egwgif/.
69 * Revision 1.10 1996/01/09 10:46:50 adam
70 * New defines: LOGDIR/EGWDIR/CGIDIR set in Makefile.
72 * Revision 1.9 1995/11/07 14:56:59 adam
73 * Work on search in multiple targets.
74 * New wtcl command: wlog.
75 * Optional timeout parameter to zwait.
77 * Revision 1.8 1995/11/06 17:44:22 adam
78 * State reestablised when shell restarts. History of previous
81 * Revision 1.7 1995/11/02 16:35:37 adam
82 * Bug fixes and select on FIFOs in wcgi - doesn't really work!
84 * Revision 1.6 1995/11/01 16:15:47 adam
85 * Better presentation of records. Query/set number persistent.
87 * Revision 1.5 1995/10/31 16:56:24 adam
88 * Record presentation.
90 * Revision 1.4 1995/10/31 10:03:53 adam
92 * New command implemented - aborts script.
94 * Revision 1.3 1995/10/30 17:35:18 adam
95 * New function zwait that waits for a variable change - due to i/o events
96 * that invoke callback routines.
98 * Revision 1.2 1995/10/27 17:30:16 adam
99 * First search request/response that works.
101 * Revision 1.1 1995/10/27 15:12:08 adam
102 * IrTcl incorporated in the gateway.
103 * Better separation of script types.
104 * Z39.50 gateway scripts entered.
111 #include <sys/time.h>
112 #include <sys/types.h>
114 #include <sys/select.h>
124 static void *do_create (WCLIENT wcl, void *args);
125 static int do_exec (const char *fname, char *parms, void *mydata);
126 static int do_load (char *parms, void *mydata);
127 static int do_save (char *parms, void *mydata);
129 static struct w_interp_type w_interp_t = {
137 W_Interp_Type w_interp_irtcl = &w_interp_t;
140 static char *mod = "wirtcl";
148 static int events (struct tcl_info *p, char *waitVar, int tout);
150 static int proc_zwait_invoke (ClientData clientData, Tcl_Interp *interp,
151 int argc, char **argv)
153 struct tcl_info *p = (struct tcl_info*) clientData;
157 return events (p, argv[1], (argc == 3) ? atoi(argv[2]) : 0);
160 /* select callbacks */
162 void (*handle)(ClientData, int, int, int);
166 #define MAX_CALLBACK 200
168 static struct callback callback_table[MAX_CALLBACK];
169 static int max_fd = 3; /* don't worry: it will grow... */
171 static void *do_create (WCLIENT wcl, void *args)
176 if (!(p = malloc (sizeof(*p))))
178 gw_log (GW_LOG_FATAL|GW_LOG_ERRNO, mod, "malloc: irtcl_info");
181 if (!(p->w_interp = w_interp_create (w_interp_tcl, wcl, NULL)))
183 gw_log (GW_LOG_FATAL, mod, "Cannot make Tcl_Interp");
187 p->interp = w_interp_tcl_get (p->w_interp);
188 if (Irtcl_Init(p->interp) == TCL_ERROR)
190 gw_log (GW_LOG_FATAL, mod, "Cannot make Irtcl_Interp");
193 log_init(LOG_ALL, "irtcl", "irtcl_log");
194 /* initialize irtcl */
195 Tcl_CreateCommand (p->interp, "egw_wait", proc_zwait_invoke, p, NULL);
196 for (i=0; i<MAX_CALLBACK; i++)
197 callback_table[i].handle = NULL;
202 static int do_exec (const char *fname, char *parms, void *mydata)
204 struct tcl_info *p = mydata;
206 if ((r = w_interp_exec (p->w_interp, fname, parms)))
212 static int events (struct tcl_info *p, char *waitVar, int tout)
217 static fd_set fdset_tcl_r;
218 static fd_set fdset_tcl_w;
219 static fd_set fdset_tcl_x;
220 int fifo_in = p->wcl->linein;
221 if (fifo_in > max_fd)
225 if ((cp = Tcl_GetVar (p->interp, waitVar, 0)))
227 waitVarVal = malloc (strlen(cp)+1);
228 strcpy (waitVarVal, cp);
234 sprintf (msg, "Variable %s doesn't exist", waitVar);
235 gw_log (GW_LOG_WARN, mod, "%s", msg);
236 Tcl_AppendResult (p->interp, msg, NULL);
239 gw_log (GW_LOG_DEBUG, mod, "Waiting %s=%s", waitVar, waitVarVal);
242 struct timeval to, *top;
252 if (!(cp = Tcl_GetVar (p->interp, waitVar, 0)) ||
253 strcmp (cp, waitVarVal))
255 gw_log (GW_LOG_DEBUG, mod, "Changed to %s", cp);
256 Tcl_AppendResult (p->interp, cp, NULL);
260 FD_ZERO (&fdset_tcl_r);
261 FD_ZERO (&fdset_tcl_w);
262 FD_ZERO (&fdset_tcl_x);
264 for (r=0, i=0; i<=max_fd; i++)
266 if (callback_table[i].handle && callback_table[i].w)
268 FD_SET (i, &fdset_tcl_w);
271 if (callback_table[i].handle && callback_table[i].r)
273 FD_SET (i, &fdset_tcl_r);
276 if (callback_table[i].handle && callback_table[i].e)
278 FD_SET (i, &fdset_tcl_x);
285 gw_log (GW_LOG_DEBUG, mod, "fifo select %d", fifo_in);
286 FD_SET (fifo_in, &fdset_tcl_r);
288 if ((r = select(max_fd+1, &fdset_tcl_r, &fdset_tcl_w,
289 &fdset_tcl_x, top)) < 0)
291 gw_log (GW_LOG_ERRNO|GW_LOG_FATAL, mod, "select");
296 gw_log (GW_LOG_DEBUG, mod, "timeout");
297 p->interp->result = "timeout";
301 if (FD_ISSET (fifo_in, &fdset_tcl_r))
303 gw_log (GW_LOG_DEBUG, mod, "FIFO closed");
304 p->interp->result = "cancel";
308 for (i=0; i<=max_fd; i++)
314 if (!callback_table[i].handle)
316 if (FD_ISSET (i, &fdset_tcl_r) && callback_table[i].r)
318 if (FD_ISSET (i, &fdset_tcl_w) && callback_table[i].w)
320 if (FD_ISSET (i, &fdset_tcl_x) && callback_table[i].e)
322 if (r_flag || w_flag || e_flag)
323 (*callback_table[i].handle)(callback_table[i].obj,
324 r_flag, w_flag, e_flag);
331 void ir_tcl_select_set (void (*f)(ClientData clientData, int r, int w, int e),
332 int fd, ClientData clientData, int r, int w, int e)
334 callback_table[fd].handle = f;
335 callback_table[fd].obj = clientData;
336 callback_table[fd].r = r;
337 callback_table[fd].w = w;
338 callback_table[fd].e = e;
343 static int do_load (char *parms, void *mydata)
345 struct tcl_info *p = mydata;
347 return w_interp_load_state (p->w_interp, parms);
350 static int do_save (char *parms, void *mydata)
352 struct tcl_info *p = mydata;
354 return w_interp_save_state (p->w_interp, parms);
357 Tcl_Interp *w_interp_irtcl_get (W_Interp w_interp)
361 if (strcmp (w_interp->ctrl->name, "irtcl"))
363 gw_log (GW_LOG_FATAL, mod, "Internal failure");
366 p = (struct tcl_info*) w_interp->mydata;