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