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.12 1996/01/12 10:05:18 adam
45 * If script name ends with ';' HTTP/GET/Expires will be defined.
46 * The cgi interface only reads final handshake if response from
47 * server (shell) was zero-terminated [If it isn't it probably died].
49 * Revision 1.11 1996/01/09 16:16:49 adam
50 * Port to OSF/1. Gif references moved from /gif/ to /egwgif/.
52 * Revision 1.10 1996/01/09 10:46:50 adam
53 * New defines: LOGDIR/EGWDIR/CGIDIR set in Makefile.
55 * Revision 1.9 1995/11/07 14:56:59 adam
56 * Work on search in multiple targets.
57 * New wtcl command: wlog.
58 * Optional timeout parameter to zwait.
60 * Revision 1.8 1995/11/06 17:44:22 adam
61 * State reestablised when shell restarts. History of previous
64 * Revision 1.7 1995/11/02 16:35:37 adam
65 * Bug fixes and select on FIFOs in wcgi - doesn't really work!
67 * Revision 1.6 1995/11/01 16:15:47 adam
68 * Better presentation of records. Query/set number persistent.
70 * Revision 1.5 1995/10/31 16:56:24 adam
71 * Record presentation.
73 * Revision 1.4 1995/10/31 10:03:53 adam
75 * New command implemented - aborts script.
77 * Revision 1.3 1995/10/30 17:35:18 adam
78 * New function zwait that waits for a variable change - due to i/o events
79 * that invoke callback routines.
81 * Revision 1.2 1995/10/27 17:30:16 adam
82 * First search request/response that works.
84 * Revision 1.1 1995/10/27 15:12:08 adam
85 * IrTcl incorporated in the gateway.
86 * Better separation of script types.
87 * Z39.50 gateway scripts entered.
95 #include <sys/types.h>
97 #include <sys/select.h>
107 static void *do_create (WCLIENT wcl, void *args);
108 static int do_exec (const char *fname, char *parms, void *mydata);
109 static int do_load (char *parms, void *mydata);
110 static int do_save (char *parms, void *mydata);
112 static struct w_interp_type w_interp_t = {
120 W_Interp_Type w_interp_irtcl = &w_interp_t;
123 static char *mod = "wirtcl";
132 static int events (struct tcl_info *p, char *waitVar, int tout);
134 static int proc_zwait_invoke (ClientData clientData, Tcl_Interp *interp,
135 int argc, char **argv)
137 struct tcl_info *p = (struct tcl_info*) clientData;
141 return events (p, argv[1], (argc == 3) ? atoi(argv[2]) : 0);
146 /* select(2) callbacks */
148 void (*r_handle)(ClientData);
149 void (*w_handle)(ClientData);
150 void (*x_handle)(ClientData);
153 #define MAX_CALLBACK 200
155 static struct callback callback_table[MAX_CALLBACK];
156 static int max_fd = 3; /* don't worry: it will grow... */
158 static void *do_create (WCLIENT wcl, void *args)
163 if (!(p = malloc (sizeof(*p))))
165 gw_log (GW_LOG_FATAL|GW_LOG_ERRNO, mod, "malloc: irtcl_info");
168 if (!(p->w_interp = w_interp_create (w_interp_tcl, wcl, NULL)))
170 gw_log (GW_LOG_FATAL, mod, "Cannot make Tcl_Interp");
174 p->interp = w_interp_tcl_get (p->w_interp);
175 if (Irtcl_Init(p->interp) == TCL_ERROR)
177 gw_log (GW_LOG_FATAL, mod, "Cannot make Irtcl_Interp");
180 log_init(LOG_ALL, "irtcl", LOGDIR "/irtcl_log");
181 /* initialize irtcl */
182 Tcl_CreateCommand (p->interp, "zwait", proc_zwait_invoke, p, NULL);
183 for (i=0; i<MAX_CALLBACK; i++)
185 callback_table[i].r_handle = NULL;
186 callback_table[i].w_handle = NULL;
187 callback_table[i].x_handle = NULL;
193 static int do_exec (const char *fname, char *parms, void *mydata)
195 struct tcl_info *p = mydata;
197 if ((r = w_interp_exec (p->w_interp, fname, parms)))
203 static int events (struct tcl_info *p, char *waitVar, int tout)
208 static fd_set fdset_tcl_r;
209 static fd_set fdset_tcl_w;
210 static fd_set fdset_tcl_x;
211 int fifo_in = p->wcl->linein;
212 if (fifo_in > max_fd)
216 if ((cp = Tcl_GetVar (p->interp, waitVar, 0)))
218 waitVarVal = malloc (strlen(cp)+1);
219 strcpy (waitVarVal, cp);
225 sprintf (msg, "Variable %s doesn't exist", waitVar);
226 gw_log (GW_LOG_WARN, mod, "%s", msg);
227 Tcl_AppendResult (p->interp, msg, NULL);
230 gw_log (GW_LOG_DEBUG, mod, "Waiting %s=%s", waitVar, waitVarVal);
233 struct timeval to, *top;
243 if (!(cp = Tcl_GetVar (p->interp, waitVar, 0)) ||
244 strcmp (cp, waitVarVal))
246 gw_log (GW_LOG_DEBUG, mod, "Changed to %s", cp);
247 Tcl_AppendResult (p->interp, cp, NULL);
251 FD_ZERO (&fdset_tcl_r);
252 FD_ZERO (&fdset_tcl_w);
253 FD_ZERO (&fdset_tcl_x);
255 for (r=0, i=0; i<=max_fd; i++)
257 if (callback_table[i].w_handle)
259 FD_SET (i, &fdset_tcl_w);
262 if (callback_table[i].r_handle)
264 FD_SET (i, &fdset_tcl_r);
267 if (callback_table[i].x_handle)
269 FD_SET (i, &fdset_tcl_x);
276 gw_log (GW_LOG_DEBUG, mod, "fifo select %d", fifo_in);
277 FD_SET (fifo_in, &fdset_tcl_r);
279 if ((r = select(max_fd+1, &fdset_tcl_r, &fdset_tcl_w,
280 &fdset_tcl_x, top)) < 0)
282 gw_log (GW_LOG_ERRNO|GW_LOG_FATAL, mod, "select");
287 gw_log (GW_LOG_DEBUG, mod, "timeout");
291 if (FD_ISSET (fifo_in, &fdset_tcl_r))
293 gw_log (GW_LOG_DEBUG, mod, "FIFO closed");
297 for (i=0; i<=max_fd; i++)
299 if (FD_ISSET (i, &fdset_tcl_r))
301 if (callback_table[i].r_handle)
302 (*callback_table[i].r_handle) (callback_table[i].obj);
304 if (FD_ISSET (i, &fdset_tcl_w))
306 if (callback_table[i].w_handle)
307 (*callback_table[i].w_handle) (callback_table[i].obj);
309 if (FD_ISSET (i, &fdset_tcl_x))
311 if (callback_table[i].x_handle)
312 (*callback_table[i].x_handle) (callback_table[i].obj);
320 void ir_select_add (int fd, void *obj)
322 callback_table[fd].obj = obj;
323 callback_table[fd].r_handle = ir_select_read;
324 callback_table[fd].w_handle = NULL;
325 callback_table[fd].x_handle = NULL;
330 void ir_select_add_write (int fd, void *obj)
332 callback_table[fd].w_handle = ir_select_write;
337 void ir_select_remove_write (int fd, void *obj)
339 callback_table[fd].w_handle = NULL;
342 void ir_select_remove (int fd, void *obj)
344 callback_table[fd].r_handle = NULL;
345 callback_table[fd].w_handle = NULL;
346 callback_table[fd].x_handle = NULL;
349 static int do_load (char *parms, void *mydata)
351 struct tcl_info *p = mydata;
353 return w_interp_load_state (p->w_interp, parms);
356 static int do_save (char *parms, void *mydata)
358 struct tcl_info *p = mydata;
360 return w_interp_save_state (p->w_interp, parms);