src/pazpar2_config.c

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