1 /* This file is part of Pazpar2.
2 Copyright (C) 2006-2010 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
27 #include <libxml/parser.h>
28 #include <libxml/tree.h>
30 #include <yaz/yaz-util.h>
32 #include <yaz/snprintf.h>
33 #include <yaz/tpath.h>
34 #include <yaz/xml_include.h>
36 #include <sys/types.h>
41 #include "pazpar2_config.h"
48 NMEM nmem; /* for conf_config and servers memory */
49 struct conf_server *servers;
54 static char *parse_settings(struct conf_config *config,
55 NMEM nmem, xmlNode *node);
57 static struct conf_targetprofiles *parse_targetprofiles(NMEM nmem,
60 static void conf_metadata_assign(NMEM nmem,
61 struct conf_metadata * metadata,
63 enum conf_metadata_type type,
64 enum conf_metadata_merge merge,
65 enum conf_setting_type setting,
70 enum conf_metadata_mergekey mt)
72 assert(nmem && metadata && name);
74 metadata->name = nmem_strdup(nmem, name);
76 metadata->type = type;
78 // enforcing that type_year is always range_merge
79 if (metadata->type == Metadata_type_year)
80 metadata->merge = Metadata_merge_range;
82 metadata->merge = merge;
84 metadata->setting = setting;
85 metadata->brief = brief;
86 metadata->termlist = termlist;
87 metadata->rank = rank;
88 metadata->sortkey_offset = sortkey_offset;
89 metadata->mergekey = mt;
93 static void conf_sortkey_assign(NMEM nmem,
94 struct conf_sortkey * sortkey,
96 enum conf_sortkey_type type)
98 assert(nmem && sortkey && name);
100 sortkey->name = nmem_strdup(nmem, name);
101 sortkey->type = type;
105 static struct conf_service *service_init(struct conf_server *server,
106 int num_metadata, int num_sortkeys,
107 const char *service_id)
109 struct conf_service * service = 0;
110 NMEM nmem = nmem_create();
112 service = nmem_malloc(nmem, sizeof(struct conf_service));
113 service->ref_count = 1;
114 service->nmem = nmem;
116 service->settings = 0;
117 service->databases = 0;
118 service->targetprofiles = 0;
119 service->server = server;
120 service->session_timeout = 60; /* default session timeout */
121 service->z3950_session_timeout = 180;
122 service->z3950_operation_timeout = 30;
124 service->relevance_pct = 0;
125 service->sort_pct = 0;
126 service->mergekey_pct = 0;
128 service->id = service_id ? nmem_strdup(nmem, service_id) : 0;
129 service->num_metadata = num_metadata;
130 service->metadata = 0;
131 if (service->num_metadata)
134 sizeof(struct conf_metadata) * service->num_metadata);
135 service->num_sortkeys = num_sortkeys;
136 service->sortkeys = 0;
137 if (service->num_sortkeys)
140 sizeof(struct conf_sortkey) * service->num_sortkeys);
141 service->dictionary = 0;
145 static struct conf_metadata* conf_service_add_metadata(
146 struct conf_service *service,
149 enum conf_metadata_type type,
150 enum conf_metadata_merge merge,
151 enum conf_setting_type setting,
156 enum conf_metadata_mergekey mt)
158 struct conf_metadata * md = 0;
160 if (!service || !service->metadata || !service->num_metadata
161 || field_id < 0 || !(field_id < service->num_metadata))
164 md = service->metadata + field_id;
165 conf_metadata_assign(service->nmem, md, name, type, merge, setting,
166 brief, termlist, rank, sortkey_offset,
172 static struct conf_sortkey * conf_service_add_sortkey(
173 struct conf_service *service,
176 enum conf_sortkey_type type)
178 struct conf_sortkey * sk = 0;
180 if (!service || !service->sortkeys || !service->num_sortkeys
181 || field_id < 0 || !(field_id < service->num_sortkeys))
184 //sk = &((service->sortkeys)[field_id]);
185 sk = service->sortkeys + field_id;
186 conf_sortkey_assign(service->nmem, sk, name, type);
192 int conf_service_metadata_field_id(struct conf_service *service,
197 if (!service || !service->metadata || !service->num_metadata)
200 for(i = 0; i < service->num_metadata; i++) {
201 if (!strcmp(name, (service->metadata[i]).name))
209 int conf_service_sortkey_field_id(struct conf_service *service,
214 if (!service || !service->sortkeys || !service->num_sortkeys)
217 for(i = 0; i < service->num_sortkeys; i++) {
218 if (!strcmp(name, (service->sortkeys[i]).name))
225 static void conf_dir_path(struct conf_config *config, WRBUF w, const char *src)
227 if (config->confdir && wrbuf_len(config->confdir) > 0 &&
228 !yaz_is_abspath(src))
230 wrbuf_printf(w, "%s/%s", wrbuf_cstr(config->confdir), src);
236 void service_destroy(struct conf_service *service)
240 assert(service->ref_count > 0);
241 service->ref_count--;
242 if (service->ref_count == 0)
244 pp2_charset_destroy(service->relevance_pct);
245 pp2_charset_destroy(service->sort_pct);
246 pp2_charset_destroy(service->mergekey_pct);
247 nmem_destroy(service->nmem);
252 void service_incref(struct conf_service *service)
254 service->ref_count++;
257 static int parse_metadata(struct conf_service *service, xmlNode *n,
258 int *md_node, int *sk_node)
260 xmlChar *xml_name = xmlGetProp(n, (xmlChar *) "name");
261 xmlChar *xml_brief = xmlGetProp(n, (xmlChar *) "brief");
262 xmlChar *xml_sortkey = xmlGetProp(n, (xmlChar *) "sortkey");
263 xmlChar *xml_merge = xmlGetProp(n, (xmlChar *) "merge");
264 xmlChar *xml_type = xmlGetProp(n, (xmlChar *) "type");
265 xmlChar *xml_termlist = xmlGetProp(n, (xmlChar *) "termlist");
266 xmlChar *xml_rank = xmlGetProp(n, (xmlChar *) "rank");
267 xmlChar *xml_setting = xmlGetProp(n, (xmlChar *) "setting");
268 xmlChar *xml_mergekey = xmlGetProp(n, (xmlChar *) "mergekey");
270 enum conf_metadata_type type = Metadata_type_generic;
271 enum conf_metadata_merge merge = Metadata_merge_no;
272 enum conf_setting_type setting = Metadata_setting_no;
273 enum conf_sortkey_type sk_type = Metadata_sortkey_relevance;
274 enum conf_metadata_mergekey mergekey_type = Metadata_mergekey_no;
278 int sortkey_offset = 0;
280 // now do the parsing logic
283 yaz_log(YLOG_FATAL, "Must specify name in metadata element");
288 if (!strcmp((const char *) xml_brief, "yes"))
290 else if (strcmp((const char *) xml_brief, "no"))
292 yaz_log(YLOG_FATAL, "metadata/brief must be yes or no");
301 if (!strcmp((const char *) xml_termlist, "yes"))
303 else if (strcmp((const char *) xml_termlist, "no"))
305 yaz_log(YLOG_FATAL, "metadata/termlist must be yes or no");
313 rank = atoi((const char *) xml_rank);
319 if (!strcmp((const char *) xml_type, "generic"))
320 type = Metadata_type_generic;
321 else if (!strcmp((const char *) xml_type, "year"))
322 type = Metadata_type_year;
323 else if (!strcmp((const char *) xml_type, "date"))
324 type = Metadata_type_date;
328 "Unknown value for metadata/type: %s", xml_type);
333 type = Metadata_type_generic;
337 if (!strcmp((const char *) xml_merge, "no"))
338 merge = Metadata_merge_no;
339 else if (!strcmp((const char *) xml_merge, "unique"))
340 merge = Metadata_merge_unique;
341 else if (!strcmp((const char *) xml_merge, "longest"))
342 merge = Metadata_merge_longest;
343 else if (!strcmp((const char *) xml_merge, "range"))
344 merge = Metadata_merge_range;
345 else if (!strcmp((const char *) xml_merge, "all"))
346 merge = Metadata_merge_all;
350 "Unknown value for metadata/merge: %s", xml_merge);
355 merge = Metadata_merge_no;
359 if (!strcmp((const char *) xml_setting, "no"))
360 setting = Metadata_setting_no;
361 else if (!strcmp((const char *) xml_setting, "postproc"))
362 setting = Metadata_setting_postproc;
363 else if (!strcmp((const char *) xml_setting, "parameter"))
364 setting = Metadata_setting_parameter;
368 "Unknown value for medadata/setting: %s", xml_setting);
373 // add a sortkey if so specified
374 if (xml_sortkey && strcmp((const char *) xml_sortkey, "no"))
376 if (merge == Metadata_merge_no)
379 "Can't specify sortkey on a non-merged field");
382 if (!strcmp((const char *) xml_sortkey, "numeric"))
383 sk_type = Metadata_sortkey_numeric;
384 else if (!strcmp((const char *) xml_sortkey, "skiparticle"))
385 sk_type = Metadata_sortkey_skiparticle;
389 "Unknown sortkey in metadata element: %s",
393 sortkey_offset = *sk_node;
395 conf_service_add_sortkey(service, *sk_node,
396 (const char *) xml_name, sk_type);
405 if (!strcmp((const char *) xml_mergekey, "required"))
406 mergekey_type = Metadata_mergekey_required;
407 else if (!strcmp((const char *) xml_mergekey, "optional"))
408 mergekey_type = Metadata_mergekey_optional;
409 else if (!strcmp((const char *) xml_mergekey, "no"))
410 mergekey_type = Metadata_mergekey_no;
413 yaz_log(YLOG_FATAL, "Unknown value for mergekey: %s", xml_mergekey);
419 // metadata known, assign values
420 conf_service_add_metadata(service, *md_node,
421 (const char *) xml_name,
422 type, merge, setting,
423 brief, termlist, rank, sortkey_offset,
428 xmlFree(xml_sortkey);
431 xmlFree(xml_termlist);
433 xmlFree(xml_setting);
434 xmlFree(xml_mergekey);
439 static struct conf_service *service_create_static(struct conf_server *server,
441 const char *service_id)
447 struct conf_service *service = 0;
448 int num_metadata = 0;
449 int num_sortkeys = 0;
450 int got_settings = 0;
452 // count num_metadata and num_sortkeys
453 for (n = node->children; n; n = n->next)
454 if (n->type == XML_ELEMENT_NODE && !strcmp((const char *)
455 n->name, "metadata"))
457 xmlChar *sortkey = xmlGetProp(n, (xmlChar *) "sortkey");
459 if (sortkey && strcmp((const char *) sortkey, "no"))
464 service = service_init(server, num_metadata, num_sortkeys, service_id);
466 for (n = node->children; n; n = n->next)
468 if (n->type != XML_ELEMENT_NODE)
470 if (!strcmp((const char *) n->name, "timeout"))
472 xmlChar *src = xmlGetProp(n, (xmlChar *) "session");
475 service->session_timeout = atoi((const char *) src);
477 if (service->session_timeout < 9)
479 yaz_log(YLOG_FATAL, "session timeout out of range");
483 src = xmlGetProp(n, (xmlChar *) "z3950_operation");
486 service->z3950_operation_timeout = atoi((const char *) src);
488 if (service->z3950_session_timeout < 9)
490 yaz_log(YLOG_FATAL, "Z39.50 operation timeout out of range");
494 src = xmlGetProp(n, (xmlChar *) "z3950_session");
497 service->z3950_session_timeout = atoi((const char *) src);
499 if (service->z3950_session_timeout < 9)
501 yaz_log(YLOG_FATAL, "Z39.50 session timeout out of range");
506 else if (!strcmp((const char *) n->name, "settings"))
508 else if (!strcmp((const char *) n->name, (const char *) "targetprofiles"))
510 if (service->targetprofiles)
512 yaz_log(YLOG_FATAL, "Can't repeat targetprofiles");
515 if (!(service->targetprofiles =
516 parse_targetprofiles(service->nmem, n)))
519 else if (!strcmp((const char *) n->name, "relevance"))
521 if (service->relevance_pct)
523 yaz_log(YLOG_LOG, "relevance may not repeat in service");
528 service->relevance_pct = pp2_charset_create_xml(n);
529 if (!service->relevance_pct)
533 else if (!strcmp((const char *) n->name, "sort"))
535 if (service->sort_pct)
537 yaz_log(YLOG_LOG, "sort may not repeat in service");
542 service->sort_pct = pp2_charset_create_xml(n);
543 if (!service->sort_pct)
547 else if (!strcmp((const char *) n->name, "mergekey"))
549 if (service->mergekey_pct)
551 yaz_log(YLOG_LOG, "mergekey may not repeat in service");
556 service->mergekey_pct = pp2_charset_create_xml(n);
557 if (!service->mergekey_pct)
561 else if (!strcmp((const char *) n->name, (const char *) "metadata"))
563 if (parse_metadata(service, n, &md_node, &sk_node))
568 yaz_log(YLOG_FATAL, "Bad element: %s", n->name);
575 /* metadata has been read.. Consider now settings */
576 init_settings(service);
577 for (pass = 1; pass <= 2; pass++)
579 for (n = node->children; n; n = n->next)
581 if (n->type != XML_ELEMENT_NODE)
583 if (!strcmp((const char *) n->name, "settings"))
585 xmlChar *src = xmlGetProp(n, (xmlChar *) "src");
588 WRBUF w = wrbuf_alloc();
589 conf_dir_path(server->config, w, (const char *) src);
590 settings_read_file(service, wrbuf_cstr(w), pass);
596 settings_read_node(service, n, pass);
605 static char *parse_settings(struct conf_config *config,
606 NMEM nmem, xmlNode *node)
608 xmlChar *src = xmlGetProp(node, (xmlChar *) "src");
613 WRBUF w = wrbuf_alloc();
614 conf_dir_path(config, w, (const char *) src);
615 r = nmem_strdup(nmem, wrbuf_cstr(w));
620 yaz_log(YLOG_FATAL, "Must specify src in targetprofile");
627 static void inherit_server_settings(struct conf_service *s)
629 struct conf_server *server = s->server;
630 if (!s->dictionary) /* service has no config settings ? */
632 if (server->server_settings)
634 /* inherit settings from server */
636 settings_read_file(s, server->server_settings, 1);
637 settings_read_file(s, server->server_settings, 2);
641 yaz_log(YLOG_WARN, "service '%s' has no settings",
642 s->id ? s->id : "unnamed");
647 /* use relevance/sort/mergekey from server if not defined
648 for this service.. */
649 if (!s->relevance_pct)
651 if (server->relevance_pct)
653 s->relevance_pct = server->relevance_pct;
654 pp2_charset_incref(s->relevance_pct);
657 s->relevance_pct = pp2_charset_create(0);
662 if (server->sort_pct)
664 s->sort_pct = server->sort_pct;
665 pp2_charset_incref(s->sort_pct);
668 s->sort_pct = pp2_charset_create(0);
671 if (!s->mergekey_pct)
673 if (server->mergekey_pct)
675 s->mergekey_pct = server->mergekey_pct;
676 pp2_charset_incref(s->mergekey_pct);
679 s->mergekey_pct = pp2_charset_create(0);
683 struct conf_service *service_create(struct conf_server *server,
686 struct conf_service *service = service_create_static(server,
690 inherit_server_settings(service);
691 resolve_databases(service);
696 static struct conf_server *server_create(struct conf_config *config,
697 NMEM nmem, xmlNode *node)
700 struct conf_server *server = nmem_malloc(nmem, sizeof(struct conf_server));
701 xmlChar *server_id = xmlGetProp(node, (xmlChar *) "id");
705 server->proxy_host = 0;
706 server->proxy_port = 0;
708 server->proxy_addr = 0;
710 server->config = config;
712 server->relevance_pct = 0;
713 server->sort_pct = 0;
714 server->mergekey_pct = 0;
715 server->server_settings = 0;
719 server->server_id = nmem_strdup(nmem, (const char *)server_id);
723 server->server_id = 0;
724 for (n = node->children; n; n = n->next)
726 if (n->type != XML_ELEMENT_NODE)
728 if (!strcmp((const char *) n->name, "listen"))
730 xmlChar *port = xmlGetProp(n, (xmlChar *) "port");
731 xmlChar *host = xmlGetProp(n, (xmlChar *) "host");
733 server->port = atoi((const char *) port);
735 server->host = nmem_strdup(nmem, (const char *) host);
739 else if (!strcmp((const char *) n->name, "proxy"))
741 xmlChar *port = xmlGetProp(n, (xmlChar *) "port");
742 xmlChar *host = xmlGetProp(n, (xmlChar *) "host");
743 xmlChar *myurl = xmlGetProp(n, (xmlChar *) "myurl");
745 server->proxy_port = atoi((const char *) port);
747 server->proxy_host = nmem_strdup(nmem, (const char *) host);
749 server->myurl = nmem_strdup(nmem, (const char *) myurl);
754 else if (!strcmp((const char *) n->name, "settings"))
756 if (server->server_settings)
758 yaz_log(YLOG_FATAL, "Can't repeat 'settings'");
761 if (!(server->server_settings = parse_settings(config, nmem, n)))
764 else if (!strcmp((const char *) n->name, "relevance"))
766 server->relevance_pct = pp2_charset_create_xml(n);
767 if (!server->relevance_pct)
770 else if (!strcmp((const char *) n->name, "sort"))
772 server->sort_pct = pp2_charset_create_xml(n);
773 if (!server->sort_pct)
776 else if (!strcmp((const char *) n->name, "mergekey"))
778 server->mergekey_pct = pp2_charset_create_xml(n);
779 if (!server->mergekey_pct)
782 else if (!strcmp((const char *) n->name, "service"))
784 char *service_id = (char *)
785 xmlGetProp(n, (xmlChar *) "id");
787 struct conf_service **sp = &server->service;
788 for (; *sp; sp = &(*sp)->next)
789 if ((*sp)->id && service_id &&
790 0 == strcmp((*sp)->id, service_id))
792 yaz_log(YLOG_FATAL, "Duplicate service: %s", service_id);
795 else if (!(*sp)->id && !service_id)
797 yaz_log(YLOG_FATAL, "Duplicate unnamed service");
801 if (*sp) /* service already exist */
808 struct conf_service *s = service_create_static(server, n,
818 yaz_log(YLOG_FATAL, "Bad element: %s", n->name);
824 struct conf_service *s;
825 for (s = server->service; s; s = s->next)
826 inherit_server_settings(s);
831 WRBUF conf_get_fname(struct conf_service *service, const char *fname)
833 struct conf_config *config = service->server->config;
834 WRBUF w = wrbuf_alloc();
836 conf_dir_path(config, w, fname);
840 static struct conf_targetprofiles *parse_targetprofiles(NMEM nmem,
843 struct conf_targetprofiles *r = nmem_malloc(nmem, sizeof(*r));
844 xmlChar *type = xmlGetProp(node, (xmlChar *) "type");
845 xmlChar *src = xmlGetProp(node, (xmlChar *) "src");
847 memset(r, 0, sizeof(*r));
851 if (!strcmp((const char *) type, "local"))
852 r->type = Targetprofiles_local;
855 yaz_log(YLOG_FATAL, "Unknown targetprofile type");
861 yaz_log(YLOG_FATAL, "Must specify type for targetprofile");
866 r->src = nmem_strdup(nmem, (const char *) src);
869 yaz_log(YLOG_FATAL, "Must specify src in targetprofile");
877 struct conf_service *locate_service(struct conf_server *server,
878 const char *service_id)
880 struct conf_service *s = server->service;
881 for (; s; s = s->next)
882 if (s->id && service_id && 0 == strcmp(s->id, service_id))
884 else if (!s->id && !service_id)
890 static int parse_config(struct conf_config *config, xmlNode *root)
894 for (n = root->children; n; n = n->next)
896 if (n->type != XML_ELEMENT_NODE)
898 if (!strcmp((const char *) n->name, "server"))
900 struct conf_server *tmp = server_create(config, config->nmem, n);
903 tmp->next = config->servers;
904 config->servers = tmp;
906 else if (!strcmp((const char *) n->name, "targetprofiles"))
908 yaz_log(YLOG_FATAL, "targetprofiles unsupported here. Must be part of service");
914 yaz_log(YLOG_FATAL, "Bad element: %s", n->name);
921 struct conf_config *config_create(const char *fname, int verbose)
923 xmlDoc *doc = xmlParseFile(fname);
927 NMEM nmem = nmem_create();
928 struct conf_config *config = nmem_malloc(nmem, sizeof(struct conf_config));
930 xmlSubstituteEntitiesDefault(1);
931 xmlLoadExtDtdDefaultValue = 1;
934 yaz_log(YLOG_FATAL, "Failed to read %s", fname);
942 config->confdir = wrbuf_alloc();
943 if ((p = strrchr(fname,
952 wrbuf_write(config->confdir, fname, len);
954 wrbuf_puts(config->confdir, "");
956 n = xmlDocGetRootElement(doc);
957 r = yaz_xml_include_simple(n, wrbuf_cstr(config->confdir));
962 yaz_log(YLOG_LOG, "Configuration %s after include processing",
964 #if LIBXML_VERSION >= 20600
965 xmlDocFormatDump(yaz_log_file(), doc, 0);
967 xmlDocDump(yaz_log_file(), doc);
970 r = parse_config(config, n);
976 config_destroy(config);
982 void server_destroy(struct conf_server *server)
984 struct conf_service *s = server->service;
987 struct conf_service *s_next = s->next;
991 pp2_charset_destroy(server->relevance_pct);
992 pp2_charset_destroy(server->sort_pct);
993 pp2_charset_destroy(server->mergekey_pct);
996 void config_destroy(struct conf_config *config)
1000 struct conf_server *server = config->servers;
1003 struct conf_server *s_next = server->next;
1004 server_destroy(server);
1007 wrbuf_destroy(config->confdir);
1008 nmem_destroy(config->nmem);
1012 void config_stop_listeners(struct conf_config *conf)
1014 struct conf_server *ser;
1015 for (ser = conf->servers; ser; ser = ser->next)
1016 http_close_server(ser);
1019 void config_start_databases(struct conf_config *conf)
1021 struct conf_server *ser;
1022 for (ser = conf->servers; ser; ser = ser->next)
1024 struct conf_service *s = ser->service;
1025 for (;s ; s = s->next)
1026 resolve_databases(s);
1030 int config_start_listeners(struct conf_config *conf,
1031 const char *listener_override)
1033 struct conf_server *ser;
1034 for (ser = conf->servers; ser; ser = ser->next)
1036 WRBUF w = wrbuf_alloc();
1038 if (listener_override)
1040 wrbuf_puts(w, listener_override);
1041 listener_override = 0; /* only first server is overriden */
1046 wrbuf_puts(w, ser->host);
1051 wrbuf_printf(w, "%d", ser->port);
1054 r = http_init(wrbuf_cstr(w), ser);
1060 if (ser->proxy_host || ser->proxy_port)
1062 if (ser->proxy_host)
1063 wrbuf_puts(w, ser->proxy_host);
1064 if (ser->proxy_port)
1068 wrbuf_printf(w, "%d", ser->proxy_port);
1072 http_set_proxyaddr(wrbuf_cstr(w), ser);
1081 * c-file-style: "Stroustrup"
1082 * indent-tabs-mode: nil
1084 * vim: shiftwidth=4 tabstop=8 expandtab