1 /* $Id: config.c,v 1.34 2007-05-23 11:19:31 marc Exp $
2 Copyright (c) 2006-2007, Index Data.
4 This file is part of Pazpar2.
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
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
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
22 /* $Id: config.c,v 1.34 2007-05-23 11:19:31 marc Exp $ */
26 #include <libxml/parser.h>
27 #include <libxml/tree.h>
28 #include <libxslt/xslt.h>
29 #include <libxslt/transform.h>
30 #include <libxslt/xsltutils.h>
36 #include <yaz/yaz-util.h>
39 #define CONFIG_NOEXTERNS
44 static char confdir[256] = ".";
46 struct conf_config *config = 0;
49 struct conf_metadata * conf_metadata_assign(NMEM nmem,
50 struct conf_metadata * metadata,
52 enum conf_metadata_type type,
53 enum conf_metadata_merge merge,
59 if (!nmem || !metadata || !name)
62 metadata->name = nmem_strdup(nmem, name);
64 // enforcing that merge_range is always type_year
65 if (merge == Metadata_merge_range)
66 metadata->type = Metadata_type_year;
68 metadata->type = type;
70 // enforcing that type_year is always range_merge
71 if (metadata->type == Metadata_type_year)
72 metadata->merge = Metadata_merge_range;
74 metadata->merge = merge;
76 metadata->brief = brief;
77 metadata->termlist = termlist;
78 metadata->rank = rank;
79 metadata->sortkey_offset = sortkey_offset;
84 struct conf_sortkey * conf_sortkey_assign(NMEM nmem,
85 struct conf_sortkey * sortkey,
87 enum conf_sortkey_type type)
89 if (!nmem || !sortkey || !name)
92 sortkey->name = nmem_strdup(nmem, name);
99 struct conf_service * conf_service_create(NMEM nmem,
100 int num_metadata, int num_sortkeys)
102 struct conf_service * service = 0;
106 service = nmem_malloc(nmem, sizeof(struct conf_service));
108 service->num_metadata = num_metadata;
109 service->metadata = 0;
110 if (service->num_metadata)
113 sizeof(struct conf_metadata) * service->num_metadata);
114 service->num_sortkeys = num_sortkeys;
115 service->sortkeys = 0;
116 if (service->num_sortkeys)
119 sizeof(struct conf_sortkey) * service->num_sortkeys);
124 struct conf_metadata* conf_service_add_metadata(NMEM nmem,
125 struct conf_service *service,
128 enum conf_metadata_type type,
129 enum conf_metadata_merge merge,
135 struct conf_metadata * md = 0;
137 if (!service || !service->metadata || !service->num_metadata
138 || field_id < 0 || !(field_id < service->num_metadata))
141 //md = &((service->metadata)[field_id]);
142 md = service->metadata + field_id;
143 md = conf_metadata_assign(nmem, md, name, type, merge,
144 brief, termlist, rank, sortkey_offset);
149 struct conf_sortkey * conf_service_add_sortkey(NMEM nmem,
150 struct conf_service *service,
153 enum conf_sortkey_type type)
155 struct conf_sortkey * sk = 0;
157 if (!service || !service->sortkeys || !service->num_sortkeys
158 || field_id < 0 || !(field_id < service->num_sortkeys))
161 //sk = &((service->sortkeys)[field_id]);
162 sk = service->sortkeys + field_id;
163 sk = conf_sortkey_assign(nmem, sk, name, type);
169 int conf_service_metadata_field_id(struct conf_service *service,
174 if (!service || !service->metadata || !service->num_metadata)
177 for(i = 0; i < service->num_metadata; i++) {
178 if (!strcmp(name, (service->metadata[i]).name))
186 int conf_service_sortkey_field_id(struct conf_service *service,
191 if (!service || !service->sortkeys || !service->num_sortkeys)
194 for(i = 0; i < service->num_sortkeys; i++) {
195 if (!strcmp(name, (service->sortkeys[i]).name))
204 /* Code to parse configuration file */
205 /* ==================================================== */
207 static struct conf_service *parse_service(xmlNode *node)
213 struct conf_service *service = 0;
214 int num_metadata = 0;
215 int num_sortkeys = 0;
217 // count num_metadata and num_sortkeys
218 for (n = node->children; n; n = n->next)
219 if (n->type == XML_ELEMENT_NODE && !strcmp((const char *)
220 n->name, "metadata"))
222 xmlChar *sortkey = xmlGetProp(n, (xmlChar *) "sortkey");
224 if (sortkey && strcmp((const char *) sortkey, "no"))
229 service = conf_service_create(nmem, num_metadata, num_sortkeys);
231 for (n = node->children; n; n = n->next)
233 if (n->type != XML_ELEMENT_NODE)
235 if (!strcmp((const char *) n->name, (const char *) "metadata"))
237 xmlChar *xml_name = xmlGetProp(n, (xmlChar *) "name");
238 xmlChar *xml_brief = xmlGetProp(n, (xmlChar *) "brief");
239 xmlChar *xml_sortkey = xmlGetProp(n, (xmlChar *) "sortkey");
240 xmlChar *xml_merge = xmlGetProp(n, (xmlChar *) "merge");
241 xmlChar *xml_type = xmlGetProp(n, (xmlChar *) "type");
242 xmlChar *xml_termlist = xmlGetProp(n, (xmlChar *) "termlist");
243 xmlChar *xml_rank = xmlGetProp(n, (xmlChar *) "rank");
245 enum conf_metadata_type type = Metadata_type_generic;
246 enum conf_metadata_merge merge = Metadata_merge_no;
250 int sortkey_offset = 0;
251 enum conf_sortkey_type sk_type = Metadata_sortkey_relevance;
253 // now do the parsing logic
256 yaz_log(YLOG_FATAL, "Must specify name in metadata element");
261 if (!strcmp((const char *) xml_brief, "yes"))
263 else if (strcmp((const char *) xml_brief, "no"))
265 yaz_log(YLOG_FATAL, "metadata/brief must be yes or no");
274 if (!strcmp((const char *) xml_termlist, "yes"))
276 else if (strcmp((const char *) xml_termlist, "no"))
278 yaz_log(YLOG_FATAL, "metadata/termlist must be yes or no");
286 rank = atoi((const char *) xml_rank);
292 if (!strcmp((const char *) xml_type, "generic"))
293 type = Metadata_type_generic;
294 else if (!strcmp((const char *) xml_type, "year"))
295 type = Metadata_type_year;
299 "Unknown value for metadata/type: %s", xml_type);
304 type = Metadata_type_generic;
308 if (!strcmp((const char *) xml_merge, "no"))
309 merge = Metadata_merge_no;
310 else if (!strcmp((const char *) xml_merge, "unique"))
311 merge = Metadata_merge_unique;
312 else if (!strcmp((const char *) xml_merge, "longest"))
313 merge = Metadata_merge_longest;
314 else if (!strcmp((const char *) xml_merge, "range"))
315 merge = Metadata_merge_range;
316 else if (!strcmp((const char *) xml_merge, "all"))
317 merge = Metadata_merge_all;
321 "Unknown value for metadata/merge: %s", xml_merge);
326 merge = Metadata_merge_no;
328 // add a sortkey if so specified
329 if (xml_sortkey && strcmp((const char *) xml_sortkey, "no"))
331 if (merge == Metadata_merge_no)
334 "Can't specify sortkey on a non-merged field");
337 if (!strcmp((const char *) xml_sortkey, "numeric"))
338 sk_type = Metadata_sortkey_numeric;
339 else if (!strcmp((const char *) xml_sortkey, "skiparticle"))
340 sk_type = Metadata_sortkey_skiparticle;
344 "Unknown sortkey in metadata element: %s",
348 sortkey_offset = sk_node;
350 conf_service_add_sortkey(nmem, service, sk_node,
351 (const char *) xml_name, sk_type);
358 // metadata known, assign values
359 conf_service_add_metadata(nmem, service, md_node,
360 (const char *) xml_name,
362 brief, termlist, rank, sortkey_offset);
366 xmlFree(xml_sortkey);
369 xmlFree(xml_termlist);
375 yaz_log(YLOG_FATAL, "Bad element: %s", n->name);
382 static char *parse_settings(xmlNode *node)
384 xmlChar *src = xmlGetProp(node, (xmlChar *) "src");
388 r = nmem_strdup(nmem, (const char *) src);
391 yaz_log(YLOG_FATAL, "Must specify src in targetprofile");
398 static struct conf_server *parse_server(xmlNode *node)
401 struct conf_server *server = nmem_malloc(nmem, sizeof(struct conf_server));
405 server->proxy_host = 0;
406 server->proxy_port = 0;
408 server->zproxy_host = 0;
409 server->zproxy_port = 0;
412 server->settings = 0;
419 for (n = node->children; n; n = n->next)
421 if (n->type != XML_ELEMENT_NODE)
423 if (!strcmp((const char *) n->name, "listen"))
425 xmlChar *port = xmlGetProp(n, (xmlChar *) "port");
426 xmlChar *host = xmlGetProp(n, (xmlChar *) "host");
428 server->port = atoi((const char *) port);
430 server->host = nmem_strdup(nmem, (const char *) host);
434 else if (!strcmp((const char *) n->name, "proxy"))
436 xmlChar *port = xmlGetProp(n, (xmlChar *) "port");
437 xmlChar *host = xmlGetProp(n, (xmlChar *) "host");
438 xmlChar *myurl = xmlGetProp(n, (xmlChar *) "myurl");
440 server->proxy_port = atoi((const char *) port);
442 server->proxy_host = nmem_strdup(nmem, (const char *) host);
444 server->myurl = nmem_strdup(nmem, (const char *) myurl);
448 yaz_log(YLOG_FATAL, "Must specify @myurl for proxy");
456 else if (!strcmp((const char *) n->name, "zproxy"))
461 port = xmlGetProp(n, (xmlChar *) "port");
462 host = xmlGetProp(n, (xmlChar *) "host");
465 server->zproxy_port = atoi((const char *) port);
467 server->zproxy_host = nmem_strdup(nmem, (const char *) host);
472 else if (!strcmp((const char *) n->name, "settings"))
474 if (server->settings)
476 yaz_log(YLOG_FATAL, "Can't repeat 'settings'");
479 if (!(server->settings = parse_settings(n)))
482 else if (!strcmp((const char *) n->name, "icu_chain"))
485 UErrorCode status = U_ZERO_ERROR;
486 struct icu_chain *chain = icu_chain_xml_config(n, &status);
487 if (!chain || U_FAILURE(status)){
488 //xmlDocPtr icu_doc = 0;
489 //xmlChar *xmlstr = 0;
491 //xmlDocDumpMemory(icu_doc, size);
493 yaz_log(YLOG_FATAL, "Could not parse ICU chain config:\n"
494 "<%s>\n ... \n</%s>",
498 server->icu_chn = chain;
500 yaz_log(YLOG_FATAL, "Error: ICU support requested with element:\n"
501 "<%s>\n ... \n</%s>",
504 "But no ICU support compiled into pazpar2 server.");
506 "Please install libicu36-dev and icu-doc or similar, "
507 "re-configure and re-compile");
511 else if (!strcmp((const char *) n->name, "service"))
513 struct conf_service *s = parse_service(n);
520 yaz_log(YLOG_FATAL, "Bad element: %s", n->name);
527 xsltStylesheet *conf_load_stylesheet(const char *fname)
530 sprintf(path, "%s/%s", confdir, fname);
531 return xsltParseStylesheetFile((xmlChar *) path);
534 static struct conf_targetprofiles *parse_targetprofiles(xmlNode *node)
536 struct conf_targetprofiles *r = nmem_malloc(nmem, sizeof(*r));
537 xmlChar *type = xmlGetProp(node, (xmlChar *) "type");
538 xmlChar *src = xmlGetProp(node, (xmlChar *) "src");
540 memset(r, 0, sizeof(*r));
544 if (!strcmp((const char *) type, "local"))
545 r->type = Targetprofiles_local;
548 yaz_log(YLOG_FATAL, "Unknown targetprofile type");
554 yaz_log(YLOG_FATAL, "Must specify type for targetprofile");
559 r->src = nmem_strdup(nmem, (const char *) src);
562 yaz_log(YLOG_FATAL, "Must specify src in targetprofile");
570 static struct conf_config *parse_config(xmlNode *root)
573 struct conf_config *r = nmem_malloc(nmem, sizeof(struct conf_config));
576 r->targetprofiles = 0;
578 for (n = root->children; n; n = n->next)
580 if (n->type != XML_ELEMENT_NODE)
582 if (!strcmp((const char *) n->name, "server"))
584 struct conf_server *tmp = parse_server(n);
587 tmp->next = r->servers;
590 else if (!strcmp((const char *) n->name, "targetprofiles"))
592 // It would be fun to be able to fix this sometime
593 if (r->targetprofiles)
595 yaz_log(YLOG_FATAL, "Can't repeat targetprofiles");
598 if (!(r->targetprofiles = parse_targetprofiles(n)))
603 yaz_log(YLOG_FATAL, "Bad element: %s", n->name);
610 int read_config(const char *fname)
612 xmlDoc *doc = xmlParseFile(fname);
615 if (!nmem) // Initialize
617 nmem = nmem_create();
618 xmlSubstituteEntitiesDefault(1);
619 xmlLoadExtDtdDefaultValue = 1;
623 yaz_log(YLOG_FATAL, "Failed to read %s", fname);
626 if ((p = strrchr(fname, '/')))
629 strncpy(confdir, fname, len);
632 config = parse_config(xmlDocGetRootElement(doc));
645 * indent-tabs-mode: nil
647 * vim: shiftwidth=4 tabstop=8 expandtab