1 /* $Id: config.c,v 1.41 2007-09-10 16:25:50 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.41 2007-09-10 16:25:50 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,
55 enum conf_setting_type setting,
61 if (!nmem || !metadata || !name)
64 metadata->name = nmem_strdup(nmem, name);
66 // enforcing that merge_range is always type_year
67 if (merge == Metadata_merge_range)
68 metadata->type = Metadata_type_year;
70 metadata->type = type;
72 // enforcing that type_year is always range_merge
73 if (metadata->type == Metadata_type_year)
74 metadata->merge = Metadata_merge_range;
76 metadata->merge = merge;
78 metadata->setting = setting;
79 metadata->brief = brief;
80 metadata->termlist = termlist;
81 metadata->rank = rank;
82 metadata->sortkey_offset = sortkey_offset;
87 struct conf_sortkey * conf_sortkey_assign(NMEM nmem,
88 struct conf_sortkey * sortkey,
90 enum conf_sortkey_type type)
92 if (!nmem || !sortkey || !name)
95 sortkey->name = nmem_strdup(nmem, name);
102 struct conf_service * conf_service_create(NMEM nmem,
103 int num_metadata, int num_sortkeys)
105 struct conf_service * service = 0;
109 service = nmem_malloc(nmem, sizeof(struct conf_service));
111 service->num_metadata = num_metadata;
112 service->metadata = 0;
113 if (service->num_metadata)
116 sizeof(struct conf_metadata) * service->num_metadata);
117 service->num_sortkeys = num_sortkeys;
118 service->sortkeys = 0;
119 if (service->num_sortkeys)
122 sizeof(struct conf_sortkey) * service->num_sortkeys);
127 struct conf_metadata* conf_service_add_metadata(NMEM nmem,
128 struct conf_service *service,
131 enum conf_metadata_type type,
132 enum conf_metadata_merge merge,
133 enum conf_setting_type setting,
139 struct conf_metadata * md = 0;
141 if (!service || !service->metadata || !service->num_metadata
142 || field_id < 0 || !(field_id < service->num_metadata))
145 //md = &((service->metadata)[field_id]);
146 md = service->metadata + field_id;
147 md = conf_metadata_assign(nmem, md, name, type, merge, setting,
148 brief, termlist, rank, sortkey_offset);
153 struct conf_sortkey * conf_service_add_sortkey(NMEM nmem,
154 struct conf_service *service,
157 enum conf_sortkey_type type)
159 struct conf_sortkey * sk = 0;
161 if (!service || !service->sortkeys || !service->num_sortkeys
162 || field_id < 0 || !(field_id < service->num_sortkeys))
165 //sk = &((service->sortkeys)[field_id]);
166 sk = service->sortkeys + field_id;
167 sk = conf_sortkey_assign(nmem, sk, name, type);
173 int conf_service_metadata_field_id(struct conf_service *service,
178 if (!service || !service->metadata || !service->num_metadata)
181 for(i = 0; i < service->num_metadata; i++) {
182 if (!strcmp(name, (service->metadata[i]).name))
190 int conf_service_sortkey_field_id(struct conf_service *service,
195 if (!service || !service->sortkeys || !service->num_sortkeys)
198 for(i = 0; i < service->num_sortkeys; i++) {
199 if (!strcmp(name, (service->sortkeys[i]).name))
208 /* Code to parse configuration file */
209 /* ==================================================== */
211 static struct conf_service *parse_service(xmlNode *node)
217 struct conf_service *service = 0;
218 int num_metadata = 0;
219 int num_sortkeys = 0;
221 // count num_metadata and num_sortkeys
222 for (n = node->children; n; n = n->next)
223 if (n->type == XML_ELEMENT_NODE && !strcmp((const char *)
224 n->name, "metadata"))
226 xmlChar *sortkey = xmlGetProp(n, (xmlChar *) "sortkey");
228 if (sortkey && strcmp((const char *) sortkey, "no"))
233 service = conf_service_create(nmem, num_metadata, num_sortkeys);
235 for (n = node->children; n; n = n->next)
237 if (n->type != XML_ELEMENT_NODE)
239 if (!strcmp((const char *) n->name, (const char *) "metadata"))
241 xmlChar *xml_name = xmlGetProp(n, (xmlChar *) "name");
242 xmlChar *xml_brief = xmlGetProp(n, (xmlChar *) "brief");
243 xmlChar *xml_sortkey = xmlGetProp(n, (xmlChar *) "sortkey");
244 xmlChar *xml_merge = xmlGetProp(n, (xmlChar *) "merge");
245 xmlChar *xml_type = xmlGetProp(n, (xmlChar *) "type");
246 xmlChar *xml_termlist = xmlGetProp(n, (xmlChar *) "termlist");
247 xmlChar *xml_rank = xmlGetProp(n, (xmlChar *) "rank");
248 xmlChar *xml_setting = xmlGetProp(n, (xmlChar *) "setting");
250 enum conf_metadata_type type = Metadata_type_generic;
251 enum conf_metadata_merge merge = Metadata_merge_no;
252 enum conf_setting_type setting = Metadata_setting_no;
253 enum conf_sortkey_type sk_type = Metadata_sortkey_relevance;
257 int sortkey_offset = 0;
259 // now do the parsing logic
262 yaz_log(YLOG_FATAL, "Must specify name in metadata element");
267 if (!strcmp((const char *) xml_brief, "yes"))
269 else if (strcmp((const char *) xml_brief, "no"))
271 yaz_log(YLOG_FATAL, "metadata/brief must be yes or no");
280 if (!strcmp((const char *) xml_termlist, "yes"))
282 else if (strcmp((const char *) xml_termlist, "no"))
284 yaz_log(YLOG_FATAL, "metadata/termlist must be yes or no");
292 rank = atoi((const char *) xml_rank);
298 if (!strcmp((const char *) xml_type, "generic"))
299 type = Metadata_type_generic;
300 else if (!strcmp((const char *) xml_type, "year"))
301 type = Metadata_type_year;
305 "Unknown value for metadata/type: %s", xml_type);
310 type = Metadata_type_generic;
314 if (!strcmp((const char *) xml_merge, "no"))
315 merge = Metadata_merge_no;
316 else if (!strcmp((const char *) xml_merge, "unique"))
317 merge = Metadata_merge_unique;
318 else if (!strcmp((const char *) xml_merge, "longest"))
319 merge = Metadata_merge_longest;
320 else if (!strcmp((const char *) xml_merge, "range"))
321 merge = Metadata_merge_range;
322 else if (!strcmp((const char *) xml_merge, "all"))
323 merge = Metadata_merge_all;
327 "Unknown value for metadata/merge: %s", xml_merge);
332 merge = Metadata_merge_no;
336 if (!strcmp((const char *) xml_setting, "no"))
337 setting = Metadata_setting_no;
338 else if (!strcmp((const char *) xml_setting, "postproc"))
339 setting = Metadata_setting_postproc;
340 else if (!strcmp((const char *) xml_setting, "parameter"))
341 setting = Metadata_setting_parameter;
345 "Unknown value for medadata/setting: %s", xml_setting);
350 // add a sortkey if so specified
351 if (xml_sortkey && strcmp((const char *) xml_sortkey, "no"))
353 if (merge == Metadata_merge_no)
356 "Can't specify sortkey on a non-merged field");
359 if (!strcmp((const char *) xml_sortkey, "numeric"))
360 sk_type = Metadata_sortkey_numeric;
361 else if (!strcmp((const char *) xml_sortkey, "skiparticle"))
362 sk_type = Metadata_sortkey_skiparticle;
366 "Unknown sortkey in metadata element: %s",
370 sortkey_offset = sk_node;
372 conf_service_add_sortkey(nmem, service, sk_node,
373 (const char *) xml_name, sk_type);
380 // metadata known, assign values
381 conf_service_add_metadata(nmem, service, md_node,
382 (const char *) xml_name,
383 type, merge, setting,
384 brief, termlist, rank, sortkey_offset);
388 xmlFree(xml_sortkey);
391 xmlFree(xml_termlist);
397 yaz_log(YLOG_FATAL, "Bad element: %s", n->name);
404 static char *parse_settings(xmlNode *node)
406 xmlChar *src = xmlGetProp(node, (xmlChar *) "src");
410 r = nmem_strdup(nmem, (const char *) src);
413 yaz_log(YLOG_FATAL, "Must specify src in targetprofile");
420 static struct conf_server *parse_server(xmlNode *node)
423 struct conf_server *server = nmem_malloc(nmem, sizeof(struct conf_server));
427 server->proxy_host = 0;
428 server->proxy_port = 0;
432 server->settings = 0;
433 server->relevance_pct = 0;
434 server->sort_pct = 0;
435 server->mergekey_pct = 0;
437 for (n = node->children; n; n = n->next)
439 if (n->type != XML_ELEMENT_NODE)
441 if (!strcmp((const char *) n->name, "listen"))
443 xmlChar *port = xmlGetProp(n, (xmlChar *) "port");
444 xmlChar *host = xmlGetProp(n, (xmlChar *) "host");
446 server->port = atoi((const char *) port);
448 server->host = nmem_strdup(nmem, (const char *) host);
452 else if (!strcmp((const char *) n->name, "proxy"))
454 xmlChar *port = xmlGetProp(n, (xmlChar *) "port");
455 xmlChar *host = xmlGetProp(n, (xmlChar *) "host");
456 xmlChar *myurl = xmlGetProp(n, (xmlChar *) "myurl");
458 server->proxy_port = atoi((const char *) port);
460 server->proxy_host = nmem_strdup(nmem, (const char *) host);
462 server->myurl = nmem_strdup(nmem, (const char *) myurl);
466 yaz_log(YLOG_FATAL, "Must specify @myurl for proxy");
474 else if (!strcmp((const char *) n->name, "settings"))
476 if (server->settings)
478 yaz_log(YLOG_FATAL, "Can't repeat 'settings'");
481 if (!(server->settings = parse_settings(n)))
484 else if (!strcmp((const char *) n->name, "relevance"))
486 server->relevance_pct = pp2_charset_create_xml(n->children);
488 else if (!strcmp((const char *) n->name, "sort"))
490 server->sort_pct = pp2_charset_create_xml(n->children);
492 else if (!strcmp((const char *) n->name, "mergekey"))
494 server->mergekey_pct = pp2_charset_create_xml(n->children);
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);
509 if (!server->relevance_pct)
510 server->relevance_pct = pp2_charset_create(0);
511 if (!server->sort_pct)
512 server->sort_pct = pp2_charset_create(0);
513 if (!server->mergekey_pct)
514 server->mergekey_pct = pp2_charset_create(0);
518 xsltStylesheet *conf_load_stylesheet(const char *fname)
522 yaz_snprintf(path, sizeof(path), fname);
524 yaz_snprintf(path, sizeof(path), "%s/%s", confdir, fname);
525 return xsltParseStylesheetFile((xmlChar *) path);
528 static struct conf_targetprofiles *parse_targetprofiles(xmlNode *node)
530 struct conf_targetprofiles *r = nmem_malloc(nmem, sizeof(*r));
531 xmlChar *type = xmlGetProp(node, (xmlChar *) "type");
532 xmlChar *src = xmlGetProp(node, (xmlChar *) "src");
534 memset(r, 0, sizeof(*r));
538 if (!strcmp((const char *) type, "local"))
539 r->type = Targetprofiles_local;
542 yaz_log(YLOG_FATAL, "Unknown targetprofile type");
548 yaz_log(YLOG_FATAL, "Must specify type for targetprofile");
553 r->src = nmem_strdup(nmem, (const char *) src);
556 yaz_log(YLOG_FATAL, "Must specify src in targetprofile");
564 static struct conf_config *parse_config(xmlNode *root)
567 struct conf_config *r = nmem_malloc(nmem, sizeof(struct conf_config));
570 r->targetprofiles = 0;
572 for (n = root->children; n; n = n->next)
574 if (n->type != XML_ELEMENT_NODE)
576 if (!strcmp((const char *) n->name, "server"))
578 struct conf_server *tmp = parse_server(n);
581 tmp->next = r->servers;
584 else if (!strcmp((const char *) n->name, "targetprofiles"))
586 // It would be fun to be able to fix this sometime
587 if (r->targetprofiles)
589 yaz_log(YLOG_FATAL, "Can't repeat targetprofiles");
592 if (!(r->targetprofiles = parse_targetprofiles(n)))
597 yaz_log(YLOG_FATAL, "Bad element: %s", n->name);
604 int read_config(const char *fname)
606 xmlDoc *doc = xmlParseFile(fname);
609 if (!nmem) // Initialize
611 nmem = nmem_create();
612 xmlSubstituteEntitiesDefault(1);
613 xmlLoadExtDtdDefaultValue = 1;
617 yaz_log(YLOG_FATAL, "Failed to read %s", fname);
620 if ((p = strrchr(fname, '/')))
623 if (len >= sizeof(confdir))
624 len = sizeof(confdir)-1;
625 strncpy(confdir, fname, len);
628 config = parse_config(xmlDocGetRootElement(doc));
641 * indent-tabs-mode: nil
643 * vim: shiftwidth=4 tabstop=8 expandtab