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.14 1996/05/21 14:53:04 adam
45 * Tcl command wform extented; options -raw and -exists added.
47 * Revision 1.13 1996/03/14 11:48:40 adam
48 * New function egw_prog that returns name of shell.
50 * Revision 1.12 1996/03/07 12:45:34 adam
51 * New Tcl calls egw_enc/egw_dec to encode/decode binary URL info.
53 * Revision 1.11 1996/01/24 08:26:56 adam
54 * All tcl commands prefixed with egw_ (except the html command).
56 * Revision 1.10 1995/11/08 16:14:35 adam
57 * Many improvements and bug fixes.
58 * First version that ran on dtbsun.
60 * Revision 1.9 1995/11/07 14:57:00 adam
61 * Work on search in multiple targets.
62 * New wtcl command: wlog.
63 * Optional timeout parameter to zwait.
65 * Revision 1.8 1995/11/06 17:44:23 adam
66 * State reestablised when shell restarts. History of previous
69 * Revision 1.7 1995/10/31 16:56:25 adam
70 * Record presentation.
72 * Revision 1.6 1995/10/31 10:03:54 adam
74 * New command implemented - aborts script.
76 * Revision 1.5 1995/10/30 17:35:18 adam
77 * New function zwait that waits for a variable change - due to i/o events
78 * that invoke callback routines.
80 * Revision 1.4 1995/10/27 17:30:16 adam
81 * First search request/response that works.
83 * Revision 1.3 1995/10/27 15:12:14 adam
84 * IrTcl incorporated in the gateway.
85 * Better separation of script types.
86 * Z39.50 gateway scripts entered.
88 * Revision 1.2 1995/10/23 16:55:43 adam
89 * A lot of changes - really.
91 * Revision 1.1 1995/10/20 14:02:42 adam
92 * First version of WWW gateway with embedded Tcl.
104 static void *do_create (WCLIENT wcl, void *args);
105 static int do_exec (const char *fname, char *parms, void *mydata);
106 static int do_load (char *parms, void *mydata);
107 static int do_save (char *parms, void *mydata);
109 static struct w_interp_type w_interp_t = {
117 W_Interp_Type w_interp_tcl = &w_interp_t;
120 static char *mod = "wtcl";
131 Tcl_Interp *w_interp_tcl_get (W_Interp w_interp)
135 if (strcmp (w_interp->ctrl->name, "tcl"))
137 gw_log (GW_LOG_FATAL, mod, "Internal failure");
140 p = (struct tcl_info*) w_interp->mydata;
144 static int proc_wabort_invoke (ClientData clientData, Tcl_Interp *interp,
145 int argc, char **argv)
147 struct tcl_info *p = (struct tcl_info*) clientData;
151 Tcl_AppendResult (interp, argv[1], NULL);
155 static int proc_wflush_invoke (ClientData clientData, Tcl_Interp *interp,
156 int argc, char **argv)
158 struct tcl_info *p = (struct tcl_info*) clientData;
164 static int proc_html_invoke (ClientData clientData, Tcl_Interp *interp,
165 int argc, char **argv)
167 struct tcl_info *p = (struct tcl_info*) clientData;
170 for (i = 1; i<argc; i++)
171 wo_write (p->wcl, argv[i], strlen(argv[i]));
175 static int proc_wform_invoke (ClientData clientData, Tcl_Interp *interp,
176 int argc, char **argv)
178 struct tcl_info *p = (struct tcl_info*) clientData;
179 const char *arg = NULL;
185 if (!strcmp (argv[1], "-raw"))
187 interp->result = p->wcl->raw_data;
190 else if (!strcmp (argv[1], "-exists"))
197 Tcl_AppendResult (p->interp, "bad option to ", argv[0],
198 " \"", argv[1], "\"", NULL);
206 for (i = 0; *p->wcl->wf_data[i].name; i++)
207 if (!strcmp (arg, p->wcl->wf_data[i].name) &&
208 *p->wcl->wf_data[i].value)
209 Tcl_AppendElement (p->interp, p->wcl->wf_data[i].value);
212 Tcl_AppendResult (p->interp, arg, " doesn't exist", NULL);
217 for (i = 0; *p->wcl->wf_data[i].name; i++)
219 Tcl_AppendResult (p->interp, "{ ", NULL);
220 Tcl_AppendElement (p->interp, p->wcl->wf_data[i].name);
221 Tcl_AppendElement (p->interp, p->wcl->wf_data[i].value);
222 Tcl_AppendResult (p->interp, " }\n", NULL);
227 static int proc_wlog_invoke (ClientData clientData, Tcl_Interp *interp,
228 int argc, char **argv)
234 if (!strcmp (argv[1], "debug"))
236 else if (!strcmp (argv[1], "fatal"))
238 else if (!strcmp (argv[1], "warn"))
240 else if (!strcmp (argv[1], "acct"))
247 gw_log (mask, mod, "%s", argv[2]);
250 gw_log (mask, mod, "%s %s", argv[2], argv[3]);
253 gw_log (mask, mod, "%s %s %s", argv[2], argv[3], argv[4]);
256 gw_log (mask, mod, "%s %s %s %s", argv[2], argv[3], argv[4], argv[5]);
262 static int proc_enc (ClientData clientData, Tcl_Interp *interp,
263 int argc, char **argv)
271 for (i = 1; i<argc; i++)
273 const char *cp = argv[i];
276 if (*cp <= ' ' || *cp >= 127 || *cp == '/' || *cp == ' ' ||
277 *cp == '&' || *cp == ':' || *cp == '%')
279 sprintf (buf1+1, "%02X", *cp);
280 Tcl_AppendResult (interp, buf1, NULL);
285 Tcl_AppendResult (interp, buf2, NULL);
293 static int proc_dec (ClientData clientData, Tcl_Interp *interp,
294 int argc, char **argv)
301 for (i = 1; i<argc; i++)
303 const char *cp = argv[i];
306 if (*cp == '%' && cp[1] && cp[2])
309 val = cp[1] - 'A'+10;
315 val = val*16 + (cp[2] - 'A'+10);
317 val = val*16 + (cp[2] - '0');
323 Tcl_AppendResult (interp, buf, NULL);
329 static int proc_prog (ClientData clientData, Tcl_Interp *interp,
330 int argc, char **argv)
332 struct tcl_info *p = (struct tcl_info*) clientData;
334 Tcl_AppendResult (p->interp, p->wcl->prog, NULL);
338 int Tcl_AppInit (Tcl_Interp *interp)
340 if (Tcl_Init (interp) == TCL_ERROR)
345 static void *do_create (WCLIENT wcl, void *args)
350 if (!(p = malloc (sizeof(*p))))
352 gw_log (GW_LOG_FATAL|GW_LOG_ERRNO, mod, "malloc: tcl_info");
355 if (!(p->interp = Tcl_CreateInterp ()))
357 gw_log (GW_LOG_FATAL, mod, "Cannot make Tcl_Interp");
362 if (!(p->fbuf = malloc (p->fbuf_size)))
364 gw_log (GW_LOG_FATAL|GW_LOG_ERRNO, mod, "malloc: tcl_info fbuf");
367 Tcl_AppInit (p->interp);
368 Tcl_CreateCommand (p->interp, "html", proc_html_invoke, p, NULL);
369 Tcl_CreateCommand (p->interp, "egw_form", proc_wform_invoke, p, NULL);
370 Tcl_CreateCommand (p->interp, "egw_abort", proc_wabort_invoke, p, NULL);
371 Tcl_CreateCommand (p->interp, "egw_flush", proc_wflush_invoke, p, NULL);
372 Tcl_CreateCommand (p->interp, "egw_log", proc_wlog_invoke, p, NULL);
373 Tcl_CreateCommand (p->interp, "egw_enc", proc_enc, p, NULL);
374 Tcl_CreateCommand (p->interp, "egw_dec", proc_dec, p, NULL);
375 Tcl_CreateCommand (p->interp, "egw_prog", proc_prog, p, NULL);
376 sprintf (tmp_str, "%d", wcl->id);
377 Tcl_SetVar (p->interp, "sessionId", tmp_str, TCL_GLOBAL_ONLY);
381 static void report_error (struct tcl_info *p, int errorLine,
382 const char *pre, const char *msg)
386 gw_log (GW_LOG_WARN, mod, "%s %d %s", pre, errorLine, msg);
387 wo_printf (p->wcl, "\n<br><hr>\n<strong>"
388 "%s %d</strong><br>\n", pre, errorLine);
389 wo_printf (p->wcl, "<xmp>\n%s</xmp>\n<hr>\n", msg);
392 static int tcl_exec (const char *fname, char *parms,
393 struct tcl_info *p, FILE *inf, int *lineno)
395 int c, escape = 0, level = 0;
401 if (fbuf_ptr == p->fbuf_size-1)
405 if (!(newb = malloc (p->fbuf_size += 16384)))
407 gw_log (GW_LOG_FATAL|GW_LOG_ERRNO, mod, "malloc: fbuf");
410 memcpy (newb, p->fbuf, fbuf_ptr);
417 report_error (p, *lineno, "Error in Tcl script starting at line",
418 "Unexpected EOF (missing right brace)");
423 else if (c == '{' && !escape)
428 else if (c == '}' && !escape)
440 p->fbuf[fbuf_ptr++] = c;
442 p->fbuf[fbuf_ptr] = '\0';
444 r = Tcl_Eval (p->interp, p->fbuf);
446 report_error (p, p->interp->errorLine + *lineno - 1,
447 "Error in Tcl script in line",
448 Tcl_GetVar (p->interp, "errorInfo", 0));
449 (*lineno) += local_line;
455 static int do_exec (const char *fname, char *parms, void *mydata)
457 struct tcl_info *p = mydata;
460 FILE *inf = fopen (fname, "r");
462 gw_log (GW_LOG_DEBUG, mod, "Executing %s", fname);
465 gw_log (GW_LOG_WARN|GW_LOG_ERRNO, mod, "open %s", fname);
468 Tcl_SetVar (p->interp, "sessionParms", parms, TCL_GLOBAL_ONLY);
469 while ((c = getc(inf)) != EOF)
479 int r = tcl_exec (fname, parms, p, inf, &lineno);
485 else if (r == TCL_ERROR)
506 static int do_load (char *parms, void *mydata)
508 struct tcl_info *p = mydata;
512 sprintf (fname, "tcl.state.%d", p->wcl->id);
513 r = Tcl_EvalFile (p->interp, fname);
515 gw_log (GW_LOG_WARN, mod, "Cannot load Tcl state" );
519 static int do_save (char *parms, void *mydata)
521 struct tcl_info *p = mydata;
522 struct Tcl_CmdInfo cinfo;
524 if (Tcl_GetCommandInfo(p->interp, "saveState", &cinfo))
528 gw_log (GW_LOG_DEBUG, mod, "saveState");
529 r = Tcl_Eval (p->interp, "saveState\n");
531 report_error (p, p->interp->errorLine,
532 "Error in Tcl saveState in line",
533 Tcl_GetVar (p->interp, "errorInfo", 0));