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;
47 struct conf_metadata * conf_metadata_assign(NMEM nmem,
48 struct conf_metadata * metadata,
50 enum conf_metadata_type type,
51 enum conf_metadata_merge merge,
52 enum conf_setting_type setting,
57 enum conf_metadata_mergekey mt)
59 if (!nmem || !metadata || !name)
62 metadata->name = nmem_strdup(nmem, name);
64 metadata->type = type;
66 // enforcing that type_year is always range_merge
67 if (metadata->type == Metadata_type_year)
68 metadata->merge = Metadata_merge_range;
70 metadata->merge = merge;
72 metadata->setting = setting;
73 metadata->brief = brief;
74 metadata->termlist = termlist;
75 metadata->rank = rank;
76 metadata->sortkey_offset = sortkey_offset;
77 metadata->mergekey = mt;
83 struct conf_sortkey * conf_sortkey_assign(NMEM nmem,
84 struct conf_sortkey * sortkey,
86 enum conf_sortkey_type type)
88 if (!nmem || !sortkey || !name)
91 sortkey->name = nmem_strdup(nmem, name);
98 struct conf_service * conf_service_create(int num_metadata, int num_sortkeys,
99 const char *service_id)
101 struct conf_service * service = 0;
102 NMEM nmem = nmem_create();
106 service = nmem_malloc(nmem, sizeof(struct conf_service));
107 service->nmem = nmem;
110 service->id = service_id ? nmem_strdup(nmem, service_id) : 0;
111 service->num_metadata = num_metadata;
112 service->metadata = 0;
113 if (service->num_metadata)
116 sizeof(struct conf_metadata) * service->num_metadata);
117 service->num_sortkeys = num_sortkeys;
118 service->sortkeys = 0;
119 if (service->num_sortkeys)
122 sizeof(struct conf_sortkey) * service->num_sortkeys);
123 service->dictionary = 0;
127 struct conf_metadata* conf_service_add_metadata(struct conf_service *service,
130 enum conf_metadata_type type,
131 enum conf_metadata_merge merge,
132 enum conf_setting_type setting,
137 enum conf_metadata_mergekey mt)
139 struct conf_metadata * md = 0;
141 if (!service || !service->metadata || !service->num_metadata
142 || field_id < 0 || !(field_id < service->num_metadata))
145 //md = &((service->metadata)[field_id]);
146 md = service->metadata + field_id;
147 md = conf_metadata_assign(service->nmem, md, name, type, merge, setting,
148 brief, termlist, rank, sortkey_offset,
154 struct conf_sortkey * conf_service_add_sortkey(struct conf_service *service,
157 enum conf_sortkey_type type)
159 struct conf_sortkey * sk = 0;
161 if (!service || !service->sortkeys || !service->num_sortkeys
162 || field_id < 0 || !(field_id < service->num_sortkeys))
165 //sk = &((service->sortkeys)[field_id]);
166 sk = service->sortkeys + field_id;
167 sk = conf_sortkey_assign(service->nmem, sk, name, type);
173 int conf_service_metadata_field_id(struct conf_service *service,
178 if (!service || !service->metadata || !service->num_metadata)
181 for(i = 0; i < service->num_metadata; i++) {
182 if (!strcmp(name, (service->metadata[i]).name))
190 int conf_service_sortkey_field_id(struct conf_service *service,
195 if (!service || !service->sortkeys || !service->num_sortkeys)
198 for(i = 0; i < service->num_sortkeys; i++) {
199 if (!strcmp(name, (service->sortkeys[i]).name))
208 /* Code to parse configuration file */
209 /* ==================================================== */
211 static struct conf_service *parse_service(xmlNode *node, const char *service_id)
217 struct conf_service *service = 0;
218 int num_metadata = 0;
219 int num_sortkeys = 0;
221 // count num_metadata and num_sortkeys
222 for (n = node->children; n; n = n->next)
223 if (n->type == XML_ELEMENT_NODE && !strcmp((const char *)
224 n->name, "metadata"))
226 xmlChar *sortkey = xmlGetProp(n, (xmlChar *) "sortkey");
228 if (sortkey && strcmp((const char *) sortkey, "no"))
233 service = conf_service_create(num_metadata, num_sortkeys, service_id);
235 for (n = node->children; n; n = n->next)
237 if (n->type != XML_ELEMENT_NODE)
239 if (!strcmp((const char *) n->name, (const char *) "metadata"))
241 xmlChar *xml_name = xmlGetProp(n, (xmlChar *) "name");
242 xmlChar *xml_brief = xmlGetProp(n, (xmlChar *) "brief");
243 xmlChar *xml_sortkey = xmlGetProp(n, (xmlChar *) "sortkey");
244 xmlChar *xml_merge = xmlGetProp(n, (xmlChar *) "merge");
245 xmlChar *xml_type = xmlGetProp(n, (xmlChar *) "type");
246 xmlChar *xml_termlist = xmlGetProp(n, (xmlChar *) "termlist");
247 xmlChar *xml_rank = xmlGetProp(n, (xmlChar *) "rank");
248 xmlChar *xml_setting = xmlGetProp(n, (xmlChar *) "setting");
249 xmlChar *xml_mergekey = xmlGetProp(n, (xmlChar *) "mergekey");
251 enum conf_metadata_type type = Metadata_type_generic;
252 enum conf_metadata_merge merge = Metadata_merge_no;
253 enum conf_setting_type setting = Metadata_setting_no;
254 enum conf_sortkey_type sk_type = Metadata_sortkey_relevance;
255 enum conf_metadata_mergekey mergekey_type = Metadata_mergekey_no;
259 int sortkey_offset = 0;
261 // now do the parsing logic
264 yaz_log(YLOG_FATAL, "Must specify name in metadata element");
269 if (!strcmp((const char *) xml_brief, "yes"))
271 else if (strcmp((const char *) xml_brief, "no"))
273 yaz_log(YLOG_FATAL, "metadata/brief must be yes or no");
282 if (!strcmp((const char *) xml_termlist, "yes"))
284 else if (strcmp((const char *) xml_termlist, "no"))
286 yaz_log(YLOG_FATAL, "metadata/termlist must be yes or no");
294 rank = atoi((const char *) xml_rank);
300 if (!strcmp((const char *) xml_type, "generic"))
301 type = Metadata_type_generic;
302 else if (!strcmp((const char *) xml_type, "year"))
303 type = Metadata_type_year;
304 else if (!strcmp((const char *) xml_type, "date"))
305 type = Metadata_type_date;
309 "Unknown value for metadata/type: %s", xml_type);
314 type = Metadata_type_generic;
318 if (!strcmp((const char *) xml_merge, "no"))
319 merge = Metadata_merge_no;
320 else if (!strcmp((const char *) xml_merge, "unique"))
321 merge = Metadata_merge_unique;
322 else if (!strcmp((const char *) xml_merge, "longest"))
323 merge = Metadata_merge_longest;
324 else if (!strcmp((const char *) xml_merge, "range"))
325 merge = Metadata_merge_range;
326 else if (!strcmp((const char *) xml_merge, "all"))
327 merge = Metadata_merge_all;
331 "Unknown value for metadata/merge: %s", xml_merge);
336 merge = Metadata_merge_no;
340 if (!strcmp((const char *) xml_setting, "no"))
341 setting = Metadata_setting_no;
342 else if (!strcmp((const char *) xml_setting, "postproc"))
343 setting = Metadata_setting_postproc;
344 else if (!strcmp((const char *) xml_setting, "parameter"))
345 setting = Metadata_setting_parameter;
349 "Unknown value for medadata/setting: %s", xml_setting);
354 // add a sortkey if so specified
355 if (xml_sortkey && strcmp((const char *) xml_sortkey, "no"))
357 if (merge == Metadata_merge_no)
360 "Can't specify sortkey on a non-merged field");
363 if (!strcmp((const char *) xml_sortkey, "numeric"))
364 sk_type = Metadata_sortkey_numeric;
365 else if (!strcmp((const char *) xml_sortkey, "skiparticle"))
366 sk_type = Metadata_sortkey_skiparticle;
370 "Unknown sortkey in metadata element: %s",
374 sortkey_offset = sk_node;
376 conf_service_add_sortkey(
378 (const char *) xml_name, sk_type);
385 if (xml_mergekey && strcmp((const char *) xml_mergekey, "no"))
387 mergekey_type = Metadata_mergekey_yes;
391 // metadata known, assign values
392 conf_service_add_metadata(service, md_node,
393 (const char *) xml_name,
394 type, merge, setting,
395 brief, termlist, rank, sortkey_offset,
400 xmlFree(xml_sortkey);
403 xmlFree(xml_termlist);
405 xmlFree(xml_setting);
410 yaz_log(YLOG_FATAL, "Bad element: %s", n->name);
417 static char *parse_settings(NMEM nmem, xmlNode *node)
419 xmlChar *src = xmlGetProp(node, (xmlChar *) "src");
424 if (yaz_is_abspath((const char *) src))
425 r = nmem_strdup(nmem, (const char *) src);
428 r = nmem_malloc(nmem,
429 strlen(confdir) + strlen((const char *) src) + 2);
430 sprintf(r, "%s/%s", confdir, src);
435 yaz_log(YLOG_FATAL, "Must specify src in targetprofile");
442 static struct conf_server *parse_server(NMEM nmem, xmlNode *node)
445 struct conf_server *server = nmem_malloc(nmem, sizeof(struct conf_server));
449 server->proxy_host = 0;
450 server->proxy_port = 0;
454 server->settings = 0;
455 server->relevance_pct = 0;
456 server->sort_pct = 0;
457 server->mergekey_pct = 0;
459 for (n = node->children; n; n = n->next)
461 if (n->type != XML_ELEMENT_NODE)
463 if (!strcmp((const char *) n->name, "listen"))
465 xmlChar *port = xmlGetProp(n, (xmlChar *) "port");
466 xmlChar *host = xmlGetProp(n, (xmlChar *) "host");
468 server->port = atoi((const char *) port);
470 server->host = nmem_strdup(nmem, (const char *) host);
474 else if (!strcmp((const char *) n->name, "proxy"))
476 xmlChar *port = xmlGetProp(n, (xmlChar *) "port");
477 xmlChar *host = xmlGetProp(n, (xmlChar *) "host");
478 xmlChar *myurl = xmlGetProp(n, (xmlChar *) "myurl");
480 server->proxy_port = atoi((const char *) port);
482 server->proxy_host = nmem_strdup(nmem, (const char *) host);
484 server->myurl = nmem_strdup(nmem, (const char *) myurl);
489 else if (!strcmp((const char *) n->name, "settings"))
491 if (server->settings)
493 yaz_log(YLOG_FATAL, "Can't repeat 'settings'");
496 if (!(server->settings = parse_settings(nmem, n)))
499 else if (!strcmp((const char *) n->name, "relevance"))
501 server->relevance_pct = pp2_charset_create_xml(n);
502 if (!server->relevance_pct)
505 else if (!strcmp((const char *) n->name, "sort"))
507 server->sort_pct = pp2_charset_create_xml(n);
508 if (!server->sort_pct)
511 else if (!strcmp((const char *) n->name, "mergekey"))
513 server->mergekey_pct = pp2_charset_create_xml(n);
514 if (!server->mergekey_pct)
517 else if (!strcmp((const char *) n->name, "service"))
519 const char *service_id = (const char *)
520 xmlGetProp(n, (xmlChar *) "id");
522 struct conf_service **sp = &server->service;
523 for (; *sp; sp = &(*sp)->next)
524 if ((*sp)->id && service_id &&
525 0 == strcmp((*sp)->id, service_id))
527 yaz_log(YLOG_FATAL, "Duplicate service: %s", service_id);
530 else if (!(*sp)->id && !service_id)
532 yaz_log(YLOG_FATAL, "Duplicate unnamed service");
536 if (*sp) /* service already exist */
540 struct conf_service *s = parse_service(n, service_id);
547 yaz_log(YLOG_FATAL, "Bad element: %s", n->name);
551 if (!server->relevance_pct)
552 server->relevance_pct = pp2_charset_create(0);
553 if (!server->sort_pct)
554 server->sort_pct = pp2_charset_create(0);
555 if (!server->mergekey_pct)
556 server->mergekey_pct = pp2_charset_create(0);
560 xsltStylesheet *conf_load_stylesheet(const char *fname)
563 if (yaz_is_abspath(fname))
564 yaz_snprintf(path, sizeof(path), fname);
566 yaz_snprintf(path, sizeof(path), "%s/%s", confdir, fname);
567 return xsltParseStylesheetFile((xmlChar *) path);
570 static struct conf_targetprofiles *parse_targetprofiles(NMEM nmem,
573 struct conf_targetprofiles *r = nmem_malloc(nmem, sizeof(*r));
574 xmlChar *type = xmlGetProp(node, (xmlChar *) "type");
575 xmlChar *src = xmlGetProp(node, (xmlChar *) "src");
577 memset(r, 0, sizeof(*r));
581 if (!strcmp((const char *) type, "local"))
582 r->type = Targetprofiles_local;
585 yaz_log(YLOG_FATAL, "Unknown targetprofile type");
591 yaz_log(YLOG_FATAL, "Must specify type for targetprofile");
596 r->src = nmem_strdup(nmem, (const char *) src);
599 yaz_log(YLOG_FATAL, "Must specify src in targetprofile");
607 struct conf_service *locate_service(const char *service_id)
609 struct conf_service *s = config->servers->service;
610 for (; s; s = s->next)
611 if (s->id && service_id && 0 == strcmp(s->id, service_id))
613 else if (!s->id && !service_id)
619 static struct conf_config *parse_config(xmlNode *root)
621 NMEM nmem = nmem_create();
623 struct conf_config *r = nmem_malloc(nmem, sizeof(struct conf_config));
627 r->targetprofiles = 0;
629 for (n = root->children; n; n = n->next)
631 if (n->type != XML_ELEMENT_NODE)
633 if (!strcmp((const char *) n->name, "server"))
635 struct conf_server *tmp = parse_server(nmem, n);
638 tmp->next = r->servers;
641 else if (!strcmp((const char *) n->name, "targetprofiles"))
643 // It would be fun to be able to fix this sometime
644 if (r->targetprofiles)
646 yaz_log(YLOG_FATAL, "Can't repeat targetprofiles");
649 if (!(r->targetprofiles = parse_targetprofiles(nmem, n)))
654 yaz_log(YLOG_FATAL, "Bad element: %s", n->name);
661 int read_config(const char *fname)
663 xmlDoc *doc = xmlParseFile(fname);
666 xmlSubstituteEntitiesDefault(1);
667 xmlLoadExtDtdDefaultValue = 1;
670 yaz_log(YLOG_FATAL, "Failed to read %s", fname);
673 if ((p = strrchr(fname,
682 if (len >= sizeof(confdir))
683 len = sizeof(confdir)-1;
684 strncpy(confdir, fname, len);
687 config = parse_config(xmlDocGetRootElement(doc));
700 * c-file-style: "Stroustrup"
701 * indent-tabs-mode: nil
703 * vim: shiftwidth=4 tabstop=8 expandtab