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.15 1996/05/22 16:50:27 adam
47 * Revision 1.14 1996/05/21 14:53:04 adam
48 * Tcl command wform extented; options -raw and -exists added.
50 * Revision 1.13 1996/03/14 11:48:40 adam
51 * New function egw_prog that returns name of shell.
53 * Revision 1.12 1996/03/07 12:45:34 adam
54 * New Tcl calls egw_enc/egw_dec to encode/decode binary URL info.
56 * Revision 1.11 1996/01/24 08:26:56 adam
57 * All tcl commands prefixed with egw_ (except the html command).
59 * Revision 1.10 1995/11/08 16:14:35 adam
60 * Many improvements and bug fixes.
61 * First version that ran on dtbsun.
63 * Revision 1.9 1995/11/07 14:57:00 adam
64 * Work on search in multiple targets.
65 * New wtcl command: wlog.
66 * Optional timeout parameter to zwait.
68 * Revision 1.8 1995/11/06 17:44:23 adam
69 * State reestablised when shell restarts. History of previous
72 * Revision 1.7 1995/10/31 16:56:25 adam
73 * Record presentation.
75 * Revision 1.6 1995/10/31 10:03:54 adam
77 * New command implemented - aborts script.
79 * Revision 1.5 1995/10/30 17:35:18 adam
80 * New function zwait that waits for a variable change - due to i/o events
81 * that invoke callback routines.
83 * Revision 1.4 1995/10/27 17:30:16 adam
84 * First search request/response that works.
86 * Revision 1.3 1995/10/27 15:12:14 adam
87 * IrTcl incorporated in the gateway.
88 * Better separation of script types.
89 * Z39.50 gateway scripts entered.
91 * Revision 1.2 1995/10/23 16:55:43 adam
92 * A lot of changes - really.
94 * Revision 1.1 1995/10/20 14:02:42 adam
95 * First version of WWW gateway with embedded Tcl.
107 static void *do_create (WCLIENT wcl, void *args);
108 static int do_exec (const char *fname, char *parms, void *mydata);
109 static int do_load (char *parms, void *mydata);
110 static int do_save (char *parms, void *mydata);
112 static struct w_interp_type w_interp_t = {
120 W_Interp_Type w_interp_tcl = &w_interp_t;
123 static char *mod = "wtcl";
134 Tcl_Interp *w_interp_tcl_get (W_Interp w_interp)
138 if (strcmp (w_interp->ctrl->name, "tcl"))
140 gw_log (GW_LOG_FATAL, mod, "Internal failure");
143 p = (struct tcl_info*) w_interp->mydata;
147 static int proc_wabort_invoke (ClientData clientData, Tcl_Interp *interp,
148 int argc, char **argv)
150 struct tcl_info *p = (struct tcl_info*) clientData;
154 Tcl_AppendResult (interp, argv[1], NULL);
158 static int proc_wflush_invoke (ClientData clientData, Tcl_Interp *interp,
159 int argc, char **argv)
161 struct tcl_info *p = (struct tcl_info*) clientData;
167 static int proc_html_invoke (ClientData clientData, Tcl_Interp *interp,
168 int argc, char **argv)
170 struct tcl_info *p = (struct tcl_info*) clientData;
173 for (i = 1; i<argc; i++)
174 wo_write (p->wcl, argv[i], strlen(argv[i]));
178 static int proc_wform_invoke (ClientData clientData, Tcl_Interp *interp,
179 int argc, char **argv)
181 struct tcl_info *p = (struct tcl_info*) clientData;
182 const char *arg = NULL;
188 if (!strcmp (argv[1], "-raw"))
190 interp->result = p->wcl->raw_data;
193 else if (!strcmp (argv[1], "-exists"))
200 Tcl_AppendResult (p->interp, "bad option to ", argv[0],
201 " \"", argv[1], "\"", NULL);
209 for (i = 0; *p->wcl->wf_data[i].name; i++)
210 if (!strcmp (arg, p->wcl->wf_data[i].name))
213 if (*p->wcl->wf_data[i].value)
214 Tcl_AppendElement (p->interp, p->wcl->wf_data[i].value);
218 Tcl_AppendResult (p->interp, arg, " doesn't exist", NULL);
223 for (i = 0; *p->wcl->wf_data[i].name; i++)
225 Tcl_AppendResult (p->interp, "{ ", NULL);
226 Tcl_AppendElement (p->interp, p->wcl->wf_data[i].name);
227 Tcl_AppendElement (p->interp, p->wcl->wf_data[i].value);
228 Tcl_AppendResult (p->interp, " }\n", NULL);
233 static int proc_wlog_invoke (ClientData clientData, Tcl_Interp *interp,
234 int argc, char **argv)
240 if (!strcmp (argv[1], "debug"))
242 else if (!strcmp (argv[1], "fatal"))
244 else if (!strcmp (argv[1], "warn"))
246 else if (!strcmp (argv[1], "acct"))
253 gw_log (mask, mod, "%s", argv[2]);
256 gw_log (mask, mod, "%s %s", argv[2], argv[3]);
259 gw_log (mask, mod, "%s %s %s", argv[2], argv[3], argv[4]);
262 gw_log (mask, mod, "%s %s %s %s", argv[2], argv[3], argv[4], argv[5]);
268 static int proc_enc (ClientData clientData, Tcl_Interp *interp,
269 int argc, char **argv)
277 for (i = 1; i<argc; i++)
279 const char *cp = argv[i];
282 if (*cp <= ' ' || *cp >= 127 || *cp == '/' || *cp == ' ' ||
283 *cp == '&' || *cp == ':' || *cp == '%')
285 sprintf (buf1+1, "%02X", *cp);
286 Tcl_AppendResult (interp, buf1, NULL);
291 Tcl_AppendResult (interp, buf2, NULL);
299 static int proc_dec (ClientData clientData, Tcl_Interp *interp,
300 int argc, char **argv)
307 for (i = 1; i<argc; i++)
309 const char *cp = argv[i];
312 if (*cp == '%' && cp[1] && cp[2])
315 val = cp[1] - 'A'+10;
321 val = val*16 + (cp[2] - 'A'+10);
323 val = val*16 + (cp[2] - '0');
329 Tcl_AppendResult (interp, buf, NULL);
335 static int proc_prog (ClientData clientData, Tcl_Interp *interp,
336 int argc, char **argv)
338 struct tcl_info *p = (struct tcl_info*) clientData;
340 Tcl_AppendResult (p->interp, p->wcl->prog, NULL);
344 int Tcl_AppInit (Tcl_Interp *interp)
346 if (Tcl_Init (interp) == TCL_ERROR)
351 static void *do_create (WCLIENT wcl, void *args)
356 if (!(p = malloc (sizeof(*p))))
358 gw_log (GW_LOG_FATAL|GW_LOG_ERRNO, mod, "malloc: tcl_info");
361 if (!(p->interp = Tcl_CreateInterp ()))
363 gw_log (GW_LOG_FATAL, mod, "Cannot make Tcl_Interp");
368 if (!(p->fbuf = malloc (p->fbuf_size)))
370 gw_log (GW_LOG_FATAL|GW_LOG_ERRNO, mod, "malloc: tcl_info fbuf");
373 Tcl_AppInit (p->interp);
374 Tcl_CreateCommand (p->interp, "html", proc_html_invoke, p, NULL);
375 Tcl_CreateCommand (p->interp, "egw_form", proc_wform_invoke, p, NULL);
376 Tcl_CreateCommand (p->interp, "egw_abort", proc_wabort_invoke, p, NULL);
377 Tcl_CreateCommand (p->interp, "egw_flush", proc_wflush_invoke, p, NULL);
378 Tcl_CreateCommand (p->interp, "egw_log", proc_wlog_invoke, p, NULL);
379 Tcl_CreateCommand (p->interp, "egw_enc", proc_enc, p, NULL);
380 Tcl_CreateCommand (p->interp, "egw_dec", proc_dec, p, NULL);
381 Tcl_CreateCommand (p->interp, "egw_prog", proc_prog, p, NULL);
382 sprintf (tmp_str, "%d", wcl->id);
383 Tcl_SetVar (p->interp, "sessionId", tmp_str, TCL_GLOBAL_ONLY);
387 static void report_error (struct tcl_info *p, int errorLine,
388 const char *pre, const char *msg)
392 gw_log (GW_LOG_WARN, mod, "%s %d %s", pre, errorLine, msg);
393 wo_printf (p->wcl, "\n<br><hr>\n<strong>"
394 "%s %d</strong><br>\n", pre, errorLine);
395 wo_printf (p->wcl, "<xmp>\n%s</xmp>\n<hr>\n", msg);
398 static int tcl_exec (const char *fname, char *parms,
399 struct tcl_info *p, FILE *inf, int *lineno)
401 int c, escape = 0, level = 0;
407 if (fbuf_ptr == p->fbuf_size-1)
411 if (!(newb = malloc (p->fbuf_size += 16384)))
413 gw_log (GW_LOG_FATAL|GW_LOG_ERRNO, mod, "malloc: fbuf");
416 memcpy (newb, p->fbuf, fbuf_ptr);
423 report_error (p, *lineno, "Error in Tcl script starting at line",
424 "Unexpected EOF (missing right brace)");
429 else if (c == '{' && !escape)
434 else if (c == '}' && !escape)
446 p->fbuf[fbuf_ptr++] = c;
448 p->fbuf[fbuf_ptr] = '\0';
450 r = Tcl_Eval (p->interp, p->fbuf);
452 report_error (p, p->interp->errorLine + *lineno - 1,
453 "Error in Tcl script in line",
454 Tcl_GetVar (p->interp, "errorInfo", 0));
455 (*lineno) += local_line;
461 static int do_exec (const char *fname, char *parms, void *mydata)
463 struct tcl_info *p = mydata;
466 FILE *inf = fopen (fname, "r");
468 gw_log (GW_LOG_DEBUG, mod, "Executing %s", fname);
471 gw_log (GW_LOG_WARN|GW_LOG_ERRNO, mod, "open %s", fname);
474 Tcl_SetVar (p->interp, "sessionParms", parms, TCL_GLOBAL_ONLY);
475 while ((c = getc(inf)) != EOF)
485 int r = tcl_exec (fname, parms, p, inf, &lineno);
491 else if (r == TCL_ERROR)
512 static int do_load (char *parms, void *mydata)
514 struct tcl_info *p = mydata;
518 sprintf (fname, "tcl.state.%d", p->wcl->id);
519 r = Tcl_EvalFile (p->interp, fname);
521 gw_log (GW_LOG_WARN, mod, "Cannot load Tcl state" );
525 static int do_save (char *parms, void *mydata)
527 struct tcl_info *p = mydata;
528 struct Tcl_CmdInfo cinfo;
530 if (Tcl_GetCommandInfo(p->interp, "saveState", &cinfo))
534 gw_log (GW_LOG_DEBUG, mod, "saveState");
535 r = Tcl_Eval (p->interp, "saveState\n");
537 report_error (p, p->interp->errorLine,
538 "Error in Tcl saveState in line",
539 Tcl_GetVar (p->interp, "errorInfo", 0));