1 /* This file is part of Pazpar2.
2 Copyright (C) 2006-2008 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>
36 #define CONFIG_NOEXTERNS
37 #include "pazpar2_config.h"
41 static char confdir[256] = ".";
43 struct conf_config *config = 0;
46 struct conf_metadata * conf_metadata_assign(NMEM nmem,
47 struct conf_metadata * metadata,
49 enum conf_metadata_type type,
50 enum conf_metadata_merge merge,
51 enum conf_setting_type setting,
57 if (!nmem || !metadata || !name)
60 metadata->name = nmem_strdup(nmem, name);
62 metadata->type = type;
64 // enforcing that type_year is always range_merge
65 if (metadata->type == Metadata_type_year)
66 metadata->merge = Metadata_merge_range;
68 metadata->merge = merge;
70 metadata->setting = setting;
71 metadata->brief = brief;
72 metadata->termlist = termlist;
73 metadata->rank = rank;
74 metadata->sortkey_offset = sortkey_offset;
79 struct conf_sortkey * conf_sortkey_assign(NMEM nmem,
80 struct conf_sortkey * sortkey,
82 enum conf_sortkey_type type)
84 if (!nmem || !sortkey || !name)
87 sortkey->name = nmem_strdup(nmem, name);
94 struct conf_service * conf_service_create(NMEM nmem,
95 int num_metadata, int num_sortkeys)
97 struct conf_service * service = 0;
101 service = nmem_malloc(nmem, sizeof(struct conf_service));
103 service->num_metadata = num_metadata;
104 service->metadata = 0;
105 if (service->num_metadata)
108 sizeof(struct conf_metadata) * service->num_metadata);
109 service->num_sortkeys = num_sortkeys;
110 service->sortkeys = 0;
111 if (service->num_sortkeys)
114 sizeof(struct conf_sortkey) * service->num_sortkeys);
119 struct conf_metadata* conf_service_add_metadata(NMEM nmem,
120 struct conf_service *service,
123 enum conf_metadata_type type,
124 enum conf_metadata_merge merge,
125 enum conf_setting_type setting,
131 struct conf_metadata * md = 0;
133 if (!service || !service->metadata || !service->num_metadata
134 || field_id < 0 || !(field_id < service->num_metadata))
137 //md = &((service->metadata)[field_id]);
138 md = service->metadata + field_id;
139 md = conf_metadata_assign(nmem, md, name, type, merge, setting,
140 brief, termlist, rank, sortkey_offset);
145 struct conf_sortkey * conf_service_add_sortkey(NMEM nmem,
146 struct conf_service *service,
149 enum conf_sortkey_type type)
151 struct conf_sortkey * sk = 0;
153 if (!service || !service->sortkeys || !service->num_sortkeys
154 || field_id < 0 || !(field_id < service->num_sortkeys))
157 //sk = &((service->sortkeys)[field_id]);
158 sk = service->sortkeys + field_id;
159 sk = conf_sortkey_assign(nmem, sk, name, type);
165 int conf_service_metadata_field_id(struct conf_service *service,
170 if (!service || !service->metadata || !service->num_metadata)
173 for(i = 0; i < service->num_metadata; i++) {
174 if (!strcmp(name, (service->metadata[i]).name))
182 int conf_service_sortkey_field_id(struct conf_service *service,
187 if (!service || !service->sortkeys || !service->num_sortkeys)
190 for(i = 0; i < service->num_sortkeys; i++) {
191 if (!strcmp(name, (service->sortkeys[i]).name))
200 /* Code to parse configuration file */
201 /* ==================================================== */
203 static struct conf_service *parse_service(xmlNode *node)
209 struct conf_service *service = 0;
210 int num_metadata = 0;
211 int num_sortkeys = 0;
213 // count num_metadata and num_sortkeys
214 for (n = node->children; n; n = n->next)
215 if (n->type == XML_ELEMENT_NODE && !strcmp((const char *)
216 n->name, "metadata"))
218 xmlChar *sortkey = xmlGetProp(n, (xmlChar *) "sortkey");
220 if (sortkey && strcmp((const char *) sortkey, "no"))
225 service = conf_service_create(nmem, num_metadata, num_sortkeys);
227 for (n = node->children; n; n = n->next)
229 if (n->type != XML_ELEMENT_NODE)
231 if (!strcmp((const char *) n->name, (const char *) "metadata"))
233 xmlChar *xml_name = xmlGetProp(n, (xmlChar *) "name");
234 xmlChar *xml_brief = xmlGetProp(n, (xmlChar *) "brief");
235 xmlChar *xml_sortkey = xmlGetProp(n, (xmlChar *) "sortkey");
236 xmlChar *xml_merge = xmlGetProp(n, (xmlChar *) "merge");
237 xmlChar *xml_type = xmlGetProp(n, (xmlChar *) "type");
238 xmlChar *xml_termlist = xmlGetProp(n, (xmlChar *) "termlist");
239 xmlChar *xml_rank = xmlGetProp(n, (xmlChar *) "rank");
240 xmlChar *xml_setting = xmlGetProp(n, (xmlChar *) "setting");
242 enum conf_metadata_type type = Metadata_type_generic;
243 enum conf_metadata_merge merge = Metadata_merge_no;
244 enum conf_setting_type setting = Metadata_setting_no;
245 enum conf_sortkey_type sk_type = Metadata_sortkey_relevance;
249 int sortkey_offset = 0;
251 // now do the parsing logic
254 yaz_log(YLOG_FATAL, "Must specify name in metadata element");
259 if (!strcmp((const char *) xml_brief, "yes"))
261 else if (strcmp((const char *) xml_brief, "no"))
263 yaz_log(YLOG_FATAL, "metadata/brief must be yes or no");
272 if (!strcmp((const char *) xml_termlist, "yes"))
274 else if (strcmp((const char *) xml_termlist, "no"))
276 yaz_log(YLOG_FATAL, "metadata/termlist must be yes or no");
284 rank = atoi((const char *) xml_rank);
290 if (!strcmp((const char *) xml_type, "generic"))
291 type = Metadata_type_generic;
292 else if (!strcmp((const char *) xml_type, "year"))
293 type = Metadata_type_year;
294 else if (!strcmp((const char *) xml_type, "date"))
295 type = Metadata_type_date;
299 "Unknown value for metadata/type: %s", xml_type);
304 type = Metadata_type_generic;
308 if (!strcmp((const char *) xml_merge, "no"))
309 merge = Metadata_merge_no;
310 else if (!strcmp((const char *) xml_merge, "unique"))
311 merge = Metadata_merge_unique;
312 else if (!strcmp((const char *) xml_merge, "longest"))
313 merge = Metadata_merge_longest;
314 else if (!strcmp((const char *) xml_merge, "range"))
315 merge = Metadata_merge_range;
316 else if (!strcmp((const char *) xml_merge, "all"))
317 merge = Metadata_merge_all;
321 "Unknown value for metadata/merge: %s", xml_merge);
326 merge = Metadata_merge_no;
330 if (!strcmp((const char *) xml_setting, "no"))
331 setting = Metadata_setting_no;
332 else if (!strcmp((const char *) xml_setting, "postproc"))
333 setting = Metadata_setting_postproc;
334 else if (!strcmp((const char *) xml_setting, "parameter"))
335 setting = Metadata_setting_parameter;
339 "Unknown value for medadata/setting: %s", xml_setting);
344 // add a sortkey if so specified
345 if (xml_sortkey && strcmp((const char *) xml_sortkey, "no"))
347 if (merge == Metadata_merge_no)
350 "Can't specify sortkey on a non-merged field");
353 if (!strcmp((const char *) xml_sortkey, "numeric"))
354 sk_type = Metadata_sortkey_numeric;
355 else if (!strcmp((const char *) xml_sortkey, "skiparticle"))
356 sk_type = Metadata_sortkey_skiparticle;
360 "Unknown sortkey in metadata element: %s",
364 sortkey_offset = sk_node;
366 conf_service_add_sortkey(nmem, service, sk_node,
367 (const char *) xml_name, sk_type);
374 // metadata known, assign values
375 conf_service_add_metadata(nmem, service, md_node,
376 (const char *) xml_name,
377 type, merge, setting,
378 brief, termlist, rank, sortkey_offset);
382 xmlFree(xml_sortkey);
385 xmlFree(xml_termlist);
387 xmlFree(xml_setting);
392 yaz_log(YLOG_FATAL, "Bad element: %s", n->name);
399 static char *parse_settings(xmlNode *node)
401 xmlChar *src = xmlGetProp(node, (xmlChar *) "src");
405 r = nmem_strdup(nmem, (const char *) src);
408 yaz_log(YLOG_FATAL, "Must specify src in targetprofile");
415 static struct conf_server *parse_server(xmlNode *node)
418 struct conf_server *server = nmem_malloc(nmem, sizeof(struct conf_server));
422 server->proxy_host = 0;
423 server->proxy_port = 0;
427 server->settings = 0;
428 server->relevance_pct = 0;
429 server->sort_pct = 0;
430 server->mergekey_pct = 0;
432 for (n = node->children; n; n = n->next)
434 if (n->type != XML_ELEMENT_NODE)
436 if (!strcmp((const char *) n->name, "listen"))
438 xmlChar *port = xmlGetProp(n, (xmlChar *) "port");
439 xmlChar *host = xmlGetProp(n, (xmlChar *) "host");
441 server->port = atoi((const char *) port);
443 server->host = nmem_strdup(nmem, (const char *) host);
447 else if (!strcmp((const char *) n->name, "proxy"))
449 xmlChar *port = xmlGetProp(n, (xmlChar *) "port");
450 xmlChar *host = xmlGetProp(n, (xmlChar *) "host");
451 xmlChar *myurl = xmlGetProp(n, (xmlChar *) "myurl");
453 server->proxy_port = atoi((const char *) port);
455 server->proxy_host = nmem_strdup(nmem, (const char *) host);
457 server->myurl = nmem_strdup(nmem, (const char *) myurl);
462 else if (!strcmp((const char *) n->name, "settings"))
464 if (server->settings)
466 yaz_log(YLOG_FATAL, "Can't repeat 'settings'");
469 if (!(server->settings = parse_settings(n)))
472 else if (!strcmp((const char *) n->name, "relevance"))
474 server->relevance_pct = pp2_charset_create_xml(n);
475 if (!server->relevance_pct)
478 else if (!strcmp((const char *) n->name, "sort"))
480 server->sort_pct = pp2_charset_create_xml(n);
481 if (!server->sort_pct)
484 else if (!strcmp((const char *) n->name, "mergekey"))
486 server->mergekey_pct = pp2_charset_create_xml(n);
487 if (!server->mergekey_pct)
490 else if (!strcmp((const char *) n->name, "service"))
492 struct conf_service *s = parse_service(n);
499 yaz_log(YLOG_FATAL, "Bad element: %s", n->name);
503 if (!server->relevance_pct)
504 server->relevance_pct = pp2_charset_create(0);
505 if (!server->sort_pct)
506 server->sort_pct = pp2_charset_create(0);
507 if (!server->mergekey_pct)
508 server->mergekey_pct = pp2_charset_create(0);
512 xsltStylesheet *conf_load_stylesheet(const char *fname)
516 yaz_snprintf(path, sizeof(path), fname);
518 yaz_snprintf(path, sizeof(path), "%s/%s", confdir, fname);
519 return xsltParseStylesheetFile((xmlChar *) path);
522 static struct conf_targetprofiles *parse_targetprofiles(xmlNode *node)
524 struct conf_targetprofiles *r = nmem_malloc(nmem, sizeof(*r));
525 xmlChar *type = xmlGetProp(node, (xmlChar *) "type");
526 xmlChar *src = xmlGetProp(node, (xmlChar *) "src");
528 memset(r, 0, sizeof(*r));
532 if (!strcmp((const char *) type, "local"))
533 r->type = Targetprofiles_local;
536 yaz_log(YLOG_FATAL, "Unknown targetprofile type");
542 yaz_log(YLOG_FATAL, "Must specify type for targetprofile");
547 r->src = nmem_strdup(nmem, (const char *) src);
550 yaz_log(YLOG_FATAL, "Must specify src in targetprofile");
558 static struct conf_config *parse_config(xmlNode *root)
561 struct conf_config *r = nmem_malloc(nmem, sizeof(struct conf_config));
564 r->targetprofiles = 0;
566 for (n = root->children; n; n = n->next)
568 if (n->type != XML_ELEMENT_NODE)
570 if (!strcmp((const char *) n->name, "server"))
572 struct conf_server *tmp = parse_server(n);
575 tmp->next = r->servers;
578 else if (!strcmp((const char *) n->name, "targetprofiles"))
580 // It would be fun to be able to fix this sometime
581 if (r->targetprofiles)
583 yaz_log(YLOG_FATAL, "Can't repeat targetprofiles");
586 if (!(r->targetprofiles = parse_targetprofiles(n)))
591 yaz_log(YLOG_FATAL, "Bad element: %s", n->name);
598 int read_config(const char *fname)
600 xmlDoc *doc = xmlParseFile(fname);
603 if (!nmem) // Initialize
605 nmem = nmem_create();
606 xmlSubstituteEntitiesDefault(1);
607 xmlLoadExtDtdDefaultValue = 1;
611 yaz_log(YLOG_FATAL, "Failed to read %s", fname);
614 if ((p = strrchr(fname, '/')))
617 if (len >= sizeof(confdir))
618 len = sizeof(confdir)-1;
619 strncpy(confdir, fname, len);
622 config = parse_config(xmlDocGetRootElement(doc));
635 * indent-tabs-mode: nil
637 * vim: shiftwidth=4 tabstop=8 expandtab