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