recctrl/recctrl.c

   1 /* $Id: recctrl.c,v 1.13 2004-11-19 10:27:12 heikki Exp $
   2    Copyright (C) 1995,1996,1997,1998,1999,2000,2001,2002,2003,2004
   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
  24 #include <stdio.h>
  25 #include <assert.h>
  26 #include <string.h>
  27 #include <dlfcn.h>
  28
  29 #include <direntz.h>
  30 #include <zebrautl.h>
  31 #include <idzebra/recctrl.h>
  32
  33 struct recTypeClass {
  34     RecType recType;
  35     struct recTypeClass *next;
  36     void *module_handle;
  37 };
  38
  39 struct recTypeInstance {
  40     RecType recType;
  41     struct recTypeInstance *next;
  42     int init_flag;
  43     void *clientData;
  44 };
  45
  46 struct recTypes {
  47     data1_handle dh;
  48     struct recTypeInstance *entries;
  49 };
  50
  51 #ifdef IDZEBRA_STATIC_TEXT
  52     extern RecType idzebra_filter_text[];
  53 #endif
  54 #ifdef IDZEBRA_STATIC_GRS_XML
  55 #if HAVE_EXPAT_H
  56     extern RecType idzebra_filter_grs_xml[];
  57 #endif
  58 #endif
  59 #ifdef IDZEBRA_STATIC_GRS_REGX
  60     extern RecType idzebra_filter_grs_regx[];
  61 #endif
  62 #ifdef IDZEBRA_STATIC_GRS_MARC
  63     extern RecType idzebra_filter_grs_marc[];
  64 #endif
  65 #ifdef IDZEBRA_STATIC_GRS_DANBIB
  66     extern RecType idzebra_filter_grs_danbib[];
  67 #endif
  68
  69 static void recTypeClass_add (struct recTypeClass **rts, RecType *rt,
  70                               NMEM nmem, void *module_handle);
  71
  72 RecTypeClass recTypeClass_create (Res res, NMEM nmem)
  73 {
  74     struct recTypeClass *rts = 0;
  75     const char *module_path = res_get_def(res, "modulePath",
  76                                           DEFAULT_MODULE_PATH);
  77
  78     extern RecType idzebra_filter_grs_sgml[];
  79     recTypeClass_add (&rts, idzebra_filter_grs_sgml, nmem, 0);
  80 #ifdef IDZEBRA_STATIC_TEXT
  81     recTypeClass_add (&rts, idzebra_filter_text, nmem, 0);
  82 #endif
  83 #ifdef IDZEBRA_STATIC_GRS_XML
  84 #if HAVE_EXPAT_H
  85     recTypeClass_add (&rts, idzebra_filter_grs_xml, nmem, 0);
  86 #endif
  87 #endif
  88 #ifdef IDZEBRA_STATIC_GRS_REGX
  89     recTypeClass_add (&rts, idzebra_filter_grs_regx, nmem, 0);
  90 #endif
  91 #ifdef IDZEBRA_STATIC_GRS_MARC
  92     recTypeClass_add (&rts, idzebra_filter_grs_marc, nmem, 0);
  93 #endif
  94 #ifdef IDZEBRA_STATIC_GRS_DANBIB
  95     recTypeClass_add (&rts, idzebra_filter_grs_danbib, nmem, 0);
  96 #endif
  97
  98     if (module_path)
  99     {
 100         DIR *dir = opendir(module_path);
 101         yaz_log(YLOG_LOG, "searching filters in %s", module_path);
 102         if (dir)
 103         {
 104             struct dirent *de;
 105
 106             while ((de = readdir(dir)))
 107             {
 108                 size_t dlen = strlen(de->d_name);
 109                 if (dlen >= 5 &&
 110                     !memcmp(de->d_name, "mod-", 4) &&
 111                     !strcmp(de->d_name + dlen - 3, ".so"))
 112                 {
 113                     void *mod_p, *fl;
 114                     char fname[FILENAME_MAX*2+1];
 115                     sprintf(fname, "%.*s/%.*s",
 116                             FILENAME_MAX, module_path,
 117                             FILENAME_MAX, de->d_name);
 118                     mod_p = dlopen(fname, RTLD_NOW|RTLD_GLOBAL);
 119                     if (mod_p && (fl = dlsym(mod_p, "idzebra_filter")))
 120                     {
 121                         yaz_log(YLOG_LOG, "Loaded filter module %s", fname);
 122                         recTypeClass_add(&rts, fl, nmem, mod_p);
 123                     }
 124                     else if (mod_p)
 125                     {
 126                         const char *err = dlerror();
 127                         yaz_log(YLOG_WARN, "dlsym failed %s %s",
 128                                 fname, err ? err : "none");
 129                         dlclose(mod_p);
 130                     }
 131                     else
 132                     {
 133                         const char *err = dlerror();
 134                         yaz_log(YLOG_WARN, "dlopen failed %s %s",
 135                                 fname, err ? err : "none");
 136
 137                     }
 138                 }
 139             }
 140             closedir(dir);
 141         }
 142     }
 143     return rts;
 144 }
 145
 146 static void recTypeClass_add (struct recTypeClass **rts, RecType *rt,
 147                               NMEM nmem, void *module_handle)
 148 {
 149     while (*rt)
 150     {
 151         struct recTypeClass *r = (struct recTypeClass *)
 152             nmem_malloc (nmem, sizeof(*r));
 153
 154         r->next = *rts;
 155         *rts = r;
 156
 157         yaz_log(YLOG_LOG, "Adding filter %s", (*rt)->name);
 158         r->module_handle = module_handle;
 159         module_handle = 0; /* so that we only store module_handle once */
 160         r->recType = *rt;
 161
 162         rt++;
 163     }
 164 }
 165
 166 void recTypeClass_info(RecTypeClass rtc, void *cd,
 167                        void (*cb)(void *cd, const char *s))
 168 {
 169     for (; rtc; rtc = rtc->next)
 170         (*cb)(cd, rtc->recType->name);
 171 }
 172
 173 void recTypeClass_destroy(RecTypeClass rtc)
 174 {
 175     for (; rtc; rtc = rtc->next)
 176     {
 177         if (rtc->module_handle)
 178             dlclose(rtc->module_handle);
 179     }
 180 }
 181
 182 RecTypes recTypes_init(RecTypeClass rtc, data1_handle dh)
 183 {
 184     RecTypes rts = (RecTypes) nmem_malloc(data1_nmem_get(dh), sizeof(*rts));
 185
 186     struct recTypeInstance **rti = &rts->entries;
 187
 188     rts->dh = dh;
 189
 190     for (; rtc; rtc = rtc->next)
 191     {
 192         *rti = nmem_malloc(data1_nmem_get(dh), sizeof(**rti));
 193         (*rti)->recType = rtc->recType;
 194         (*rti)->init_flag = 0;
 195         rti = &(*rti)->next;
 196     }
 197     *rti = 0;
 198     return rts;
 199 }
 200
 201 void recTypes_destroy (RecTypes rts)
 202 {
 203     struct recTypeInstance *rti;
 204
 205     for (rti = rts->entries; rti; rti = rti->next)
 206     {
 207         if (rti->init_flag)
 208             (*(rti->recType)->destroy)(rti->clientData);
 209     }
 210 }
 211
 212 RecType recType_byName (RecTypes rts, Res res, const char *name,
 213                         void **clientDataP)
 214 {
 215     struct recTypeInstance *rti;
 216
 217     for (rti = rts->entries; rti; rti = rti->next)
 218     {
 219         size_t slen = strlen(rti->recType->name);
 220         if (!strncmp (rti->recType->name, name, slen)
 221             && (name[slen] == '\0' || name[slen] == '.'))
 222         {
 223             if (!rti->init_flag)
 224             {
 225                 rti->init_flag = 1;
 226                 rti->clientData =
 227                     (*(rti->recType)->init)(res, rti->recType);
 228             }
 229             *clientDataP = rti->clientData;
 230             if (name[slen])
 231                 slen++;  /* skip . */
 232
 233             if (rti->recType->config)
 234                 (*(rti->recType)->config)(rti->clientData, res, name+slen);
 235             return rti->recType;
 236         }
 237     }
 238     return 0;
 239 }
 240