1 /* This file is part of Pazpar2.
2 Copyright (C) 2006-2009 Index Data
4 Pazpar2 is free software; you can redistribute it and/or modify it under
5 the terms of the GNU General Public License as published by the Free
6 Software Foundation; either version 2, or (at your option) any later
9 Pazpar2 is distributed in the hope that it will be useful, but WITHOUT ANY
10 WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 You should have received a copy of the GNU General Public License
15 along with this program; if not, write to the Free Software
16 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
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>
32 #include <yaz/yaz-util.h>
34 #include <yaz/snprintf.h>
35 #include <yaz/tpath.h>
37 #define CONFIG_NOEXTERNS
38 #include "pazpar2_config.h"
42 static char confdir[256] = ".";
44 struct conf_config *config = 0;
48 struct conf_metadata * conf_metadata_assign(NMEM nmem,
49 struct conf_metadata * metadata,
51 enum conf_metadata_type type,
52 enum conf_metadata_merge merge,
53 enum conf_setting_type setting,
58 enum conf_metadata_mergekey mt)
60 if (!nmem || !metadata || !name)
63 metadata->name = nmem_strdup(nmem, name);
65 metadata->type = type;
67 // enforcing that type_year is always range_merge
68 if (metadata->type == Metadata_type_year)
69 metadata->merge = Metadata_merge_range;
71 metadata->merge = merge;
73 metadata->setting = setting;
74 metadata->brief = brief;
75 metadata->termlist = termlist;
76 metadata->rank = rank;
77 metadata->sortkey_offset = sortkey_offset;
78 metadata->mergekey = mt;
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);
122 service->dictionary = 0;
126 struct conf_metadata* conf_service_add_metadata(NMEM nmem,
127 struct conf_service *service,
130 enum conf_metadata_type type,
131 enum conf_metadata_merge merge,
132 enum conf_setting_type setting,
137 enum conf_metadata_mergekey mt)
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,
154 struct conf_sortkey * conf_service_add_sortkey(NMEM nmem,
155 struct conf_service *service,
158 enum conf_sortkey_type type)
160 struct conf_sortkey * sk = 0;
162 if (!service || !service->sortkeys || !service->num_sortkeys
163 || field_id < 0 || !(field_id < service->num_sortkeys))
166 //sk = &((service->sortkeys)[field_id]);
167 sk = service->sortkeys + field_id;
168 sk = conf_sortkey_assign(nmem, sk, name, type);
174 int conf_service_metadata_field_id(struct conf_service *service,
179 if (!service || !service->metadata || !service->num_metadata)
182 for(i = 0; i < service->num_metadata; i++) {
183 if (!strcmp(name, (service->metadata[i]).name))
191 int conf_service_sortkey_field_id(struct conf_service *service,
196 if (!service || !service->sortkeys || !service->num_sortkeys)
199 for(i = 0; i < service->num_sortkeys; i++) {
200 if (!strcmp(name, (service->sortkeys[i]).name))
209 /* Code to parse configuration file */
210 /* ==================================================== */
212 static struct conf_service *parse_service(xmlNode *node)
218 struct conf_service *service = 0;
219 int num_metadata = 0;
220 int num_sortkeys = 0;
222 // count num_metadata and num_sortkeys
223 for (n = node->children; n; n = n->next)
224 if (n->type == XML_ELEMENT_NODE && !strcmp((const char *)
225 n->name, "metadata"))
227 xmlChar *sortkey = xmlGetProp(n, (xmlChar *) "sortkey");
229 if (sortkey && strcmp((const char *) sortkey, "no"))
234 service = conf_service_create(nmem, num_metadata, num_sortkeys);
236 for (n = node->children; n; n = n->next)
238 if (n->type != XML_ELEMENT_NODE)
240 if (!strcmp((const char *) n->name, (const char *) "metadata"))
242 xmlChar *xml_name = xmlGetProp(n, (xmlChar *) "name");
243 xmlChar *xml_brief = xmlGetProp(n, (xmlChar *) "brief");
244 xmlChar *xml_sortkey = xmlGetProp(n, (xmlChar *) "sortkey");
245 xmlChar *xml_merge = xmlGetProp(n, (xmlChar *) "merge");
246 xmlChar *xml_type = xmlGetProp(n, (xmlChar *) "type");
247 xmlChar *xml_termlist = xmlGetProp(n, (xmlChar *) "termlist");
248 xmlChar *xml_rank = xmlGetProp(n, (xmlChar *) "rank");
249 xmlChar *xml_setting = xmlGetProp(n, (xmlChar *) "setting");
250 xmlChar *xml_mergekey = xmlGetProp(n, (xmlChar *) "mergekey");
252 enum conf_metadata_type type = Metadata_type_generic;
253 enum conf_metadata_merge merge = Metadata_merge_no;
254 enum conf_setting_type setting = Metadata_setting_no;
255 enum conf_sortkey_type sk_type = Metadata_sortkey_relevance;
256 enum conf_metadata_mergekey mergekey_type = Metadata_mergekey_no;
260 int sortkey_offset = 0;
262 // now do the parsing logic
265 yaz_log(YLOG_FATAL, "Must specify name in metadata element");
270 if (!strcmp((const char *) xml_brief, "yes"))
272 else if (strcmp((const char *) xml_brief, "no"))
274 yaz_log(YLOG_FATAL, "metadata/brief must be yes or no");
283 if (!strcmp((const char *) xml_termlist, "yes"))
285 else if (strcmp((const char *) xml_termlist, "no"))
287 yaz_log(YLOG_FATAL, "metadata/termlist must be yes or no");
295 rank = atoi((const char *) xml_rank);
301 if (!strcmp((const char *) xml_type, "generic"))
302 type = Metadata_type_generic;
303 else if (!strcmp((const char *) xml_type, "year"))
304 type = Metadata_type_year;
305 else if (!strcmp((const char *) xml_type, "date"))
306 type = Metadata_type_date;
310 "Unknown value for metadata/type: %s", xml_type);
315 type = Metadata_type_generic;
319 if (!strcmp((const char *) xml_merge, "no"))
320 merge = Metadata_merge_no;
321 else if (!strcmp((const char *) xml_merge, "unique"))
322 merge = Metadata_merge_unique;
323 else if (!strcmp((const char *) xml_merge, "longest"))
324 merge = Metadata_merge_longest;
325 else if (!strcmp((const char *) xml_merge, "range"))
326 merge = Metadata_merge_range;
327 else if (!strcmp((const char *) xml_merge, "all"))
328 merge = Metadata_merge_all;
332 "Unknown value for metadata/merge: %s", xml_merge);
337 merge = Metadata_merge_no;
341 if (!strcmp((const char *) xml_setting, "no"))
342 setting = Metadata_setting_no;
343 else if (!strcmp((const char *) xml_setting, "postproc"))
344 setting = Metadata_setting_postproc;
345 else if (!strcmp((const char *) xml_setting, "parameter"))
346 setting = Metadata_setting_parameter;
350 "Unknown value for medadata/setting: %s", xml_setting);
355 // add a sortkey if so specified
356 if (xml_sortkey && strcmp((const char *) xml_sortkey, "no"))
358 if (merge == Metadata_merge_no)
361 "Can't specify sortkey on a non-merged field");
364 if (!strcmp((const char *) xml_sortkey, "numeric"))
365 sk_type = Metadata_sortkey_numeric;
366 else if (!strcmp((const char *) xml_sortkey, "skiparticle"))
367 sk_type = Metadata_sortkey_skiparticle;
371 "Unknown sortkey in metadata element: %s",
375 sortkey_offset = sk_node;
377 conf_service_add_sortkey(nmem, service, sk_node,
378 (const char *) xml_name, sk_type);
385 if (xml_mergekey && strcmp((const char *) xml_mergekey, "no"))
387 mergekey_type = Metadata_mergekey_yes;
391 // metadata known, assign values
392 conf_service_add_metadata(nmem, service, md_node,
393 (const char *) xml_name,
394 type, merge, setting,
395 brief, termlist, rank, sortkey_offset,
400 xmlFree(xml_sortkey);
403 xmlFree(xml_termlist);
405 xmlFree(xml_setting);
410 yaz_log(YLOG_FATAL, "Bad element: %s", n->name);
417 static char *parse_settings(xmlNode *node)
419 xmlChar *src = xmlGetProp(node, (xmlChar *) "src");
424 if (yaz_is_abspath((const char *) src))
425 r = nmem_strdup(nmem, (const char *) src);
428 r = nmem_malloc(nmem,
429 strlen(confdir) + strlen((const char *) src) + 2);
430 sprintf(r, "%s/%s", confdir, src);
435 yaz_log(YLOG_FATAL, "Must specify src in targetprofile");
442 static struct conf_server *parse_server(xmlNode *node)
445 struct conf_server *server = nmem_malloc(nmem, sizeof(struct conf_server));
449 server->proxy_host = 0;
450 server->proxy_port = 0;
454 server->settings = 0;
455 server->relevance_pct = 0;
456 server->sort_pct = 0;
457 server->mergekey_pct = 0;
459 for (n = node->children; n; n = n->next)
461 if (n->type != XML_ELEMENT_NODE)
463 if (!strcmp((const char *) n->name, "listen"))
465 xmlChar *port = xmlGetProp(n, (xmlChar *) "port");
466 xmlChar *host = xmlGetProp(n, (xmlChar *) "host");
468 server->port = atoi((const char *) port);
470 server->host = nmem_strdup(nmem, (const char *) host);
474 else if (!strcmp((const char *) n->name, "proxy"))
476 xmlChar *port = xmlGetProp(n, (xmlChar *) "port");
477 xmlChar *host = xmlGetProp(n, (xmlChar *) "host");
478 xmlChar *myurl = xmlGetProp(n, (xmlChar *) "myurl");
480 server->proxy_port = atoi((const char *) port);
482 server->proxy_host = nmem_strdup(nmem, (const char *) host);
484 server->myurl = nmem_strdup(nmem, (const char *) myurl);
489 else if (!strcmp((const char *) n->name, "settings"))
491 if (server->settings)
493 yaz_log(YLOG_FATAL, "Can't repeat 'settings'");
496 if (!(server->settings = parse_settings(n)))
499 else if (!strcmp((const char *) n->name, "relevance"))
501 server->relevance_pct = pp2_charset_create_xml(n);
502 if (!server->relevance_pct)
505 else if (!strcmp((const char *) n->name, "sort"))
507 server->sort_pct = pp2_charset_create_xml(n);
508 if (!server->sort_pct)
511 else if (!strcmp((const char *) n->name, "mergekey"))
513 server->mergekey_pct = pp2_charset_create_xml(n);
514 if (!server->mergekey_pct)
517 else if (!strcmp((const char *) n->name, "service"))
519 struct conf_service *s = parse_service(n);
526 yaz_log(YLOG_FATAL, "Bad element: %s", n->name);
530 if (!server->relevance_pct)
531 server->relevance_pct = pp2_charset_create(0);
532 if (!server->sort_pct)
533 server->sort_pct = pp2_charset_create(0);
534 if (!server->mergekey_pct)
535 server->mergekey_pct = pp2_charset_create(0);
539 xsltStylesheet *conf_load_stylesheet(const char *fname)
542 if (yaz_is_abspath(fname))
543 yaz_snprintf(path, sizeof(path), fname);
545 yaz_snprintf(path, sizeof(path), "%s/%s", confdir, fname);
546 return xsltParseStylesheetFile((xmlChar *) path);
549 static struct conf_targetprofiles *parse_targetprofiles(xmlNode *node)
551 struct conf_targetprofiles *r = nmem_malloc(nmem, sizeof(*r));
552 xmlChar *type = xmlGetProp(node, (xmlChar *) "type");
553 xmlChar *src = xmlGetProp(node, (xmlChar *) "src");
555 memset(r, 0, sizeof(*r));
559 if (!strcmp((const char *) type, "local"))
560 r->type = Targetprofiles_local;
563 yaz_log(YLOG_FATAL, "Unknown targetprofile type");
569 yaz_log(YLOG_FATAL, "Must specify type for targetprofile");
574 r->src = nmem_strdup(nmem, (const char *) src);
577 yaz_log(YLOG_FATAL, "Must specify src in targetprofile");
585 static struct conf_config *parse_config(xmlNode *root)
588 struct conf_config *r = nmem_malloc(nmem, sizeof(struct conf_config));
591 r->targetprofiles = 0;
593 for (n = root->children; n; n = n->next)
595 if (n->type != XML_ELEMENT_NODE)
597 if (!strcmp((const char *) n->name, "server"))
599 struct conf_server *tmp = parse_server(n);
602 tmp->next = r->servers;
605 else if (!strcmp((const char *) n->name, "targetprofiles"))
607 // It would be fun to be able to fix this sometime
608 if (r->targetprofiles)
610 yaz_log(YLOG_FATAL, "Can't repeat targetprofiles");
613 if (!(r->targetprofiles = parse_targetprofiles(n)))
618 yaz_log(YLOG_FATAL, "Bad element: %s", n->name);
625 int read_config(const char *fname)
627 xmlDoc *doc = xmlParseFile(fname);
630 if (!nmem) // Initialize
632 nmem = nmem_create();
633 xmlSubstituteEntitiesDefault(1);
634 xmlLoadExtDtdDefaultValue = 1;
638 yaz_log(YLOG_FATAL, "Failed to read %s", fname);
641 if ((p = strrchr(fname,
650 if (len >= sizeof(confdir))
651 len = sizeof(confdir)-1;
652 strncpy(confdir, fname, len);
655 config = parse_config(xmlDocGetRootElement(doc));
668 * c-file-style: "Stroustrup"
669 * indent-tabs-mode: nil
671 * vim: shiftwidth=4 tabstop=8 expandtab