Allows definition/override of pz:cclmap:* settings via settings ws.
[pazpar2-moved-to-github.git] / src / database.c
1 /* $Id: database.c,v 1.20 2007-04-20 04:32:33 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->yaz_marc = 0;
169     db->map = 0;
170     databases = db;
171
172     return db;
173 }
174
175 // Return a database structure by ID. Load and add to list if necessary
176 // new==1 just means we know it's not in the list
177 struct database *find_database(const char *id, int new)
178 {
179     struct database *p;
180     if (!new)
181     {
182         for (p = databases; p; p = p->next)
183             if (!strcmp(p->url, id))
184                 return p;
185     }
186     return load_database(id);
187 }
188
189 // This whole session_grep database thing should be moved to pazpar2.c
190
191 int match_zurl(const char *zurl, const char *pattern)
192 {
193     if (!strcmp(pattern, "*"))
194         return 1;
195     else if (!strncmp(pattern, "*/", 2))
196     {
197         char *db = strchr(zurl, '/');
198         if (!db)
199             return 0;
200         if (!strcmp(pattern + 2, db))
201             return 1;
202         else
203             return 0;
204     }
205     else if (!strcmp(pattern, zurl))
206         return 1;
207     else
208         return 0;
209 }
210
211 // This will be generalized at some point
212 static int match_criterion(struct setting **settings, struct database_criterion *c)
213 {
214     int offset = settings_offset(c->name);
215     struct database_criterion_value *v;
216
217     if (offset < 0)
218     {
219         yaz_log(YLOG_WARN, "Criterion not found: %s", c->name);
220         return 0;
221     }
222     if (!settings[offset])
223         return 0;
224     for (v = c->values; v; v = v->next)
225     {
226         if (offset == PZ_ID)
227         {
228             if (match_zurl(settings[offset]->value, v->value))
229                 break;
230         }
231         else 
232         {
233             if (!strcmp(settings[offset]->value, v->value))
234                 break;
235         }
236     }
237     if (v)
238         return 1;
239     else
240         return 0;
241 }
242
243 int database_match_criteria(struct setting **settings, struct database_criterion *cl)
244 {
245     for (; cl; cl = cl->next)
246         if (!match_criterion(settings, cl))
247             break;
248     if (cl) // one of the criteria failed to match -- skip this db
249         return 0;
250     else
251         return 1;
252 }
253
254 // Cycles through databases, calling a handler function on the ones for
255 // which all criteria matched.
256 int session_grep_databases(struct session *se, struct database_criterion *cl,
257         void (*fun)(void *context, struct session_database *db))
258 {
259     struct session_database *p;
260     int i = 0;
261
262     for (p = se->databases; p; p = p->next)
263     {
264         if (p->settings && p->settings[PZ_ALLOW] && *p->settings[PZ_ALLOW]->value == '0')
265             continue;
266         if (database_match_criteria(p->settings, cl))
267         {
268             (*fun)(se, p);
269             i++;
270         }
271     }
272     return i;
273 }
274
275 int grep_databases(void *context, struct database_criterion *cl,
276         void (*fun)(void *context, struct database *db))
277 {
278     struct database *p;
279     int i = 0;
280
281     for (p = databases; p; p = p->next)
282         if (database_match_criteria(p->settings, cl))
283         {
284             (*fun)(context, p);
285             i++;
286         }
287     return i;
288 }
289
290 // Initialize YAZ Map structures for MARC-based targets
291 static void prepare_yazmarc(void *ignore, struct database *db)
292 {
293     struct setting *s;
294
295     if (!db->settings)
296         return;
297     for (s = db->settings[PZ_NATIVESYNTAX]; s; s = s->next)
298         if (!strcmp(s->value, "iso2709"))
299         {
300             char *encoding = "marc-8s";
301             yaz_iconv_t cm;
302
303             db->yaz_marc = yaz_marc_create();
304             yaz_marc_subfield_str(db->yaz_marc, "\t");
305
306             // See if a native encoding is specified
307             if (db->settings[PZ_ENCODING])
308                 encoding = db->settings[PZ_ENCODING]->value;
309             
310             cm = yaz_iconv_open("utf-8", encoding);
311             if (!cm)
312             {
313                 yaz_log(YLOG_FATAL, 
314                         "Unable to map from %s to UTF-8 for target %s", 
315                         encoding, db->url);
316                 exit(1);
317             }
318             yaz_marc_iconv(db->yaz_marc, cm);
319         }
320 }
321
322 // Prepare XSLT stylesheets for record normalization
323 static void prepare_map(void *ignore, struct database *db)
324 {
325     struct setting *s;
326
327     if (!db->settings)
328         return;
329     for (s = db->settings[PZ_XSLT]; s; s = s->next)
330     {
331         char **stylesheets;
332         struct database_retrievalmap **m = &db->map;
333         int num, i;
334
335         nmem_strsplit(nmem, ",", s->value, &stylesheets, &num);
336         for (i = 0; i < num; i++)
337         {
338             (*m) = nmem_malloc(nmem, sizeof(**m));
339             (*m)->next = 0;
340             if (!((*m)->stylesheet = conf_load_stylesheet(stylesheets[i])))
341             {
342                 yaz_log(YLOG_FATAL, "Unable to load stylesheet: %s",
343                         stylesheets[i]);
344                 exit(1);
345             }
346             m = &(*m)->next;
347         }
348     }
349     if (!db->map)
350         yaz_log(YLOG_WARN, "No Normalization stylesheet for target %s", db->url);
351 }
352
353 // Read settings for each database, and prepare support data structures
354 void prepare_databases(void)
355 {
356     grep_databases(0, 0, prepare_yazmarc);
357     grep_databases(0, 0, prepare_map);
358 }
359
360 // This function will most likely vanish when a proper target profile mechanism is
361 // introduced.
362 void load_simpletargets(const char *fn)
363 {
364     FILE *f = fopen(fn, "r");
365     char line[256];
366
367     if (!f)
368     {
369         yaz_log(YLOG_WARN|YLOG_ERRNO, "open %s", fn);
370         exit(1);
371     }
372
373     while (fgets(line, 255, f))
374     {
375         char *url;
376         char *name;
377         struct database *db;
378
379         if (strncmp(line, "target ", 7))
380             continue;
381         line[strlen(line) - 1] = '\0';
382
383         if ((name = strchr(line, ';')))
384             *(name++) = '\0';
385
386         url = line + 7;
387
388         if (!(db = find_database(url, 0)))
389             yaz_log(YLOG_WARN, "Unable to load database %s", url);
390     }
391     fclose(f);
392 }
393
394
395 /*
396  * Local variables:
397  * c-basic-offset: 4
398  * indent-tabs-mode: nil
399  * End:
400  * vim: shiftwidth=4 tabstop=8 expandtab
401  */