1 /* $Id: config.c,v 1.42 2007-10-31 05:29:08 quinn 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.42 2007-10-31 05:29:08 quinn 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 metadata->type = type;
68 // enforcing that type_year is always range_merge
69 if (metadata->type == Metadata_type_year)
70 metadata->merge = Metadata_merge_range;
72 metadata->merge = merge;
74 metadata->setting = setting;
75 metadata->brief = brief;
76 metadata->termlist = termlist;
77 metadata->rank = rank;
78 metadata->sortkey_offset = sortkey_offset;
83 struct conf_sortkey * conf_sortkey_assign(NMEM nmem,
84 struct conf_sortkey * sortkey,
86 enum conf_sortkey_type type)
88 if (!nmem || !sortkey || !name)
91 sortkey->name = nmem_strdup(nmem, name);
98 struct conf_service * conf_service_create(NMEM nmem,
99 int num_metadata, int num_sortkeys)
101 struct conf_service * service = 0;
105 service = nmem_malloc(nmem, sizeof(struct conf_service));
107 service->num_metadata = num_metadata;
108 service->metadata = 0;
109 if (service->num_metadata)
112 sizeof(struct conf_metadata) * service->num_metadata);
113 service->num_sortkeys = num_sortkeys;
114 service->sortkeys = 0;
115 if (service->num_sortkeys)
118 sizeof(struct conf_sortkey) * service->num_sortkeys);
123 struct conf_metadata* conf_service_add_metadata(NMEM nmem,
124 struct conf_service *service,
127 enum conf_metadata_type type,
128 enum conf_metadata_merge merge,
129 enum conf_setting_type setting,
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, setting,
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");
244 xmlChar *xml_setting = xmlGetProp(n, (xmlChar *) "setting");
246 enum conf_metadata_type type = Metadata_type_generic;
247 enum conf_metadata_merge merge = Metadata_merge_no;
248 enum conf_setting_type setting = Metadata_setting_no;
249 enum conf_sortkey_type sk_type = Metadata_sortkey_relevance;
253 int sortkey_offset = 0;
255 // now do the parsing logic
258 yaz_log(YLOG_FATAL, "Must specify name in metadata element");
263 if (!strcmp((const char *) xml_brief, "yes"))
265 else if (strcmp((const char *) xml_brief, "no"))
267 yaz_log(YLOG_FATAL, "metadata/brief must be yes or no");
276 if (!strcmp((const char *) xml_termlist, "yes"))
278 else if (strcmp((const char *) xml_termlist, "no"))
280 yaz_log(YLOG_FATAL, "metadata/termlist must be yes or no");
288 rank = atoi((const char *) xml_rank);
294 if (!strcmp((const char *) xml_type, "generic"))
295 type = Metadata_type_generic;
296 else if (!strcmp((const char *) xml_type, "year"))
297 type = Metadata_type_year;
298 else if (!strcmp((const char *) xml_type, "date"))
299 type = Metadata_type_date;
303 "Unknown value for metadata/type: %s", xml_type);
308 type = Metadata_type_generic;
312 if (!strcmp((const char *) xml_merge, "no"))
313 merge = Metadata_merge_no;
314 else if (!strcmp((const char *) xml_merge, "unique"))
315 merge = Metadata_merge_unique;
316 else if (!strcmp((const char *) xml_merge, "longest"))
317 merge = Metadata_merge_longest;
318 else if (!strcmp((const char *) xml_merge, "range"))
319 merge = Metadata_merge_range;
320 else if (!strcmp((const char *) xml_merge, "all"))
321 merge = Metadata_merge_all;
325 "Unknown value for metadata/merge: %s", xml_merge);
330 merge = Metadata_merge_no;
334 if (!strcmp((const char *) xml_setting, "no"))
335 setting = Metadata_setting_no;
336 else if (!strcmp((const char *) xml_setting, "postproc"))
337 setting = Metadata_setting_postproc;
338 else if (!strcmp((const char *) xml_setting, "parameter"))
339 setting = Metadata_setting_parameter;
343 "Unknown value for medadata/setting: %s", xml_setting);
348 // add a sortkey if so specified
349 if (xml_sortkey && strcmp((const char *) xml_sortkey, "no"))
351 if (merge == Metadata_merge_no)
354 "Can't specify sortkey on a non-merged field");
357 if (!strcmp((const char *) xml_sortkey, "numeric"))
358 sk_type = Metadata_sortkey_numeric;
359 else if (!strcmp((const char *) xml_sortkey, "skiparticle"))
360 sk_type = Metadata_sortkey_skiparticle;
364 "Unknown sortkey in metadata element: %s",
368 sortkey_offset = sk_node;
370 conf_service_add_sortkey(nmem, service, sk_node,
371 (const char *) xml_name, sk_type);
378 // metadata known, assign values
379 conf_service_add_metadata(nmem, service, md_node,
380 (const char *) xml_name,
381 type, merge, setting,
382 brief, termlist, rank, sortkey_offset);
386 xmlFree(xml_sortkey);
389 xmlFree(xml_termlist);
395 yaz_log(YLOG_FATAL, "Bad element: %s", n->name);
402 static char *parse_settings(xmlNode *node)
404 xmlChar *src = xmlGetProp(node, (xmlChar *) "src");
408 r = nmem_strdup(nmem, (const char *) src);
411 yaz_log(YLOG_FATAL, "Must specify src in targetprofile");
418 static struct conf_server *parse_server(xmlNode *node)
421 struct conf_server *server = nmem_malloc(nmem, sizeof(struct conf_server));
425 server->proxy_host = 0;
426 server->proxy_port = 0;
430 server->settings = 0;
431 server->relevance_pct = 0;
432 server->sort_pct = 0;
433 server->mergekey_pct = 0;
435 for (n = node->children; n; n = n->next)
437 if (n->type != XML_ELEMENT_NODE)
439 if (!strcmp((const char *) n->name, "listen"))
441 xmlChar *port = xmlGetProp(n, (xmlChar *) "port");
442 xmlChar *host = xmlGetProp(n, (xmlChar *) "host");
444 server->port = atoi((const char *) port);
446 server->host = nmem_strdup(nmem, (const char *) host);
450 else if (!strcmp((const char *) n->name, "proxy"))
452 xmlChar *port = xmlGetProp(n, (xmlChar *) "port");
453 xmlChar *host = xmlGetProp(n, (xmlChar *) "host");
454 xmlChar *myurl = xmlGetProp(n, (xmlChar *) "myurl");
456 server->proxy_port = atoi((const char *) port);
458 server->proxy_host = nmem_strdup(nmem, (const char *) host);
460 server->myurl = nmem_strdup(nmem, (const char *) myurl);
464 yaz_log(YLOG_FATAL, "Must specify @myurl for proxy");
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, "relevance"))
484 server->relevance_pct = pp2_charset_create_xml(n->children);
486 else if (!strcmp((const char *) n->name, "sort"))
488 server->sort_pct = pp2_charset_create_xml(n->children);
490 else if (!strcmp((const char *) n->name, "mergekey"))
492 server->mergekey_pct = pp2_charset_create_xml(n->children);
494 else if (!strcmp((const char *) n->name, "service"))
496 struct conf_service *s = parse_service(n);
503 yaz_log(YLOG_FATAL, "Bad element: %s", n->name);
507 if (!server->relevance_pct)
508 server->relevance_pct = pp2_charset_create(0);
509 if (!server->sort_pct)
510 server->sort_pct = pp2_charset_create(0);
511 if (!server->mergekey_pct)
512 server->mergekey_pct = pp2_charset_create(0);
516 xsltStylesheet *conf_load_stylesheet(const char *fname)
520 yaz_snprintf(path, sizeof(path), fname);
522 yaz_snprintf(path, sizeof(path), "%s/%s", confdir, fname);
523 return xsltParseStylesheetFile((xmlChar *) path);
526 static struct conf_targetprofiles *parse_targetprofiles(xmlNode *node)
528 struct conf_targetprofiles *r = nmem_malloc(nmem, sizeof(*r));
529 xmlChar *type = xmlGetProp(node, (xmlChar *) "type");
530 xmlChar *src = xmlGetProp(node, (xmlChar *) "src");
532 memset(r, 0, sizeof(*r));
536 if (!strcmp((const char *) type, "local"))
537 r->type = Targetprofiles_local;
540 yaz_log(YLOG_FATAL, "Unknown targetprofile type");
546 yaz_log(YLOG_FATAL, "Must specify type for targetprofile");
551 r->src = nmem_strdup(nmem, (const char *) src);
554 yaz_log(YLOG_FATAL, "Must specify src in targetprofile");
562 static struct conf_config *parse_config(xmlNode *root)
565 struct conf_config *r = nmem_malloc(nmem, sizeof(struct conf_config));
568 r->targetprofiles = 0;
570 for (n = root->children; n; n = n->next)
572 if (n->type != XML_ELEMENT_NODE)
574 if (!strcmp((const char *) n->name, "server"))
576 struct conf_server *tmp = parse_server(n);
579 tmp->next = r->servers;
582 else if (!strcmp((const char *) n->name, "targetprofiles"))
584 // It would be fun to be able to fix this sometime
585 if (r->targetprofiles)
587 yaz_log(YLOG_FATAL, "Can't repeat targetprofiles");
590 if (!(r->targetprofiles = parse_targetprofiles(n)))
595 yaz_log(YLOG_FATAL, "Bad element: %s", n->name);
602 int read_config(const char *fname)
604 xmlDoc *doc = xmlParseFile(fname);
607 if (!nmem) // Initialize
609 nmem = nmem_create();
610 xmlSubstituteEntitiesDefault(1);
611 xmlLoadExtDtdDefaultValue = 1;
615 yaz_log(YLOG_FATAL, "Failed to read %s", fname);
618 if ((p = strrchr(fname, '/')))
621 if (len >= sizeof(confdir))
622 len = sizeof(confdir)-1;
623 strncpy(confdir, fname, len);
626 config = parse_config(xmlDocGetRootElement(doc));
639 * indent-tabs-mode: nil
641 * vim: shiftwidth=4 tabstop=8 expandtab