src/pazpar2_config.c

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