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 #include "pazpar2_config.h"
40 static char confdir[256] = ".";
42 static char *parse_settings(NMEM nmem, xmlNode *node);
45 struct conf_metadata * conf_metadata_assign(NMEM nmem,
46 struct conf_metadata * metadata,
48 enum conf_metadata_type type,
49 enum conf_metadata_merge merge,
50 enum conf_setting_type setting,
55 enum conf_metadata_mergekey mt)
57 if (!nmem || !metadata || !name)
60 metadata->name = nmem_strdup(nmem, name);
62 metadata->type = type;
64 // enforcing that type_year is always range_merge
65 if (metadata->type == Metadata_type_year)
66 metadata->merge = Metadata_merge_range;
68 metadata->merge = merge;
70 metadata->setting = setting;
71 metadata->brief = brief;
72 metadata->termlist = termlist;
73 metadata->rank = rank;
74 metadata->sortkey_offset = sortkey_offset;
75 metadata->mergekey = mt;
81 struct conf_sortkey * conf_sortkey_assign(NMEM nmem,
82 struct conf_sortkey * sortkey,
84 enum conf_sortkey_type type)
86 if (!nmem || !sortkey || !name)
89 sortkey->name = nmem_strdup(nmem, name);
96 struct conf_service * conf_service_create(int num_metadata, int num_sortkeys,
97 const char *service_id)
99 struct conf_service * service = 0;
100 NMEM nmem = nmem_create();
104 service = nmem_malloc(nmem, sizeof(struct conf_service));
105 service->nmem = nmem;
107 service->settings = 0;
108 service->databases = 0;
110 service->id = service_id ? nmem_strdup(nmem, service_id) : 0;
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);
123 service->dictionary = 0;
127 struct conf_metadata* conf_service_add_metadata(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(service->nmem, md, name, type, merge, setting,
148 brief, termlist, rank, sortkey_offset,
154 struct conf_sortkey * conf_service_add_sortkey(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(service->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, const char *service_id)
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(num_metadata, num_sortkeys, service_id);
235 for (n = node->children; n; n = n->next)
237 if (n->type != XML_ELEMENT_NODE)
239 if (!strcmp((const char *) n->name, "settings"))
241 if (service->settings)
243 yaz_log(YLOG_FATAL, "Can't repeat 'settings'");
246 service->settings = parse_settings(service->nmem, n);
247 if (!service->settings)
250 else if (!strcmp((const char *) n->name, (const char *) "metadata"))
252 xmlChar *xml_name = xmlGetProp(n, (xmlChar *) "name");
253 xmlChar *xml_brief = xmlGetProp(n, (xmlChar *) "brief");
254 xmlChar *xml_sortkey = xmlGetProp(n, (xmlChar *) "sortkey");
255 xmlChar *xml_merge = xmlGetProp(n, (xmlChar *) "merge");
256 xmlChar *xml_type = xmlGetProp(n, (xmlChar *) "type");
257 xmlChar *xml_termlist = xmlGetProp(n, (xmlChar *) "termlist");
258 xmlChar *xml_rank = xmlGetProp(n, (xmlChar *) "rank");
259 xmlChar *xml_setting = xmlGetProp(n, (xmlChar *) "setting");
260 xmlChar *xml_mergekey = xmlGetProp(n, (xmlChar *) "mergekey");
262 enum conf_metadata_type type = Metadata_type_generic;
263 enum conf_metadata_merge merge = Metadata_merge_no;
264 enum conf_setting_type setting = Metadata_setting_no;
265 enum conf_sortkey_type sk_type = Metadata_sortkey_relevance;
266 enum conf_metadata_mergekey mergekey_type = Metadata_mergekey_no;
270 int sortkey_offset = 0;
272 // now do the parsing logic
275 yaz_log(YLOG_FATAL, "Must specify name in metadata element");
280 if (!strcmp((const char *) xml_brief, "yes"))
282 else if (strcmp((const char *) xml_brief, "no"))
284 yaz_log(YLOG_FATAL, "metadata/brief must be yes or no");
293 if (!strcmp((const char *) xml_termlist, "yes"))
295 else if (strcmp((const char *) xml_termlist, "no"))
297 yaz_log(YLOG_FATAL, "metadata/termlist must be yes or no");
305 rank = atoi((const char *) xml_rank);
311 if (!strcmp((const char *) xml_type, "generic"))
312 type = Metadata_type_generic;
313 else if (!strcmp((const char *) xml_type, "year"))
314 type = Metadata_type_year;
315 else if (!strcmp((const char *) xml_type, "date"))
316 type = Metadata_type_date;
320 "Unknown value for metadata/type: %s", xml_type);
325 type = Metadata_type_generic;
329 if (!strcmp((const char *) xml_merge, "no"))
330 merge = Metadata_merge_no;
331 else if (!strcmp((const char *) xml_merge, "unique"))
332 merge = Metadata_merge_unique;
333 else if (!strcmp((const char *) xml_merge, "longest"))
334 merge = Metadata_merge_longest;
335 else if (!strcmp((const char *) xml_merge, "range"))
336 merge = Metadata_merge_range;
337 else if (!strcmp((const char *) xml_merge, "all"))
338 merge = Metadata_merge_all;
342 "Unknown value for metadata/merge: %s", xml_merge);
347 merge = Metadata_merge_no;
351 if (!strcmp((const char *) xml_setting, "no"))
352 setting = Metadata_setting_no;
353 else if (!strcmp((const char *) xml_setting, "postproc"))
354 setting = Metadata_setting_postproc;
355 else if (!strcmp((const char *) xml_setting, "parameter"))
356 setting = Metadata_setting_parameter;
360 "Unknown value for medadata/setting: %s", xml_setting);
365 // add a sortkey if so specified
366 if (xml_sortkey && strcmp((const char *) xml_sortkey, "no"))
368 if (merge == Metadata_merge_no)
371 "Can't specify sortkey on a non-merged field");
374 if (!strcmp((const char *) xml_sortkey, "numeric"))
375 sk_type = Metadata_sortkey_numeric;
376 else if (!strcmp((const char *) xml_sortkey, "skiparticle"))
377 sk_type = Metadata_sortkey_skiparticle;
381 "Unknown sortkey in metadata element: %s",
385 sortkey_offset = sk_node;
387 conf_service_add_sortkey(
389 (const char *) xml_name, sk_type);
396 if (xml_mergekey && strcmp((const char *) xml_mergekey, "no"))
398 mergekey_type = Metadata_mergekey_yes;
402 // metadata known, assign values
403 conf_service_add_metadata(service, md_node,
404 (const char *) xml_name,
405 type, merge, setting,
406 brief, termlist, rank, sortkey_offset,
411 xmlFree(xml_sortkey);
414 xmlFree(xml_termlist);
416 xmlFree(xml_setting);
421 yaz_log(YLOG_FATAL, "Bad element: %s", n->name);
428 static char *parse_settings(NMEM nmem, xmlNode *node)
430 xmlChar *src = xmlGetProp(node, (xmlChar *) "src");
435 if (yaz_is_abspath((const char *) src))
436 r = nmem_strdup(nmem, (const char *) src);
439 r = nmem_malloc(nmem,
440 strlen(confdir) + strlen((const char *) src) + 2);
441 sprintf(r, "%s/%s", confdir, src);
446 yaz_log(YLOG_FATAL, "Must specify src in targetprofile");
453 static struct conf_server *parse_server(NMEM nmem, xmlNode *node)
456 struct conf_server *server = nmem_malloc(nmem, sizeof(struct conf_server));
460 server->proxy_host = 0;
461 server->proxy_port = 0;
465 server->server_settings = 0;
466 server->relevance_pct = 0;
467 server->sort_pct = 0;
468 server->mergekey_pct = 0;
470 for (n = node->children; n; n = n->next)
472 if (n->type != XML_ELEMENT_NODE)
474 if (!strcmp((const char *) n->name, "listen"))
476 xmlChar *port = xmlGetProp(n, (xmlChar *) "port");
477 xmlChar *host = xmlGetProp(n, (xmlChar *) "host");
479 server->port = atoi((const char *) port);
481 server->host = nmem_strdup(nmem, (const char *) host);
485 else if (!strcmp((const char *) n->name, "proxy"))
487 xmlChar *port = xmlGetProp(n, (xmlChar *) "port");
488 xmlChar *host = xmlGetProp(n, (xmlChar *) "host");
489 xmlChar *myurl = xmlGetProp(n, (xmlChar *) "myurl");
491 server->proxy_port = atoi((const char *) port);
493 server->proxy_host = nmem_strdup(nmem, (const char *) host);
495 server->myurl = nmem_strdup(nmem, (const char *) myurl);
500 else if (!strcmp((const char *) n->name, "settings"))
502 if (server->server_settings)
504 yaz_log(YLOG_FATAL, "Can't repeat 'settings'");
507 if (!(server->server_settings = parse_settings(nmem, n)))
510 else if (!strcmp((const char *) n->name, "relevance"))
512 server->relevance_pct = pp2_charset_create_xml(n);
513 if (!server->relevance_pct)
516 else if (!strcmp((const char *) n->name, "sort"))
518 server->sort_pct = pp2_charset_create_xml(n);
519 if (!server->sort_pct)
522 else if (!strcmp((const char *) n->name, "mergekey"))
524 server->mergekey_pct = pp2_charset_create_xml(n);
525 if (!server->mergekey_pct)
528 else if (!strcmp((const char *) n->name, "service"))
530 const char *service_id = (const char *)
531 xmlGetProp(n, (xmlChar *) "id");
533 struct conf_service **sp = &server->service;
534 for (; *sp; sp = &(*sp)->next)
535 if ((*sp)->id && service_id &&
536 0 == strcmp((*sp)->id, service_id))
538 yaz_log(YLOG_FATAL, "Duplicate service: %s", service_id);
541 else if (!(*sp)->id && !service_id)
543 yaz_log(YLOG_FATAL, "Duplicate unnamed service");
547 if (*sp) /* service already exist */
551 struct conf_service *s = parse_service(n, service_id);
554 s->relevance_pct = server->relevance_pct ?
555 server->relevance_pct : pp2_charset_create(0);
556 s->sort_pct = server->sort_pct ?
557 server->sort_pct : pp2_charset_create(0);
558 s->mergekey_pct = server->mergekey_pct ?
559 server->mergekey_pct : pp2_charset_create(0);
566 yaz_log(YLOG_FATAL, "Bad element: %s", n->name);
573 xsltStylesheet *conf_load_stylesheet(const char *fname)
576 if (yaz_is_abspath(fname))
577 yaz_snprintf(path, sizeof(path), fname);
579 yaz_snprintf(path, sizeof(path), "%s/%s", confdir, fname);
580 return xsltParseStylesheetFile((xmlChar *) path);
583 static struct conf_targetprofiles *parse_targetprofiles(NMEM nmem,
586 struct conf_targetprofiles *r = nmem_malloc(nmem, sizeof(*r));
587 xmlChar *type = xmlGetProp(node, (xmlChar *) "type");
588 xmlChar *src = xmlGetProp(node, (xmlChar *) "src");
590 memset(r, 0, sizeof(*r));
594 if (!strcmp((const char *) type, "local"))
595 r->type = Targetprofiles_local;
598 yaz_log(YLOG_FATAL, "Unknown targetprofile type");
604 yaz_log(YLOG_FATAL, "Must specify type for targetprofile");
609 r->src = nmem_strdup(nmem, (const char *) src);
612 yaz_log(YLOG_FATAL, "Must specify src in targetprofile");
620 struct conf_service *locate_service(struct conf_server *server,
621 const char *service_id)
623 struct conf_service *s = server->service;
624 for (; s; s = s->next)
625 if (s->id && service_id && 0 == strcmp(s->id, service_id))
627 else if (!s->id && !service_id)
633 static struct conf_config *parse_config(xmlNode *root)
635 NMEM nmem = nmem_create();
637 struct conf_config *r = nmem_malloc(nmem, sizeof(struct conf_config));
641 r->targetprofiles = 0;
643 for (n = root->children; n; n = n->next)
645 if (n->type != XML_ELEMENT_NODE)
647 if (!strcmp((const char *) n->name, "server"))
649 struct conf_server *tmp = parse_server(nmem, n);
652 tmp->next = r->servers;
655 else if (!strcmp((const char *) n->name, "targetprofiles"))
657 // It would be fun to be able to fix this sometime
658 if (r->targetprofiles)
660 yaz_log(YLOG_FATAL, "Can't repeat targetprofiles");
663 if (!(r->targetprofiles = parse_targetprofiles(nmem, n)))
668 yaz_log(YLOG_FATAL, "Bad element: %s", n->name);
675 struct conf_config *read_config(const char *fname)
677 xmlDoc *doc = xmlParseFile(fname);
679 struct conf_config *config;
681 xmlSubstituteEntitiesDefault(1);
682 xmlLoadExtDtdDefaultValue = 1;
685 yaz_log(YLOG_FATAL, "Failed to read %s", fname);
688 if ((p = strrchr(fname,
697 if (len >= sizeof(confdir))
698 len = sizeof(confdir)-1;
699 strncpy(confdir, fname, len);
702 config = parse_config(xmlDocGetRootElement(doc));
708 void config_read_settings(struct conf_config *config,
709 const char *path_override)
711 struct conf_service *s = config->servers->service;
712 for (;s ; s = s->next)
716 settings_read(s, path_override);
717 else if (s->settings)
718 settings_read(s, s->settings);
719 else if (config->servers->server_settings)
720 settings_read(s, config->servers->server_settings);
722 yaz_log(YLOG_WARN, "No settings for service");
729 * c-file-style: "Stroustrup"
730 * indent-tabs-mode: nil
732 * vim: shiftwidth=4 tabstop=8 expandtab