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>
37 #define CONFIG_NOEXTERNS
38 #include "pazpar2_config.h"
41 static char confdir[256] = ".";
43 struct conf_config *config = 0;
46 static char *parse_settings(NMEM nmem, xmlNode *node);
49 struct conf_metadata * conf_metadata_assign(NMEM nmem,
50 struct conf_metadata * metadata,
52 enum conf_metadata_type type,
53 enum conf_metadata_merge merge,
54 enum conf_setting_type setting,
59 enum conf_metadata_mergekey mt)
61 if (!nmem || !metadata || !name)
64 metadata->name = nmem_strdup(nmem, name);
66 metadata->type = type;
68 // enforcing that type_year is always range_merge
69 if (metadata->type == Metadata_type_year)
70 metadata->merge = Metadata_merge_range;
72 metadata->merge = merge;
74 metadata->setting = setting;
75 metadata->brief = brief;
76 metadata->termlist = termlist;
77 metadata->rank = rank;
78 metadata->sortkey_offset = sortkey_offset;
79 metadata->mergekey = mt;
85 struct conf_sortkey * conf_sortkey_assign(NMEM nmem,
86 struct conf_sortkey * sortkey,
88 enum conf_sortkey_type type)
90 if (!nmem || !sortkey || !name)
93 sortkey->name = nmem_strdup(nmem, name);
100 struct conf_service * conf_service_create(int num_metadata, int num_sortkeys,
101 const char *service_id)
103 struct conf_service * service = 0;
104 NMEM nmem = nmem_create();
108 service = nmem_malloc(nmem, sizeof(struct conf_service));
109 service->nmem = nmem;
111 service->settings = 0;
112 service->databases = 0;
114 service->id = service_id ? nmem_strdup(nmem, service_id) : 0;
115 service->num_metadata = num_metadata;
116 service->metadata = 0;
117 if (service->num_metadata)
120 sizeof(struct conf_metadata) * service->num_metadata);
121 service->num_sortkeys = num_sortkeys;
122 service->sortkeys = 0;
123 if (service->num_sortkeys)
126 sizeof(struct conf_sortkey) * service->num_sortkeys);
127 service->dictionary = 0;
131 struct conf_metadata* conf_service_add_metadata(struct conf_service *service,
134 enum conf_metadata_type type,
135 enum conf_metadata_merge merge,
136 enum conf_setting_type setting,
141 enum conf_metadata_mergekey mt)
143 struct conf_metadata * md = 0;
145 if (!service || !service->metadata || !service->num_metadata
146 || field_id < 0 || !(field_id < service->num_metadata))
149 //md = &((service->metadata)[field_id]);
150 md = service->metadata + field_id;
151 md = conf_metadata_assign(service->nmem, md, name, type, merge, setting,
152 brief, termlist, rank, sortkey_offset,
158 struct conf_sortkey * conf_service_add_sortkey(struct conf_service *service,
161 enum conf_sortkey_type type)
163 struct conf_sortkey * sk = 0;
165 if (!service || !service->sortkeys || !service->num_sortkeys
166 || field_id < 0 || !(field_id < service->num_sortkeys))
169 //sk = &((service->sortkeys)[field_id]);
170 sk = service->sortkeys + field_id;
171 sk = conf_sortkey_assign(service->nmem, sk, name, type);
177 int conf_service_metadata_field_id(struct conf_service *service,
182 if (!service || !service->metadata || !service->num_metadata)
185 for(i = 0; i < service->num_metadata; i++) {
186 if (!strcmp(name, (service->metadata[i]).name))
194 int conf_service_sortkey_field_id(struct conf_service *service,
199 if (!service || !service->sortkeys || !service->num_sortkeys)
202 for(i = 0; i < service->num_sortkeys; i++) {
203 if (!strcmp(name, (service->sortkeys[i]).name))
212 /* Code to parse configuration file */
213 /* ==================================================== */
215 static struct conf_service *parse_service(xmlNode *node, const char *service_id)
221 struct conf_service *service = 0;
222 int num_metadata = 0;
223 int num_sortkeys = 0;
225 // count num_metadata and num_sortkeys
226 for (n = node->children; n; n = n->next)
227 if (n->type == XML_ELEMENT_NODE && !strcmp((const char *)
228 n->name, "metadata"))
230 xmlChar *sortkey = xmlGetProp(n, (xmlChar *) "sortkey");
232 if (sortkey && strcmp((const char *) sortkey, "no"))
237 service = conf_service_create(num_metadata, num_sortkeys, service_id);
239 for (n = node->children; n; n = n->next)
241 if (n->type != XML_ELEMENT_NODE)
243 if (!strcmp((const char *) n->name, "settings"))
245 if (service->settings)
247 yaz_log(YLOG_FATAL, "Can't repeat 'settings'");
250 service->settings = parse_settings(service->nmem, n);
251 if (!service->settings)
254 else if (!strcmp((const char *) n->name, (const char *) "metadata"))
256 xmlChar *xml_name = xmlGetProp(n, (xmlChar *) "name");
257 xmlChar *xml_brief = xmlGetProp(n, (xmlChar *) "brief");
258 xmlChar *xml_sortkey = xmlGetProp(n, (xmlChar *) "sortkey");
259 xmlChar *xml_merge = xmlGetProp(n, (xmlChar *) "merge");
260 xmlChar *xml_type = xmlGetProp(n, (xmlChar *) "type");
261 xmlChar *xml_termlist = xmlGetProp(n, (xmlChar *) "termlist");
262 xmlChar *xml_rank = xmlGetProp(n, (xmlChar *) "rank");
263 xmlChar *xml_setting = xmlGetProp(n, (xmlChar *) "setting");
264 xmlChar *xml_mergekey = xmlGetProp(n, (xmlChar *) "mergekey");
266 enum conf_metadata_type type = Metadata_type_generic;
267 enum conf_metadata_merge merge = Metadata_merge_no;
268 enum conf_setting_type setting = Metadata_setting_no;
269 enum conf_sortkey_type sk_type = Metadata_sortkey_relevance;
270 enum conf_metadata_mergekey mergekey_type = Metadata_mergekey_no;
274 int sortkey_offset = 0;
276 // now do the parsing logic
279 yaz_log(YLOG_FATAL, "Must specify name in metadata element");
284 if (!strcmp((const char *) xml_brief, "yes"))
286 else if (strcmp((const char *) xml_brief, "no"))
288 yaz_log(YLOG_FATAL, "metadata/brief must be yes or no");
297 if (!strcmp((const char *) xml_termlist, "yes"))
299 else if (strcmp((const char *) xml_termlist, "no"))
301 yaz_log(YLOG_FATAL, "metadata/termlist must be yes or no");
309 rank = atoi((const char *) xml_rank);
315 if (!strcmp((const char *) xml_type, "generic"))
316 type = Metadata_type_generic;
317 else if (!strcmp((const char *) xml_type, "year"))
318 type = Metadata_type_year;
319 else if (!strcmp((const char *) xml_type, "date"))
320 type = Metadata_type_date;
324 "Unknown value for metadata/type: %s", xml_type);
329 type = Metadata_type_generic;
333 if (!strcmp((const char *) xml_merge, "no"))
334 merge = Metadata_merge_no;
335 else if (!strcmp((const char *) xml_merge, "unique"))
336 merge = Metadata_merge_unique;
337 else if (!strcmp((const char *) xml_merge, "longest"))
338 merge = Metadata_merge_longest;
339 else if (!strcmp((const char *) xml_merge, "range"))
340 merge = Metadata_merge_range;
341 else if (!strcmp((const char *) xml_merge, "all"))
342 merge = Metadata_merge_all;
346 "Unknown value for metadata/merge: %s", xml_merge);
351 merge = Metadata_merge_no;
355 if (!strcmp((const char *) xml_setting, "no"))
356 setting = Metadata_setting_no;
357 else if (!strcmp((const char *) xml_setting, "postproc"))
358 setting = Metadata_setting_postproc;
359 else if (!strcmp((const char *) xml_setting, "parameter"))
360 setting = Metadata_setting_parameter;
364 "Unknown value for medadata/setting: %s", xml_setting);
369 // add a sortkey if so specified
370 if (xml_sortkey && strcmp((const char *) xml_sortkey, "no"))
372 if (merge == Metadata_merge_no)
375 "Can't specify sortkey on a non-merged field");
378 if (!strcmp((const char *) xml_sortkey, "numeric"))
379 sk_type = Metadata_sortkey_numeric;
380 else if (!strcmp((const char *) xml_sortkey, "skiparticle"))
381 sk_type = Metadata_sortkey_skiparticle;
385 "Unknown sortkey in metadata element: %s",
389 sortkey_offset = sk_node;
391 conf_service_add_sortkey(
393 (const char *) xml_name, sk_type);
400 if (xml_mergekey && strcmp((const char *) xml_mergekey, "no"))
402 mergekey_type = Metadata_mergekey_yes;
406 // metadata known, assign values
407 conf_service_add_metadata(service, md_node,
408 (const char *) xml_name,
409 type, merge, setting,
410 brief, termlist, rank, sortkey_offset,
415 xmlFree(xml_sortkey);
418 xmlFree(xml_termlist);
420 xmlFree(xml_setting);
425 yaz_log(YLOG_FATAL, "Bad element: %s", n->name);
432 static char *parse_settings(NMEM nmem, xmlNode *node)
434 xmlChar *src = xmlGetProp(node, (xmlChar *) "src");
439 if (yaz_is_abspath((const char *) src))
440 r = nmem_strdup(nmem, (const char *) src);
443 r = nmem_malloc(nmem,
444 strlen(confdir) + strlen((const char *) src) + 2);
445 sprintf(r, "%s/%s", confdir, src);
450 yaz_log(YLOG_FATAL, "Must specify src in targetprofile");
457 static struct conf_server *parse_server(NMEM nmem, xmlNode *node)
460 struct conf_server *server = nmem_malloc(nmem, sizeof(struct conf_server));
464 server->proxy_host = 0;
465 server->proxy_port = 0;
469 server->server_settings = 0;
470 server->relevance_pct = 0;
471 server->sort_pct = 0;
472 server->mergekey_pct = 0;
474 for (n = node->children; n; n = n->next)
476 if (n->type != XML_ELEMENT_NODE)
478 if (!strcmp((const char *) n->name, "listen"))
480 xmlChar *port = xmlGetProp(n, (xmlChar *) "port");
481 xmlChar *host = xmlGetProp(n, (xmlChar *) "host");
483 server->port = atoi((const char *) port);
485 server->host = nmem_strdup(nmem, (const char *) host);
489 else if (!strcmp((const char *) n->name, "proxy"))
491 xmlChar *port = xmlGetProp(n, (xmlChar *) "port");
492 xmlChar *host = xmlGetProp(n, (xmlChar *) "host");
493 xmlChar *myurl = xmlGetProp(n, (xmlChar *) "myurl");
495 server->proxy_port = atoi((const char *) port);
497 server->proxy_host = nmem_strdup(nmem, (const char *) host);
499 server->myurl = nmem_strdup(nmem, (const char *) myurl);
504 else if (!strcmp((const char *) n->name, "settings"))
506 if (server->server_settings)
508 yaz_log(YLOG_FATAL, "Can't repeat 'settings'");
511 if (!(server->server_settings = parse_settings(nmem, n)))
514 else if (!strcmp((const char *) n->name, "relevance"))
516 server->relevance_pct = pp2_charset_create_xml(n);
517 if (!server->relevance_pct)
520 else if (!strcmp((const char *) n->name, "sort"))
522 server->sort_pct = pp2_charset_create_xml(n);
523 if (!server->sort_pct)
526 else if (!strcmp((const char *) n->name, "mergekey"))
528 server->mergekey_pct = pp2_charset_create_xml(n);
529 if (!server->mergekey_pct)
532 else if (!strcmp((const char *) n->name, "service"))
534 const char *service_id = (const char *)
535 xmlGetProp(n, (xmlChar *) "id");
537 struct conf_service **sp = &server->service;
538 for (; *sp; sp = &(*sp)->next)
539 if ((*sp)->id && service_id &&
540 0 == strcmp((*sp)->id, service_id))
542 yaz_log(YLOG_FATAL, "Duplicate service: %s", service_id);
545 else if (!(*sp)->id && !service_id)
547 yaz_log(YLOG_FATAL, "Duplicate unnamed service");
551 if (*sp) /* service already exist */
555 struct conf_service *s = parse_service(n, service_id);
562 yaz_log(YLOG_FATAL, "Bad element: %s", n->name);
566 if (!server->relevance_pct)
567 server->relevance_pct = pp2_charset_create(0);
568 if (!server->sort_pct)
569 server->sort_pct = pp2_charset_create(0);
570 if (!server->mergekey_pct)
571 server->mergekey_pct = pp2_charset_create(0);
575 xsltStylesheet *conf_load_stylesheet(const char *fname)
578 if (yaz_is_abspath(fname))
579 yaz_snprintf(path, sizeof(path), fname);
581 yaz_snprintf(path, sizeof(path), "%s/%s", confdir, fname);
582 return xsltParseStylesheetFile((xmlChar *) path);
585 static struct conf_targetprofiles *parse_targetprofiles(NMEM nmem,
588 struct conf_targetprofiles *r = nmem_malloc(nmem, sizeof(*r));
589 xmlChar *type = xmlGetProp(node, (xmlChar *) "type");
590 xmlChar *src = xmlGetProp(node, (xmlChar *) "src");
592 memset(r, 0, sizeof(*r));
596 if (!strcmp((const char *) type, "local"))
597 r->type = Targetprofiles_local;
600 yaz_log(YLOG_FATAL, "Unknown targetprofile type");
606 yaz_log(YLOG_FATAL, "Must specify type for targetprofile");
611 r->src = nmem_strdup(nmem, (const char *) src);
614 yaz_log(YLOG_FATAL, "Must specify src in targetprofile");
622 struct conf_service *locate_service(const char *service_id)
624 struct conf_service *s = config->servers->service;
625 for (; s; s = s->next)
626 if (s->id && service_id && 0 == strcmp(s->id, service_id))
628 else if (!s->id && !service_id)
634 static struct conf_config *parse_config(xmlNode *root)
636 NMEM nmem = nmem_create();
638 struct conf_config *r = nmem_malloc(nmem, sizeof(struct conf_config));
642 r->targetprofiles = 0;
644 for (n = root->children; n; n = n->next)
646 if (n->type != XML_ELEMENT_NODE)
648 if (!strcmp((const char *) n->name, "server"))
650 struct conf_server *tmp = parse_server(nmem, n);
653 tmp->next = r->servers;
656 else if (!strcmp((const char *) n->name, "targetprofiles"))
658 // It would be fun to be able to fix this sometime
659 if (r->targetprofiles)
661 yaz_log(YLOG_FATAL, "Can't repeat targetprofiles");
664 if (!(r->targetprofiles = parse_targetprofiles(nmem, n)))
669 yaz_log(YLOG_FATAL, "Bad element: %s", n->name);
676 int read_config(const char *fname)
678 xmlDoc *doc = xmlParseFile(fname);
681 xmlSubstituteEntitiesDefault(1);
682 xmlLoadExtDtdDefaultValue = 1;
685 yaz_log(YLOG_FATAL, "Failed to read %s", fname);
688 if ((p = strrchr(fname,
697 if (len >= sizeof(confdir))
698 len = sizeof(confdir)-1;
699 strncpy(confdir, fname, len);
702 config = parse_config(xmlDocGetRootElement(doc));
711 void config_read_settings(const char *path_override)
713 struct conf_service *s = config->servers->service;
714 for (;s ; s = s->next)
718 settings_read(s, path_override);
719 else if (s->settings)
720 settings_read(s, s->settings);
721 else if (config->servers->server_settings)
722 settings_read(s, config->servers->server_settings);
724 yaz_log(YLOG_WARN, "No settings for service");
731 * c-file-style: "Stroustrup"
732 * indent-tabs-mode: nil
734 * vim: shiftwidth=4 tabstop=8 expandtab