src/database.c

   1 /* $Id: database.c,v 1.19 2007-04-18 12:41:38 quinn Exp $
   2    Copyright (c) 2006-2007, Index Data.
   3
   4 This file is part of Pazpar2.
   5
   6 Pazpar2 is free software; you can redistribute it and/or modify it under
   7 the terms of the GNU General Public License as published by the Free
   8 Software Foundation; either version 2, or (at your option) any later
   9 version.
  10
  11 Pazpar2 is distributed in the hope that it will be useful, but WITHOUT ANY
  12 WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14 for more details.
  15
  16 You should have received a copy of the GNU General Public License
  17 along with Pazpar2; see the file LICENSE.  If not, write to the
  18 Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA
  19 02111-1307, USA.
  20  */
  21
  22 #include <libxml/parser.h>
  23 #include <libxml/tree.h>
  24 #include <libxslt/xslt.h>
  25 #include <libxslt/transform.h>
  26 #include <libxslt/xsltutils.h>
  27 #include <assert.h>
  28 #include <sys/types.h>
  29 #include <sys/stat.h>
  30
  31 #include "pazpar2.h"
  32 #include "config.h"
  33 #include "settings.h"
  34 #include "http.h"
  35 #include "zeerex.h"
  36
  37 #include <sys/types.h>
  38 #include <sys/socket.h>
  39 #include <netdb.h>
  40 #include <netinet/in.h>
  41
  42 static struct host *hosts = 0;  // The hosts we know about
  43 static struct database *databases = 0; // The databases we know about
  44 static NMEM nmem = 0;
  45
  46 static xmlDoc *get_explain_xml(const char *id)
  47 {
  48     struct stat st;
  49     char *dir;
  50     char path[256];
  51     char ide[256];
  52     if (!config || !config->targetprofiles)
  53     {
  54         yaz_log(YLOG_WARN, "Config must be loaded and specify targetprofiles");
  55         return 0;
  56     }
  57     if (config->targetprofiles->type != Targetprofiles_local)
  58     {
  59         yaz_log(YLOG_FATAL, "Only supports local type");
  60         return 0;
  61     }
  62     dir = config->targetprofiles->src;
  63     urlencode(id, ide);
  64     sprintf(path, "%s/%s", dir, ide);
  65     if (!stat(path, &st))
  66         return xmlParseFile(path);
  67     else
  68         return 0;
  69 }
  70
  71 // Create a new host structure for hostport
  72 static struct host *create_host(const char *hostport)
  73 {
  74     struct addrinfo *addrinfo, hints;
  75     struct host *host;
  76     char *port;
  77     char ipport[128];
  78     unsigned char addrbuf[4];
  79     int res;
  80
  81     host = xmalloc(sizeof(struct host));
  82     host->hostport = xstrdup(hostport);
  83     host->connections = 0;
  84
  85     if ((port = strchr(hostport, ':')))
  86         *(port++) = '\0';
  87     else
  88         port = "210";
  89
  90     hints.ai_flags = 0;
  91     hints.ai_family = PF_INET;
  92     hints.ai_socktype = SOCK_STREAM;
  93     hints.ai_protocol = IPPROTO_TCP;
  94     hints.ai_addrlen = 0;
  95     hints.ai_addr = 0;
  96     hints.ai_canonname = 0;
  97     hints.ai_next = 0;
  98     // This is not robust code. It assumes that getaddrinfo always
  99     // returns AF_INET address.
 100     if ((res = getaddrinfo(hostport, port, &hints, &addrinfo)))
 101     {
 102         yaz_log(YLOG_WARN, "Failed to resolve %s: %s", hostport, gai_strerror(res));
 103         xfree(host->hostport);
 104         xfree(host);
 105         return 0;
 106     }
 107     assert(addrinfo->ai_family == PF_INET);
 108     memcpy(addrbuf, &((struct sockaddr_in*)addrinfo->ai_addr)->sin_addr.s_addr, 4);
 109     sprintf(ipport, "%u.%u.%u.%u:%s",
 110             addrbuf[0], addrbuf[1], addrbuf[2], addrbuf[3], port);
 111     host->ipport = xstrdup(ipport);
 112     freeaddrinfo(addrinfo);
 113     host->next = hosts;
 114     hosts = host;
 115     return host;
 116 }
 117
 118 static struct host *find_host(const char *hostport)
 119 {
 120     struct host *p;
 121     for (p = hosts; p; p = p->next)
 122         if (!strcmp(p->hostport, hostport))
 123             return p;
 124     return create_host(hostport);
 125 }
 126
 127 static struct database *load_database(const char *id)
 128 {
 129     xmlDoc *doc = 0;
 130     struct zr_explain *explain = 0;
 131     struct database *db;
 132     struct host *host;
 133     char hostport[256];
 134     char *dbname;
 135
 136     yaz_log(YLOG_LOG, "New database: %s", id);
 137     if (!nmem)
 138         nmem = nmem_create();
 139
 140     if (config && config->targetprofiles
 141         && (doc = get_explain_xml(id)))
 142     {
 143         explain = zr_read_xml(nmem, xmlDocGetRootElement(doc));
 144         if (!explain)
 145             return 0;
 146     }
 147
 148     if (strlen(id) > 255)
 149         return 0;
 150     strcpy(hostport, id);
 151     if ((dbname = strchr(hostport, '/')))
 152         *(dbname++) = '\0';
 153     else
 154         dbname = "Default";
 155     if (!(host = find_host(hostport)))
 156         return 0;
 157     db = nmem_malloc(nmem, sizeof(*db));
 158     memset(db, 0, sizeof(*db));
 159     db->host = host;
 160     db->url = nmem_strdup(nmem, id);
 161     db->databases = xmalloc(2 * sizeof(char *));
 162     db->databases[0] = nmem_strdup(nmem, dbname);
 163     db->databases[1] = 0;
 164     db->errors = 0;
 165     db->explain = explain;
 166     db->settings = 0;
 167     db->next = databases;
 168     db->ccl_map = 0;
 169     db->yaz_marc = 0;
 170     db->map = 0;
 171     databases = db;
 172
 173     return db;
 174 }
 175
 176 // Return a database structure by ID. Load and add to list if necessary
 177 // new==1 just means we know it's not in the list
 178 struct database *find_database(const char *id, int new)
 179 {
 180     struct database *p;
 181     if (!new)
 182     {
 183         for (p = databases; p; p = p->next)
 184             if (!strcmp(p->url, id))
 185                 return p;
 186     }
 187     return load_database(id);
 188 }
 189
 190 // This whole session_grep database thing should be moved to pazpar2.c
 191
 192 int match_zurl(const char *zurl, const char *pattern)
 193 {
 194     if (!strcmp(pattern, "*"))
 195         return 1;
 196     else if (!strncmp(pattern, "*/", 2))
 197     {
 198         char *db = strchr(zurl, '/');
 199         if (!db)
 200             return 0;
 201         if (!strcmp(pattern + 2, db))
 202             return 1;
 203         else
 204             return 0;
 205     }
 206     else if (!strcmp(pattern, zurl))
 207         return 1;
 208     else
 209         return 0;
 210 }
 211
 212 // This will be generalized at some point
 213 static int match_criterion(struct setting **settings, struct database_criterion *c)
 214 {
 215     int offset = settings_offset(c->name);
 216     struct database_criterion_value *v;
 217
 218     if (offset < 0)
 219     {
 220         yaz_log(YLOG_WARN, "Criterion not found: %s", c->name);
 221         return 0;
 222     }
 223     if (!settings[offset])
 224         return 0;
 225     for (v = c->values; v; v = v->next)
 226     {
 227         if (offset == PZ_ID)
 228         {
 229             if (match_zurl(settings[offset]->value, v->value))
 230                 break;
 231         }
 232         else
 233         {
 234             if (!strcmp(settings[offset]->value, v->value))
 235                 break;
 236         }
 237     }
 238     if (v)
 239         return 1;
 240     else
 241         return 0;
 242 }
 243
 244 int database_match_criteria(struct setting **settings, struct database_criterion *cl)
 245 {
 246     for (; cl; cl = cl->next)
 247         if (!match_criterion(settings, cl))
 248             break;
 249     if (cl) // one of the criteria failed to match -- skip this db
 250         return 0;
 251     else
 252         return 1;
 253 }
 254
 255 // Cycles through databases, calling a handler function on the ones for
 256 // which all criteria matched.
 257 int session_grep_databases(struct session *se, struct database_criterion *cl,
 258         void (*fun)(void *context, struct session_database *db))
 259 {
 260     struct session_database *p;
 261     int i = 0;
 262
 263     for (p = se->databases; p; p = p->next)
 264     {
 265         if (p->settings && p->settings[PZ_ALLOW] && *p->settings[PZ_ALLOW]->value == '0')
 266             continue;
 267         if (database_match_criteria(p->settings, cl))
 268         {
 269             (*fun)(se, p);
 270             i++;
 271         }
 272     }
 273     return i;
 274 }
 275
 276 int grep_databases(void *context, struct database_criterion *cl,
 277         void (*fun)(void *context, struct database *db))
 278 {
 279     struct database *p;
 280     int i = 0;
 281
 282     for (p = databases; p; p = p->next)
 283         if (database_match_criteria(p->settings, cl))
 284         {
 285             (*fun)(context, p);
 286             i++;
 287         }
 288     return i;
 289 }
 290
 291 // Initialize CCL map for a target
 292 // Note: This approach ignores user-specific CCL maps, for which I
 293 // don't presently see any application.
 294 static void prepare_cclmap(void *ignore, struct database *db)
 295 {
 296     struct setting *s;
 297
 298     if (!db->settings)
 299         return;
 300     db->ccl_map = ccl_qual_mk();
 301     for (s = db->settings[PZ_CCLMAP]; s; s = s->next)
 302     {
 303         char *p = strchr(s->name + 3, ':');
 304         if (!p)
 305         {
 306             yaz_log(YLOG_FATAL, "Malformed cclmap name: %s", s->name);
 307             exit(1);
 308         }
 309         p++;
 310         ccl_qual_fitem(db->ccl_map, s->value, p);
 311     }
 312 }
 313
 314 // Initialize YAZ Map structures for MARC-based targets
 315 static void prepare_yazmarc(void *ignore, struct database *db)
 316 {
 317     struct setting *s;
 318
 319     if (!db->settings)
 320         return;
 321     for (s = db->settings[PZ_NATIVESYNTAX]; s; s = s->next)
 322         if (!strcmp(s->value, "iso2709"))
 323         {
 324             char *encoding = "marc-8s";
 325             yaz_iconv_t cm;
 326
 327             db->yaz_marc = yaz_marc_create();
 328             yaz_marc_subfield_str(db->yaz_marc, "\t");
 329
 330             // See if a native encoding is specified
 331             if (db->settings[PZ_ENCODING])
 332                 encoding = db->settings[PZ_ENCODING]->value;
 333
 334             cm = yaz_iconv_open("utf-8", encoding);
 335             if (!cm)
 336             {
 337                 yaz_log(YLOG_FATAL,
 338                         "Unable to map from %s to UTF-8 for target %s",
 339                         encoding, db->url);
 340                 exit(1);
 341             }
 342             yaz_marc_iconv(db->yaz_marc, cm);
 343         }
 344 }
 345
 346 // Prepare XSLT stylesheets for record normalization
 347 static void prepare_map(void *ignore, struct database *db)
 348 {
 349     struct setting *s;
 350
 351     if (!db->settings)
 352         return;
 353     for (s = db->settings[PZ_XSLT]; s; s = s->next)
 354     {
 355         char **stylesheets;
 356         struct database_retrievalmap **m = &db->map;
 357         int num, i;
 358
 359         nmem_strsplit(nmem, ",", s->value, &stylesheets, &num);
 360         for (i = 0; i < num; i++)
 361         {
 362             (*m) = nmem_malloc(nmem, sizeof(**m));
 363             (*m)->next = 0;
 364             if (!((*m)->stylesheet = conf_load_stylesheet(stylesheets[i])))
 365             {
 366                 yaz_log(YLOG_FATAL, "Unable to load stylesheet: %s",
 367                         stylesheets[i]);
 368                 exit(1);
 369             }
 370             m = &(*m)->next;
 371         }
 372     }
 373     if (!db->map)
 374         yaz_log(YLOG_WARN, "No Normalization stylesheet for target %s", db->url);
 375 }
 376
 377 // Read settings for each database, and prepare support data structures
 378 void prepare_databases(void)
 379 {
 380     grep_databases(0, 0, prepare_cclmap);
 381     grep_databases(0, 0, prepare_yazmarc);
 382     grep_databases(0, 0, prepare_map);
 383 }
 384
 385 // This function will most likely vanish when a proper target profile mechanism is
 386 // introduced.
 387 void load_simpletargets(const char *fn)
 388 {
 389     FILE *f = fopen(fn, "r");
 390     char line[256];
 391
 392     if (!f)
 393     {
 394         yaz_log(YLOG_WARN|YLOG_ERRNO, "open %s", fn);
 395         exit(1);
 396     }
 397
 398     while (fgets(line, 255, f))
 399     {
 400         char *url;
 401         char *name;
 402         struct database *db;
 403
 404         if (strncmp(line, "target ", 7))
 405             continue;
 406         line[strlen(line) - 1] = '\0';
 407
 408         if ((name = strchr(line, ';')))
 409             *(name++) = '\0';
 410
 411         url = line + 7;
 412
 413         if (!(db = find_database(url, 0)))
 414             yaz_log(YLOG_WARN, "Unable to load database %s", url);
 415     }
 416     fclose(f);
 417 }
 418
 419
 420 /*
 421  * Local variables:
 422  * c-basic-offset: 4
 423  * indent-tabs-mode: nil
 424  * End:
 425  * vim: shiftwidth=4 tabstop=8 expandtab
 426  */