www/wirtcl.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: wirtcl.c,v $
  44  * Revision 1.13  1996/01/24 08:26:54  adam
  45  * All tcl commands prefixed with egw_ (except the html command).
  46  *
  47  * Revision 1.12  1996/01/12  10:05:18  adam
  48  * If script name ends with ';' HTTP/GET/Expires will be defined.
  49  * The cgi interface only reads final handshake if response from
  50  * server (shell) was zero-terminated [If it isn't it probably died].
  51  *
  52  * Revision 1.11  1996/01/09  16:16:49  adam
  53  * Port to OSF/1. Gif references moved from /gif/ to /egwgif/.
  54  *
  55  * Revision 1.10  1996/01/09  10:46:50  adam
  56  * New defines: LOGDIR/EGWDIR/CGIDIR set in Makefile.
  57  *
  58  * Revision 1.9  1995/11/07  14:56:59  adam
  59  * Work on search in multiple targets.
  60  * New wtcl command: wlog.
  61  * Optional timeout parameter to zwait.
  62  *
  63  * Revision 1.8  1995/11/06  17:44:22  adam
  64  * State reestablised when shell restarts. History of previous
  65  * result sets.
  66  *
  67  * Revision 1.7  1995/11/02  16:35:37  adam
  68  * Bug fixes and select on FIFOs in wcgi - doesn't really work!
  69  *
  70  * Revision 1.6  1995/11/01  16:15:47  adam
  71  * Better presentation of records. Query/set number persistent.
  72  *
  73  * Revision 1.5  1995/10/31  16:56:24  adam
  74  * Record presentation.
  75  *
  76  * Revision 1.4  1995/10/31  10:03:53  adam
  77  * Work on queries.
  78  * New command implemented - aborts script.
  79  *
  80  * Revision 1.3  1995/10/30  17:35:18  adam
  81  * New function zwait that waits for a variable change - due to i/o events
  82  * that invoke callback routines.
  83  *
  84  * Revision 1.2  1995/10/27  17:30:16  adam
  85  * First search request/response that works.
  86  *
  87  * Revision 1.1  1995/10/27  15:12:08  adam
  88  * IrTcl incorporated in the gateway.
  89  * Better separation of script types.
  90  * Z39.50 gateway scripts entered.
  91  *
  92  */
  93
  94 #include <stdio.h>
  95 #include <stdlib.h>
  96 #include <unistd.h>
  97 #include <sys/time.h>
  98 #include <sys/types.h>
  99 #ifdef AIX
 100 #include <sys/select.h>
 101 #endif
 102 #include <string.h>
 103 #include <assert.h>
 104 #include <ctype.h>
 105
 106 #include <log.h>
 107 #include "wtcl.h"
 108 #include "wirtcl.h"
 109
 110 static void *do_create (WCLIENT wcl, void *args);
 111 static int do_exec (const char *fname, char *parms, void *mydata);
 112 static int do_load (char *parms, void *mydata);
 113 static int do_save (char *parms, void *mydata);
 114
 115 static struct w_interp_type w_interp_t = {
 116     "irtcl",
 117     do_create,
 118     do_exec,
 119     do_load,
 120     do_save
 121 };
 122
 123 W_Interp_Type w_interp_irtcl = &w_interp_t;
 124
 125
 126 static char *mod = "wirtcl";
 127
 128 struct tcl_info {
 129     W_Interp w_interp;
 130     Tcl_Interp *interp;
 131     WCLIENT wcl;
 132 };
 133
 134
 135 static int events (struct tcl_info *p, char *waitVar, int tout);
 136
 137 static int proc_zwait_invoke (ClientData clientData, Tcl_Interp *interp,
 138                               int argc, char **argv)
 139 {
 140     struct tcl_info *p = (struct tcl_info*) clientData;
 141
 142     if (argc < 2)
 143         return TCL_OK;
 144     return events (p, argv[1], (argc == 3) ? atoi(argv[2]) : 0);
 145 }
 146
 147
 148
 149 /* select(2) callbacks */
 150 struct callback {
 151     void (*r_handle)(ClientData);
 152     void (*w_handle)(ClientData);
 153     void (*x_handle)(ClientData);
 154     void *obj;
 155 };
 156 #define MAX_CALLBACK 200
 157
 158 static struct callback callback_table[MAX_CALLBACK];
 159 static int max_fd = 3;            /* don't worry: it will grow... */
 160
 161 static void *do_create (WCLIENT wcl, void *args)
 162 {
 163     struct tcl_info *p;
 164     int i;
 165
 166     if (!(p = malloc (sizeof(*p))))
 167     {
 168         gw_log (GW_LOG_FATAL|GW_LOG_ERRNO, mod, "malloc: irtcl_info");
 169         exit (1);
 170     }
 171     if (!(p->w_interp = w_interp_create (w_interp_tcl, wcl, NULL)))
 172     {
 173         gw_log (GW_LOG_FATAL, mod, "Cannot make Tcl_Interp");
 174         exit (1);
 175     }
 176     p->wcl = wcl;
 177     p->interp = w_interp_tcl_get (p->w_interp);
 178     if (Irtcl_Init(p->interp) == TCL_ERROR)
 179     {
 180         gw_log (GW_LOG_FATAL, mod, "Cannot make Irtcl_Interp");
 181         exit (1);
 182     }
 183     log_init(LOG_ALL, "irtcl", LOGDIR "/irtcl_log");
 184     /* initialize irtcl */
 185     Tcl_CreateCommand (p->interp, "egw_wait", proc_zwait_invoke, p, NULL);
 186     for (i=0; i<MAX_CALLBACK; i++)
 187     {
 188         callback_table[i].r_handle = NULL;
 189         callback_table[i].w_handle = NULL;
 190         callback_table[i].x_handle = NULL;
 191     }
 192     return p;
 193 }
 194
 195
 196 static int do_exec (const char *fname, char *parms, void *mydata)
 197 {
 198     struct tcl_info *p = mydata;
 199     int r;
 200     if ((r = w_interp_exec (p->w_interp, fname, parms)))
 201         return r;
 202     return 0;
 203 }
 204
 205
 206 static int events (struct tcl_info *p, char *waitVar, int tout)
 207 {
 208     int r, i;
 209     char *cp;
 210     char *waitVarVal;
 211     static fd_set fdset_tcl_r;
 212     static fd_set fdset_tcl_w;
 213     static fd_set fdset_tcl_x;
 214     int fifo_in = p->wcl->linein;
 215     if (fifo_in > max_fd)
 216         max_fd = fifo_in;
 217
 218     assert (waitVar);
 219     if ((cp = Tcl_GetVar (p->interp, waitVar, 0)))
 220     {
 221         waitVarVal = malloc (strlen(cp)+1);
 222         strcpy (waitVarVal, cp);
 223     }
 224     else
 225     {
 226         char msg[128];
 227
 228         sprintf (msg, "Variable %s doesn't exist", waitVar);
 229         gw_log (GW_LOG_WARN, mod, "%s", msg);
 230         Tcl_AppendResult (p->interp, msg, NULL);
 231         return TCL_ERROR;
 232     }
 233     gw_log (GW_LOG_DEBUG, mod, "Waiting %s=%s", waitVar, waitVarVal);
 234     while (1)
 235     {
 236         struct timeval to, *top;
 237         if (tout > 0)
 238         {
 239             to.tv_usec = 0;
 240             to.tv_sec = tout;
 241             top = &to;
 242         }
 243         else
 244             top = 0;
 245
 246         if (!(cp = Tcl_GetVar (p->interp, waitVar, 0)) ||
 247             strcmp (cp, waitVarVal))
 248         {
 249             gw_log (GW_LOG_DEBUG, mod, "Changed to %s", cp);
 250             Tcl_AppendResult (p->interp, cp, NULL);
 251             free (waitVarVal);
 252             return TCL_OK;
 253         }
 254         FD_ZERO (&fdset_tcl_r);
 255         FD_ZERO (&fdset_tcl_w);
 256         FD_ZERO (&fdset_tcl_x);
 257
 258         for (r=0, i=0; i<=max_fd; i++)
 259         {
 260             if (callback_table[i].w_handle)
 261             {
 262                 FD_SET (i, &fdset_tcl_w);
 263                 r++;
 264             }
 265             if (callback_table[i].r_handle)
 266             {
 267                 FD_SET (i, &fdset_tcl_r);
 268                 r++;
 269             }
 270             if (callback_table[i].x_handle)
 271             {
 272                 FD_SET (i, &fdset_tcl_x);
 273                 r++;
 274             }
 275         }
 276         if (!r)
 277             break;
 278 #if 1
 279         gw_log (GW_LOG_DEBUG, mod, "fifo select %d", fifo_in);
 280         FD_SET (fifo_in, &fdset_tcl_r);
 281 #endif
 282         if ((r = select(max_fd+1, &fdset_tcl_r, &fdset_tcl_w,
 283                           &fdset_tcl_x, top)) < 0)
 284         {
 285             gw_log (GW_LOG_ERRNO|GW_LOG_FATAL, mod, "select");
 286             exit(1);
 287         }
 288         if (!r)
 289         {
 290             gw_log (GW_LOG_DEBUG, mod, "timeout");
 291             free (waitVarVal);
 292             return TCL_ERROR;
 293         }
 294         if (FD_ISSET (fifo_in, &fdset_tcl_r))
 295         {
 296             gw_log (GW_LOG_DEBUG, mod, "FIFO closed");
 297             free (waitVarVal);
 298             return TCL_ERROR;
 299         }
 300         for (i=0; i<=max_fd; i++)
 301         {
 302             if (FD_ISSET (i, &fdset_tcl_r))
 303             {
 304                 if (callback_table[i].r_handle)
 305                     (*callback_table[i].r_handle) (callback_table[i].obj);
 306             }
 307             if (FD_ISSET (i, &fdset_tcl_w))
 308             {
 309                 if (callback_table[i].w_handle)
 310                     (*callback_table[i].w_handle) (callback_table[i].obj);
 311             }
 312             if (FD_ISSET (i, &fdset_tcl_x))
 313             {
 314                 if (callback_table[i].x_handle)
 315                     (*callback_table[i].x_handle) (callback_table[i].obj);
 316             }
 317         }
 318     }
 319     free (waitVarVal);
 320     return TCL_OK;
 321 }
 322
 323 void ir_select_add (int fd, void *obj)
 324 {
 325     callback_table[fd].obj = obj;
 326     callback_table[fd].r_handle = ir_select_read;
 327     callback_table[fd].w_handle = NULL;
 328     callback_table[fd].x_handle = NULL;
 329     if (fd > max_fd)
 330         max_fd = fd;
 331 }
 332
 333 void ir_select_add_write (int fd, void *obj)
 334 {
 335     callback_table[fd].w_handle = ir_select_write;
 336     if (fd > max_fd)
 337         max_fd = fd;
 338 }
 339
 340 void ir_select_remove_write (int fd, void *obj)
 341 {
 342     callback_table[fd].w_handle = NULL;
 343 }
 344
 345 void ir_select_remove (int fd, void *obj)
 346 {
 347     callback_table[fd].r_handle = NULL;
 348     callback_table[fd].w_handle = NULL;
 349     callback_table[fd].x_handle = NULL;
 350 }
 351
 352 static int do_load (char *parms, void *mydata)
 353 {
 354     struct tcl_info *p = mydata;
 355
 356     return w_interp_load_state (p->w_interp, parms);
 357 }
 358
 359 static int do_save (char *parms, void *mydata)
 360 {
 361     struct tcl_info *p = mydata;
 362
 363     return w_interp_save_state (p->w_interp, parms);
 364 }
 365