recctrl/recctrl.c

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