1 /* $Id: config.c,v 1.37 2007-06-19 10:15:44 adam 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.37 2007-06-19 10:15:44 adam 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>
38 #include <yaz/snprintf.h>
40 #define CONFIG_NOEXTERNS
45 static char confdir[256] = ".";
47 struct conf_config *config = 0;
50 struct conf_metadata * conf_metadata_assign(NMEM nmem,
51 struct conf_metadata * metadata,
53 enum conf_metadata_type type,
54 enum conf_metadata_merge merge,
60 if (!nmem || !metadata || !name)
63 metadata->name = nmem_strdup(nmem, name);
65 // enforcing that merge_range is always type_year
66 if (merge == Metadata_merge_range)
67 metadata->type = Metadata_type_year;
69 metadata->type = type;
71 // enforcing that type_year is always range_merge
72 if (metadata->type == Metadata_type_year)
73 metadata->merge = Metadata_merge_range;
75 metadata->merge = merge;
77 metadata->brief = brief;
78 metadata->termlist = termlist;
79 metadata->rank = rank;
80 metadata->sortkey_offset = sortkey_offset;
85 struct conf_sortkey * conf_sortkey_assign(NMEM nmem,
86 struct conf_sortkey * sortkey,
88 enum conf_sortkey_type type)
90 if (!nmem || !sortkey || !name)
93 sortkey->name = nmem_strdup(nmem, name);
100 struct conf_service * conf_service_create(NMEM nmem,
101 int num_metadata, int num_sortkeys)
103 struct conf_service * service = 0;
107 service = nmem_malloc(nmem, sizeof(struct conf_service));
109 service->num_metadata = num_metadata;
110 service->metadata = 0;
111 if (service->num_metadata)
114 sizeof(struct conf_metadata) * service->num_metadata);
115 service->num_sortkeys = num_sortkeys;
116 service->sortkeys = 0;
117 if (service->num_sortkeys)
120 sizeof(struct conf_sortkey) * service->num_sortkeys);
125 struct conf_metadata* conf_service_add_metadata(NMEM nmem,
126 struct conf_service *service,
129 enum conf_metadata_type type,
130 enum conf_metadata_merge merge,
136 struct conf_metadata * md = 0;
138 if (!service || !service->metadata || !service->num_metadata
139 || field_id < 0 || !(field_id < service->num_metadata))
142 //md = &((service->metadata)[field_id]);
143 md = service->metadata + field_id;
144 md = conf_metadata_assign(nmem, md, name, type, merge,
145 brief, termlist, rank, sortkey_offset);
150 struct conf_sortkey * conf_service_add_sortkey(NMEM nmem,
151 struct conf_service *service,
154 enum conf_sortkey_type type)
156 struct conf_sortkey * sk = 0;
158 if (!service || !service->sortkeys || !service->num_sortkeys
159 || field_id < 0 || !(field_id < service->num_sortkeys))
162 //sk = &((service->sortkeys)[field_id]);
163 sk = service->sortkeys + field_id;
164 sk = conf_sortkey_assign(nmem, sk, name, type);
170 int conf_service_metadata_field_id(struct conf_service *service,
175 if (!service || !service->metadata || !service->num_metadata)
178 for(i = 0; i < service->num_metadata; i++) {
179 if (!strcmp(name, (service->metadata[i]).name))
187 int conf_service_sortkey_field_id(struct conf_service *service,
192 if (!service || !service->sortkeys || !service->num_sortkeys)
195 for(i = 0; i < service->num_sortkeys; i++) {
196 if (!strcmp(name, (service->sortkeys[i]).name))
205 /* Code to parse configuration file */
206 /* ==================================================== */
208 static struct conf_service *parse_service(xmlNode *node)
214 struct conf_service *service = 0;
215 int num_metadata = 0;
216 int num_sortkeys = 0;
218 // count num_metadata and num_sortkeys
219 for (n = node->children; n; n = n->next)
220 if (n->type == XML_ELEMENT_NODE && !strcmp((const char *)
221 n->name, "metadata"))
223 xmlChar *sortkey = xmlGetProp(n, (xmlChar *) "sortkey");
225 if (sortkey && strcmp((const char *) sortkey, "no"))
230 service = conf_service_create(nmem, num_metadata, num_sortkeys);
232 for (n = node->children; n; n = n->next)
234 if (n->type != XML_ELEMENT_NODE)
236 if (!strcmp((const char *) n->name, (const char *) "metadata"))
238 xmlChar *xml_name = xmlGetProp(n, (xmlChar *) "name");
239 xmlChar *xml_brief = xmlGetProp(n, (xmlChar *) "brief");
240 xmlChar *xml_sortkey = xmlGetProp(n, (xmlChar *) "sortkey");
241 xmlChar *xml_merge = xmlGetProp(n, (xmlChar *) "merge");
242 xmlChar *xml_type = xmlGetProp(n, (xmlChar *) "type");
243 xmlChar *xml_termlist = xmlGetProp(n, (xmlChar *) "termlist");
244 xmlChar *xml_rank = xmlGetProp(n, (xmlChar *) "rank");
246 enum conf_metadata_type type = Metadata_type_generic;
247 enum conf_metadata_merge merge = Metadata_merge_no;
251 int sortkey_offset = 0;
252 enum conf_sortkey_type sk_type = Metadata_sortkey_relevance;
254 // now do the parsing logic
257 yaz_log(YLOG_FATAL, "Must specify name in metadata element");
262 if (!strcmp((const char *) xml_brief, "yes"))
264 else if (strcmp((const char *) xml_brief, "no"))
266 yaz_log(YLOG_FATAL, "metadata/brief must be yes or no");
275 if (!strcmp((const char *) xml_termlist, "yes"))
277 else if (strcmp((const char *) xml_termlist, "no"))
279 yaz_log(YLOG_FATAL, "metadata/termlist must be yes or no");
287 rank = atoi((const char *) xml_rank);
293 if (!strcmp((const char *) xml_type, "generic"))
294 type = Metadata_type_generic;
295 else if (!strcmp((const char *) xml_type, "year"))
296 type = Metadata_type_year;
300 "Unknown value for metadata/type: %s", xml_type);
305 type = Metadata_type_generic;
309 if (!strcmp((const char *) xml_merge, "no"))
310 merge = Metadata_merge_no;
311 else if (!strcmp((const char *) xml_merge, "unique"))
312 merge = Metadata_merge_unique;
313 else if (!strcmp((const char *) xml_merge, "longest"))
314 merge = Metadata_merge_longest;
315 else if (!strcmp((const char *) xml_merge, "range"))
316 merge = Metadata_merge_range;
317 else if (!strcmp((const char *) xml_merge, "all"))
318 merge = Metadata_merge_all;
322 "Unknown value for metadata/merge: %s", xml_merge);
327 merge = Metadata_merge_no;
329 // add a sortkey if so specified
330 if (xml_sortkey && strcmp((const char *) xml_sortkey, "no"))
332 if (merge == Metadata_merge_no)
335 "Can't specify sortkey on a non-merged field");
338 if (!strcmp((const char *) xml_sortkey, "numeric"))
339 sk_type = Metadata_sortkey_numeric;
340 else if (!strcmp((const char *) xml_sortkey, "skiparticle"))
341 sk_type = Metadata_sortkey_skiparticle;
345 "Unknown sortkey in metadata element: %s",
349 sortkey_offset = sk_node;
351 conf_service_add_sortkey(nmem, service, sk_node,
352 (const char *) xml_name, sk_type);
359 // metadata known, assign values
360 conf_service_add_metadata(nmem, service, md_node,
361 (const char *) xml_name,
363 brief, termlist, rank, sortkey_offset);
367 xmlFree(xml_sortkey);
370 xmlFree(xml_termlist);
376 yaz_log(YLOG_FATAL, "Bad element: %s", n->name);
383 static char *parse_settings(xmlNode *node)
385 xmlChar *src = xmlGetProp(node, (xmlChar *) "src");
389 r = nmem_strdup(nmem, (const char *) src);
392 yaz_log(YLOG_FATAL, "Must specify src in targetprofile");
399 static struct conf_server *parse_server(xmlNode *node)
402 struct conf_server *server = nmem_malloc(nmem, sizeof(struct conf_server));
406 server->proxy_host = 0;
407 server->proxy_port = 0;
409 //server->zproxy_host = 0;
410 //server->zproxy_port = 0;
413 server->settings = 0;
420 for (n = node->children; n; n = n->next)
422 if (n->type != XML_ELEMENT_NODE)
424 if (!strcmp((const char *) n->name, "listen"))
426 xmlChar *port = xmlGetProp(n, (xmlChar *) "port");
427 xmlChar *host = xmlGetProp(n, (xmlChar *) "host");
429 server->port = atoi((const char *) port);
431 server->host = nmem_strdup(nmem, (const char *) host);
435 else if (!strcmp((const char *) n->name, "proxy"))
437 xmlChar *port = xmlGetProp(n, (xmlChar *) "port");
438 xmlChar *host = xmlGetProp(n, (xmlChar *) "host");
439 xmlChar *myurl = xmlGetProp(n, (xmlChar *) "myurl");
441 server->proxy_port = atoi((const char *) port);
443 server->proxy_host = nmem_strdup(nmem, (const char *) host);
445 server->myurl = nmem_strdup(nmem, (const char *) myurl);
449 yaz_log(YLOG_FATAL, "Must specify @myurl for proxy");
457 else if (!strcmp((const char *) n->name, "settings"))
459 if (server->settings)
461 yaz_log(YLOG_FATAL, "Can't repeat 'settings'");
464 if (!(server->settings = parse_settings(n)))
467 else if (!strcmp((const char *) n->name, "icu_chain"))
470 UErrorCode status = U_ZERO_ERROR;
471 struct icu_chain *chain = icu_chain_xml_config(n, &status);
472 if (!chain || U_FAILURE(status)){
473 //xmlDocPtr icu_doc = 0;
474 //xmlChar *xmlstr = 0;
476 //xmlDocDumpMemory(icu_doc, size);
478 yaz_log(YLOG_FATAL, "Could not parse ICU chain config:\n"
479 "<%s>\n ... \n</%s>",
483 server->icu_chn = chain;
485 yaz_log(YLOG_FATAL, "Error: ICU support requested with element:\n"
486 "<%s>\n ... \n</%s>",
489 "But no ICU support compiled into pazpar2 server.");
491 "Please install libicu36-dev and icu-doc or similar, "
492 "re-configure and re-compile");
496 else if (!strcmp((const char *) n->name, "service"))
498 struct conf_service *s = parse_service(n);
505 yaz_log(YLOG_FATAL, "Bad element: %s", n->name);
512 xsltStylesheet *conf_load_stylesheet(const char *fname)
516 yaz_snprintf(path, sizeof(path), fname);
518 yaz_snprintf(path, sizeof(path), "%s/%s", confdir, fname);
519 return xsltParseStylesheetFile((xmlChar *) path);
522 static struct conf_targetprofiles *parse_targetprofiles(xmlNode *node)
524 struct conf_targetprofiles *r = nmem_malloc(nmem, sizeof(*r));
525 xmlChar *type = xmlGetProp(node, (xmlChar *) "type");
526 xmlChar *src = xmlGetProp(node, (xmlChar *) "src");
528 memset(r, 0, sizeof(*r));
532 if (!strcmp((const char *) type, "local"))
533 r->type = Targetprofiles_local;
536 yaz_log(YLOG_FATAL, "Unknown targetprofile type");
542 yaz_log(YLOG_FATAL, "Must specify type for targetprofile");
547 r->src = nmem_strdup(nmem, (const char *) src);
550 yaz_log(YLOG_FATAL, "Must specify src in targetprofile");
558 static struct conf_config *parse_config(xmlNode *root)
561 struct conf_config *r = nmem_malloc(nmem, sizeof(struct conf_config));
564 r->targetprofiles = 0;
566 for (n = root->children; n; n = n->next)
568 if (n->type != XML_ELEMENT_NODE)
570 if (!strcmp((const char *) n->name, "server"))
572 struct conf_server *tmp = parse_server(n);
575 tmp->next = r->servers;
578 else if (!strcmp((const char *) n->name, "targetprofiles"))
580 // It would be fun to be able to fix this sometime
581 if (r->targetprofiles)
583 yaz_log(YLOG_FATAL, "Can't repeat targetprofiles");
586 if (!(r->targetprofiles = parse_targetprofiles(n)))
591 yaz_log(YLOG_FATAL, "Bad element: %s", n->name);
598 int read_config(const char *fname)
600 xmlDoc *doc = xmlParseFile(fname);
603 if (!nmem) // Initialize
605 nmem = nmem_create();
606 xmlSubstituteEntitiesDefault(1);
607 xmlLoadExtDtdDefaultValue = 1;
611 yaz_log(YLOG_FATAL, "Failed to read %s", fname);
614 if ((p = strrchr(fname, '/')))
617 if (len >= sizeof(confdir))
618 len = sizeof(confdir)-1;
619 strncpy(confdir, fname, len);
622 config = parse_config(xmlDocGetRootElement(doc));
635 * indent-tabs-mode: nil
637 * vim: shiftwidth=4 tabstop=8 expandtab