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.21 1997/02/10 10:15:40 adam
45 * Bug fix: egw_source <file> <var> didn't work properly.
47 * Revision 1.20 1997/01/31 11:16:01 adam
48 * Enhanced the egw_source command. An optional parameter specifies the
49 * name of a variable in which the HTML output is stored.
51 * Revision 1.19 1997/01/27 11:27:17 adam
52 * Implemented a new command, egw_clear, to clear http output cache.
53 * Changed prototype for function wo_clear.
55 * Revision 1.18 1997/01/24 13:13:13 adam
56 * Implemnted egw_source and added a "raw" option to the URL.
57 * Fixed a bug in the buffering system of wproto; the macro wo_putc could
58 * override memory if it was the first HTML generating function called.
60 * Revision 1.17 1996/05/31 08:02:56 adam
61 * Bug fix: egw_enc encoded '/' - it shouldn't.
63 * Revision 1.16 1996/05/23 15:53:12 adam
64 * Bug fix: egw_enc failed on 8-bit chars.
65 * New command: egw_parms.
67 * Revision 1.15 1996/05/22 16:50:27 adam
70 * Revision 1.14 1996/05/21 14:53:04 adam
71 * Tcl command wform extented; options -raw and -exists added.
73 * Revision 1.13 1996/03/14 11:48:40 adam
74 * New function egw_prog that returns name of shell.
76 * Revision 1.12 1996/03/07 12:45:34 adam
77 * New Tcl calls egw_enc/egw_dec to encode/decode binary URL info.
79 * Revision 1.11 1996/01/24 08:26:56 adam
80 * All tcl commands prefixed with egw_ (except the html command).
82 * Revision 1.10 1995/11/08 16:14:35 adam
83 * Many improvements and bug fixes.
84 * First version that ran on dtbsun.
86 * Revision 1.9 1995/11/07 14:57:00 adam
87 * Work on search in multiple targets.
88 * New wtcl command: wlog.
89 * Optional timeout parameter to zwait.
91 * Revision 1.8 1995/11/06 17:44:23 adam
92 * State reestablised when shell restarts. History of previous
95 * Revision 1.7 1995/10/31 16:56:25 adam
96 * Record presentation.
98 * Revision 1.6 1995/10/31 10:03:54 adam
100 * New command implemented - aborts script.
102 * Revision 1.5 1995/10/30 17:35:18 adam
103 * New function zwait that waits for a variable change - due to i/o events
104 * that invoke callback routines.
106 * Revision 1.4 1995/10/27 17:30:16 adam
107 * First search request/response that works.
109 * Revision 1.3 1995/10/27 15:12:14 adam
110 * IrTcl incorporated in the gateway.
111 * Better separation of script types.
112 * Z39.50 gateway scripts entered.
114 * Revision 1.2 1995/10/23 16:55:43 adam
115 * A lot of changes - really.
117 * Revision 1.1 1995/10/20 14:02:42 adam
118 * First version of WWW gateway with embedded Tcl.
130 static void *do_create (WCLIENT wcl, void *args);
131 static int do_exec (const char *fname, char *parms, void *mydata);
132 static int do_load (char *parms, void *mydata);
133 static int do_save (char *parms, void *mydata);
135 static struct w_interp_type w_interp_t = {
143 W_Interp_Type w_interp_tcl = &w_interp_t;
146 static char *mod = "wtcl";
157 static int exec_file (const char *fname, struct tcl_info *p);
159 Tcl_Interp *w_interp_tcl_get (W_Interp w_interp)
163 if (strcmp (w_interp->ctrl->name, "tcl"))
165 gw_log (GW_LOG_FATAL, mod, "Internal failure");
168 p = (struct tcl_info*) w_interp->mydata;
172 static int proc_wabort_invoke (ClientData clientData, Tcl_Interp *interp,
173 int argc, char **argv)
175 struct tcl_info *p = (struct tcl_info*) clientData;
179 Tcl_AppendResult (interp, argv[1], NULL);
183 static int proc_wflush_invoke (ClientData clientData, Tcl_Interp *interp,
184 int argc, char **argv)
186 struct tcl_info *p = (struct tcl_info*) clientData;
192 static int proc_html_invoke (ClientData clientData, Tcl_Interp *interp,
193 int argc, char **argv)
195 struct tcl_info *p = (struct tcl_info*) clientData;
198 for (i = 1; i<argc; i++)
199 wo_write (p->wcl, argv[i], strlen(argv[i]));
203 static int proc_form_invoke (struct tcl_info *p, wform_data *wfdata,
205 int argc, char **argv)
207 const char *arg = NULL;
213 if (!strcmp (argv[1], "-raw"))
215 interp->result = p->wcl->raw_data;
218 else if (!strcmp (argv[1], "-exists"))
225 Tcl_AppendResult (p->interp, "bad option to ", argv[0],
226 " \"", argv[1], "\"", NULL);
234 for (i = 0; *wfdata[i].name; i++)
235 if (!strcmp (arg, wfdata[i].name))
238 if (*wfdata[i].value)
239 Tcl_AppendElement (p->interp, wfdata[i].value);
243 Tcl_AppendResult (p->interp, arg, " doesn't exist", NULL);
248 for (i = 0; *wfdata[i].name; i++)
250 Tcl_AppendResult (p->interp, "{ ", NULL);
251 Tcl_AppendElement (p->interp, wfdata[i].name);
252 Tcl_AppendElement (p->interp, wfdata[i].value);
253 Tcl_AppendResult (p->interp, " }\n", NULL);
258 static int proc_wform_invoke (ClientData clientData, Tcl_Interp *interp,
259 int argc, char **argv)
261 struct tcl_info *p = (struct tcl_info*) clientData;
262 wform_data *wfdata = p->wcl->wf_data;
263 return proc_form_invoke (p, wfdata, interp, argc, argv);
266 static int proc_parms_invoke (ClientData clientData, Tcl_Interp *interp,
267 int argc, char **argv)
269 struct tcl_info *p = (struct tcl_info*) clientData;
270 wform_data *wfdata = p->wcl->wf_parms_var;
271 return proc_form_invoke (p, wfdata, interp, argc, argv);
275 static int proc_wlog_invoke (ClientData clientData, Tcl_Interp *interp,
276 int argc, char **argv)
282 if (!strcmp (argv[1], "debug"))
284 else if (!strcmp (argv[1], "fatal"))
286 else if (!strcmp (argv[1], "warn"))
288 else if (!strcmp (argv[1], "acct"))
295 gw_log (mask, mod, "%s", argv[2]);
298 gw_log (mask, mod, "%s %s", argv[2], argv[3]);
301 gw_log (mask, mod, "%s %s %s", argv[2], argv[3], argv[4]);
304 gw_log (mask, mod, "%s %s %s %s", argv[2], argv[3], argv[4], argv[5]);
310 static int proc_enc (ClientData clientData, Tcl_Interp *interp,
311 int argc, char **argv)
319 for (i = 1; i<argc; i++)
321 const char *cp = argv[i];
324 if (*cp < ' ' || *cp >= 127 || *cp == '&' || *cp == '?'
325 || *cp == '%' || *cp == '+' || *cp == '"')
327 sprintf (buf1+1, "%02X", *cp & 0xff);
328 Tcl_AppendResult (interp, buf1, NULL);
332 Tcl_AppendResult (interp, "+", NULL);
337 Tcl_AppendResult (interp, buf2, NULL);
345 static int proc_dec (ClientData clientData, Tcl_Interp *interp,
346 int argc, char **argv)
353 for (i = 1; i<argc; i++)
355 const char *cp = argv[i];
358 if (*cp == '%' && cp[1] && cp[2])
361 val = cp[1] - 'A'+10;
367 val = val*16 + (cp[2] - 'A'+10);
369 val = val*16 + (cp[2] - '0');
375 Tcl_AppendResult (interp, buf, NULL);
381 static int proc_prog (ClientData clientData, Tcl_Interp *interp,
382 int argc, char **argv)
384 struct tcl_info *p = (struct tcl_info*) clientData;
386 Tcl_AppendResult (p->interp, p->wcl->prog, NULL);
390 static int proc_source (ClientData clientData, Tcl_Interp *interp,
391 int argc, char **argv)
393 struct tcl_info *p = (struct tcl_info*) clientData;
396 if (argc < 2 || argc > 3)
398 Tcl_AppendResult (p->interp,
399 "wrong # args: should be egw_source file ?var?",
404 offset = wproto_save_push (p->wcl);
405 r = exec_file (argv[1], p);
406 Tcl_ResetResult (p->interp);
409 char *res = wproto_save_pop (p->wcl, offset);
411 Tcl_SetVar (p->interp, argv[2], res, 0);
415 Tcl_AppendResult (p->interp, "egw_source: couldn't open ",
421 Tcl_AppendResult (p->interp, "egw_source: Tcl error in script ",
428 static int proc_clear (ClientData clientData, Tcl_Interp *interp,
429 int argc, char **argv)
431 struct tcl_info *p = (struct tcl_info*) clientData;
437 int Tcl_AppInit (Tcl_Interp *interp)
439 if (Tcl_Init (interp) == TCL_ERROR)
444 static void *do_create (WCLIENT wcl, void *args)
449 if (!(p = malloc (sizeof(*p))))
451 gw_log (GW_LOG_FATAL|GW_LOG_ERRNO, mod, "malloc: tcl_info");
454 if (!(p->interp = Tcl_CreateInterp ()))
456 gw_log (GW_LOG_FATAL, mod, "Cannot make Tcl_Interp");
461 if (!(p->fbuf = malloc (p->fbuf_size)))
463 gw_log (GW_LOG_FATAL|GW_LOG_ERRNO, mod, "malloc: tcl_info fbuf");
466 Tcl_AppInit (p->interp);
467 Tcl_CreateCommand (p->interp, "html", proc_html_invoke, p, NULL);
468 Tcl_CreateCommand (p->interp, "egw_form", proc_wform_invoke, p, NULL);
469 Tcl_CreateCommand (p->interp, "egw_parms", proc_parms_invoke, p, NULL);
470 Tcl_CreateCommand (p->interp, "egw_abort", proc_wabort_invoke, p, NULL);
471 Tcl_CreateCommand (p->interp, "egw_flush", proc_wflush_invoke, p, NULL);
472 Tcl_CreateCommand (p->interp, "egw_log", proc_wlog_invoke, p, NULL);
473 Tcl_CreateCommand (p->interp, "egw_enc", proc_enc, p, NULL);
474 Tcl_CreateCommand (p->interp, "egw_dec", proc_dec, p, NULL);
475 Tcl_CreateCommand (p->interp, "egw_prog", proc_prog, p, NULL);
476 Tcl_CreateCommand (p->interp, "egw_source", proc_source, p, NULL);
477 Tcl_CreateCommand (p->interp, "egw_clear", proc_clear, p, NULL);
478 sprintf (tmp_str, "%d", wcl->id);
479 Tcl_SetVar (p->interp, "sessionId", tmp_str, TCL_GLOBAL_ONLY);
483 static void report_error (struct tcl_info *p, int errorLine,
484 const char *pre, const char *msg)
488 gw_log (GW_LOG_WARN, mod, "%s %d %s", pre, errorLine, msg);
489 wo_printf (p->wcl, "\n<br><hr>\n<strong>"
490 "%s %d</strong><br>\n", pre, errorLine);
491 wo_printf (p->wcl, "<xmp>\n%s</xmp>\n<hr>\n", msg);
494 static int tcl_exec (const char *fname, struct tcl_info *p, FILE *inf,
497 int c, escape = 0, level = 0;
503 if (fbuf_ptr == p->fbuf_size-1)
507 if (!(newb = malloc (p->fbuf_size += 16384)))
509 gw_log (GW_LOG_FATAL|GW_LOG_ERRNO, mod, "malloc: fbuf");
512 memcpy (newb, p->fbuf, fbuf_ptr);
519 report_error (p, *lineno, "Error in Tcl script starting at line",
520 "Unexpected EOF (missing right brace)");
525 else if (c == '{' && !escape)
530 else if (c == '}' && !escape)
542 p->fbuf[fbuf_ptr++] = c;
544 p->fbuf[fbuf_ptr] = '\0';
546 r = Tcl_Eval (p->interp, p->fbuf);
548 report_error (p, p->interp->errorLine + *lineno - 1,
549 "Error in Tcl script in line",
550 Tcl_GetVar (p->interp, "errorInfo", 0));
551 (*lineno) += local_line;
557 static int var_ref (struct tcl_info *p, FILE *inf)
565 while ((c = getc(inf)) != EOF)
582 if (c != '(' && c != ')' && c != '-' && c != '_' && !isalnum(c))
590 vp = Tcl_GetVar (p->interp, name, 0);
592 wo_puts (p->wcl, vp);
596 static int exec_file (const char *fname, struct tcl_info *p)
600 FILE *inf = fopen (fname, "r");
602 gw_log (GW_LOG_DEBUG, mod, "Executing %s", fname);
605 gw_log (GW_LOG_WARN|GW_LOG_ERRNO, mod, "open %s", fname);
624 c = var_ref (p, inf);
631 int r = tcl_exec (fname, p, inf, &lineno);
637 else if (r == TCL_ERROR)
658 static int do_exec (const char *fname, char *parms, void *mydata)
660 struct tcl_info *p = mydata;
662 Tcl_SetVar (p->interp, "sessionParms", parms, TCL_GLOBAL_ONLY);
663 return exec_file (fname, p);
666 static int do_load (char *parms, void *mydata)
668 struct tcl_info *p = mydata;
672 sprintf (fname, "tcl.state.%d", p->wcl->id);
673 r = Tcl_EvalFile (p->interp, fname);
675 gw_log (GW_LOG_WARN, mod, "Cannot load Tcl state" );
679 static int do_save (char *parms, void *mydata)
681 struct tcl_info *p = mydata;
682 struct Tcl_CmdInfo cinfo;
684 if (Tcl_GetCommandInfo(p->interp, "saveState", &cinfo))
688 gw_log (GW_LOG_DEBUG, mod, "saveState");
689 r = Tcl_Eval (p->interp, "saveState\n");
691 report_error (p, p->interp->errorLine,
692 "Error in Tcl saveState in line",
693 Tcl_GetVar (p->interp, "errorInfo", 0));