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"
42 static char confdir[256] = ".";
44 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,
58 if (!nmem || !metadata || !name)
61 metadata->name = nmem_strdup(nmem, name);
63 metadata->type = type;
65 // enforcing that type_year is always range_merge
66 if (metadata->type == Metadata_type_year)
67 metadata->merge = Metadata_merge_range;
69 metadata->merge = merge;
71 metadata->setting = setting;
72 metadata->brief = brief;
73 metadata->termlist = termlist;
74 metadata->rank = rank;
75 metadata->sortkey_offset = sortkey_offset;
80 struct conf_sortkey * conf_sortkey_assign(NMEM nmem,
81 struct conf_sortkey * sortkey,
83 enum conf_sortkey_type type)
85 if (!nmem || !sortkey || !name)
88 sortkey->name = nmem_strdup(nmem, name);
95 struct conf_service * conf_service_create(NMEM nmem,
96 int num_metadata, int num_sortkeys)
98 struct conf_service * service = 0;
102 service = nmem_malloc(nmem, sizeof(struct conf_service));
104 service->num_metadata = num_metadata;
105 service->metadata = 0;
106 if (service->num_metadata)
109 sizeof(struct conf_metadata) * service->num_metadata);
110 service->num_sortkeys = num_sortkeys;
111 service->sortkeys = 0;
112 if (service->num_sortkeys)
115 sizeof(struct conf_sortkey) * service->num_sortkeys);
120 struct conf_metadata* conf_service_add_metadata(NMEM nmem,
121 struct conf_service *service,
124 enum conf_metadata_type type,
125 enum conf_metadata_merge merge,
126 enum conf_setting_type setting,
132 struct conf_metadata * md = 0;
134 if (!service || !service->metadata || !service->num_metadata
135 || field_id < 0 || !(field_id < service->num_metadata))
138 //md = &((service->metadata)[field_id]);
139 md = service->metadata + field_id;
140 md = conf_metadata_assign(nmem, md, name, type, merge, setting,
141 brief, termlist, rank, sortkey_offset);
146 struct conf_sortkey * conf_service_add_sortkey(NMEM nmem,
147 struct conf_service *service,
150 enum conf_sortkey_type type)
152 struct conf_sortkey * sk = 0;
154 if (!service || !service->sortkeys || !service->num_sortkeys
155 || field_id < 0 || !(field_id < service->num_sortkeys))
158 //sk = &((service->sortkeys)[field_id]);
159 sk = service->sortkeys + field_id;
160 sk = conf_sortkey_assign(nmem, sk, name, type);
166 int conf_service_metadata_field_id(struct conf_service *service,
171 if (!service || !service->metadata || !service->num_metadata)
174 for(i = 0; i < service->num_metadata; i++) {
175 if (!strcmp(name, (service->metadata[i]).name))
183 int conf_service_sortkey_field_id(struct conf_service *service,
188 if (!service || !service->sortkeys || !service->num_sortkeys)
191 for(i = 0; i < service->num_sortkeys; i++) {
192 if (!strcmp(name, (service->sortkeys[i]).name))
201 /* Code to parse configuration file */
202 /* ==================================================== */
204 static struct conf_service *parse_service(xmlNode *node)
210 struct conf_service *service = 0;
211 int num_metadata = 0;
212 int num_sortkeys = 0;
214 // count num_metadata and num_sortkeys
215 for (n = node->children; n; n = n->next)
216 if (n->type == XML_ELEMENT_NODE && !strcmp((const char *)
217 n->name, "metadata"))
219 xmlChar *sortkey = xmlGetProp(n, (xmlChar *) "sortkey");
221 if (sortkey && strcmp((const char *) sortkey, "no"))
226 service = conf_service_create(nmem, num_metadata, num_sortkeys);
228 for (n = node->children; n; n = n->next)
230 if (n->type != XML_ELEMENT_NODE)
232 if (!strcmp((const char *) n->name, (const char *) "metadata"))
234 xmlChar *xml_name = xmlGetProp(n, (xmlChar *) "name");
235 xmlChar *xml_brief = xmlGetProp(n, (xmlChar *) "brief");
236 xmlChar *xml_sortkey = xmlGetProp(n, (xmlChar *) "sortkey");
237 xmlChar *xml_merge = xmlGetProp(n, (xmlChar *) "merge");
238 xmlChar *xml_type = xmlGetProp(n, (xmlChar *) "type");
239 xmlChar *xml_termlist = xmlGetProp(n, (xmlChar *) "termlist");
240 xmlChar *xml_rank = xmlGetProp(n, (xmlChar *) "rank");
241 xmlChar *xml_setting = xmlGetProp(n, (xmlChar *) "setting");
243 enum conf_metadata_type type = Metadata_type_generic;
244 enum conf_metadata_merge merge = Metadata_merge_no;
245 enum conf_setting_type setting = Metadata_setting_no;
246 enum conf_sortkey_type sk_type = Metadata_sortkey_relevance;
250 int sortkey_offset = 0;
252 // now do the parsing logic
255 yaz_log(YLOG_FATAL, "Must specify name in metadata element");
260 if (!strcmp((const char *) xml_brief, "yes"))
262 else if (strcmp((const char *) xml_brief, "no"))
264 yaz_log(YLOG_FATAL, "metadata/brief must be yes or no");
273 if (!strcmp((const char *) xml_termlist, "yes"))
275 else if (strcmp((const char *) xml_termlist, "no"))
277 yaz_log(YLOG_FATAL, "metadata/termlist must be yes or no");
285 rank = atoi((const char *) xml_rank);
291 if (!strcmp((const char *) xml_type, "generic"))
292 type = Metadata_type_generic;
293 else if (!strcmp((const char *) xml_type, "year"))
294 type = Metadata_type_year;
295 else if (!strcmp((const char *) xml_type, "date"))
296 type = Metadata_type_date;
300 "Unknown value for metadata/type: %s", xml_type);
305 type = Metadata_type_generic;
309 if (!strcmp((const char *) xml_merge, "no"))
310 merge = Metadata_merge_no;
311 else if (!strcmp((const char *) xml_merge, "unique"))
312 merge = Metadata_merge_unique;
313 else if (!strcmp((const char *) xml_merge, "longest"))
314 merge = Metadata_merge_longest;
315 else if (!strcmp((const char *) xml_merge, "range"))
316 merge = Metadata_merge_range;
317 else if (!strcmp((const char *) xml_merge, "all"))
318 merge = Metadata_merge_all;
322 "Unknown value for metadata/merge: %s", xml_merge);
327 merge = Metadata_merge_no;
331 if (!strcmp((const char *) xml_setting, "no"))
332 setting = Metadata_setting_no;
333 else if (!strcmp((const char *) xml_setting, "postproc"))
334 setting = Metadata_setting_postproc;
335 else if (!strcmp((const char *) xml_setting, "parameter"))
336 setting = Metadata_setting_parameter;
340 "Unknown value for medadata/setting: %s", xml_setting);
345 // add a sortkey if so specified
346 if (xml_sortkey && strcmp((const char *) xml_sortkey, "no"))
348 if (merge == Metadata_merge_no)
351 "Can't specify sortkey on a non-merged field");
354 if (!strcmp((const char *) xml_sortkey, "numeric"))
355 sk_type = Metadata_sortkey_numeric;
356 else if (!strcmp((const char *) xml_sortkey, "skiparticle"))
357 sk_type = Metadata_sortkey_skiparticle;
361 "Unknown sortkey in metadata element: %s",
365 sortkey_offset = sk_node;
367 conf_service_add_sortkey(nmem, service, sk_node,
368 (const char *) xml_name, sk_type);
375 // metadata known, assign values
376 conf_service_add_metadata(nmem, service, md_node,
377 (const char *) xml_name,
378 type, merge, setting,
379 brief, termlist, rank, sortkey_offset);
383 xmlFree(xml_sortkey);
386 xmlFree(xml_termlist);
388 xmlFree(xml_setting);
393 yaz_log(YLOG_FATAL, "Bad element: %s", n->name);
400 static char *parse_settings(xmlNode *node)
402 xmlChar *src = xmlGetProp(node, (xmlChar *) "src");
407 if (yaz_is_abspath((const char *) src))
408 r = nmem_strdup(nmem, (const char *) src);
411 r = nmem_malloc(nmem,
412 strlen(confdir) + strlen((const char *) src) + 2);
413 sprintf(r, "%s/%s", confdir, src);
418 yaz_log(YLOG_FATAL, "Must specify src in targetprofile");
425 static struct conf_server *parse_server(xmlNode *node)
428 struct conf_server *server = nmem_malloc(nmem, sizeof(struct conf_server));
432 server->proxy_host = 0;
433 server->proxy_port = 0;
437 server->settings = 0;
438 server->relevance_pct = 0;
439 server->sort_pct = 0;
440 server->mergekey_pct = 0;
442 for (n = node->children; n; n = n->next)
444 if (n->type != XML_ELEMENT_NODE)
446 if (!strcmp((const char *) n->name, "listen"))
448 xmlChar *port = xmlGetProp(n, (xmlChar *) "port");
449 xmlChar *host = xmlGetProp(n, (xmlChar *) "host");
451 server->port = atoi((const char *) port);
453 server->host = nmem_strdup(nmem, (const char *) host);
457 else if (!strcmp((const char *) n->name, "proxy"))
459 xmlChar *port = xmlGetProp(n, (xmlChar *) "port");
460 xmlChar *host = xmlGetProp(n, (xmlChar *) "host");
461 xmlChar *myurl = xmlGetProp(n, (xmlChar *) "myurl");
463 server->proxy_port = atoi((const char *) port);
465 server->proxy_host = nmem_strdup(nmem, (const char *) host);
467 server->myurl = nmem_strdup(nmem, (const char *) myurl);
472 else if (!strcmp((const char *) n->name, "settings"))
474 if (server->settings)
476 yaz_log(YLOG_FATAL, "Can't repeat 'settings'");
479 if (!(server->settings = parse_settings(n)))
482 else if (!strcmp((const char *) n->name, "relevance"))
484 server->relevance_pct = pp2_charset_create_xml(n);
485 if (!server->relevance_pct)
488 else if (!strcmp((const char *) n->name, "sort"))
490 server->sort_pct = pp2_charset_create_xml(n);
491 if (!server->sort_pct)
494 else if (!strcmp((const char *) n->name, "mergekey"))
496 server->mergekey_pct = pp2_charset_create_xml(n);
497 if (!server->mergekey_pct)
500 else if (!strcmp((const char *) n->name, "service"))
502 struct conf_service *s = parse_service(n);
509 yaz_log(YLOG_FATAL, "Bad element: %s", n->name);
513 if (!server->relevance_pct)
514 server->relevance_pct = pp2_charset_create(0);
515 if (!server->sort_pct)
516 server->sort_pct = pp2_charset_create(0);
517 if (!server->mergekey_pct)
518 server->mergekey_pct = pp2_charset_create(0);
522 xsltStylesheet *conf_load_stylesheet(const char *fname)
525 if (yaz_is_abspath(fname))
526 yaz_snprintf(path, sizeof(path), fname);
528 yaz_snprintf(path, sizeof(path), "%s/%s", confdir, fname);
529 return xsltParseStylesheetFile((xmlChar *) path);
532 static struct conf_targetprofiles *parse_targetprofiles(xmlNode *node)
534 struct conf_targetprofiles *r = nmem_malloc(nmem, sizeof(*r));
535 xmlChar *type = xmlGetProp(node, (xmlChar *) "type");
536 xmlChar *src = xmlGetProp(node, (xmlChar *) "src");
538 memset(r, 0, sizeof(*r));
542 if (!strcmp((const char *) type, "local"))
543 r->type = Targetprofiles_local;
546 yaz_log(YLOG_FATAL, "Unknown targetprofile type");
552 yaz_log(YLOG_FATAL, "Must specify type for targetprofile");
557 r->src = nmem_strdup(nmem, (const char *) src);
560 yaz_log(YLOG_FATAL, "Must specify src in targetprofile");
568 static struct conf_config *parse_config(xmlNode *root)
571 struct conf_config *r = nmem_malloc(nmem, sizeof(struct conf_config));
574 r->targetprofiles = 0;
576 for (n = root->children; n; n = n->next)
578 if (n->type != XML_ELEMENT_NODE)
580 if (!strcmp((const char *) n->name, "server"))
582 struct conf_server *tmp = parse_server(n);
585 tmp->next = r->servers;
588 else if (!strcmp((const char *) n->name, "targetprofiles"))
590 // It would be fun to be able to fix this sometime
591 if (r->targetprofiles)
593 yaz_log(YLOG_FATAL, "Can't repeat targetprofiles");
596 if (!(r->targetprofiles = parse_targetprofiles(n)))
601 yaz_log(YLOG_FATAL, "Bad element: %s", n->name);
608 int read_config(const char *fname)
610 xmlDoc *doc = xmlParseFile(fname);
613 if (!nmem) // Initialize
615 nmem = nmem_create();
616 xmlSubstituteEntitiesDefault(1);
617 xmlLoadExtDtdDefaultValue = 1;
621 yaz_log(YLOG_FATAL, "Failed to read %s", fname);
624 if ((p = strrchr(fname,
633 if (len >= sizeof(confdir))
634 len = sizeof(confdir)-1;
635 strncpy(confdir, fname, len);
638 config = parse_config(xmlDocGetRootElement(doc));
651 * c-file-style: "Stroustrup"
652 * indent-tabs-mode: nil
654 * vim: shiftwidth=4 tabstop=8 expandtab