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.18  1997/01/24 13:13:13  adam
  45  * Implemnted egw_source and added a "raw" option to the URL.
  46  * Fixed a bug in the buffering system of wproto; the macro wo_putc could
  47  * override memory if it was the first HTML generating function called.
  48  *
  49  * Revision 1.17  1996/05/31 08:02:56  adam
  50  * Bug fix: egw_enc encoded '/' - it shouldn't.
  51  *
  52  * Revision 1.16  1996/05/23 15:53:12  adam
  53  * Bug fix: egw_enc failed on 8-bit chars.
  54  * New command: egw_parms.
  55  *
  56  * Revision 1.15  1996/05/22  16:50:27  adam
  57  * Bug fix.
  58  *
  59  * Revision 1.14  1996/05/21  14:53:04  adam
  60  * Tcl command wform extented; options -raw and -exists added.
  61  *
  62  * Revision 1.13  1996/03/14  11:48:40  adam
  63  * New function egw_prog that returns name of shell.
  64  *
  65  * Revision 1.12  1996/03/07  12:45:34  adam
  66  * New Tcl calls egw_enc/egw_dec to encode/decode binary URL info.
  67  *
  68  * Revision 1.11  1996/01/24  08:26:56  adam
  69  * All tcl commands prefixed with egw_ (except the html command).
  70  *
  71  * Revision 1.10  1995/11/08  16:14:35  adam
  72  * Many improvements and bug fixes.
  73  * First version that ran on dtbsun.
  74  *
  75  * Revision 1.9  1995/11/07  14:57:00  adam
  76  * Work on search in multiple targets.
  77  * New wtcl command: wlog.
  78  * Optional timeout parameter to zwait.
  79  *
  80  * Revision 1.8  1995/11/06  17:44:23  adam
  81  * State reestablised when shell restarts. History of previous
  82  * result sets.
  83  *
  84  * Revision 1.7  1995/10/31  16:56:25  adam
  85  * Record presentation.
  86  *
  87  * Revision 1.6  1995/10/31  10:03:54  adam
  88  * Work on queries.
  89  * New command implemented - aborts script.
  90  *
  91  * Revision 1.5  1995/10/30  17:35:18  adam
  92  * New function zwait that waits for a variable change - due to i/o events
  93  * that invoke callback routines.
  94  *
  95  * Revision 1.4  1995/10/27  17:30:16  adam
  96  * First search request/response that works.
  97  *
  98  * Revision 1.3  1995/10/27  15:12:14  adam
  99  * IrTcl incorporated in the gateway.
 100  * Better separation of script types.
 101  * Z39.50 gateway scripts entered.
 102  *
 103  * Revision 1.2  1995/10/23  16:55:43  adam
 104  * A lot of changes - really.
 105  *
 106  * Revision 1.1  1995/10/20  14:02:42  adam
 107  * First version of WWW gateway with embedded Tcl.
 108  *
 109  */
 110
 111 #include <stdio.h>
 112 #include <stdlib.h>
 113 #include <string.h>
 114 #include <assert.h>
 115 #include <ctype.h>
 116
 117 #include "wtcl.h"
 118
 119 static void *do_create (WCLIENT wcl, void *args);
 120 static int do_exec (const char *fname, char *parms, void *mydata);
 121 static int do_load (char *parms, void *mydata);
 122 static int do_save (char *parms, void *mydata);
 123
 124 static struct w_interp_type w_interp_t = {
 125     "tcl",
 126     do_create,
 127     do_exec,
 128     do_load,
 129     do_save
 130 };
 131
 132 W_Interp_Type w_interp_tcl = &w_interp_t;
 133
 134
 135 static char *mod = "wtcl";
 136
 137 struct tcl_info {
 138     Tcl_Interp *interp;
 139     char  *fbuf;
 140     int    fbuf_size;
 141     int    fbuf_ptr;
 142     int    wabort;
 143     WCLIENT wcl;
 144 };
 145
 146 static int exec_file (const char *fname, struct tcl_info *p);
 147
 148 Tcl_Interp *w_interp_tcl_get (W_Interp w_interp)
 149 {
 150     struct tcl_info *p;
 151
 152     if (strcmp (w_interp->ctrl->name, "tcl"))
 153     {
 154         gw_log (GW_LOG_FATAL, mod, "Internal failure");
 155         assert (0);
 156     }
 157     p = (struct tcl_info*) w_interp->mydata;
 158     return p->interp;
 159 }
 160
 161 static int proc_wabort_invoke (ClientData clientData, Tcl_Interp *interp,
 162                                int argc, char **argv)
 163 {
 164     struct tcl_info *p = (struct tcl_info*) clientData;
 165
 166     p->wabort = 1;
 167     if (argc > 1)
 168         Tcl_AppendResult (interp, argv[1], NULL);
 169     return TCL_RETURN;
 170 }
 171
 172 static int proc_wflush_invoke (ClientData clientData, Tcl_Interp *interp,
 173                                int argc, char **argv)
 174 {
 175     struct tcl_info *p = (struct tcl_info*) clientData;
 176
 177     wo_flush (p->wcl);
 178     return TCL_OK;
 179 }
 180
 181 static int proc_html_invoke (ClientData clientData, Tcl_Interp *interp,
 182                              int argc, char **argv)
 183 {
 184     struct tcl_info *p = (struct tcl_info*) clientData;
 185     int i;
 186
 187     for (i = 1; i<argc; i++)
 188         wo_write (p->wcl, argv[i], strlen(argv[i]));
 189     return TCL_OK;
 190 }
 191
 192 static int proc_form_invoke (struct tcl_info *p, wform_data *wfdata,
 193                              Tcl_Interp *interp,
 194                              int argc, char **argv)
 195 {
 196     const char *arg = NULL;
 197     int failFlag = 0;
 198     int i;
 199
 200     if (argc == 3)
 201     {
 202         if (!strcmp (argv[1], "-raw"))
 203         {
 204             interp->result = p->wcl->raw_data;
 205             return TCL_OK;
 206         }
 207         else if (!strcmp (argv[1], "-exists"))
 208         {
 209             failFlag = 1;
 210             arg = argv[2];
 211         }
 212         else
 213         {
 214             Tcl_AppendResult (p->interp, "bad option to ", argv[0],
 215                               " \"", argv[1], "\"", NULL);
 216             return TCL_ERROR;
 217         }
 218     }
 219     else if (argc == 2)
 220         arg = argv[1];
 221     if (arg)
 222     {
 223         for (i = 0; *wfdata[i].name; i++)
 224             if (!strcmp (arg, wfdata[i].name))
 225             {
 226                 failFlag = 0;
 227                 if (*wfdata[i].value)
 228                     Tcl_AppendElement (p->interp, wfdata[i].value);
 229             }
 230         if (failFlag)
 231         {
 232             Tcl_AppendResult (p->interp, arg, " doesn't exist", NULL);
 233             return TCL_ERROR;
 234         }
 235         return TCL_OK;
 236     }
 237     for (i = 0; *wfdata[i].name; i++)
 238     {
 239         Tcl_AppendResult (p->interp, "{ ", NULL);
 240         Tcl_AppendElement (p->interp, wfdata[i].name);
 241         Tcl_AppendElement (p->interp, wfdata[i].value);
 242         Tcl_AppendResult (p->interp, " }\n", NULL);
 243     }
 244     return TCL_OK;
 245 }
 246
 247 static int proc_wform_invoke (ClientData clientData, Tcl_Interp *interp,
 248                               int argc, char **argv)
 249 {
 250     struct tcl_info *p = (struct tcl_info*) clientData;
 251     wform_data *wfdata = p->wcl->wf_data;
 252     return proc_form_invoke (p, wfdata, interp, argc, argv);
 253 }
 254
 255 static int proc_parms_invoke (ClientData clientData, Tcl_Interp *interp,
 256                               int argc, char **argv)
 257 {
 258     struct tcl_info *p = (struct tcl_info*) clientData;
 259     wform_data *wfdata = p->wcl->wf_parms_var;
 260     return proc_form_invoke (p, wfdata, interp, argc, argv);
 261 }
 262
 263
 264 static int proc_wlog_invoke (ClientData clientData, Tcl_Interp *interp,
 265                              int argc, char **argv)
 266 {
 267     unsigned mask;
 268
 269     if (argc < 3)
 270         return TCL_OK;
 271     if (!strcmp (argv[1], "debug"))
 272         mask = GW_LOG_DEBUG;
 273     else if (!strcmp (argv[1], "fatal"))
 274         mask = GW_LOG_FATAL;
 275     else if (!strcmp (argv[1], "warn"))
 276         mask = GW_LOG_WARN;
 277     else if (!strcmp (argv[1], "acct"))
 278         mask = GW_LOG_ACCT;
 279     else
 280         mask = GW_LOG_DEBUG;
 281     switch (argc)
 282     {
 283     case 3:
 284         gw_log (mask, mod, "%s", argv[2]);
 285         break;
 286     case 4:
 287         gw_log (mask, mod, "%s %s", argv[2], argv[3]);
 288         break;
 289     case 5:
 290         gw_log (mask, mod, "%s %s %s", argv[2], argv[3], argv[4]);
 291         break;
 292     case 6:
 293         gw_log (mask, mod, "%s %s %s %s", argv[2], argv[3], argv[4], argv[5]);
 294         break;
 295     }
 296     return TCL_OK;
 297 }
 298
 299 static int proc_enc (ClientData clientData, Tcl_Interp *interp,
 300                      int argc, char **argv)
 301 {
 302     int i;
 303     char buf1[6];
 304     char buf2[2];
 305
 306     buf1[0] = '%';
 307     buf2[1] = '\0';
 308     for (i = 1; i<argc; i++)
 309     {
 310         const char *cp = argv[i];
 311         while (*cp)
 312         {
 313             if (*cp < ' ' || *cp >= 127 || *cp == '&' || *cp == '?'
 314                 || *cp == '%' || *cp == '+')
 315             {
 316                 sprintf (buf1+1, "%02X", *cp & 0xff);
 317                 Tcl_AppendResult (interp, buf1, NULL);
 318             }
 319             else if (*cp == ' ')
 320             {
 321                 Tcl_AppendResult (interp, "+", NULL);
 322             }
 323             else
 324             {
 325                 buf2[0] = *cp;
 326                 Tcl_AppendResult (interp, buf2, NULL);
 327             }
 328             cp++;
 329         }
 330     }
 331     return TCL_OK;
 332 }
 333
 334 static int proc_dec (ClientData clientData, Tcl_Interp *interp,
 335                      int argc, char **argv)
 336 {
 337     int i;
 338     unsigned val;
 339     char buf[2];
 340
 341     buf[1] = '\0';
 342     for (i = 1; i<argc; i++)
 343     {
 344         const char *cp = argv[i];
 345         while (*cp)
 346         {
 347             if (*cp == '%' && cp[1] && cp[2])
 348             {
 349                 if (cp[1] >= 'A')
 350                     val = cp[1] - 'A'+10;
 351                 else
 352                     val = cp[1] - '0';
 353
 354
 355                 if (cp[2] >= 'A')
 356                     val = val*16 + (cp[2] - 'A'+10);
 357                 else
 358                     val = val*16 + (cp[2] - '0');
 359                 buf[0] = val;
 360                 cp += 3;
 361             }
 362             else
 363                 buf[0] = *cp++;
 364             Tcl_AppendResult (interp, buf, NULL);
 365         }
 366     }
 367     return TCL_OK;
 368 }
 369
 370 static int proc_prog (ClientData clientData, Tcl_Interp *interp,
 371                       int argc, char **argv)
 372 {
 373     struct tcl_info *p = (struct tcl_info*) clientData;
 374
 375     Tcl_AppendResult (p->interp, p->wcl->prog, NULL);
 376     return TCL_OK;
 377 }
 378
 379 static int proc_source (ClientData clientData, Tcl_Interp *interp,
 380                         int argc, char **argv)
 381 {
 382     struct tcl_info *p = (struct tcl_info*) clientData;
 383     int r;
 384
 385     if (argc != 2)
 386     {
 387         Tcl_AppendResult (p->interp,
 388                           "wrong # args: should be egw_source file", NULL);
 389         return TCL_ERROR;
 390     }
 391     r = exec_file (argv[1], p);
 392     if (r == -2)
 393     {
 394         Tcl_AppendResult (p->interp, "egw_source: couldn't source ",
 395                           argv[1], NULL);
 396         return TCL_ERROR;
 397     }
 398     else if (r == -1)
 399     {
 400         Tcl_AppendResult (p->interp, "egw_source: Tcl error in script ",
 401                           argv[1], NULL);
 402         return TCL_ERROR;
 403     }
 404     return TCL_OK;
 405 }
 406
 407
 408 int Tcl_AppInit (Tcl_Interp *interp)
 409 {
 410     if (Tcl_Init (interp) == TCL_ERROR)
 411         return TCL_ERROR;
 412     return TCL_OK;
 413 }
 414
 415 static void *do_create (WCLIENT wcl, void *args)
 416 {
 417     struct tcl_info *p;
 418     char tmp_str[256];
 419
 420     if (!(p = malloc (sizeof(*p))))
 421     {
 422         gw_log (GW_LOG_FATAL|GW_LOG_ERRNO, mod, "malloc: tcl_info");
 423         exit (1);
 424     }
 425     if (!(p->interp = Tcl_CreateInterp ()))
 426     {
 427         gw_log (GW_LOG_FATAL, mod, "Cannot make Tcl_Interp");
 428         exit (1);
 429     }
 430     p->wcl = wcl;
 431     p->fbuf_size = 1024;
 432     if (!(p->fbuf = malloc (p->fbuf_size)))
 433     {
 434         gw_log (GW_LOG_FATAL|GW_LOG_ERRNO, mod, "malloc: tcl_info fbuf");
 435         exit (1);
 436     }
 437     Tcl_AppInit (p->interp);
 438     Tcl_CreateCommand (p->interp, "html", proc_html_invoke, p, NULL);
 439     Tcl_CreateCommand (p->interp, "egw_form", proc_wform_invoke, p, NULL);
 440     Tcl_CreateCommand (p->interp, "egw_parms", proc_parms_invoke, p, NULL);
 441     Tcl_CreateCommand (p->interp, "egw_abort", proc_wabort_invoke, p, NULL);
 442     Tcl_CreateCommand (p->interp, "egw_flush", proc_wflush_invoke, p, NULL);
 443     Tcl_CreateCommand (p->interp, "egw_log", proc_wlog_invoke, p, NULL);
 444     Tcl_CreateCommand (p->interp, "egw_enc", proc_enc, p, NULL);
 445     Tcl_CreateCommand (p->interp, "egw_dec", proc_dec, p, NULL);
 446     Tcl_CreateCommand (p->interp, "egw_prog", proc_prog, p, NULL);
 447     Tcl_CreateCommand (p->interp, "egw_source", proc_source, p, NULL);
 448     sprintf (tmp_str, "%d", wcl->id);
 449     Tcl_SetVar (p->interp, "sessionId", tmp_str, TCL_GLOBAL_ONLY);
 450     return p;
 451 }
 452
 453 static void report_error (struct tcl_info *p, int errorLine,
 454                           const char *pre, const char *msg)
 455 {
 456     if (!msg)
 457         msg = "";
 458     gw_log (GW_LOG_WARN, mod, "%s %d %s", pre, errorLine, msg);
 459     wo_printf (p->wcl, "\n<br><hr>\n<strong>"
 460                "%s %d</strong><br>\n", pre, errorLine);
 461     wo_printf (p->wcl, "<xmp>\n%s</xmp>\n<hr>\n", msg);
 462 }
 463
 464 static int tcl_exec (const char *fname, struct tcl_info *p, FILE *inf,
 465                      int *lineno)
 466 {
 467     int c, escape = 0, level = 0;
 468     int r, fbuf_ptr = 0;
 469     int local_line = 0;
 470
 471     while (1)
 472     {
 473         if (fbuf_ptr == p->fbuf_size-1)
 474         {
 475             char *newb;
 476
 477             if (!(newb = malloc (p->fbuf_size += 16384)))
 478             {
 479                 gw_log (GW_LOG_FATAL|GW_LOG_ERRNO, mod, "malloc: fbuf");
 480                 exit (1);
 481             }
 482             memcpy (newb, p->fbuf, fbuf_ptr);
 483             free (p->fbuf);
 484             p->fbuf = newb;
 485         }
 486         c = getc (inf);
 487         if (c == EOF)
 488         {
 489             report_error (p, *lineno, "Error in Tcl script starting at line",
 490                                       "Unexpected EOF (missing right brace)");
 491             return TCL_ERROR;
 492         }
 493         if (c == '\\')
 494             escape = 1;
 495         else if (c == '{' && !escape)
 496         {
 497             level++;
 498             escape = 0;
 499         }
 500         else if (c == '}' && !escape)
 501         {
 502             if (--level < 0)
 503                 break;
 504             escape = 0;
 505         }
 506         else
 507         {
 508             if (c == '\n')
 509                 local_line++;
 510             escape = 0;
 511         }
 512         p->fbuf[fbuf_ptr++] = c;
 513     }
 514     p->fbuf[fbuf_ptr] = '\0';
 515     p->wabort = 0;
 516     r = Tcl_Eval (p->interp, p->fbuf);
 517     if (r == TCL_ERROR)
 518         report_error (p, p->interp->errorLine + *lineno - 1,
 519                       "Error in Tcl script in line",
 520                       Tcl_GetVar (p->interp, "errorInfo", 0));
 521     (*lineno) += local_line;
 522     if (p->wabort)
 523         return TCL_RETURN;
 524     return r;
 525 }
 526
 527 static int exec_file (const char *fname, struct tcl_info *p)
 528 {
 529     int c, escape = 0;
 530     int lineno = 1;
 531     FILE *inf = fopen (fname, "r");
 532
 533     gw_log (GW_LOG_DEBUG, mod, "Executing %s", fname);
 534     if (!inf)
 535     {
 536         gw_log (GW_LOG_WARN|GW_LOG_ERRNO, mod, "open %s", fname);
 537         return -1;
 538     }
 539     while ((c = getc(inf)) != EOF)
 540     {
 541         if (c == '\\')
 542             escape = 1;
 543         else if (c == '{')
 544         {
 545             if (escape)
 546                 wo_putc (p->wcl, c);
 547             else
 548             {
 549                 int r = tcl_exec (fname, p, inf, &lineno);
 550                 if (r == TCL_RETURN)
 551                 {
 552                     fclose (inf);
 553                     return 0;
 554                 }
 555                 else if (r == TCL_ERROR)
 556                 {
 557                     fclose (inf);
 558                     return -2;
 559                 }
 560             }
 561             escape = 0;
 562         }
 563         else
 564         {
 565             if (c == '\n')
 566                 lineno++;
 567             escape = 0;
 568             wo_putc (p->wcl, c);
 569         }
 570     }
 571     fclose (inf);
 572     return 0;
 573 }
 574
 575 static int do_exec (const char *fname, char *parms, void *mydata)
 576 {
 577     struct tcl_info *p = mydata;
 578
 579     Tcl_SetVar (p->interp, "sessionParms", parms, TCL_GLOBAL_ONLY);
 580     return exec_file (fname, p);
 581 }
 582
 583 static int do_load (char *parms, void *mydata)
 584 {
 585     struct tcl_info *p = mydata;
 586     char fname[80];
 587     int r;
 588
 589     sprintf (fname, "tcl.state.%d", p->wcl->id);
 590     r = Tcl_EvalFile (p->interp, fname);
 591     if (r == TCL_ERROR)
 592         gw_log (GW_LOG_WARN, mod, "Cannot load Tcl state" );
 593     return 0;
 594 }
 595
 596 static int do_save (char *parms, void *mydata)
 597 {
 598     struct tcl_info *p = mydata;
 599     struct Tcl_CmdInfo cinfo;
 600
 601     if (Tcl_GetCommandInfo(p->interp, "saveState", &cinfo))
 602     {
 603         int r;
 604
 605         gw_log (GW_LOG_DEBUG, mod, "saveState");
 606         r = Tcl_Eval (p->interp, "saveState\n");
 607         if (r == TCL_ERROR)
 608             report_error (p, p->interp->errorLine,
 609                           "Error in Tcl saveState in line",
 610                           Tcl_GetVar (p->interp, "errorInfo", 0));
 611     }
 612     return 0;
 613 }
 614