GPLv2. Added appendix with full license. Added refernece to that from
[pazpar2-moved-to-github.git] / src / database.c
1 /* $Id: database.c,v 1.8 2007-04-10 08:48:56 adam 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 = get_explain_xml(id);
130     struct zr_explain *explain = 0;
131     struct database *db;
132     struct host *host;
133     char hostport[256];
134     char *dbname;
135
136     if (!nmem)
137         nmem = nmem_create();
138     if (doc)
139     {
140         explain = zr_read_xml(nmem, xmlDocGetRootElement(doc));
141         if (!explain)
142             return 0;
143     }
144     if (strlen(id) > 255)
145         return 0;
146     strcpy(hostport, id);
147     if ((dbname = strchr(hostport, '/')))
148         *(dbname++) = '\0';
149     else
150         dbname = "Default";
151     if (!(host = find_host(hostport)))
152         return 0;
153     db = nmem_malloc(nmem, sizeof(*db));
154     memset(db, 0, sizeof(*db));
155     db->host = host;
156     db->url = nmem_strdup(nmem, id);
157     db->name = 0;
158     db->databases = xmalloc(2 * sizeof(char *));
159     db->databases[0] = nmem_strdup(nmem, dbname);
160     db->databases[1] = 0;
161     db->errors = 0;
162     db->explain = explain;
163     db->settings = 0;
164     db->next = databases;
165     db->ccl_map = 0;
166     db->yaz_marc = 0;
167     db->map = 0;
168     databases = db;
169
170     return db;
171 }
172
173 // Return a database structure by ID. Load and add to list if necessary
174 // new==1 just means we know it's not in the list
175 struct database *find_database(const char *id, int new)
176 {
177     struct database *p;
178     if (!new)
179     {
180         for (p = databases; p; p = p->next)
181             if (!strcmp(p->url, id))
182                 return p;
183     }
184     return load_database(id);
185 }
186
187 static int match_zurl(const char *zurl, const char *pattern)
188 {
189     if (!strcmp(pattern, "*"))
190         return 1;
191     else if (!strncmp(pattern, "*/", 2))
192     {
193         char *db = strchr(zurl, '/');
194         if (!db)
195             return 0;
196         if (!strcmp(pattern + 2, db))
197             return 1;
198         else
199             return 0;
200     }
201     else if (!strcmp(pattern, zurl))
202         return 1;
203     else
204         return 0;
205 }
206
207 // This will be generalized at some point
208 static int match_criterion(struct database *db, struct database_criterion *c)
209 {
210     if (!strcmp(c->name, "id"))
211     {
212         struct database_criterion_value *v;
213         for (v = c->values; v; v = v->next)
214             if (match_zurl(db->url, v->value))
215                 return 1;
216         return 0;
217     }
218     else
219         return 0;
220 }
221
222 int database_match_criteria(struct database *db, struct database_criterion *cl)
223 {
224     for (; cl; cl = cl->next)
225         if (!match_criterion(db, cl))
226             break;
227     if (cl) // one of the criteria failed to match -- skip this db
228         return 0;
229     else
230         return 1;
231 }
232
233 // Cycles through databases, calling a handler function on the ones for
234 // which all criteria matched.
235 int grep_databases(void *context, struct database_criterion *cl,
236         void (*fun)(void *context, struct database *db))
237 {
238     struct database *p;
239     int i;
240
241     for (p = databases; p; p = p->next)
242     {
243         if (database_match_criteria(p, cl))
244         {
245             (*fun)(context, p);
246             i++;
247         }
248     }
249     return i;
250 }
251
252 // Initialize CCL map for a target
253 // Note: This approach ignores user-specific CCL maps, for which I
254 // don't presently see any application.
255 static void prepare_cclmap(void *ignore, struct database *db)
256 {
257     struct setting *s;
258
259     if (!db->settings)
260         return;
261     db->ccl_map = ccl_qual_mk();
262     for (s = db->settings[PZ_CCLMAP]; s; s = s->next)
263         if (!*s->user)
264         {
265             char *p = strchr(s->name + 3, ':');
266             if (!p)
267             {
268                 yaz_log(YLOG_FATAL, "Malformed cclmap name: %s", s->name);
269                 exit(1);
270             }
271             p++;
272             ccl_qual_fitem(db->ccl_map, s->value, p);
273         }
274 }
275
276 // Initialize YAZ Map structures for MARC-based targets
277 static void prepare_yazmarc(void *ignore, struct database *db)
278 {
279     struct setting *s;
280
281     if (!db->settings)
282         return;
283     for (s = db->settings[PZ_NATIVESYNTAX]; s; s = s->next)
284         if (!*s->user && !strcmp(s->value, "iso2709"))
285         {
286             char *encoding = "marc-8s";
287             yaz_iconv_t cm;
288
289             db->yaz_marc = yaz_marc_create();
290             yaz_marc_subfield_str(db->yaz_marc, "\t");
291             // See if a native encoding is specified
292             for (s = db->settings[PZ_ENCODING]; s; s = s->next)
293                 if (!*s->user)
294                 {
295                     encoding = s->value;
296                     break;
297                 }
298             if (!(cm = yaz_iconv_open("utf-8", encoding)))
299             {
300                 yaz_log(YLOG_FATAL, "Unable to map from %s to UTF-8", encoding);
301                 exit(1);
302             }
303             yaz_marc_iconv(db->yaz_marc, cm);
304             break;
305         }
306 }
307
308 // Prepare XSLT stylesheets for record normalization
309 static void prepare_map(void *ignore, struct database *db)
310 {
311     struct setting *s;
312
313     if (!db->settings)
314         return;
315     for (s = db->settings[PZ_XSLT]; s; s = s->next)
316         if (!*s->user)
317         {
318             char **stylesheets;
319             struct database_retrievalmap **m = &db->map;
320             int num, i;
321
322             nmem_strsplit(nmem, ",", s->value, &stylesheets, &num);
323             for (i = 0; i < num; i++)
324             {
325                 (*m) = nmem_malloc(nmem, sizeof(**m));
326                 (*m)->next = 0;
327                 if (!((*m)->stylesheet = conf_load_stylesheet(stylesheets[i])))
328                 {
329                     yaz_log(YLOG_FATAL, "Unable to load stylesheet: %s",
330                             stylesheets[i]);
331                     exit(1);
332                 }
333                 m = &(*m)->next;
334             }
335             break;
336         }
337     if (!s)
338         yaz_log(YLOG_WARN, "No Normalization stylesheet for target %s", db->url);
339 }
340
341 // Read settings for each database, and prepare support data structures
342 void prepare_databases(void)
343 {
344     grep_databases(0, 0, prepare_cclmap);
345     grep_databases(0, 0, prepare_yazmarc);
346     grep_databases(0, 0, prepare_map);
347 }
348
349 // This function will most likely vanish when a proper target profile mechanism is
350 // introduced.
351 void load_simpletargets(const char *fn)
352 {
353     FILE *f = fopen(fn, "r");
354     char line[256];
355
356     if (!f)
357     {
358         yaz_log(YLOG_WARN|YLOG_ERRNO, "open %s", fn);
359         exit(1);
360     }
361
362     while (fgets(line, 255, f))
363     {
364         char *url;
365         char *name;
366         struct database *db;
367
368         if (strncmp(line, "target ", 7))
369             continue;
370         line[strlen(line) - 1] = '\0';
371
372         if ((name = strchr(line, ';')))
373             *(name++) = '\0';
374
375         url = line + 7;
376
377         if (!(db = find_database(url, 0)))
378             yaz_log(YLOG_WARN, "Unable to load database %s", url);
379         if (name && db)
380             db->name = nmem_strdup(nmem, name);
381     }
382     fclose(f);
383 }
384
385
386 /*
387  * Local variables:
388  * c-basic-offset: 4
389  * indent-tabs-mode: nil
390  * End:
391  * vim: shiftwidth=4 tabstop=8 expandtab
392  */