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;
55 static char *parse_settings(struct conf_config *config,
56 NMEM nmem, xmlNode *node);
58 static struct conf_targetprofiles *parse_targetprofiles(NMEM nmem,
61 static void conf_metadata_assign(NMEM nmem,
62 struct conf_metadata * metadata,
64 enum conf_metadata_type type,
65 enum conf_metadata_merge merge,
66 enum conf_setting_type setting,
71 enum conf_metadata_mergekey mt)
73 assert(nmem && metadata && name);
75 metadata->name = nmem_strdup(nmem, name);
77 metadata->type = type;
79 // enforcing that type_year is always range_merge
80 if (metadata->type == Metadata_type_year)
81 metadata->merge = Metadata_merge_range;
83 metadata->merge = merge;
85 metadata->setting = setting;
86 metadata->brief = brief;
87 metadata->termlist = termlist;
88 metadata->rank = rank;
89 metadata->sortkey_offset = sortkey_offset;
90 metadata->mergekey = mt;
94 static void conf_sortkey_assign(NMEM nmem,
95 struct conf_sortkey * sortkey,
97 enum conf_sortkey_type type)
99 assert(nmem && sortkey && name);
101 sortkey->name = nmem_strdup(nmem, name);
102 sortkey->type = type;
106 static struct conf_service *service_init(struct conf_server *server,
107 int num_metadata, int num_sortkeys,
108 const char *service_id)
110 struct conf_service * service = 0;
111 NMEM nmem = nmem_create();
113 service = nmem_malloc(nmem, sizeof(struct conf_service));
114 service->ref_count = 1;
115 service->nmem = nmem;
117 service->settings = 0;
118 service->databases = 0;
119 service->targetprofiles = 0;
120 service->server = server;
121 service->session_timeout = 60; /* default session timeout */
122 service->z3950_session_timeout = 180;
123 service->z3950_operation_timeout = 30;
125 service->relevance_pct = 0;
126 service->sort_pct = 0;
127 service->mergekey_pct = 0;
129 service->id = service_id ? nmem_strdup(nmem, service_id) : 0;
130 service->num_metadata = num_metadata;
131 service->metadata = 0;
132 if (service->num_metadata)
135 sizeof(struct conf_metadata) * service->num_metadata);
136 service->num_sortkeys = num_sortkeys;
137 service->sortkeys = 0;
138 if (service->num_sortkeys)
141 sizeof(struct conf_sortkey) * service->num_sortkeys);
142 service->dictionary = 0;
146 static struct conf_metadata* conf_service_add_metadata(
147 struct conf_service *service,
150 enum conf_metadata_type type,
151 enum conf_metadata_merge merge,
152 enum conf_setting_type setting,
157 enum conf_metadata_mergekey mt)
159 struct conf_metadata * md = 0;
161 if (!service || !service->metadata || !service->num_metadata
162 || field_id < 0 || !(field_id < service->num_metadata))
165 md = service->metadata + field_id;
166 conf_metadata_assign(service->nmem, md, name, type, merge, setting,
167 brief, termlist, rank, sortkey_offset,
173 static struct conf_sortkey * conf_service_add_sortkey(
174 struct conf_service *service,
177 enum conf_sortkey_type type)
179 struct conf_sortkey * sk = 0;
181 if (!service || !service->sortkeys || !service->num_sortkeys
182 || field_id < 0 || !(field_id < service->num_sortkeys))
185 //sk = &((service->sortkeys)[field_id]);
186 sk = service->sortkeys + field_id;
187 conf_sortkey_assign(service->nmem, sk, name, type);
193 int conf_service_metadata_field_id(struct conf_service *service,
198 if (!service || !service->metadata || !service->num_metadata)
201 for(i = 0; i < service->num_metadata; i++) {
202 if (!strcmp(name, (service->metadata[i]).name))
210 int conf_service_sortkey_field_id(struct conf_service *service,
215 if (!service || !service->sortkeys || !service->num_sortkeys)
218 for(i = 0; i < service->num_sortkeys; i++) {
219 if (!strcmp(name, (service->sortkeys[i]).name))
226 static void conf_dir_path(struct conf_config *config, WRBUF w, const char *src)
228 if (config->confdir && wrbuf_len(config->confdir) > 0 &&
229 !yaz_is_abspath(src))
231 wrbuf_printf(w, "%s/%s", wrbuf_cstr(config->confdir), src);
237 void service_destroy(struct conf_service *service)
241 assert(service->ref_count > 0);
242 service->ref_count--;
243 if (service->ref_count == 0)
245 pp2_charset_destroy(service->relevance_pct);
246 pp2_charset_destroy(service->sort_pct);
247 pp2_charset_destroy(service->mergekey_pct);
248 nmem_destroy(service->nmem);
253 void service_incref(struct conf_service *service)
255 service->ref_count++;
258 static int parse_metadata(struct conf_service *service, xmlNode *n,
259 int *md_node, int *sk_node)
261 xmlChar *xml_name = xmlGetProp(n, (xmlChar *) "name");
262 xmlChar *xml_brief = xmlGetProp(n, (xmlChar *) "brief");
263 xmlChar *xml_sortkey = xmlGetProp(n, (xmlChar *) "sortkey");
264 xmlChar *xml_merge = xmlGetProp(n, (xmlChar *) "merge");
265 xmlChar *xml_type = xmlGetProp(n, (xmlChar *) "type");
266 xmlChar *xml_termlist = xmlGetProp(n, (xmlChar *) "termlist");
267 xmlChar *xml_rank = xmlGetProp(n, (xmlChar *) "rank");
268 xmlChar *xml_setting = xmlGetProp(n, (xmlChar *) "setting");
269 xmlChar *xml_mergekey = xmlGetProp(n, (xmlChar *) "mergekey");
271 enum conf_metadata_type type = Metadata_type_generic;
272 enum conf_metadata_merge merge = Metadata_merge_no;
273 enum conf_setting_type setting = Metadata_setting_no;
274 enum conf_sortkey_type sk_type = Metadata_sortkey_relevance;
275 enum conf_metadata_mergekey mergekey_type = Metadata_mergekey_no;
279 int sortkey_offset = 0;
281 // now do the parsing logic
284 yaz_log(YLOG_FATAL, "Must specify name in metadata element");
289 if (!strcmp((const char *) xml_brief, "yes"))
291 else if (strcmp((const char *) xml_brief, "no"))
293 yaz_log(YLOG_FATAL, "metadata/brief must be yes or no");
302 if (!strcmp((const char *) xml_termlist, "yes"))
304 else if (strcmp((const char *) xml_termlist, "no"))
306 yaz_log(YLOG_FATAL, "metadata/termlist must be yes or no");
314 rank = atoi((const char *) xml_rank);
320 if (!strcmp((const char *) xml_type, "generic"))
321 type = Metadata_type_generic;
322 else if (!strcmp((const char *) xml_type, "year"))
323 type = Metadata_type_year;
324 else if (!strcmp((const char *) xml_type, "date"))
325 type = Metadata_type_date;
329 "Unknown value for metadata/type: %s", xml_type);
334 type = Metadata_type_generic;
338 if (!strcmp((const char *) xml_merge, "no"))
339 merge = Metadata_merge_no;
340 else if (!strcmp((const char *) xml_merge, "unique"))
341 merge = Metadata_merge_unique;
342 else if (!strcmp((const char *) xml_merge, "longest"))
343 merge = Metadata_merge_longest;
344 else if (!strcmp((const char *) xml_merge, "range"))
345 merge = Metadata_merge_range;
346 else if (!strcmp((const char *) xml_merge, "all"))
347 merge = Metadata_merge_all;
351 "Unknown value for metadata/merge: %s", xml_merge);
356 merge = Metadata_merge_no;
360 if (!strcmp((const char *) xml_setting, "no"))
361 setting = Metadata_setting_no;
362 else if (!strcmp((const char *) xml_setting, "postproc"))
363 setting = Metadata_setting_postproc;
364 else if (!strcmp((const char *) xml_setting, "parameter"))
365 setting = Metadata_setting_parameter;
369 "Unknown value for medadata/setting: %s", xml_setting);
374 // add a sortkey if so specified
375 if (xml_sortkey && strcmp((const char *) xml_sortkey, "no"))
377 if (merge == Metadata_merge_no)
380 "Can't specify sortkey on a non-merged field");
383 if (!strcmp((const char *) xml_sortkey, "numeric"))
384 sk_type = Metadata_sortkey_numeric;
385 else if (!strcmp((const char *) xml_sortkey, "skiparticle"))
386 sk_type = Metadata_sortkey_skiparticle;
390 "Unknown sortkey in metadata element: %s",
394 sortkey_offset = *sk_node;
396 conf_service_add_sortkey(service, *sk_node,
397 (const char *) xml_name, sk_type);
406 if (!strcmp((const char *) xml_mergekey, "required"))
407 mergekey_type = Metadata_mergekey_required;
408 else if (!strcmp((const char *) xml_mergekey, "optional"))
409 mergekey_type = Metadata_mergekey_optional;
410 else if (!strcmp((const char *) xml_mergekey, "no"))
411 mergekey_type = Metadata_mergekey_no;
414 yaz_log(YLOG_FATAL, "Unknown value for mergekey: %s", xml_mergekey);
420 // metadata known, assign values
421 conf_service_add_metadata(service, *md_node,
422 (const char *) xml_name,
423 type, merge, setting,
424 brief, termlist, rank, sortkey_offset,
429 xmlFree(xml_sortkey);
432 xmlFree(xml_termlist);
434 xmlFree(xml_setting);
435 xmlFree(xml_mergekey);
440 static struct conf_service *service_create_static(struct conf_server *server,
442 const char *service_id)
448 struct conf_service *service = 0;
449 int num_metadata = 0;
450 int num_sortkeys = 0;
451 int got_settings = 0;
453 // count num_metadata and num_sortkeys
454 for (n = node->children; n; n = n->next)
455 if (n->type == XML_ELEMENT_NODE && !strcmp((const char *)
456 n->name, "metadata"))
458 xmlChar *sortkey = xmlGetProp(n, (xmlChar *) "sortkey");
460 if (sortkey && strcmp((const char *) sortkey, "no"))
465 service = service_init(server, num_metadata, num_sortkeys, service_id);
467 for (n = node->children; n; n = n->next)
469 if (n->type != XML_ELEMENT_NODE)
471 if (!strcmp((const char *) n->name, "timeout"))
473 xmlChar *src = xmlGetProp(n, (xmlChar *) "session");
476 service->session_timeout = atoi((const char *) src);
478 if (service->session_timeout < 9)
480 yaz_log(YLOG_FATAL, "session timeout out of range");
484 src = xmlGetProp(n, (xmlChar *) "z3950_operation");
487 service->z3950_operation_timeout = atoi((const char *) src);
489 if (service->z3950_session_timeout < 9)
491 yaz_log(YLOG_FATAL, "Z39.50 operation timeout out of range");
495 src = xmlGetProp(n, (xmlChar *) "z3950_session");
498 service->z3950_session_timeout = atoi((const char *) src);
500 if (service->z3950_session_timeout < 9)
502 yaz_log(YLOG_FATAL, "Z39.50 session timeout out of range");
507 else if (!strcmp((const char *) n->name, "settings"))
509 else if (!strcmp((const char *) n->name, (const char *) "targetprofiles"))
511 if (service->targetprofiles)
513 yaz_log(YLOG_FATAL, "Can't repeat targetprofiles");
516 if (!(service->targetprofiles =
517 parse_targetprofiles(service->nmem, n)))
520 else if (!strcmp((const char *) n->name, "relevance"))
522 if (service->relevance_pct)
524 yaz_log(YLOG_LOG, "relevance may not repeat in service");
529 service->relevance_pct = pp2_charset_create_xml(n);
530 if (!service->relevance_pct)
534 else if (!strcmp((const char *) n->name, "sort"))
536 if (service->sort_pct)
538 yaz_log(YLOG_LOG, "sort may not repeat in service");
543 service->sort_pct = pp2_charset_create_xml(n);
544 if (!service->sort_pct)
548 else if (!strcmp((const char *) n->name, "mergekey"))
550 if (service->mergekey_pct)
552 yaz_log(YLOG_LOG, "mergekey may not repeat in service");
557 service->mergekey_pct = pp2_charset_create_xml(n);
558 if (!service->mergekey_pct)
562 else if (!strcmp((const char *) n->name, (const char *) "metadata"))
564 if (parse_metadata(service, n, &md_node, &sk_node))
569 yaz_log(YLOG_FATAL, "Bad element: %s", n->name);
576 /* metadata has been read.. Consider now settings */
577 init_settings(service);
578 for (pass = 1; pass <= 2; pass++)
580 for (n = node->children; n; n = n->next)
582 if (n->type != XML_ELEMENT_NODE)
584 if (!strcmp((const char *) n->name, "settings"))
586 xmlChar *src = xmlGetProp(n, (xmlChar *) "src");
589 WRBUF w = wrbuf_alloc();
590 conf_dir_path(server->config, w, (const char *) src);
591 settings_read_file(service, wrbuf_cstr(w), pass);
597 settings_read_node(service, n, pass);
606 static char *parse_settings(struct conf_config *config,
607 NMEM nmem, xmlNode *node)
609 xmlChar *src = xmlGetProp(node, (xmlChar *) "src");
614 WRBUF w = wrbuf_alloc();
615 conf_dir_path(config, w, (const char *) src);
616 r = nmem_strdup(nmem, wrbuf_cstr(w));
621 yaz_log(YLOG_FATAL, "Must specify src in targetprofile");
628 static void inherit_server_settings(struct conf_service *s)
630 struct conf_server *server = s->server;
631 if (!s->dictionary) /* service has no config settings ? */
633 if (server->server_settings)
635 /* inherit settings from server */
637 settings_read_file(s, server->server_settings, 1);
638 settings_read_file(s, server->server_settings, 2);
642 yaz_log(YLOG_WARN, "service '%s' has no settings",
643 s->id ? s->id : "unnamed");
648 /* use relevance/sort/mergekey from server if not defined
649 for this service.. */
650 if (!s->relevance_pct)
652 if (server->relevance_pct)
654 s->relevance_pct = server->relevance_pct;
655 pp2_charset_incref(s->relevance_pct);
658 s->relevance_pct = pp2_charset_create(0);
663 if (server->sort_pct)
665 s->sort_pct = server->sort_pct;
666 pp2_charset_incref(s->sort_pct);
669 s->sort_pct = pp2_charset_create(0);
672 if (!s->mergekey_pct)
674 if (server->mergekey_pct)
676 s->mergekey_pct = server->mergekey_pct;
677 pp2_charset_incref(s->mergekey_pct);
680 s->mergekey_pct = pp2_charset_create(0);
684 struct conf_service *service_create(struct conf_server *server,
687 struct conf_service *service = service_create_static(server,
691 inherit_server_settings(service);
692 resolve_databases(service);
697 static struct conf_server *server_create(struct conf_config *config,
698 NMEM nmem, xmlNode *node)
701 struct conf_server *server = nmem_malloc(nmem, sizeof(struct conf_server));
702 xmlChar *server_id = xmlGetProp(node, (xmlChar *) "id");
706 server->proxy_host = 0;
707 server->proxy_port = 0;
709 server->proxy_addr = 0;
711 server->config = config;
713 server->relevance_pct = 0;
714 server->sort_pct = 0;
715 server->mergekey_pct = 0;
716 server->server_settings = 0;
720 server->server_id = nmem_strdup(nmem, (const char *)server_id);
724 server->server_id = 0;
725 for (n = node->children; n; n = n->next)
727 if (n->type != XML_ELEMENT_NODE)
729 if (!strcmp((const char *) n->name, "listen"))
731 xmlChar *port = xmlGetProp(n, (xmlChar *) "port");
732 xmlChar *host = xmlGetProp(n, (xmlChar *) "host");
734 server->port = atoi((const char *) port);
736 server->host = nmem_strdup(nmem, (const char *) host);
740 else if (!strcmp((const char *) n->name, "proxy"))
742 xmlChar *port = xmlGetProp(n, (xmlChar *) "port");
743 xmlChar *host = xmlGetProp(n, (xmlChar *) "host");
744 xmlChar *myurl = xmlGetProp(n, (xmlChar *) "myurl");
746 server->proxy_port = atoi((const char *) port);
748 server->proxy_host = nmem_strdup(nmem, (const char *) host);
750 server->myurl = nmem_strdup(nmem, (const char *) myurl);
755 else if (!strcmp((const char *) n->name, "settings"))
757 if (server->server_settings)
759 yaz_log(YLOG_FATAL, "Can't repeat 'settings'");
762 if (!(server->server_settings = parse_settings(config, nmem, n)))
765 else if (!strcmp((const char *) n->name, "relevance"))
767 server->relevance_pct = pp2_charset_create_xml(n);
768 if (!server->relevance_pct)
771 else if (!strcmp((const char *) n->name, "sort"))
773 server->sort_pct = pp2_charset_create_xml(n);
774 if (!server->sort_pct)
777 else if (!strcmp((const char *) n->name, "mergekey"))
779 server->mergekey_pct = pp2_charset_create_xml(n);
780 if (!server->mergekey_pct)
783 else if (!strcmp((const char *) n->name, "service"))
785 char *service_id = (char *)
786 xmlGetProp(n, (xmlChar *) "id");
788 struct conf_service **sp = &server->service;
789 for (; *sp; sp = &(*sp)->next)
790 if ((*sp)->id && service_id &&
791 0 == strcmp((*sp)->id, service_id))
793 yaz_log(YLOG_FATAL, "Duplicate service: %s", service_id);
796 else if (!(*sp)->id && !service_id)
798 yaz_log(YLOG_FATAL, "Duplicate unnamed service");
802 if (*sp) /* service already exist */
809 struct conf_service *s = service_create_static(server, n,
819 yaz_log(YLOG_FATAL, "Bad element: %s", n->name);
825 struct conf_service *s;
826 for (s = server->service; s; s = s->next)
827 inherit_server_settings(s);
832 WRBUF conf_get_fname(struct conf_service *service, const char *fname)
834 struct conf_config *config = service->server->config;
835 WRBUF w = wrbuf_alloc();
837 conf_dir_path(config, w, fname);
841 static struct conf_targetprofiles *parse_targetprofiles(NMEM nmem,
844 struct conf_targetprofiles *r = nmem_malloc(nmem, sizeof(*r));
845 xmlChar *type = xmlGetProp(node, (xmlChar *) "type");
846 xmlChar *src = xmlGetProp(node, (xmlChar *) "src");
848 memset(r, 0, sizeof(*r));
852 if (!strcmp((const char *) type, "local"))
853 r->type = Targetprofiles_local;
856 yaz_log(YLOG_FATAL, "Unknown targetprofile type");
862 yaz_log(YLOG_FATAL, "Must specify type for targetprofile");
867 r->src = nmem_strdup(nmem, (const char *) src);
870 yaz_log(YLOG_FATAL, "Must specify src in targetprofile");
878 struct conf_service *locate_service(struct conf_server *server,
879 const char *service_id)
881 struct conf_service *s = server->service;
882 for (; s; s = s->next)
883 if (s->id && service_id && 0 == strcmp(s->id, service_id))
885 else if (!s->id && !service_id)
891 static int parse_config(struct conf_config *config, xmlNode *root)
895 for (n = root->children; n; n = n->next)
897 if (n->type != XML_ELEMENT_NODE)
899 if (!strcmp((const char *) n->name, "server"))
901 struct conf_server *tmp = server_create(config, config->nmem, n);
904 tmp->next = config->servers;
905 config->servers = tmp;
907 else if (!strcmp((const char *) n->name, "threads"))
909 xmlChar *number = xmlGetProp(n, (xmlChar *) "number");
912 config->no_threads = atoi(number);
916 else if (!strcmp((const char *) n->name, "targetprofiles"))
918 yaz_log(YLOG_FATAL, "targetprofiles unsupported here. Must be part of service");
924 yaz_log(YLOG_FATAL, "Bad element: %s", n->name);
931 struct conf_config *config_create(const char *fname, int verbose)
933 xmlDoc *doc = xmlParseFile(fname);
937 NMEM nmem = nmem_create();
938 struct conf_config *config = nmem_malloc(nmem, sizeof(struct conf_config));
940 xmlSubstituteEntitiesDefault(1);
941 xmlLoadExtDtdDefaultValue = 1;
944 yaz_log(YLOG_FATAL, "Failed to read %s", fname);
951 config->no_threads = 0;
953 config->confdir = wrbuf_alloc();
954 if ((p = strrchr(fname,
963 wrbuf_write(config->confdir, fname, len);
965 wrbuf_puts(config->confdir, "");
967 n = xmlDocGetRootElement(doc);
968 r = yaz_xml_include_simple(n, wrbuf_cstr(config->confdir));
973 yaz_log(YLOG_LOG, "Configuration %s after include processing",
975 #if LIBXML_VERSION >= 20600
976 xmlDocFormatDump(yaz_log_file(), doc, 0);
978 xmlDocDump(yaz_log_file(), doc);
981 r = parse_config(config, n);
987 config_destroy(config);
993 void server_destroy(struct conf_server *server)
995 struct conf_service *s = server->service;
998 struct conf_service *s_next = s->next;
1002 pp2_charset_destroy(server->relevance_pct);
1003 pp2_charset_destroy(server->sort_pct);
1004 pp2_charset_destroy(server->mergekey_pct);
1007 void config_destroy(struct conf_config *config)
1011 struct conf_server *server = config->servers;
1014 struct conf_server *s_next = server->next;
1015 server_destroy(server);
1018 wrbuf_destroy(config->confdir);
1019 nmem_destroy(config->nmem);
1023 void config_stop_listeners(struct conf_config *conf)
1025 struct conf_server *ser;
1026 for (ser = conf->servers; ser; ser = ser->next)
1027 http_close_server(ser);
1030 void config_start_databases(struct conf_config *conf)
1032 struct conf_server *ser;
1033 for (ser = conf->servers; ser; ser = ser->next)
1035 struct conf_service *s = ser->service;
1036 for (;s ; s = s->next)
1037 resolve_databases(s);
1041 int config_start_listeners(struct conf_config *conf,
1042 const char *listener_override)
1044 struct conf_server *ser;
1045 pazpar2_chan_man_start(conf->no_threads);
1046 for (ser = conf->servers; ser; ser = ser->next)
1048 WRBUF w = wrbuf_alloc();
1050 if (listener_override)
1052 wrbuf_puts(w, listener_override);
1053 listener_override = 0; /* only first server is overriden */
1058 wrbuf_puts(w, ser->host);
1063 wrbuf_printf(w, "%d", ser->port);
1066 r = http_init(wrbuf_cstr(w), ser);
1072 if (ser->proxy_host || ser->proxy_port)
1074 if (ser->proxy_host)
1075 wrbuf_puts(w, ser->proxy_host);
1076 if (ser->proxy_port)
1080 wrbuf_printf(w, "%d", ser->proxy_port);
1084 http_set_proxyaddr(wrbuf_cstr(w), ser);
1093 * c-file-style: "Stroustrup"
1094 * indent-tabs-mode: nil
1096 * vim: shiftwidth=4 tabstop=8 expandtab