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>
50 #include "pazpar2_config.h"
57 NMEM nmem; /* for conf_config and servers memory */
58 struct conf_server *servers;
63 static char *parse_settings(struct conf_config *config,
64 NMEM nmem, xmlNode *node);
66 static struct conf_targetprofiles *parse_targetprofiles(NMEM nmem,
70 struct conf_metadata * conf_metadata_assign(NMEM nmem,
71 struct conf_metadata * metadata,
73 enum conf_metadata_type type,
74 enum conf_metadata_merge merge,
75 enum conf_setting_type setting,
80 enum conf_metadata_mergekey mt)
82 if (!nmem || !metadata || !name)
85 metadata->name = nmem_strdup(nmem, name);
87 metadata->type = type;
89 // enforcing that type_year is always range_merge
90 if (metadata->type == Metadata_type_year)
91 metadata->merge = Metadata_merge_range;
93 metadata->merge = merge;
95 metadata->setting = setting;
96 metadata->brief = brief;
97 metadata->termlist = termlist;
98 metadata->rank = rank;
99 metadata->sortkey_offset = sortkey_offset;
100 metadata->mergekey = mt;
106 struct conf_sortkey * conf_sortkey_assign(NMEM nmem,
107 struct conf_sortkey * sortkey,
109 enum conf_sortkey_type type)
111 if (!nmem || !sortkey || !name)
114 sortkey->name = nmem_strdup(nmem, name);
115 sortkey->type = type;
121 struct conf_service * conf_service_create(struct conf_config *config,
122 int num_metadata, int num_sortkeys,
123 const char *service_id)
125 struct conf_service * service = 0;
126 NMEM nmem = nmem_create();
130 service = nmem_malloc(nmem, sizeof(struct conf_service));
131 service->nmem = nmem;
133 service->settings = 0;
134 service->databases = 0;
135 service->targetprofiles = 0;
136 service->config = config;
138 service->id = service_id ? nmem_strdup(nmem, service_id) : 0;
139 service->num_metadata = num_metadata;
140 service->metadata = 0;
141 if (service->num_metadata)
144 sizeof(struct conf_metadata) * service->num_metadata);
145 service->num_sortkeys = num_sortkeys;
146 service->sortkeys = 0;
147 if (service->num_sortkeys)
150 sizeof(struct conf_sortkey) * service->num_sortkeys);
151 service->dictionary = 0;
155 struct conf_metadata* conf_service_add_metadata(struct conf_service *service,
158 enum conf_metadata_type type,
159 enum conf_metadata_merge merge,
160 enum conf_setting_type setting,
165 enum conf_metadata_mergekey mt)
167 struct conf_metadata * md = 0;
169 if (!service || !service->metadata || !service->num_metadata
170 || field_id < 0 || !(field_id < service->num_metadata))
173 //md = &((service->metadata)[field_id]);
174 md = service->metadata + field_id;
175 md = conf_metadata_assign(service->nmem, md, name, type, merge, setting,
176 brief, termlist, rank, sortkey_offset,
182 struct conf_sortkey * conf_service_add_sortkey(struct conf_service *service,
185 enum conf_sortkey_type type)
187 struct conf_sortkey * sk = 0;
189 if (!service || !service->sortkeys || !service->num_sortkeys
190 || field_id < 0 || !(field_id < service->num_sortkeys))
193 //sk = &((service->sortkeys)[field_id]);
194 sk = service->sortkeys + field_id;
195 sk = conf_sortkey_assign(service->nmem, sk, name, type);
201 int conf_service_metadata_field_id(struct conf_service *service,
206 if (!service || !service->metadata || !service->num_metadata)
209 for(i = 0; i < service->num_metadata; i++) {
210 if (!strcmp(name, (service->metadata[i]).name))
218 int conf_service_sortkey_field_id(struct conf_service *service,
223 if (!service || !service->sortkeys || !service->num_sortkeys)
226 for(i = 0; i < service->num_sortkeys; i++) {
227 if (!strcmp(name, (service->sortkeys[i]).name))
234 static void conf_dir_path(struct conf_config *config, WRBUF w, const char *src)
236 if (config->confdir && wrbuf_len(config->confdir) > 0 &&
237 !yaz_is_abspath(src))
239 wrbuf_printf(w, "%s/%s", wrbuf_cstr(config->confdir), src);
245 static void service_destroy(struct conf_service *service)
249 pp2_charset_destroy(service->relevance_pct);
250 pp2_charset_destroy(service->sort_pct);
251 pp2_charset_destroy(service->mergekey_pct);
252 nmem_destroy(service->nmem);
256 static struct conf_service *service_create(struct conf_config *config,
257 xmlNode *node, const char *service_id)
263 struct conf_service *service = 0;
264 int num_metadata = 0;
265 int num_sortkeys = 0;
267 // count num_metadata and num_sortkeys
268 for (n = node->children; n; n = n->next)
269 if (n->type == XML_ELEMENT_NODE && !strcmp((const char *)
270 n->name, "metadata"))
272 xmlChar *sortkey = xmlGetProp(n, (xmlChar *) "sortkey");
274 if (sortkey && strcmp((const char *) sortkey, "no"))
279 service = conf_service_create(config,
280 num_metadata, num_sortkeys, service_id);
282 for (n = node->children; n; n = n->next)
284 if (n->type != XML_ELEMENT_NODE)
286 if (!strcmp((const char *) n->name, "settings"))
288 if (service->settings)
290 yaz_log(YLOG_FATAL, "Can't repeat 'settings'");
293 service->settings = parse_settings(config, service->nmem, n);
294 if (!service->settings)
297 else if (!strcmp((const char *) n->name, (const char *) "targetprofiles"))
299 if (service->targetprofiles)
301 yaz_log(YLOG_FATAL, "Can't repeat targetprofiles");
304 if (!(service->targetprofiles =
305 parse_targetprofiles(service->nmem, n)))
308 else if (!strcmp((const char *) n->name, (const char *) "metadata"))
310 xmlChar *xml_name = xmlGetProp(n, (xmlChar *) "name");
311 xmlChar *xml_brief = xmlGetProp(n, (xmlChar *) "brief");
312 xmlChar *xml_sortkey = xmlGetProp(n, (xmlChar *) "sortkey");
313 xmlChar *xml_merge = xmlGetProp(n, (xmlChar *) "merge");
314 xmlChar *xml_type = xmlGetProp(n, (xmlChar *) "type");
315 xmlChar *xml_termlist = xmlGetProp(n, (xmlChar *) "termlist");
316 xmlChar *xml_rank = xmlGetProp(n, (xmlChar *) "rank");
317 xmlChar *xml_setting = xmlGetProp(n, (xmlChar *) "setting");
318 xmlChar *xml_mergekey = xmlGetProp(n, (xmlChar *) "mergekey");
320 enum conf_metadata_type type = Metadata_type_generic;
321 enum conf_metadata_merge merge = Metadata_merge_no;
322 enum conf_setting_type setting = Metadata_setting_no;
323 enum conf_sortkey_type sk_type = Metadata_sortkey_relevance;
324 enum conf_metadata_mergekey mergekey_type = Metadata_mergekey_no;
328 int sortkey_offset = 0;
330 // now do the parsing logic
333 yaz_log(YLOG_FATAL, "Must specify name in metadata element");
338 if (!strcmp((const char *) xml_brief, "yes"))
340 else if (strcmp((const char *) xml_brief, "no"))
342 yaz_log(YLOG_FATAL, "metadata/brief must be yes or no");
351 if (!strcmp((const char *) xml_termlist, "yes"))
353 else if (strcmp((const char *) xml_termlist, "no"))
355 yaz_log(YLOG_FATAL, "metadata/termlist must be yes or no");
363 rank = atoi((const char *) xml_rank);
369 if (!strcmp((const char *) xml_type, "generic"))
370 type = Metadata_type_generic;
371 else if (!strcmp((const char *) xml_type, "year"))
372 type = Metadata_type_year;
373 else if (!strcmp((const char *) xml_type, "date"))
374 type = Metadata_type_date;
378 "Unknown value for metadata/type: %s", xml_type);
383 type = Metadata_type_generic;
387 if (!strcmp((const char *) xml_merge, "no"))
388 merge = Metadata_merge_no;
389 else if (!strcmp((const char *) xml_merge, "unique"))
390 merge = Metadata_merge_unique;
391 else if (!strcmp((const char *) xml_merge, "longest"))
392 merge = Metadata_merge_longest;
393 else if (!strcmp((const char *) xml_merge, "range"))
394 merge = Metadata_merge_range;
395 else if (!strcmp((const char *) xml_merge, "all"))
396 merge = Metadata_merge_all;
400 "Unknown value for metadata/merge: %s", xml_merge);
405 merge = Metadata_merge_no;
409 if (!strcmp((const char *) xml_setting, "no"))
410 setting = Metadata_setting_no;
411 else if (!strcmp((const char *) xml_setting, "postproc"))
412 setting = Metadata_setting_postproc;
413 else if (!strcmp((const char *) xml_setting, "parameter"))
414 setting = Metadata_setting_parameter;
418 "Unknown value for medadata/setting: %s", xml_setting);
423 // add a sortkey if so specified
424 if (xml_sortkey && strcmp((const char *) xml_sortkey, "no"))
426 if (merge == Metadata_merge_no)
429 "Can't specify sortkey on a non-merged field");
432 if (!strcmp((const char *) xml_sortkey, "numeric"))
433 sk_type = Metadata_sortkey_numeric;
434 else if (!strcmp((const char *) xml_sortkey, "skiparticle"))
435 sk_type = Metadata_sortkey_skiparticle;
439 "Unknown sortkey in metadata element: %s",
443 sortkey_offset = sk_node;
445 conf_service_add_sortkey(service, sk_node,
446 (const char *) xml_name, sk_type);
453 if (xml_mergekey && strcmp((const char *) xml_mergekey, "no"))
455 mergekey_type = Metadata_mergekey_yes;
459 // metadata known, assign values
460 conf_service_add_metadata(service, md_node,
461 (const char *) xml_name,
462 type, merge, setting,
463 brief, termlist, rank, sortkey_offset,
468 xmlFree(xml_sortkey);
471 xmlFree(xml_termlist);
473 xmlFree(xml_setting);
478 yaz_log(YLOG_FATAL, "Bad element: %s", n->name);
485 static char *parse_settings(struct conf_config *config,
486 NMEM nmem, xmlNode *node)
488 xmlChar *src = xmlGetProp(node, (xmlChar *) "src");
493 WRBUF w = wrbuf_alloc();
494 conf_dir_path(config, w, (const char *) src);
495 r = nmem_strdup(nmem, wrbuf_cstr(w));
500 yaz_log(YLOG_FATAL, "Must specify src in targetprofile");
507 static struct conf_server *parse_server(struct conf_config *config,
508 NMEM nmem, xmlNode *node)
511 struct conf_server *server = nmem_malloc(nmem, sizeof(struct conf_server));
515 server->proxy_host = 0;
516 server->proxy_port = 0;
518 server->proxy_addr = 0;
521 server->server_settings = 0;
522 server->relevance_pct = 0;
523 server->sort_pct = 0;
524 server->mergekey_pct = 0;
526 for (n = node->children; n; n = n->next)
528 if (n->type != XML_ELEMENT_NODE)
530 if (!strcmp((const char *) n->name, "listen"))
532 xmlChar *port = xmlGetProp(n, (xmlChar *) "port");
533 xmlChar *host = xmlGetProp(n, (xmlChar *) "host");
535 server->port = atoi((const char *) port);
537 server->host = nmem_strdup(nmem, (const char *) host);
541 else if (!strcmp((const char *) n->name, "proxy"))
543 xmlChar *port = xmlGetProp(n, (xmlChar *) "port");
544 xmlChar *host = xmlGetProp(n, (xmlChar *) "host");
545 xmlChar *myurl = xmlGetProp(n, (xmlChar *) "myurl");
547 server->proxy_port = atoi((const char *) port);
549 server->proxy_host = nmem_strdup(nmem, (const char *) host);
551 server->myurl = nmem_strdup(nmem, (const char *) myurl);
556 else if (!strcmp((const char *) n->name, "settings"))
558 if (server->server_settings)
560 yaz_log(YLOG_FATAL, "Can't repeat 'settings'");
563 if (!(server->server_settings = parse_settings(config, nmem, n)))
566 else if (!strcmp((const char *) n->name, "relevance"))
568 server->relevance_pct = pp2_charset_create_xml(n);
569 if (!server->relevance_pct)
572 else if (!strcmp((const char *) n->name, "sort"))
574 server->sort_pct = pp2_charset_create_xml(n);
575 if (!server->sort_pct)
578 else if (!strcmp((const char *) n->name, "mergekey"))
580 server->mergekey_pct = pp2_charset_create_xml(n);
581 if (!server->mergekey_pct)
584 else if (!strcmp((const char *) n->name, "service"))
586 char *service_id = (char *)
587 xmlGetProp(n, (xmlChar *) "id");
589 struct conf_service **sp = &server->service;
590 for (; *sp; sp = &(*sp)->next)
591 if ((*sp)->id && service_id &&
592 0 == strcmp((*sp)->id, service_id))
594 yaz_log(YLOG_FATAL, "Duplicate service: %s", service_id);
597 else if (!(*sp)->id && !service_id)
599 yaz_log(YLOG_FATAL, "Duplicate unnamed service");
603 if (*sp) /* service already exist */
607 struct conf_service *s = service_create(config, n, service_id);
610 if (server->relevance_pct)
612 s->relevance_pct = server->relevance_pct;
613 pp2_charset_incref(s->relevance_pct);
616 s->relevance_pct = pp2_charset_create(0);
618 if (server->sort_pct)
621 s->sort_pct = server->sort_pct;
622 pp2_charset_incref(s->sort_pct);
625 s->sort_pct = pp2_charset_create(0);
627 if (server->mergekey_pct)
629 s->mergekey_pct = server->mergekey_pct;
630 pp2_charset_incref(s->mergekey_pct);
633 s->mergekey_pct = pp2_charset_create(0);
641 yaz_log(YLOG_FATAL, "Bad element: %s", n->name);
648 xsltStylesheet *conf_load_stylesheet(struct conf_config *config,
651 WRBUF w = wrbuf_alloc();
654 conf_dir_path(config, w, fname);
655 s = xsltParseStylesheetFile((xmlChar *) wrbuf_cstr(w));
660 static struct conf_targetprofiles *parse_targetprofiles(NMEM nmem,
663 struct conf_targetprofiles *r = nmem_malloc(nmem, sizeof(*r));
664 xmlChar *type = xmlGetProp(node, (xmlChar *) "type");
665 xmlChar *src = xmlGetProp(node, (xmlChar *) "src");
667 memset(r, 0, sizeof(*r));
671 if (!strcmp((const char *) type, "local"))
672 r->type = Targetprofiles_local;
675 yaz_log(YLOG_FATAL, "Unknown targetprofile type");
681 yaz_log(YLOG_FATAL, "Must specify type for targetprofile");
686 r->src = nmem_strdup(nmem, (const char *) src);
689 yaz_log(YLOG_FATAL, "Must specify src in targetprofile");
697 struct conf_service *locate_service(struct conf_server *server,
698 const char *service_id)
700 struct conf_service *s = server->service;
701 for (; s; s = s->next)
702 if (s->id && service_id && 0 == strcmp(s->id, service_id))
704 else if (!s->id && !service_id)
710 static int parse_config(struct conf_config *config, xmlNode *root)
714 for (n = root->children; n; n = n->next)
716 if (n->type != XML_ELEMENT_NODE)
718 if (!strcmp((const char *) n->name, "server"))
720 struct conf_server *tmp = parse_server(config, config->nmem, n);
723 tmp->next = config->servers;
724 config->servers = tmp;
726 else if (!strcmp((const char *) n->name, "targetprofiles"))
728 yaz_log(YLOG_FATAL, "targetprofiles unsupported here. Must be part of service");
734 yaz_log(YLOG_FATAL, "Bad element: %s", n->name);
741 static int process_config_includes(struct conf_config *config, xmlNode *n);
743 static int config_include_one(struct conf_config *config, xmlNode **sib,
747 if (stat(path, &st) < 0)
749 yaz_log(YLOG_FATAL|YLOG_ERRNO, "stat %s", path);
754 if (S_ISREG(st.st_mode))
756 xmlDoc *doc = xmlParseFile(path);
757 yaz_log(YLOG_LOG, "processing include path=%s", path);
760 xmlNodePtr t = xmlDocGetRootElement(doc);
761 int ret = process_config_includes(config, t);
762 *sib = xmlAddNextSibling(*sib, xmlCopyNode(t, 1));
769 yaz_log(YLOG_FATAL, "Could not parse %s", path);
777 static int config_include_src(struct conf_config *config, xmlNode **np,
780 int ret = 0; /* return code. OK so far */
781 WRBUF w = wrbuf_alloc();
782 xmlNodePtr sib; /* our sibling that we append */
783 xmlNodePtr c; /* tmp node */
785 wrbuf_printf(w, " begin include src=\"%s\" ", src);
787 /* replace include element with a 'begin' comment */
788 sib = xmlNewComment((const xmlChar *) wrbuf_cstr(w));
789 xmlReplaceNode(*np, sib);
794 conf_dir_path(config, w, src);
799 glob(wrbuf_cstr(w), 0 /* flags */, 0 /* errfunc */, &glob_res);
801 for (i = 0; ret == 0 && i < glob_res.gl_pathc; i++)
803 const char *path = glob_res.gl_pathv[i];
804 ret = config_include_one(config, &sib, path);
809 ret = config_include_one(config, &sib, wrbuf_cstr(w));
812 wrbuf_printf(w, " end include src=\"%s\" ", src);
813 c = xmlNewComment((const xmlChar *) wrbuf_cstr(w));
814 sib = xmlAddNextSibling(sib, c);
821 static int process_config_includes(struct conf_config *config, xmlNode *n)
823 for (; n; n = n->next)
825 if (n->type == XML_ELEMENT_NODE)
827 if (!strcmp((const char *) n->name, "include"))
829 xmlChar *src = xmlGetProp(n, (xmlChar *) "src");
832 int ret = config_include_src(config, &n,
842 if (process_config_includes(config, n->children))
850 struct conf_config *config_create(const char *fname)
852 xmlDoc *doc = xmlParseFile(fname);
856 NMEM nmem = nmem_create();
857 struct conf_config *config = nmem_malloc(nmem, sizeof(struct conf_config));
859 xmlSubstituteEntitiesDefault(1);
860 xmlLoadExtDtdDefaultValue = 1;
863 yaz_log(YLOG_FATAL, "Failed to read %s", fname);
870 config->confdir = wrbuf_alloc();
871 if ((p = strrchr(fname,
880 wrbuf_write(config->confdir, fname, len);
882 wrbuf_puts(config->confdir, "");
884 n = xmlDocGetRootElement(doc);
885 r = process_config_includes(config, n);
888 xmlDocFormatDump(stdout, doc, 0);
889 r = parse_config(config, n);
895 config_destroy(config);
901 void server_destroy(struct conf_server *server)
903 struct conf_service *s = server->service;
906 struct conf_service *s_next = s->next;
910 pp2_charset_destroy(server->relevance_pct);
911 pp2_charset_destroy(server->sort_pct);
912 pp2_charset_destroy(server->mergekey_pct);
915 void config_destroy(struct conf_config *config)
919 struct conf_server *server = config->servers;
922 struct conf_server *s_next = server->next;
923 server_destroy(server);
926 wrbuf_destroy(config->confdir);
927 nmem_destroy(config->nmem);
931 void config_read_settings(struct conf_config *config,
932 const char *path_override)
934 struct conf_service *s = config->servers->service;
935 for (;s ; s = s->next)
939 settings_read(s, path_override);
940 else if (s->settings)
941 settings_read(s, s->settings);
942 else if (config->servers->server_settings)
943 settings_read(s, config->servers->server_settings);
945 yaz_log(YLOG_WARN, "No settings for service");
949 void config_stop_listeners(struct conf_config *conf)
951 struct conf_server *ser;
952 for (ser = conf->servers; ser; ser = ser->next)
953 http_close_server(ser);
956 int config_start_listeners(struct conf_config *conf,
957 const char *listener_override,
958 const char *proxy_override)
960 struct conf_server *ser;
961 for (ser = conf->servers; ser; ser = ser->next)
963 WRBUF w = wrbuf_alloc();
965 if (listener_override)
967 wrbuf_puts(w, listener_override);
968 listener_override = 0; /* only first server is overriden */
973 wrbuf_puts(w, ser->host);
978 wrbuf_printf(w, "%d", ser->port);
981 r = http_init(wrbuf_cstr(w), ser);
988 wrbuf_puts(w, proxy_override);
989 else if (ser->proxy_host || ser->proxy_port)
992 wrbuf_puts(w, ser->proxy_host);
997 wrbuf_printf(w, "%d", ser->proxy_port);
1001 http_set_proxyaddr(wrbuf_cstr(w), ser);
1010 * c-file-style: "Stroustrup"
1011 * indent-tabs-mode: nil
1013 * vim: shiftwidth=4 tabstop=8 expandtab