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