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     pazpar2_incref(&service->ref_count, service->mutex);
 285 }
 286
 287 static int parse_metadata(struct conf_service *service, xmlNode *n,
 288                           int *md_node, int *sk_node)
 289 {
 290     enum conf_metadata_type type = Metadata_type_generic;
 291     enum conf_metadata_merge merge = Metadata_merge_no;
 292     enum conf_setting_type setting = Metadata_setting_no;
 293     enum conf_metadata_mergekey mergekey_type = Metadata_mergekey_no;
 294     int brief = 0;
 295     int termlist = 0;
 296     int sortkey_offset = 0;
 297     xmlChar *xml_name = 0;
 298     xmlChar *xml_brief = 0;
 299     xmlChar *xml_sortkey = 0;
 300     xmlChar *xml_merge = 0;
 301     xmlChar *xml_type = 0;
 302     xmlChar *xml_termlist = 0;
 303     xmlChar *xml_rank = 0;
 304     xmlChar *xml_setting = 0;
 305     xmlChar *xml_mergekey = 0;
 306     xmlChar *xml_limitmap = 0;
 307     xmlChar *xml_limitcluster = 0;
 308     xmlChar *xml_icu_chain = 0;
 309
 310     struct _xmlAttr *attr;
 311
 312     assert(service);
 313
 314     for (attr = n->properties; attr; attr = attr->next)
 315     {
 316         if (!xmlStrcmp(attr->name, BAD_CAST "name") &&
 317             attr->children && attr->children->type == XML_TEXT_NODE)
 318             xml_name = attr->children->content;
 319         else if (!xmlStrcmp(attr->name, BAD_CAST "brief") &&
 320                  attr->children && attr->children->type == XML_TEXT_NODE)
 321             xml_brief = attr->children->content;
 322         else if (!xmlStrcmp(attr->name, BAD_CAST "sortkey") &&
 323                  attr->children && attr->children->type == XML_TEXT_NODE)
 324             xml_sortkey = attr->children->content;
 325         else if (!xmlStrcmp(attr->name, BAD_CAST "merge") &&
 326                  attr->children && attr->children->type == XML_TEXT_NODE)
 327             xml_merge = attr->children->content;
 328         else if (!xmlStrcmp(attr->name, BAD_CAST "type") &&
 329                  attr->children && attr->children->type == XML_TEXT_NODE)
 330             xml_type = attr->children->content;
 331         else if (!xmlStrcmp(attr->name, BAD_CAST "termlist") &&
 332                  attr->children && attr->children->type == XML_TEXT_NODE)
 333             xml_termlist = attr->children->content;
 334         else if (!xmlStrcmp(attr->name, BAD_CAST "rank") &&
 335                  attr->children && attr->children->type == XML_TEXT_NODE)
 336             xml_rank = attr->children->content;
 337         else if (!xmlStrcmp(attr->name, BAD_CAST "setting") &&
 338                  attr->children && attr->children->type == XML_TEXT_NODE)
 339             xml_setting = attr->children->content;
 340         else if (!xmlStrcmp(attr->name, BAD_CAST "mergekey") &&
 341                  attr->children && attr->children->type == XML_TEXT_NODE)
 342             xml_mergekey = attr->children->content;
 343         else if (!xmlStrcmp(attr->name, BAD_CAST "facetrule") &&
 344                  attr->children && attr->children->type == XML_TEXT_NODE)
 345             xml_icu_chain = attr->children->content;
 346         else if (!xmlStrcmp(attr->name, BAD_CAST "limitmap") &&
 347                  attr->children && attr->children->type == XML_TEXT_NODE)
 348             xml_limitmap = attr->children->content;
 349         else if (!xmlStrcmp(attr->name, BAD_CAST "limitcluster") &&
 350                  attr->children && attr->children->type == XML_TEXT_NODE)
 351             xml_limitcluster = attr->children->content;
 352         else
 353         {
 354             yaz_log(YLOG_FATAL, "Unknown metadata attribute '%s'", attr->name);
 355             return -1;
 356         }
 357     }
 358
 359     // now do the parsing logic
 360     if (!xml_name)
 361     {
 362         yaz_log(YLOG_FATAL, "Must specify name in metadata element");
 363         return -1;
 364     }
 365     if (xml_brief)
 366     {
 367         if (!strcmp((const char *) xml_brief, "yes"))
 368             brief = 1;
 369         else if (strcmp((const char *) xml_brief, "no"))
 370         {
 371             yaz_log(YLOG_FATAL, "metadata/brief must be yes or no");
 372             return -1;
 373         }
 374     }
 375
 376     if (xml_termlist)
 377     {
 378         if (!strcmp((const char *) xml_termlist, "yes"))
 379             termlist = 1;
 380         else if (strcmp((const char *) xml_termlist, "no"))
 381         {
 382             yaz_log(YLOG_FATAL, "metadata/termlist must be yes or no");
 383             return -1;
 384         }
 385     }
 386
 387     if (xml_type)
 388     {
 389         if (!strcmp((const char *) xml_type, "generic"))
 390             type = Metadata_type_generic;
 391         else if (!strcmp((const char *) xml_type, "year"))
 392             type = Metadata_type_year;
 393         else if (!strcmp((const char *) xml_type, "date"))
 394             type = Metadata_type_date;
 395         else
 396         {
 397             yaz_log(YLOG_FATAL,
 398                     "Unknown value for metadata/type: %s", xml_type);
 399             return -1;
 400         }
 401     }
 402
 403     if (xml_merge)
 404     {
 405         if (!strcmp((const char *) xml_merge, "no"))
 406             merge = Metadata_merge_no;
 407         else if (!strcmp((const char *) xml_merge, "unique"))
 408             merge = Metadata_merge_unique;
 409         else if (!strcmp((const char *) xml_merge, "longest"))
 410             merge = Metadata_merge_longest;
 411         else if (!strcmp((const char *) xml_merge, "range"))
 412             merge = Metadata_merge_range;
 413         else if (!strcmp((const char *) xml_merge, "all"))
 414             merge = Metadata_merge_all;
 415         else if (!strcmp((const char *) xml_merge, "first"))
 416             merge = Metadata_merge_first;
 417         else
 418         {
 419             yaz_log(YLOG_FATAL,
 420                     "Unknown value for metadata/merge: %s", xml_merge);
 421             return -1;
 422         }
 423     }
 424
 425     if (xml_setting)
 426     {
 427         if (!strcmp((const char *) xml_setting, "no"))
 428             setting = Metadata_setting_no;
 429         else if (!strcmp((const char *) xml_setting, "postproc"))
 430             setting = Metadata_setting_postproc;
 431         else if (!strcmp((const char *) xml_setting, "parameter"))
 432             setting = Metadata_setting_parameter;
 433         else
 434         {
 435             yaz_log(YLOG_FATAL,
 436                     "Unknown value for medadata/setting: %s", xml_setting);
 437             return -1;
 438         }
 439     }
 440
 441     // add a sortkey if so specified
 442     if (xml_sortkey && strcmp((const char *) xml_sortkey, "no"))
 443     {
 444         enum conf_sortkey_type sk_type;
 445         if (merge == Metadata_merge_no)
 446         {
 447             yaz_log(YLOG_FATAL,
 448                     "Can't specify sortkey on a non-merged field");
 449             return -1;
 450         }
 451         if (!strcmp((const char *) xml_sortkey, "numeric"))
 452             sk_type = Metadata_sortkey_numeric;
 453         else if (!strcmp((const char *) xml_sortkey, "skiparticle"))
 454             sk_type = Metadata_sortkey_skiparticle;
 455         else
 456         {
 457             yaz_log(YLOG_FATAL,
 458                     "Unknown sortkey in metadata element: %s",
 459                     xml_sortkey);
 460             return -1;
 461         }
 462         sortkey_offset = *sk_node;
 463
 464         conf_service_add_sortkey(service, *sk_node,
 465                                  (const char *) xml_name, sk_type);
 466         (*sk_node)++;
 467     }
 468     else
 469         sortkey_offset = -1;
 470
 471     if (xml_mergekey)
 472     {
 473         if (!strcmp((const char *) xml_mergekey, "required"))
 474             mergekey_type = Metadata_mergekey_required;
 475         else if (!strcmp((const char *) xml_mergekey, "optional"))
 476             mergekey_type = Metadata_mergekey_optional;
 477         else if (!strcmp((const char *) xml_mergekey, "no"))
 478             mergekey_type = Metadata_mergekey_no;
 479         else
 480         {
 481             yaz_log(YLOG_FATAL, "Unknown value for mergekey: %s", xml_mergekey);
 482             return -1;
 483         }
 484     }
 485
 486     // metadata known, assign values
 487     conf_service_add_metadata(service, *md_node,
 488                               (const char *) xml_name,
 489                               type, merge, setting,
 490                               brief, termlist,
 491                               (const char *) xml_rank, sortkey_offset,
 492                               mergekey_type,
 493                               (const char *) xml_icu_chain,
 494                               (const char *) xml_limitmap,
 495                               (const char *) xml_limitcluster);
 496     (*md_node)++;
 497     return 0;
 498 }
 499
 500 static struct conf_service *service_create_static(struct conf_server *server,
 501                                                   xmlNode *node,
 502                                                   const char *service_id)
 503 {
 504     xmlNode *n;
 505     int md_node = 0;
 506     int sk_node = 0;
 507
 508     struct conf_service *service = 0;
 509     int num_metadata = 0;
 510     int num_sortkeys = 0;
 511     int got_settings = 0;
 512
 513     // count num_metadata and num_sortkeys
 514     for (n = node->children; n; n = n->next)
 515         if (n->type == XML_ELEMENT_NODE && !strcmp((const char *)
 516                                                    n->name, "metadata"))
 517         {
 518             xmlChar *sortkey = xmlGetProp(n, (xmlChar *) "sortkey");
 519             num_metadata++;
 520             if (sortkey && strcmp((const char *) sortkey, "no"))
 521                 num_sortkeys++;
 522             xmlFree(sortkey);
 523         }
 524
 525     service = service_init(server, num_metadata, num_sortkeys, service_id);
 526
 527     for (n = node->children; n; n = n->next)
 528     {
 529         if (n->type != XML_ELEMENT_NODE)
 530             continue;
 531         if (!strcmp((const char *) n->name, "timeout"))
 532         {
 533             xmlChar *src = xmlGetProp(n, (xmlChar *) "session");
 534             if (src)
 535             {
 536                 service->session_timeout = atoi((const char *) src);
 537                 xmlFree(src);
 538                 if (service->session_timeout < 9)
 539                 {
 540                     yaz_log(YLOG_FATAL, "session timeout out of range");
 541                     return 0;
 542                 }
 543             }
 544             src = xmlGetProp(n, (xmlChar *) "z3950_operation");
 545             if (src)
 546             {
 547                 service->z3950_operation_timeout = atoi((const char *) src);
 548                 xmlFree(src);
 549                 if (service->z3950_session_timeout < 9)
 550                 {
 551                     yaz_log(YLOG_FATAL, "Z39.50 operation timeout out of range");
 552                     return 0;
 553                 }
 554             }
 555             src = xmlGetProp(n, (xmlChar *) "z3950_session");
 556             if (src)
 557             {
 558                 service->z3950_session_timeout = atoi((const char *) src);
 559                 xmlFree(src);
 560                 if (service->z3950_session_timeout < 9)
 561                 {
 562                     yaz_log(YLOG_FATAL, "Z39.50 session timeout out of range");
 563                     return 0;
 564                 }
 565             }
 566         }
 567         else if (!strcmp((const char *) n->name, "ccldirective"))
 568         {
 569             char *name;
 570             char *value;
 571             if (!service->ccl_bibset)
 572                 service->ccl_bibset = ccl_qual_mk();
 573             name = (char *) xmlGetProp(n, (xmlChar *) "name");
 574             if (!name)
 575             {
 576                 yaz_log(YLOG_FATAL, "ccldirective: missing @name");
 577                 return 0;
 578             }
 579             value = (char *) xmlGetProp(n, (xmlChar *) "value");
 580             if (!value)
 581             {
 582                 xmlFree(name);
 583                 yaz_log(YLOG_FATAL, "ccldirective: missing @value");
 584                 return 0;
 585             }
 586             ccl_qual_add_special(service->ccl_bibset, name, value);
 587             xmlFree(value);
 588             xmlFree(name);
 589         }
 590         else if (!strcmp((const char *) n->name, "settings"))
 591             got_settings++;
 592         else if (!strcmp((const char *) n->name, "icu_chain"))
 593         {
 594             if (!service->charsets)
 595                 service->charsets = pp2_charset_fact_create();
 596             if (pp2_charset_fact_define(service->charsets, n, 0))
 597             {
 598                 yaz_log(YLOG_FATAL, "ICU chain definition error");
 599                 return 0;
 600             }
 601         }
 602         else if (!strcmp((const char *) n->name, "relevance")
 603                  || !strcmp((const char *) n->name, "sort")
 604                  || !strcmp((const char *) n->name, "mergekey")
 605                  || !strcmp((const char *) n->name, "facet"))
 606
 607         {
 608             if (!service->charsets)
 609                 service->charsets = pp2_charset_fact_create();
 610             if (pp2_charset_fact_define(service->charsets,
 611                                         n->children, (const char *) n->name))
 612             {
 613                 yaz_log(YLOG_FATAL, "ICU chain definition error");
 614                 return 0;
 615             }
 616         }
 617         else if (!strcmp((const char *) n->name, (const char *) "metadata"))
 618         {
 619             if (parse_metadata(service, n, &md_node, &sk_node))
 620                 return 0;
 621         }
 622         else if (!strcmp((const char *) n->name, (const char *) "xslt"))
 623         {
 624             if (service_xslt_config(service, n))
 625                 return 0;
 626         }
 627         else if (!strcmp((const char *) n->name, "rank"))
 628         {
 629             char *rank_cluster = (char *) xmlGetProp(n, (xmlChar *) "cluster");
 630             char *rank_debug = (char *) xmlGetProp(n, (xmlChar *) "debug");
 631             char *rank_follow = (char *) xmlGetProp(n, (xmlChar *) "follow");
 632             char *rank_lead = (char *) xmlGetProp(n, (xmlChar *) "lead");
 633             char *rank_length= (char *) xmlGetProp(n, (xmlChar *) "length");
 634             if (rank_cluster)
 635             {
 636                 if (!strcmp(rank_cluster, "yes"))
 637                     service->rank_cluster = 1;
 638                 else if (!strcmp(rank_cluster, "no"))
 639                     service->rank_cluster = 0;
 640                 else
 641                 {
 642                     yaz_log(YLOG_FATAL, "service: rank@cluster boolean");
 643                     return 0;
 644                 }
 645             }
 646             if (rank_debug)
 647             {
 648                 if (!strcmp(rank_debug, "yes"))
 649                     service->rank_debug = 1;
 650                 else if (!strcmp(rank_debug, "no"))
 651                     service->rank_debug = 0;
 652                 else
 653                 {
 654                     yaz_log(YLOG_FATAL, "service: rank@debug boolean");
 655                     return 0;
 656                 }
 657             }
 658             if (rank_follow)
 659             {
 660                 service->rank_follow = atof(rank_follow);
 661             }
 662             if (rank_lead)
 663             {
 664                 service->rank_lead = atof(rank_lead);
 665             }
 666             if (rank_length)
 667             {
 668                 if (!strcmp(rank_length, "linear"))
 669                     service->rank_length = 2;
 670                 else if (!strcmp(rank_length, "log"))
 671                     service->rank_length = 1;
 672                 else if (!strcmp(rank_length, "none"))
 673                     service->rank_length = 0;
 674                 else
 675                 {
 676                     yaz_log(YLOG_FATAL, "service: rank@length linear|log|none");
 677                     return 0;
 678                 }
 679             }
 680             xmlFree(rank_cluster);
 681             xmlFree(rank_debug);
 682             xmlFree(rank_follow);
 683             xmlFree(rank_lead);
 684             xmlFree(rank_length);
 685         }
 686         else if (!strcmp((const char *) n->name, "sort-default"))
 687         {
 688             char *default_sort = (char *) xmlGetProp(n, (xmlChar *) "field");
 689
 690             if (default_sort && strcmp(default_sort, "")) {
 691                 service->default_sort = nmem_strdup(service->nmem, default_sort);
 692                 yaz_log(YLOG_LOG, "service %s: default sort order configured to: %s",
 693                         service_id ? service_id : "unnamed", default_sort);
 694             }
 695             else
 696             {
 697                 yaz_log(YLOG_FATAL, "default sort order is invalid: %s", default_sort);
 698                 return 0;
 699             }
 700             xmlFree(default_sort);
 701         }
 702         else
 703         {
 704             char tmp[80];
 705             yaz_log(YLOG_FATAL, "Bad element: %s . Context: %s", n->name,
 706                     xml_context(n, tmp, sizeof tmp));
 707             return 0;
 708         }
 709     }
 710     if (got_settings)
 711     {
 712         int pass;
 713         /* metadata has been read.. Consider now settings */
 714         init_settings(service);
 715         for (pass = 1; pass <= 2; pass++)
 716         {
 717             for (n = node->children; n; n = n->next)
 718             {
 719                 if (n->type != XML_ELEMENT_NODE)
 720                     continue;
 721                 if (!strcmp((const char *) n->name, "settings"))
 722                 {
 723                     int ret;
 724                     xmlChar *src = xmlGetProp(n, (xmlChar *) "src");
 725                     if (src)
 726                     {
 727                         WRBUF w = wrbuf_alloc();
 728                         conf_dir_path(server->config, w, (const char *) src);
 729                         ret = settings_read_file(service, wrbuf_cstr(w), pass);
 730                         wrbuf_destroy(w);
 731                         xmlFree(src);
 732                     }
 733                     else
 734                     {
 735                         ret = settings_read_node(service, n, pass);
 736                     }
 737                     if (ret)
 738                         return 0;
 739                 }
 740             }
 741         }
 742     }
 743
 744     {
 745         xmlBufferPtr buf = xmlBufferCreate();
 746         xmlNodeDump(buf, node->doc, node, 0, 0);
 747         service->xml_node =
 748             nmem_strdupn(service->nmem, (const char *) buf->content, buf->use);
 749         xmlBufferFree(buf);
 750     }
 751     return service;
 752 }
 753
 754 static int inherit_server_settings(struct conf_service *s)
 755 {
 756     int ret = 0;
 757     struct conf_server *server = s->server;
 758     if (!s->dictionary) /* service has no config settings ? */
 759     {
 760         if (server->settings_fname)
 761         {
 762             /* inherit settings from server */
 763             init_settings(s);
 764             if (settings_read_file(s, server->settings_fname, 1))
 765                 ret = -1;
 766             if (settings_read_file(s, server->settings_fname, 2))
 767                 ret = -1;
 768         }
 769         else
 770         {
 771             yaz_log(YLOG_WARN, "server '%s' has no settings", s->id ? s->id : "unnamed");
 772             init_settings(s);
 773         }
 774     }
 775
 776     /* use relevance/sort/mergekey/facet from server if not defined
 777        for this service.. */
 778     if (!s->charsets)
 779     {
 780         if (server->charsets)
 781         {
 782             s->charsets = server->charsets;
 783             pp2_charset_fact_incref(s->charsets);
 784         }
 785         else
 786         {
 787             s->charsets = pp2_charset_fact_create();
 788         }
 789     }
 790     return ret;
 791 }
 792
 793 struct conf_service *service_create(struct conf_server *server,
 794                                     xmlNode *node)
 795 {
 796     struct conf_service *service = service_create_static(server, node, 0);
 797     if (service)
 798     {
 799         inherit_server_settings(service);
 800         assert(service->mutex == 0);
 801         pazpar2_mutex_create(&service->mutex, "conf");
 802     }
 803     return service;
 804 }
 805
 806 static struct conf_server *server_create(struct conf_config *config,
 807                                          NMEM nmem, xmlNode *node)
 808 {
 809     xmlNode *n;
 810     struct conf_server *server = nmem_malloc(nmem, sizeof(struct conf_server));
 811     xmlChar *server_id = xmlGetProp(node, (xmlChar *) "id");
 812
 813     server->host = "@";
 814     server->port = 0;
 815     server->proxy_host = 0;
 816     server->proxy_port = 0;
 817     server->myurl = 0;
 818     server->service = 0;
 819     server->config = config;
 820     server->next = 0;
 821     server->charsets = 0;
 822     server->http_server = 0;
 823     server->iochan_man = 0;
 824     server->database_hosts = config->database_hosts;
 825     server->settings_fname = 0;
 826
 827     if (server_id)
 828     {
 829         server->server_id = nmem_strdup(nmem, (const char *)server_id);
 830         xmlFree(server_id);
 831     }
 832     else
 833         server->server_id = 0;
 834     for (n = node->children; n; n = n->next)
 835     {
 836         if (n->type != XML_ELEMENT_NODE)
 837             continue;
 838         if (!strcmp((const char *) n->name, "listen"))
 839         {
 840             xmlChar *port = xmlGetProp(n, (xmlChar *) "port");
 841             xmlChar *host = xmlGetProp(n, (xmlChar *) "host");
 842
 843             if (port)
 844                 server->port = nmem_strdup(nmem, (const char *) port);
 845             if (host)
 846                 server->host = nmem_strdup(nmem, (const char *) host);
 847
 848             xmlFree(port);
 849             xmlFree(host);
 850         }
 851         else if (!strcmp((const char *) n->name, "proxy"))
 852         {
 853             xmlChar *port = xmlGetProp(n, (xmlChar *) "port");
 854             xmlChar *host = xmlGetProp(n, (xmlChar *) "host");
 855             xmlChar *myurl = xmlGetProp(n, (xmlChar *) "myurl");
 856             if (port)
 857                 server->proxy_port = atoi((const char *) port);
 858             if (host)
 859                 server->proxy_host = nmem_strdup(nmem, (const char *) host);
 860             if (myurl)
 861                 server->myurl = nmem_strdup(nmem, (const char *) myurl);
 862             xmlFree(port);
 863             xmlFree(host);
 864             xmlFree(myurl);
 865         }
 866         else if (!strcmp((const char *) n->name, "settings"))
 867         {
 868             xmlChar *src = xmlGetProp(n, (xmlChar *) "src");
 869             WRBUF w;
 870             if (!src)
 871             {
 872                 yaz_log(YLOG_FATAL, "Missing src attribute for settings");
 873                 return 0;
 874             }
 875             if (server->settings_fname)
 876             {
 877                 xmlFree(src);
 878                 yaz_log(YLOG_FATAL, "Can't repeat 'settings'");
 879                 return 0;
 880             }
 881             w = wrbuf_alloc();
 882             conf_dir_path(config, w, (const char *) src);
 883             server->settings_fname = nmem_strdup(nmem, wrbuf_cstr(w));
 884             wrbuf_destroy(w);
 885             xmlFree(src);
 886         }
 887         else if (!strcmp((const char *) n->name, "icu_chain"))
 888         {
 889             if (!server->charsets)
 890                 server->charsets = pp2_charset_fact_create();
 891             if (pp2_charset_fact_define(server->charsets, n, 0))
 892             {
 893                 yaz_log(YLOG_FATAL, "ICU chain definition error");
 894                 return 0;
 895             }
 896         }
 897         else if (!strcmp((const char *) n->name, "relevance")
 898                  || !strcmp((const char *) n->name, "sort")
 899                  || !strcmp((const char *) n->name, "mergekey")
 900                  || !strcmp((const char *) n->name, "facet"))
 901         {
 902             if (!server->charsets)
 903                 server->charsets = pp2_charset_fact_create();
 904             if (pp2_charset_fact_define(server->charsets,
 905                                         n->children, (const char *) n->name))
 906             {
 907                 yaz_log(YLOG_FATAL, "ICU chain definition error");
 908                 return 0;
 909             }
 910         }
 911         else if (!strcmp((const char *) n->name, "service"))
 912         {
 913             char *service_id = (char *)
 914                 xmlGetProp(n, (xmlChar *) "id");
 915
 916             struct conf_service **sp = &server->service;
 917             for (; *sp; sp = &(*sp)->next)
 918                 if ((*sp)->id && service_id &&
 919                     0 == strcmp((*sp)->id, service_id))
 920                 {
 921                     yaz_log(YLOG_FATAL, "Duplicate service: %s", service_id);
 922                     break;
 923                 }
 924                 else if (!(*sp)->id && !service_id)
 925                 {
 926                     yaz_log(YLOG_FATAL, "Duplicate unnamed service");
 927                     break;
 928                 }
 929
 930             if (*sp)  /* service already exist */
 931             {
 932                 xmlFree(service_id);
 933                 return 0;
 934             }
 935             else
 936             {
 937                 struct conf_service *s = service_create_static(server, n,
 938                                                                service_id);
 939                 xmlFree(service_id);
 940                 if (!s)
 941                     return 0;
 942                 *sp = s;
 943             }
 944         }
 945         else
 946         {
 947             yaz_log(YLOG_FATAL, "Bad element: %s", n->name);
 948             return 0;
 949         }
 950     }
 951     if (!server->port)
 952     {
 953         yaz_log(YLOG_FATAL, "No listening port given");
 954         return 0;
 955     }
 956     if (server->service)
 957     {
 958         struct conf_service *s;
 959         for (s = server->service; s; s = s->next)
 960             inherit_server_settings(s);
 961     }
 962     return server;
 963 }
 964
 965 WRBUF conf_get_fname(struct conf_config *config, const char *fname)
 966 {
 967     WRBUF w = wrbuf_alloc();
 968
 969     conf_dir_path(config, w, fname);
 970     return w;
 971 }
 972
 973 struct conf_service *locate_service(struct conf_server *server,
 974                                     const char *service_id)
 975 {
 976     struct conf_service *s = server->service;
 977     for (; s; s = s->next)
 978         if (s->id && service_id && 0 == strcmp(s->id, service_id))
 979             break;
 980         else if (!s->id && !service_id)
 981             break;
 982     if (s)
 983         service_incref(s);
 984     return s;
 985 }
 986
 987 static void info_service_metadata(struct conf_service *service, WRBUF w)
 988 {
 989     int i;
 990     struct conf_metadata *md;
 991
 992     if (service->num_metadata)
 993     {
 994         for (i = 0; i < service->num_metadata; i++)
 995         {
 996             md = &(service->metadata[i]);
 997             wrbuf_puts(w, "   <metadata");
 998             if (md->name) {
 999                 wrbuf_puts(w, " name=\"");
1000                 wrbuf_xmlputs(w, md->name);
1001                 wrbuf_puts(w, "\"");
1002             }
1003             if (md->brief) {
1004                 wrbuf_puts(w, " brief=\"yes\"");
1005             }
1006             if (md->termlist) {
1007                 wrbuf_puts(w, " termlist=\"yes\"");
1008             }
1009             if (md->rank) {
1010                 wrbuf_puts(w, " rank=\"");
1011                 wrbuf_xmlputs(w, md->rank);
1012                 wrbuf_puts(w, "\"");
1013             }
1014             if (md->sortkey_offset > 0) {
1015                 wrbuf_puts(w, " sortkey=\"");
1016                 switch (service->sortkeys[md->sortkey_offset].type) {
1017                     case Metadata_sortkey_relevance:
1018                         wrbuf_puts(w, "relevance");
1019                         break;
1020                     case Metadata_sortkey_relevance_h:
1021                         wrbuf_puts(w, "relevance_h");
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 static 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
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     http_server_destroy(server->http_server);
1291 }
1292
1293 void config_destroy(struct conf_config *config)
1294 {
1295     if (config)
1296     {
1297         struct conf_server *server = config->servers;
1298         iochan_man_destroy(&config->iochan_man);
1299         while (server)
1300         {
1301             struct conf_server *s_next = server->next;
1302             server_destroy(server);
1303             server = s_next;
1304             database_hosts_destroy(&config->database_hosts);
1305         }
1306         wrbuf_destroy(config->confdir);
1307         nmem_destroy(config->nmem);
1308     }
1309 }
1310
1311 void config_stop_listeners(struct conf_config *conf)
1312 {
1313     struct conf_server *ser;
1314     for (ser = conf->servers; ser; ser = ser->next)
1315         http_close_server(ser);
1316 }
1317
1318 void config_process_events(struct conf_config *conf)
1319 {
1320     struct conf_server *ser;
1321
1322     for (ser = conf->servers; ser; ser = ser->next)
1323     {
1324         struct conf_service *s = ser->service;
1325
1326         for (;s ; s = s->next)
1327         {
1328             assert(s->mutex == 0);
1329             pazpar2_mutex_create(&s->mutex, "service");
1330         }
1331         http_mutex_init(ser);
1332     }
1333     iochan_man_events(conf->iochan_man);
1334 }
1335
1336 int config_start_listeners(struct conf_config *conf,
1337                            const char *listener_override,
1338                            const char *record_fname)
1339 {
1340     struct conf_server *ser;
1341
1342     conf->iochan_man = iochan_man_create(conf->no_threads);
1343     for (ser = conf->servers; ser; ser = ser->next)
1344     {
1345         WRBUF w;
1346         int r;
1347
1348         ser->iochan_man = conf->iochan_man;
1349         if (listener_override)
1350         {
1351             const char *cp = strrchr(listener_override, ':');
1352             if (cp)
1353             {
1354                 ser->host = nmem_strdupn(conf->nmem, listener_override,
1355                                          cp - listener_override);
1356                 ser->port = nmem_strdup(conf->nmem, cp + 1);
1357             }
1358             else
1359             {
1360                 ser->host = "@";
1361                 ser->port = nmem_strdup(conf->nmem, listener_override);
1362             }
1363             listener_override = 0; /* only first server is overriden */
1364         }
1365         r = http_init(ser, record_fname);
1366         if (r)
1367             return -1;
1368
1369         w = wrbuf_alloc();
1370         if (ser->proxy_host || ser->proxy_port)
1371         {
1372             if (ser->proxy_host)
1373                 wrbuf_puts(w, ser->proxy_host);
1374             if (ser->proxy_port)
1375             {
1376                 if (wrbuf_len(w))
1377                     wrbuf_puts(w, ":");
1378                 wrbuf_printf(w, "%d", ser->proxy_port);
1379             }
1380         }
1381         if (wrbuf_len(w))
1382             http_set_proxyaddr(wrbuf_cstr(w), ser);
1383         wrbuf_destroy(w);
1384     }
1385     return 0;
1386 }
1387
1388 /*
1389  * Local variables:
1390  * c-basic-offset: 4
1391  * c-file-style: "Stroustrup"
1392  * indent-tabs-mode: nil
1393  * End:
1394  * vim: shiftwidth=4 tabstop=8 expandtab
1395  */
1396