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
26 #include <libxml/parser.h>
27 #include <libxml/tree.h>
28 #include <libxslt/xslt.h>
29 #include <libxslt/transform.h>
30 #include <libxslt/xsltutils.h>
32 #include <yaz/yaz-util.h>
34 #include <yaz/snprintf.h>
35 #include <yaz/tpath.h>
38 #define USE_POSIX_GLOB 1
40 #define USE_POSIX_GLOB 0
47 #include <sys/types.h>
52 #include "pazpar2_config.h"
59 NMEM nmem; /* for conf_config and servers memory */
60 struct conf_server *servers;
65 static char *parse_settings(struct conf_config *config,
66 NMEM nmem, xmlNode *node);
68 static struct conf_targetprofiles *parse_targetprofiles(NMEM nmem,
72 struct conf_metadata * 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 if (!nmem || !metadata || !name)
87 metadata->name = nmem_strdup(nmem, name);
89 metadata->type = type;
91 // enforcing that type_year is always range_merge
92 if (metadata->type == Metadata_type_year)
93 metadata->merge = Metadata_merge_range;
95 metadata->merge = merge;
97 metadata->setting = setting;
98 metadata->brief = brief;
99 metadata->termlist = termlist;
100 metadata->rank = rank;
101 metadata->sortkey_offset = sortkey_offset;
102 metadata->mergekey = mt;
108 struct conf_sortkey * conf_sortkey_assign(NMEM nmem,
109 struct conf_sortkey * sortkey,
111 enum conf_sortkey_type type)
113 if (!nmem || !sortkey || !name)
116 sortkey->name = nmem_strdup(nmem, name);
117 sortkey->type = type;
123 struct conf_service * conf_service_create(struct conf_config *config,
124 int num_metadata, int num_sortkeys,
125 const char *service_id)
127 struct conf_service * service = 0;
128 NMEM nmem = nmem_create();
132 service = nmem_malloc(nmem, sizeof(struct conf_service));
133 service->nmem = nmem;
135 service->settings = 0;
136 service->databases = 0;
137 service->targetprofiles = 0;
138 service->config = config;
140 service->id = service_id ? nmem_strdup(nmem, service_id) : 0;
141 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;
148 service->sortkeys = 0;
149 if (service->num_sortkeys)
152 sizeof(struct conf_sortkey) * service->num_sortkeys);
153 service->dictionary = 0;
157 struct conf_metadata* conf_service_add_metadata(struct conf_service *service,
160 enum conf_metadata_type type,
161 enum conf_metadata_merge merge,
162 enum conf_setting_type setting,
167 enum conf_metadata_mergekey mt)
169 struct conf_metadata * md = 0;
171 if (!service || !service->metadata || !service->num_metadata
172 || field_id < 0 || !(field_id < service->num_metadata))
175 //md = &((service->metadata)[field_id]);
176 md = service->metadata + field_id;
177 md = conf_metadata_assign(service->nmem, md, name, type, merge, setting,
178 brief, termlist, rank, sortkey_offset,
184 struct conf_sortkey * conf_service_add_sortkey(struct conf_service *service,
187 enum conf_sortkey_type type)
189 struct conf_sortkey * sk = 0;
191 if (!service || !service->sortkeys || !service->num_sortkeys
192 || field_id < 0 || !(field_id < service->num_sortkeys))
195 //sk = &((service->sortkeys)[field_id]);
196 sk = service->sortkeys + field_id;
197 sk = conf_sortkey_assign(service->nmem, sk, name, type);
203 int conf_service_metadata_field_id(struct conf_service *service,
208 if (!service || !service->metadata || !service->num_metadata)
211 for(i = 0; i < service->num_metadata; i++) {
212 if (!strcmp(name, (service->metadata[i]).name))
220 int conf_service_sortkey_field_id(struct conf_service *service,
225 if (!service || !service->sortkeys || !service->num_sortkeys)
228 for(i = 0; i < service->num_sortkeys; i++) {
229 if (!strcmp(name, (service->sortkeys[i]).name))
236 static void conf_dir_path(struct conf_config *config, WRBUF w, const char *src)
238 if (config->confdir && wrbuf_len(config->confdir) > 0 &&
239 !yaz_is_abspath(src))
241 wrbuf_printf(w, "%s/%s", wrbuf_cstr(config->confdir), src);
247 static void service_destroy(struct conf_service *service)
251 pp2_charset_destroy(service->relevance_pct);
252 pp2_charset_destroy(service->sort_pct);
253 pp2_charset_destroy(service->mergekey_pct);
254 nmem_destroy(service->nmem);
258 static struct conf_service *service_create(struct conf_config *config,
259 xmlNode *node, const char *service_id)
265 struct conf_service *service = 0;
266 int num_metadata = 0;
267 int num_sortkeys = 0;
269 // count num_metadata and num_sortkeys
270 for (n = node->children; n; n = n->next)
271 if (n->type == XML_ELEMENT_NODE && !strcmp((const char *)
272 n->name, "metadata"))
274 xmlChar *sortkey = xmlGetProp(n, (xmlChar *) "sortkey");
276 if (sortkey && strcmp((const char *) sortkey, "no"))
281 service = conf_service_create(config,
282 num_metadata, num_sortkeys, service_id);
284 for (n = node->children; n; n = n->next)
286 if (n->type != XML_ELEMENT_NODE)
288 if (!strcmp((const char *) n->name, "settings"))
290 if (service->settings)
292 yaz_log(YLOG_FATAL, "Can't repeat 'settings'");
295 service->settings = parse_settings(config, service->nmem, n);
296 if (!service->settings)
299 else if (!strcmp((const char *) n->name, (const char *) "targetprofiles"))
301 if (service->targetprofiles)
303 yaz_log(YLOG_FATAL, "Can't repeat targetprofiles");
306 if (!(service->targetprofiles =
307 parse_targetprofiles(service->nmem, n)))
310 else if (!strcmp((const char *) n->name, (const char *) "metadata"))
312 xmlChar *xml_name = xmlGetProp(n, (xmlChar *) "name");
313 xmlChar *xml_brief = xmlGetProp(n, (xmlChar *) "brief");
314 xmlChar *xml_sortkey = xmlGetProp(n, (xmlChar *) "sortkey");
315 xmlChar *xml_merge = xmlGetProp(n, (xmlChar *) "merge");
316 xmlChar *xml_type = xmlGetProp(n, (xmlChar *) "type");
317 xmlChar *xml_termlist = xmlGetProp(n, (xmlChar *) "termlist");
318 xmlChar *xml_rank = xmlGetProp(n, (xmlChar *) "rank");
319 xmlChar *xml_setting = xmlGetProp(n, (xmlChar *) "setting");
320 xmlChar *xml_mergekey = xmlGetProp(n, (xmlChar *) "mergekey");
322 enum conf_metadata_type type = Metadata_type_generic;
323 enum conf_metadata_merge merge = Metadata_merge_no;
324 enum conf_setting_type setting = Metadata_setting_no;
325 enum conf_sortkey_type sk_type = Metadata_sortkey_relevance;
326 enum conf_metadata_mergekey mergekey_type = Metadata_mergekey_no;
330 int sortkey_offset = 0;
332 // now do the parsing logic
335 yaz_log(YLOG_FATAL, "Must specify name in metadata element");
340 if (!strcmp((const char *) xml_brief, "yes"))
342 else if (strcmp((const char *) xml_brief, "no"))
344 yaz_log(YLOG_FATAL, "metadata/brief must be yes or no");
353 if (!strcmp((const char *) xml_termlist, "yes"))
355 else if (strcmp((const char *) xml_termlist, "no"))
357 yaz_log(YLOG_FATAL, "metadata/termlist must be yes or no");
365 rank = atoi((const char *) xml_rank);
371 if (!strcmp((const char *) xml_type, "generic"))
372 type = Metadata_type_generic;
373 else if (!strcmp((const char *) xml_type, "year"))
374 type = Metadata_type_year;
375 else if (!strcmp((const char *) xml_type, "date"))
376 type = Metadata_type_date;
380 "Unknown value for metadata/type: %s", xml_type);
385 type = Metadata_type_generic;
389 if (!strcmp((const char *) xml_merge, "no"))
390 merge = Metadata_merge_no;
391 else if (!strcmp((const char *) xml_merge, "unique"))
392 merge = Metadata_merge_unique;
393 else if (!strcmp((const char *) xml_merge, "longest"))
394 merge = Metadata_merge_longest;
395 else if (!strcmp((const char *) xml_merge, "range"))
396 merge = Metadata_merge_range;
397 else if (!strcmp((const char *) xml_merge, "all"))
398 merge = Metadata_merge_all;
402 "Unknown value for metadata/merge: %s", xml_merge);
407 merge = Metadata_merge_no;
411 if (!strcmp((const char *) xml_setting, "no"))
412 setting = Metadata_setting_no;
413 else if (!strcmp((const char *) xml_setting, "postproc"))
414 setting = Metadata_setting_postproc;
415 else if (!strcmp((const char *) xml_setting, "parameter"))
416 setting = Metadata_setting_parameter;
420 "Unknown value for medadata/setting: %s", xml_setting);
425 // add a sortkey if so specified
426 if (xml_sortkey && strcmp((const char *) xml_sortkey, "no"))
428 if (merge == Metadata_merge_no)
431 "Can't specify sortkey on a non-merged field");
434 if (!strcmp((const char *) xml_sortkey, "numeric"))
435 sk_type = Metadata_sortkey_numeric;
436 else if (!strcmp((const char *) xml_sortkey, "skiparticle"))
437 sk_type = Metadata_sortkey_skiparticle;
441 "Unknown sortkey in metadata element: %s",
445 sortkey_offset = sk_node;
447 conf_service_add_sortkey(service, sk_node,
448 (const char *) xml_name, sk_type);
455 if (xml_mergekey && strcmp((const char *) xml_mergekey, "no"))
457 mergekey_type = Metadata_mergekey_yes;
461 // metadata known, assign values
462 conf_service_add_metadata(service, md_node,
463 (const char *) xml_name,
464 type, merge, setting,
465 brief, termlist, rank, sortkey_offset,
470 xmlFree(xml_sortkey);
473 xmlFree(xml_termlist);
475 xmlFree(xml_setting);
480 yaz_log(YLOG_FATAL, "Bad element: %s", n->name);
487 static char *parse_settings(struct conf_config *config,
488 NMEM nmem, xmlNode *node)
490 xmlChar *src = xmlGetProp(node, (xmlChar *) "src");
495 WRBUF w = wrbuf_alloc();
496 conf_dir_path(config, w, (const char *) src);
497 r = nmem_strdup(nmem, wrbuf_cstr(w));
502 yaz_log(YLOG_FATAL, "Must specify src in targetprofile");
509 static struct conf_server *parse_server(struct conf_config *config,
510 NMEM nmem, xmlNode *node)
513 struct conf_server *server = nmem_malloc(nmem, sizeof(struct conf_server));
517 server->proxy_host = 0;
518 server->proxy_port = 0;
520 server->proxy_addr = 0;
523 server->server_settings = 0;
524 server->relevance_pct = 0;
525 server->sort_pct = 0;
526 server->mergekey_pct = 0;
528 for (n = node->children; n; n = n->next)
530 if (n->type != XML_ELEMENT_NODE)
532 if (!strcmp((const char *) n->name, "listen"))
534 xmlChar *port = xmlGetProp(n, (xmlChar *) "port");
535 xmlChar *host = xmlGetProp(n, (xmlChar *) "host");
537 server->port = atoi((const char *) port);
539 server->host = nmem_strdup(nmem, (const char *) host);
543 else if (!strcmp((const char *) n->name, "proxy"))
545 xmlChar *port = xmlGetProp(n, (xmlChar *) "port");
546 xmlChar *host = xmlGetProp(n, (xmlChar *) "host");
547 xmlChar *myurl = xmlGetProp(n, (xmlChar *) "myurl");
549 server->proxy_port = atoi((const char *) port);
551 server->proxy_host = nmem_strdup(nmem, (const char *) host);
553 server->myurl = nmem_strdup(nmem, (const char *) myurl);
558 else if (!strcmp((const char *) n->name, "settings"))
560 if (server->server_settings)
562 yaz_log(YLOG_FATAL, "Can't repeat 'settings'");
565 if (!(server->server_settings = parse_settings(config, nmem, n)))
568 else if (!strcmp((const char *) n->name, "relevance"))
570 server->relevance_pct = pp2_charset_create_xml(n);
571 if (!server->relevance_pct)
574 else if (!strcmp((const char *) n->name, "sort"))
576 server->sort_pct = pp2_charset_create_xml(n);
577 if (!server->sort_pct)
580 else if (!strcmp((const char *) n->name, "mergekey"))
582 server->mergekey_pct = pp2_charset_create_xml(n);
583 if (!server->mergekey_pct)
586 else if (!strcmp((const char *) n->name, "service"))
588 char *service_id = (char *)
589 xmlGetProp(n, (xmlChar *) "id");
591 struct conf_service **sp = &server->service;
592 for (; *sp; sp = &(*sp)->next)
593 if ((*sp)->id && service_id &&
594 0 == strcmp((*sp)->id, service_id))
596 yaz_log(YLOG_FATAL, "Duplicate service: %s", service_id);
599 else if (!(*sp)->id && !service_id)
601 yaz_log(YLOG_FATAL, "Duplicate unnamed service");
605 if (*sp) /* service already exist */
609 struct conf_service *s = service_create(config, n, service_id);
612 if (server->relevance_pct)
614 s->relevance_pct = server->relevance_pct;
615 pp2_charset_incref(s->relevance_pct);
618 s->relevance_pct = pp2_charset_create(0);
620 if (server->sort_pct)
623 s->sort_pct = server->sort_pct;
624 pp2_charset_incref(s->sort_pct);
627 s->sort_pct = pp2_charset_create(0);
629 if (server->mergekey_pct)
631 s->mergekey_pct = server->mergekey_pct;
632 pp2_charset_incref(s->mergekey_pct);
635 s->mergekey_pct = pp2_charset_create(0);
643 yaz_log(YLOG_FATAL, "Bad element: %s", n->name);
650 xsltStylesheet *conf_load_stylesheet(struct conf_config *config,
653 WRBUF w = wrbuf_alloc();
656 conf_dir_path(config, w, fname);
657 s = xsltParseStylesheetFile((xmlChar *) wrbuf_cstr(w));
662 static struct conf_targetprofiles *parse_targetprofiles(NMEM nmem,
665 struct conf_targetprofiles *r = nmem_malloc(nmem, sizeof(*r));
666 xmlChar *type = xmlGetProp(node, (xmlChar *) "type");
667 xmlChar *src = xmlGetProp(node, (xmlChar *) "src");
669 memset(r, 0, sizeof(*r));
673 if (!strcmp((const char *) type, "local"))
674 r->type = Targetprofiles_local;
677 yaz_log(YLOG_FATAL, "Unknown targetprofile type");
683 yaz_log(YLOG_FATAL, "Must specify type for targetprofile");
688 r->src = nmem_strdup(nmem, (const char *) src);
691 yaz_log(YLOG_FATAL, "Must specify src in targetprofile");
699 struct conf_service *locate_service(struct conf_server *server,
700 const char *service_id)
702 struct conf_service *s = server->service;
703 for (; s; s = s->next)
704 if (s->id && service_id && 0 == strcmp(s->id, service_id))
706 else if (!s->id && !service_id)
712 static int parse_config(struct conf_config *config, xmlNode *root)
716 for (n = root->children; n; n = n->next)
718 if (n->type != XML_ELEMENT_NODE)
720 if (!strcmp((const char *) n->name, "server"))
722 struct conf_server *tmp = parse_server(config, config->nmem, n);
725 tmp->next = config->servers;
726 config->servers = tmp;
728 else if (!strcmp((const char *) n->name, "targetprofiles"))
730 yaz_log(YLOG_FATAL, "targetprofiles unsupported here. Must be part of service");
736 yaz_log(YLOG_FATAL, "Bad element: %s", n->name);
743 static int process_config_includes(struct conf_config *config, xmlNode *n);
745 static int config_include_one(struct conf_config *config, xmlNode **sib,
749 if (stat(path, &st) < 0)
751 yaz_log(YLOG_FATAL|YLOG_ERRNO, "stat %s", path);
756 if ((st.st_mode & S_IFMT) == S_IFREG)
758 xmlDoc *doc = xmlParseFile(path);
759 yaz_log(YLOG_LOG, "processing include path=%s", path);
762 xmlNodePtr t = xmlDocGetRootElement(doc);
763 int ret = process_config_includes(config, t);
764 *sib = xmlAddNextSibling(*sib, xmlCopyNode(t, 1));
771 yaz_log(YLOG_FATAL, "Could not parse %s", path);
779 static int config_include_src(struct conf_config *config, xmlNode **np,
782 int ret = 0; /* return code. OK so far */
783 WRBUF w = wrbuf_alloc();
784 xmlNodePtr sib; /* our sibling that we append */
785 xmlNodePtr c; /* tmp node */
787 wrbuf_printf(w, " begin include src=\"%s\" ", src);
789 /* replace include element with a 'begin' comment */
790 sib = xmlNewComment((const xmlChar *) wrbuf_cstr(w));
791 xmlReplaceNode(*np, sib);
796 conf_dir_path(config, w, src);
801 glob(wrbuf_cstr(w), 0 /* flags */, 0 /* errfunc */, &glob_res);
803 for (i = 0; ret == 0 && i < glob_res.gl_pathc; i++)
805 const char *path = glob_res.gl_pathv[i];
806 ret = config_include_one(config, &sib, path);
811 ret = config_include_one(config, &sib, wrbuf_cstr(w));
814 wrbuf_printf(w, " end include src=\"%s\" ", src);
815 c = xmlNewComment((const xmlChar *) wrbuf_cstr(w));
816 sib = xmlAddNextSibling(sib, c);
823 static int process_config_includes(struct conf_config *config, xmlNode *n)
825 for (; n; n = n->next)
827 if (n->type == XML_ELEMENT_NODE)
829 if (!strcmp((const char *) n->name, "include"))
831 xmlChar *src = xmlGetProp(n, (xmlChar *) "src");
834 int ret = config_include_src(config, &n,
844 if (process_config_includes(config, n->children))
852 struct conf_config *config_create(const char *fname)
854 xmlDoc *doc = xmlParseFile(fname);
858 NMEM nmem = nmem_create();
859 struct conf_config *config = nmem_malloc(nmem, sizeof(struct conf_config));
861 xmlSubstituteEntitiesDefault(1);
862 xmlLoadExtDtdDefaultValue = 1;
865 yaz_log(YLOG_FATAL, "Failed to read %s", fname);
872 config->confdir = wrbuf_alloc();
873 if ((p = strrchr(fname,
882 wrbuf_write(config->confdir, fname, len);
884 wrbuf_puts(config->confdir, "");
886 n = xmlDocGetRootElement(doc);
887 r = process_config_includes(config, n);
890 xmlDocFormatDump(stdout, doc, 0);
891 r = parse_config(config, n);
897 config_destroy(config);
903 void server_destroy(struct conf_server *server)
905 struct conf_service *s = server->service;
908 struct conf_service *s_next = s->next;
912 pp2_charset_destroy(server->relevance_pct);
913 pp2_charset_destroy(server->sort_pct);
914 pp2_charset_destroy(server->mergekey_pct);
917 void config_destroy(struct conf_config *config)
921 struct conf_server *server = config->servers;
924 struct conf_server *s_next = server->next;
925 server_destroy(server);
928 wrbuf_destroy(config->confdir);
929 nmem_destroy(config->nmem);
933 void config_read_settings(struct conf_config *config,
934 const char *path_override)
936 struct conf_service *s = config->servers->service;
937 for (;s ; s = s->next)
941 settings_read(s, path_override);
942 else if (s->settings)
943 settings_read(s, s->settings);
944 else if (config->servers->server_settings)
945 settings_read(s, config->servers->server_settings);
947 yaz_log(YLOG_WARN, "No settings for service");
951 void config_stop_listeners(struct conf_config *conf)
953 struct conf_server *ser;
954 for (ser = conf->servers; ser; ser = ser->next)
955 http_close_server(ser);
958 int config_start_listeners(struct conf_config *conf,
959 const char *listener_override,
960 const char *proxy_override)
962 struct conf_server *ser;
963 for (ser = conf->servers; ser; ser = ser->next)
965 WRBUF w = wrbuf_alloc();
967 if (listener_override)
969 wrbuf_puts(w, listener_override);
970 listener_override = 0; /* only first server is overriden */
975 wrbuf_puts(w, ser->host);
980 wrbuf_printf(w, "%d", ser->port);
983 r = http_init(wrbuf_cstr(w), ser);
990 wrbuf_puts(w, proxy_override);
991 else if (ser->proxy_host || ser->proxy_port)
994 wrbuf_puts(w, ser->proxy_host);
999 wrbuf_printf(w, "%d", ser->proxy_port);
1003 http_set_proxyaddr(wrbuf_cstr(w), ser);
1012 * c-file-style: "Stroustrup"
1013 * indent-tabs-mode: nil
1015 * vim: shiftwidth=4 tabstop=8 expandtab