index/recctrl.c

   1 /* $Id: recctrl.c,v 1.5 2007-01-15 15:10:17 adam Exp $
   2    Copyright (C) 1995-2007
   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 this program; if not, write to the Free Software
  19 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  20
  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
  57 RecTypeClass recTypeClass_create (Res res, NMEM nmem)
  58 {
  59     struct recTypeClass *rts = 0;
  60
  61 #ifdef IDZEBRA_STATIC_GRS_SGML
  62     if (1)
  63     {
  64         extern RecType idzebra_filter_grs_sgml[];
  65         recTypeClass_add (&rts, idzebra_filter_grs_sgml, nmem, 0);
  66     }
  67 #endif
  68
  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
  77 #ifdef IDZEBRA_STATIC_GRS_XML
  78 #if HAVE_EXPAT_H
  79     if (1)
  80     {
  81         extern RecType idzebra_filter_grs_xml[];
  82         recTypeClass_add (&rts, idzebra_filter_grs_xml, nmem, 0);
  83     }
  84 #endif
  85 #endif
  86
  87 #ifdef IDZEBRA_STATIC_GRS_REGX
  88     if (1)
  89     {
  90         extern RecType idzebra_filter_grs_regx[];
  91         recTypeClass_add (&rts, idzebra_filter_grs_regx, nmem, 0);
  92     }
  93 #endif
  94
  95 #ifdef IDZEBRA_STATIC_GRS_MARC
  96     if (1)
  97     {
  98         extern RecType idzebra_filter_grs_marc[];
  99         recTypeClass_add (&rts, idzebra_filter_grs_marc, nmem, 0);
 100     }
 101 #endif
 102
 103 #ifdef IDZEBRA_STATIC_SAFARI
 104     if (1)
 105     {
 106         extern RecType idzebra_filter_safari[];
 107         recTypeClass_add (&rts, idzebra_filter_safari, nmem, 0);
 108     }
 109 #endif
 110
 111 #ifdef IDZEBRA_STATIC_ALVIS
 112     if (1)
 113     {
 114         extern RecType idzebra_filter_alvis[];
 115         recTypeClass_add (&rts, idzebra_filter_alvis, nmem, 0);
 116     }
 117 #endif
 118
 119     return rts;
 120 }
 121
 122 static void load_from_dir(RecTypeClass *rts, NMEM nmem, const char *dirname)
 123 {
 124 #if HAVE_DLFCN_H
 125     DIR *dir = opendir(dirname);
 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, dirname,
 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 #endif
 167 }
 168
 169 void recTypeClass_load_modules(RecTypeClass *rts, NMEM nmem,
 170                                const char *module_path)
 171 {
 172     while (module_path)
 173     {
 174         const char *comp_ptr;
 175         char comp[FILENAME_MAX+1];
 176         size_t len;
 177
 178         len = yaz_filepath_comp(&module_path, &comp_ptr);
 179         if (!len || len >= FILENAME_MAX)
 180             break;
 181
 182         memcpy(comp, comp_ptr, len);
 183         comp[len] = '\0';
 184
 185         load_from_dir(rts, nmem, comp);
 186     }
 187 }
 188
 189 static void recTypeClass_add(struct recTypeClass **rts, RecType *rt,
 190                              NMEM nmem, void *module_handle)
 191 {
 192     while (*rt)
 193     {
 194         struct recTypeClass *r = (struct recTypeClass *)
 195             nmem_malloc (nmem, sizeof(*r));
 196
 197         r->next = *rts;
 198         *rts = r;
 199
 200         r->module_handle = module_handle;
 201         module_handle = 0; /* so that we only store module_handle once */
 202         r->recType = *rt;
 203
 204         rt++;
 205     }
 206 }
 207
 208 void recTypeClass_info(RecTypeClass rtc, void *cd,
 209                        void (*cb)(void *cd, const char *s))
 210 {
 211     for (; rtc; rtc = rtc->next)
 212         (*cb)(cd, rtc->recType->name);
 213 }
 214
 215 void recTypeClass_destroy(RecTypeClass rtc)
 216 {
 217     for (; rtc; rtc = rtc->next)
 218     {
 219 #if HAVE_DLFCN_H
 220         if (rtc->module_handle)
 221             dlclose(rtc->module_handle);
 222 #endif
 223     }
 224 }
 225
 226 RecTypes recTypes_init(RecTypeClass rtc, data1_handle dh)
 227 {
 228     RecTypes rts = (RecTypes) nmem_malloc(data1_nmem_get(dh), sizeof(*rts));
 229
 230     struct recTypeInstance **rti = &rts->entries;
 231
 232     rts->dh = dh;
 233
 234     for (; rtc; rtc = rtc->next)
 235     {
 236         *rti = nmem_malloc(data1_nmem_get(dh), sizeof(**rti));
 237         (*rti)->recType = rtc->recType;
 238         (*rti)->init_flag = 0;
 239         rti = &(*rti)->next;
 240     }
 241     *rti = 0;
 242     return rts;
 243 }
 244
 245 void recTypes_destroy (RecTypes rts)
 246 {
 247     struct recTypeInstance *rti;
 248
 249     for (rti = rts->entries; rti; rti = rti->next)
 250     {
 251         if (rti->init_flag)
 252             (*(rti->recType)->destroy)(rti->clientData);
 253     }
 254 }
 255
 256 RecType recType_byName (RecTypes rts, Res res, const char *name,
 257                         void **clientDataP)
 258 {
 259     struct recTypeInstance *rti;
 260
 261     for (rti = rts->entries; rti; rti = rti->next)
 262     {
 263         size_t slen = strlen(rti->recType->name);
 264         if (!strncmp (rti->recType->name, name, slen)
 265             && (name[slen] == '\0' || name[slen] == '.'))
 266         {
 267             if (!rti->init_flag)
 268             {
 269                 rti->init_flag = 1;
 270                 rti->clientData =
 271                     (*(rti->recType)->init)(res, rti->recType);
 272             }
 273             *clientDataP = rti->clientData;
 274             if (name[slen])
 275                 slen++;  /* skip . */
 276
 277             if (rti->recType->config)
 278             {
 279                 if ((*(rti->recType)->config)
 280                     (rti->clientData, res, name+slen) != ZEBRA_OK)
 281                     return 0;
 282             }
 283             return rti->recType;
 284         }
 285     }
 286     return 0;
 287 }
 288
 289 /*
 290  * Local variables:
 291  * c-basic-offset: 4
 292  * indent-tabs-mode: nil
 293  * End:
 294  * vim: shiftwidth=4 tabstop=8 expandtab
 295  */
 296