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;
58 iochan_man_t iochan_man;
64 xsltStylesheetPtr xsp;
65 struct service_xslt *next;
68 static char *xml_context(const xmlNode *ptr, char *res, size_t len)
70 xmlAttr *attr = ptr->properties;
74 for (; attr; attr = attr->next)
76 size_t l = strlen((const char *) attr->name);
80 memcpy(res + off, attr->name, l);
83 while (ptr && ptr->type == XML_ELEMENT_NODE)
85 size_t l = strlen((const char *) ptr->name);
90 memcpy(res + off, ptr->name, l);
98 struct conf_service *service_init(struct conf_server *server,
99 int num_metadata, int num_sortkeys,
100 const char *service_id)
102 struct conf_service * service = 0;
103 NMEM nmem = nmem_create();
106 service = nmem_malloc(nmem, sizeof(struct conf_service));
108 service->ref_count = 1;
109 service->nmem = nmem;
111 service->databases = 0;
112 service->xslt_list = 0;
113 service->ccl_bibset = 0;
114 service->server = server;
115 service->session_timeout = 60; /* default session timeout */
116 service->z3950_session_timeout = 180;
117 service->z3950_operation_timeout = 30;
118 service->rank_cluster = 1;
119 service->rank_debug = 0;
120 service->rank_follow = 0.0;
121 service->rank_lead = 0.0;
122 service->rank_length = 2;
124 service->charsets = 0;
126 service->id = service_id ? nmem_strdup(nmem, service_id) : 0;
128 // Setup a dictionary from server.
129 service->dictionary = 0;
131 service->settings = nmem_malloc(nmem, sizeof(*service->settings));
132 service->settings->num_settings = PZ_MAX_EOF;
133 service->settings->settings = nmem_malloc(nmem, sizeof(struct setting*) * service->settings->num_settings);
134 memset(service->settings->settings, 0, sizeof(struct setting*) * service->settings->num_settings);
135 // inherit_server_settings_values(service);
139 service->num_metadata = num_metadata;
141 service->metadata = 0;
142 if (service->num_metadata)
145 sizeof(struct conf_metadata) * service->num_metadata);
146 service->num_sortkeys = num_sortkeys;
148 service->default_sort = nmem_strdup(nmem, "relevance");
149 service->sortkeys = 0;
150 if (service->num_sortkeys)
153 sizeof(struct conf_sortkey) * service->num_sortkeys);
154 service->xml_node = 0;
158 static struct conf_metadata* conf_service_add_metadata(
159 struct conf_service *service,
162 enum conf_metadata_type type,
163 enum conf_metadata_merge merge,
164 enum conf_setting_type setting,
169 enum conf_metadata_mergekey mt,
170 const char *facetrule,
171 const char *limitmap,
172 const char *limitcluster,
176 struct conf_metadata * md = 0;
177 NMEM nmem = service->nmem;
179 if (!service->metadata || !service->num_metadata
180 || field_id < 0 || !(field_id < service->num_metadata))
183 md = service->metadata + field_id;
184 assert(nmem && md && name);
186 md->name = nmem_strdup(nmem, name);
190 // enforcing that type_year is always range_merge
191 if (md->type == Metadata_type_year)
192 md->merge = Metadata_merge_range;
196 md->setting = setting;
198 md->termlist = termlist;
199 md->rank = nmem_strdup_null(nmem, rank);
200 md->sortkey_offset = sortkey_offset;
202 md->facetrule = nmem_strdup_null(nmem, facetrule);
203 md->limitmap = nmem_strdup_null(nmem, limitmap);
204 md->limitcluster = nmem_strdup_null(nmem, limitcluster);
205 md->icurule = nmem_strdup_null(nmem, icurule);
209 static struct conf_sortkey *conf_service_add_sortkey(
210 struct conf_service *service,
213 enum conf_metadata_type type)
215 struct conf_sortkey *sk = 0;
216 NMEM nmem = service->nmem;
218 if (!service->sortkeys || !service->num_sortkeys
219 || field_id < 0 || !(field_id < service->num_sortkeys))
222 sk = service->sortkeys + field_id;
224 assert(nmem && sk && name);
226 sk->name = nmem_strdup(nmem, name);
231 int conf_service_metadata_field_id(struct conf_service *service,
236 if (!service || !service->metadata || !service->num_metadata)
239 for (i = 0; i < service->num_metadata; i++)
240 if (!strcmp(name, (service->metadata[i]).name))
245 int conf_service_sortkey_field_id(struct conf_service *service,
250 if (!service || !service->sortkeys || !service->num_sortkeys)
253 for (i = 0; i < service->num_sortkeys; i++)
254 if (!strcmp(name, (service->sortkeys[i]).name))
259 static void conf_dir_path(struct conf_config *config, WRBUF w, const char *src)
261 char full_path[1024];
262 if (yaz_filepath_resolve(src, config->path,
263 wrbuf_len(config->confdir) > 0 ?
264 wrbuf_cstr(config->confdir) : ".",
267 wrbuf_puts(w, full_path);
271 yaz_log(YLOG_WARN, "File not found: fname=%s path=%s base=%s", src,
272 config->path, wrbuf_cstr(config->confdir));
277 void service_destroy(struct conf_service *service)
281 if (!pazpar2_decref(&service->ref_count, service->mutex))
283 service_xslt_destroy(service);
284 pp2_charset_fact_destroy(service->charsets);
285 ccl_qual_rm(&service->ccl_bibset);
286 yaz_mutex_destroy(&service->mutex);
287 nmem_destroy(service->nmem);
292 void service_incref(struct conf_service *service)
294 pazpar2_incref(&service->ref_count, service->mutex);
297 static int parse_metadata(struct conf_service *service, xmlNode *n,
298 int *md_node, int *sk_node)
300 enum conf_metadata_type type = Metadata_type_generic;
301 enum conf_metadata_merge merge = Metadata_merge_no;
302 enum conf_setting_type setting = Metadata_setting_no;
303 enum conf_metadata_mergekey mergekey_type = Metadata_mergekey_no;
306 int sortkey_offset = 0;
307 xmlChar *xml_name = 0;
308 xmlChar *xml_brief = 0;
309 xmlChar *xml_sortkey = 0;
310 xmlChar *xml_merge = 0;
311 xmlChar *xml_type = 0;
312 xmlChar *xml_termlist = 0;
313 xmlChar *xml_rank = 0;
314 xmlChar *xml_setting = 0;
315 xmlChar *xml_mergekey = 0;
316 xmlChar *xml_limitmap = 0;
317 xmlChar *xml_limitcluster = 0;
318 xmlChar *xml_icu_chain = 0;
319 xmlChar *xml_icurule = 0;
321 struct _xmlAttr *attr;
325 for (attr = n->properties; attr; attr = attr->next)
327 if (!xmlStrcmp(attr->name, BAD_CAST "name") &&
328 attr->children && attr->children->type == XML_TEXT_NODE)
329 xml_name = attr->children->content;
330 else if (!xmlStrcmp(attr->name, BAD_CAST "brief") &&
331 attr->children && attr->children->type == XML_TEXT_NODE)
332 xml_brief = attr->children->content;
333 else if (!xmlStrcmp(attr->name, BAD_CAST "sortkey") &&
334 attr->children && attr->children->type == XML_TEXT_NODE)
335 xml_sortkey = attr->children->content;
336 else if (!xmlStrcmp(attr->name, BAD_CAST "merge") &&
337 attr->children && attr->children->type == XML_TEXT_NODE)
338 xml_merge = attr->children->content;
339 else if (!xmlStrcmp(attr->name, BAD_CAST "type") &&
340 attr->children && attr->children->type == XML_TEXT_NODE)
341 xml_type = attr->children->content;
342 else if (!xmlStrcmp(attr->name, BAD_CAST "termlist") &&
343 attr->children && attr->children->type == XML_TEXT_NODE)
344 xml_termlist = attr->children->content;
345 else if (!xmlStrcmp(attr->name, BAD_CAST "rank") &&
346 attr->children && attr->children->type == XML_TEXT_NODE)
347 xml_rank = attr->children->content;
348 else if (!xmlStrcmp(attr->name, BAD_CAST "setting") &&
349 attr->children && attr->children->type == XML_TEXT_NODE)
350 xml_setting = attr->children->content;
351 else if (!xmlStrcmp(attr->name, BAD_CAST "mergekey") &&
352 attr->children && attr->children->type == XML_TEXT_NODE)
353 xml_mergekey = attr->children->content;
354 else if (!xmlStrcmp(attr->name, BAD_CAST "facetrule") &&
355 attr->children && attr->children->type == XML_TEXT_NODE)
356 xml_icu_chain = attr->children->content;
357 else if (!xmlStrcmp(attr->name, BAD_CAST "limitmap") &&
358 attr->children && attr->children->type == XML_TEXT_NODE)
359 xml_limitmap = attr->children->content;
360 else if (!xmlStrcmp(attr->name, BAD_CAST "limitcluster") &&
361 attr->children && attr->children->type == XML_TEXT_NODE)
362 xml_limitcluster = attr->children->content;
363 else if (!xmlStrcmp(attr->name, BAD_CAST "icurule") &&
364 attr->children && attr->children->type == XML_TEXT_NODE)
365 xml_icurule = attr->children->content;
368 yaz_log(YLOG_FATAL, "Unknown metadata attribute '%s'", attr->name);
373 // now do the parsing logic
376 yaz_log(YLOG_FATAL, "Must specify name in metadata element");
381 if (!strcmp((const char *) xml_brief, "yes"))
383 else if (strcmp((const char *) xml_brief, "no"))
385 yaz_log(YLOG_FATAL, "metadata/brief must be yes or no");
392 if (!strcmp((const char *) xml_termlist, "yes"))
394 else if (strcmp((const char *) xml_termlist, "no"))
396 yaz_log(YLOG_FATAL, "metadata/termlist must be yes or no");
403 if (!strcmp((const char *) xml_type, "generic"))
404 type = Metadata_type_generic;
405 else if (!strcmp((const char *) xml_type, "year"))
406 type = Metadata_type_year;
407 else if (!strcmp((const char *) xml_type, "date"))
408 type = Metadata_type_date;
409 else if (!strcmp((const char *) xml_type, "float"))
410 type = Metadata_type_float;
414 "Unknown value for metadata/type: %s", xml_type);
421 if (!strcmp((const char *) xml_merge, "no"))
422 merge = Metadata_merge_no;
423 else if (!strcmp((const char *) xml_merge, "unique"))
424 merge = Metadata_merge_unique;
425 else if (!strcmp((const char *) xml_merge, "longest"))
426 merge = Metadata_merge_longest;
427 else if (!strcmp((const char *) xml_merge, "range"))
428 merge = Metadata_merge_range;
429 else if (!strcmp((const char *) xml_merge, "all"))
430 merge = Metadata_merge_all;
431 else if (!strcmp((const char *) xml_merge, "first"))
432 merge = Metadata_merge_first;
436 "Unknown value for metadata/merge: %s", xml_merge);
443 if (!strcmp((const char *) xml_setting, "no"))
444 setting = Metadata_setting_no;
445 else if (!strcmp((const char *) xml_setting, "postproc"))
446 setting = Metadata_setting_postproc;
447 else if (!strcmp((const char *) xml_setting, "parameter"))
448 setting = Metadata_setting_parameter;
452 "Unknown value for metadata/setting: %s", xml_setting);
457 // add a sortkey if so specified
458 if (xml_sortkey && strcmp((const char *) xml_sortkey, "no"))
460 enum conf_metadata_type sk_type = type;
461 if (merge == Metadata_merge_no)
464 "Can't specify sortkey on a non-merged field");
467 if (!strcmp((const char *) xml_sortkey, "yes"))
469 if (!strcmp((const char *) xml_sortkey, "numeric"))
471 else if (!strcmp((const char *) xml_sortkey, "skiparticle"))
473 if (sk_type == Metadata_type_generic)
474 sk_type = Metadata_type_skiparticle;
478 "skiparticle only supported for type=generic: %s",
486 "Unknown sortkey in metadata element: %s",
490 sortkey_offset = *sk_node;
492 conf_service_add_sortkey(service, *sk_node,
493 (const char *) xml_name, sk_type);
501 if (!strcmp((const char *) xml_mergekey, "required"))
502 mergekey_type = Metadata_mergekey_required;
503 else if (!strcmp((const char *) xml_mergekey, "optional"))
504 mergekey_type = Metadata_mergekey_optional;
505 else if (!strcmp((const char *) xml_mergekey, "no"))
506 mergekey_type = Metadata_mergekey_no;
509 yaz_log(YLOG_FATAL, "Unknown value for mergekey: %s", xml_mergekey);
514 // metadata known, assign values
515 conf_service_add_metadata(service, *md_node,
516 (const char *) xml_name,
517 type, merge, setting,
519 (const char *) xml_rank, sortkey_offset,
521 (const char *) xml_icu_chain,
522 (const char *) xml_limitmap,
523 (const char *) xml_limitcluster,
524 (const char *) xml_icurule
531 static void count_metadata(xmlNode *n, int *num_metadata, int *num_sortkeys)
533 xmlChar *sortkey = xmlGetProp(n, (xmlChar *) "sortkey");
536 if (sortkey && strcmp((const char *) sortkey, "no"))
542 static struct conf_service *service_create_static(struct conf_server *server,
544 const char *service_id)
550 struct conf_service *service = 0;
551 int num_metadata = 0;
552 int num_sortkeys = 0;
553 int got_settings = 0;
555 // count num_metadata and num_sortkeys
556 for (n = node->children; n; n = n->next)
557 if (n->type == XML_ELEMENT_NODE && !strcmp((const char *)
558 n->name, "metadata"))
560 if (n->children) // This is a <metadata> container, look at its contents.
563 for (m = n->children; m; m = m->next)
565 if (m->type == XML_ELEMENT_NODE &&
566 !strcmp((const char *) m->name, "metadata"))
567 count_metadata(m, &num_metadata, &num_sortkeys);
570 else // This is a metadata-element proper, count it right away.
571 count_metadata(n, &num_metadata, &num_sortkeys);
574 service = service_init(server, num_metadata, num_sortkeys, service_id);
576 for (n = node->children; n; n = n->next)
578 if (n->type != XML_ELEMENT_NODE)
580 if (!strcmp((const char *) n->name, "timeout"))
582 xmlChar *src = xmlGetProp(n, (xmlChar *) "session");
585 service->session_timeout = atoi((const char *) src);
587 if (service->session_timeout < 9)
589 yaz_log(YLOG_FATAL, "session timeout out of range");
593 src = xmlGetProp(n, (xmlChar *) "z3950_operation");
596 service->z3950_operation_timeout = atoi((const char *) src);
598 if (service->z3950_session_timeout < 9)
600 yaz_log(YLOG_FATAL, "Z39.50 operation timeout out of range");
604 src = xmlGetProp(n, (xmlChar *) "z3950_session");
607 service->z3950_session_timeout = atoi((const char *) src);
609 if (service->z3950_session_timeout < 9)
611 yaz_log(YLOG_FATAL, "Z39.50 session timeout out of range");
616 else if (!strcmp((const char *) n->name, "ccldirective"))
620 if (!service->ccl_bibset)
621 service->ccl_bibset = ccl_qual_mk();
622 name = (char *) xmlGetProp(n, (xmlChar *) "name");
625 yaz_log(YLOG_FATAL, "ccldirective: missing @name");
628 value = (char *) xmlGetProp(n, (xmlChar *) "value");
632 yaz_log(YLOG_FATAL, "ccldirective: missing @value");
635 ccl_qual_add_special(service->ccl_bibset, name, value);
639 else if (!strcmp((const char *) n->name, "settings"))
641 else if (!strcmp((const char *) n->name, "icu_chain"))
643 if (!service->charsets)
644 service->charsets = pp2_charset_fact_create();
645 if (pp2_charset_fact_define(service->charsets, n, 0))
647 yaz_log(YLOG_FATAL, "ICU chain definition error");
651 else if (!strcmp((const char *) n->name, "relevance")
652 || !strcmp((const char *) n->name, "sort")
653 || !strcmp((const char *) n->name, "mergekey")
654 || !strcmp((const char *) n->name, "facet"))
657 if (!service->charsets)
658 service->charsets = pp2_charset_fact_create();
659 if (pp2_charset_fact_define(service->charsets, n,
660 (const char *) n->name))
662 yaz_log(YLOG_FATAL, "ICU chain definition error");
666 else if (!strcmp((const char *) n->name, (const char *) "metadata"))
668 if (n->children) // This is a <metadata> container, look at its content.
671 for (m = n->children; m; m = m->next)
672 if ((!strcmp((const char *) m->name, (const char *) "metadata")))
673 if (parse_metadata(service, m, &md_node, &sk_node))
676 else // This is a metadata-element proper, count it right away.
677 if (parse_metadata(service, n, &md_node, &sk_node))
680 else if (!strcmp((const char *) n->name, (const char *) "xslt"))
682 if (service_xslt_config(service, n))
685 else if (!strcmp((const char *) n->name, "rank"))
687 char *rank_cluster = (char *) xmlGetProp(n, (xmlChar *) "cluster");
688 char *rank_debug = (char *) xmlGetProp(n, (xmlChar *) "debug");
689 char *rank_follow = (char *) xmlGetProp(n, (xmlChar *) "follow");
690 char *rank_lead = (char *) xmlGetProp(n, (xmlChar *) "lead");
691 char *rank_length= (char *) xmlGetProp(n, (xmlChar *) "length");
694 if (!strcmp(rank_cluster, "yes"))
695 service->rank_cluster = 1;
696 else if (!strcmp(rank_cluster, "no"))
697 service->rank_cluster = 0;
700 yaz_log(YLOG_FATAL, "service: rank@cluster boolean");
706 if (!strcmp(rank_debug, "yes"))
707 service->rank_debug = 1;
708 else if (!strcmp(rank_debug, "no"))
709 service->rank_debug = 0;
712 yaz_log(YLOG_FATAL, "service: rank@debug boolean");
718 service->rank_follow = atof(rank_follow);
722 service->rank_lead = atof(rank_lead);
726 if (!strcmp(rank_length, "linear"))
727 service->rank_length = 2;
728 else if (!strcmp(rank_length, "log"))
729 service->rank_length = 1;
730 else if (!strcmp(rank_length, "none"))
731 service->rank_length = 0;
734 yaz_log(YLOG_FATAL, "service: rank@length linear|log|none");
738 xmlFree(rank_cluster);
740 xmlFree(rank_follow);
742 xmlFree(rank_length);
744 else if (!strcmp((const char *) n->name, "sort-default"))
746 char *default_sort = (char *) xmlGetProp(n, (xmlChar *) "field");
748 if (default_sort && strcmp(default_sort, "")) {
749 service->default_sort = nmem_strdup(service->nmem, default_sort);
750 yaz_log(YLOG_LOG, "service %s: default sort order configured to: %s",
751 service_id ? service_id : "unnamed", default_sort);
755 yaz_log(YLOG_FATAL, "default sort order is invalid: %s", default_sort);
758 xmlFree(default_sort);
763 yaz_log(YLOG_FATAL, "Bad element: %s . Context: %s", n->name,
764 xml_context(n, tmp, sizeof tmp));
771 /* metadata has been read.. Consider now settings */
772 init_settings(service);
773 for (pass = 1; pass <= 2; pass++)
775 for (n = node->children; n; n = n->next)
777 if (n->type != XML_ELEMENT_NODE)
779 if (!strcmp((const char *) n->name, "settings"))
782 xmlChar *src = xmlGetProp(n, (xmlChar *) "src");
785 WRBUF w = wrbuf_alloc();
786 conf_dir_path(server->config, w, (const char *) src);
787 ret = settings_read_file(service, wrbuf_cstr(w), pass);
793 ret = settings_read_node(service, n, pass);
803 xmlBufferPtr buf = xmlBufferCreate();
804 xmlNodeDump(buf, node->doc, node, 0, 0);
806 nmem_strdupn(service->nmem, (const char *) buf->content, buf->use);
812 static int inherit_server_settings(struct conf_service *s)
815 struct conf_server *server = s->server;
816 if (!s->dictionary) /* service has no config settings ? */
818 if (server->settings_fname)
820 /* inherit settings from server */
822 if (settings_read_file(s, server->settings_fname, 1))
824 if (settings_read_file(s, server->settings_fname, 2))
829 yaz_log(YLOG_WARN, "server '%s' has no settings", s->id ? s->id : "unnamed");
834 /* use relevance/sort/mergekey/facet from server if not defined
835 for this service.. */
838 if (server->charsets)
840 s->charsets = server->charsets;
841 pp2_charset_fact_incref(s->charsets);
845 s->charsets = pp2_charset_fact_create();
851 struct conf_service *service_create(struct conf_server *server,
854 struct conf_service *service = service_create_static(server, node, 0);
857 inherit_server_settings(service);
858 assert(service->mutex == 0);
859 pazpar2_mutex_create(&service->mutex, "conf");
864 static struct conf_server *server_create(struct conf_config *config,
865 NMEM nmem, xmlNode *node)
868 struct conf_server *server = nmem_malloc(nmem, sizeof(struct conf_server));
869 xmlChar *server_id = xmlGetProp(node, (xmlChar *) "id");
873 server->proxy_host = 0;
874 server->proxy_port = 0;
877 server->config = config;
879 server->charsets = 0;
880 server->http_server = 0;
881 server->iochan_man = 0;
882 server->settings_fname = 0;
886 server->server_id = nmem_strdup(nmem, (const char *)server_id);
890 server->server_id = 0;
891 for (n = node->children; n; n = n->next)
893 if (n->type != XML_ELEMENT_NODE)
895 if (!strcmp((const char *) n->name, "listen"))
897 xmlChar *port = xmlGetProp(n, (xmlChar *) "port");
898 xmlChar *host = xmlGetProp(n, (xmlChar *) "host");
901 server->port = nmem_strdup(nmem, (const char *) port);
903 server->host = nmem_strdup(nmem, (const char *) host);
908 else if (!strcmp((const char *) n->name, "proxy"))
910 xmlChar *port = xmlGetProp(n, (xmlChar *) "port");
911 xmlChar *host = xmlGetProp(n, (xmlChar *) "host");
912 xmlChar *myurl = xmlGetProp(n, (xmlChar *) "myurl");
914 server->proxy_port = atoi((const char *) port);
916 server->proxy_host = nmem_strdup(nmem, (const char *) host);
918 server->myurl = nmem_strdup(nmem, (const char *) myurl);
923 else if (!strcmp((const char *) n->name, "settings"))
925 xmlChar *src = xmlGetProp(n, (xmlChar *) "src");
929 yaz_log(YLOG_FATAL, "Missing src attribute for settings");
932 if (server->settings_fname)
935 yaz_log(YLOG_FATAL, "Can't repeat 'settings'");
939 conf_dir_path(config, w, (const char *) src);
940 server->settings_fname = nmem_strdup(nmem, wrbuf_cstr(w));
944 else if (!strcmp((const char *) n->name, "icu_chain"))
946 if (!server->charsets)
947 server->charsets = pp2_charset_fact_create();
948 if (pp2_charset_fact_define(server->charsets, n, 0))
950 yaz_log(YLOG_FATAL, "ICU chain definition error");
954 else if (!strcmp((const char *) n->name, "relevance")
955 || !strcmp((const char *) n->name, "sort")
956 || !strcmp((const char *) n->name, "mergekey")
957 || !strcmp((const char *) n->name, "facet"))
959 if (!server->charsets)
960 server->charsets = pp2_charset_fact_create();
961 if (pp2_charset_fact_define(server->charsets, n,
962 (const char *) n->name))
964 yaz_log(YLOG_FATAL, "ICU chain definition error");
968 else if (!strcmp((const char *) n->name, "service"))
970 char *service_id = (char *)
971 xmlGetProp(n, (xmlChar *) "id");
973 struct conf_service **sp = &server->service;
974 for (; *sp; sp = &(*sp)->next)
975 if ((*sp)->id && service_id &&
976 0 == strcmp((*sp)->id, service_id))
978 yaz_log(YLOG_FATAL, "Duplicate service: %s", service_id);
981 else if (!(*sp)->id && !service_id)
983 yaz_log(YLOG_FATAL, "Duplicate unnamed service");
987 if (*sp) /* service already exist */
994 struct conf_service *s = service_create_static(server, n,
1004 yaz_log(YLOG_FATAL, "Bad element: %s", n->name);
1010 yaz_log(YLOG_FATAL, "No listening port given");
1013 if (server->service)
1015 struct conf_service *s;
1016 for (s = server->service; s; s = s->next)
1017 inherit_server_settings(s);
1022 WRBUF conf_get_fname(struct conf_config *config, const char *fname)
1024 WRBUF w = wrbuf_alloc();
1026 conf_dir_path(config, w, fname);
1030 struct conf_service *locate_service(struct conf_server *server,
1031 const char *service_id)
1033 struct conf_service *s = server->service;
1034 for (; s; s = s->next)
1035 if (s->id && service_id && 0 == strcmp(s->id, service_id))
1037 else if (!s->id && !service_id)
1044 static void info_service_metadata(struct conf_service *service, WRBUF w)
1047 struct conf_metadata *md;
1049 if (service->num_metadata)
1051 for (i = 0; i < service->num_metadata; i++)
1053 md = &(service->metadata[i]);
1054 wrbuf_puts(w, " <metadata");
1056 wrbuf_puts(w, " name=\"");
1057 wrbuf_xmlputs(w, md->name);
1058 wrbuf_puts(w, "\"");
1061 wrbuf_puts(w, " brief=\"yes\"");
1064 wrbuf_puts(w, " termlist=\"yes\"");
1067 wrbuf_puts(w, " rank=\"");
1068 wrbuf_xmlputs(w, md->rank);
1069 wrbuf_puts(w, "\"");
1071 if (md->sortkey_offset > 0) {
1072 wrbuf_puts(w, " sortkey=\"");
1073 switch (service->sortkeys[md->sortkey_offset].type)
1075 case Metadata_type_relevance:
1076 wrbuf_puts(w, "relevance");
1078 case Metadata_type_skiparticle:
1079 wrbuf_puts(w, "skiparticle");
1081 case Metadata_type_position:
1082 wrbuf_puts(w, "position");
1084 case Metadata_type_retrieval:
1085 wrbuf_puts(w, "retrieval");
1088 wrbuf_puts(w, "yes");
1091 wrbuf_puts(w, "\"");
1095 case Metadata_type_generic:
1096 case Metadata_type_skiparticle:
1098 case Metadata_type_year:
1099 wrbuf_puts(w, " type=\"year\"");
1101 case Metadata_type_date:
1102 wrbuf_puts(w, " type=\"date\"");
1104 case Metadata_type_float:
1105 wrbuf_puts(w, " type=\"float\"");
1112 case Metadata_merge_no:
1114 case Metadata_merge_unique:
1115 wrbuf_puts(w, " merge=\"unique\"");
1117 case Metadata_merge_longest:
1118 wrbuf_puts(w, " merge=\"longest\"");
1120 case Metadata_merge_range:
1121 wrbuf_puts(w, " merge=\"range\"");
1123 case Metadata_merge_all:
1124 wrbuf_puts(w, " merge=\"all\"");
1126 case Metadata_merge_first:
1127 wrbuf_puts(w, " merge=\"first\"");
1130 switch (md->mergekey)
1132 case Metadata_mergekey_no:
1134 case Metadata_mergekey_optional:
1135 wrbuf_puts(w, " mergekey=\"optional\"");
1137 case Metadata_mergekey_required:
1138 wrbuf_puts(w, " mergekey=\"required\"");
1141 wrbuf_puts(w, " />\n");
1146 static void info_service_databases(struct conf_service *service, WRBUF w)
1149 if (service->databases)
1151 struct database *db;
1152 wrbuf_puts(w, " <databases>\n");
1153 for (db = service->databases; db; db = db->next)
1156 wrbuf_puts(w, " <database");
1159 wrbuf_puts(w, " id=\"");
1160 wrbuf_printf(w, "%s", db->id);
1161 wrbuf_puts(w, "\"");
1163 wrbuf_puts(w, ">\n");
1164 for (i = 0; i < db->num_settings; i++)
1166 struct setting *s = db->settings[i];
1167 for (; s; s = s->next)
1169 wrbuf_puts(w, " <setting name=\"");
1170 wrbuf_xmlputs(w, s->name);
1171 wrbuf_puts(w, "\"");
1172 wrbuf_puts(w, " value=\"");
1173 wrbuf_xmlputs(w, s->value);
1174 wrbuf_puts(w, "\"");
1175 wrbuf_puts(w, " />\n");
1178 wrbuf_puts(w, " </database>\n");
1180 wrbuf_puts(w, " </databases>\n");
1184 void info_services(struct conf_server *server, WRBUF w)
1186 struct conf_service *s = server->service;
1189 wrbuf_puts(w, " <services>\n");
1190 for (; s; s = s->next)
1192 wrbuf_puts(w, " <service");
1195 wrbuf_puts(w, " id=\"");
1196 wrbuf_xmlputs(w, s->id);
1197 wrbuf_puts(w, "\"");
1199 wrbuf_puts(w, ">\n");
1202 for (i = 0; i < s->settings->num_settings; i++)
1204 struct setting *S = s->settings->settings[i];
1205 for (; S; S = S->next)
1207 wrbuf_puts(w, " <setting name=\"");
1208 wrbuf_xmlputs(w, S->name);
1209 wrbuf_puts(w, "\"");
1210 wrbuf_puts(w, " value=\"");
1211 wrbuf_xmlputs(w, S->value);
1212 wrbuf_puts(w, "\"");
1215 wrbuf_puts(w, " target=\"");
1216 wrbuf_xmlputs(w, S->target);
1217 wrbuf_puts(w, "\"");
1219 wrbuf_puts(w, " />\n");
1223 info_service_metadata(s, w);
1224 info_service_databases(s, w);
1225 wrbuf_puts(w, " </service>\n");
1227 wrbuf_puts(w, " </services>\n");
1230 static int parse_config(struct conf_config *config, xmlNode *root)
1234 for (n = root->children; n; n = n->next)
1236 if (n->type != XML_ELEMENT_NODE)
1238 if (!strcmp((const char *) n->name, "server"))
1240 struct conf_server *tmp = server_create(config, config->nmem, n);
1243 tmp->next = config->servers;
1244 config->servers = tmp;
1246 else if (!strcmp((const char *) n->name, "threads"))
1248 xmlChar *number = xmlGetProp(n, (xmlChar *) "number");
1251 config->no_threads = atoi((const char *) number);
1255 else if (!strcmp((const char *) n->name, "file"))
1257 xmlChar *path = xmlGetProp(n, (xmlChar *) "path");
1260 config->path = nmem_strdup(config->nmem, (const char *) path);
1264 else if (!strcmp((const char *) n->name, "targetprofiles"))
1266 yaz_log(YLOG_FATAL, "targetprofiles unsupported here. Must be part of service");
1272 yaz_log(YLOG_FATAL, "Bad element: %s", n->name);
1279 struct conf_config *config_create(const char *fname)
1281 xmlDoc *doc = xmlReadFile(fname,
1284 + XML_PARSE_NSCLEAN + XML_PARSE_NONET);
1288 NMEM nmem = nmem_create();
1289 struct conf_config *config = nmem_malloc(nmem, sizeof(struct conf_config));
1291 xmlSubstituteEntitiesDefault(1);
1292 xmlLoadExtDtdDefaultValue = 1;
1295 yaz_log(YLOG_FATAL, "Failed to read %s", fname);
1300 // Perform XInclude.
1301 r = xmlXIncludeProcess(doc);
1304 yaz_log(YLOG_FATAL, "XInclude processing failed");
1308 config->nmem = nmem;
1309 config->servers = 0;
1310 config->path = nmem_strdup(nmem, ".");
1311 config->no_threads = 0;
1312 config->iochan_man = 0;
1314 config->confdir = wrbuf_alloc();
1315 if ((p = strrchr(fname,
1323 int len = p - fname;
1324 wrbuf_write(config->confdir, fname, len);
1326 wrbuf_puts(config->confdir, "");
1328 n = xmlDocGetRootElement(doc);
1329 r = yaz_xml_include_simple(n, wrbuf_cstr(config->confdir));
1330 if (r == 0) /* OK */
1333 yaz_log(YLOG_LOG, "Configuration %s after include processing",
1335 #if LIBXML_VERSION >= 20600
1336 xmlDocFormatDump(yaz_log_file(), doc, 0);
1338 xmlDocDump(yaz_log_file(), doc);
1341 r = parse_config(config, n);
1347 config_destroy(config);
1353 void server_destroy(struct conf_server *server)
1355 struct conf_service *s = server->service;
1358 struct conf_service *s_next = s->next;
1362 pp2_charset_fact_destroy(server->charsets);
1363 http_server_destroy(server->http_server);
1366 void config_destroy(struct conf_config *config)
1370 struct conf_server *server = config->servers;
1371 iochan_man_destroy(&config->iochan_man);
1374 struct conf_server *s_next = server->next;
1375 server_destroy(server);
1378 wrbuf_destroy(config->confdir);
1379 nmem_destroy(config->nmem);
1383 void config_stop_listeners(struct conf_config *conf)
1385 struct conf_server *ser;
1386 for (ser = conf->servers; ser; ser = ser->next)
1387 http_close_server(ser);
1390 void config_process_events(struct conf_config *conf)
1392 struct conf_server *ser;
1394 for (ser = conf->servers; ser; ser = ser->next)
1396 struct conf_service *s = ser->service;
1398 for (;s ; s = s->next)
1400 assert(s->mutex == 0);
1401 pazpar2_mutex_create(&s->mutex, "service");
1403 http_mutex_init(ser);
1405 iochan_man_events(conf->iochan_man);
1408 int config_start_listeners(struct conf_config *conf,
1409 const char *listener_override,
1410 const char *record_fname)
1412 struct conf_server *ser;
1414 conf->iochan_man = iochan_man_create(conf->no_threads);
1415 for (ser = conf->servers; ser; ser = ser->next)
1420 ser->iochan_man = conf->iochan_man;
1421 if (listener_override)
1423 const char *cp = strrchr(listener_override, ':');
1426 ser->host = nmem_strdupn(conf->nmem, listener_override,
1427 cp - listener_override);
1428 ser->port = nmem_strdup(conf->nmem, cp + 1);
1433 ser->port = nmem_strdup(conf->nmem, listener_override);
1435 listener_override = 0; /* only first server is overriden */
1437 r = http_init(ser, record_fname);
1442 if (ser->proxy_host || ser->proxy_port)
1444 if (ser->proxy_host)
1445 wrbuf_puts(w, ser->proxy_host);
1446 if (ser->proxy_port)
1450 wrbuf_printf(w, "%d", ser->proxy_port);
1454 http_set_proxyaddr(wrbuf_cstr(w), ser);
1463 * c-file-style: "Stroustrup"
1464 * indent-tabs-mode: nil
1466 * vim: shiftwidth=4 tabstop=8 expandtab