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