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 WRBUF confdir = 0;
42 static char *parse_settings(NMEM nmem, xmlNode *node);
44 static struct conf_targetprofiles *parse_targetprofiles(NMEM nmem,
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;
112 service->targetprofiles = 0;
115 service->id = service_id ? nmem_strdup(nmem, service_id) : 0;
116 service->num_metadata = num_metadata;
117 service->metadata = 0;
118 if (service->num_metadata)
121 sizeof(struct conf_metadata) * service->num_metadata);
122 service->num_sortkeys = num_sortkeys;
123 service->sortkeys = 0;
124 if (service->num_sortkeys)
127 sizeof(struct conf_sortkey) * service->num_sortkeys);
128 service->dictionary = 0;
132 struct conf_metadata* conf_service_add_metadata(struct conf_service *service,
135 enum conf_metadata_type type,
136 enum conf_metadata_merge merge,
137 enum conf_setting_type setting,
142 enum conf_metadata_mergekey mt)
144 struct conf_metadata * md = 0;
146 if (!service || !service->metadata || !service->num_metadata
147 || field_id < 0 || !(field_id < service->num_metadata))
150 //md = &((service->metadata)[field_id]);
151 md = service->metadata + field_id;
152 md = conf_metadata_assign(service->nmem, md, name, type, merge, setting,
153 brief, termlist, rank, sortkey_offset,
159 struct conf_sortkey * conf_service_add_sortkey(struct conf_service *service,
162 enum conf_sortkey_type type)
164 struct conf_sortkey * sk = 0;
166 if (!service || !service->sortkeys || !service->num_sortkeys
167 || field_id < 0 || !(field_id < service->num_sortkeys))
170 //sk = &((service->sortkeys)[field_id]);
171 sk = service->sortkeys + field_id;
172 sk = conf_sortkey_assign(service->nmem, sk, name, type);
178 int conf_service_metadata_field_id(struct conf_service *service,
183 if (!service || !service->metadata || !service->num_metadata)
186 for(i = 0; i < service->num_metadata; i++) {
187 if (!strcmp(name, (service->metadata[i]).name))
195 int conf_service_sortkey_field_id(struct conf_service *service,
200 if (!service || !service->sortkeys || !service->num_sortkeys)
203 for(i = 0; i < service->num_sortkeys; i++) {
204 if (!strcmp(name, (service->sortkeys[i]).name))
213 /* Code to parse configuration file */
214 /* ==================================================== */
216 static struct conf_service *parse_service(xmlNode *node, const char *service_id)
222 struct conf_service *service = 0;
223 int num_metadata = 0;
224 int num_sortkeys = 0;
226 // count num_metadata and num_sortkeys
227 for (n = node->children; n; n = n->next)
228 if (n->type == XML_ELEMENT_NODE && !strcmp((const char *)
229 n->name, "metadata"))
231 xmlChar *sortkey = xmlGetProp(n, (xmlChar *) "sortkey");
233 if (sortkey && strcmp((const char *) sortkey, "no"))
238 service = conf_service_create(num_metadata, num_sortkeys, service_id);
240 for (n = node->children; n; n = n->next)
242 if (n->type != XML_ELEMENT_NODE)
244 if (!strcmp((const char *) n->name, "settings"))
246 if (service->settings)
248 yaz_log(YLOG_FATAL, "Can't repeat 'settings'");
251 service->settings = parse_settings(service->nmem, n);
252 if (!service->settings)
255 else if (!strcmp((const char *) n->name, (const char *) "targetprofiles"))
257 if (service->targetprofiles)
259 yaz_log(YLOG_FATAL, "Can't repeat targetprofiles");
262 if (!(service->targetprofiles =
263 parse_targetprofiles(service->nmem, n)))
266 else if (!strcmp((const char *) n->name, (const char *) "metadata"))
268 xmlChar *xml_name = xmlGetProp(n, (xmlChar *) "name");
269 xmlChar *xml_brief = xmlGetProp(n, (xmlChar *) "brief");
270 xmlChar *xml_sortkey = xmlGetProp(n, (xmlChar *) "sortkey");
271 xmlChar *xml_merge = xmlGetProp(n, (xmlChar *) "merge");
272 xmlChar *xml_type = xmlGetProp(n, (xmlChar *) "type");
273 xmlChar *xml_termlist = xmlGetProp(n, (xmlChar *) "termlist");
274 xmlChar *xml_rank = xmlGetProp(n, (xmlChar *) "rank");
275 xmlChar *xml_setting = xmlGetProp(n, (xmlChar *) "setting");
276 xmlChar *xml_mergekey = xmlGetProp(n, (xmlChar *) "mergekey");
278 enum conf_metadata_type type = Metadata_type_generic;
279 enum conf_metadata_merge merge = Metadata_merge_no;
280 enum conf_setting_type setting = Metadata_setting_no;
281 enum conf_sortkey_type sk_type = Metadata_sortkey_relevance;
282 enum conf_metadata_mergekey mergekey_type = Metadata_mergekey_no;
286 int sortkey_offset = 0;
288 // now do the parsing logic
291 yaz_log(YLOG_FATAL, "Must specify name in metadata element");
296 if (!strcmp((const char *) xml_brief, "yes"))
298 else if (strcmp((const char *) xml_brief, "no"))
300 yaz_log(YLOG_FATAL, "metadata/brief must be yes or no");
309 if (!strcmp((const char *) xml_termlist, "yes"))
311 else if (strcmp((const char *) xml_termlist, "no"))
313 yaz_log(YLOG_FATAL, "metadata/termlist must be yes or no");
321 rank = atoi((const char *) xml_rank);
327 if (!strcmp((const char *) xml_type, "generic"))
328 type = Metadata_type_generic;
329 else if (!strcmp((const char *) xml_type, "year"))
330 type = Metadata_type_year;
331 else if (!strcmp((const char *) xml_type, "date"))
332 type = Metadata_type_date;
336 "Unknown value for metadata/type: %s", xml_type);
341 type = Metadata_type_generic;
345 if (!strcmp((const char *) xml_merge, "no"))
346 merge = Metadata_merge_no;
347 else if (!strcmp((const char *) xml_merge, "unique"))
348 merge = Metadata_merge_unique;
349 else if (!strcmp((const char *) xml_merge, "longest"))
350 merge = Metadata_merge_longest;
351 else if (!strcmp((const char *) xml_merge, "range"))
352 merge = Metadata_merge_range;
353 else if (!strcmp((const char *) xml_merge, "all"))
354 merge = Metadata_merge_all;
358 "Unknown value for metadata/merge: %s", xml_merge);
363 merge = Metadata_merge_no;
367 if (!strcmp((const char *) xml_setting, "no"))
368 setting = Metadata_setting_no;
369 else if (!strcmp((const char *) xml_setting, "postproc"))
370 setting = Metadata_setting_postproc;
371 else if (!strcmp((const char *) xml_setting, "parameter"))
372 setting = Metadata_setting_parameter;
376 "Unknown value for medadata/setting: %s", xml_setting);
381 // add a sortkey if so specified
382 if (xml_sortkey && strcmp((const char *) xml_sortkey, "no"))
384 if (merge == Metadata_merge_no)
387 "Can't specify sortkey on a non-merged field");
390 if (!strcmp((const char *) xml_sortkey, "numeric"))
391 sk_type = Metadata_sortkey_numeric;
392 else if (!strcmp((const char *) xml_sortkey, "skiparticle"))
393 sk_type = Metadata_sortkey_skiparticle;
397 "Unknown sortkey in metadata element: %s",
401 sortkey_offset = sk_node;
403 conf_service_add_sortkey(
405 (const char *) xml_name, sk_type);
412 if (xml_mergekey && strcmp((const char *) xml_mergekey, "no"))
414 mergekey_type = Metadata_mergekey_yes;
418 // metadata known, assign values
419 conf_service_add_metadata(service, md_node,
420 (const char *) xml_name,
421 type, merge, setting,
422 brief, termlist, rank, sortkey_offset,
427 xmlFree(xml_sortkey);
430 xmlFree(xml_termlist);
432 xmlFree(xml_setting);
437 yaz_log(YLOG_FATAL, "Bad element: %s", n->name);
444 static char *parse_settings(NMEM nmem, xmlNode *node)
446 xmlChar *src = xmlGetProp(node, (xmlChar *) "src");
451 if (yaz_is_abspath((const char *) src))
452 r = nmem_strdup(nmem, (const char *) src);
455 r = nmem_malloc(nmem,
456 wrbuf_len(confdir) + strlen((const char *) src) + 2);
457 sprintf(r, "%s/%s", wrbuf_cstr(confdir), src);
462 yaz_log(YLOG_FATAL, "Must specify src in targetprofile");
469 static struct conf_server *parse_server(NMEM nmem, xmlNode *node)
472 struct conf_server *server = nmem_malloc(nmem, sizeof(struct conf_server));
476 server->proxy_host = 0;
477 server->proxy_port = 0;
479 server->proxy_addr = 0;
482 server->server_settings = 0;
483 server->relevance_pct = 0;
484 server->sort_pct = 0;
485 server->mergekey_pct = 0;
487 for (n = node->children; n; n = n->next)
489 if (n->type != XML_ELEMENT_NODE)
491 if (!strcmp((const char *) n->name, "listen"))
493 xmlChar *port = xmlGetProp(n, (xmlChar *) "port");
494 xmlChar *host = xmlGetProp(n, (xmlChar *) "host");
496 server->port = atoi((const char *) port);
498 server->host = nmem_strdup(nmem, (const char *) host);
502 else if (!strcmp((const char *) n->name, "proxy"))
504 xmlChar *port = xmlGetProp(n, (xmlChar *) "port");
505 xmlChar *host = xmlGetProp(n, (xmlChar *) "host");
506 xmlChar *myurl = xmlGetProp(n, (xmlChar *) "myurl");
508 server->proxy_port = atoi((const char *) port);
510 server->proxy_host = nmem_strdup(nmem, (const char *) host);
512 server->myurl = nmem_strdup(nmem, (const char *) myurl);
517 else if (!strcmp((const char *) n->name, "settings"))
519 if (server->server_settings)
521 yaz_log(YLOG_FATAL, "Can't repeat 'settings'");
524 if (!(server->server_settings = parse_settings(nmem, n)))
527 else if (!strcmp((const char *) n->name, "relevance"))
529 server->relevance_pct = pp2_charset_create_xml(n);
530 if (!server->relevance_pct)
533 else if (!strcmp((const char *) n->name, "sort"))
535 server->sort_pct = pp2_charset_create_xml(n);
536 if (!server->sort_pct)
539 else if (!strcmp((const char *) n->name, "mergekey"))
541 server->mergekey_pct = pp2_charset_create_xml(n);
542 if (!server->mergekey_pct)
545 else if (!strcmp((const char *) n->name, "service"))
547 char *service_id = (char *)
548 xmlGetProp(n, (xmlChar *) "id");
550 struct conf_service **sp = &server->service;
551 for (; *sp; sp = &(*sp)->next)
552 if ((*sp)->id && service_id &&
553 0 == strcmp((*sp)->id, service_id))
555 yaz_log(YLOG_FATAL, "Duplicate service: %s", service_id);
558 else if (!(*sp)->id && !service_id)
560 yaz_log(YLOG_FATAL, "Duplicate unnamed service");
564 if (*sp) /* service already exist */
568 struct conf_service *s = parse_service(n, service_id);
571 s->relevance_pct = server->relevance_pct ?
572 server->relevance_pct : pp2_charset_create(0);
573 s->sort_pct = server->sort_pct ?
574 server->sort_pct : pp2_charset_create(0);
575 s->mergekey_pct = server->mergekey_pct ?
576 server->mergekey_pct : pp2_charset_create(0);
584 yaz_log(YLOG_FATAL, "Bad element: %s", n->name);
591 xsltStylesheet *conf_load_stylesheet(const char *fname)
594 if (yaz_is_abspath(fname))
595 yaz_snprintf(path, sizeof(path), fname);
597 yaz_snprintf(path, sizeof(path), "%s/%s", wrbuf_cstr(confdir), fname);
598 return xsltParseStylesheetFile((xmlChar *) path);
601 static struct conf_targetprofiles *parse_targetprofiles(NMEM nmem,
604 struct conf_targetprofiles *r = nmem_malloc(nmem, sizeof(*r));
605 xmlChar *type = xmlGetProp(node, (xmlChar *) "type");
606 xmlChar *src = xmlGetProp(node, (xmlChar *) "src");
608 memset(r, 0, sizeof(*r));
612 if (!strcmp((const char *) type, "local"))
613 r->type = Targetprofiles_local;
616 yaz_log(YLOG_FATAL, "Unknown targetprofile type");
622 yaz_log(YLOG_FATAL, "Must specify type for targetprofile");
627 r->src = nmem_strdup(nmem, (const char *) src);
630 yaz_log(YLOG_FATAL, "Must specify src in targetprofile");
638 struct conf_service *locate_service(struct conf_server *server,
639 const char *service_id)
641 struct conf_service *s = server->service;
642 for (; s; s = s->next)
643 if (s->id && service_id && 0 == strcmp(s->id, service_id))
645 else if (!s->id && !service_id)
651 static struct conf_config *parse_config(xmlNode *root)
653 NMEM nmem = nmem_create();
655 struct conf_config *r = nmem_malloc(nmem, sizeof(struct conf_config));
660 for (n = root->children; n; n = n->next)
662 if (n->type != XML_ELEMENT_NODE)
664 if (!strcmp((const char *) n->name, "server"))
666 struct conf_server *tmp = parse_server(nmem, n);
669 tmp->next = r->servers;
672 else if (!strcmp((const char *) n->name, "targetprofiles"))
674 yaz_log(YLOG_FATAL, "targetprofiles unsupported here. Must be part of service");
680 yaz_log(YLOG_FATAL, "Bad element: %s", n->name);
687 struct conf_config *read_config(const char *fname)
689 xmlDoc *doc = xmlParseFile(fname);
691 struct conf_config *config;
693 xmlSubstituteEntitiesDefault(1);
694 xmlLoadExtDtdDefaultValue = 1;
697 yaz_log(YLOG_FATAL, "Failed to read %s", fname);
700 confdir = wrbuf_alloc();
701 if ((p = strrchr(fname,
710 wrbuf_write(confdir, fname, len);
712 wrbuf_puts(confdir, "");
713 config = parse_config(xmlDocGetRootElement(doc));
719 void config_read_settings(struct conf_config *config,
720 const char *path_override)
722 struct conf_service *s = config->servers->service;
723 for (;s ; s = s->next)
727 settings_read(s, path_override);
728 else if (s->settings)
729 settings_read(s, s->settings);
730 else if (config->servers->server_settings)
731 settings_read(s, config->servers->server_settings);
733 yaz_log(YLOG_WARN, "No settings for service");
740 * c-file-style: "Stroustrup"
741 * indent-tabs-mode: nil
743 * vim: shiftwidth=4 tabstop=8 expandtab