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.5  1995/10/30 17:35:18  adam
  45  * New function zwait that waits for a variable change - due to i/o events
  46  * that invoke callback routines.
  47  *
  48  * Revision 1.4  1995/10/27  17:30:16  adam
  49  * First search request/response that works.
  50  *
  51  * Revision 1.3  1995/10/27  15:12:14  adam
  52  * IrTcl incorporated in the gateway.
  53  * Better separation of script types.
  54  * Z39.50 gateway scripts entered.
  55  *
  56  * Revision 1.2  1995/10/23  16:55:43  adam
  57  * A lot of changes - really.
  58  *
  59  * Revision 1.1  1995/10/20  14:02:42  adam
  60  * First version of WWW gateway with embedded Tcl.
  61  *
  62  */
  63
  64 #include <stdio.h>
  65 #include <stdlib.h>
  66 #include <string.h>
  67 #include <assert.h>
  68 #include <ctype.h>
  69
  70 #include "wtcl.h"
  71
  72 static void *do_create (WCLIENT wcl, void *args);
  73 static int do_exec (const char *fname, char *parms, void *mydata);
  74
  75 static struct w_interp_type w_interp_t = {
  76     "tcl",
  77     do_create,
  78     do_exec
  79 };
  80
  81 W_Interp_Type w_interp_tcl = &w_interp_t;
  82
  83
  84 static char *mod = "wtcl";
  85
  86 struct tcl_info {
  87     Tcl_Interp *interp;
  88     char  *fbuf;
  89     int    fbuf_size;
  90     int    fbuf_ptr;
  91     WCLIENT wcl;
  92 };
  93
  94 Tcl_Interp *w_interp_tcl_get (W_Interp w_interp)
  95 {
  96     struct tcl_info *p;
  97
  98     if (strcmp (w_interp->ctrl->name, "tcl"))
  99     {
 100         gw_log (GW_LOG_FATAL, mod, "Internal failure");
 101         assert (0);
 102     }
 103     p = (struct tcl_info*) w_interp->mydata;
 104     return p->interp;
 105 }
 106
 107 static int proc_html_invoke (ClientData clientData, Tcl_Interp *interp,
 108                              int argc, char **argv)
 109 {
 110     struct tcl_info *p = (struct tcl_info*) clientData;
 111     int i;
 112
 113     for (i = 1; i<argc; i++)
 114         wo_puts (p->wcl, argv[i]);
 115     return TCL_OK;
 116 }
 117
 118 static int proc_htmlr_invoke (ClientData clientData, Tcl_Interp *interp,
 119                               int argc, char **argv)
 120 {
 121     struct tcl_info *p = (struct tcl_info*) clientData;
 122     int r;
 123
 124     r = proc_html_invoke (clientData, interp, argc, argv);
 125     wo_putc (p->wcl, '\n');
 126     return r;
 127 }
 128
 129 static int proc_form_invoke (ClientData clientData, Tcl_Interp *interp,
 130                              int argc, char **argv)
 131 {
 132     struct tcl_info *p = (struct tcl_info*) clientData;
 133     int i;
 134     if (argc == 2)
 135     {
 136         Tcl_AppendResult (p->interp, wgetval (p->wcl, argv[1]), NULL);
 137         return TCL_OK;
 138     }
 139     for (i = 0; *p->wcl->wf_data[i].name; i++)
 140     {
 141         Tcl_AppendResult (p->interp, "{ ", NULL);
 142         Tcl_AppendElement (p->interp, p->wcl->wf_data[i].name);
 143         Tcl_AppendElement (p->interp, p->wcl->wf_data[i].value);
 144         Tcl_AppendResult (p->interp, " }\n", NULL);
 145     }
 146     return TCL_OK;
 147 }
 148
 149 int Tcl_AppInit (Tcl_Interp *interp)
 150 {
 151     if (Tcl_Init (interp) == TCL_ERROR)
 152         return TCL_ERROR;
 153     return TCL_OK;
 154 }
 155
 156 static void *do_create (WCLIENT wcl, void *args)
 157 {
 158     struct tcl_info *p;
 159     char tmp_str[256];
 160
 161     if (!(p = malloc (sizeof(*p))))
 162     {
 163         gw_log (GW_LOG_FATAL|GW_LOG_ERRNO, mod, "malloc: tcl_info");
 164         exit (1);
 165     }
 166     if (!(p->interp = Tcl_CreateInterp ()))
 167     {
 168         gw_log (GW_LOG_FATAL, mod, "Cannot make Tcl_Interp");
 169         exit (1);
 170     }
 171     p->wcl = wcl;
 172     p->fbuf_size = 1024;
 173     if (!(p->fbuf = malloc (p->fbuf_size)))
 174     {
 175         gw_log (GW_LOG_FATAL|GW_LOG_ERRNO, mod, "malloc: tcl_info fbuf");
 176         exit (1);
 177     }
 178     Tcl_AppInit (p->interp);
 179     Tcl_CreateCommand (p->interp, "html", proc_html_invoke, p, NULL);
 180     Tcl_CreateCommand (p->interp, "htmlr", proc_htmlr_invoke, p, NULL);
 181     Tcl_CreateCommand (p->interp, "form", proc_form_invoke, p, NULL);
 182     sprintf (tmp_str, "%d", wcl->id);
 183     Tcl_SetVar (p->interp, "sessionId", tmp_str, TCL_GLOBAL_ONLY);
 184     return p;
 185 }
 186
 187 static void report_error (struct tcl_info *p, int errorLine,
 188                           const char *pre, const char *msg)
 189 {
 190     gw_log (GW_LOG_WARN, mod, "%s %d %s", pre, errorLine, msg);
 191     wo_printf (p->wcl, "\n<br><hr>\n<strong>"
 192                "%s %d</strong><br>\n", pre, errorLine);
 193     wo_printf (p->wcl, "<xmp>\n%s</xmp>\n<hr>\n", msg);
 194 }
 195
 196 static int tcl_exec (const char *fname, char *parms,
 197                      struct tcl_info *p, FILE *inf, int *lineno)
 198 {
 199     int c, escape = 0, level = 0;
 200     int r, fbuf_ptr = 0;
 201     int local_line = 0;
 202
 203     while (1)
 204     {
 205         if (fbuf_ptr == p->fbuf_size-1)
 206         {
 207             char *newb;
 208
 209             if (!(newb = malloc (p->fbuf_size += 16384)))
 210             {
 211                 gw_log (GW_LOG_FATAL|GW_LOG_ERRNO, mod, "malloc: fbuf");
 212                 exit (1);
 213             }
 214             memcpy (newb, p->fbuf, fbuf_ptr);
 215             free (p->fbuf);
 216             p->fbuf = newb;
 217         }
 218         c = getc (inf);
 219         if (c == EOF)
 220         {
 221             report_error (p, *lineno, "Error in Tcl script starting at line",
 222                                       "Unexpected EOF (missing right brace)");
 223             return TCL_ERROR;
 224         }
 225         if (c == '\\')
 226             escape = 1;
 227         else if (c == '{' && !escape)
 228         {
 229             level++;
 230             escape = 0;
 231         }
 232         else if (c == '}' && !escape)
 233         {
 234             if (--level < 0)
 235                 break;
 236             escape = 0;
 237         }
 238         else
 239         {
 240             if (c == '\n')
 241                 local_line++;
 242             escape = 0;
 243         }
 244         p->fbuf[fbuf_ptr++] = c;
 245     }
 246     p->fbuf[fbuf_ptr] = '\0';
 247     r = Tcl_Eval (p->interp, p->fbuf);
 248     if (r == TCL_ERROR)
 249         report_error (p, p->interp->errorLine + *lineno - 1,
 250                       "Error in Tcl script in line",
 251                       Tcl_GetVar (p->interp, "errorInfo", 0));
 252     (*lineno) += local_line;
 253     return r;
 254 }
 255
 256 static int do_exec (const char *fname, char *parms, void *mydata)
 257 {
 258     struct tcl_info *p = mydata;
 259     int c, escape = 0;
 260     int lineno = 1;
 261     FILE *inf = fopen (fname, "r");
 262
 263     gw_log (GW_LOG_DEBUG, mod, "Executing %s", fname);
 264     if (!inf)
 265     {
 266         gw_log (GW_LOG_WARN|GW_LOG_ERRNO, mod, "open %s", fname);
 267         return -1;
 268     }
 269     Tcl_SetVar (p->interp, "sessionParms", parms, TCL_GLOBAL_ONLY);
 270     while ((c = getc(inf)) != EOF)
 271     {
 272         if (c == '\\')
 273             escape = 1;
 274         else if (c == '{')
 275         {
 276             if (escape)
 277                 wo_putc (p->wcl, c);
 278             else
 279             {
 280                 int r = tcl_exec (fname, parms, p, inf, &lineno);
 281                 if (r == TCL_RETURN)
 282                 {
 283                     fclose (inf);
 284                     return 0;
 285                 }
 286                 else if (r == TCL_ERROR)
 287                 {
 288                     fclose (inf);
 289                     return -2;
 290                 }
 291             }
 292             escape = 0;
 293         }
 294         else
 295         {
 296             if (c == '\n')
 297                 lineno++;
 298             escape = 0;
 299             wo_putc (p->wcl, c);
 300         }
 301     }
 302     fclose (inf);
 303     return 0;
 304 }