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.19 1997/01/27 11:27:17 adam
45 * Implemented a new command, egw_clear, to clear http output cache.
46 * Changed prototype for function wo_clear.
48 * Revision 1.18 1997/01/24 13:13:13 adam
49 * Implemnted egw_source and added a "raw" option to the URL.
50 * Fixed a bug in the buffering system of wproto; the macro wo_putc could
51 * override memory if it was the first HTML generating function called.
53 * Revision 1.17 1996/05/31 08:02:56 adam
54 * Bug fix: egw_enc encoded '/' - it shouldn't.
56 * Revision 1.16 1996/05/23 15:53:12 adam
57 * Bug fix: egw_enc failed on 8-bit chars.
58 * New command: egw_parms.
60 * Revision 1.15 1996/05/22 16:50:27 adam
63 * Revision 1.14 1996/05/21 14:53:04 adam
64 * Tcl command wform extented; options -raw and -exists added.
66 * Revision 1.13 1996/03/14 11:48:40 adam
67 * New function egw_prog that returns name of shell.
69 * Revision 1.12 1996/03/07 12:45:34 adam
70 * New Tcl calls egw_enc/egw_dec to encode/decode binary URL info.
72 * Revision 1.11 1996/01/24 08:26:56 adam
73 * All tcl commands prefixed with egw_ (except the html command).
75 * Revision 1.10 1995/11/08 16:14:35 adam
76 * Many improvements and bug fixes.
77 * First version that ran on dtbsun.
79 * Revision 1.9 1995/11/07 14:57:00 adam
80 * Work on search in multiple targets.
81 * New wtcl command: wlog.
82 * Optional timeout parameter to zwait.
84 * Revision 1.8 1995/11/06 17:44:23 adam
85 * State reestablised when shell restarts. History of previous
88 * Revision 1.7 1995/10/31 16:56:25 adam
89 * Record presentation.
91 * Revision 1.6 1995/10/31 10:03:54 adam
93 * New command implemented - aborts script.
95 * Revision 1.5 1995/10/30 17:35:18 adam
96 * New function zwait that waits for a variable change - due to i/o events
97 * that invoke callback routines.
99 * Revision 1.4 1995/10/27 17:30:16 adam
100 * First search request/response that works.
102 * Revision 1.3 1995/10/27 15:12:14 adam
103 * IrTcl incorporated in the gateway.
104 * Better separation of script types.
105 * Z39.50 gateway scripts entered.
107 * Revision 1.2 1995/10/23 16:55:43 adam
108 * A lot of changes - really.
110 * Revision 1.1 1995/10/20 14:02:42 adam
111 * First version of WWW gateway with embedded Tcl.
123 static void *do_create (WCLIENT wcl, void *args);
124 static int do_exec (const char *fname, char *parms, void *mydata);
125 static int do_load (char *parms, void *mydata);
126 static int do_save (char *parms, void *mydata);
128 static struct w_interp_type w_interp_t = {
136 W_Interp_Type w_interp_tcl = &w_interp_t;
139 static char *mod = "wtcl";
150 static int exec_file (const char *fname, struct tcl_info *p);
152 Tcl_Interp *w_interp_tcl_get (W_Interp w_interp)
156 if (strcmp (w_interp->ctrl->name, "tcl"))
158 gw_log (GW_LOG_FATAL, mod, "Internal failure");
161 p = (struct tcl_info*) w_interp->mydata;
165 static int proc_wabort_invoke (ClientData clientData, Tcl_Interp *interp,
166 int argc, char **argv)
168 struct tcl_info *p = (struct tcl_info*) clientData;
172 Tcl_AppendResult (interp, argv[1], NULL);
176 static int proc_wflush_invoke (ClientData clientData, Tcl_Interp *interp,
177 int argc, char **argv)
179 struct tcl_info *p = (struct tcl_info*) clientData;
185 static int proc_html_invoke (ClientData clientData, Tcl_Interp *interp,
186 int argc, char **argv)
188 struct tcl_info *p = (struct tcl_info*) clientData;
191 for (i = 1; i<argc; i++)
192 wo_write (p->wcl, argv[i], strlen(argv[i]));
196 static int proc_form_invoke (struct tcl_info *p, wform_data *wfdata,
198 int argc, char **argv)
200 const char *arg = NULL;
206 if (!strcmp (argv[1], "-raw"))
208 interp->result = p->wcl->raw_data;
211 else if (!strcmp (argv[1], "-exists"))
218 Tcl_AppendResult (p->interp, "bad option to ", argv[0],
219 " \"", argv[1], "\"", NULL);
227 for (i = 0; *wfdata[i].name; i++)
228 if (!strcmp (arg, wfdata[i].name))
231 if (*wfdata[i].value)
232 Tcl_AppendElement (p->interp, wfdata[i].value);
236 Tcl_AppendResult (p->interp, arg, " doesn't exist", NULL);
241 for (i = 0; *wfdata[i].name; i++)
243 Tcl_AppendResult (p->interp, "{ ", NULL);
244 Tcl_AppendElement (p->interp, wfdata[i].name);
245 Tcl_AppendElement (p->interp, wfdata[i].value);
246 Tcl_AppendResult (p->interp, " }\n", NULL);
251 static int proc_wform_invoke (ClientData clientData, Tcl_Interp *interp,
252 int argc, char **argv)
254 struct tcl_info *p = (struct tcl_info*) clientData;
255 wform_data *wfdata = p->wcl->wf_data;
256 return proc_form_invoke (p, wfdata, interp, argc, argv);
259 static int proc_parms_invoke (ClientData clientData, Tcl_Interp *interp,
260 int argc, char **argv)
262 struct tcl_info *p = (struct tcl_info*) clientData;
263 wform_data *wfdata = p->wcl->wf_parms_var;
264 return proc_form_invoke (p, wfdata, interp, argc, argv);
268 static int proc_wlog_invoke (ClientData clientData, Tcl_Interp *interp,
269 int argc, char **argv)
275 if (!strcmp (argv[1], "debug"))
277 else if (!strcmp (argv[1], "fatal"))
279 else if (!strcmp (argv[1], "warn"))
281 else if (!strcmp (argv[1], "acct"))
288 gw_log (mask, mod, "%s", argv[2]);
291 gw_log (mask, mod, "%s %s", argv[2], argv[3]);
294 gw_log (mask, mod, "%s %s %s", argv[2], argv[3], argv[4]);
297 gw_log (mask, mod, "%s %s %s %s", argv[2], argv[3], argv[4], argv[5]);
303 static int proc_enc (ClientData clientData, Tcl_Interp *interp,
304 int argc, char **argv)
312 for (i = 1; i<argc; i++)
314 const char *cp = argv[i];
317 if (*cp < ' ' || *cp >= 127 || *cp == '&' || *cp == '?'
318 || *cp == '%' || *cp == '+')
320 sprintf (buf1+1, "%02X", *cp & 0xff);
321 Tcl_AppendResult (interp, buf1, NULL);
325 Tcl_AppendResult (interp, "+", NULL);
330 Tcl_AppendResult (interp, buf2, NULL);
338 static int proc_dec (ClientData clientData, Tcl_Interp *interp,
339 int argc, char **argv)
346 for (i = 1; i<argc; i++)
348 const char *cp = argv[i];
351 if (*cp == '%' && cp[1] && cp[2])
354 val = cp[1] - 'A'+10;
360 val = val*16 + (cp[2] - 'A'+10);
362 val = val*16 + (cp[2] - '0');
368 Tcl_AppendResult (interp, buf, NULL);
374 static int proc_prog (ClientData clientData, Tcl_Interp *interp,
375 int argc, char **argv)
377 struct tcl_info *p = (struct tcl_info*) clientData;
379 Tcl_AppendResult (p->interp, p->wcl->prog, NULL);
383 static int proc_source (ClientData clientData, Tcl_Interp *interp,
384 int argc, char **argv)
386 struct tcl_info *p = (struct tcl_info*) clientData;
391 Tcl_AppendResult (p->interp,
392 "wrong # args: should be egw_source file", NULL);
395 r = exec_file (argv[1], p);
398 Tcl_AppendResult (p->interp, "egw_source: couldn't source ",
404 Tcl_AppendResult (p->interp, "egw_source: Tcl error in script ",
411 static int proc_clear (ClientData clientData, Tcl_Interp *interp,
412 int argc, char **argv)
414 struct tcl_info *p = (struct tcl_info*) clientData;
420 int Tcl_AppInit (Tcl_Interp *interp)
422 if (Tcl_Init (interp) == TCL_ERROR)
427 static void *do_create (WCLIENT wcl, void *args)
432 if (!(p = malloc (sizeof(*p))))
434 gw_log (GW_LOG_FATAL|GW_LOG_ERRNO, mod, "malloc: tcl_info");
437 if (!(p->interp = Tcl_CreateInterp ()))
439 gw_log (GW_LOG_FATAL, mod, "Cannot make Tcl_Interp");
444 if (!(p->fbuf = malloc (p->fbuf_size)))
446 gw_log (GW_LOG_FATAL|GW_LOG_ERRNO, mod, "malloc: tcl_info fbuf");
449 Tcl_AppInit (p->interp);
450 Tcl_CreateCommand (p->interp, "html", proc_html_invoke, p, NULL);
451 Tcl_CreateCommand (p->interp, "egw_form", proc_wform_invoke, p, NULL);
452 Tcl_CreateCommand (p->interp, "egw_parms", proc_parms_invoke, p, NULL);
453 Tcl_CreateCommand (p->interp, "egw_abort", proc_wabort_invoke, p, NULL);
454 Tcl_CreateCommand (p->interp, "egw_flush", proc_wflush_invoke, p, NULL);
455 Tcl_CreateCommand (p->interp, "egw_log", proc_wlog_invoke, p, NULL);
456 Tcl_CreateCommand (p->interp, "egw_enc", proc_enc, p, NULL);
457 Tcl_CreateCommand (p->interp, "egw_dec", proc_dec, p, NULL);
458 Tcl_CreateCommand (p->interp, "egw_prog", proc_prog, p, NULL);
459 Tcl_CreateCommand (p->interp, "egw_source", proc_source, p, NULL);
460 Tcl_CreateCommand (p->interp, "egw_clear", proc_clear, p, NULL);
461 sprintf (tmp_str, "%d", wcl->id);
462 Tcl_SetVar (p->interp, "sessionId", tmp_str, TCL_GLOBAL_ONLY);
466 static void report_error (struct tcl_info *p, int errorLine,
467 const char *pre, const char *msg)
471 gw_log (GW_LOG_WARN, mod, "%s %d %s", pre, errorLine, msg);
472 wo_printf (p->wcl, "\n<br><hr>\n<strong>"
473 "%s %d</strong><br>\n", pre, errorLine);
474 wo_printf (p->wcl, "<xmp>\n%s</xmp>\n<hr>\n", msg);
477 static int tcl_exec (const char *fname, struct tcl_info *p, FILE *inf,
480 int c, escape = 0, level = 0;
486 if (fbuf_ptr == p->fbuf_size-1)
490 if (!(newb = malloc (p->fbuf_size += 16384)))
492 gw_log (GW_LOG_FATAL|GW_LOG_ERRNO, mod, "malloc: fbuf");
495 memcpy (newb, p->fbuf, fbuf_ptr);
502 report_error (p, *lineno, "Error in Tcl script starting at line",
503 "Unexpected EOF (missing right brace)");
508 else if (c == '{' && !escape)
513 else if (c == '}' && !escape)
525 p->fbuf[fbuf_ptr++] = c;
527 p->fbuf[fbuf_ptr] = '\0';
529 r = Tcl_Eval (p->interp, p->fbuf);
531 report_error (p, p->interp->errorLine + *lineno - 1,
532 "Error in Tcl script in line",
533 Tcl_GetVar (p->interp, "errorInfo", 0));
534 (*lineno) += local_line;
540 static int var_ref (struct tcl_info *p, FILE *inf)
548 while ((c = getc(inf)) != EOF)
565 if (c != '(' && c != ')' && c != '-' && c != '_' && !isalnum(c))
573 vp = Tcl_GetVar (p->interp, name, 0);
575 wo_puts (p->wcl, vp);
579 static int exec_file (const char *fname, struct tcl_info *p)
583 FILE *inf = fopen (fname, "r");
585 gw_log (GW_LOG_DEBUG, mod, "Executing %s", fname);
588 gw_log (GW_LOG_WARN|GW_LOG_ERRNO, mod, "open %s", fname);
607 c = var_ref (p, inf);
614 int r = tcl_exec (fname, p, inf, &lineno);
620 else if (r == TCL_ERROR)
641 static int do_exec (const char *fname, char *parms, void *mydata)
643 struct tcl_info *p = mydata;
645 Tcl_SetVar (p->interp, "sessionParms", parms, TCL_GLOBAL_ONLY);
646 return exec_file (fname, p);
649 static int do_load (char *parms, void *mydata)
651 struct tcl_info *p = mydata;
655 sprintf (fname, "tcl.state.%d", p->wcl->id);
656 r = Tcl_EvalFile (p->interp, fname);
658 gw_log (GW_LOG_WARN, mod, "Cannot load Tcl state" );
662 static int do_save (char *parms, void *mydata)
664 struct tcl_info *p = mydata;
665 struct Tcl_CmdInfo cinfo;
667 if (Tcl_GetCommandInfo(p->interp, "saveState", &cinfo))
671 gw_log (GW_LOG_DEBUG, mod, "saveState");
672 r = Tcl_Eval (p->interp, "saveState\n");
674 report_error (p, p->interp->errorLine,
675 "Error in Tcl saveState in line",
676 Tcl_GetVar (p->interp, "errorInfo", 0));