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.23 1998/03/26 11:29:02 franck
45 * Fixed some bugs with escape sequences.
47 * Revision 1.22 1997/12/15 15:05:03 adam
48 * Enhanced the code that deals with FORM variables.
50 * Revision 1.21 1997/02/10 10:15:40 adam
51 * Bug fix: egw_source <file> <var> didn't work properly.
53 * Revision 1.20 1997/01/31 11:16:01 adam
54 * Enhanced the egw_source command. An optional parameter specifies the
55 * name of a variable in which the HTML output is stored.
57 * Revision 1.19 1997/01/27 11:27:17 adam
58 * Implemented a new command, egw_clear, to clear http output cache.
59 * Changed prototype for function wo_clear.
61 * Revision 1.18 1997/01/24 13:13:13 adam
62 * Implemnted egw_source and added a "raw" option to the URL.
63 * Fixed a bug in the buffering system of wproto; the macro wo_putc could
64 * override memory if it was the first HTML generating function called.
66 * Revision 1.17 1996/05/31 08:02:56 adam
67 * Bug fix: egw_enc encoded '/' - it shouldn't.
69 * Revision 1.16 1996/05/23 15:53:12 adam
70 * Bug fix: egw_enc failed on 8-bit chars.
71 * New command: egw_parms.
73 * Revision 1.15 1996/05/22 16:50:27 adam
76 * Revision 1.14 1996/05/21 14:53:04 adam
77 * Tcl command wform extented; options -raw and -exists added.
79 * Revision 1.13 1996/03/14 11:48:40 adam
80 * New function egw_prog that returns name of shell.
82 * Revision 1.12 1996/03/07 12:45:34 adam
83 * New Tcl calls egw_enc/egw_dec to encode/decode binary URL info.
85 * Revision 1.11 1996/01/24 08:26:56 adam
86 * All tcl commands prefixed with egw_ (except the html command).
88 * Revision 1.10 1995/11/08 16:14:35 adam
89 * Many improvements and bug fixes.
90 * First version that ran on dtbsun.
92 * Revision 1.9 1995/11/07 14:57:00 adam
93 * Work on search in multiple targets.
94 * New wtcl command: wlog.
95 * Optional timeout parameter to zwait.
97 * Revision 1.8 1995/11/06 17:44:23 adam
98 * State reestablised when shell restarts. History of previous
101 * Revision 1.7 1995/10/31 16:56:25 adam
102 * Record presentation.
104 * Revision 1.6 1995/10/31 10:03:54 adam
106 * New command implemented - aborts script.
108 * Revision 1.5 1995/10/30 17:35:18 adam
109 * New function zwait that waits for a variable change - due to i/o events
110 * that invoke callback routines.
112 * Revision 1.4 1995/10/27 17:30:16 adam
113 * First search request/response that works.
115 * Revision 1.3 1995/10/27 15:12:14 adam
116 * IrTcl incorporated in the gateway.
117 * Better separation of script types.
118 * Z39.50 gateway scripts entered.
120 * Revision 1.2 1995/10/23 16:55:43 adam
121 * A lot of changes - really.
123 * Revision 1.1 1995/10/20 14:02:42 adam
124 * First version of WWW gateway with embedded Tcl.
136 static void *do_create (WCLIENT wcl, void *args);
137 static int do_exec (const char *fname, char *parms, void *mydata);
138 static int do_load (char *parms, void *mydata);
139 static int do_save (char *parms, void *mydata);
141 static struct w_interp_type w_interp_t = {
149 W_Interp_Type w_interp_tcl = &w_interp_t;
152 static char *mod = "wtcl";
163 static int exec_file (const char *fname, struct tcl_info *p);
165 Tcl_Interp *w_interp_tcl_get (W_Interp w_interp)
169 if (strcmp (w_interp->ctrl->name, "tcl"))
171 gw_log (GW_LOG_FATAL, mod, "Internal failure");
174 p = (struct tcl_info*) w_interp->mydata;
178 static int proc_wabort_invoke (ClientData clientData, Tcl_Interp *interp,
179 int argc, char **argv)
181 struct tcl_info *p = (struct tcl_info*) clientData;
185 Tcl_AppendResult (interp, argv[1], NULL);
189 static int proc_wflush_invoke (ClientData clientData, Tcl_Interp *interp,
190 int argc, char **argv)
192 struct tcl_info *p = (struct tcl_info*) clientData;
198 static int proc_html_invoke (ClientData clientData, Tcl_Interp *interp,
199 int argc, char **argv)
201 struct tcl_info *p = (struct tcl_info*) clientData;
204 for (i = 1; i<argc; i++)
205 wo_write (p->wcl, argv[i], strlen(argv[i]));
209 static int proc_form_invoke (struct tcl_info *p, wform_data *wfdata,
211 int argc, char **argv)
213 const char *arg = NULL;
218 if (!strcmp (argv[1], "-raw"))
220 interp->result = p->wcl->raw_data;
223 else if (!strcmp (argv[1], "-exists"))
230 Tcl_AppendResult (p->interp, "bad option to ", argv[0],
231 " \"", argv[1], "\"", NULL);
239 for (; wfdata; wfdata = wfdata->next)
240 if (!strcmp (arg, wfdata->name))
244 Tcl_AppendElement (p->interp, wfdata->value);
248 Tcl_AppendResult (p->interp, arg, " doesn't exist", NULL);
253 for ( ; wfdata; wfdata = wfdata->next)
255 Tcl_AppendResult (p->interp, "{ ", NULL);
256 Tcl_AppendElement (p->interp, wfdata->name);
257 Tcl_AppendElement (p->interp, wfdata->value ? wfdata->value : "");
258 Tcl_AppendResult (p->interp, " }\n", NULL);
263 static int proc_wform_invoke (ClientData clientData, Tcl_Interp *interp,
264 int argc, char **argv)
266 struct tcl_info *p = (struct tcl_info*) clientData;
267 wform_data *wfdata = p->wcl->wf_data;
268 return proc_form_invoke (p, wfdata, interp, argc, argv);
271 static int proc_parms_invoke (ClientData clientData, Tcl_Interp *interp,
272 int argc, char **argv)
274 struct tcl_info *p = (struct tcl_info*) clientData;
275 wform_data *wfdata = p->wcl->wf_parms_var;
276 return proc_form_invoke (p, wfdata, interp, argc, argv);
280 static int proc_wlog_invoke (ClientData clientData, Tcl_Interp *interp,
281 int argc, char **argv)
287 if (!strcmp (argv[1], "debug"))
289 else if (!strcmp (argv[1], "fatal"))
291 else if (!strcmp (argv[1], "warn"))
293 else if (!strcmp (argv[1], "acct"))
300 gw_log (mask, mod, "%s", argv[2]);
303 gw_log (mask, mod, "%s %s", argv[2], argv[3]);
306 gw_log (mask, mod, "%s %s %s", argv[2], argv[3], argv[4]);
309 gw_log (mask, mod, "%s %s %s %s", argv[2], argv[3], argv[4], argv[5]);
315 static int proc_enc (ClientData clientData, Tcl_Interp *interp,
316 int argc, char **argv)
324 for (i = 1; i<argc; i++)
326 const char *cp = argv[i];
329 if (*cp < ' ' || *cp >= 127 || *cp == '&' || *cp == '?'
330 || *cp == '%' || *cp == '+' || *cp == '"' || *cp == '=')
332 sprintf (buf1+1, "%02X", *cp & 0xff);
333 Tcl_AppendResult (interp, buf1, NULL);
337 Tcl_AppendResult (interp, "+", NULL);
342 Tcl_AppendResult (interp, buf2, NULL);
350 static int proc_dec (ClientData clientData, Tcl_Interp *interp,
351 int argc, char **argv)
358 for (i = 1; i<argc; i++)
360 const char *cp = argv[i];
363 if (*cp == '%' && cp[1] && cp[2])
366 val = cp[1] - 'A'+10;
372 val = val*16 + (cp[2] - 'A'+10);
374 val = val*16 + (cp[2] - '0');
380 Tcl_AppendResult (interp, buf, NULL);
386 static int proc_prog (ClientData clientData, Tcl_Interp *interp,
387 int argc, char **argv)
389 struct tcl_info *p = (struct tcl_info*) clientData;
391 Tcl_AppendResult (p->interp, p->wcl->prog, NULL);
395 static int proc_source (ClientData clientData, Tcl_Interp *interp,
396 int argc, char **argv)
398 struct tcl_info *p = (struct tcl_info*) clientData;
401 if (argc < 2 || argc > 3)
403 Tcl_AppendResult (p->interp,
404 "wrong # args: should be egw_source file ?var?",
409 offset = wproto_save_push (p->wcl);
410 r = exec_file (argv[1], p);
411 Tcl_ResetResult (p->interp);
414 char *res = wproto_save_pop (p->wcl, offset);
416 Tcl_SetVar (p->interp, argv[2], res, 0);
420 Tcl_AppendResult (p->interp, "egw_source: couldn't open ",
426 Tcl_AppendResult (p->interp, "egw_source: Tcl error in script ",
433 static int proc_clear (ClientData clientData, Tcl_Interp *interp,
434 int argc, char **argv)
436 struct tcl_info *p = (struct tcl_info*) clientData;
442 int Tcl_AppInit (Tcl_Interp *interp)
444 if (Tcl_Init (interp) == TCL_ERROR)
449 static void *do_create (WCLIENT wcl, void *args)
454 if (!(p = malloc (sizeof(*p))))
456 gw_log (GW_LOG_FATAL|GW_LOG_ERRNO, mod, "malloc: tcl_info");
459 if (!(p->interp = Tcl_CreateInterp ()))
461 gw_log (GW_LOG_FATAL, mod, "Cannot make Tcl_Interp");
466 if (!(p->fbuf = malloc (p->fbuf_size)))
468 gw_log (GW_LOG_FATAL|GW_LOG_ERRNO, mod, "malloc: tcl_info fbuf");
471 Tcl_AppInit (p->interp);
472 Tcl_CreateCommand (p->interp, "html", proc_html_invoke, p, NULL);
473 Tcl_CreateCommand (p->interp, "egw_form", proc_wform_invoke, p, NULL);
474 Tcl_CreateCommand (p->interp, "egw_parms", proc_parms_invoke, p, NULL);
475 Tcl_CreateCommand (p->interp, "egw_abort", proc_wabort_invoke, p, NULL);
476 Tcl_CreateCommand (p->interp, "egw_flush", proc_wflush_invoke, p, NULL);
477 Tcl_CreateCommand (p->interp, "egw_log", proc_wlog_invoke, p, NULL);
478 Tcl_CreateCommand (p->interp, "egw_enc", proc_enc, p, NULL);
479 Tcl_CreateCommand (p->interp, "egw_dec", proc_dec, p, NULL);
480 Tcl_CreateCommand (p->interp, "egw_prog", proc_prog, p, NULL);
481 Tcl_CreateCommand (p->interp, "egw_source", proc_source, p, NULL);
482 Tcl_CreateCommand (p->interp, "egw_clear", proc_clear, p, NULL);
483 sprintf (tmp_str, "%d", wcl->id);
484 Tcl_SetVar (p->interp, "sessionId", tmp_str, TCL_GLOBAL_ONLY);
488 static void report_error (struct tcl_info *p, int errorLine,
489 const char *pre, const char *msg)
493 gw_log (GW_LOG_WARN, mod, "%s %d %s", pre, errorLine, msg);
494 wo_printf (p->wcl, "\n<br><hr>\n<strong>"
495 "%s %d</strong><br>\n", pre, errorLine);
496 wo_printf (p->wcl, "<xmp>\n%s</xmp>\n<hr>\n", msg);
499 static int tcl_exec (const char *fname, struct tcl_info *p, FILE *inf,
502 int c, escape = 0, level = 0;
508 if (fbuf_ptr == p->fbuf_size-1)
512 if (!(newb = malloc (p->fbuf_size += 16384)))
514 gw_log (GW_LOG_FATAL|GW_LOG_ERRNO, mod, "malloc: fbuf");
517 memcpy (newb, p->fbuf, fbuf_ptr);
524 report_error (p, *lineno, "Error in Tcl script starting at line",
525 "Unexpected EOF (missing right brace)");
530 else if (c == '{' && !escape)
535 else if (c == '}' && !escape)
547 p->fbuf[fbuf_ptr++] = c;
549 p->fbuf[fbuf_ptr] = '\0';
551 r = Tcl_Eval (p->interp, p->fbuf);
553 report_error (p, p->interp->errorLine + *lineno - 1,
554 "Error in Tcl script in line",
555 Tcl_GetVar (p->interp, "errorInfo", 0));
556 (*lineno) += local_line;
562 static int var_ref (struct tcl_info *p, FILE *inf)
570 while ((c = getc(inf)) != EOF)
587 if (c != '(' && c != ')' && c != '-' && c != '_' && !isalnum(c))
595 vp = Tcl_GetVar (p->interp, name, 0);
597 wo_puts (p->wcl, vp);
601 static int exec_file (const char *fname, struct tcl_info *p)
605 FILE *inf = fopen (fname, "r");
607 gw_log (GW_LOG_DEBUG, mod, "Executing %s", fname);
610 gw_log (GW_LOG_WARN|GW_LOG_ERRNO, mod, "open %s", fname);
630 c = var_ref (p, inf);
640 int r = tcl_exec (fname, p, inf, &lineno);
646 else if (r == TCL_ERROR)
666 static int do_exec (const char *fname, char *parms, void *mydata)
668 struct tcl_info *p = mydata;
670 Tcl_SetVar (p->interp, "sessionParms", parms, TCL_GLOBAL_ONLY);
671 return exec_file (fname, p);
674 static int do_load (char *parms, void *mydata)
676 struct tcl_info *p = mydata;
680 sprintf (fname, "tcl.state.%d", p->wcl->id);
681 r = Tcl_EvalFile (p->interp, fname);
683 gw_log (GW_LOG_WARN, mod, "Cannot load Tcl state" );
687 static int do_save (char *parms, void *mydata)
689 struct tcl_info *p = mydata;
690 struct Tcl_CmdInfo cinfo;
692 if (Tcl_GetCommandInfo(p->interp, "saveState", &cinfo))
696 gw_log (GW_LOG_DEBUG, mod, "saveState");
697 r = Tcl_Eval (p->interp, "saveState\n");
699 report_error (p, p->interp->errorLine,
700 "Error in Tcl saveState in line",
701 Tcl_GetVar (p->interp, "errorInfo", 0));