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;
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(NMEM nmem,
100 int num_metadata, int num_sortkeys)
102 struct conf_service * service = 0;
106 service = nmem_malloc(nmem, sizeof(struct conf_service));
108 service->num_metadata = num_metadata;
109 service->metadata = 0;
110 if (service->num_metadata)
113 sizeof(struct conf_metadata) * service->num_metadata);
114 service->num_sortkeys = num_sortkeys;
115 service->sortkeys = 0;
116 if (service->num_sortkeys)
119 sizeof(struct conf_sortkey) * service->num_sortkeys);
124 struct conf_metadata* conf_service_add_metadata(NMEM nmem,
125 struct conf_service *service,
128 enum conf_metadata_type type,
129 enum conf_metadata_merge merge,
130 enum conf_setting_type setting,
135 enum conf_metadata_mergekey mt)
137 struct conf_metadata * md = 0;
139 if (!service || !service->metadata || !service->num_metadata
140 || field_id < 0 || !(field_id < service->num_metadata))
143 //md = &((service->metadata)[field_id]);
144 md = service->metadata + field_id;
145 md = conf_metadata_assign(nmem, md, name, type, merge, setting,
146 brief, termlist, rank, sortkey_offset,
152 struct conf_sortkey * conf_service_add_sortkey(NMEM nmem,
153 struct conf_service *service,
156 enum conf_sortkey_type type)
158 struct conf_sortkey * sk = 0;
160 if (!service || !service->sortkeys || !service->num_sortkeys
161 || field_id < 0 || !(field_id < service->num_sortkeys))
164 //sk = &((service->sortkeys)[field_id]);
165 sk = service->sortkeys + field_id;
166 sk = conf_sortkey_assign(nmem, sk, name, type);
172 int conf_service_metadata_field_id(struct conf_service *service,
177 if (!service || !service->metadata || !service->num_metadata)
180 for(i = 0; i < service->num_metadata; i++) {
181 if (!strcmp(name, (service->metadata[i]).name))
189 int conf_service_sortkey_field_id(struct conf_service *service,
194 if (!service || !service->sortkeys || !service->num_sortkeys)
197 for(i = 0; i < service->num_sortkeys; i++) {
198 if (!strcmp(name, (service->sortkeys[i]).name))
207 /* Code to parse configuration file */
208 /* ==================================================== */
210 static struct conf_service *parse_service(xmlNode *node)
216 struct conf_service *service = 0;
217 int num_metadata = 0;
218 int num_sortkeys = 0;
220 // count num_metadata and num_sortkeys
221 for (n = node->children; n; n = n->next)
222 if (n->type == XML_ELEMENT_NODE && !strcmp((const char *)
223 n->name, "metadata"))
225 xmlChar *sortkey = xmlGetProp(n, (xmlChar *) "sortkey");
227 if (sortkey && strcmp((const char *) sortkey, "no"))
232 service = conf_service_create(nmem, num_metadata, num_sortkeys);
234 for (n = node->children; n; n = n->next)
236 if (n->type != XML_ELEMENT_NODE)
238 if (!strcmp((const char *) n->name, (const char *) "metadata"))
240 xmlChar *xml_name = xmlGetProp(n, (xmlChar *) "name");
241 xmlChar *xml_brief = xmlGetProp(n, (xmlChar *) "brief");
242 xmlChar *xml_sortkey = xmlGetProp(n, (xmlChar *) "sortkey");
243 xmlChar *xml_merge = xmlGetProp(n, (xmlChar *) "merge");
244 xmlChar *xml_type = xmlGetProp(n, (xmlChar *) "type");
245 xmlChar *xml_termlist = xmlGetProp(n, (xmlChar *) "termlist");
246 xmlChar *xml_rank = xmlGetProp(n, (xmlChar *) "rank");
247 xmlChar *xml_setting = xmlGetProp(n, (xmlChar *) "setting");
248 xmlChar *xml_mergekey = xmlGetProp(n, (xmlChar *) "mergekey");
250 enum conf_metadata_type type = Metadata_type_generic;
251 enum conf_metadata_merge merge = Metadata_merge_no;
252 enum conf_setting_type setting = Metadata_setting_no;
253 enum conf_sortkey_type sk_type = Metadata_sortkey_relevance;
254 enum conf_metadata_mergekey mergekey_type = Metadata_mergekey_no;
258 int sortkey_offset = 0;
260 // now do the parsing logic
263 yaz_log(YLOG_FATAL, "Must specify name in metadata element");
268 if (!strcmp((const char *) xml_brief, "yes"))
270 else if (strcmp((const char *) xml_brief, "no"))
272 yaz_log(YLOG_FATAL, "metadata/brief must be yes or no");
281 if (!strcmp((const char *) xml_termlist, "yes"))
283 else if (strcmp((const char *) xml_termlist, "no"))
285 yaz_log(YLOG_FATAL, "metadata/termlist must be yes or no");
293 rank = atoi((const char *) xml_rank);
299 if (!strcmp((const char *) xml_type, "generic"))
300 type = Metadata_type_generic;
301 else if (!strcmp((const char *) xml_type, "year"))
302 type = Metadata_type_year;
303 else if (!strcmp((const char *) xml_type, "date"))
304 type = Metadata_type_date;
308 "Unknown value for metadata/type: %s", xml_type);
313 type = Metadata_type_generic;
317 if (!strcmp((const char *) xml_merge, "no"))
318 merge = Metadata_merge_no;
319 else if (!strcmp((const char *) xml_merge, "unique"))
320 merge = Metadata_merge_unique;
321 else if (!strcmp((const char *) xml_merge, "longest"))
322 merge = Metadata_merge_longest;
323 else if (!strcmp((const char *) xml_merge, "range"))
324 merge = Metadata_merge_range;
325 else if (!strcmp((const char *) xml_merge, "all"))
326 merge = Metadata_merge_all;
330 "Unknown value for metadata/merge: %s", xml_merge);
335 merge = Metadata_merge_no;
339 if (!strcmp((const char *) xml_setting, "no"))
340 setting = Metadata_setting_no;
341 else if (!strcmp((const char *) xml_setting, "postproc"))
342 setting = Metadata_setting_postproc;
343 else if (!strcmp((const char *) xml_setting, "parameter"))
344 setting = Metadata_setting_parameter;
348 "Unknown value for medadata/setting: %s", xml_setting);
353 // add a sortkey if so specified
354 if (xml_sortkey && strcmp((const char *) xml_sortkey, "no"))
356 if (merge == Metadata_merge_no)
359 "Can't specify sortkey on a non-merged field");
362 if (!strcmp((const char *) xml_sortkey, "numeric"))
363 sk_type = Metadata_sortkey_numeric;
364 else if (!strcmp((const char *) xml_sortkey, "skiparticle"))
365 sk_type = Metadata_sortkey_skiparticle;
369 "Unknown sortkey in metadata element: %s",
373 sortkey_offset = sk_node;
375 conf_service_add_sortkey(nmem, service, sk_node,
376 (const char *) xml_name, sk_type);
383 if (xml_mergekey && strcmp((const char *) xml_mergekey, "no"))
385 mergekey_type = Metadata_mergekey_yes;
389 // metadata known, assign values
390 conf_service_add_metadata(nmem, service, md_node,
391 (const char *) xml_name,
392 type, merge, setting,
393 brief, termlist, rank, sortkey_offset,
398 xmlFree(xml_sortkey);
401 xmlFree(xml_termlist);
403 xmlFree(xml_setting);
408 yaz_log(YLOG_FATAL, "Bad element: %s", n->name);
415 static char *parse_settings(xmlNode *node)
417 xmlChar *src = xmlGetProp(node, (xmlChar *) "src");
422 if (yaz_is_abspath((const char *) src))
423 r = nmem_strdup(nmem, (const char *) src);
426 r = nmem_malloc(nmem,
427 strlen(confdir) + strlen((const char *) src) + 2);
428 sprintf(r, "%s/%s", confdir, src);
433 yaz_log(YLOG_FATAL, "Must specify src in targetprofile");
440 static struct conf_server *parse_server(xmlNode *node)
443 struct conf_server *server = nmem_malloc(nmem, sizeof(struct conf_server));
447 server->proxy_host = 0;
448 server->proxy_port = 0;
452 server->settings = 0;
453 server->relevance_pct = 0;
454 server->sort_pct = 0;
455 server->mergekey_pct = 0;
457 for (n = node->children; n; n = n->next)
459 if (n->type != XML_ELEMENT_NODE)
461 if (!strcmp((const char *) n->name, "listen"))
463 xmlChar *port = xmlGetProp(n, (xmlChar *) "port");
464 xmlChar *host = xmlGetProp(n, (xmlChar *) "host");
466 server->port = atoi((const char *) port);
468 server->host = nmem_strdup(nmem, (const char *) host);
472 else if (!strcmp((const char *) n->name, "proxy"))
474 xmlChar *port = xmlGetProp(n, (xmlChar *) "port");
475 xmlChar *host = xmlGetProp(n, (xmlChar *) "host");
476 xmlChar *myurl = xmlGetProp(n, (xmlChar *) "myurl");
478 server->proxy_port = atoi((const char *) port);
480 server->proxy_host = nmem_strdup(nmem, (const char *) host);
482 server->myurl = nmem_strdup(nmem, (const char *) myurl);
487 else if (!strcmp((const char *) n->name, "settings"))
489 if (server->settings)
491 yaz_log(YLOG_FATAL, "Can't repeat 'settings'");
494 if (!(server->settings = parse_settings(n)))
497 else if (!strcmp((const char *) n->name, "relevance"))
499 server->relevance_pct = pp2_charset_create_xml(n);
500 if (!server->relevance_pct)
503 else if (!strcmp((const char *) n->name, "sort"))
505 server->sort_pct = pp2_charset_create_xml(n);
506 if (!server->sort_pct)
509 else if (!strcmp((const char *) n->name, "mergekey"))
511 server->mergekey_pct = pp2_charset_create_xml(n);
512 if (!server->mergekey_pct)
515 else if (!strcmp((const char *) n->name, "service"))
517 struct conf_service *s = parse_service(n);
524 yaz_log(YLOG_FATAL, "Bad element: %s", n->name);
528 if (!server->relevance_pct)
529 server->relevance_pct = pp2_charset_create(0);
530 if (!server->sort_pct)
531 server->sort_pct = pp2_charset_create(0);
532 if (!server->mergekey_pct)
533 server->mergekey_pct = pp2_charset_create(0);
537 xsltStylesheet *conf_load_stylesheet(const char *fname)
540 if (yaz_is_abspath(fname))
541 yaz_snprintf(path, sizeof(path), fname);
543 yaz_snprintf(path, sizeof(path), "%s/%s", confdir, fname);
544 return xsltParseStylesheetFile((xmlChar *) path);
547 static struct conf_targetprofiles *parse_targetprofiles(xmlNode *node)
549 struct conf_targetprofiles *r = nmem_malloc(nmem, sizeof(*r));
550 xmlChar *type = xmlGetProp(node, (xmlChar *) "type");
551 xmlChar *src = xmlGetProp(node, (xmlChar *) "src");
553 memset(r, 0, sizeof(*r));
557 if (!strcmp((const char *) type, "local"))
558 r->type = Targetprofiles_local;
561 yaz_log(YLOG_FATAL, "Unknown targetprofile type");
567 yaz_log(YLOG_FATAL, "Must specify type for targetprofile");
572 r->src = nmem_strdup(nmem, (const char *) src);
575 yaz_log(YLOG_FATAL, "Must specify src in targetprofile");
583 static struct conf_config *parse_config(xmlNode *root)
586 struct conf_config *r = nmem_malloc(nmem, sizeof(struct conf_config));
589 r->targetprofiles = 0;
591 for (n = root->children; n; n = n->next)
593 if (n->type != XML_ELEMENT_NODE)
595 if (!strcmp((const char *) n->name, "server"))
597 struct conf_server *tmp = parse_server(n);
600 tmp->next = r->servers;
603 else if (!strcmp((const char *) n->name, "targetprofiles"))
605 // It would be fun to be able to fix this sometime
606 if (r->targetprofiles)
608 yaz_log(YLOG_FATAL, "Can't repeat targetprofiles");
611 if (!(r->targetprofiles = parse_targetprofiles(n)))
616 yaz_log(YLOG_FATAL, "Bad element: %s", n->name);
623 int read_config(const char *fname)
625 xmlDoc *doc = xmlParseFile(fname);
628 if (!nmem) // Initialize
630 nmem = nmem_create();
631 xmlSubstituteEntitiesDefault(1);
632 xmlLoadExtDtdDefaultValue = 1;
636 yaz_log(YLOG_FATAL, "Failed to read %s", fname);
639 if ((p = strrchr(fname,
648 if (len >= sizeof(confdir))
649 len = sizeof(confdir)-1;
650 strncpy(confdir, fname, len);
653 config = parse_config(xmlDocGetRootElement(doc));
666 * c-file-style: "Stroustrup"
667 * indent-tabs-mode: nil
669 * vim: shiftwidth=4 tabstop=8 expandtab