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