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 #include "pazpar2_config.h"
40 static char confdir[256] = ".";
42 struct conf_config *config1 = 0;
45 static char *parse_settings(NMEM nmem, xmlNode *node);
48 struct conf_metadata * conf_metadata_assign(NMEM nmem,
49 struct conf_metadata * metadata,
51 enum conf_metadata_type type,
52 enum conf_metadata_merge merge,
53 enum conf_setting_type setting,
58 enum conf_metadata_mergekey mt)
60 if (!nmem || !metadata || !name)
63 metadata->name = nmem_strdup(nmem, name);
65 metadata->type = type;
67 // enforcing that type_year is always range_merge
68 if (metadata->type == Metadata_type_year)
69 metadata->merge = Metadata_merge_range;
71 metadata->merge = merge;
73 metadata->setting = setting;
74 metadata->brief = brief;
75 metadata->termlist = termlist;
76 metadata->rank = rank;
77 metadata->sortkey_offset = sortkey_offset;
78 metadata->mergekey = mt;
84 struct conf_sortkey * conf_sortkey_assign(NMEM nmem,
85 struct conf_sortkey * sortkey,
87 enum conf_sortkey_type type)
89 if (!nmem || !sortkey || !name)
92 sortkey->name = nmem_strdup(nmem, name);
99 struct conf_service * conf_service_create(int num_metadata, int num_sortkeys,
100 const char *service_id)
102 struct conf_service * service = 0;
103 NMEM nmem = nmem_create();
107 service = nmem_malloc(nmem, sizeof(struct conf_service));
108 service->nmem = nmem;
110 service->settings = 0;
111 service->databases = 0;
113 service->id = service_id ? nmem_strdup(nmem, service_id) : 0;
114 service->num_metadata = num_metadata;
115 service->metadata = 0;
116 if (service->num_metadata)
119 sizeof(struct conf_metadata) * service->num_metadata);
120 service->num_sortkeys = num_sortkeys;
121 service->sortkeys = 0;
122 if (service->num_sortkeys)
125 sizeof(struct conf_sortkey) * service->num_sortkeys);
126 service->dictionary = 0;
130 struct conf_metadata* conf_service_add_metadata(struct conf_service *service,
133 enum conf_metadata_type type,
134 enum conf_metadata_merge merge,
135 enum conf_setting_type setting,
140 enum conf_metadata_mergekey mt)
142 struct conf_metadata * md = 0;
144 if (!service || !service->metadata || !service->num_metadata
145 || field_id < 0 || !(field_id < service->num_metadata))
148 //md = &((service->metadata)[field_id]);
149 md = service->metadata + field_id;
150 md = conf_metadata_assign(service->nmem, md, name, type, merge, setting,
151 brief, termlist, rank, sortkey_offset,
157 struct conf_sortkey * conf_service_add_sortkey(struct conf_service *service,
160 enum conf_sortkey_type type)
162 struct conf_sortkey * sk = 0;
164 if (!service || !service->sortkeys || !service->num_sortkeys
165 || field_id < 0 || !(field_id < service->num_sortkeys))
168 //sk = &((service->sortkeys)[field_id]);
169 sk = service->sortkeys + field_id;
170 sk = conf_sortkey_assign(service->nmem, sk, name, type);
176 int conf_service_metadata_field_id(struct conf_service *service,
181 if (!service || !service->metadata || !service->num_metadata)
184 for(i = 0; i < service->num_metadata; i++) {
185 if (!strcmp(name, (service->metadata[i]).name))
193 int conf_service_sortkey_field_id(struct conf_service *service,
198 if (!service || !service->sortkeys || !service->num_sortkeys)
201 for(i = 0; i < service->num_sortkeys; i++) {
202 if (!strcmp(name, (service->sortkeys[i]).name))
211 /* Code to parse configuration file */
212 /* ==================================================== */
214 static struct conf_service *parse_service(xmlNode *node, const char *service_id)
220 struct conf_service *service = 0;
221 int num_metadata = 0;
222 int num_sortkeys = 0;
224 // count num_metadata and num_sortkeys
225 for (n = node->children; n; n = n->next)
226 if (n->type == XML_ELEMENT_NODE && !strcmp((const char *)
227 n->name, "metadata"))
229 xmlChar *sortkey = xmlGetProp(n, (xmlChar *) "sortkey");
231 if (sortkey && strcmp((const char *) sortkey, "no"))
236 service = conf_service_create(num_metadata, num_sortkeys, service_id);
238 for (n = node->children; n; n = n->next)
240 if (n->type != XML_ELEMENT_NODE)
242 if (!strcmp((const char *) n->name, "settings"))
244 if (service->settings)
246 yaz_log(YLOG_FATAL, "Can't repeat 'settings'");
249 service->settings = parse_settings(service->nmem, n);
250 if (!service->settings)
253 else if (!strcmp((const char *) n->name, (const char *) "metadata"))
255 xmlChar *xml_name = xmlGetProp(n, (xmlChar *) "name");
256 xmlChar *xml_brief = xmlGetProp(n, (xmlChar *) "brief");
257 xmlChar *xml_sortkey = xmlGetProp(n, (xmlChar *) "sortkey");
258 xmlChar *xml_merge = xmlGetProp(n, (xmlChar *) "merge");
259 xmlChar *xml_type = xmlGetProp(n, (xmlChar *) "type");
260 xmlChar *xml_termlist = xmlGetProp(n, (xmlChar *) "termlist");
261 xmlChar *xml_rank = xmlGetProp(n, (xmlChar *) "rank");
262 xmlChar *xml_setting = xmlGetProp(n, (xmlChar *) "setting");
263 xmlChar *xml_mergekey = xmlGetProp(n, (xmlChar *) "mergekey");
265 enum conf_metadata_type type = Metadata_type_generic;
266 enum conf_metadata_merge merge = Metadata_merge_no;
267 enum conf_setting_type setting = Metadata_setting_no;
268 enum conf_sortkey_type sk_type = Metadata_sortkey_relevance;
269 enum conf_metadata_mergekey mergekey_type = Metadata_mergekey_no;
273 int sortkey_offset = 0;
275 // now do the parsing logic
278 yaz_log(YLOG_FATAL, "Must specify name in metadata element");
283 if (!strcmp((const char *) xml_brief, "yes"))
285 else if (strcmp((const char *) xml_brief, "no"))
287 yaz_log(YLOG_FATAL, "metadata/brief must be yes or no");
296 if (!strcmp((const char *) xml_termlist, "yes"))
298 else if (strcmp((const char *) xml_termlist, "no"))
300 yaz_log(YLOG_FATAL, "metadata/termlist must be yes or no");
308 rank = atoi((const char *) xml_rank);
314 if (!strcmp((const char *) xml_type, "generic"))
315 type = Metadata_type_generic;
316 else if (!strcmp((const char *) xml_type, "year"))
317 type = Metadata_type_year;
318 else if (!strcmp((const char *) xml_type, "date"))
319 type = Metadata_type_date;
323 "Unknown value for metadata/type: %s", xml_type);
328 type = Metadata_type_generic;
332 if (!strcmp((const char *) xml_merge, "no"))
333 merge = Metadata_merge_no;
334 else if (!strcmp((const char *) xml_merge, "unique"))
335 merge = Metadata_merge_unique;
336 else if (!strcmp((const char *) xml_merge, "longest"))
337 merge = Metadata_merge_longest;
338 else if (!strcmp((const char *) xml_merge, "range"))
339 merge = Metadata_merge_range;
340 else if (!strcmp((const char *) xml_merge, "all"))
341 merge = Metadata_merge_all;
345 "Unknown value for metadata/merge: %s", xml_merge);
350 merge = Metadata_merge_no;
354 if (!strcmp((const char *) xml_setting, "no"))
355 setting = Metadata_setting_no;
356 else if (!strcmp((const char *) xml_setting, "postproc"))
357 setting = Metadata_setting_postproc;
358 else if (!strcmp((const char *) xml_setting, "parameter"))
359 setting = Metadata_setting_parameter;
363 "Unknown value for medadata/setting: %s", xml_setting);
368 // add a sortkey if so specified
369 if (xml_sortkey && strcmp((const char *) xml_sortkey, "no"))
371 if (merge == Metadata_merge_no)
374 "Can't specify sortkey on a non-merged field");
377 if (!strcmp((const char *) xml_sortkey, "numeric"))
378 sk_type = Metadata_sortkey_numeric;
379 else if (!strcmp((const char *) xml_sortkey, "skiparticle"))
380 sk_type = Metadata_sortkey_skiparticle;
384 "Unknown sortkey in metadata element: %s",
388 sortkey_offset = sk_node;
390 conf_service_add_sortkey(
392 (const char *) xml_name, sk_type);
399 if (xml_mergekey && strcmp((const char *) xml_mergekey, "no"))
401 mergekey_type = Metadata_mergekey_yes;
405 // metadata known, assign values
406 conf_service_add_metadata(service, md_node,
407 (const char *) xml_name,
408 type, merge, setting,
409 brief, termlist, rank, sortkey_offset,
414 xmlFree(xml_sortkey);
417 xmlFree(xml_termlist);
419 xmlFree(xml_setting);
424 yaz_log(YLOG_FATAL, "Bad element: %s", n->name);
431 static char *parse_settings(NMEM nmem, xmlNode *node)
433 xmlChar *src = xmlGetProp(node, (xmlChar *) "src");
438 if (yaz_is_abspath((const char *) src))
439 r = nmem_strdup(nmem, (const char *) src);
442 r = nmem_malloc(nmem,
443 strlen(confdir) + strlen((const char *) src) + 2);
444 sprintf(r, "%s/%s", confdir, src);
449 yaz_log(YLOG_FATAL, "Must specify src in targetprofile");
456 static struct conf_server *parse_server(NMEM nmem, xmlNode *node)
459 struct conf_server *server = nmem_malloc(nmem, sizeof(struct conf_server));
463 server->proxy_host = 0;
464 server->proxy_port = 0;
468 server->server_settings = 0;
469 server->relevance_pct = 0;
470 server->sort_pct = 0;
471 server->mergekey_pct = 0;
473 for (n = node->children; n; n = n->next)
475 if (n->type != XML_ELEMENT_NODE)
477 if (!strcmp((const char *) n->name, "listen"))
479 xmlChar *port = xmlGetProp(n, (xmlChar *) "port");
480 xmlChar *host = xmlGetProp(n, (xmlChar *) "host");
482 server->port = atoi((const char *) port);
484 server->host = nmem_strdup(nmem, (const char *) host);
488 else if (!strcmp((const char *) n->name, "proxy"))
490 xmlChar *port = xmlGetProp(n, (xmlChar *) "port");
491 xmlChar *host = xmlGetProp(n, (xmlChar *) "host");
492 xmlChar *myurl = xmlGetProp(n, (xmlChar *) "myurl");
494 server->proxy_port = atoi((const char *) port);
496 server->proxy_host = nmem_strdup(nmem, (const char *) host);
498 server->myurl = nmem_strdup(nmem, (const char *) myurl);
503 else if (!strcmp((const char *) n->name, "settings"))
505 if (server->server_settings)
507 yaz_log(YLOG_FATAL, "Can't repeat 'settings'");
510 if (!(server->server_settings = parse_settings(nmem, n)))
513 else if (!strcmp((const char *) n->name, "relevance"))
515 server->relevance_pct = pp2_charset_create_xml(n);
516 if (!server->relevance_pct)
519 else if (!strcmp((const char *) n->name, "sort"))
521 server->sort_pct = pp2_charset_create_xml(n);
522 if (!server->sort_pct)
525 else if (!strcmp((const char *) n->name, "mergekey"))
527 server->mergekey_pct = pp2_charset_create_xml(n);
528 if (!server->mergekey_pct)
531 else if (!strcmp((const char *) n->name, "service"))
533 const char *service_id = (const char *)
534 xmlGetProp(n, (xmlChar *) "id");
536 struct conf_service **sp = &server->service;
537 for (; *sp; sp = &(*sp)->next)
538 if ((*sp)->id && service_id &&
539 0 == strcmp((*sp)->id, service_id))
541 yaz_log(YLOG_FATAL, "Duplicate service: %s", service_id);
544 else if (!(*sp)->id && !service_id)
546 yaz_log(YLOG_FATAL, "Duplicate unnamed service");
550 if (*sp) /* service already exist */
554 struct conf_service *s = parse_service(n, service_id);
557 s->relevance_pct = server->relevance_pct ?
558 server->relevance_pct : pp2_charset_create(0);
559 s->sort_pct = server->sort_pct ?
560 server->sort_pct : pp2_charset_create(0);
561 s->mergekey_pct = server->mergekey_pct ?
562 server->mergekey_pct : pp2_charset_create(0);
569 yaz_log(YLOG_FATAL, "Bad element: %s", n->name);
576 xsltStylesheet *conf_load_stylesheet(const char *fname)
579 if (yaz_is_abspath(fname))
580 yaz_snprintf(path, sizeof(path), fname);
582 yaz_snprintf(path, sizeof(path), "%s/%s", confdir, fname);
583 return xsltParseStylesheetFile((xmlChar *) path);
586 static struct conf_targetprofiles *parse_targetprofiles(NMEM nmem,
589 struct conf_targetprofiles *r = nmem_malloc(nmem, sizeof(*r));
590 xmlChar *type = xmlGetProp(node, (xmlChar *) "type");
591 xmlChar *src = xmlGetProp(node, (xmlChar *) "src");
593 memset(r, 0, sizeof(*r));
597 if (!strcmp((const char *) type, "local"))
598 r->type = Targetprofiles_local;
601 yaz_log(YLOG_FATAL, "Unknown targetprofile type");
607 yaz_log(YLOG_FATAL, "Must specify type for targetprofile");
612 r->src = nmem_strdup(nmem, (const char *) src);
615 yaz_log(YLOG_FATAL, "Must specify src in targetprofile");
623 struct conf_service *locate_service(struct conf_server *server,
624 const char *service_id)
626 struct conf_service *s = server->service;
627 for (; s; s = s->next)
628 if (s->id && service_id && 0 == strcmp(s->id, service_id))
630 else if (!s->id && !service_id)
636 static struct conf_config *parse_config(xmlNode *root)
638 NMEM nmem = nmem_create();
640 struct conf_config *r = nmem_malloc(nmem, sizeof(struct conf_config));
644 r->targetprofiles = 0;
646 for (n = root->children; n; n = n->next)
648 if (n->type != XML_ELEMENT_NODE)
650 if (!strcmp((const char *) n->name, "server"))
652 struct conf_server *tmp = parse_server(nmem, n);
655 tmp->next = r->servers;
658 else if (!strcmp((const char *) n->name, "targetprofiles"))
660 // It would be fun to be able to fix this sometime
661 if (r->targetprofiles)
663 yaz_log(YLOG_FATAL, "Can't repeat targetprofiles");
666 if (!(r->targetprofiles = parse_targetprofiles(nmem, n)))
671 yaz_log(YLOG_FATAL, "Bad element: %s", n->name);
678 struct conf_config *read_config(const char *fname)
680 xmlDoc *doc = xmlParseFile(fname);
682 struct conf_config *config;
684 xmlSubstituteEntitiesDefault(1);
685 xmlLoadExtDtdDefaultValue = 1;
688 yaz_log(YLOG_FATAL, "Failed to read %s", fname);
691 if ((p = strrchr(fname,
700 if (len >= sizeof(confdir))
701 len = sizeof(confdir)-1;
702 strncpy(confdir, fname, len);
705 config = parse_config(xmlDocGetRootElement(doc));
711 void config_read_settings(struct conf_config *config,
712 const char *path_override)
714 struct conf_service *s = config->servers->service;
715 for (;s ; s = s->next)
719 settings_read(s, path_override);
720 else if (s->settings)
721 settings_read(s, s->settings);
722 else if (config->servers->server_settings)
723 settings_read(s, config->servers->server_settings);
725 yaz_log(YLOG_WARN, "No settings for service");
732 * c-file-style: "Stroustrup"
733 * indent-tabs-mode: nil
735 * vim: shiftwidth=4 tabstop=8 expandtab