www/wtcl.c

   1 /*
   2  * Copyright (c) 1995, the EUROPAGATE consortium (see below).
   3  *
   4  * The EUROPAGATE consortium members are:
   5  *
   6  *    University College Dublin
   7  *    Danmarks Teknologiske Videnscenter
   8  *    An Chomhairle Leabharlanna
   9  *    Consejo Superior de Investigaciones Cientificas
  10  *
  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,
  13  * provided that:
  14  *
  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.
  18  *
  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.
  22  *
  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.
  28  *
  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.
  32  *
  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.
  42  *
  43  * $Log: wtcl.c,v $
  44  * Revision 1.9  1995/11/07 14:57:00  adam
  45  * Work on search in multiple targets.
  46  * New wtcl command: wlog.
  47  * Optional timeout parameter to zwait.
  48  *
  49  * Revision 1.8  1995/11/06  17:44:23  adam
  50  * State reestablised when shell restarts. History of previous
  51  * result sets.
  52  *
  53  * Revision 1.7  1995/10/31  16:56:25  adam
  54  * Record presentation.
  55  *
  56  * Revision 1.6  1995/10/31  10:03:54  adam
  57  * Work on queries.
  58  * New command implemented - aborts script.
  59  *
  60  * Revision 1.5  1995/10/30  17:35:18  adam
  61  * New function zwait that waits for a variable change - due to i/o events
  62  * that invoke callback routines.
  63  *
  64  * Revision 1.4  1995/10/27  17:30:16  adam
  65  * First search request/response that works.
  66  *
  67  * Revision 1.3  1995/10/27  15:12:14  adam
  68  * IrTcl incorporated in the gateway.
  69  * Better separation of script types.
  70  * Z39.50 gateway scripts entered.
  71  *
  72  * Revision 1.2  1995/10/23  16:55:43  adam
  73  * A lot of changes - really.
  74  *
  75  * Revision 1.1  1995/10/20  14:02:42  adam
  76  * First version of WWW gateway with embedded Tcl.
  77  *
  78  */
  79
  80 #include <stdio.h>
  81 #include <stdlib.h>
  82 #include <string.h>
  83 #include <assert.h>
  84 #include <ctype.h>
  85
  86 #include "wtcl.h"
  87
  88 static void *do_create (WCLIENT wcl, void *args);
  89 static int do_exec (const char *fname, char *parms, void *mydata);
  90 static int do_load (char *parms, void *mydata);
  91 static int do_save (char *parms, void *mydata);
  92
  93 static struct w_interp_type w_interp_t = {
  94     "tcl",
  95     do_create,
  96     do_exec,
  97     do_load,
  98     do_save
  99 };
 100
 101 W_Interp_Type w_interp_tcl = &w_interp_t;
 102
 103
 104 static char *mod = "wtcl";
 105
 106 struct tcl_info {
 107     Tcl_Interp *interp;
 108     char  *fbuf;
 109     int    fbuf_size;
 110     int    fbuf_ptr;
 111     int    wabort;
 112     WCLIENT wcl;
 113 };
 114
 115 Tcl_Interp *w_interp_tcl_get (W_Interp w_interp)
 116 {
 117     struct tcl_info *p;
 118
 119     if (strcmp (w_interp->ctrl->name, "tcl"))
 120     {
 121         gw_log (GW_LOG_FATAL, mod, "Internal failure");
 122         assert (0);
 123     }
 124     p = (struct tcl_info*) w_interp->mydata;
 125     return p->interp;
 126 }
 127
 128 static int proc_wabort_invoke (ClientData clientData, Tcl_Interp *interp,
 129                                int argc, char **argv)
 130 {
 131     struct tcl_info *p = (struct tcl_info*) clientData;
 132
 133     p->wabort = 1;
 134     if (argc > 1)
 135         Tcl_AppendResult (interp, argv[1], NULL);
 136     return TCL_RETURN;
 137 }
 138
 139 static int proc_wflush_invoke (ClientData clientData, Tcl_Interp *interp,
 140                                int argc, char **argv)
 141 {
 142     struct tcl_info *p = (struct tcl_info*) clientData;
 143
 144     wo_flush (p->wcl);
 145     return TCL_OK;
 146 }
 147
 148 static int proc_html_invoke (ClientData clientData, Tcl_Interp *interp,
 149                              int argc, char **argv)
 150 {
 151     struct tcl_info *p = (struct tcl_info*) clientData;
 152     int i;
 153
 154     for (i = 1; i<argc; i++)
 155         wo_puts (p->wcl, argv[i]);
 156     return TCL_OK;
 157 }
 158
 159 static int proc_htmlr_invoke (ClientData clientData, Tcl_Interp *interp,
 160                               int argc, char **argv)
 161 {
 162     struct tcl_info *p = (struct tcl_info*) clientData;
 163     int r;
 164
 165     r = proc_html_invoke (clientData, interp, argc, argv);
 166     wo_putc (p->wcl, '\n');
 167     return r;
 168 }
 169
 170 static int proc_wform_invoke (ClientData clientData, Tcl_Interp *interp,
 171                               int argc, char **argv)
 172 {
 173     struct tcl_info *p = (struct tcl_info*) clientData;
 174     int i;
 175     if (argc == 2)
 176     {
 177         for (i = 0; *p->wcl->wf_data[i].name; i++)
 178             if (!strcmp (argv[1], p->wcl->wf_data[i].name) &&
 179                 *p->wcl->wf_data[i].value)
 180                 Tcl_AppendElement (p->interp, p->wcl->wf_data[i].value);
 181         return TCL_OK;
 182     }
 183     for (i = 0; *p->wcl->wf_data[i].name; i++)
 184     {
 185         Tcl_AppendResult (p->interp, "{ ", NULL);
 186         Tcl_AppendElement (p->interp, p->wcl->wf_data[i].name);
 187         Tcl_AppendElement (p->interp, p->wcl->wf_data[i].value);
 188         Tcl_AppendResult (p->interp, " }\n", NULL);
 189     }
 190     return TCL_OK;
 191 }
 192
 193 static int proc_wlog_invoke (ClientData clientData, Tcl_Interp *interp,
 194                              int argc, char **argv)
 195 {
 196     unsigned mask;
 197
 198     if (argc < 3)
 199         return TCL_OK;
 200     if (!strcmp (argv[1], "debug"))
 201         mask = GW_LOG_DEBUG;
 202     else if (!strcmp (argv[1], "fatal"))
 203         mask = GW_LOG_FATAL;
 204     else if (!strcmp (argv[1], "warn"))
 205         mask = GW_LOG_WARN;
 206     else if (!strcmp (argv[1], "acct"))
 207         mask = GW_LOG_ACCT;
 208     else
 209         mask = GW_LOG_DEBUG;
 210     switch (argc)
 211     {
 212     case 3:
 213         gw_log (mask, mod, "%s", argv[2]);
 214         break;
 215     case 4:
 216         gw_log (mask, mod, "%s %s", argv[2], argv[3]);
 217         break;
 218     case 5:
 219         gw_log (mask, mod, "%s %s %s", argv[2], argv[3], argv[4]);
 220         break;
 221     case 6:
 222         gw_log (mask, mod, "%s %s %s %s", argv[2], argv[3], argv[4], argv[5]);
 223         break;
 224     }
 225     return TCL_OK;
 226 }
 227
 228
 229 int Tcl_AppInit (Tcl_Interp *interp)
 230 {
 231     if (Tcl_Init (interp) == TCL_ERROR)
 232         return TCL_ERROR;
 233     return TCL_OK;
 234 }
 235
 236 static void *do_create (WCLIENT wcl, void *args)
 237 {
 238     struct tcl_info *p;
 239     char tmp_str[256];
 240
 241     if (!(p = malloc (sizeof(*p))))
 242     {
 243         gw_log (GW_LOG_FATAL|GW_LOG_ERRNO, mod, "malloc: tcl_info");
 244         exit (1);
 245     }
 246     if (!(p->interp = Tcl_CreateInterp ()))
 247     {
 248         gw_log (GW_LOG_FATAL, mod, "Cannot make Tcl_Interp");
 249         exit (1);
 250     }
 251     p->wcl = wcl;
 252     p->fbuf_size = 1024;
 253     if (!(p->fbuf = malloc (p->fbuf_size)))
 254     {
 255         gw_log (GW_LOG_FATAL|GW_LOG_ERRNO, mod, "malloc: tcl_info fbuf");
 256         exit (1);
 257     }
 258     Tcl_AppInit (p->interp);
 259     Tcl_CreateCommand (p->interp, "html", proc_html_invoke, p, NULL);
 260     Tcl_CreateCommand (p->interp, "htmlr", proc_htmlr_invoke, p, NULL);
 261     Tcl_CreateCommand (p->interp, "wform", proc_wform_invoke, p, NULL);
 262     Tcl_CreateCommand (p->interp, "wabort", proc_wabort_invoke, p, NULL);
 263     Tcl_CreateCommand (p->interp, "wflush", proc_wflush_invoke, p, NULL);
 264     Tcl_CreateCommand (p->interp, "wlog", proc_wlog_invoke, p, NULL);
 265     sprintf (tmp_str, "%d", wcl->id);
 266     Tcl_SetVar (p->interp, "sessionId", tmp_str, TCL_GLOBAL_ONLY);
 267     return p;
 268 }
 269
 270 static void report_error (struct tcl_info *p, int errorLine,
 271                           const char *pre, const char *msg)
 272 {
 273     gw_log (GW_LOG_WARN, mod, "%s %d %s", pre, errorLine, msg);
 274     wo_printf (p->wcl, "\n<br><hr>\n<strong>"
 275                "%s %d</strong><br>\n", pre, errorLine);
 276     wo_printf (p->wcl, "<xmp>\n%s</xmp>\n<hr>\n", msg);
 277 }
 278
 279 static int tcl_exec (const char *fname, char *parms,
 280                      struct tcl_info *p, FILE *inf, int *lineno)
 281 {
 282     int c, escape = 0, level = 0;
 283     int r, fbuf_ptr = 0;
 284     int local_line = 0;
 285
 286     while (1)
 287     {
 288         if (fbuf_ptr == p->fbuf_size-1)
 289         {
 290             char *newb;
 291
 292             if (!(newb = malloc (p->fbuf_size += 16384)))
 293             {
 294                 gw_log (GW_LOG_FATAL|GW_LOG_ERRNO, mod, "malloc: fbuf");
 295                 exit (1);
 296             }
 297             memcpy (newb, p->fbuf, fbuf_ptr);
 298             free (p->fbuf);
 299             p->fbuf = newb;
 300         }
 301         c = getc (inf);
 302         if (c == EOF)
 303         {
 304             report_error (p, *lineno, "Error in Tcl script starting at line",
 305                                       "Unexpected EOF (missing right brace)");
 306             return TCL_ERROR;
 307         }
 308         if (c == '\\')
 309             escape = 1;
 310         else if (c == '{' && !escape)
 311         {
 312             level++;
 313             escape = 0;
 314         }
 315         else if (c == '}' && !escape)
 316         {
 317             if (--level < 0)
 318                 break;
 319             escape = 0;
 320         }
 321         else
 322         {
 323             if (c == '\n')
 324                 local_line++;
 325             escape = 0;
 326         }
 327         p->fbuf[fbuf_ptr++] = c;
 328     }
 329     p->fbuf[fbuf_ptr] = '\0';
 330     p->wabort = 0;
 331     r = Tcl_Eval (p->interp, p->fbuf);
 332     if (r == TCL_ERROR)
 333         report_error (p, p->interp->errorLine + *lineno - 1,
 334                       "Error in Tcl script in line",
 335                       Tcl_GetVar (p->interp, "errorInfo", 0));
 336     (*lineno) += local_line;
 337     if (p->wabort)
 338         return TCL_RETURN;
 339     return r;
 340 }
 341
 342 static int do_exec (const char *fname, char *parms, void *mydata)
 343 {
 344     struct tcl_info *p = mydata;
 345     int c, escape = 0;
 346     int lineno = 1;
 347     FILE *inf = fopen (fname, "r");
 348
 349     gw_log (GW_LOG_DEBUG, mod, "Executing %s", fname);
 350     if (!inf)
 351     {
 352         gw_log (GW_LOG_WARN|GW_LOG_ERRNO, mod, "open %s", fname);
 353         return -1;
 354     }
 355     Tcl_SetVar (p->interp, "sessionParms", parms, TCL_GLOBAL_ONLY);
 356     while ((c = getc(inf)) != EOF)
 357     {
 358         if (c == '\\')
 359             escape = 1;
 360         else if (c == '{')
 361         {
 362             if (escape)
 363                 wo_putc (p->wcl, c);
 364             else
 365             {
 366                 int r = tcl_exec (fname, parms, p, inf, &lineno);
 367                 if (r == TCL_RETURN)
 368                 {
 369                     fclose (inf);
 370                     return 0;
 371                 }
 372                 else if (r == TCL_ERROR)
 373                 {
 374                     fclose (inf);
 375                     return -2;
 376                 }
 377             }
 378             escape = 0;
 379         }
 380         else
 381         {
 382             if (c == '\n')
 383                 lineno++;
 384             escape = 0;
 385             wo_putc (p->wcl, c);
 386         }
 387     }
 388     fclose (inf);
 389     return 0;
 390 }
 391
 392
 393 static int do_load (char *parms, void *mydata)
 394 {
 395     struct tcl_info *p = mydata;
 396     char fname[80];
 397     int r;
 398
 399     sprintf (fname, "tcl.state.%d", p->wcl->id);
 400     r = Tcl_EvalFile (p->interp, fname);
 401     if (r == TCL_ERROR)
 402         report_error (p, p->interp->errorLine,
 403                       "Error in Tcl loadState in line",
 404                       Tcl_GetVar (p->interp, "errorInfo", 0));
 405     return 0;
 406 }
 407
 408 static int do_save (char *parms, void *mydata)
 409 {
 410     struct tcl_info *p = mydata;
 411     struct Tcl_CmdInfo cinfo;
 412
 413     if (Tcl_GetCommandInfo(p->interp, "saveState", &cinfo))
 414     {
 415         int r;
 416
 417         gw_log (GW_LOG_DEBUG, mod, "saveState");
 418         r = Tcl_Eval (p->interp, "saveState\n");
 419         if (r == TCL_ERROR)
 420             report_error (p, p->interp->errorLine,
 421                           "Error in Tcl saveState in line",
 422                           Tcl_GetVar (p->interp, "errorInfo", 0));
 423     }
 424     return 0;
 425 }
 426