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.13 1996/01/24 08:26:54 adam
45 * All tcl commands prefixed with egw_ (except the html command).
47 * Revision 1.12 1996/01/12 10:05:18 adam
48 * If script name ends with ';' HTTP/GET/Expires will be defined.
49 * The cgi interface only reads final handshake if response from
50 * server (shell) was zero-terminated [If it isn't it probably died].
52 * Revision 1.11 1996/01/09 16:16:49 adam
53 * Port to OSF/1. Gif references moved from /gif/ to /egwgif/.
55 * Revision 1.10 1996/01/09 10:46:50 adam
56 * New defines: LOGDIR/EGWDIR/CGIDIR set in Makefile.
58 * Revision 1.9 1995/11/07 14:56:59 adam
59 * Work on search in multiple targets.
60 * New wtcl command: wlog.
61 * Optional timeout parameter to zwait.
63 * Revision 1.8 1995/11/06 17:44:22 adam
64 * State reestablised when shell restarts. History of previous
67 * Revision 1.7 1995/11/02 16:35:37 adam
68 * Bug fixes and select on FIFOs in wcgi - doesn't really work!
70 * Revision 1.6 1995/11/01 16:15:47 adam
71 * Better presentation of records. Query/set number persistent.
73 * Revision 1.5 1995/10/31 16:56:24 adam
74 * Record presentation.
76 * Revision 1.4 1995/10/31 10:03:53 adam
78 * New command implemented - aborts script.
80 * Revision 1.3 1995/10/30 17:35:18 adam
81 * New function zwait that waits for a variable change - due to i/o events
82 * that invoke callback routines.
84 * Revision 1.2 1995/10/27 17:30:16 adam
85 * First search request/response that works.
87 * Revision 1.1 1995/10/27 15:12:08 adam
88 * IrTcl incorporated in the gateway.
89 * Better separation of script types.
90 * Z39.50 gateway scripts entered.
98 #include <sys/types.h>
100 #include <sys/select.h>
110 static void *do_create (WCLIENT wcl, void *args);
111 static int do_exec (const char *fname, char *parms, void *mydata);
112 static int do_load (char *parms, void *mydata);
113 static int do_save (char *parms, void *mydata);
115 static struct w_interp_type w_interp_t = {
123 W_Interp_Type w_interp_irtcl = &w_interp_t;
126 static char *mod = "wirtcl";
135 static int events (struct tcl_info *p, char *waitVar, int tout);
137 static int proc_zwait_invoke (ClientData clientData, Tcl_Interp *interp,
138 int argc, char **argv)
140 struct tcl_info *p = (struct tcl_info*) clientData;
144 return events (p, argv[1], (argc == 3) ? atoi(argv[2]) : 0);
149 /* select(2) callbacks */
151 void (*r_handle)(ClientData);
152 void (*w_handle)(ClientData);
153 void (*x_handle)(ClientData);
156 #define MAX_CALLBACK 200
158 static struct callback callback_table[MAX_CALLBACK];
159 static int max_fd = 3; /* don't worry: it will grow... */
161 static void *do_create (WCLIENT wcl, void *args)
166 if (!(p = malloc (sizeof(*p))))
168 gw_log (GW_LOG_FATAL|GW_LOG_ERRNO, mod, "malloc: irtcl_info");
171 if (!(p->w_interp = w_interp_create (w_interp_tcl, wcl, NULL)))
173 gw_log (GW_LOG_FATAL, mod, "Cannot make Tcl_Interp");
177 p->interp = w_interp_tcl_get (p->w_interp);
178 if (Irtcl_Init(p->interp) == TCL_ERROR)
180 gw_log (GW_LOG_FATAL, mod, "Cannot make Irtcl_Interp");
183 log_init(LOG_ALL, "irtcl", LOGDIR "/irtcl_log");
184 /* initialize irtcl */
185 Tcl_CreateCommand (p->interp, "egw_wait", proc_zwait_invoke, p, NULL);
186 for (i=0; i<MAX_CALLBACK; i++)
188 callback_table[i].r_handle = NULL;
189 callback_table[i].w_handle = NULL;
190 callback_table[i].x_handle = NULL;
196 static int do_exec (const char *fname, char *parms, void *mydata)
198 struct tcl_info *p = mydata;
200 if ((r = w_interp_exec (p->w_interp, fname, parms)))
206 static int events (struct tcl_info *p, char *waitVar, int tout)
211 static fd_set fdset_tcl_r;
212 static fd_set fdset_tcl_w;
213 static fd_set fdset_tcl_x;
214 int fifo_in = p->wcl->linein;
215 if (fifo_in > max_fd)
219 if ((cp = Tcl_GetVar (p->interp, waitVar, 0)))
221 waitVarVal = malloc (strlen(cp)+1);
222 strcpy (waitVarVal, cp);
228 sprintf (msg, "Variable %s doesn't exist", waitVar);
229 gw_log (GW_LOG_WARN, mod, "%s", msg);
230 Tcl_AppendResult (p->interp, msg, NULL);
233 gw_log (GW_LOG_DEBUG, mod, "Waiting %s=%s", waitVar, waitVarVal);
236 struct timeval to, *top;
246 if (!(cp = Tcl_GetVar (p->interp, waitVar, 0)) ||
247 strcmp (cp, waitVarVal))
249 gw_log (GW_LOG_DEBUG, mod, "Changed to %s", cp);
250 Tcl_AppendResult (p->interp, cp, NULL);
254 FD_ZERO (&fdset_tcl_r);
255 FD_ZERO (&fdset_tcl_w);
256 FD_ZERO (&fdset_tcl_x);
258 for (r=0, i=0; i<=max_fd; i++)
260 if (callback_table[i].w_handle)
262 FD_SET (i, &fdset_tcl_w);
265 if (callback_table[i].r_handle)
267 FD_SET (i, &fdset_tcl_r);
270 if (callback_table[i].x_handle)
272 FD_SET (i, &fdset_tcl_x);
279 gw_log (GW_LOG_DEBUG, mod, "fifo select %d", fifo_in);
280 FD_SET (fifo_in, &fdset_tcl_r);
282 if ((r = select(max_fd+1, &fdset_tcl_r, &fdset_tcl_w,
283 &fdset_tcl_x, top)) < 0)
285 gw_log (GW_LOG_ERRNO|GW_LOG_FATAL, mod, "select");
290 gw_log (GW_LOG_DEBUG, mod, "timeout");
294 if (FD_ISSET (fifo_in, &fdset_tcl_r))
296 gw_log (GW_LOG_DEBUG, mod, "FIFO closed");
300 for (i=0; i<=max_fd; i++)
302 if (FD_ISSET (i, &fdset_tcl_r))
304 if (callback_table[i].r_handle)
305 (*callback_table[i].r_handle) (callback_table[i].obj);
307 if (FD_ISSET (i, &fdset_tcl_w))
309 if (callback_table[i].w_handle)
310 (*callback_table[i].w_handle) (callback_table[i].obj);
312 if (FD_ISSET (i, &fdset_tcl_x))
314 if (callback_table[i].x_handle)
315 (*callback_table[i].x_handle) (callback_table[i].obj);
323 void ir_select_add (int fd, void *obj)
325 callback_table[fd].obj = obj;
326 callback_table[fd].r_handle = ir_select_read;
327 callback_table[fd].w_handle = NULL;
328 callback_table[fd].x_handle = NULL;
333 void ir_select_add_write (int fd, void *obj)
335 callback_table[fd].w_handle = ir_select_write;
340 void ir_select_remove_write (int fd, void *obj)
342 callback_table[fd].w_handle = NULL;
345 void ir_select_remove (int fd, void *obj)
347 callback_table[fd].r_handle = NULL;
348 callback_table[fd].w_handle = NULL;
349 callback_table[fd].x_handle = NULL;
352 static int do_load (char *parms, void *mydata)
354 struct tcl_info *p = mydata;
356 return w_interp_load_state (p->w_interp, parms);
359 static int do_save (char *parms, void *mydata)
361 struct tcl_info *p = mydata;
363 return w_interp_save_state (p->w_interp, parms);