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/05/31 08:02:56 adam
45 * Bug fix: egw_enc encoded '/' - it shouldn't.
47 * Revision 1.16 1996/05/23 15:53:12 adam
48 * Bug fix: egw_enc failed on 8-bit chars.
49 * New command: egw_parms.
51 * Revision 1.15 1996/05/22 16:50:27 adam
54 * Revision 1.14 1996/05/21 14:53:04 adam
55 * Tcl command wform extented; options -raw and -exists added.
57 * Revision 1.13 1996/03/14 11:48:40 adam
58 * New function egw_prog that returns name of shell.
60 * Revision 1.12 1996/03/07 12:45:34 adam
61 * New Tcl calls egw_enc/egw_dec to encode/decode binary URL info.
63 * Revision 1.11 1996/01/24 08:26:56 adam
64 * All tcl commands prefixed with egw_ (except the html command).
66 * Revision 1.10 1995/11/08 16:14:35 adam
67 * Many improvements and bug fixes.
68 * First version that ran on dtbsun.
70 * Revision 1.9 1995/11/07 14:57:00 adam
71 * Work on search in multiple targets.
72 * New wtcl command: wlog.
73 * Optional timeout parameter to zwait.
75 * Revision 1.8 1995/11/06 17:44:23 adam
76 * State reestablised when shell restarts. History of previous
79 * Revision 1.7 1995/10/31 16:56:25 adam
80 * Record presentation.
82 * Revision 1.6 1995/10/31 10:03:54 adam
84 * New command implemented - aborts script.
86 * Revision 1.5 1995/10/30 17:35:18 adam
87 * New function zwait that waits for a variable change - due to i/o events
88 * that invoke callback routines.
90 * Revision 1.4 1995/10/27 17:30:16 adam
91 * First search request/response that works.
93 * Revision 1.3 1995/10/27 15:12:14 adam
94 * IrTcl incorporated in the gateway.
95 * Better separation of script types.
96 * Z39.50 gateway scripts entered.
98 * Revision 1.2 1995/10/23 16:55:43 adam
99 * A lot of changes - really.
101 * Revision 1.1 1995/10/20 14:02:42 adam
102 * First version of WWW gateway with embedded Tcl.
114 static void *do_create (WCLIENT wcl, void *args);
115 static int do_exec (const char *fname, char *parms, void *mydata);
116 static int do_load (char *parms, void *mydata);
117 static int do_save (char *parms, void *mydata);
119 static struct w_interp_type w_interp_t = {
127 W_Interp_Type w_interp_tcl = &w_interp_t;
130 static char *mod = "wtcl";
141 Tcl_Interp *w_interp_tcl_get (W_Interp w_interp)
145 if (strcmp (w_interp->ctrl->name, "tcl"))
147 gw_log (GW_LOG_FATAL, mod, "Internal failure");
150 p = (struct tcl_info*) w_interp->mydata;
154 static int proc_wabort_invoke (ClientData clientData, Tcl_Interp *interp,
155 int argc, char **argv)
157 struct tcl_info *p = (struct tcl_info*) clientData;
161 Tcl_AppendResult (interp, argv[1], NULL);
165 static int proc_wflush_invoke (ClientData clientData, Tcl_Interp *interp,
166 int argc, char **argv)
168 struct tcl_info *p = (struct tcl_info*) clientData;
174 static int proc_html_invoke (ClientData clientData, Tcl_Interp *interp,
175 int argc, char **argv)
177 struct tcl_info *p = (struct tcl_info*) clientData;
180 for (i = 1; i<argc; i++)
181 wo_write (p->wcl, argv[i], strlen(argv[i]));
185 static int proc_form_invoke (struct tcl_info *p, wform_data *wfdata,
187 int argc, char **argv)
189 const char *arg = NULL;
195 if (!strcmp (argv[1], "-raw"))
197 interp->result = p->wcl->raw_data;
200 else if (!strcmp (argv[1], "-exists"))
207 Tcl_AppendResult (p->interp, "bad option to ", argv[0],
208 " \"", argv[1], "\"", NULL);
216 for (i = 0; *wfdata[i].name; i++)
217 if (!strcmp (arg, wfdata[i].name))
220 if (*wfdata[i].value)
221 Tcl_AppendElement (p->interp, wfdata[i].value);
225 Tcl_AppendResult (p->interp, arg, " doesn't exist", NULL);
230 for (i = 0; *wfdata[i].name; i++)
232 Tcl_AppendResult (p->interp, "{ ", NULL);
233 Tcl_AppendElement (p->interp, wfdata[i].name);
234 Tcl_AppendElement (p->interp, wfdata[i].value);
235 Tcl_AppendResult (p->interp, " }\n", NULL);
240 static int proc_wform_invoke (ClientData clientData, Tcl_Interp *interp,
241 int argc, char **argv)
243 struct tcl_info *p = (struct tcl_info*) clientData;
244 wform_data *wfdata = p->wcl->wf_data;
245 return proc_form_invoke (p, wfdata, interp, argc, argv);
248 static int proc_parms_invoke (ClientData clientData, Tcl_Interp *interp,
249 int argc, char **argv)
251 struct tcl_info *p = (struct tcl_info*) clientData;
252 wform_data *wfdata = p->wcl->wf_parms_var;
253 return proc_form_invoke (p, wfdata, interp, argc, argv);
257 static int proc_wlog_invoke (ClientData clientData, Tcl_Interp *interp,
258 int argc, char **argv)
264 if (!strcmp (argv[1], "debug"))
266 else if (!strcmp (argv[1], "fatal"))
268 else if (!strcmp (argv[1], "warn"))
270 else if (!strcmp (argv[1], "acct"))
277 gw_log (mask, mod, "%s", argv[2]);
280 gw_log (mask, mod, "%s %s", argv[2], argv[3]);
283 gw_log (mask, mod, "%s %s %s", argv[2], argv[3], argv[4]);
286 gw_log (mask, mod, "%s %s %s %s", argv[2], argv[3], argv[4], argv[5]);
292 static int proc_enc (ClientData clientData, Tcl_Interp *interp,
293 int argc, char **argv)
301 for (i = 1; i<argc; i++)
303 const char *cp = argv[i];
306 if (*cp < ' ' || *cp >= 127 || *cp == '&' || *cp == '?'
307 || *cp == '%' || *cp == '+')
309 sprintf (buf1+1, "%02X", *cp & 0xff);
310 Tcl_AppendResult (interp, buf1, NULL);
314 Tcl_AppendResult (interp, "+", NULL);
319 Tcl_AppendResult (interp, buf2, NULL);
327 static int proc_dec (ClientData clientData, Tcl_Interp *interp,
328 int argc, char **argv)
335 for (i = 1; i<argc; i++)
337 const char *cp = argv[i];
340 if (*cp == '%' && cp[1] && cp[2])
343 val = cp[1] - 'A'+10;
349 val = val*16 + (cp[2] - 'A'+10);
351 val = val*16 + (cp[2] - '0');
357 Tcl_AppendResult (interp, buf, NULL);
363 static int proc_prog (ClientData clientData, Tcl_Interp *interp,
364 int argc, char **argv)
366 struct tcl_info *p = (struct tcl_info*) clientData;
368 Tcl_AppendResult (p->interp, p->wcl->prog, NULL);
372 int Tcl_AppInit (Tcl_Interp *interp)
374 if (Tcl_Init (interp) == TCL_ERROR)
379 static void *do_create (WCLIENT wcl, void *args)
384 if (!(p = malloc (sizeof(*p))))
386 gw_log (GW_LOG_FATAL|GW_LOG_ERRNO, mod, "malloc: tcl_info");
389 if (!(p->interp = Tcl_CreateInterp ()))
391 gw_log (GW_LOG_FATAL, mod, "Cannot make Tcl_Interp");
396 if (!(p->fbuf = malloc (p->fbuf_size)))
398 gw_log (GW_LOG_FATAL|GW_LOG_ERRNO, mod, "malloc: tcl_info fbuf");
401 Tcl_AppInit (p->interp);
402 Tcl_CreateCommand (p->interp, "html", proc_html_invoke, p, NULL);
403 Tcl_CreateCommand (p->interp, "egw_form", proc_wform_invoke, p, NULL);
404 Tcl_CreateCommand (p->interp, "egw_parms", proc_parms_invoke, p, NULL);
405 Tcl_CreateCommand (p->interp, "egw_abort", proc_wabort_invoke, p, NULL);
406 Tcl_CreateCommand (p->interp, "egw_flush", proc_wflush_invoke, p, NULL);
407 Tcl_CreateCommand (p->interp, "egw_log", proc_wlog_invoke, p, NULL);
408 Tcl_CreateCommand (p->interp, "egw_enc", proc_enc, p, NULL);
409 Tcl_CreateCommand (p->interp, "egw_dec", proc_dec, p, NULL);
410 Tcl_CreateCommand (p->interp, "egw_prog", proc_prog, p, NULL);
411 sprintf (tmp_str, "%d", wcl->id);
412 Tcl_SetVar (p->interp, "sessionId", tmp_str, TCL_GLOBAL_ONLY);
416 static void report_error (struct tcl_info *p, int errorLine,
417 const char *pre, const char *msg)
421 gw_log (GW_LOG_WARN, mod, "%s %d %s", pre, errorLine, msg);
422 wo_printf (p->wcl, "\n<br><hr>\n<strong>"
423 "%s %d</strong><br>\n", pre, errorLine);
424 wo_printf (p->wcl, "<xmp>\n%s</xmp>\n<hr>\n", msg);
427 static int tcl_exec (const char *fname, char *parms,
428 struct tcl_info *p, FILE *inf, int *lineno)
430 int c, escape = 0, level = 0;
436 if (fbuf_ptr == p->fbuf_size-1)
440 if (!(newb = malloc (p->fbuf_size += 16384)))
442 gw_log (GW_LOG_FATAL|GW_LOG_ERRNO, mod, "malloc: fbuf");
445 memcpy (newb, p->fbuf, fbuf_ptr);
452 report_error (p, *lineno, "Error in Tcl script starting at line",
453 "Unexpected EOF (missing right brace)");
458 else if (c == '{' && !escape)
463 else if (c == '}' && !escape)
475 p->fbuf[fbuf_ptr++] = c;
477 p->fbuf[fbuf_ptr] = '\0';
479 r = Tcl_Eval (p->interp, p->fbuf);
481 report_error (p, p->interp->errorLine + *lineno - 1,
482 "Error in Tcl script in line",
483 Tcl_GetVar (p->interp, "errorInfo", 0));
484 (*lineno) += local_line;
490 static int do_exec (const char *fname, char *parms, void *mydata)
492 struct tcl_info *p = mydata;
495 FILE *inf = fopen (fname, "r");
497 gw_log (GW_LOG_DEBUG, mod, "Executing %s", fname);
500 gw_log (GW_LOG_WARN|GW_LOG_ERRNO, mod, "open %s", fname);
503 Tcl_SetVar (p->interp, "sessionParms", parms, TCL_GLOBAL_ONLY);
504 while ((c = getc(inf)) != EOF)
514 int r = tcl_exec (fname, parms, p, inf, &lineno);
520 else if (r == TCL_ERROR)
541 static int do_load (char *parms, void *mydata)
543 struct tcl_info *p = mydata;
547 sprintf (fname, "tcl.state.%d", p->wcl->id);
548 r = Tcl_EvalFile (p->interp, fname);
550 gw_log (GW_LOG_WARN, mod, "Cannot load Tcl state" );
554 static int do_save (char *parms, void *mydata)
556 struct tcl_info *p = mydata;
557 struct Tcl_CmdInfo cinfo;
559 if (Tcl_GetCommandInfo(p->interp, "saveState", &cinfo))
563 gw_log (GW_LOG_DEBUG, mod, "saveState");
564 r = Tcl_Eval (p->interp, "saveState\n");
566 report_error (p, p->interp->errorLine,
567 "Error in Tcl saveState in line",
568 Tcl_GetVar (p->interp, "errorInfo", 0));