src/pazpar2_config.c

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