recctrl/perlread.c

   1 /* $Id: perlread.c,v 1.8 2003-03-05 16:43:48 adam Exp $
   2    Copyright (C) 1995,1996,1997,1998,1999,2000,2001,2002
   3    Index Data Aps
   4
   5 This file is part of the Zebra server.
   6
   7 Zebra is free software; you can redistribute it and/or modify it under
   8 the terms of the GNU General Public License as published by the Free
   9 Software Foundation; either version 2, or (at your option) any later
  10 version.
  11
  12 Zebra is distributed in the hope that it will be useful, but WITHOUT ANY
  13 WARRANTY; without even the implied warranty of MERCHANTABILITY or
  14 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  15 for more details.
  16
  17 You should have received a copy of the GNU General Public License
  18 along with Zebra; see the file LICENSE.zebra.  If not, write to the
  19 Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA
  20 02111-1307, USA.
  21 */
  22
  23 #if HAVE_PERL
  24 #include "perlread.h"
  25 #include "EXTERN.h"
  26 #include "perl.h"
  27 #include "XSUB.h"
  28
  29 #include <stdio.h>
  30 #include <string.h>
  31 #include <ctype.h>
  32
  33 #include <yaz/tpath.h>
  34 #include <zebrautl.h>
  35 #include <dfa.h>
  36 #include "grsread.h"
  37
  38
  39 #define GRS_PERL_MODULE_NAME_MAXLEN 255
  40
  41 /* Context information for the filter */
  42 struct perl_context {
  43   PerlInterpreter *perli;
  44   PerlInterpreter *origi;
  45   int perli_ready;
  46   char filterClass[GRS_PERL_MODULE_NAME_MAXLEN];
  47   SV *filterRef;
  48
  49   int (*readf)(void *, char *, size_t);
  50   off_t (*seekf)(void *, off_t);
  51   off_t (*tellf)(void *);
  52   void (*endf)(void *, off_t);
  53
  54   void *fh;
  55   data1_handle dh;
  56   NMEM mem;
  57   data1_node *res;
  58 };
  59
  60 /* Constructor call for the filter object */
  61 void Filter_create (struct perl_context *context)
  62 {
  63   dSP;
  64   SV *msv;
  65
  66   PUSHMARK(SP) ;
  67   XPUSHs(sv_2mortal(newSVpv(context->filterClass,
  68                             strlen(context->filterClass)))) ;
  69   msv = sv_newmortal();
  70   sv_setref_pv(msv, "_p_perl_context", (void*)context);
  71   XPUSHs(msv) ;
  72   PUTBACK ;
  73   call_method("new", G_EVAL);
  74
  75   SPAGAIN ;
  76   context->filterRef = POPs;
  77   PUTBACK ;
  78 }
  79
  80 /*
  81  Execute the process call on the filter. This is a bit dirty.
  82  The perl code is going to get dh and nmem from the context trough callbacks,
  83  then call readf, to get the stream, and then set the res (d1 node)
  84  in the context. However, it's safer, to let swig do as much of wrapping
  85  as possible.
  86  */
  87 int Filter_process (struct perl_context *context)
  88
  89 {
  90
  91   int res;
  92
  93   dSP;
  94
  95   ENTER;
  96   SAVETMPS;
  97
  98   PUSHMARK(SP) ;
  99   XPUSHs(context->filterRef);
 100   PUTBACK ;
 101   call_method("_process", 0);
 102   SPAGAIN ;
 103   res = POPi;
 104   PUTBACK ;
 105
 106   FREETMPS;
 107   LEAVE;
 108
 109   return (res);
 110 }
 111
 112 /*
 113  This one is called to transfer the results of a readf. It's going to create
 114  a temporary variable there...
 115
 116  So the call stack is something like:
 117
 118
 119  ->Filter_process(context)                            [C]
 120    -> _process($context)                              [Perl]
 121     -> grs_perl_get_dh($context)                      [Perl]
 122       -> grs_perl_get_dh(context)                     [C]
 123     -> grs_perl_get_mem($context)                     [Perl]
 124       -> grs_perl_get_mem(context)                    [C]
 125     -> process()                                      [Perl]
 126       ...
 127       -> grs_perl_readf($context,$len)                [Perl]
 128         -> grs_perl_readf(context, len)               [C]
 129            ->(*context->readf)(context->fh, buf, len) [C]
 130         -> Filter_store_buff(context, buf, r)         [C]
 131            -> _store_buff($buff)                      [Perl]
 132         [... returns buff and length ...]
 133       ...
 134       [... returns d1 node ...]
 135     -> grs_perl_set_res($context, $node)              [Perl]
 136       -> grs_perl_set_res(context, node)              [C]
 137
 138  [... The result is in context->res ...]
 139
 140   Dirty, isn't it? It may become nicer, if I'll have some more time to work on
 141   it. However, these changes are not going to hurt the filter api, as
 142   Filter.pm, which is inherited into all specific filter implementations
 143   can hide this whole compexity behind.
 144
 145 */
 146 void Filter_store_buff (struct perl_context *context, char *buff, size_t len) {
 147   dSP;
 148
 149   ENTER;
 150   SAVETMPS;
 151
 152   PUSHMARK(SP) ;
 153   XPUSHs(context->filterRef);
 154   XPUSHs(sv_2mortal(newSVpv(buff, len)));
 155   PUTBACK ;
 156   call_method("_store_buff", 0);
 157   SPAGAIN ;
 158   PUTBACK ;
 159
 160   FREETMPS;
 161   LEAVE;
 162 }
 163 /*  The "file" manipulation function wrappers */
 164 int grs_perl_readf(struct perl_context *context, size_t len) {
 165   int r;
 166   char *buf = (char *) xmalloc (len+1);
 167   r = (*context->readf)(context->fh, buf, len);
 168   if (r > 0) Filter_store_buff (context, buf, r);
 169   xfree (buf);
 170   return (r);
 171 }
 172
 173 int grs_perl_readline(struct perl_context *context) {
 174   int r;
 175   char *buf = (char *) xmalloc (4096);
 176   char *p = buf;
 177
 178   while ((r = (*context->readf)(context->fh,p,1)) && (p-buf < 4095)) {
 179     p++;
 180     if (*(p-1) == 10) break;
 181   }
 182
 183   *p = 0;
 184
 185   if (p != buf) Filter_store_buff (context, buf, p - buf);
 186   xfree (buf);
 187   return (p - buf);
 188 }
 189
 190 char grs_perl_getc(struct perl_context *context) {
 191   int r;
 192   char *p;
 193   if ((r = (*context->readf)(context->fh,p,1))) {
 194     return (*p);
 195   } else {
 196     return (0);
 197   }
 198 }
 199
 200 off_t grs_perl_seekf(struct perl_context *context, off_t offset) {
 201   return ((*context->seekf)(context->fh, offset));
 202 }
 203
 204 off_t grs_perl_tellf(struct perl_context *context) {
 205   return ((*context->tellf)(context->fh));
 206 }
 207
 208 void grs_perl_endf(struct perl_context *context, off_t offset) {
 209   (*context->endf)(context->fh, offset);
 210 }
 211
 212 /* Get pointers from the context. Easyer to wrap this by SWIG */
 213 data1_handle *grs_perl_get_dh(struct perl_context *context) {
 214   return(&context->dh);
 215 }
 216
 217 NMEM *grs_perl_get_mem(struct perl_context *context) {
 218   return(&context->mem);
 219 }
 220
 221 /* Set the result in the context */
 222 void grs_perl_set_res(struct perl_context *context, data1_node *n) {
 223   context->res = n;
 224 }
 225
 226 /* The filter handlers (init, destroy, read) */
 227 static void *grs_init_perl(void)
 228 {
 229   struct perl_context *context =
 230     (struct perl_context *) xmalloc (sizeof(*context));
 231
 232   /* If there is an interpreter (context) running, - we are calling
 233      indexing and retrieval from the perl API - we don't create a new one. */
 234   context->origi = PERL_GET_CONTEXT;
 235   if (context->origi == NULL) {
 236     context->perli = perl_alloc();
 237     PERL_SET_CONTEXT(context->perli);
 238     logf (LOG_LOG, "Initializing new perl interpreter context (%p)",context->perli);
 239   } else {
 240     logf (LOG_LOG, "Using existing perl interpreter context (%p)",context->origi);
 241   }
 242   context->perli_ready = 0;
 243   strcpy(context->filterClass, "");
 244   return (context);
 245 }
 246
 247 void grs_destroy_perl(void *clientData)
 248 {
 249   struct perl_context *context = (struct perl_context *) clientData;
 250
 251   logf (LOG_LOG, "Destroying perl interpreter context");
 252   if (context->perli_ready) {
 253     /*
 254     FREETMPS;
 255     LEAVE;
 256     */
 257     if (context->origi == NULL)  perl_destruct(context->perli);
 258    }
 259   if (context->origi == NULL) perl_free(context->perli);
 260   xfree (context);
 261 }
 262
 263 static data1_node *grs_read_perl (struct grs_read_info *p)
 264 {
 265   struct perl_context *context = (struct perl_context *) p->clientData;
 266   char *filterClass = p->type;
 267
 268   /* The "file" manipulation function wrappers */
 269   context->readf = p->readf;
 270   context->seekf = p->seekf;
 271   context->tellf = p->tellf;
 272   context->endf  = p->endf;
 273
 274   /* The "file", data1 and NMEM handles */
 275   context->fh  = p->fh;
 276   context->dh  = p->dh;
 277   context->mem = p->mem;
 278
 279   /* If the class was not interpreted before... */
 280   /* This is not too efficient, when indexing with many different filters... */
 281   if (strcmp(context->filterClass,filterClass)) {
 282
 283     char modarg[GRS_PERL_MODULE_NAME_MAXLEN + 2];
 284     char initarg[GRS_PERL_MODULE_NAME_MAXLEN + 2];
 285     char *arglist[6] = { "", "-I", "", "-M", "-e", "" };
 286
 287     if (context->perli_ready) {
 288       /*
 289       FREETMPS;
 290       LEAVE;
 291       */
 292       if (context->origi == NULL) perl_destruct(context->perli);
 293     }
 294     if (context->origi == NULL) perl_construct(context->perli);
 295
 296     /*
 297     ENTER;
 298     SAVETMPS;
 299     */
 300     context->perli_ready = 1;
 301
 302     /* parse, and run the init call */
 303     if (context->origi == NULL) {
 304       logf (LOG_LOG, "Interpreting filter class:%s", filterClass);
 305
 306       arglist[2] = (char *) data1_get_tabpath(p->dh);
 307       sprintf(modarg,"-M%s",filterClass);
 308       arglist[3] = (char *) &modarg;
 309       sprintf(initarg,"%s->init;",filterClass);
 310       arglist[5] = (char *) &initarg;
 311
 312       perl_parse(context->perli, PERL_XS_INIT, 6, arglist, NULL);
 313       perl_run(context->perli);
 314     }
 315
 316     strcpy(context->filterClass, filterClass);
 317
 318     /* create the filter object as a filterClass blessed reference */
 319     Filter_create(context);
 320   }
 321
 322   /* Wow... if calling with individual update_record calls from perl,
 323      the filter object reference may go out of scope... */
 324   if (!sv_isa(context->filterRef, context->filterClass)) {
 325     Filter_create(context);
 326     logf (LOG_DEBUG,"Filter recreated");
 327   }
 328
 329   if (!SvTRUE(context->filterRef)) {
 330     logf (LOG_WARN,"Failed to initialize perl filter %s",context->filterClass);
 331     return (0);
 332   }
 333
 334   /* call the process method */
 335   Filter_process(context);
 336
 337   /* return the created data1 node */
 338   return (context->res);
 339 }
 340
 341 static struct recTypeGrs perl_type = {
 342     "perl",
 343     grs_init_perl,
 344     grs_destroy_perl,
 345     grs_read_perl
 346 };
 347
 348 RecTypeGrs recTypeGrs_perl = &perl_type;
 349
 350 /* HAVE_PERL */
 351 #endif