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>
42 #include "pazpar2_config.h"
49 NMEM nmem; /* for conf_config and servers memory */
50 struct conf_server *servers;
54 iochan_man_t iochan_man;
58 static char *parse_settings(struct conf_config *config,
59 NMEM nmem, xmlNode *node);
61 static struct conf_targetprofiles *parse_targetprofiles(NMEM nmem,
64 static void conf_metadata_assign(NMEM nmem,
65 struct conf_metadata * metadata,
67 enum conf_metadata_type type,
68 enum conf_metadata_merge merge,
69 enum conf_setting_type setting,
74 enum conf_metadata_mergekey mt)
76 assert(nmem && metadata && name);
78 metadata->name = nmem_strdup(nmem, name);
80 metadata->type = type;
82 // enforcing that type_year is always range_merge
83 if (metadata->type == Metadata_type_year)
84 metadata->merge = Metadata_merge_range;
86 metadata->merge = merge;
88 metadata->setting = setting;
89 metadata->brief = brief;
90 metadata->termlist = termlist;
91 metadata->rank = rank;
92 metadata->sortkey_offset = sortkey_offset;
93 metadata->mergekey = mt;
97 static void conf_sortkey_assign(NMEM nmem,
98 struct conf_sortkey * sortkey,
100 enum conf_sortkey_type type)
102 assert(nmem && sortkey && name);
104 sortkey->name = nmem_strdup(nmem, name);
105 sortkey->type = type;
109 static struct conf_service *service_init(struct conf_server *server,
110 int num_metadata, int num_sortkeys,
111 const char *service_id)
113 struct conf_service * service = 0;
114 NMEM nmem = nmem_create();
116 service = nmem_malloc(nmem, sizeof(struct conf_service));
118 service->ref_count = 1;
119 service->nmem = nmem;
121 service->settings = 0;
122 service->databases = 0;
123 service->targetprofiles = 0;
124 service->server = server;
125 service->session_timeout = 60; /* default session timeout */
126 service->z3950_session_timeout = 180;
127 service->z3950_operation_timeout = 30;
129 service->relevance_pct = 0;
130 service->sort_pct = 0;
131 service->mergekey_pct = 0;
133 service->id = service_id ? nmem_strdup(nmem, service_id) : 0;
134 service->num_metadata = num_metadata;
135 service->metadata = 0;
136 if (service->num_metadata)
139 sizeof(struct conf_metadata) * service->num_metadata);
140 service->num_sortkeys = num_sortkeys;
141 service->sortkeys = 0;
142 if (service->num_sortkeys)
145 sizeof(struct conf_sortkey) * service->num_sortkeys);
146 service->dictionary = 0;
150 static struct conf_metadata* conf_service_add_metadata(
151 struct conf_service *service,
154 enum conf_metadata_type type,
155 enum conf_metadata_merge merge,
156 enum conf_setting_type setting,
161 enum conf_metadata_mergekey mt)
163 struct conf_metadata * md = 0;
165 if (!service || !service->metadata || !service->num_metadata
166 || field_id < 0 || !(field_id < service->num_metadata))
169 md = service->metadata + field_id;
170 conf_metadata_assign(service->nmem, md, name, type, merge, setting,
171 brief, termlist, rank, sortkey_offset,
177 static struct conf_sortkey * conf_service_add_sortkey(
178 struct conf_service *service,
181 enum conf_sortkey_type type)
183 struct conf_sortkey * sk = 0;
185 if (!service || !service->sortkeys || !service->num_sortkeys
186 || field_id < 0 || !(field_id < service->num_sortkeys))
189 //sk = &((service->sortkeys)[field_id]);
190 sk = service->sortkeys + field_id;
191 conf_sortkey_assign(service->nmem, sk, name, type);
197 int conf_service_metadata_field_id(struct conf_service *service,
202 if (!service || !service->metadata || !service->num_metadata)
205 for(i = 0; i < service->num_metadata; i++) {
206 if (!strcmp(name, (service->metadata[i]).name))
214 int conf_service_sortkey_field_id(struct conf_service *service,
219 if (!service || !service->sortkeys || !service->num_sortkeys)
222 for(i = 0; i < service->num_sortkeys; i++) {
223 if (!strcmp(name, (service->sortkeys[i]).name))
230 static void conf_dir_path(struct conf_config *config, WRBUF w, const char *src)
232 if (config->confdir && wrbuf_len(config->confdir) > 0 &&
233 !yaz_is_abspath(src))
235 wrbuf_printf(w, "%s/%s", wrbuf_cstr(config->confdir), src);
241 void service_destroy(struct conf_service *service)
245 if (!pazpar2_decref(&service->ref_count, service->mutex))
247 pp2_charset_destroy(service->relevance_pct);
248 pp2_charset_destroy(service->sort_pct);
249 pp2_charset_destroy(service->mergekey_pct);
250 yaz_mutex_destroy(&service->mutex);
251 nmem_destroy(service->nmem);
256 void service_incref(struct conf_service *service)
258 yaz_log(YLOG_LOG, "service_incref. p=%p cnt=%d", service,
260 pazpar2_incref(&service->ref_count, service->mutex);
263 static int parse_metadata(struct conf_service *service, xmlNode *n,
264 int *md_node, int *sk_node)
266 xmlChar *xml_name = xmlGetProp(n, (xmlChar *) "name");
267 xmlChar *xml_brief = xmlGetProp(n, (xmlChar *) "brief");
268 xmlChar *xml_sortkey = xmlGetProp(n, (xmlChar *) "sortkey");
269 xmlChar *xml_merge = xmlGetProp(n, (xmlChar *) "merge");
270 xmlChar *xml_type = xmlGetProp(n, (xmlChar *) "type");
271 xmlChar *xml_termlist = xmlGetProp(n, (xmlChar *) "termlist");
272 xmlChar *xml_rank = xmlGetProp(n, (xmlChar *) "rank");
273 xmlChar *xml_setting = xmlGetProp(n, (xmlChar *) "setting");
274 xmlChar *xml_mergekey = xmlGetProp(n, (xmlChar *) "mergekey");
276 enum conf_metadata_type type = Metadata_type_generic;
277 enum conf_metadata_merge merge = Metadata_merge_no;
278 enum conf_setting_type setting = Metadata_setting_no;
279 enum conf_sortkey_type sk_type = Metadata_sortkey_relevance;
280 enum conf_metadata_mergekey mergekey_type = Metadata_mergekey_no;
284 int sortkey_offset = 0;
286 // now do the parsing logic
289 yaz_log(YLOG_FATAL, "Must specify name in metadata element");
294 if (!strcmp((const char *) xml_brief, "yes"))
296 else if (strcmp((const char *) xml_brief, "no"))
298 yaz_log(YLOG_FATAL, "metadata/brief must be yes or no");
307 if (!strcmp((const char *) xml_termlist, "yes"))
309 else if (strcmp((const char *) xml_termlist, "no"))
311 yaz_log(YLOG_FATAL, "metadata/termlist must be yes or no");
319 rank = atoi((const char *) xml_rank);
325 if (!strcmp((const char *) xml_type, "generic"))
326 type = Metadata_type_generic;
327 else if (!strcmp((const char *) xml_type, "year"))
328 type = Metadata_type_year;
329 else if (!strcmp((const char *) xml_type, "date"))
330 type = Metadata_type_date;
334 "Unknown value for metadata/type: %s", xml_type);
339 type = Metadata_type_generic;
343 if (!strcmp((const char *) xml_merge, "no"))
344 merge = Metadata_merge_no;
345 else if (!strcmp((const char *) xml_merge, "unique"))
346 merge = Metadata_merge_unique;
347 else if (!strcmp((const char *) xml_merge, "longest"))
348 merge = Metadata_merge_longest;
349 else if (!strcmp((const char *) xml_merge, "range"))
350 merge = Metadata_merge_range;
351 else if (!strcmp((const char *) xml_merge, "all"))
352 merge = Metadata_merge_all;
356 "Unknown value for metadata/merge: %s", xml_merge);
361 merge = Metadata_merge_no;
365 if (!strcmp((const char *) xml_setting, "no"))
366 setting = Metadata_setting_no;
367 else if (!strcmp((const char *) xml_setting, "postproc"))
368 setting = Metadata_setting_postproc;
369 else if (!strcmp((const char *) xml_setting, "parameter"))
370 setting = Metadata_setting_parameter;
374 "Unknown value for medadata/setting: %s", xml_setting);
379 // add a sortkey if so specified
380 if (xml_sortkey && strcmp((const char *) xml_sortkey, "no"))
382 if (merge == Metadata_merge_no)
385 "Can't specify sortkey on a non-merged field");
388 if (!strcmp((const char *) xml_sortkey, "numeric"))
389 sk_type = Metadata_sortkey_numeric;
390 else if (!strcmp((const char *) xml_sortkey, "skiparticle"))
391 sk_type = Metadata_sortkey_skiparticle;
395 "Unknown sortkey in metadata element: %s",
399 sortkey_offset = *sk_node;
401 conf_service_add_sortkey(service, *sk_node,
402 (const char *) xml_name, sk_type);
411 if (!strcmp((const char *) xml_mergekey, "required"))
412 mergekey_type = Metadata_mergekey_required;
413 else if (!strcmp((const char *) xml_mergekey, "optional"))
414 mergekey_type = Metadata_mergekey_optional;
415 else if (!strcmp((const char *) xml_mergekey, "no"))
416 mergekey_type = Metadata_mergekey_no;
419 yaz_log(YLOG_FATAL, "Unknown value for mergekey: %s", xml_mergekey);
425 // metadata known, assign values
426 conf_service_add_metadata(service, *md_node,
427 (const char *) xml_name,
428 type, merge, setting,
429 brief, termlist, rank, sortkey_offset,
434 xmlFree(xml_sortkey);
437 xmlFree(xml_termlist);
439 xmlFree(xml_setting);
440 xmlFree(xml_mergekey);
445 static struct conf_service *service_create_static(struct conf_server *server,
447 const char *service_id)
453 struct conf_service *service = 0;
454 int num_metadata = 0;
455 int num_sortkeys = 0;
456 int got_settings = 0;
458 // count num_metadata and num_sortkeys
459 for (n = node->children; n; n = n->next)
460 if (n->type == XML_ELEMENT_NODE && !strcmp((const char *)
461 n->name, "metadata"))
463 xmlChar *sortkey = xmlGetProp(n, (xmlChar *) "sortkey");
465 if (sortkey && strcmp((const char *) sortkey, "no"))
470 service = service_init(server, num_metadata, num_sortkeys, service_id);
472 for (n = node->children; n; n = n->next)
474 if (n->type != XML_ELEMENT_NODE)
476 if (!strcmp((const char *) n->name, "timeout"))
478 xmlChar *src = xmlGetProp(n, (xmlChar *) "session");
481 service->session_timeout = atoi((const char *) src);
483 if (service->session_timeout < 9)
485 yaz_log(YLOG_FATAL, "session timeout out of range");
489 src = xmlGetProp(n, (xmlChar *) "z3950_operation");
492 service->z3950_operation_timeout = atoi((const char *) src);
494 if (service->z3950_session_timeout < 9)
496 yaz_log(YLOG_FATAL, "Z39.50 operation timeout out of range");
500 src = xmlGetProp(n, (xmlChar *) "z3950_session");
503 service->z3950_session_timeout = atoi((const char *) src);
505 if (service->z3950_session_timeout < 9)
507 yaz_log(YLOG_FATAL, "Z39.50 session timeout out of range");
512 else if (!strcmp((const char *) n->name, "settings"))
514 else if (!strcmp((const char *) n->name, (const char *) "targetprofiles"))
516 if (service->targetprofiles)
518 yaz_log(YLOG_FATAL, "Can't repeat targetprofiles");
521 if (!(service->targetprofiles =
522 parse_targetprofiles(service->nmem, n)))
525 else if (!strcmp((const char *) n->name, "relevance"))
527 if (service->relevance_pct)
529 yaz_log(YLOG_LOG, "relevance may not repeat in service");
534 service->relevance_pct = pp2_charset_create_xml(n);
535 if (!service->relevance_pct)
539 else if (!strcmp((const char *) n->name, "sort"))
541 if (service->sort_pct)
543 yaz_log(YLOG_LOG, "sort may not repeat in service");
548 service->sort_pct = pp2_charset_create_xml(n);
549 if (!service->sort_pct)
553 else if (!strcmp((const char *) n->name, "mergekey"))
555 if (service->mergekey_pct)
557 yaz_log(YLOG_LOG, "mergekey may not repeat in service");
562 service->mergekey_pct = pp2_charset_create_xml(n);
563 if (!service->mergekey_pct)
567 else if (!strcmp((const char *) n->name, (const char *) "metadata"))
569 if (parse_metadata(service, n, &md_node, &sk_node))
574 yaz_log(YLOG_FATAL, "Bad element: %s", n->name);
581 /* metadata has been read.. Consider now settings */
582 init_settings(service);
583 for (pass = 1; pass <= 2; pass++)
585 for (n = node->children; n; n = n->next)
587 if (n->type != XML_ELEMENT_NODE)
589 if (!strcmp((const char *) n->name, "settings"))
591 xmlChar *src = xmlGetProp(n, (xmlChar *) "src");
594 WRBUF w = wrbuf_alloc();
595 conf_dir_path(server->config, w, (const char *) src);
596 settings_read_file(service, wrbuf_cstr(w), pass);
602 settings_read_node(service, n, pass);
611 static char *parse_settings(struct conf_config *config,
612 NMEM nmem, xmlNode *node)
614 xmlChar *src = xmlGetProp(node, (xmlChar *) "src");
619 WRBUF w = wrbuf_alloc();
620 conf_dir_path(config, w, (const char *) src);
621 r = nmem_strdup(nmem, wrbuf_cstr(w));
626 yaz_log(YLOG_FATAL, "Must specify src in targetprofile");
633 static void inherit_server_settings(struct conf_service *s)
635 struct conf_server *server = s->server;
636 if (!s->dictionary) /* service has no config settings ? */
638 if (server->server_settings)
640 /* inherit settings from server */
642 settings_read_file(s, server->server_settings, 1);
643 settings_read_file(s, server->server_settings, 2);
647 yaz_log(YLOG_WARN, "service '%s' has no settings",
648 s->id ? s->id : "unnamed");
653 /* use relevance/sort/mergekey from server if not defined
654 for this service.. */
655 if (!s->relevance_pct)
657 if (server->relevance_pct)
659 s->relevance_pct = server->relevance_pct;
660 pp2_charset_incref(s->relevance_pct);
663 s->relevance_pct = pp2_charset_create(0);
668 if (server->sort_pct)
670 s->sort_pct = server->sort_pct;
671 pp2_charset_incref(s->sort_pct);
674 s->sort_pct = pp2_charset_create(0);
677 if (!s->mergekey_pct)
679 if (server->mergekey_pct)
681 s->mergekey_pct = server->mergekey_pct;
682 pp2_charset_incref(s->mergekey_pct);
685 s->mergekey_pct = pp2_charset_create(0);
689 struct conf_service *service_create(struct conf_server *server,
692 struct conf_service *service = service_create_static(server,
696 inherit_server_settings(service);
697 resolve_databases(service);
698 assert(service->mutex == 0);
699 yaz_mutex_create(&service->mutex);
704 static struct conf_server *server_create(struct conf_config *config,
705 NMEM nmem, xmlNode *node)
708 struct conf_server *server = nmem_malloc(nmem, sizeof(struct conf_server));
709 xmlChar *server_id = xmlGetProp(node, (xmlChar *) "id");
713 server->proxy_host = 0;
714 server->proxy_port = 0;
717 server->config = config;
719 server->relevance_pct = 0;
720 server->sort_pct = 0;
721 server->mergekey_pct = 0;
722 server->server_settings = 0;
723 server->http_server = 0;
724 server->iochan_man = 0;
728 server->server_id = nmem_strdup(nmem, (const char *)server_id);
732 server->server_id = 0;
733 for (n = node->children; n; n = n->next)
735 if (n->type != XML_ELEMENT_NODE)
737 if (!strcmp((const char *) n->name, "listen"))
739 xmlChar *port = xmlGetProp(n, (xmlChar *) "port");
740 xmlChar *host = xmlGetProp(n, (xmlChar *) "host");
742 server->port = atoi((const char *) port);
744 server->host = nmem_strdup(nmem, (const char *) host);
748 else if (!strcmp((const char *) n->name, "proxy"))
750 xmlChar *port = xmlGetProp(n, (xmlChar *) "port");
751 xmlChar *host = xmlGetProp(n, (xmlChar *) "host");
752 xmlChar *myurl = xmlGetProp(n, (xmlChar *) "myurl");
754 server->proxy_port = atoi((const char *) port);
756 server->proxy_host = nmem_strdup(nmem, (const char *) host);
758 server->myurl = nmem_strdup(nmem, (const char *) myurl);
763 else if (!strcmp((const char *) n->name, "settings"))
765 if (server->server_settings)
767 yaz_log(YLOG_FATAL, "Can't repeat 'settings'");
770 if (!(server->server_settings = parse_settings(config, nmem, n)))
773 else if (!strcmp((const char *) n->name, "relevance"))
775 server->relevance_pct = pp2_charset_create_xml(n);
776 if (!server->relevance_pct)
779 else if (!strcmp((const char *) n->name, "sort"))
781 server->sort_pct = pp2_charset_create_xml(n);
782 if (!server->sort_pct)
785 else if (!strcmp((const char *) n->name, "mergekey"))
787 server->mergekey_pct = pp2_charset_create_xml(n);
788 if (!server->mergekey_pct)
791 else if (!strcmp((const char *) n->name, "service"))
793 char *service_id = (char *)
794 xmlGetProp(n, (xmlChar *) "id");
796 struct conf_service **sp = &server->service;
797 for (; *sp; sp = &(*sp)->next)
798 if ((*sp)->id && service_id &&
799 0 == strcmp((*sp)->id, service_id))
801 yaz_log(YLOG_FATAL, "Duplicate service: %s", service_id);
804 else if (!(*sp)->id && !service_id)
806 yaz_log(YLOG_FATAL, "Duplicate unnamed service");
810 if (*sp) /* service already exist */
817 struct conf_service *s = service_create_static(server, n,
827 yaz_log(YLOG_FATAL, "Bad element: %s", n->name);
833 struct conf_service *s;
834 for (s = server->service; s; s = s->next)
835 inherit_server_settings(s);
840 WRBUF conf_get_fname(struct conf_service *service, const char *fname)
842 struct conf_config *config = service->server->config;
843 WRBUF w = wrbuf_alloc();
845 conf_dir_path(config, w, fname);
849 static struct conf_targetprofiles *parse_targetprofiles(NMEM nmem,
852 struct conf_targetprofiles *r = nmem_malloc(nmem, sizeof(*r));
853 xmlChar *type = xmlGetProp(node, (xmlChar *) "type");
854 xmlChar *src = xmlGetProp(node, (xmlChar *) "src");
856 memset(r, 0, sizeof(*r));
860 if (!strcmp((const char *) type, "local"))
861 r->type = Targetprofiles_local;
864 yaz_log(YLOG_FATAL, "Unknown targetprofile type");
870 yaz_log(YLOG_FATAL, "Must specify type for targetprofile");
875 r->src = nmem_strdup(nmem, (const char *) src);
878 yaz_log(YLOG_FATAL, "Must specify src in targetprofile");
886 struct conf_service *locate_service(struct conf_server *server,
887 const char *service_id)
889 struct conf_service *s = server->service;
890 for (; s; s = s->next)
891 if (s->id && service_id && 0 == strcmp(s->id, service_id))
893 else if (!s->id && !service_id)
901 static int parse_config(struct conf_config *config, xmlNode *root)
905 for (n = root->children; n; n = n->next)
907 if (n->type != XML_ELEMENT_NODE)
909 if (!strcmp((const char *) n->name, "server"))
911 struct conf_server *tmp = server_create(config, config->nmem, n);
914 tmp->next = config->servers;
915 config->servers = tmp;
917 else if (!strcmp((const char *) n->name, "threads"))
919 xmlChar *number = xmlGetProp(n, (xmlChar *) "number");
922 config->no_threads = atoi((const char *) number);
926 else if (!strcmp((const char *) n->name, "targetprofiles"))
928 yaz_log(YLOG_FATAL, "targetprofiles unsupported here. Must be part of service");
934 yaz_log(YLOG_FATAL, "Bad element: %s", n->name);
941 struct conf_config *config_create(const char *fname, int verbose)
943 xmlDoc *doc = xmlParseFile(fname);
947 NMEM nmem = nmem_create();
948 struct conf_config *config = nmem_malloc(nmem, sizeof(struct conf_config));
950 xmlSubstituteEntitiesDefault(1);
951 xmlLoadExtDtdDefaultValue = 1;
954 yaz_log(YLOG_FATAL, "Failed to read %s", fname);
961 config->no_threads = 0;
962 config->iochan_man = 0;
964 config->confdir = wrbuf_alloc();
965 if ((p = strrchr(fname,
974 wrbuf_write(config->confdir, fname, len);
976 wrbuf_puts(config->confdir, "");
978 n = xmlDocGetRootElement(doc);
979 r = yaz_xml_include_simple(n, wrbuf_cstr(config->confdir));
984 yaz_log(YLOG_LOG, "Configuration %s after include processing",
986 #if LIBXML_VERSION >= 20600
987 xmlDocFormatDump(yaz_log_file(), doc, 0);
989 xmlDocDump(yaz_log_file(), doc);
992 r = parse_config(config, n);
998 config_destroy(config);
1004 void server_destroy(struct conf_server *server)
1006 struct conf_service *s = server->service;
1009 struct conf_service *s_next = s->next;
1013 pp2_charset_destroy(server->relevance_pct);
1014 pp2_charset_destroy(server->sort_pct);
1015 pp2_charset_destroy(server->mergekey_pct);
1016 yaz_log(YLOG_LOG, "server_destroy server=%p", server);
1017 http_server_destroy(server->http_server);
1020 void config_destroy(struct conf_config *config)
1024 struct conf_server *server = config->servers;
1027 struct conf_server *s_next = server->next;
1028 server_destroy(server);
1031 wrbuf_destroy(config->confdir);
1032 nmem_destroy(config->nmem);
1036 void config_stop_listeners(struct conf_config *conf)
1038 struct conf_server *ser;
1039 for (ser = conf->servers; ser; ser = ser->next)
1040 http_close_server(ser);
1043 void config_process_events(struct conf_config *conf)
1045 struct conf_server *ser;
1046 for (ser = conf->servers; ser; ser = ser->next)
1048 struct conf_service *s = ser->service;
1049 for (;s ; s = s->next)
1051 resolve_databases(s);
1052 assert(s->mutex == 0);
1053 yaz_mutex_create(&s->mutex);
1055 http_mutex_init(ser);
1057 iochan_man_events(conf->iochan_man);
1060 int config_start_listeners(struct conf_config *conf,
1061 const char *listener_override)
1063 struct conf_server *ser;
1065 conf->iochan_man = iochan_man_create(conf->no_threads);
1066 for (ser = conf->servers; ser; ser = ser->next)
1068 WRBUF w = wrbuf_alloc();
1071 ser->iochan_man = conf->iochan_man;
1072 if (listener_override)
1074 wrbuf_puts(w, listener_override);
1075 listener_override = 0; /* only first server is overriden */
1080 wrbuf_puts(w, ser->host);
1085 wrbuf_printf(w, "%d", ser->port);
1088 r = http_init(wrbuf_cstr(w), ser);
1094 if (ser->proxy_host || ser->proxy_port)
1096 if (ser->proxy_host)
1097 wrbuf_puts(w, ser->proxy_host);
1098 if (ser->proxy_port)
1102 wrbuf_printf(w, "%d", ser->proxy_port);
1106 http_set_proxyaddr(wrbuf_cstr(w), ser);
1115 * c-file-style: "Stroustrup"
1116 * indent-tabs-mode: nil
1118 * vim: shiftwidth=4 tabstop=8 expandtab