recctrl/recctrl.c

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