1 /* This file is part of Pazpar2.
2 Copyright (C) 2006-2009 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 <libxslt/xslt.h>
30 #include <libxslt/transform.h>
31 #include <libxslt/xsltutils.h>
33 #include <yaz/yaz-util.h>
35 #include <yaz/snprintf.h>
36 #include <yaz/tpath.h>
39 #define USE_POSIX_GLOB 1
41 #define USE_POSIX_GLOB 0
48 #include <sys/types.h>
53 #include "pazpar2_config.h"
60 NMEM nmem; /* for conf_config and servers memory */
61 struct conf_server *servers;
66 static char *parse_settings(struct conf_config *config,
67 NMEM nmem, xmlNode *node);
69 static struct conf_targetprofiles *parse_targetprofiles(NMEM nmem,
72 static void conf_metadata_assign(NMEM nmem,
73 struct conf_metadata * metadata,
75 enum conf_metadata_type type,
76 enum conf_metadata_merge merge,
77 enum conf_setting_type setting,
82 enum conf_metadata_mergekey mt)
84 assert(nmem && metadata && name);
86 metadata->name = nmem_strdup(nmem, name);
88 metadata->type = type;
90 // enforcing that type_year is always range_merge
91 if (metadata->type == Metadata_type_year)
92 metadata->merge = Metadata_merge_range;
94 metadata->merge = merge;
96 metadata->setting = setting;
97 metadata->brief = brief;
98 metadata->termlist = termlist;
99 metadata->rank = rank;
100 metadata->sortkey_offset = sortkey_offset;
101 metadata->mergekey = mt;
105 static void conf_sortkey_assign(NMEM nmem,
106 struct conf_sortkey * sortkey,
108 enum conf_sortkey_type type)
110 assert(nmem && sortkey && name);
112 sortkey->name = nmem_strdup(nmem, name);
113 sortkey->type = type;
117 static struct conf_service *service_init(struct conf_config *config,
118 int num_metadata, int num_sortkeys,
119 const char *service_id)
121 struct conf_service * service = 0;
122 NMEM nmem = nmem_create();
124 service = nmem_malloc(nmem, sizeof(struct conf_service));
125 service->nmem = nmem;
127 service->settings = 0;
128 service->databases = 0;
129 service->targetprofiles = 0;
130 service->config = config;
132 service->relevance_pct = 0;
133 service->sort_pct = 0;
134 service->mergekey_pct = 0;
136 service->id = service_id ? nmem_strdup(nmem, service_id) : 0;
137 service->num_metadata = num_metadata;
138 service->metadata = 0;
139 if (service->num_metadata)
142 sizeof(struct conf_metadata) * service->num_metadata);
143 service->num_sortkeys = num_sortkeys;
144 service->sortkeys = 0;
145 if (service->num_sortkeys)
148 sizeof(struct conf_sortkey) * service->num_sortkeys);
149 service->dictionary = 0;
153 struct conf_metadata* conf_service_add_metadata(struct conf_service *service,
156 enum conf_metadata_type type,
157 enum conf_metadata_merge merge,
158 enum conf_setting_type setting,
163 enum conf_metadata_mergekey mt)
165 struct conf_metadata * md = 0;
167 if (!service || !service->metadata || !service->num_metadata
168 || field_id < 0 || !(field_id < service->num_metadata))
171 md = service->metadata + field_id;
172 conf_metadata_assign(service->nmem, md, name, type, merge, setting,
173 brief, termlist, rank, sortkey_offset,
179 struct conf_sortkey * conf_service_add_sortkey(struct conf_service *service,
182 enum conf_sortkey_type type)
184 struct conf_sortkey * sk = 0;
186 if (!service || !service->sortkeys || !service->num_sortkeys
187 || field_id < 0 || !(field_id < service->num_sortkeys))
190 //sk = &((service->sortkeys)[field_id]);
191 sk = service->sortkeys + field_id;
192 conf_sortkey_assign(service->nmem, sk, name, type);
198 int conf_service_metadata_field_id(struct conf_service *service,
203 if (!service || !service->metadata || !service->num_metadata)
206 for(i = 0; i < service->num_metadata; i++) {
207 if (!strcmp(name, (service->metadata[i]).name))
215 int conf_service_sortkey_field_id(struct conf_service *service,
220 if (!service || !service->sortkeys || !service->num_sortkeys)
223 for(i = 0; i < service->num_sortkeys; i++) {
224 if (!strcmp(name, (service->sortkeys[i]).name))
231 static void conf_dir_path(struct conf_config *config, WRBUF w, const char *src)
233 if (config->confdir && wrbuf_len(config->confdir) > 0 &&
234 !yaz_is_abspath(src))
236 wrbuf_printf(w, "%s/%s", wrbuf_cstr(config->confdir), src);
242 static void service_destroy(struct conf_service *service)
246 pp2_charset_destroy(service->relevance_pct);
247 pp2_charset_destroy(service->sort_pct);
248 pp2_charset_destroy(service->mergekey_pct);
249 nmem_destroy(service->nmem);
253 static struct conf_service *service_create(struct conf_config *config,
255 const char *service_id)
261 struct conf_service *service = 0;
262 int num_metadata = 0;
263 int num_sortkeys = 0;
264 int got_settings = 0;
266 // count num_metadata and num_sortkeys
267 for (n = node->children; n; n = n->next)
268 if (n->type == XML_ELEMENT_NODE && !strcmp((const char *)
269 n->name, "metadata"))
271 xmlChar *sortkey = xmlGetProp(n, (xmlChar *) "sortkey");
273 if (sortkey && strcmp((const char *) sortkey, "no"))
278 service = service_init(config, num_metadata, num_sortkeys, service_id);
280 for (n = node->children; n; n = n->next)
282 if (n->type != XML_ELEMENT_NODE)
284 if (!strcmp((const char *) n->name, "settings"))
286 else if (!strcmp((const char *) n->name, (const char *) "targetprofiles"))
288 if (service->targetprofiles)
290 yaz_log(YLOG_FATAL, "Can't repeat targetprofiles");
293 if (!(service->targetprofiles =
294 parse_targetprofiles(service->nmem, n)))
297 else if (!strcmp((const char *) n->name, "relevance"))
299 if (service->relevance_pct)
301 yaz_log(YLOG_LOG, "relevance may not repeat in service");
306 service->relevance_pct = pp2_charset_create_xml(n);
307 if (!service->relevance_pct)
311 else if (!strcmp((const char *) n->name, "sort"))
313 if (service->sort_pct)
315 yaz_log(YLOG_LOG, "sort may not repeat in service");
320 service->sort_pct = pp2_charset_create_xml(n);
321 if (!service->sort_pct)
325 else if (!strcmp((const char *) n->name, "mergekey"))
327 if (service->mergekey_pct)
329 yaz_log(YLOG_LOG, "mergekey may not repeat in service");
334 service->mergekey_pct = pp2_charset_create_xml(n);
335 if (!service->mergekey_pct)
339 else if (!strcmp((const char *) n->name, (const char *) "metadata"))
341 xmlChar *xml_name = xmlGetProp(n, (xmlChar *) "name");
342 xmlChar *xml_brief = xmlGetProp(n, (xmlChar *) "brief");
343 xmlChar *xml_sortkey = xmlGetProp(n, (xmlChar *) "sortkey");
344 xmlChar *xml_merge = xmlGetProp(n, (xmlChar *) "merge");
345 xmlChar *xml_type = xmlGetProp(n, (xmlChar *) "type");
346 xmlChar *xml_termlist = xmlGetProp(n, (xmlChar *) "termlist");
347 xmlChar *xml_rank = xmlGetProp(n, (xmlChar *) "rank");
348 xmlChar *xml_setting = xmlGetProp(n, (xmlChar *) "setting");
349 xmlChar *xml_mergekey = xmlGetProp(n, (xmlChar *) "mergekey");
351 enum conf_metadata_type type = Metadata_type_generic;
352 enum conf_metadata_merge merge = Metadata_merge_no;
353 enum conf_setting_type setting = Metadata_setting_no;
354 enum conf_sortkey_type sk_type = Metadata_sortkey_relevance;
355 enum conf_metadata_mergekey mergekey_type = Metadata_mergekey_no;
359 int sortkey_offset = 0;
361 // now do the parsing logic
364 yaz_log(YLOG_FATAL, "Must specify name in metadata element");
369 if (!strcmp((const char *) xml_brief, "yes"))
371 else if (strcmp((const char *) xml_brief, "no"))
373 yaz_log(YLOG_FATAL, "metadata/brief must be yes or no");
382 if (!strcmp((const char *) xml_termlist, "yes"))
384 else if (strcmp((const char *) xml_termlist, "no"))
386 yaz_log(YLOG_FATAL, "metadata/termlist must be yes or no");
394 rank = atoi((const char *) xml_rank);
400 if (!strcmp((const char *) xml_type, "generic"))
401 type = Metadata_type_generic;
402 else if (!strcmp((const char *) xml_type, "year"))
403 type = Metadata_type_year;
404 else if (!strcmp((const char *) xml_type, "date"))
405 type = Metadata_type_date;
409 "Unknown value for metadata/type: %s", xml_type);
414 type = Metadata_type_generic;
418 if (!strcmp((const char *) xml_merge, "no"))
419 merge = Metadata_merge_no;
420 else if (!strcmp((const char *) xml_merge, "unique"))
421 merge = Metadata_merge_unique;
422 else if (!strcmp((const char *) xml_merge, "longest"))
423 merge = Metadata_merge_longest;
424 else if (!strcmp((const char *) xml_merge, "range"))
425 merge = Metadata_merge_range;
426 else if (!strcmp((const char *) xml_merge, "all"))
427 merge = Metadata_merge_all;
431 "Unknown value for metadata/merge: %s", xml_merge);
436 merge = Metadata_merge_no;
440 if (!strcmp((const char *) xml_setting, "no"))
441 setting = Metadata_setting_no;
442 else if (!strcmp((const char *) xml_setting, "postproc"))
443 setting = Metadata_setting_postproc;
444 else if (!strcmp((const char *) xml_setting, "parameter"))
445 setting = Metadata_setting_parameter;
449 "Unknown value for medadata/setting: %s", xml_setting);
454 // add a sortkey if so specified
455 if (xml_sortkey && strcmp((const char *) xml_sortkey, "no"))
457 if (merge == Metadata_merge_no)
460 "Can't specify sortkey on a non-merged field");
463 if (!strcmp((const char *) xml_sortkey, "numeric"))
464 sk_type = Metadata_sortkey_numeric;
465 else if (!strcmp((const char *) xml_sortkey, "skiparticle"))
466 sk_type = Metadata_sortkey_skiparticle;
470 "Unknown sortkey in metadata element: %s",
474 sortkey_offset = sk_node;
476 conf_service_add_sortkey(service, sk_node,
477 (const char *) xml_name, sk_type);
484 if (xml_mergekey && strcmp((const char *) xml_mergekey, "no"))
486 mergekey_type = Metadata_mergekey_yes;
490 // metadata known, assign values
491 conf_service_add_metadata(service, md_node,
492 (const char *) xml_name,
493 type, merge, setting,
494 brief, termlist, rank, sortkey_offset,
499 xmlFree(xml_sortkey);
502 xmlFree(xml_termlist);
504 xmlFree(xml_setting);
509 yaz_log(YLOG_FATAL, "Bad element: %s", n->name);
516 /* metadata has been read.. Consider now settings */
517 init_settings(service);
518 for (pass = 1; pass <= 2; pass++)
520 for (n = node->children; n; n = n->next)
522 if (n->type != XML_ELEMENT_NODE)
524 if (!strcmp((const char *) n->name, "settings"))
526 xmlChar *src = xmlGetProp(n, (xmlChar *) "src");
529 WRBUF w = wrbuf_alloc();
530 conf_dir_path(config, w, (const char *) src);
531 settings_read_file(service, wrbuf_cstr(w), pass);
537 settings_read_node(service, n, pass);
546 static char *parse_settings(struct conf_config *config,
547 NMEM nmem, xmlNode *node)
549 xmlChar *src = xmlGetProp(node, (xmlChar *) "src");
554 WRBUF w = wrbuf_alloc();
555 conf_dir_path(config, w, (const char *) src);
556 r = nmem_strdup(nmem, wrbuf_cstr(w));
561 yaz_log(YLOG_FATAL, "Must specify src in targetprofile");
568 static void inherit_server_settings(struct conf_server *server)
570 struct conf_service *s;
571 for (s = server->service; s; s = s->next)
573 if (!s->dictionary) /* service has no config settings ? */
575 if (server->server_settings)
577 /* inherit settings from server */
579 settings_read_file(s, server->server_settings, 1);
580 settings_read_file(s, server->server_settings, 2);
584 yaz_log(YLOG_WARN, "service '%s' has no settings",
585 s->id ? s->id : "unnamed");
590 /* use relevance/sort/mergekey from server if not defined
591 for this service.. */
592 if (!s->relevance_pct)
594 if (server->relevance_pct)
596 s->relevance_pct = server->relevance_pct;
597 pp2_charset_incref(s->relevance_pct);
600 s->relevance_pct = pp2_charset_create(0);
605 if (server->sort_pct)
607 s->sort_pct = server->sort_pct;
608 pp2_charset_incref(s->sort_pct);
611 s->sort_pct = pp2_charset_create(0);
614 if (!s->mergekey_pct)
616 if (server->mergekey_pct)
618 s->mergekey_pct = server->mergekey_pct;
619 pp2_charset_incref(s->mergekey_pct);
622 s->mergekey_pct = pp2_charset_create(0);
627 static struct conf_server *server_create(struct conf_config *config,
628 NMEM nmem, xmlNode *node)
631 struct conf_server *server = nmem_malloc(nmem, sizeof(struct conf_server));
635 server->proxy_host = 0;
636 server->proxy_port = 0;
638 server->proxy_addr = 0;
641 server->relevance_pct = 0;
642 server->sort_pct = 0;
643 server->mergekey_pct = 0;
644 server->server_settings = 0;
646 for (n = node->children; n; n = n->next)
648 if (n->type != XML_ELEMENT_NODE)
650 if (!strcmp((const char *) n->name, "listen"))
652 xmlChar *port = xmlGetProp(n, (xmlChar *) "port");
653 xmlChar *host = xmlGetProp(n, (xmlChar *) "host");
655 server->port = atoi((const char *) port);
657 server->host = nmem_strdup(nmem, (const char *) host);
661 else if (!strcmp((const char *) n->name, "proxy"))
663 xmlChar *port = xmlGetProp(n, (xmlChar *) "port");
664 xmlChar *host = xmlGetProp(n, (xmlChar *) "host");
665 xmlChar *myurl = xmlGetProp(n, (xmlChar *) "myurl");
667 server->proxy_port = atoi((const char *) port);
669 server->proxy_host = nmem_strdup(nmem, (const char *) host);
671 server->myurl = nmem_strdup(nmem, (const char *) myurl);
676 else if (!strcmp((const char *) n->name, "settings"))
678 if (server->server_settings)
680 yaz_log(YLOG_FATAL, "Can't repeat 'settings'");
683 if (!(server->server_settings = parse_settings(config, nmem, n)))
686 else if (!strcmp((const char *) n->name, "relevance"))
688 server->relevance_pct = pp2_charset_create_xml(n);
689 if (!server->relevance_pct)
692 else if (!strcmp((const char *) n->name, "sort"))
694 server->sort_pct = pp2_charset_create_xml(n);
695 if (!server->sort_pct)
698 else if (!strcmp((const char *) n->name, "mergekey"))
700 server->mergekey_pct = pp2_charset_create_xml(n);
701 if (!server->mergekey_pct)
704 else if (!strcmp((const char *) n->name, "service"))
706 char *service_id = (char *)
707 xmlGetProp(n, (xmlChar *) "id");
709 struct conf_service **sp = &server->service;
710 for (; *sp; sp = &(*sp)->next)
711 if ((*sp)->id && service_id &&
712 0 == strcmp((*sp)->id, service_id))
714 yaz_log(YLOG_FATAL, "Duplicate service: %s", service_id);
717 else if (!(*sp)->id && !service_id)
719 yaz_log(YLOG_FATAL, "Duplicate unnamed service '%s'",
724 if (*sp) /* service already exist */
731 struct conf_service *s = service_create(config, n,
741 yaz_log(YLOG_FATAL, "Bad element: %s", n->name);
745 inherit_server_settings(server);
749 xsltStylesheet *conf_load_stylesheet(struct conf_config *config,
752 WRBUF w = wrbuf_alloc();
755 conf_dir_path(config, w, fname);
756 s = xsltParseStylesheetFile((xmlChar *) wrbuf_cstr(w));
761 static struct conf_targetprofiles *parse_targetprofiles(NMEM nmem,
764 struct conf_targetprofiles *r = nmem_malloc(nmem, sizeof(*r));
765 xmlChar *type = xmlGetProp(node, (xmlChar *) "type");
766 xmlChar *src = xmlGetProp(node, (xmlChar *) "src");
768 memset(r, 0, sizeof(*r));
772 if (!strcmp((const char *) type, "local"))
773 r->type = Targetprofiles_local;
776 yaz_log(YLOG_FATAL, "Unknown targetprofile type");
782 yaz_log(YLOG_FATAL, "Must specify type for targetprofile");
787 r->src = nmem_strdup(nmem, (const char *) src);
790 yaz_log(YLOG_FATAL, "Must specify src in targetprofile");
798 struct conf_service *locate_service(struct conf_server *server,
799 const char *service_id)
801 struct conf_service *s = server->service;
802 for (; s; s = s->next)
803 if (s->id && service_id && 0 == strcmp(s->id, service_id))
805 else if (!s->id && !service_id)
811 static int parse_config(struct conf_config *config, xmlNode *root)
815 for (n = root->children; n; n = n->next)
817 if (n->type != XML_ELEMENT_NODE)
819 if (!strcmp((const char *) n->name, "server"))
821 struct conf_server *tmp = server_create(config, config->nmem, n);
824 tmp->next = config->servers;
825 config->servers = tmp;
827 else if (!strcmp((const char *) n->name, "targetprofiles"))
829 yaz_log(YLOG_FATAL, "targetprofiles unsupported here. Must be part of service");
835 yaz_log(YLOG_FATAL, "Bad element: %s", n->name);
842 static int process_config_includes(struct conf_config *config, xmlNode *n);
844 static int config_include_one(struct conf_config *config, xmlNode **sib,
848 if (stat(path, &st) < 0)
850 yaz_log(YLOG_FATAL|YLOG_ERRNO, "stat %s", path);
855 if ((st.st_mode & S_IFMT) == S_IFREG)
857 xmlDoc *doc = xmlParseFile(path);
860 xmlNodePtr t = xmlDocGetRootElement(doc);
861 int ret = process_config_includes(config, t);
862 *sib = xmlAddNextSibling(*sib, xmlCopyNode(t, 1));
869 yaz_log(YLOG_FATAL, "Could not parse %s", path);
877 static int config_include_src(struct conf_config *config, xmlNode **np,
880 int ret = 0; /* return code. OK so far */
881 WRBUF w = wrbuf_alloc();
882 xmlNodePtr sib; /* our sibling that we append */
883 xmlNodePtr c; /* tmp node */
885 wrbuf_printf(w, " begin include src=\"%s\" ", src);
887 /* replace include element with a 'begin' comment */
888 sib = xmlNewComment((const xmlChar *) wrbuf_cstr(w));
889 xmlReplaceNode(*np, sib);
894 conf_dir_path(config, w, src);
899 glob(wrbuf_cstr(w), 0 /* flags */, 0 /* errfunc */, &glob_res);
901 for (i = 0; ret == 0 && i < glob_res.gl_pathc; i++)
903 const char *path = glob_res.gl_pathv[i];
904 ret = config_include_one(config, &sib, path);
909 ret = config_include_one(config, &sib, wrbuf_cstr(w));
912 wrbuf_printf(w, " end include src=\"%s\" ", src);
913 c = xmlNewComment((const xmlChar *) wrbuf_cstr(w));
914 sib = xmlAddNextSibling(sib, c);
921 static int process_config_includes(struct conf_config *config, xmlNode *n)
923 for (; n; n = n->next)
925 if (n->type == XML_ELEMENT_NODE)
927 if (!strcmp((const char *) n->name, "include"))
929 xmlChar *src = xmlGetProp(n, (xmlChar *) "src");
932 int ret = config_include_src(config, &n,
942 if (process_config_includes(config, n->children))
950 struct conf_config *config_create(const char *fname, int verbose)
952 xmlDoc *doc = xmlParseFile(fname);
956 NMEM nmem = nmem_create();
957 struct conf_config *config = nmem_malloc(nmem, sizeof(struct conf_config));
959 xmlSubstituteEntitiesDefault(1);
960 xmlLoadExtDtdDefaultValue = 1;
963 yaz_log(YLOG_FATAL, "Failed to read %s", fname);
971 config->confdir = wrbuf_alloc();
972 if ((p = strrchr(fname,
981 wrbuf_write(config->confdir, fname, len);
983 wrbuf_puts(config->confdir, "");
985 n = xmlDocGetRootElement(doc);
986 r = process_config_includes(config, n);
991 yaz_log(YLOG_LOG, "Configuration %s after include processing",
993 xmlDocFormatDump(yaz_log_file(), doc, 0);
995 r = parse_config(config, n);
1001 config_destroy(config);
1007 void server_destroy(struct conf_server *server)
1009 struct conf_service *s = server->service;
1012 struct conf_service *s_next = s->next;
1016 pp2_charset_destroy(server->relevance_pct);
1017 pp2_charset_destroy(server->sort_pct);
1018 pp2_charset_destroy(server->mergekey_pct);
1021 void config_destroy(struct conf_config *config)
1025 struct conf_server *server = config->servers;
1028 struct conf_server *s_next = server->next;
1029 server_destroy(server);
1032 wrbuf_destroy(config->confdir);
1033 nmem_destroy(config->nmem);
1037 void config_stop_listeners(struct conf_config *conf)
1039 struct conf_server *ser;
1040 for (ser = conf->servers; ser; ser = ser->next)
1041 http_close_server(ser);
1044 void config_start_databases(struct conf_config *conf)
1046 struct conf_server *ser;
1047 for (ser = conf->servers; ser; ser = ser->next)
1049 struct conf_service *s = ser->service;
1050 for (;s ; s = s->next)
1051 resolve_databases(s);
1055 int config_start_listeners(struct conf_config *conf,
1056 const char *listener_override)
1058 struct conf_server *ser;
1059 for (ser = conf->servers; ser; ser = ser->next)
1061 WRBUF w = wrbuf_alloc();
1063 if (listener_override)
1065 wrbuf_puts(w, listener_override);
1066 listener_override = 0; /* only first server is overriden */
1071 wrbuf_puts(w, ser->host);
1076 wrbuf_printf(w, "%d", ser->port);
1079 r = http_init(wrbuf_cstr(w), ser);
1085 if (ser->proxy_host || ser->proxy_port)
1087 if (ser->proxy_host)
1088 wrbuf_puts(w, ser->proxy_host);
1089 if (ser->proxy_port)
1093 wrbuf_printf(w, "%d", ser->proxy_port);
1097 http_set_proxyaddr(wrbuf_cstr(w), ser);
1106 * c-file-style: "Stroustrup"
1107 * indent-tabs-mode: nil
1109 * vim: shiftwidth=4 tabstop=8 expandtab