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