Merge branch 'master' into paz-927
[pazpar2-moved-to-github.git] / src / pazpar2_config.c
1 /* This file is part of Pazpar2.
2    Copyright (C) Index Data
3
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
7 version.
8
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
12 for more details.
13
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
17
18 */
19
20 #if HAVE_CONFIG_H
21 #include <config.h>
22 #endif
23
24 #include <string.h>
25 #include <assert.h>
26
27 #include <libxml/parser.h>
28 #include <libxml/tree.h>
29 #include <libxml/xinclude.h>
30
31 #include <yaz/yaz-util.h>
32 #include <yaz/nmem.h>
33 #include <yaz/snprintf.h>
34 #include <yaz/tpath.h>
35 #include <yaz/xml_include.h>
36
37 #include <sys/types.h>
38 #include <sys/stat.h>
39 #if HAVE_UNISTD_H
40 #include <unistd.h>
41 #endif
42 #include "ppmutex.h"
43 #include "incref.h"
44 #include "pazpar2_config.h"
45 #include "service_xslt.h"
46 #include "settings.h"
47 #include "eventl.h"
48 #include "http.h"
49
50 struct conf_config
51 {
52     NMEM nmem; /* for conf_config and servers memory */
53     struct conf_server *servers;
54
55     int no_threads;
56     WRBUF confdir;
57     iochan_man_t iochan_man;
58 };
59
60 struct service_xslt
61 {
62     char *id;
63     xsltStylesheetPtr xsp;
64     struct service_xslt *next;
65 };
66
67 static char *xml_context(const xmlNode *ptr, char *res, size_t len)
68 {
69     xmlAttr *attr = ptr->properties;
70     size_t off = len - 1;
71
72     res[off] = '\0';
73     for (; attr; attr = attr->next)
74     {
75         size_t l = strlen((const char *) attr->name);
76         if (off <= l + 1)
77             break;
78         off = off - l;
79         memcpy(res + off, attr->name, l);
80         res[--off] = '@';
81     }
82     while (ptr && ptr->type == XML_ELEMENT_NODE)
83     {
84         size_t l = strlen((const char *) ptr->name);
85         if (off <= l + 1)
86             break;
87
88         off = off - l;
89         memcpy(res + off, ptr->name, l);
90         res[--off] = '/';
91
92         ptr = ptr->parent;
93     }
94     return res + off;
95 }
96
97 struct conf_service *service_init(struct conf_server *server,
98                                          int num_metadata, int num_sortkeys,
99                                          const char *service_id)
100 {
101     struct conf_service * service = 0;
102     NMEM nmem = nmem_create();
103
104
105     service = nmem_malloc(nmem, sizeof(struct conf_service));
106     service->mutex = 0;
107     service->ref_count = 1;
108     service->nmem = nmem;
109     service->next = 0;
110     service->databases = 0;
111     service->xslt_list = 0;
112     service->ccl_bibset = 0;
113     service->server = server;
114     service->session_timeout = 60; /* default session timeout */
115     service->z3950_session_timeout = 180;
116     service->z3950_operation_timeout = 30;
117     service->rank_cluster = 1;
118     service->rank_debug = 0;
119     service->rank_follow = 0.0;
120     service->rank_lead = 0.0;
121     service->rank_length = 2;
122
123     service->charsets = 0;
124
125     service->id = service_id ? nmem_strdup(nmem, service_id) : 0;
126
127     // Setup a dictionary from server.
128     service->dictionary = 0;
129
130     service->settings = nmem_malloc(nmem, sizeof(*service->settings));
131     service->settings->num_settings = PZ_MAX_EOF;
132     service->settings->settings = nmem_malloc(nmem, sizeof(struct setting*) * service->settings->num_settings);
133     memset(service->settings->settings, 0, sizeof(struct setting*) * service->settings->num_settings);
134     //  inherit_server_settings_values(service);
135
136     service->next = 0;
137
138     service->num_metadata = num_metadata;
139
140     service->metadata = 0;
141     if (service->num_metadata)
142         service->metadata
143             = nmem_malloc(nmem,
144                           sizeof(struct conf_metadata) * service->num_metadata);
145     service->num_sortkeys = num_sortkeys;
146
147     service->default_sort = nmem_strdup(nmem, "relevance");
148     service->sortkeys = 0;
149     if (service->num_sortkeys)
150         service->sortkeys
151             = nmem_malloc(nmem,
152                           sizeof(struct conf_sortkey) * service->num_sortkeys);
153     service->xml_node = 0;
154     return service;
155 }
156
157 static struct conf_metadata* conf_service_add_metadata(
158     struct conf_service *service,
159     int field_id,
160     const char *name,
161     enum conf_metadata_type type,
162     enum conf_metadata_merge merge,
163     enum conf_setting_type setting,
164     int brief,
165     int termlist,
166     const char *rank,
167     int sortkey_offset,
168     enum conf_metadata_mergekey mt,
169     const char *facetrule,
170     const char *limitmap,
171     const char *limitcluster
172     )
173 {
174     struct conf_metadata * md = 0;
175     NMEM nmem = service->nmem;
176
177     if (!service->metadata || !service->num_metadata
178         || field_id < 0  || !(field_id < service->num_metadata))
179         return 0;
180
181     md = service->metadata + field_id;
182     assert(nmem && md && name);
183
184     md->name = nmem_strdup(nmem, name);
185
186     md->type = type;
187
188     // enforcing that type_year is always range_merge
189     if (md->type == Metadata_type_year)
190         md->merge = Metadata_merge_range;
191     else
192         md->merge = merge;
193
194     md->setting = setting;
195     md->brief = brief;
196     md->termlist = termlist;
197     md->rank = nmem_strdup_null(nmem, rank);
198     md->sortkey_offset = sortkey_offset;
199     md->mergekey = mt;
200     md->facetrule = nmem_strdup_null(nmem, facetrule);
201     md->limitmap = nmem_strdup_null(nmem, limitmap);
202     md->limitcluster = nmem_strdup_null(nmem, limitcluster);
203     return md;
204 }
205
206 static struct conf_sortkey *conf_service_add_sortkey(
207     struct conf_service *service,
208     int field_id,
209     const char *name,
210     enum conf_metadata_type type)
211 {
212     struct conf_sortkey *sk = 0;
213     NMEM nmem = service->nmem;
214
215     if (!service->sortkeys || !service->num_sortkeys
216         || field_id < 0 || !(field_id < service->num_sortkeys))
217         return 0;
218
219     sk = service->sortkeys + field_id;
220
221     assert(nmem && sk && name);
222
223     sk->name = nmem_strdup(nmem, name);
224     sk->type = type;
225     return sk;
226 }
227
228 int conf_service_metadata_field_id(struct conf_service *service,
229                                    const char * name)
230 {
231     int i = 0;
232
233     if (!service || !service->metadata || !service->num_metadata)
234         return -1;
235
236     for (i = 0; i < service->num_metadata; i++)
237         if (!strcmp(name, (service->metadata[i]).name))
238             return i;
239     return -1;
240 }
241
242 int conf_service_sortkey_field_id(struct conf_service *service,
243                                   const char * name)
244 {
245     int i = 0;
246
247     if (!service || !service->sortkeys || !service->num_sortkeys)
248         return -1;
249
250     for (i = 0; i < service->num_sortkeys; i++)
251         if (!strcmp(name, (service->sortkeys[i]).name))
252             return i;
253     return -1;
254 }
255
256 static void conf_dir_path(struct conf_config *config, WRBUF w, const char *src)
257 {
258     if (config->confdir && wrbuf_len(config->confdir) > 0 &&
259         !yaz_is_abspath(src))
260     {
261         wrbuf_printf(w, "%s/%s", wrbuf_cstr(config->confdir), src);
262     }
263     else
264         wrbuf_puts(w, src);
265 }
266
267 void service_destroy(struct conf_service *service)
268 {
269     if (service)
270     {
271         if (!pazpar2_decref(&service->ref_count, service->mutex))
272         {
273             service_xslt_destroy(service);
274             pp2_charset_fact_destroy(service->charsets);
275             ccl_qual_rm(&service->ccl_bibset);
276             yaz_mutex_destroy(&service->mutex);
277             nmem_destroy(service->nmem);
278         }
279     }
280 }
281
282 void service_incref(struct conf_service *service)
283 {
284     pazpar2_incref(&service->ref_count, service->mutex);
285 }
286
287 static int parse_metadata(struct conf_service *service, xmlNode *n,
288                           int *md_node, int *sk_node)
289 {
290     enum conf_metadata_type type = Metadata_type_generic;
291     enum conf_metadata_merge merge = Metadata_merge_no;
292     enum conf_setting_type setting = Metadata_setting_no;
293     enum conf_metadata_mergekey mergekey_type = Metadata_mergekey_no;
294     int brief = 0;
295     int termlist = 0;
296     int sortkey_offset = 0;
297     xmlChar *xml_name = 0;
298     xmlChar *xml_brief = 0;
299     xmlChar *xml_sortkey = 0;
300     xmlChar *xml_merge = 0;
301     xmlChar *xml_type = 0;
302     xmlChar *xml_termlist = 0;
303     xmlChar *xml_rank = 0;
304     xmlChar *xml_setting = 0;
305     xmlChar *xml_mergekey = 0;
306     xmlChar *xml_limitmap = 0;
307     xmlChar *xml_limitcluster = 0;
308     xmlChar *xml_icu_chain = 0;
309
310     struct _xmlAttr *attr;
311
312     assert(service);
313
314     for (attr = n->properties; attr; attr = attr->next)
315     {
316         if (!xmlStrcmp(attr->name, BAD_CAST "name") &&
317             attr->children && attr->children->type == XML_TEXT_NODE)
318             xml_name = attr->children->content;
319         else if (!xmlStrcmp(attr->name, BAD_CAST "brief") &&
320                  attr->children && attr->children->type == XML_TEXT_NODE)
321             xml_brief = attr->children->content;
322         else if (!xmlStrcmp(attr->name, BAD_CAST "sortkey") &&
323                  attr->children && attr->children->type == XML_TEXT_NODE)
324             xml_sortkey = attr->children->content;
325         else if (!xmlStrcmp(attr->name, BAD_CAST "merge") &&
326                  attr->children && attr->children->type == XML_TEXT_NODE)
327             xml_merge = attr->children->content;
328         else if (!xmlStrcmp(attr->name, BAD_CAST "type") &&
329                  attr->children && attr->children->type == XML_TEXT_NODE)
330             xml_type = attr->children->content;
331         else if (!xmlStrcmp(attr->name, BAD_CAST "termlist") &&
332                  attr->children && attr->children->type == XML_TEXT_NODE)
333             xml_termlist = attr->children->content;
334         else if (!xmlStrcmp(attr->name, BAD_CAST "rank") &&
335                  attr->children && attr->children->type == XML_TEXT_NODE)
336             xml_rank = attr->children->content;
337         else if (!xmlStrcmp(attr->name, BAD_CAST "setting") &&
338                  attr->children && attr->children->type == XML_TEXT_NODE)
339             xml_setting = attr->children->content;
340         else if (!xmlStrcmp(attr->name, BAD_CAST "mergekey") &&
341                  attr->children && attr->children->type == XML_TEXT_NODE)
342             xml_mergekey = attr->children->content;
343         else if (!xmlStrcmp(attr->name, BAD_CAST "facetrule") &&
344                  attr->children && attr->children->type == XML_TEXT_NODE)
345             xml_icu_chain = attr->children->content;
346         else if (!xmlStrcmp(attr->name, BAD_CAST "limitmap") &&
347                  attr->children && attr->children->type == XML_TEXT_NODE)
348             xml_limitmap = attr->children->content;
349         else if (!xmlStrcmp(attr->name, BAD_CAST "limitcluster") &&
350                  attr->children && attr->children->type == XML_TEXT_NODE)
351             xml_limitcluster = attr->children->content;
352         else
353         {
354             yaz_log(YLOG_FATAL, "Unknown metadata attribute '%s'", attr->name);
355             return -1;
356         }
357     }
358
359     // now do the parsing logic
360     if (!xml_name)
361     {
362         yaz_log(YLOG_FATAL, "Must specify name in metadata element");
363         return -1;
364     }
365     if (xml_brief)
366     {
367         if (!strcmp((const char *) xml_brief, "yes"))
368             brief = 1;
369         else if (strcmp((const char *) xml_brief, "no"))
370         {
371             yaz_log(YLOG_FATAL, "metadata/brief must be yes or no");
372             return -1;
373         }
374     }
375
376     if (xml_termlist)
377     {
378         if (!strcmp((const char *) xml_termlist, "yes"))
379             termlist = 1;
380         else if (strcmp((const char *) xml_termlist, "no"))
381         {
382             yaz_log(YLOG_FATAL, "metadata/termlist must be yes or no");
383             return -1;
384         }
385     }
386
387     if (xml_type)
388     {
389         if (!strcmp((const char *) xml_type, "generic"))
390             type = Metadata_type_generic;
391         else if (!strcmp((const char *) xml_type, "year"))
392             type = Metadata_type_year;
393         else if (!strcmp((const char *) xml_type, "date"))
394             type = Metadata_type_date;
395         else if (!strcmp((const char *) xml_type, "float"))
396             type = Metadata_type_float;
397         else
398         {
399             yaz_log(YLOG_FATAL,
400                     "Unknown value for metadata/type: %s", xml_type);
401             return -1;
402         }
403     }
404
405     if (xml_merge)
406     {
407         if (!strcmp((const char *) xml_merge, "no"))
408             merge = Metadata_merge_no;
409         else if (!strcmp((const char *) xml_merge, "unique"))
410             merge = Metadata_merge_unique;
411         else if (!strcmp((const char *) xml_merge, "longest"))
412             merge = Metadata_merge_longest;
413         else if (!strcmp((const char *) xml_merge, "range"))
414             merge = Metadata_merge_range;
415         else if (!strcmp((const char *) xml_merge, "all"))
416             merge = Metadata_merge_all;
417         else if (!strcmp((const char *) xml_merge, "first"))
418             merge = Metadata_merge_first;
419         else
420         {
421             yaz_log(YLOG_FATAL,
422                     "Unknown value for metadata/merge: %s", xml_merge);
423             return -1;
424         }
425     }
426
427     if (xml_setting)
428     {
429         if (!strcmp((const char *) xml_setting, "no"))
430             setting = Metadata_setting_no;
431         else if (!strcmp((const char *) xml_setting, "postproc"))
432             setting = Metadata_setting_postproc;
433         else if (!strcmp((const char *) xml_setting, "parameter"))
434             setting = Metadata_setting_parameter;
435         else
436         {
437             yaz_log(YLOG_FATAL,
438                     "Unknown value for metadata/setting: %s", xml_setting);
439             return -1;
440         }
441     }
442
443     // add a sortkey if so specified
444     if (xml_sortkey && strcmp((const char *) xml_sortkey, "no"))
445     {
446         enum conf_metadata_type sk_type = type;
447         if (merge == Metadata_merge_no)
448         {
449             yaz_log(YLOG_FATAL,
450                     "Can't specify sortkey on a non-merged field");
451             return -1;
452         }
453         if (!strcmp((const char *) xml_sortkey, "yes"))
454             ;
455         if (!strcmp((const char *) xml_sortkey, "numeric"))
456             ;
457         else if (!strcmp((const char *) xml_sortkey, "skiparticle"))
458         {
459             if (sk_type == Metadata_type_generic)
460                 sk_type = Metadata_type_skiparticle;
461             else
462             {
463                 yaz_log(YLOG_FATAL,
464                         "skiparticle only supported for type=generic: %s",
465                     xml_type);
466                 return -1;
467             }
468         }
469         else
470         {
471             yaz_log(YLOG_FATAL,
472                     "Unknown sortkey in metadata element: %s",
473                     xml_sortkey);
474             return -1;
475         }
476         sortkey_offset = *sk_node;
477
478         conf_service_add_sortkey(service, *sk_node,
479                                  (const char *) xml_name, sk_type);
480         (*sk_node)++;
481     }
482     else
483         sortkey_offset = -1;
484
485     if (xml_mergekey)
486     {
487         if (!strcmp((const char *) xml_mergekey, "required"))
488             mergekey_type = Metadata_mergekey_required;
489         else if (!strcmp((const char *) xml_mergekey, "optional"))
490             mergekey_type = Metadata_mergekey_optional;
491         else if (!strcmp((const char *) xml_mergekey, "no"))
492             mergekey_type = Metadata_mergekey_no;
493         else
494         {
495             yaz_log(YLOG_FATAL, "Unknown value for mergekey: %s", xml_mergekey);
496             return -1;
497         }
498     }
499
500     // metadata known, assign values
501     conf_service_add_metadata(service, *md_node,
502                               (const char *) xml_name,
503                               type, merge, setting,
504                               brief, termlist,
505                               (const char *) xml_rank, sortkey_offset,
506                               mergekey_type,
507                               (const char *) xml_icu_chain,
508                               (const char *) xml_limitmap,
509                               (const char *) xml_limitcluster);
510     (*md_node)++;
511     return 0;
512 }
513
514
515 static void count_metadata(xmlNode *n, int *num_metadata, int *num_sortkeys)
516 {
517     xmlChar *sortkey = xmlGetProp(n, (xmlChar *) "sortkey");
518     (*num_metadata)++;
519
520     if (sortkey && strcmp((const char *) sortkey, "no"))
521         (*num_sortkeys)++;
522     xmlFree(sortkey);
523 }
524
525
526 static struct conf_service *service_create_static(struct conf_server *server,
527                                                   xmlNode *node,
528                                                   const char *service_id)
529 {
530     xmlNode *n;
531     int md_node = 0;
532     int sk_node = 0;
533
534     struct conf_service *service = 0;
535     int num_metadata = 0;
536     int num_sortkeys = 0;
537     int got_settings = 0;
538
539     // count num_metadata and num_sortkeys
540     for (n = node->children; n; n = n->next)
541         if (n->type == XML_ELEMENT_NODE && !strcmp((const char *)
542                                                    n->name, "metadata"))
543         {
544             if (n->children) // This is a <metadata> container, look at its contents.
545             {
546                 xmlNode *m;
547                 for (m = n->children; m; m = m->next)
548                 {
549                     if (m->type == XML_ELEMENT_NODE &&
550                             !strcmp((const char *) m->name, "metadata"))
551                         count_metadata(m, &num_metadata, &num_sortkeys);
552                 }
553             }
554             else // This is a metadata-element proper, count it right away.
555                 count_metadata(n, &num_metadata, &num_sortkeys);
556         }
557
558     service = service_init(server, num_metadata, num_sortkeys, service_id);
559
560     for (n = node->children; n; n = n->next)
561     {
562         if (n->type != XML_ELEMENT_NODE)
563             continue;
564         if (!strcmp((const char *) n->name, "timeout"))
565         {
566             xmlChar *src = xmlGetProp(n, (xmlChar *) "session");
567             if (src)
568             {
569                 service->session_timeout = atoi((const char *) src);
570                 xmlFree(src);
571                 if (service->session_timeout < 9)
572                 {
573                     yaz_log(YLOG_FATAL, "session timeout out of range");
574                     return 0;
575                 }
576             }
577             src = xmlGetProp(n, (xmlChar *) "z3950_operation");
578             if (src)
579             {
580                 service->z3950_operation_timeout = atoi((const char *) src);
581                 xmlFree(src);
582                 if (service->z3950_session_timeout < 9)
583                 {
584                     yaz_log(YLOG_FATAL, "Z39.50 operation timeout out of range");
585                     return 0;
586                 }
587             }
588             src = xmlGetProp(n, (xmlChar *) "z3950_session");
589             if (src)
590             {
591                 service->z3950_session_timeout = atoi((const char *) src);
592                 xmlFree(src);
593                 if (service->z3950_session_timeout < 9)
594                 {
595                     yaz_log(YLOG_FATAL, "Z39.50 session timeout out of range");
596                     return 0;
597                 }
598             }
599         }
600         else if (!strcmp((const char *) n->name, "ccldirective"))
601         {
602             char *name;
603             char *value;
604             if (!service->ccl_bibset)
605                 service->ccl_bibset = ccl_qual_mk();
606             name = (char *) xmlGetProp(n, (xmlChar *) "name");
607             if (!name)
608             {
609                 yaz_log(YLOG_FATAL, "ccldirective: missing @name");
610                 return 0;
611             }
612             value = (char *) xmlGetProp(n, (xmlChar *) "value");
613             if (!value)
614             {
615                 xmlFree(name);
616                 yaz_log(YLOG_FATAL, "ccldirective: missing @value");
617                 return 0;
618             }
619             ccl_qual_add_special(service->ccl_bibset, name, value);
620             xmlFree(value);
621             xmlFree(name);
622         }
623         else if (!strcmp((const char *) n->name, "settings"))
624             got_settings++;
625         else if (!strcmp((const char *) n->name, "icu_chain"))
626         {
627             if (!service->charsets)
628                 service->charsets = pp2_charset_fact_create();
629             if (pp2_charset_fact_define(service->charsets, n, 0))
630             {
631                 yaz_log(YLOG_FATAL, "ICU chain definition error");
632                 return 0;
633             }
634         }
635         else if (!strcmp((const char *) n->name, "relevance")
636                  || !strcmp((const char *) n->name, "sort")
637                  || !strcmp((const char *) n->name, "mergekey")
638                  || !strcmp((const char *) n->name, "facet"))
639
640         {
641             if (!service->charsets)
642                 service->charsets = pp2_charset_fact_create();
643             if (pp2_charset_fact_define(service->charsets, n,
644                                         (const char *) n->name))
645             {
646                 yaz_log(YLOG_FATAL, "ICU chain definition error");
647                 return 0;
648             }
649         }
650         else if (!strcmp((const char *) n->name, (const char *) "metadata"))
651         {
652             if (n->children) // This is a <metadata> container, look at its content.
653             {
654                 xmlNode *m;
655                 for (m = n->children; m; m = m->next)
656                     if ((!strcmp((const char *) m->name, (const char *) "metadata")))
657                         if (parse_metadata(service, m, &md_node, &sk_node))
658                             return 0;
659             }
660             else // This is a metadata-element proper, count it right away.
661                 if (parse_metadata(service, n, &md_node, &sk_node))
662                     return 0;
663         }
664         else if (!strcmp((const char *) n->name, (const char *) "xslt"))
665         {
666             if (service_xslt_config(service, n))
667                 return 0;
668         }
669         else if (!strcmp((const char *) n->name, "rank"))
670         {
671             char *rank_cluster = (char *) xmlGetProp(n, (xmlChar *) "cluster");
672             char *rank_debug = (char *) xmlGetProp(n, (xmlChar *) "debug");
673             char *rank_follow = (char *) xmlGetProp(n, (xmlChar *) "follow");
674             char *rank_lead = (char *) xmlGetProp(n, (xmlChar *) "lead");
675             char *rank_length= (char *) xmlGetProp(n, (xmlChar *) "length");
676             if (rank_cluster)
677             {
678                 if (!strcmp(rank_cluster, "yes"))
679                     service->rank_cluster = 1;
680                 else if (!strcmp(rank_cluster, "no"))
681                     service->rank_cluster = 0;
682                 else
683                 {
684                     yaz_log(YLOG_FATAL, "service: rank@cluster boolean");
685                     return 0;
686                 }
687             }
688             if (rank_debug)
689             {
690                 if (!strcmp(rank_debug, "yes"))
691                     service->rank_debug = 1;
692                 else if (!strcmp(rank_debug, "no"))
693                     service->rank_debug = 0;
694                 else
695                 {
696                     yaz_log(YLOG_FATAL, "service: rank@debug boolean");
697                     return 0;
698                 }
699             }
700             if (rank_follow)
701             {
702                 service->rank_follow = atof(rank_follow);
703             }
704             if (rank_lead)
705             {
706                 service->rank_lead = atof(rank_lead);
707             }
708             if (rank_length)
709             {
710                 if (!strcmp(rank_length, "linear"))
711                     service->rank_length = 2;
712                 else if (!strcmp(rank_length, "log"))
713                     service->rank_length = 1;
714                 else if (!strcmp(rank_length, "none"))
715                     service->rank_length = 0;
716                 else
717                 {
718                     yaz_log(YLOG_FATAL, "service: rank@length linear|log|none");
719                     return 0;
720                 }
721             }
722             xmlFree(rank_cluster);
723             xmlFree(rank_debug);
724             xmlFree(rank_follow);
725             xmlFree(rank_lead);
726             xmlFree(rank_length);
727         }
728         else if (!strcmp((const char *) n->name, "sort-default"))
729         {
730             char *default_sort = (char *) xmlGetProp(n, (xmlChar *) "field");
731
732             if (default_sort && strcmp(default_sort, "")) {
733                 service->default_sort = nmem_strdup(service->nmem, default_sort);
734                 yaz_log(YLOG_LOG, "service %s: default sort order configured to: %s",
735                         service_id ? service_id : "unnamed", default_sort);
736             }
737             else
738             {
739                 yaz_log(YLOG_FATAL, "default sort order is invalid: %s", default_sort);
740                 return 0;
741             }
742             xmlFree(default_sort);
743         }
744         else
745         {
746             char tmp[80];
747             yaz_log(YLOG_FATAL, "Bad element: %s . Context: %s", n->name,
748                     xml_context(n, tmp, sizeof tmp));
749             return 0;
750         }
751     }
752     if (got_settings)
753     {
754         int pass;
755         /* metadata has been read.. Consider now settings */
756         init_settings(service);
757         for (pass = 1; pass <= 2; pass++)
758         {
759             for (n = node->children; n; n = n->next)
760             {
761                 if (n->type != XML_ELEMENT_NODE)
762                     continue;
763                 if (!strcmp((const char *) n->name, "settings"))
764                 {
765                     int ret;
766                     xmlChar *src = xmlGetProp(n, (xmlChar *) "src");
767                     if (src)
768                     {
769                         WRBUF w = wrbuf_alloc();
770                         conf_dir_path(server->config, w, (const char *) src);
771                         ret = settings_read_file(service, wrbuf_cstr(w), pass);
772                         wrbuf_destroy(w);
773                         xmlFree(src);
774                     }
775                     else
776                     {
777                         ret = settings_read_node(service, n, pass);
778                     }
779                     if (ret)
780                         return 0;
781                 }
782             }
783         }
784     }
785
786     {
787         xmlBufferPtr buf = xmlBufferCreate();
788         xmlNodeDump(buf, node->doc, node, 0, 0);
789         service->xml_node =
790             nmem_strdupn(service->nmem, (const char *) buf->content, buf->use);
791         xmlBufferFree(buf);
792     }
793     return service;
794 }
795
796 static int inherit_server_settings(struct conf_service *s)
797 {
798     int ret = 0;
799     struct conf_server *server = s->server;
800     if (!s->dictionary) /* service has no config settings ? */
801     {
802         if (server->settings_fname)
803         {
804             /* inherit settings from server */
805             init_settings(s);
806             if (settings_read_file(s, server->settings_fname, 1))
807                 ret = -1;
808             if (settings_read_file(s, server->settings_fname, 2))
809                 ret = -1;
810         }
811         else
812         {
813             yaz_log(YLOG_WARN, "server '%s' has no settings", s->id ? s->id : "unnamed");
814             init_settings(s);
815         }
816     }
817
818     /* use relevance/sort/mergekey/facet from server if not defined
819        for this service.. */
820     if (!s->charsets)
821     {
822         if (server->charsets)
823         {
824             s->charsets = server->charsets;
825             pp2_charset_fact_incref(s->charsets);
826         }
827         else
828         {
829             s->charsets = pp2_charset_fact_create();
830         }
831     }
832     return ret;
833 }
834
835 struct conf_service *service_create(struct conf_server *server,
836                                     xmlNode *node)
837 {
838     struct conf_service *service = service_create_static(server, node, 0);
839     if (service)
840     {
841         inherit_server_settings(service);
842         assert(service->mutex == 0);
843         pazpar2_mutex_create(&service->mutex, "conf");
844     }
845     return service;
846 }
847
848 static struct conf_server *server_create(struct conf_config *config,
849                                          NMEM nmem, xmlNode *node)
850 {
851     xmlNode *n;
852     struct conf_server *server = nmem_malloc(nmem, sizeof(struct conf_server));
853     xmlChar *server_id = xmlGetProp(node, (xmlChar *) "id");
854
855     server->host = "@";
856     server->port = 0;
857     server->proxy_host = 0;
858     server->proxy_port = 0;
859     server->myurl = 0;
860     server->service = 0;
861     server->config = config;
862     server->next = 0;
863     server->charsets = 0;
864     server->http_server = 0;
865     server->iochan_man = 0;
866     server->settings_fname = 0;
867
868     if (server_id)
869     {
870         server->server_id = nmem_strdup(nmem, (const char *)server_id);
871         xmlFree(server_id);
872     }
873     else
874         server->server_id = 0;
875     for (n = node->children; n; n = n->next)
876     {
877         if (n->type != XML_ELEMENT_NODE)
878             continue;
879         if (!strcmp((const char *) n->name, "listen"))
880         {
881             xmlChar *port = xmlGetProp(n, (xmlChar *) "port");
882             xmlChar *host = xmlGetProp(n, (xmlChar *) "host");
883
884             if (port)
885                 server->port = nmem_strdup(nmem, (const char *) port);
886             if (host)
887                 server->host = nmem_strdup(nmem, (const char *) host);
888
889             xmlFree(port);
890             xmlFree(host);
891         }
892         else if (!strcmp((const char *) n->name, "proxy"))
893         {
894             xmlChar *port = xmlGetProp(n, (xmlChar *) "port");
895             xmlChar *host = xmlGetProp(n, (xmlChar *) "host");
896             xmlChar *myurl = xmlGetProp(n, (xmlChar *) "myurl");
897             if (port)
898                 server->proxy_port = atoi((const char *) port);
899             if (host)
900                 server->proxy_host = nmem_strdup(nmem, (const char *) host);
901             if (myurl)
902                 server->myurl = nmem_strdup(nmem, (const char *) myurl);
903             xmlFree(port);
904             xmlFree(host);
905             xmlFree(myurl);
906         }
907         else if (!strcmp((const char *) n->name, "settings"))
908         {
909             xmlChar *src = xmlGetProp(n, (xmlChar *) "src");
910             WRBUF w;
911             if (!src)
912             {
913                 yaz_log(YLOG_FATAL, "Missing src attribute for settings");
914                 return 0;
915             }
916             if (server->settings_fname)
917             {
918                 xmlFree(src);
919                 yaz_log(YLOG_FATAL, "Can't repeat 'settings'");
920                 return 0;
921             }
922             w = wrbuf_alloc();
923             conf_dir_path(config, w, (const char *) src);
924             server->settings_fname = nmem_strdup(nmem, wrbuf_cstr(w));
925             wrbuf_destroy(w);
926             xmlFree(src);
927         }
928         else if (!strcmp((const char *) n->name, "icu_chain"))
929         {
930             if (!server->charsets)
931                 server->charsets = pp2_charset_fact_create();
932             if (pp2_charset_fact_define(server->charsets, n, 0))
933             {
934                 yaz_log(YLOG_FATAL, "ICU chain definition error");
935                 return 0;
936             }
937         }
938         else if (!strcmp((const char *) n->name, "relevance")
939                  || !strcmp((const char *) n->name, "sort")
940                  || !strcmp((const char *) n->name, "mergekey")
941                  || !strcmp((const char *) n->name, "facet"))
942         {
943             if (!server->charsets)
944                 server->charsets = pp2_charset_fact_create();
945             if (pp2_charset_fact_define(server->charsets, n,
946                                         (const char *) n->name))
947             {
948                 yaz_log(YLOG_FATAL, "ICU chain definition error");
949                 return 0;
950             }
951         }
952         else if (!strcmp((const char *) n->name, "service"))
953         {
954             char *service_id = (char *)
955                 xmlGetProp(n, (xmlChar *) "id");
956
957             struct conf_service **sp = &server->service;
958             for (; *sp; sp = &(*sp)->next)
959                 if ((*sp)->id && service_id &&
960                     0 == strcmp((*sp)->id, service_id))
961                 {
962                     yaz_log(YLOG_FATAL, "Duplicate service: %s", service_id);
963                     break;
964                 }
965                 else if (!(*sp)->id && !service_id)
966                 {
967                     yaz_log(YLOG_FATAL, "Duplicate unnamed service");
968                     break;
969                 }
970
971             if (*sp)  /* service already exist */
972             {
973                 xmlFree(service_id);
974                 return 0;
975             }
976             else
977             {
978                 struct conf_service *s = service_create_static(server, n,
979                                                                service_id);
980                 xmlFree(service_id);
981                 if (!s)
982                     return 0;
983                 *sp = s;
984             }
985         }
986         else
987         {
988             yaz_log(YLOG_FATAL, "Bad element: %s", n->name);
989             return 0;
990         }
991     }
992     if (!server->port)
993     {
994         yaz_log(YLOG_FATAL, "No listening port given");
995         return 0;
996     }
997     if (server->service)
998     {
999         struct conf_service *s;
1000         for (s = server->service; s; s = s->next)
1001             inherit_server_settings(s);
1002     }
1003     return server;
1004 }
1005
1006 WRBUF conf_get_fname(struct conf_config *config, const char *fname)
1007 {
1008     WRBUF w = wrbuf_alloc();
1009
1010     conf_dir_path(config, w, fname);
1011     return w;
1012 }
1013
1014 struct conf_service *locate_service(struct conf_server *server,
1015                                     const char *service_id)
1016 {
1017     struct conf_service *s = server->service;
1018     for (; s; s = s->next)
1019         if (s->id && service_id && 0 == strcmp(s->id, service_id))
1020             break;
1021         else if (!s->id && !service_id)
1022             break;
1023     if (s)
1024         service_incref(s);
1025     return s;
1026 }
1027
1028 static void info_service_metadata(struct conf_service *service, WRBUF w)
1029 {
1030     int i;
1031     struct conf_metadata *md;
1032
1033     if (service->num_metadata)
1034     {
1035         for (i = 0; i < service->num_metadata; i++)
1036         {
1037             md = &(service->metadata[i]);
1038             wrbuf_puts(w, "   <metadata");
1039             if (md->name) {
1040                 wrbuf_puts(w, " name=\"");
1041                 wrbuf_xmlputs(w, md->name);
1042                 wrbuf_puts(w, "\"");
1043             }
1044             if (md->brief) {
1045                 wrbuf_puts(w, " brief=\"yes\"");
1046             }
1047             if (md->termlist) {
1048                 wrbuf_puts(w, " termlist=\"yes\"");
1049             }
1050             if (md->rank) {
1051                 wrbuf_puts(w, " rank=\"");
1052                 wrbuf_xmlputs(w, md->rank);
1053                 wrbuf_puts(w, "\"");
1054             }
1055             if (md->sortkey_offset > 0) {
1056                 wrbuf_puts(w, " sortkey=\"");
1057                 switch (service->sortkeys[md->sortkey_offset].type)
1058                 {
1059                 case Metadata_type_relevance:
1060                     wrbuf_puts(w, "relevance");
1061                     break;
1062                 case Metadata_type_skiparticle:
1063                     wrbuf_puts(w, "skiparticle");
1064                     break;
1065                 case Metadata_type_position:
1066                     wrbuf_puts(w, "position");
1067                     break;
1068                 default:
1069                     wrbuf_puts(w, "yes");
1070                     break;
1071                 }
1072                 wrbuf_puts(w, "\"");
1073             }
1074             switch (md->type)
1075             {
1076             case Metadata_type_generic:
1077             case Metadata_type_skiparticle:
1078                 break;
1079             case Metadata_type_year:
1080                 wrbuf_puts(w, " type=\"year\"");
1081                 break;
1082             case Metadata_type_date:
1083                 wrbuf_puts(w, " type=\"date\"");
1084                 break;
1085             case Metadata_type_float:
1086                 wrbuf_puts(w, " type=\"float\"");
1087                 break;
1088             case Metadata_type_relevance:
1089             case Metadata_type_position:
1090                 break;
1091             }
1092             switch (md->merge)
1093             {
1094             case Metadata_merge_no:
1095                 break;
1096             case Metadata_merge_unique:
1097                 wrbuf_puts(w, " merge=\"unique\"");
1098                 break;
1099             case Metadata_merge_longest:
1100                 wrbuf_puts(w, " merge=\"longest\"");
1101                 break;
1102             case Metadata_merge_range:
1103                 wrbuf_puts(w, " merge=\"range\"");
1104                 break;
1105             case Metadata_merge_all:
1106                 wrbuf_puts(w, " merge=\"all\"");
1107                 break;
1108             case Metadata_merge_first:
1109                 wrbuf_puts(w, " merge=\"first\"");
1110                 break;
1111             }
1112             switch (md->mergekey)
1113             {
1114             case Metadata_mergekey_no:
1115                 break;
1116             case Metadata_mergekey_optional:
1117                 wrbuf_puts(w, " mergekey=\"optional\"");
1118                 break;
1119             case Metadata_mergekey_required:
1120                 wrbuf_puts(w, " mergekey=\"required\"");
1121                 break;
1122             }
1123             wrbuf_puts(w, " />\n");
1124         }
1125     }
1126 }
1127
1128 static void info_service_databases(struct conf_service *service, WRBUF w)
1129 {
1130     struct database *db;
1131     struct setting *s;
1132     int i;
1133
1134     if (service->databases)
1135     {
1136         wrbuf_puts(w, "   <databases>\n");
1137         for(db = service->databases; db; db = db->next)
1138         {
1139             wrbuf_puts(w, "    <database");
1140             if (db->id)
1141             {
1142                 wrbuf_puts(w, " id=\"");
1143                 wrbuf_printf(w, "%s", db->id);
1144                 wrbuf_puts(w, "\"");
1145             }
1146             wrbuf_puts(w, ">\n");
1147             for (i = 0; i < db->num_settings; i++)
1148             {
1149                 s = db->settings[i];
1150                 while (s != NULL)
1151                 {
1152                     wrbuf_puts(w, "     <setting");
1153                     wrbuf_puts(w, " name=\"");
1154                     wrbuf_xmlputs(w, s->name);
1155                     wrbuf_puts(w, "\"");
1156                     wrbuf_puts(w, " value=\"");
1157                     wrbuf_xmlputs(w, s->value);
1158                     wrbuf_puts(w, "\"");
1159                     wrbuf_puts(w, " />\n");
1160                     s = s->next;
1161                 }
1162             }
1163             wrbuf_puts(w, "    </database>\n");
1164         }
1165         wrbuf_puts(w, "   </databases>\n");
1166     }
1167 }
1168
1169 void info_services(struct conf_server *server, WRBUF w)
1170 {
1171     struct conf_service *s = server->service;
1172     int i;
1173     struct setting *S;
1174
1175     wrbuf_puts(w, " <services>\n");
1176     for (; s; s = s->next)
1177     {
1178         wrbuf_puts(w, "  <service");
1179         if (s->id)
1180         {
1181             wrbuf_puts(w, " id=\"");
1182             wrbuf_xmlputs(w, s->id);
1183             wrbuf_puts(w, "\"");
1184         }
1185         wrbuf_puts(w, ">\n");
1186         if (s->settings)
1187         {
1188             for (i=0; i<s->settings->num_settings; i++)
1189             {
1190                 S = s->settings->settings[i];
1191                 while (S != NULL) {
1192                     wrbuf_puts(w, "   <setting");
1193                     wrbuf_puts(w, " name=\"");
1194                     wrbuf_xmlputs(w,  S->name);
1195                     wrbuf_puts(w, "\"");
1196                     wrbuf_puts(w, " value=\"");
1197                     wrbuf_xmlputs(w, S->value);
1198                     wrbuf_puts(w, "\"");
1199                     if (S->target) {
1200                         wrbuf_puts(w, " target=\"");
1201                         wrbuf_xmlputs(w, S->target);
1202                         wrbuf_puts(w, "\"");
1203                     }
1204
1205                     wrbuf_puts(w, " />\n");
1206
1207                     S = S->next;
1208                 }
1209             }
1210         }
1211         info_service_metadata(s, w);
1212         info_service_databases(s, w);
1213         wrbuf_puts(w, "  </service>");
1214
1215         wrbuf_puts(w, "\n");
1216     }
1217     wrbuf_puts(w, " </services>\n");
1218 }
1219
1220 static int parse_config(struct conf_config *config, xmlNode *root)
1221 {
1222     xmlNode *n;
1223
1224     for (n = root->children; n; n = n->next)
1225     {
1226         if (n->type != XML_ELEMENT_NODE)
1227             continue;
1228         if (!strcmp((const char *) n->name, "server"))
1229         {
1230             struct conf_server *tmp = server_create(config, config->nmem, n);
1231             if (!tmp)
1232                 return -1;
1233             tmp->next = config->servers;
1234             config->servers = tmp;
1235         }
1236         else if (!strcmp((const char *) n->name, "threads"))
1237         {
1238             xmlChar *number = xmlGetProp(n, (xmlChar *) "number");
1239             if (number)
1240             {
1241                 config->no_threads = atoi((const char *) number);
1242                 xmlFree(number);
1243             }
1244         }
1245         else if (!strcmp((const char *) n->name, "targetprofiles"))
1246         {
1247             yaz_log(YLOG_FATAL, "targetprofiles unsupported here. Must be part of service");
1248             return -1;
1249
1250         }
1251         else
1252         {
1253             yaz_log(YLOG_FATAL, "Bad element: %s", n->name);
1254             return -1;
1255         }
1256     }
1257     return 0;
1258 }
1259
1260 struct conf_config *config_create(const char *fname, int verbose)
1261 {
1262     xmlDoc *doc = xmlReadFile(fname,
1263                               NULL,
1264                               XML_PARSE_XINCLUDE
1265                               + XML_PARSE_NSCLEAN + XML_PARSE_NONET);
1266     xmlNode *n;
1267     const char *p;
1268     int r;
1269     NMEM nmem = nmem_create();
1270     struct conf_config *config = nmem_malloc(nmem, sizeof(struct conf_config));
1271
1272     xmlSubstituteEntitiesDefault(1);
1273     xmlLoadExtDtdDefaultValue = 1;
1274     if (!doc)
1275     {
1276         yaz_log(YLOG_FATAL, "Failed to read %s", fname);
1277         nmem_destroy(nmem);
1278         return 0;
1279     }
1280
1281     // Perform XInclude.
1282     r = xmlXIncludeProcess(doc);
1283     if (r == -1)
1284     {
1285         yaz_log(YLOG_FATAL, "XInclude processing failed");
1286         return 0;
1287     }
1288
1289     config->nmem = nmem;
1290     config->servers = 0;
1291     config->no_threads = 0;
1292     config->iochan_man = 0;
1293
1294     config->confdir = wrbuf_alloc();
1295     if ((p = strrchr(fname,
1296 #ifdef WIN32
1297                      '\\'
1298 #else
1299                      '/'
1300 #endif
1301              )))
1302     {
1303         int len = p - fname;
1304         wrbuf_write(config->confdir, fname, len);
1305     }
1306     wrbuf_puts(config->confdir, "");
1307
1308     n = xmlDocGetRootElement(doc);
1309     r = yaz_xml_include_simple(n, wrbuf_cstr(config->confdir));
1310     if (r == 0) /* OK */
1311     {
1312         if (verbose)
1313         {
1314             yaz_log(YLOG_LOG, "Configuration %s after include processing",
1315                     fname);
1316 #if LIBXML_VERSION >= 20600
1317             xmlDocFormatDump(yaz_log_file(), doc, 0);
1318 #else
1319             xmlDocDump(yaz_log_file(), doc);
1320 #endif
1321         }
1322         r = parse_config(config, n);
1323     }
1324     xmlFreeDoc(doc);
1325
1326     if (r)
1327     {
1328         config_destroy(config);
1329         return 0;
1330     }
1331     return config;
1332 }
1333
1334 void server_destroy(struct conf_server *server)
1335 {
1336     struct conf_service *s = server->service;
1337     while (s)
1338     {
1339         struct conf_service *s_next = s->next;
1340         service_destroy(s);
1341         s = s_next;
1342     }
1343     pp2_charset_fact_destroy(server->charsets);
1344     http_server_destroy(server->http_server);
1345 }
1346
1347 void config_destroy(struct conf_config *config)
1348 {
1349     if (config)
1350     {
1351         struct conf_server *server = config->servers;
1352         iochan_man_destroy(&config->iochan_man);
1353         while (server)
1354         {
1355             struct conf_server *s_next = server->next;
1356             server_destroy(server);
1357             server = s_next;
1358         }
1359         wrbuf_destroy(config->confdir);
1360         nmem_destroy(config->nmem);
1361     }
1362 }
1363
1364 void config_stop_listeners(struct conf_config *conf)
1365 {
1366     struct conf_server *ser;
1367     for (ser = conf->servers; ser; ser = ser->next)
1368         http_close_server(ser);
1369 }
1370
1371 void config_process_events(struct conf_config *conf)
1372 {
1373     struct conf_server *ser;
1374
1375     for (ser = conf->servers; ser; ser = ser->next)
1376     {
1377         struct conf_service *s = ser->service;
1378
1379         for (;s ; s = s->next)
1380         {
1381             assert(s->mutex == 0);
1382             pazpar2_mutex_create(&s->mutex, "service");
1383         }
1384         http_mutex_init(ser);
1385     }
1386     iochan_man_events(conf->iochan_man);
1387 }
1388
1389 int config_start_listeners(struct conf_config *conf,
1390                            const char *listener_override,
1391                            const char *record_fname)
1392 {
1393     struct conf_server *ser;
1394
1395     conf->iochan_man = iochan_man_create(conf->no_threads);
1396     for (ser = conf->servers; ser; ser = ser->next)
1397     {
1398         WRBUF w;
1399         int r;
1400
1401         ser->iochan_man = conf->iochan_man;
1402         if (listener_override)
1403         {
1404             const char *cp = strrchr(listener_override, ':');
1405             if (cp)
1406             {
1407                 ser->host = nmem_strdupn(conf->nmem, listener_override,
1408                                          cp - listener_override);
1409                 ser->port = nmem_strdup(conf->nmem, cp + 1);
1410             }
1411             else
1412             {
1413                 ser->host = "@";
1414                 ser->port = nmem_strdup(conf->nmem, listener_override);
1415             }
1416             listener_override = 0; /* only first server is overriden */
1417         }
1418         r = http_init(ser, record_fname);
1419         if (r)
1420             return -1;
1421
1422         w = wrbuf_alloc();
1423         if (ser->proxy_host || ser->proxy_port)
1424         {
1425             if (ser->proxy_host)
1426                 wrbuf_puts(w, ser->proxy_host);
1427             if (ser->proxy_port)
1428             {
1429                 if (wrbuf_len(w))
1430                     wrbuf_puts(w, ":");
1431                 wrbuf_printf(w, "%d", ser->proxy_port);
1432             }
1433         }
1434         if (wrbuf_len(w))
1435             http_set_proxyaddr(wrbuf_cstr(w), ser);
1436         wrbuf_destroy(w);
1437     }
1438     return 0;
1439 }
1440
1441 /*
1442  * Local variables:
1443  * c-basic-offset: 4
1444  * c-file-style: "Stroustrup"
1445  * indent-tabs-mode: nil
1446  * End:
1447  * vim: shiftwidth=4 tabstop=8 expandtab
1448  */
1449