1 /* This file is part of Pazpar2.
2 Copyright (C) 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>
29 #include <libxml/xinclude.h>
31 #include <yaz/yaz-util.h>
33 #include <yaz/snprintf.h>
34 #include <yaz/tpath.h>
35 #include <yaz/xml_include.h>
37 #include <sys/types.h>
44 #include "pazpar2_config.h"
45 #include "service_xslt.h"
52 NMEM nmem; /* for conf_config and servers memory */
53 struct conf_server *servers;
59 iochan_man_t iochan_man;
65 xsltStylesheetPtr xsp;
66 struct service_xslt *next;
69 static char *xml_context(const xmlNode *ptr, char *res, size_t len)
71 xmlAttr *attr = ptr->properties;
75 for (; attr; attr = attr->next)
77 size_t l = strlen((const char *) attr->name);
81 memcpy(res + off, attr->name, l);
84 while (ptr && ptr->type == XML_ELEMENT_NODE)
86 size_t l = strlen((const char *) ptr->name);
91 memcpy(res + off, ptr->name, l);
99 struct conf_service *service_init(struct conf_server *server,
100 int num_metadata, int num_sortkeys,
101 const char *service_id)
103 struct conf_service * service = 0;
104 NMEM nmem = nmem_create();
107 service = nmem_malloc(nmem, sizeof(struct conf_service));
109 service->ref_count = 1;
110 service->nmem = nmem;
112 service->databases = 0;
113 service->xslt_list = 0;
114 service->ccl_bibset = 0;
115 service->server = server;
116 service->session_timeout = 60; /* default session timeout */
117 service->z3950_session_timeout = 180;
118 service->z3950_operation_timeout = 30;
119 service->rank_cluster = 1;
120 service->rank_debug = 0;
121 service->rank_follow = 0.0;
122 service->rank_lead = 0.0;
123 service->rank_length = 2;
125 service->charsets = 0;
127 service->id = service_id ? nmem_strdup(nmem, service_id) : 0;
129 // Setup a dictionary from server.
130 service->dictionary = 0;
132 service->settings = nmem_malloc(nmem, sizeof(*service->settings));
133 service->settings->num_settings = PZ_MAX_EOF;
134 service->settings->settings = nmem_malloc(nmem, sizeof(struct setting*) * service->settings->num_settings);
135 memset(service->settings->settings, 0, sizeof(struct setting*) * service->settings->num_settings);
136 // inherit_server_settings_values(service);
140 service->num_metadata = num_metadata;
142 service->metadata = 0;
143 if (service->num_metadata)
146 sizeof(struct conf_metadata) * service->num_metadata);
147 service->num_sortkeys = num_sortkeys;
149 service->default_sort = nmem_strdup(nmem, "relevance");
150 service->sortkeys = 0;
151 if (service->num_sortkeys)
154 sizeof(struct conf_sortkey) * service->num_sortkeys);
155 service->xml_node = 0;
159 static struct conf_metadata* conf_service_add_metadata(
160 struct conf_service *service,
163 enum conf_metadata_type type,
164 enum conf_metadata_merge merge,
165 enum conf_setting_type setting,
170 enum conf_metadata_mergekey mt,
171 const char *facetrule,
172 const char *limitmap,
173 const char *limitcluster,
177 struct conf_metadata * md = 0;
178 NMEM nmem = service->nmem;
180 if (!service->metadata || !service->num_metadata
181 || field_id < 0 || !(field_id < service->num_metadata))
184 md = service->metadata + field_id;
185 assert(nmem && md && name);
187 md->name = nmem_strdup(nmem, name);
191 // enforcing that type_year is always range_merge
192 if (md->type == Metadata_type_year)
193 md->merge = Metadata_merge_range;
197 md->setting = setting;
199 md->termlist = termlist;
200 md->rank = nmem_strdup_null(nmem, rank);
201 md->sortkey_offset = sortkey_offset;
203 md->facetrule = nmem_strdup_null(nmem, facetrule);
204 md->limitmap = nmem_strdup_null(nmem, limitmap);
205 md->limitcluster = nmem_strdup_null(nmem, limitcluster);
206 md->icurule = nmem_strdup_null(nmem, icurule);
210 static struct conf_sortkey *conf_service_add_sortkey(
211 struct conf_service *service,
214 enum conf_metadata_type type)
216 struct conf_sortkey *sk = 0;
217 NMEM nmem = service->nmem;
219 if (!service->sortkeys || !service->num_sortkeys
220 || field_id < 0 || !(field_id < service->num_sortkeys))
223 sk = service->sortkeys + field_id;
225 assert(nmem && sk && name);
227 sk->name = nmem_strdup(nmem, name);
232 int conf_service_metadata_field_id(struct conf_service *service,
237 if (!service || !service->metadata || !service->num_metadata)
240 for (i = 0; i < service->num_metadata; i++)
241 if (!strcmp(name, (service->metadata[i]).name))
246 int conf_service_sortkey_field_id(struct conf_service *service,
251 if (!service || !service->sortkeys || !service->num_sortkeys)
254 for (i = 0; i < service->num_sortkeys; i++)
255 if (!strcmp(name, (service->sortkeys[i]).name))
260 static void conf_dir_path(struct conf_config *config, WRBUF w, const char *src)
262 char full_path[1024];
263 if (yaz_filepath_resolve(src, config->path,
264 wrbuf_len(config->confdir) > 0 ?
265 wrbuf_cstr(config->confdir) : ".",
268 wrbuf_puts(w, full_path);
272 yaz_log(YLOG_WARN, "File not found: fname=%s path=%s base=%s", src,
273 config->path, wrbuf_cstr(config->confdir));
278 void service_destroy(struct conf_service *service)
282 if (!pazpar2_decref(&service->ref_count, service->mutex))
284 service_xslt_destroy(service);
285 pp2_charset_fact_destroy(service->charsets);
286 ccl_qual_rm(&service->ccl_bibset);
287 yaz_mutex_destroy(&service->mutex);
288 nmem_destroy(service->nmem);
293 void service_incref(struct conf_service *service)
295 pazpar2_incref(&service->ref_count, service->mutex);
298 static int parse_metadata(struct conf_service *service, xmlNode *n,
299 int *md_node, int *sk_node)
301 enum conf_metadata_type type = Metadata_type_generic;
302 enum conf_metadata_merge merge = Metadata_merge_no;
303 enum conf_setting_type setting = Metadata_setting_no;
304 enum conf_metadata_mergekey mergekey_type = Metadata_mergekey_no;
307 int sortkey_offset = 0;
308 xmlChar *xml_name = 0;
309 xmlChar *xml_brief = 0;
310 xmlChar *xml_sortkey = 0;
311 xmlChar *xml_merge = 0;
312 xmlChar *xml_type = 0;
313 xmlChar *xml_termlist = 0;
314 xmlChar *xml_rank = 0;
315 xmlChar *xml_setting = 0;
316 xmlChar *xml_mergekey = 0;
317 xmlChar *xml_limitmap = 0;
318 xmlChar *xml_limitcluster = 0;
319 xmlChar *xml_icu_chain = 0;
320 xmlChar *xml_icurule = 0;
322 struct _xmlAttr *attr;
326 for (attr = n->properties; attr; attr = attr->next)
328 if (!xmlStrcmp(attr->name, BAD_CAST "name") &&
329 attr->children && attr->children->type == XML_TEXT_NODE)
330 xml_name = attr->children->content;
331 else if (!xmlStrcmp(attr->name, BAD_CAST "brief") &&
332 attr->children && attr->children->type == XML_TEXT_NODE)
333 xml_brief = attr->children->content;
334 else if (!xmlStrcmp(attr->name, BAD_CAST "sortkey") &&
335 attr->children && attr->children->type == XML_TEXT_NODE)
336 xml_sortkey = attr->children->content;
337 else if (!xmlStrcmp(attr->name, BAD_CAST "merge") &&
338 attr->children && attr->children->type == XML_TEXT_NODE)
339 xml_merge = attr->children->content;
340 else if (!xmlStrcmp(attr->name, BAD_CAST "type") &&
341 attr->children && attr->children->type == XML_TEXT_NODE)
342 xml_type = attr->children->content;
343 else if (!xmlStrcmp(attr->name, BAD_CAST "termlist") &&
344 attr->children && attr->children->type == XML_TEXT_NODE)
345 xml_termlist = attr->children->content;
346 else if (!xmlStrcmp(attr->name, BAD_CAST "rank") &&
347 attr->children && attr->children->type == XML_TEXT_NODE)
348 xml_rank = attr->children->content;
349 else if (!xmlStrcmp(attr->name, BAD_CAST "setting") &&
350 attr->children && attr->children->type == XML_TEXT_NODE)
351 xml_setting = attr->children->content;
352 else if (!xmlStrcmp(attr->name, BAD_CAST "mergekey") &&
353 attr->children && attr->children->type == XML_TEXT_NODE)
354 xml_mergekey = attr->children->content;
355 else if (!xmlStrcmp(attr->name, BAD_CAST "facetrule") &&
356 attr->children && attr->children->type == XML_TEXT_NODE)
357 xml_icu_chain = attr->children->content;
358 else if (!xmlStrcmp(attr->name, BAD_CAST "limitmap") &&
359 attr->children && attr->children->type == XML_TEXT_NODE)
360 xml_limitmap = attr->children->content;
361 else if (!xmlStrcmp(attr->name, BAD_CAST "limitcluster") &&
362 attr->children && attr->children->type == XML_TEXT_NODE)
363 xml_limitcluster = attr->children->content;
364 else if (!xmlStrcmp(attr->name, BAD_CAST "icurule") &&
365 attr->children && attr->children->type == XML_TEXT_NODE)
366 xml_icurule = attr->children->content;
369 yaz_log(YLOG_FATAL, "Unknown metadata attribute '%s'", attr->name);
374 // now do the parsing logic
377 yaz_log(YLOG_FATAL, "Must specify name in metadata element");
382 if (!strcmp((const char *) xml_brief, "yes"))
384 else if (strcmp((const char *) xml_brief, "no"))
386 yaz_log(YLOG_FATAL, "metadata/brief must be yes or no");
393 if (!strcmp((const char *) xml_termlist, "yes"))
395 else if (strcmp((const char *) xml_termlist, "no"))
397 yaz_log(YLOG_FATAL, "metadata/termlist must be yes or no");
404 if (!strcmp((const char *) xml_type, "generic"))
405 type = Metadata_type_generic;
406 else if (!strcmp((const char *) xml_type, "year"))
407 type = Metadata_type_year;
408 else if (!strcmp((const char *) xml_type, "date"))
409 type = Metadata_type_date;
410 else if (!strcmp((const char *) xml_type, "float"))
411 type = Metadata_type_float;
415 "Unknown value for metadata/type: %s", xml_type);
422 if (!strcmp((const char *) xml_merge, "no"))
423 merge = Metadata_merge_no;
424 else if (!strcmp((const char *) xml_merge, "unique"))
425 merge = Metadata_merge_unique;
426 else if (!strcmp((const char *) xml_merge, "longest"))
427 merge = Metadata_merge_longest;
428 else if (!strcmp((const char *) xml_merge, "range"))
429 merge = Metadata_merge_range;
430 else if (!strcmp((const char *) xml_merge, "all"))
431 merge = Metadata_merge_all;
432 else if (!strcmp((const char *) xml_merge, "first"))
433 merge = Metadata_merge_first;
437 "Unknown value for metadata/merge: %s", xml_merge);
444 if (!strcmp((const char *) xml_setting, "no"))
445 setting = Metadata_setting_no;
446 else if (!strcmp((const char *) xml_setting, "postproc"))
447 setting = Metadata_setting_postproc;
448 else if (!strcmp((const char *) xml_setting, "parameter"))
449 setting = Metadata_setting_parameter;
453 "Unknown value for metadata/setting: %s", xml_setting);
458 // add a sortkey if so specified
459 if (xml_sortkey && strcmp((const char *) xml_sortkey, "no"))
461 enum conf_metadata_type sk_type = type;
462 if (merge == Metadata_merge_no)
465 "Can't specify sortkey on a non-merged field");
468 if (!strcmp((const char *) xml_sortkey, "yes"))
470 if (!strcmp((const char *) xml_sortkey, "numeric"))
472 else if (!strcmp((const char *) xml_sortkey, "skiparticle"))
474 if (sk_type == Metadata_type_generic)
475 sk_type = Metadata_type_skiparticle;
479 "skiparticle only supported for type=generic: %s",
487 "Unknown sortkey in metadata element: %s",
491 sortkey_offset = *sk_node;
493 conf_service_add_sortkey(service, *sk_node,
494 (const char *) xml_name, sk_type);
502 if (!strcmp((const char *) xml_mergekey, "required"))
503 mergekey_type = Metadata_mergekey_required;
504 else if (!strcmp((const char *) xml_mergekey, "optional"))
505 mergekey_type = Metadata_mergekey_optional;
506 else if (!strcmp((const char *) xml_mergekey, "no"))
507 mergekey_type = Metadata_mergekey_no;
510 yaz_log(YLOG_FATAL, "Unknown value for mergekey: %s", xml_mergekey);
515 // metadata known, assign values
516 conf_service_add_metadata(service, *md_node,
517 (const char *) xml_name,
518 type, merge, setting,
520 (const char *) xml_rank, sortkey_offset,
522 (const char *) xml_icu_chain,
523 (const char *) xml_limitmap,
524 (const char *) xml_limitcluster,
525 (const char *) xml_icurule
532 static void count_metadata(xmlNode *n, int *num_metadata, int *num_sortkeys)
534 xmlChar *sortkey = xmlGetProp(n, (xmlChar *) "sortkey");
537 if (sortkey && strcmp((const char *) sortkey, "no"))
543 static struct conf_service *service_create_static(struct conf_server *server,
545 const char *service_id)
551 struct conf_service *service = 0;
552 int num_metadata = 0;
553 int num_sortkeys = 0;
554 int got_settings = 0;
556 // count num_metadata and num_sortkeys
557 for (n = node->children; n; n = n->next)
558 if (n->type == XML_ELEMENT_NODE && !strcmp((const char *)
559 n->name, "metadata"))
561 if (n->children) // This is a <metadata> container, look at its contents.
564 for (m = n->children; m; m = m->next)
566 if (m->type == XML_ELEMENT_NODE &&
567 !strcmp((const char *) m->name, "metadata"))
568 count_metadata(m, &num_metadata, &num_sortkeys);
571 else // This is a metadata-element proper, count it right away.
572 count_metadata(n, &num_metadata, &num_sortkeys);
575 service = service_init(server, num_metadata, num_sortkeys, service_id);
577 for (n = node->children; n; n = n->next)
579 if (n->type != XML_ELEMENT_NODE)
581 if (!strcmp((const char *) n->name, "timeout"))
583 xmlChar *src = xmlGetProp(n, (xmlChar *) "session");
586 service->session_timeout = atoi((const char *) src);
588 if (service->session_timeout < 9)
590 yaz_log(YLOG_FATAL, "session timeout out of range");
594 src = xmlGetProp(n, (xmlChar *) "z3950_operation");
597 service->z3950_operation_timeout = atoi((const char *) src);
599 if (service->z3950_session_timeout < 9)
601 yaz_log(YLOG_FATAL, "Z39.50 operation timeout out of range");
605 src = xmlGetProp(n, (xmlChar *) "z3950_session");
608 service->z3950_session_timeout = atoi((const char *) src);
610 if (service->z3950_session_timeout < 9)
612 yaz_log(YLOG_FATAL, "Z39.50 session timeout out of range");
617 else if (!strcmp((const char *) n->name, "ccldirective"))
621 if (!service->ccl_bibset)
622 service->ccl_bibset = ccl_qual_mk();
623 name = (char *) xmlGetProp(n, (xmlChar *) "name");
626 yaz_log(YLOG_FATAL, "ccldirective: missing @name");
629 value = (char *) xmlGetProp(n, (xmlChar *) "value");
633 yaz_log(YLOG_FATAL, "ccldirective: missing @value");
636 ccl_qual_add_special(service->ccl_bibset, name, value);
640 else if (!strcmp((const char *) n->name, "settings"))
642 else if (!strcmp((const char *) n->name, "icu_chain"))
644 if (!service->charsets)
645 service->charsets = pp2_charset_fact_create();
646 if (pp2_charset_fact_define(service->charsets, n, 0))
648 yaz_log(YLOG_FATAL, "ICU chain definition error");
652 else if (!strcmp((const char *) n->name, "relevance")
653 || !strcmp((const char *) n->name, "sort")
654 || !strcmp((const char *) n->name, "mergekey")
655 || !strcmp((const char *) n->name, "facet"))
658 if (!service->charsets)
659 service->charsets = pp2_charset_fact_create();
660 if (pp2_charset_fact_define(service->charsets, n,
661 (const char *) n->name))
663 yaz_log(YLOG_FATAL, "ICU chain definition error");
667 else if (!strcmp((const char *) n->name, (const char *) "metadata"))
669 if (n->children) // This is a <metadata> container, look at its content.
672 for (m = n->children; m; m = m->next)
673 if ((!strcmp((const char *) m->name, (const char *) "metadata")))
674 if (parse_metadata(service, m, &md_node, &sk_node))
677 else // This is a metadata-element proper, count it right away.
678 if (parse_metadata(service, n, &md_node, &sk_node))
681 else if (!strcmp((const char *) n->name, (const char *) "xslt"))
683 if (service_xslt_config(service, n))
686 else if (!strcmp((const char *) n->name, "rank"))
688 char *rank_cluster = (char *) xmlGetProp(n, (xmlChar *) "cluster");
689 char *rank_debug = (char *) xmlGetProp(n, (xmlChar *) "debug");
690 char *rank_follow = (char *) xmlGetProp(n, (xmlChar *) "follow");
691 char *rank_lead = (char *) xmlGetProp(n, (xmlChar *) "lead");
692 char *rank_length= (char *) xmlGetProp(n, (xmlChar *) "length");
695 if (!strcmp(rank_cluster, "yes"))
696 service->rank_cluster = 1;
697 else if (!strcmp(rank_cluster, "no"))
698 service->rank_cluster = 0;
701 yaz_log(YLOG_FATAL, "service: rank@cluster boolean");
707 if (!strcmp(rank_debug, "yes"))
708 service->rank_debug = 1;
709 else if (!strcmp(rank_debug, "no"))
710 service->rank_debug = 0;
713 yaz_log(YLOG_FATAL, "service: rank@debug boolean");
719 service->rank_follow = atof(rank_follow);
723 service->rank_lead = atof(rank_lead);
727 if (!strcmp(rank_length, "linear"))
728 service->rank_length = 2;
729 else if (!strcmp(rank_length, "log"))
730 service->rank_length = 1;
731 else if (!strcmp(rank_length, "none"))
732 service->rank_length = 0;
735 yaz_log(YLOG_FATAL, "service: rank@length linear|log|none");
739 xmlFree(rank_cluster);
741 xmlFree(rank_follow);
743 xmlFree(rank_length);
745 else if (!strcmp((const char *) n->name, "sort-default"))
747 char *default_sort = (char *) xmlGetProp(n, (xmlChar *) "field");
749 if (default_sort && strcmp(default_sort, "")) {
750 service->default_sort = nmem_strdup(service->nmem, default_sort);
751 yaz_log(YLOG_LOG, "service %s: default sort order configured to: %s",
752 service_id ? service_id : "unnamed", default_sort);
756 yaz_log(YLOG_FATAL, "default sort order is invalid: %s", default_sort);
759 xmlFree(default_sort);
764 yaz_log(YLOG_FATAL, "Bad element: %s . Context: %s", n->name,
765 xml_context(n, tmp, sizeof tmp));
772 /* metadata has been read.. Consider now settings */
773 init_settings(service);
774 for (pass = 1; pass <= 2; pass++)
776 for (n = node->children; n; n = n->next)
778 if (n->type != XML_ELEMENT_NODE)
780 if (!strcmp((const char *) n->name, "settings"))
783 xmlChar *src = xmlGetProp(n, (xmlChar *) "src");
786 WRBUF w = wrbuf_alloc();
787 conf_dir_path(server->config, w, (const char *) src);
788 ret = settings_read_file(service, wrbuf_cstr(w), pass);
794 ret = settings_read_node(service, n, pass);
804 xmlBufferPtr buf = xmlBufferCreate();
805 xmlNodeDump(buf, node->doc, node, 0, 0);
807 nmem_strdupn(service->nmem, (const char *) buf->content, buf->use);
813 static int inherit_server_settings(struct conf_service *s)
816 struct conf_server *server = s->server;
817 if (!s->dictionary) /* service has no config settings ? */
819 if (server->settings_fname)
821 /* inherit settings from server */
823 if (settings_read_file(s, server->settings_fname, 1))
825 if (settings_read_file(s, server->settings_fname, 2))
830 yaz_log(YLOG_WARN, "server '%s' has no settings", s->id ? s->id : "unnamed");
835 /* use relevance/sort/mergekey/facet from server if not defined
836 for this service.. */
839 if (server->charsets)
841 s->charsets = server->charsets;
842 pp2_charset_fact_incref(s->charsets);
846 s->charsets = pp2_charset_fact_create();
852 struct conf_service *service_create(struct conf_server *server,
855 struct conf_service *service = service_create_static(server, node, 0);
858 inherit_server_settings(service);
859 assert(service->mutex == 0);
860 pazpar2_mutex_create(&service->mutex, "conf");
865 static struct conf_server *server_create(struct conf_config *config,
866 NMEM nmem, xmlNode *node)
869 struct conf_server *server = nmem_malloc(nmem, sizeof(struct conf_server));
870 xmlChar *server_id = xmlGetProp(node, (xmlChar *) "id");
874 server->proxy_host = 0;
875 server->proxy_port = 0;
878 server->config = config;
880 server->charsets = 0;
881 server->http_server = 0;
882 server->iochan_man = 0;
883 server->settings_fname = 0;
887 server->server_id = nmem_strdup(nmem, (const char *)server_id);
891 server->server_id = 0;
892 for (n = node->children; n; n = n->next)
894 if (n->type != XML_ELEMENT_NODE)
896 if (!strcmp((const char *) n->name, "listen"))
898 xmlChar *port = xmlGetProp(n, (xmlChar *) "port");
899 xmlChar *host = xmlGetProp(n, (xmlChar *) "host");
902 server->port = nmem_strdup(nmem, (const char *) port);
904 server->host = nmem_strdup(nmem, (const char *) host);
909 else if (!strcmp((const char *) n->name, "proxy"))
911 xmlChar *port = xmlGetProp(n, (xmlChar *) "port");
912 xmlChar *host = xmlGetProp(n, (xmlChar *) "host");
913 xmlChar *myurl = xmlGetProp(n, (xmlChar *) "myurl");
915 server->proxy_port = atoi((const char *) port);
917 server->proxy_host = nmem_strdup(nmem, (const char *) host);
919 server->myurl = nmem_strdup(nmem, (const char *) myurl);
924 else if (!strcmp((const char *) n->name, "settings"))
926 xmlChar *src = xmlGetProp(n, (xmlChar *) "src");
930 yaz_log(YLOG_FATAL, "Missing src attribute for settings");
933 if (server->settings_fname)
936 yaz_log(YLOG_FATAL, "Can't repeat 'settings'");
940 conf_dir_path(config, w, (const char *) src);
941 server->settings_fname = nmem_strdup(nmem, wrbuf_cstr(w));
945 else if (!strcmp((const char *) n->name, "icu_chain"))
947 if (!server->charsets)
948 server->charsets = pp2_charset_fact_create();
949 if (pp2_charset_fact_define(server->charsets, n, 0))
951 yaz_log(YLOG_FATAL, "ICU chain definition error");
955 else if (!strcmp((const char *) n->name, "relevance")
956 || !strcmp((const char *) n->name, "sort")
957 || !strcmp((const char *) n->name, "mergekey")
958 || !strcmp((const char *) n->name, "facet"))
960 if (!server->charsets)
961 server->charsets = pp2_charset_fact_create();
962 if (pp2_charset_fact_define(server->charsets, n,
963 (const char *) n->name))
965 yaz_log(YLOG_FATAL, "ICU chain definition error");
969 else if (!strcmp((const char *) n->name, "service"))
971 char *service_id = (char *)
972 xmlGetProp(n, (xmlChar *) "id");
974 struct conf_service **sp = &server->service;
975 for (; *sp; sp = &(*sp)->next)
976 if ((*sp)->id && service_id &&
977 0 == strcmp((*sp)->id, service_id))
979 yaz_log(YLOG_FATAL, "Duplicate service: %s", service_id);
982 else if (!(*sp)->id && !service_id)
984 yaz_log(YLOG_FATAL, "Duplicate unnamed service");
988 if (*sp) /* service already exist */
995 struct conf_service *s = service_create_static(server, n,
1005 yaz_log(YLOG_FATAL, "Bad element: %s", n->name);
1011 yaz_log(YLOG_FATAL, "No listening port given");
1014 if (server->service)
1016 struct conf_service *s;
1017 for (s = server->service; s; s = s->next)
1018 inherit_server_settings(s);
1023 WRBUF conf_get_fname(struct conf_config *config, const char *fname)
1025 WRBUF w = wrbuf_alloc();
1027 conf_dir_path(config, w, fname);
1031 struct conf_service *locate_service(struct conf_server *server,
1032 const char *service_id)
1034 struct conf_service *s = server->service;
1035 for (; s; s = s->next)
1036 if (s->id && service_id && 0 == strcmp(s->id, service_id))
1038 else if (!s->id && !service_id)
1045 static void info_service_metadata(struct conf_service *service, WRBUF w)
1048 struct conf_metadata *md;
1050 if (service->num_metadata)
1052 for (i = 0; i < service->num_metadata; i++)
1054 md = &(service->metadata[i]);
1055 wrbuf_puts(w, " <metadata");
1057 wrbuf_puts(w, " name=\"");
1058 wrbuf_xmlputs(w, md->name);
1059 wrbuf_puts(w, "\"");
1062 wrbuf_puts(w, " brief=\"yes\"");
1065 wrbuf_puts(w, " termlist=\"yes\"");
1068 wrbuf_puts(w, " rank=\"");
1069 wrbuf_xmlputs(w, md->rank);
1070 wrbuf_puts(w, "\"");
1072 if (md->sortkey_offset > 0) {
1073 wrbuf_puts(w, " sortkey=\"");
1074 switch (service->sortkeys[md->sortkey_offset].type)
1076 case Metadata_type_relevance:
1077 wrbuf_puts(w, "relevance");
1079 case Metadata_type_skiparticle:
1080 wrbuf_puts(w, "skiparticle");
1082 case Metadata_type_position:
1083 wrbuf_puts(w, "position");
1085 case Metadata_type_retrieval:
1086 wrbuf_puts(w, "retrieval");
1089 wrbuf_puts(w, "yes");
1092 wrbuf_puts(w, "\"");
1096 case Metadata_type_generic:
1097 case Metadata_type_skiparticle:
1099 case Metadata_type_year:
1100 wrbuf_puts(w, " type=\"year\"");
1102 case Metadata_type_date:
1103 wrbuf_puts(w, " type=\"date\"");
1105 case Metadata_type_float:
1106 wrbuf_puts(w, " type=\"float\"");
1113 case Metadata_merge_no:
1115 case Metadata_merge_unique:
1116 wrbuf_puts(w, " merge=\"unique\"");
1118 case Metadata_merge_longest:
1119 wrbuf_puts(w, " merge=\"longest\"");
1121 case Metadata_merge_range:
1122 wrbuf_puts(w, " merge=\"range\"");
1124 case Metadata_merge_all:
1125 wrbuf_puts(w, " merge=\"all\"");
1127 case Metadata_merge_first:
1128 wrbuf_puts(w, " merge=\"first\"");
1131 switch (md->mergekey)
1133 case Metadata_mergekey_no:
1135 case Metadata_mergekey_optional:
1136 wrbuf_puts(w, " mergekey=\"optional\"");
1138 case Metadata_mergekey_required:
1139 wrbuf_puts(w, " mergekey=\"required\"");
1142 wrbuf_puts(w, " />\n");
1147 static void info_service_databases(struct conf_service *service, WRBUF w)
1150 if (service->databases)
1152 struct database *db;
1153 wrbuf_puts(w, " <databases>\n");
1154 for (db = service->databases; db; db = db->next)
1157 wrbuf_puts(w, " <database");
1160 wrbuf_puts(w, " id=\"");
1161 wrbuf_printf(w, "%s", db->id);
1162 wrbuf_puts(w, "\"");
1164 wrbuf_puts(w, ">\n");
1165 for (i = 0; i < db->num_settings; i++)
1167 struct setting *s = db->settings[i];
1168 for (; s; s = s->next)
1170 wrbuf_puts(w, " <setting name=\"");
1171 wrbuf_xmlputs(w, s->name);
1172 wrbuf_puts(w, "\"");
1173 wrbuf_puts(w, " value=\"");
1174 wrbuf_xmlputs(w, s->value);
1175 wrbuf_puts(w, "\"");
1176 wrbuf_puts(w, " />\n");
1179 wrbuf_puts(w, " </database>\n");
1181 wrbuf_puts(w, " </databases>\n");
1185 void info_services(struct conf_server *server, WRBUF w)
1187 struct conf_service *s = server->service;
1190 wrbuf_puts(w, " <services>\n");
1191 for (; s; s = s->next)
1193 wrbuf_puts(w, " <service");
1196 wrbuf_puts(w, " id=\"");
1197 wrbuf_xmlputs(w, s->id);
1198 wrbuf_puts(w, "\"");
1200 wrbuf_puts(w, ">\n");
1203 for (i = 0; i < s->settings->num_settings; i++)
1205 struct setting *S = s->settings->settings[i];
1206 for (; S; S = S->next)
1208 wrbuf_puts(w, " <setting name=\"");
1209 wrbuf_xmlputs(w, S->name);
1210 wrbuf_puts(w, "\"");
1211 wrbuf_puts(w, " value=\"");
1212 wrbuf_xmlputs(w, S->value);
1213 wrbuf_puts(w, "\"");
1216 wrbuf_puts(w, " target=\"");
1217 wrbuf_xmlputs(w, S->target);
1218 wrbuf_puts(w, "\"");
1220 wrbuf_puts(w, " />\n");
1224 info_service_metadata(s, w);
1225 info_service_databases(s, w);
1226 wrbuf_puts(w, " </service>\n");
1228 wrbuf_puts(w, " </services>\n");
1231 static int parse_config(struct conf_config *config, xmlNode *root)
1235 for (n = root->children; n; n = n->next)
1237 if (n->type != XML_ELEMENT_NODE)
1239 if (!strcmp((const char *) n->name, "server"))
1241 struct conf_server *tmp = server_create(config, config->nmem, n);
1244 tmp->next = config->servers;
1245 config->servers = tmp;
1247 else if (!strcmp((const char *) n->name, "threads"))
1249 xmlChar *number = xmlGetProp(n, (xmlChar *) "number");
1252 config->no_threads = atoi((const char *) number);
1256 else if (!strcmp((const char *) n->name, "sockets"))
1258 xmlChar *number = xmlGetProp(n, (xmlChar *) "max");
1261 config->max_sockets = atoi((const char *) number);
1265 else if (!strcmp((const char *) n->name, "file"))
1267 xmlChar *path = xmlGetProp(n, (xmlChar *) "path");
1270 config->path = nmem_strdup(config->nmem, (const char *) path);
1274 else if (!strcmp((const char *) n->name, "targetprofiles"))
1276 yaz_log(YLOG_FATAL, "targetprofiles unsupported here. Must be part of service");
1282 yaz_log(YLOG_FATAL, "Bad element: %s", n->name);
1289 struct conf_config *config_create(const char *fname)
1291 xmlDoc *doc = xmlReadFile(fname,
1294 + XML_PARSE_NSCLEAN + XML_PARSE_NONET);
1298 NMEM nmem = nmem_create();
1299 struct conf_config *config = nmem_malloc(nmem, sizeof(struct conf_config));
1301 xmlSubstituteEntitiesDefault(1);
1302 xmlLoadExtDtdDefaultValue = 1;
1305 yaz_log(YLOG_FATAL, "Failed to read %s", fname);
1310 // Perform XInclude.
1311 r = xmlXIncludeProcess(doc);
1314 yaz_log(YLOG_FATAL, "XInclude processing failed");
1318 config->nmem = nmem;
1319 config->servers = 0;
1320 config->path = nmem_strdup(nmem, ".");
1321 config->no_threads = 0;
1322 config->max_sockets = 0;
1323 config->iochan_man = 0;
1325 config->confdir = wrbuf_alloc();
1326 if ((p = strrchr(fname,
1334 int len = p - fname;
1335 wrbuf_write(config->confdir, fname, len);
1337 wrbuf_puts(config->confdir, "");
1339 n = xmlDocGetRootElement(doc);
1340 r = yaz_xml_include_simple(n, wrbuf_cstr(config->confdir));
1341 if (r == 0) /* OK */
1344 yaz_log(YLOG_LOG, "Configuration %s after include processing",
1346 #if LIBXML_VERSION >= 20600
1347 xmlDocFormatDump(yaz_log_file(), doc, 0);
1349 xmlDocDump(yaz_log_file(), doc);
1352 r = parse_config(config, n);
1358 config_destroy(config);
1364 void server_destroy(struct conf_server *server)
1366 struct conf_service *s = server->service;
1369 struct conf_service *s_next = s->next;
1373 pp2_charset_fact_destroy(server->charsets);
1374 http_server_destroy(server->http_server);
1377 void config_destroy(struct conf_config *config)
1381 struct conf_server *server = config->servers;
1382 iochan_man_destroy(&config->iochan_man);
1385 struct conf_server *s_next = server->next;
1386 server_destroy(server);
1389 wrbuf_destroy(config->confdir);
1390 nmem_destroy(config->nmem);
1394 void config_stop_listeners(struct conf_config *conf)
1396 struct conf_server *ser;
1397 for (ser = conf->servers; ser; ser = ser->next)
1398 http_close_server(ser);
1401 void config_process_events(struct conf_config *conf)
1403 struct conf_server *ser;
1405 for (ser = conf->servers; ser; ser = ser->next)
1407 struct conf_service *s = ser->service;
1409 for (;s ; s = s->next)
1411 assert(s->mutex == 0);
1412 pazpar2_mutex_create(&s->mutex, "service");
1414 http_mutex_init(ser);
1416 iochan_man_events(conf->iochan_man);
1419 int config_start_listeners(struct conf_config *conf,
1420 const char *listener_override,
1421 const char *record_fname)
1423 struct conf_server *ser;
1425 conf->iochan_man = iochan_man_create(conf->no_threads, conf->max_sockets);
1426 for (ser = conf->servers; ser; ser = ser->next)
1431 ser->iochan_man = conf->iochan_man;
1432 if (listener_override)
1434 const char *cp = strrchr(listener_override, ':');
1437 ser->host = nmem_strdupn(conf->nmem, listener_override,
1438 cp - listener_override);
1439 ser->port = nmem_strdup(conf->nmem, cp + 1);
1444 ser->port = nmem_strdup(conf->nmem, listener_override);
1446 listener_override = 0; /* only first server is overriden */
1448 r = http_init(ser, record_fname);
1453 if (ser->proxy_host || ser->proxy_port)
1455 if (ser->proxy_host)
1456 wrbuf_puts(w, ser->proxy_host);
1457 if (ser->proxy_port)
1461 wrbuf_printf(w, "%d", ser->proxy_port);
1465 http_set_proxyaddr(wrbuf_cstr(w), ser);
1474 * c-file-style: "Stroustrup"
1475 * indent-tabs-mode: nil
1477 * vim: shiftwidth=4 tabstop=8 expandtab