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"
44 NMEM nmem; /* for conf_config and servers memory */
45 struct conf_server *servers;
50 static char *parse_settings(struct conf_config *config,
51 NMEM nmem, xmlNode *node);
53 static struct conf_targetprofiles *parse_targetprofiles(NMEM nmem,
57 struct conf_metadata * conf_metadata_assign(NMEM nmem,
58 struct conf_metadata * metadata,
60 enum conf_metadata_type type,
61 enum conf_metadata_merge merge,
62 enum conf_setting_type setting,
67 enum conf_metadata_mergekey mt)
69 if (!nmem || !metadata || !name)
72 metadata->name = nmem_strdup(nmem, name);
74 metadata->type = type;
76 // enforcing that type_year is always range_merge
77 if (metadata->type == Metadata_type_year)
78 metadata->merge = Metadata_merge_range;
80 metadata->merge = merge;
82 metadata->setting = setting;
83 metadata->brief = brief;
84 metadata->termlist = termlist;
85 metadata->rank = rank;
86 metadata->sortkey_offset = sortkey_offset;
87 metadata->mergekey = mt;
93 struct conf_sortkey * conf_sortkey_assign(NMEM nmem,
94 struct conf_sortkey * sortkey,
96 enum conf_sortkey_type type)
98 if (!nmem || !sortkey || !name)
101 sortkey->name = nmem_strdup(nmem, name);
102 sortkey->type = type;
108 struct conf_service * conf_service_create(struct conf_config *config,
109 int num_metadata, int num_sortkeys,
110 const char *service_id)
112 struct conf_service * service = 0;
113 NMEM nmem = nmem_create();
117 service = nmem_malloc(nmem, sizeof(struct conf_service));
118 service->nmem = nmem;
120 service->settings = 0;
121 service->databases = 0;
122 service->targetprofiles = 0;
123 service->config = config;
125 service->id = service_id ? nmem_strdup(nmem, service_id) : 0;
126 service->num_metadata = num_metadata;
127 service->metadata = 0;
128 if (service->num_metadata)
131 sizeof(struct conf_metadata) * service->num_metadata);
132 service->num_sortkeys = num_sortkeys;
133 service->sortkeys = 0;
134 if (service->num_sortkeys)
137 sizeof(struct conf_sortkey) * service->num_sortkeys);
138 service->dictionary = 0;
142 struct conf_metadata* conf_service_add_metadata(struct conf_service *service,
145 enum conf_metadata_type type,
146 enum conf_metadata_merge merge,
147 enum conf_setting_type setting,
152 enum conf_metadata_mergekey mt)
154 struct conf_metadata * md = 0;
156 if (!service || !service->metadata || !service->num_metadata
157 || field_id < 0 || !(field_id < service->num_metadata))
160 //md = &((service->metadata)[field_id]);
161 md = service->metadata + field_id;
162 md = conf_metadata_assign(service->nmem, md, name, type, merge, setting,
163 brief, termlist, rank, sortkey_offset,
169 struct conf_sortkey * conf_service_add_sortkey(struct conf_service *service,
172 enum conf_sortkey_type type)
174 struct conf_sortkey * sk = 0;
176 if (!service || !service->sortkeys || !service->num_sortkeys
177 || field_id < 0 || !(field_id < service->num_sortkeys))
180 //sk = &((service->sortkeys)[field_id]);
181 sk = service->sortkeys + field_id;
182 sk = conf_sortkey_assign(service->nmem, sk, name, type);
188 int conf_service_metadata_field_id(struct conf_service *service,
193 if (!service || !service->metadata || !service->num_metadata)
196 for(i = 0; i < service->num_metadata; i++) {
197 if (!strcmp(name, (service->metadata[i]).name))
205 int conf_service_sortkey_field_id(struct conf_service *service,
210 if (!service || !service->sortkeys || !service->num_sortkeys)
213 for(i = 0; i < service->num_sortkeys; i++) {
214 if (!strcmp(name, (service->sortkeys[i]).name))
223 /* Code to parse configuration file */
224 /* ==================================================== */
226 static struct conf_service *parse_service(struct conf_config *config,
227 xmlNode *node, const char *service_id)
233 struct conf_service *service = 0;
234 int num_metadata = 0;
235 int num_sortkeys = 0;
237 // count num_metadata and num_sortkeys
238 for (n = node->children; n; n = n->next)
239 if (n->type == XML_ELEMENT_NODE && !strcmp((const char *)
240 n->name, "metadata"))
242 xmlChar *sortkey = xmlGetProp(n, (xmlChar *) "sortkey");
244 if (sortkey && strcmp((const char *) sortkey, "no"))
249 service = conf_service_create(config,
250 num_metadata, num_sortkeys, service_id);
252 for (n = node->children; n; n = n->next)
254 if (n->type != XML_ELEMENT_NODE)
256 if (!strcmp((const char *) n->name, "settings"))
258 if (service->settings)
260 yaz_log(YLOG_FATAL, "Can't repeat 'settings'");
263 service->settings = parse_settings(config, service->nmem, n);
264 if (!service->settings)
267 else if (!strcmp((const char *) n->name, (const char *) "targetprofiles"))
269 if (service->targetprofiles)
271 yaz_log(YLOG_FATAL, "Can't repeat targetprofiles");
274 if (!(service->targetprofiles =
275 parse_targetprofiles(service->nmem, n)))
278 else if (!strcmp((const char *) n->name, (const char *) "metadata"))
280 xmlChar *xml_name = xmlGetProp(n, (xmlChar *) "name");
281 xmlChar *xml_brief = xmlGetProp(n, (xmlChar *) "brief");
282 xmlChar *xml_sortkey = xmlGetProp(n, (xmlChar *) "sortkey");
283 xmlChar *xml_merge = xmlGetProp(n, (xmlChar *) "merge");
284 xmlChar *xml_type = xmlGetProp(n, (xmlChar *) "type");
285 xmlChar *xml_termlist = xmlGetProp(n, (xmlChar *) "termlist");
286 xmlChar *xml_rank = xmlGetProp(n, (xmlChar *) "rank");
287 xmlChar *xml_setting = xmlGetProp(n, (xmlChar *) "setting");
288 xmlChar *xml_mergekey = xmlGetProp(n, (xmlChar *) "mergekey");
290 enum conf_metadata_type type = Metadata_type_generic;
291 enum conf_metadata_merge merge = Metadata_merge_no;
292 enum conf_setting_type setting = Metadata_setting_no;
293 enum conf_sortkey_type sk_type = Metadata_sortkey_relevance;
294 enum conf_metadata_mergekey mergekey_type = Metadata_mergekey_no;
298 int sortkey_offset = 0;
300 // now do the parsing logic
303 yaz_log(YLOG_FATAL, "Must specify name in metadata element");
308 if (!strcmp((const char *) xml_brief, "yes"))
310 else if (strcmp((const char *) xml_brief, "no"))
312 yaz_log(YLOG_FATAL, "metadata/brief must be yes or no");
321 if (!strcmp((const char *) xml_termlist, "yes"))
323 else if (strcmp((const char *) xml_termlist, "no"))
325 yaz_log(YLOG_FATAL, "metadata/termlist must be yes or no");
333 rank = atoi((const char *) xml_rank);
339 if (!strcmp((const char *) xml_type, "generic"))
340 type = Metadata_type_generic;
341 else if (!strcmp((const char *) xml_type, "year"))
342 type = Metadata_type_year;
343 else if (!strcmp((const char *) xml_type, "date"))
344 type = Metadata_type_date;
348 "Unknown value for metadata/type: %s", xml_type);
353 type = Metadata_type_generic;
357 if (!strcmp((const char *) xml_merge, "no"))
358 merge = Metadata_merge_no;
359 else if (!strcmp((const char *) xml_merge, "unique"))
360 merge = Metadata_merge_unique;
361 else if (!strcmp((const char *) xml_merge, "longest"))
362 merge = Metadata_merge_longest;
363 else if (!strcmp((const char *) xml_merge, "range"))
364 merge = Metadata_merge_range;
365 else if (!strcmp((const char *) xml_merge, "all"))
366 merge = Metadata_merge_all;
370 "Unknown value for metadata/merge: %s", xml_merge);
375 merge = Metadata_merge_no;
379 if (!strcmp((const char *) xml_setting, "no"))
380 setting = Metadata_setting_no;
381 else if (!strcmp((const char *) xml_setting, "postproc"))
382 setting = Metadata_setting_postproc;
383 else if (!strcmp((const char *) xml_setting, "parameter"))
384 setting = Metadata_setting_parameter;
388 "Unknown value for medadata/setting: %s", xml_setting);
393 // add a sortkey if so specified
394 if (xml_sortkey && strcmp((const char *) xml_sortkey, "no"))
396 if (merge == Metadata_merge_no)
399 "Can't specify sortkey on a non-merged field");
402 if (!strcmp((const char *) xml_sortkey, "numeric"))
403 sk_type = Metadata_sortkey_numeric;
404 else if (!strcmp((const char *) xml_sortkey, "skiparticle"))
405 sk_type = Metadata_sortkey_skiparticle;
409 "Unknown sortkey in metadata element: %s",
413 sortkey_offset = sk_node;
415 conf_service_add_sortkey(service, sk_node,
416 (const char *) xml_name, sk_type);
423 if (xml_mergekey && strcmp((const char *) xml_mergekey, "no"))
425 mergekey_type = Metadata_mergekey_yes;
429 // metadata known, assign values
430 conf_service_add_metadata(service, md_node,
431 (const char *) xml_name,
432 type, merge, setting,
433 brief, termlist, rank, sortkey_offset,
438 xmlFree(xml_sortkey);
441 xmlFree(xml_termlist);
443 xmlFree(xml_setting);
448 yaz_log(YLOG_FATAL, "Bad element: %s", n->name);
455 static char *parse_settings(struct conf_config *config,
456 NMEM nmem, xmlNode *node)
458 xmlChar *src = xmlGetProp(node, (xmlChar *) "src");
463 if (yaz_is_abspath((const char *) src) || !wrbuf_len(config->confdir))
464 r = nmem_strdup(nmem, (const char *) src);
467 r = nmem_malloc(nmem,
468 wrbuf_len(config->confdir) +
469 strlen((const char *) src) + 2);
470 sprintf(r, "%s/%s", wrbuf_cstr(config->confdir), src);
475 yaz_log(YLOG_FATAL, "Must specify src in targetprofile");
482 static struct conf_server *parse_server(struct conf_config *config,
483 NMEM nmem, xmlNode *node)
486 struct conf_server *server = nmem_malloc(nmem, sizeof(struct conf_server));
490 server->proxy_host = 0;
491 server->proxy_port = 0;
493 server->proxy_addr = 0;
496 server->server_settings = 0;
497 server->relevance_pct = 0;
498 server->sort_pct = 0;
499 server->mergekey_pct = 0;
501 for (n = node->children; n; n = n->next)
503 if (n->type != XML_ELEMENT_NODE)
505 if (!strcmp((const char *) n->name, "listen"))
507 xmlChar *port = xmlGetProp(n, (xmlChar *) "port");
508 xmlChar *host = xmlGetProp(n, (xmlChar *) "host");
510 server->port = atoi((const char *) port);
512 server->host = nmem_strdup(nmem, (const char *) host);
516 else if (!strcmp((const char *) n->name, "proxy"))
518 xmlChar *port = xmlGetProp(n, (xmlChar *) "port");
519 xmlChar *host = xmlGetProp(n, (xmlChar *) "host");
520 xmlChar *myurl = xmlGetProp(n, (xmlChar *) "myurl");
522 server->proxy_port = atoi((const char *) port);
524 server->proxy_host = nmem_strdup(nmem, (const char *) host);
526 server->myurl = nmem_strdup(nmem, (const char *) myurl);
531 else if (!strcmp((const char *) n->name, "settings"))
533 if (server->server_settings)
535 yaz_log(YLOG_FATAL, "Can't repeat 'settings'");
538 if (!(server->server_settings = parse_settings(config, nmem, n)))
541 else if (!strcmp((const char *) n->name, "relevance"))
543 server->relevance_pct = pp2_charset_create_xml(n);
544 if (!server->relevance_pct)
547 else if (!strcmp((const char *) n->name, "sort"))
549 server->sort_pct = pp2_charset_create_xml(n);
550 if (!server->sort_pct)
553 else if (!strcmp((const char *) n->name, "mergekey"))
555 server->mergekey_pct = pp2_charset_create_xml(n);
556 if (!server->mergekey_pct)
559 else if (!strcmp((const char *) n->name, "service"))
561 char *service_id = (char *)
562 xmlGetProp(n, (xmlChar *) "id");
564 struct conf_service **sp = &server->service;
565 for (; *sp; sp = &(*sp)->next)
566 if ((*sp)->id && service_id &&
567 0 == strcmp((*sp)->id, service_id))
569 yaz_log(YLOG_FATAL, "Duplicate service: %s", service_id);
572 else if (!(*sp)->id && !service_id)
574 yaz_log(YLOG_FATAL, "Duplicate unnamed service");
578 if (*sp) /* service already exist */
582 struct conf_service *s = parse_service(config, n, service_id);
585 s->relevance_pct = server->relevance_pct ?
586 server->relevance_pct : pp2_charset_create(0);
587 s->sort_pct = server->sort_pct ?
588 server->sort_pct : pp2_charset_create(0);
589 s->mergekey_pct = server->mergekey_pct ?
590 server->mergekey_pct : pp2_charset_create(0);
598 yaz_log(YLOG_FATAL, "Bad element: %s", n->name);
605 xsltStylesheet *conf_load_stylesheet(struct conf_config *config,
609 if (yaz_is_abspath(fname) || !config || !wrbuf_len(config->confdir))
610 yaz_snprintf(path, sizeof(path), fname);
612 yaz_snprintf(path, sizeof(path), "%s/%s",
613 wrbuf_cstr(config->confdir), fname);
614 return xsltParseStylesheetFile((xmlChar *) path);
617 static struct conf_targetprofiles *parse_targetprofiles(NMEM nmem,
620 struct conf_targetprofiles *r = nmem_malloc(nmem, sizeof(*r));
621 xmlChar *type = xmlGetProp(node, (xmlChar *) "type");
622 xmlChar *src = xmlGetProp(node, (xmlChar *) "src");
624 memset(r, 0, sizeof(*r));
628 if (!strcmp((const char *) type, "local"))
629 r->type = Targetprofiles_local;
632 yaz_log(YLOG_FATAL, "Unknown targetprofile type");
638 yaz_log(YLOG_FATAL, "Must specify type for targetprofile");
643 r->src = nmem_strdup(nmem, (const char *) src);
646 yaz_log(YLOG_FATAL, "Must specify src in targetprofile");
654 struct conf_service *locate_service(struct conf_server *server,
655 const char *service_id)
657 struct conf_service *s = server->service;
658 for (; s; s = s->next)
659 if (s->id && service_id && 0 == strcmp(s->id, service_id))
661 else if (!s->id && !service_id)
667 static int parse_config(struct conf_config *config, xmlNode *root)
671 for (n = root->children; n; n = n->next)
673 if (n->type != XML_ELEMENT_NODE)
675 if (!strcmp((const char *) n->name, "server"))
677 struct conf_server *tmp = parse_server(config, config->nmem, n);
680 tmp->next = config->servers;
681 config->servers = tmp;
683 else if (!strcmp((const char *) n->name, "targetprofiles"))
685 yaz_log(YLOG_FATAL, "targetprofiles unsupported here. Must be part of service");
691 yaz_log(YLOG_FATAL, "Bad element: %s", n->name);
698 static void config_include_src(struct conf_config *config, xmlNode *n,
701 xmlDoc *doc = xmlParseFile(src);
702 yaz_log(YLOG_LOG, "processing incldue src=%s", src);
705 xmlNodePtr t = xmlDocGetRootElement(doc);
706 xmlReplaceNode(n, xmlCopyNode(t, 1));
711 static void process_config_includes(struct conf_config *config, xmlNode *n)
713 for (; n; n = n->next)
715 if (n->type == XML_ELEMENT_NODE)
717 if (!strcmp((const char *) n->name, "include"))
719 xmlChar *src = xmlGetProp(n, (xmlChar *) "src");
722 config_include_src(config, n, (const char *) src);
727 process_config_includes(config, n->children);
731 struct conf_config *read_config(const char *fname)
733 xmlDoc *doc = xmlParseFile(fname);
737 NMEM nmem = nmem_create();
738 struct conf_config *config = nmem_malloc(nmem, sizeof(struct conf_config));
740 xmlSubstituteEntitiesDefault(1);
741 xmlLoadExtDtdDefaultValue = 1;
744 yaz_log(YLOG_FATAL, "Failed to read %s", fname);
751 config->confdir = wrbuf_alloc();
752 if ((p = strrchr(fname,
761 wrbuf_write(config->confdir, fname, len);
763 wrbuf_puts(config->confdir, "");
765 n = xmlDocGetRootElement(doc);
766 process_config_includes(config, n);
767 xmlDocFormatDump(stdout, doc, 0);
768 r = parse_config(config, n);
776 void config_read_settings(struct conf_config *config,
777 const char *path_override)
779 struct conf_service *s = config->servers->service;
780 for (;s ; s = s->next)
784 settings_read(s, path_override);
785 else if (s->settings)
786 settings_read(s, s->settings);
787 else if (config->servers->server_settings)
788 settings_read(s, config->servers->server_settings);
790 yaz_log(YLOG_WARN, "No settings for service");
794 void config_stop_listeners(struct conf_config *conf)
796 struct conf_server *ser;
797 for (ser = conf->servers; ser; ser = ser->next)
798 http_close_server(ser);
801 int config_start_listeners(struct conf_config *conf,
802 const char *listener_override,
803 const char *proxy_override)
805 struct conf_server *ser;
806 for (ser = conf->servers; ser; ser = ser->next)
808 WRBUF w = wrbuf_alloc();
810 if (listener_override)
812 wrbuf_puts(w, listener_override);
813 listener_override = 0; /* only first server is overriden */
818 wrbuf_puts(w, ser->host);
823 wrbuf_printf(w, "%d", ser->port);
826 r = http_init(wrbuf_cstr(w), ser);
833 wrbuf_puts(w, proxy_override);
834 else if (ser->proxy_host || ser->proxy_port)
837 wrbuf_puts(w, ser->proxy_host);
842 wrbuf_printf(w, "%d", ser->proxy_port);
846 http_set_proxyaddr(wrbuf_cstr(w), ser);
855 * c-file-style: "Stroustrup"
856 * indent-tabs-mode: nil
858 * vim: shiftwidth=4 tabstop=8 expandtab