Remove support for deprecated ICU definitions
[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             yaz_log(YLOG_FATAL, "No longer supported: <%s>", n->name);
643             yaz_log(YLOG_LOG, "Use <icu_chain id=\"%s\">.. instead", n->name);
644             return 0;
645         }
646         else if (!strcmp((const char *) n->name, (const char *) "metadata"))
647         {
648             if (n->children) // This is a <metadata> container, look at its content.
649             {
650                 xmlNode *m;
651                 for (m = n->children; m; m = m->next)
652                     if ((!strcmp((const char *) m->name, (const char *) "metadata")))
653                         if (parse_metadata(service, m, &md_node, &sk_node))
654                             return 0;
655             }
656             else // This is a metadata-element proper, count it right away.
657                 if (parse_metadata(service, n, &md_node, &sk_node))
658                     return 0;
659         }
660         else if (!strcmp((const char *) n->name, (const char *) "xslt"))
661         {
662             if (service_xslt_config(service, n))
663                 return 0;
664         }
665         else if (!strcmp((const char *) n->name, "rank"))
666         {
667             char *rank_cluster = (char *) xmlGetProp(n, (xmlChar *) "cluster");
668             char *rank_debug = (char *) xmlGetProp(n, (xmlChar *) "debug");
669             char *rank_follow = (char *) xmlGetProp(n, (xmlChar *) "follow");
670             char *rank_lead = (char *) xmlGetProp(n, (xmlChar *) "lead");
671             char *rank_length= (char *) xmlGetProp(n, (xmlChar *) "length");
672             if (rank_cluster)
673             {
674                 if (!strcmp(rank_cluster, "yes"))
675                     service->rank_cluster = 1;
676                 else if (!strcmp(rank_cluster, "no"))
677                     service->rank_cluster = 0;
678                 else
679                 {
680                     yaz_log(YLOG_FATAL, "service: rank@cluster boolean");
681                     return 0;
682                 }
683             }
684             if (rank_debug)
685             {
686                 if (!strcmp(rank_debug, "yes"))
687                     service->rank_debug = 1;
688                 else if (!strcmp(rank_debug, "no"))
689                     service->rank_debug = 0;
690                 else
691                 {
692                     yaz_log(YLOG_FATAL, "service: rank@debug boolean");
693                     return 0;
694                 }
695             }
696             if (rank_follow)
697             {
698                 service->rank_follow = atof(rank_follow);
699             }
700             if (rank_lead)
701             {
702                 service->rank_lead = atof(rank_lead);
703             }
704             if (rank_length)
705             {
706                 if (!strcmp(rank_length, "linear"))
707                     service->rank_length = 2;
708                 else if (!strcmp(rank_length, "log"))
709                     service->rank_length = 1;
710                 else if (!strcmp(rank_length, "none"))
711                     service->rank_length = 0;
712                 else
713                 {
714                     yaz_log(YLOG_FATAL, "service: rank@length linear|log|none");
715                     return 0;
716                 }
717             }
718             xmlFree(rank_cluster);
719             xmlFree(rank_debug);
720             xmlFree(rank_follow);
721             xmlFree(rank_lead);
722             xmlFree(rank_length);
723         }
724         else if (!strcmp((const char *) n->name, "sort-default"))
725         {
726             char *default_sort = (char *) xmlGetProp(n, (xmlChar *) "field");
727
728             if (default_sort && strcmp(default_sort, "")) {
729                 service->default_sort = nmem_strdup(service->nmem, default_sort);
730                 yaz_log(YLOG_LOG, "service %s: default sort order configured to: %s",
731                         service_id ? service_id : "unnamed", default_sort);
732             }
733             else
734             {
735                 yaz_log(YLOG_FATAL, "default sort order is invalid: %s", default_sort);
736                 return 0;
737             }
738             xmlFree(default_sort);
739         }
740         else
741         {
742             char tmp[80];
743             yaz_log(YLOG_FATAL, "Bad element: %s . Context: %s", n->name,
744                     xml_context(n, tmp, sizeof tmp));
745             return 0;
746         }
747     }
748     if (got_settings)
749     {
750         int pass;
751         /* metadata has been read.. Consider now settings */
752         init_settings(service);
753         for (pass = 1; pass <= 2; pass++)
754         {
755             for (n = node->children; n; n = n->next)
756             {
757                 if (n->type != XML_ELEMENT_NODE)
758                     continue;
759                 if (!strcmp((const char *) n->name, "settings"))
760                 {
761                     int ret;
762                     xmlChar *src = xmlGetProp(n, (xmlChar *) "src");
763                     if (src)
764                     {
765                         WRBUF w = wrbuf_alloc();
766                         conf_dir_path(server->config, w, (const char *) src);
767                         ret = settings_read_file(service, wrbuf_cstr(w), pass);
768                         wrbuf_destroy(w);
769                         xmlFree(src);
770                     }
771                     else
772                     {
773                         ret = settings_read_node(service, n, pass);
774                     }
775                     if (ret)
776                         return 0;
777                 }
778             }
779         }
780     }
781
782     {
783         xmlBufferPtr buf = xmlBufferCreate();
784         xmlNodeDump(buf, node->doc, node, 0, 0);
785         service->xml_node =
786             nmem_strdupn(service->nmem, (const char *) buf->content, buf->use);
787         xmlBufferFree(buf);
788     }
789     return service;
790 }
791
792 static int inherit_server_settings(struct conf_service *s)
793 {
794     int ret = 0;
795     struct conf_server *server = s->server;
796     if (!s->dictionary) /* service has no config settings ? */
797     {
798         if (server->settings_fname)
799         {
800             /* inherit settings from server */
801             init_settings(s);
802             if (settings_read_file(s, server->settings_fname, 1))
803                 ret = -1;
804             if (settings_read_file(s, server->settings_fname, 2))
805                 ret = -1;
806         }
807         else
808         {
809             yaz_log(YLOG_WARN, "server '%s' has no settings", s->id ? s->id : "unnamed");
810             init_settings(s);
811         }
812     }
813
814     /* use relevance/sort/mergekey/facet from server if not defined
815        for this service.. */
816     if (!s->charsets)
817     {
818         if (server->charsets)
819         {
820             s->charsets = server->charsets;
821             pp2_charset_fact_incref(s->charsets);
822         }
823         else
824         {
825             s->charsets = pp2_charset_fact_create();
826         }
827     }
828     return ret;
829 }
830
831 struct conf_service *service_create(struct conf_server *server,
832                                     xmlNode *node)
833 {
834     struct conf_service *service = service_create_static(server, node, 0);
835     if (service)
836     {
837         inherit_server_settings(service);
838         assert(service->mutex == 0);
839         pazpar2_mutex_create(&service->mutex, "conf");
840     }
841     return service;
842 }
843
844 static struct conf_server *server_create(struct conf_config *config,
845                                          NMEM nmem, xmlNode *node)
846 {
847     xmlNode *n;
848     struct conf_server *server = nmem_malloc(nmem, sizeof(struct conf_server));
849     xmlChar *server_id = xmlGetProp(node, (xmlChar *) "id");
850
851     server->host = "@";
852     server->port = 0;
853     server->proxy_host = 0;
854     server->proxy_port = 0;
855     server->myurl = 0;
856     server->service = 0;
857     server->config = config;
858     server->next = 0;
859     server->charsets = 0;
860     server->http_server = 0;
861     server->iochan_man = 0;
862     server->database_hosts = config->database_hosts;
863     server->settings_fname = 0;
864
865     if (server_id)
866     {
867         server->server_id = nmem_strdup(nmem, (const char *)server_id);
868         xmlFree(server_id);
869     }
870     else
871         server->server_id = 0;
872     for (n = node->children; n; n = n->next)
873     {
874         if (n->type != XML_ELEMENT_NODE)
875             continue;
876         if (!strcmp((const char *) n->name, "listen"))
877         {
878             xmlChar *port = xmlGetProp(n, (xmlChar *) "port");
879             xmlChar *host = xmlGetProp(n, (xmlChar *) "host");
880
881             if (port)
882                 server->port = nmem_strdup(nmem, (const char *) port);
883             if (host)
884                 server->host = nmem_strdup(nmem, (const char *) host);
885
886             xmlFree(port);
887             xmlFree(host);
888         }
889         else if (!strcmp((const char *) n->name, "proxy"))
890         {
891             xmlChar *port = xmlGetProp(n, (xmlChar *) "port");
892             xmlChar *host = xmlGetProp(n, (xmlChar *) "host");
893             xmlChar *myurl = xmlGetProp(n, (xmlChar *) "myurl");
894             if (port)
895                 server->proxy_port = atoi((const char *) port);
896             if (host)
897                 server->proxy_host = nmem_strdup(nmem, (const char *) host);
898             if (myurl)
899                 server->myurl = nmem_strdup(nmem, (const char *) myurl);
900             xmlFree(port);
901             xmlFree(host);
902             xmlFree(myurl);
903         }
904         else if (!strcmp((const char *) n->name, "settings"))
905         {
906             xmlChar *src = xmlGetProp(n, (xmlChar *) "src");
907             WRBUF w;
908             if (!src)
909             {
910                 yaz_log(YLOG_FATAL, "Missing src attribute for settings");
911                 return 0;
912             }
913             if (server->settings_fname)
914             {
915                 xmlFree(src);
916                 yaz_log(YLOG_FATAL, "Can't repeat 'settings'");
917                 return 0;
918             }
919             w = wrbuf_alloc();
920             conf_dir_path(config, w, (const char *) src);
921             server->settings_fname = nmem_strdup(nmem, wrbuf_cstr(w));
922             wrbuf_destroy(w);
923             xmlFree(src);
924         }
925         else if (!strcmp((const char *) n->name, "icu_chain"))
926         {
927             if (!server->charsets)
928                 server->charsets = pp2_charset_fact_create();
929             if (pp2_charset_fact_define(server->charsets, n, 0))
930             {
931                 yaz_log(YLOG_FATAL, "ICU chain definition error");
932                 return 0;
933             }
934         }
935         else if (!strcmp((const char *) n->name, "relevance")
936                  || !strcmp((const char *) n->name, "sort")
937                  || !strcmp((const char *) n->name, "mergekey")
938                  || !strcmp((const char *) n->name, "facet"))
939         {
940             yaz_log(YLOG_FATAL, "No longer supported: <%s>", n->name);
941             yaz_log(YLOG_LOG, "Use <icu_chain id=\"%s\">.. instead", n->name);
942             return 0;
943         }
944         else if (!strcmp((const char *) n->name, "service"))
945         {
946             char *service_id = (char *)
947                 xmlGetProp(n, (xmlChar *) "id");
948
949             struct conf_service **sp = &server->service;
950             for (; *sp; sp = &(*sp)->next)
951                 if ((*sp)->id && service_id &&
952                     0 == strcmp((*sp)->id, service_id))
953                 {
954                     yaz_log(YLOG_FATAL, "Duplicate service: %s", service_id);
955                     break;
956                 }
957                 else if (!(*sp)->id && !service_id)
958                 {
959                     yaz_log(YLOG_FATAL, "Duplicate unnamed service");
960                     break;
961                 }
962
963             if (*sp)  /* service already exist */
964             {
965                 xmlFree(service_id);
966                 return 0;
967             }
968             else
969             {
970                 struct conf_service *s = service_create_static(server, n,
971                                                                service_id);
972                 xmlFree(service_id);
973                 if (!s)
974                     return 0;
975                 *sp = s;
976             }
977         }
978         else
979         {
980             yaz_log(YLOG_FATAL, "Bad element: %s", n->name);
981             return 0;
982         }
983     }
984     if (!server->port)
985     {
986         yaz_log(YLOG_FATAL, "No listening port given");
987         return 0;
988     }
989     if (server->service)
990     {
991         struct conf_service *s;
992         for (s = server->service; s; s = s->next)
993             inherit_server_settings(s);
994     }
995     return server;
996 }
997
998 WRBUF conf_get_fname(struct conf_config *config, const char *fname)
999 {
1000     WRBUF w = wrbuf_alloc();
1001
1002     conf_dir_path(config, w, fname);
1003     return w;
1004 }
1005
1006 struct conf_service *locate_service(struct conf_server *server,
1007                                     const char *service_id)
1008 {
1009     struct conf_service *s = server->service;
1010     for (; s; s = s->next)
1011         if (s->id && service_id && 0 == strcmp(s->id, service_id))
1012             break;
1013         else if (!s->id && !service_id)
1014             break;
1015     if (s)
1016         service_incref(s);
1017     return s;
1018 }
1019
1020 static void info_service_metadata(struct conf_service *service, WRBUF w)
1021 {
1022     int i;
1023     struct conf_metadata *md;
1024
1025     if (service->num_metadata)
1026     {
1027         for (i = 0; i < service->num_metadata; i++)
1028         {
1029             md = &(service->metadata[i]);
1030             wrbuf_puts(w, "   <metadata");
1031             if (md->name) {
1032                 wrbuf_puts(w, " name=\"");
1033                 wrbuf_xmlputs(w, md->name);
1034                 wrbuf_puts(w, "\"");
1035             }
1036             if (md->brief) {
1037                 wrbuf_puts(w, " brief=\"yes\"");
1038             }
1039             if (md->termlist) {
1040                 wrbuf_puts(w, " termlist=\"yes\"");
1041             }
1042             if (md->rank) {
1043                 wrbuf_puts(w, " rank=\"");
1044                 wrbuf_xmlputs(w, md->rank);
1045                 wrbuf_puts(w, "\"");
1046             }
1047             if (md->sortkey_offset > 0) {
1048                 wrbuf_puts(w, " sortkey=\"");
1049                 switch (service->sortkeys[md->sortkey_offset].type)
1050                 {
1051                 case Metadata_type_relevance:
1052                     wrbuf_puts(w, "relevance");
1053                     break;
1054                 case Metadata_type_skiparticle:
1055                     wrbuf_puts(w, "skiparticle");
1056                     break;
1057                 case Metadata_type_position:
1058                     wrbuf_puts(w, "position");
1059                     break;
1060                 default:
1061                     wrbuf_puts(w, "yes");
1062                     break;
1063                 }
1064                 wrbuf_puts(w, "\"");
1065             }
1066             switch (md->type)
1067             {
1068             case Metadata_type_generic:
1069             case Metadata_type_skiparticle:
1070                 break;
1071             case Metadata_type_year:
1072                 wrbuf_puts(w, " type=\"year\"");
1073                 break;
1074             case Metadata_type_date:
1075                 wrbuf_puts(w, " type=\"date\"");
1076                 break;
1077             case Metadata_type_float:
1078                 wrbuf_puts(w, " type=\"float\"");
1079                 break;
1080             case Metadata_type_relevance:
1081             case Metadata_type_position:
1082                 break;
1083             }
1084             switch (md->merge)
1085             {
1086             case Metadata_merge_no:
1087                 break;
1088             case Metadata_merge_unique:
1089                 wrbuf_puts(w, " merge=\"unique\"");
1090                 break;
1091             case Metadata_merge_longest:
1092                 wrbuf_puts(w, " merge=\"longest\"");
1093                 break;
1094             case Metadata_merge_range:
1095                 wrbuf_puts(w, " merge=\"range\"");
1096                 break;
1097             case Metadata_merge_all:
1098                 wrbuf_puts(w, " merge=\"all\"");
1099                 break;
1100             case Metadata_merge_first:
1101                 wrbuf_puts(w, " merge=\"first\"");
1102                 break;
1103             }
1104             switch (md->mergekey)
1105             {
1106             case Metadata_mergekey_no:
1107                 break;
1108             case Metadata_mergekey_optional:
1109                 wrbuf_puts(w, " mergekey=\"optional\"");
1110                 break;
1111             case Metadata_mergekey_required:
1112                 wrbuf_puts(w, " mergekey=\"required\"");
1113                 break;
1114             }
1115             wrbuf_puts(w, " />\n");
1116         }
1117     }
1118 }
1119
1120 static void info_service_databases(struct conf_service *service, WRBUF w)
1121 {
1122     struct database *db;
1123     struct setting *s;
1124     int i;
1125
1126     if (service->databases)
1127     {
1128         wrbuf_puts(w, "   <databases>\n");
1129         for(db = service->databases; db; db = db->next)
1130         {
1131             wrbuf_puts(w, "    <database");
1132             if (db->id)
1133             {
1134                 wrbuf_puts(w, " id=\"");
1135                 wrbuf_printf(w, "%s", db->id);
1136                 wrbuf_puts(w, "\"");
1137             }
1138             wrbuf_puts(w, ">\n");
1139             for (i = 0; i < db->num_settings; i++)
1140             {
1141                 s = db->settings[i];
1142                 while (s != NULL)
1143                 {
1144                     wrbuf_puts(w, "     <setting");
1145                     wrbuf_puts(w, " name=\"");
1146                     wrbuf_xmlputs(w, s->name);
1147                     wrbuf_puts(w, "\"");
1148                     wrbuf_puts(w, " value=\"");
1149                     wrbuf_xmlputs(w, s->value);
1150                     wrbuf_puts(w, "\"");
1151                     wrbuf_puts(w, " />\n");
1152                     s = s->next;
1153                 }
1154             }
1155             wrbuf_puts(w, "    </database>\n");
1156         }
1157         wrbuf_puts(w, "   </databases>\n");
1158     }
1159 }
1160
1161 void info_services(struct conf_server *server, WRBUF w)
1162 {
1163     struct conf_service *s = server->service;
1164     int i;
1165     struct setting *S;
1166
1167     wrbuf_puts(w, " <services>\n");
1168     for (; s; s = s->next)
1169     {
1170         wrbuf_puts(w, "  <service");
1171         if (s->id)
1172         {
1173             wrbuf_puts(w, " id=\"");
1174             wrbuf_xmlputs(w, s->id);
1175             wrbuf_puts(w, "\"");
1176         }
1177         wrbuf_puts(w, ">\n");
1178         if (s->settings)
1179         {
1180             for (i=0; i<s->settings->num_settings; i++)
1181             {
1182                 S = s->settings->settings[i];
1183                 while (S != NULL) {
1184                     wrbuf_puts(w, "   <setting");
1185                     wrbuf_puts(w, " name=\"");
1186                     wrbuf_xmlputs(w,  S->name);
1187                     wrbuf_puts(w, "\"");
1188                     wrbuf_puts(w, " value=\"");
1189                     wrbuf_xmlputs(w, S->value);
1190                     wrbuf_puts(w, "\"");
1191                     if (S->target) {
1192                         wrbuf_puts(w, " target=\"");
1193                         wrbuf_xmlputs(w, S->target);
1194                         wrbuf_puts(w, "\"");
1195                     }
1196
1197                     wrbuf_puts(w, " />\n");
1198
1199                     S = S->next;
1200                 }
1201             }
1202         }
1203         info_service_metadata(s, w);
1204         info_service_databases(s, w);
1205         wrbuf_puts(w, "  </service>");
1206
1207         wrbuf_puts(w, "\n");
1208     }
1209     wrbuf_puts(w, " </services>\n");
1210 }
1211
1212 static int parse_config(struct conf_config *config, xmlNode *root)
1213 {
1214     xmlNode *n;
1215
1216     for (n = root->children; n; n = n->next)
1217     {
1218         if (n->type != XML_ELEMENT_NODE)
1219             continue;
1220         if (!strcmp((const char *) n->name, "server"))
1221         {
1222             struct conf_server *tmp = server_create(config, config->nmem, n);
1223             if (!tmp)
1224                 return -1;
1225             tmp->next = config->servers;
1226             config->servers = tmp;
1227         }
1228         else if (!strcmp((const char *) n->name, "threads"))
1229         {
1230             xmlChar *number = xmlGetProp(n, (xmlChar *) "number");
1231             if (number)
1232             {
1233                 config->no_threads = atoi((const char *) number);
1234                 xmlFree(number);
1235             }
1236         }
1237         else if (!strcmp((const char *) n->name, "targetprofiles"))
1238         {
1239             yaz_log(YLOG_FATAL, "targetprofiles unsupported here. Must be part of service");
1240             return -1;
1241
1242         }
1243         else
1244         {
1245             yaz_log(YLOG_FATAL, "Bad element: %s", n->name);
1246             return -1;
1247         }
1248     }
1249     return 0;
1250 }
1251
1252 struct conf_config *config_create(const char *fname, int verbose)
1253 {
1254     xmlDoc *doc = xmlReadFile(fname,
1255                               NULL,
1256                               XML_PARSE_XINCLUDE
1257                               + XML_PARSE_NSCLEAN + XML_PARSE_NONET);
1258     xmlNode *n;
1259     const char *p;
1260     int r;
1261     NMEM nmem = nmem_create();
1262     struct conf_config *config = nmem_malloc(nmem, sizeof(struct conf_config));
1263
1264     xmlSubstituteEntitiesDefault(1);
1265     xmlLoadExtDtdDefaultValue = 1;
1266     if (!doc)
1267     {
1268         yaz_log(YLOG_FATAL, "Failed to read %s", fname);
1269         nmem_destroy(nmem);
1270         return 0;
1271     }
1272
1273     // Perform XInclude.
1274     r = xmlXIncludeProcess(doc);
1275     if (r == -1)
1276     {
1277         yaz_log(YLOG_FATAL, "XInclude processing failed");
1278         return 0;
1279     }
1280
1281     config->nmem = nmem;
1282     config->servers = 0;
1283     config->no_threads = 0;
1284     config->iochan_man = 0;
1285     config->database_hosts = database_hosts_create();
1286
1287     config->confdir = wrbuf_alloc();
1288     if ((p = strrchr(fname,
1289 #ifdef WIN32
1290                      '\\'
1291 #else
1292                      '/'
1293 #endif
1294              )))
1295     {
1296         int len = p - fname;
1297         wrbuf_write(config->confdir, fname, len);
1298     }
1299     wrbuf_puts(config->confdir, "");
1300
1301     n = xmlDocGetRootElement(doc);
1302     r = yaz_xml_include_simple(n, wrbuf_cstr(config->confdir));
1303     if (r == 0) /* OK */
1304     {
1305         if (verbose)
1306         {
1307             yaz_log(YLOG_LOG, "Configuration %s after include processing",
1308                     fname);
1309 #if LIBXML_VERSION >= 20600
1310             xmlDocFormatDump(yaz_log_file(), doc, 0);
1311 #else
1312             xmlDocDump(yaz_log_file(), doc);
1313 #endif
1314         }
1315         r = parse_config(config, n);
1316     }
1317     xmlFreeDoc(doc);
1318
1319     if (r)
1320     {
1321         config_destroy(config);
1322         return 0;
1323     }
1324     return config;
1325 }
1326
1327 void server_destroy(struct conf_server *server)
1328 {
1329     struct conf_service *s = server->service;
1330     while (s)
1331     {
1332         struct conf_service *s_next = s->next;
1333         service_destroy(s);
1334         s = s_next;
1335     }
1336     pp2_charset_fact_destroy(server->charsets);
1337     http_server_destroy(server->http_server);
1338 }
1339
1340 void config_destroy(struct conf_config *config)
1341 {
1342     if (config)
1343     {
1344         struct conf_server *server = config->servers;
1345         iochan_man_destroy(&config->iochan_man);
1346         while (server)
1347         {
1348             struct conf_server *s_next = server->next;
1349             server_destroy(server);
1350             server = s_next;
1351             database_hosts_destroy(&config->database_hosts);
1352         }
1353         wrbuf_destroy(config->confdir);
1354         nmem_destroy(config->nmem);
1355     }
1356 }
1357
1358 void config_stop_listeners(struct conf_config *conf)
1359 {
1360     struct conf_server *ser;
1361     for (ser = conf->servers; ser; ser = ser->next)
1362         http_close_server(ser);
1363 }
1364
1365 void config_process_events(struct conf_config *conf)
1366 {
1367     struct conf_server *ser;
1368
1369     for (ser = conf->servers; ser; ser = ser->next)
1370     {
1371         struct conf_service *s = ser->service;
1372
1373         for (;s ; s = s->next)
1374         {
1375             assert(s->mutex == 0);
1376             pazpar2_mutex_create(&s->mutex, "service");
1377         }
1378         http_mutex_init(ser);
1379     }
1380     iochan_man_events(conf->iochan_man);
1381 }
1382
1383 int config_start_listeners(struct conf_config *conf,
1384                            const char *listener_override,
1385                            const char *record_fname)
1386 {
1387     struct conf_server *ser;
1388
1389     conf->iochan_man = iochan_man_create(conf->no_threads);
1390     for (ser = conf->servers; ser; ser = ser->next)
1391     {
1392         WRBUF w;
1393         int r;
1394
1395         ser->iochan_man = conf->iochan_man;
1396         if (listener_override)
1397         {
1398             const char *cp = strrchr(listener_override, ':');
1399             if (cp)
1400             {
1401                 ser->host = nmem_strdupn(conf->nmem, listener_override,
1402                                          cp - listener_override);
1403                 ser->port = nmem_strdup(conf->nmem, cp + 1);
1404             }
1405             else
1406             {
1407                 ser->host = "@";
1408                 ser->port = nmem_strdup(conf->nmem, listener_override);
1409             }
1410             listener_override = 0; /* only first server is overriden */
1411         }
1412         r = http_init(ser, record_fname);
1413         if (r)
1414             return -1;
1415
1416         w = wrbuf_alloc();
1417         if (ser->proxy_host || ser->proxy_port)
1418         {
1419             if (ser->proxy_host)
1420                 wrbuf_puts(w, ser->proxy_host);
1421             if (ser->proxy_port)
1422             {
1423                 if (wrbuf_len(w))
1424                     wrbuf_puts(w, ":");
1425                 wrbuf_printf(w, "%d", ser->proxy_port);
1426             }
1427         }
1428         if (wrbuf_len(w))
1429             http_set_proxyaddr(wrbuf_cstr(w), ser);
1430         wrbuf_destroy(w);
1431     }
1432     return 0;
1433 }
1434
1435 /*
1436  * Local variables:
1437  * c-basic-offset: 4
1438  * c-file-style: "Stroustrup"
1439  * indent-tabs-mode: nil
1440  * End:
1441  * vim: shiftwidth=4 tabstop=8 expandtab
1442  */
1443