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
 154     service->xml_node = 0;
 155
 156     return service;
 157 }
 158
 159 static struct conf_metadata* conf_service_add_metadata(
 160     struct conf_service *service,
 161     int field_id,
 162     const char *name,
 163     enum conf_metadata_type type,
 164     enum conf_metadata_merge merge,
 165     enum conf_setting_type setting,
 166     int brief,
 167     int termlist,
 168     const char *rank,
 169     int sortkey_offset,
 170     enum conf_metadata_mergekey mt,
 171     const char *facetrule,
 172     const char *limitmap,
 173     const char *limitcluster
 174     )
 175 {
 176     struct conf_metadata * md = 0;
 177     NMEM nmem = service->nmem;
 178
 179     if (!service->metadata || !service->num_metadata
 180         || field_id < 0  || !(field_id < service->num_metadata))
 181         return 0;
 182
 183     md = service->metadata + field_id;
 184     assert(nmem && md && name);
 185
 186     md->name = nmem_strdup(nmem, name);
 187
 188     md->type = type;
 189
 190     // enforcing that type_year is always range_merge
 191     if (md->type == Metadata_type_year)
 192         md->merge = Metadata_merge_range;
 193     else
 194         md->merge = merge;
 195
 196     md->setting = setting;
 197     md->brief = brief;
 198     md->termlist = termlist;
 199     md->rank = nmem_strdup_null(nmem, rank);
 200     md->sortkey_offset = sortkey_offset;
 201     md->mergekey = mt;
 202     md->facetrule = nmem_strdup_null(nmem, facetrule);
 203     md->limitmap = nmem_strdup_null(nmem, limitmap);
 204     md->limitcluster = nmem_strdup_null(nmem, limitcluster);
 205     return md;
 206 }
 207
 208 static struct conf_sortkey *conf_service_add_sortkey(
 209     struct conf_service *service,
 210     int field_id,
 211     const char *name,
 212     enum conf_sortkey_type type)
 213 {
 214     struct conf_sortkey *sk = 0;
 215     NMEM nmem = service->nmem;
 216
 217     if (!service->sortkeys || !service->num_sortkeys
 218         || field_id < 0 || !(field_id < service->num_sortkeys))
 219         return 0;
 220
 221     sk = service->sortkeys + field_id;
 222
 223     assert(nmem && sk && name);
 224
 225     sk->name = nmem_strdup(nmem, name);
 226     sk->type = type;
 227     return sk;
 228 }
 229
 230 int conf_service_metadata_field_id(struct conf_service *service,
 231                                    const char * name)
 232 {
 233     int i = 0;
 234
 235     if (!service || !service->metadata || !service->num_metadata)
 236         return -1;
 237
 238     for (i = 0; i < service->num_metadata; i++)
 239         if (!strcmp(name, (service->metadata[i]).name))
 240             return i;
 241     return -1;
 242 }
 243
 244 int conf_service_sortkey_field_id(struct conf_service *service,
 245                                   const char * name)
 246 {
 247     int i = 0;
 248
 249     if (!service || !service->sortkeys || !service->num_sortkeys)
 250         return -1;
 251
 252     for (i = 0; i < service->num_sortkeys; i++)
 253         if (!strcmp(name, (service->sortkeys[i]).name))
 254             return i;
 255     return -1;
 256 }
 257
 258 static void conf_dir_path(struct conf_config *config, WRBUF w, const char *src)
 259 {
 260     if (config->confdir && wrbuf_len(config->confdir) > 0 &&
 261         !yaz_is_abspath(src))
 262     {
 263         wrbuf_printf(w, "%s/%s", wrbuf_cstr(config->confdir), src);
 264     }
 265     else
 266         wrbuf_puts(w, src);
 267 }
 268
 269 void service_destroy(struct conf_service *service)
 270 {
 271     if (service)
 272     {
 273         if (!pazpar2_decref(&service->ref_count, service->mutex))
 274         {
 275             service_xslt_destroy(service);
 276             if (service->xml_node)
 277                 xmlFreeNode(service->xml_node);
 278             pp2_charset_fact_destroy(service->charsets);
 279             ccl_qual_rm(&service->ccl_bibset);
 280             yaz_mutex_destroy(&service->mutex);
 281             nmem_destroy(service->nmem);
 282         }
 283     }
 284 }
 285
 286 void service_incref(struct conf_service *service)
 287 {
 288     yaz_log(YLOG_LOG, "service_incref. p=%p cnt=%d", service,
 289             service->ref_count);
 290     pazpar2_incref(&service->ref_count, service->mutex);
 291 }
 292
 293 static int parse_metadata(struct conf_service *service, xmlNode *n,
 294                           int *md_node, int *sk_node)
 295 {
 296     enum conf_metadata_type type = Metadata_type_generic;
 297     enum conf_metadata_merge merge = Metadata_merge_no;
 298     enum conf_setting_type setting = Metadata_setting_no;
 299     enum conf_metadata_mergekey mergekey_type = Metadata_mergekey_no;
 300     int brief = 0;
 301     int termlist = 0;
 302     int sortkey_offset = 0;
 303     xmlChar *xml_name = 0;
 304     xmlChar *xml_brief = 0;
 305     xmlChar *xml_sortkey = 0;
 306     xmlChar *xml_merge = 0;
 307     xmlChar *xml_type = 0;
 308     xmlChar *xml_termlist = 0;
 309     xmlChar *xml_rank = 0;
 310     xmlChar *xml_setting = 0;
 311     xmlChar *xml_mergekey = 0;
 312     xmlChar *xml_limitmap = 0;
 313     xmlChar *xml_limitcluster = 0;
 314     xmlChar *xml_icu_chain = 0;
 315
 316     struct _xmlAttr *attr;
 317
 318     assert(service);
 319
 320     for (attr = n->properties; attr; attr = attr->next)
 321     {
 322         if (!xmlStrcmp(attr->name, BAD_CAST "name") &&
 323             attr->children && attr->children->type == XML_TEXT_NODE)
 324             xml_name = attr->children->content;
 325         else if (!xmlStrcmp(attr->name, BAD_CAST "brief") &&
 326                  attr->children && attr->children->type == XML_TEXT_NODE)
 327             xml_brief = attr->children->content;
 328         else if (!xmlStrcmp(attr->name, BAD_CAST "sortkey") &&
 329                  attr->children && attr->children->type == XML_TEXT_NODE)
 330             xml_sortkey = attr->children->content;
 331         else if (!xmlStrcmp(attr->name, BAD_CAST "merge") &&
 332                  attr->children && attr->children->type == XML_TEXT_NODE)
 333             xml_merge = attr->children->content;
 334         else if (!xmlStrcmp(attr->name, BAD_CAST "type") &&
 335                  attr->children && attr->children->type == XML_TEXT_NODE)
 336             xml_type = attr->children->content;
 337         else if (!xmlStrcmp(attr->name, BAD_CAST "termlist") &&
 338                  attr->children && attr->children->type == XML_TEXT_NODE)
 339             xml_termlist = attr->children->content;
 340         else if (!xmlStrcmp(attr->name, BAD_CAST "rank") &&
 341                  attr->children && attr->children->type == XML_TEXT_NODE)
 342             xml_rank = attr->children->content;
 343         else if (!xmlStrcmp(attr->name, BAD_CAST "setting") &&
 344                  attr->children && attr->children->type == XML_TEXT_NODE)
 345             xml_setting = attr->children->content;
 346         else if (!xmlStrcmp(attr->name, BAD_CAST "mergekey") &&
 347                  attr->children && attr->children->type == XML_TEXT_NODE)
 348             xml_mergekey = attr->children->content;
 349         else if (!xmlStrcmp(attr->name, BAD_CAST "facetrule") &&
 350                  attr->children && attr->children->type == XML_TEXT_NODE)
 351             xml_icu_chain = attr->children->content;
 352         else if (!xmlStrcmp(attr->name, BAD_CAST "limitmap") &&
 353                  attr->children && attr->children->type == XML_TEXT_NODE)
 354             xml_limitmap = attr->children->content;
 355         else if (!xmlStrcmp(attr->name, BAD_CAST "limitcluster") &&
 356                  attr->children && attr->children->type == XML_TEXT_NODE)
 357             xml_limitcluster = attr->children->content;
 358         else
 359         {
 360             yaz_log(YLOG_FATAL, "Unknown metadata attribute '%s'", attr->name);
 361             return -1;
 362         }
 363     }
 364
 365     // now do the parsing logic
 366     if (!xml_name)
 367     {
 368         yaz_log(YLOG_FATAL, "Must specify name in metadata element");
 369         return -1;
 370     }
 371     if (xml_brief)
 372     {
 373         if (!strcmp((const char *) xml_brief, "yes"))
 374             brief = 1;
 375         else if (strcmp((const char *) xml_brief, "no"))
 376         {
 377             yaz_log(YLOG_FATAL, "metadata/brief must be yes or no");
 378             return -1;
 379         }
 380     }
 381
 382     if (xml_termlist)
 383     {
 384         if (!strcmp((const char *) xml_termlist, "yes"))
 385             termlist = 1;
 386         else if (strcmp((const char *) xml_termlist, "no"))
 387         {
 388             yaz_log(YLOG_FATAL, "metadata/termlist must be yes or no");
 389             return -1;
 390         }
 391     }
 392
 393     if (xml_type)
 394     {
 395         if (!strcmp((const char *) xml_type, "generic"))
 396             type = Metadata_type_generic;
 397         else if (!strcmp((const char *) xml_type, "year"))
 398             type = Metadata_type_year;
 399         else if (!strcmp((const char *) xml_type, "date"))
 400             type = Metadata_type_date;
 401         else
 402         {
 403             yaz_log(YLOG_FATAL,
 404                     "Unknown value for metadata/type: %s", xml_type);
 405             return -1;
 406         }
 407     }
 408
 409     if (xml_merge)
 410     {
 411         if (!strcmp((const char *) xml_merge, "no"))
 412             merge = Metadata_merge_no;
 413         else if (!strcmp((const char *) xml_merge, "unique"))
 414             merge = Metadata_merge_unique;
 415         else if (!strcmp((const char *) xml_merge, "longest"))
 416             merge = Metadata_merge_longest;
 417         else if (!strcmp((const char *) xml_merge, "range"))
 418             merge = Metadata_merge_range;
 419         else if (!strcmp((const char *) xml_merge, "all"))
 420             merge = Metadata_merge_all;
 421         else if (!strcmp((const char *) xml_merge, "first"))
 422             merge = Metadata_merge_first;
 423         else
 424         {
 425             yaz_log(YLOG_FATAL,
 426                     "Unknown value for metadata/merge: %s", xml_merge);
 427             return -1;
 428         }
 429     }
 430
 431     if (xml_setting)
 432     {
 433         if (!strcmp((const char *) xml_setting, "no"))
 434             setting = Metadata_setting_no;
 435         else if (!strcmp((const char *) xml_setting, "postproc"))
 436             setting = Metadata_setting_postproc;
 437         else if (!strcmp((const char *) xml_setting, "parameter"))
 438             setting = Metadata_setting_parameter;
 439         else
 440         {
 441             yaz_log(YLOG_FATAL,
 442                     "Unknown value for medadata/setting: %s", xml_setting);
 443             return -1;
 444         }
 445     }
 446
 447     // add a sortkey if so specified
 448     if (xml_sortkey && strcmp((const char *) xml_sortkey, "no"))
 449     {
 450         enum conf_sortkey_type sk_type;
 451         if (merge == Metadata_merge_no)
 452         {
 453             yaz_log(YLOG_FATAL,
 454                     "Can't specify sortkey on a non-merged field");
 455             return -1;
 456         }
 457         if (!strcmp((const char *) xml_sortkey, "numeric"))
 458             sk_type = Metadata_sortkey_numeric;
 459         else if (!strcmp((const char *) xml_sortkey, "skiparticle"))
 460             sk_type = Metadata_sortkey_skiparticle;
 461         else
 462         {
 463             yaz_log(YLOG_FATAL,
 464                     "Unknown sortkey in metadata element: %s",
 465                     xml_sortkey);
 466             return -1;
 467         }
 468         sortkey_offset = *sk_node;
 469
 470         conf_service_add_sortkey(service, *sk_node,
 471                                  (const char *) xml_name, sk_type);
 472         (*sk_node)++;
 473     }
 474     else
 475         sortkey_offset = -1;
 476
 477     if (xml_mergekey)
 478     {
 479         if (!strcmp((const char *) xml_mergekey, "required"))
 480             mergekey_type = Metadata_mergekey_required;
 481         else if (!strcmp((const char *) xml_mergekey, "optional"))
 482             mergekey_type = Metadata_mergekey_optional;
 483         else if (!strcmp((const char *) xml_mergekey, "no"))
 484             mergekey_type = Metadata_mergekey_no;
 485         else
 486         {
 487             yaz_log(YLOG_FATAL, "Unknown value for mergekey: %s", xml_mergekey);
 488             return -1;
 489         }
 490     }
 491
 492     // metadata known, assign values
 493     conf_service_add_metadata(service, *md_node,
 494                               (const char *) xml_name,
 495                               type, merge, setting,
 496                               brief, termlist,
 497                               (const char *) xml_rank, sortkey_offset,
 498                               mergekey_type,
 499                               (const char *) xml_icu_chain,
 500                               (const char *) xml_limitmap,
 501                               (const char *) xml_limitcluster);
 502     (*md_node)++;
 503     return 0;
 504 }
 505
 506 static struct conf_service *service_create_static(struct conf_server *server,
 507                                                   xmlNode *node,
 508                                                   const char *service_id)
 509 {
 510     xmlNode *n;
 511     int md_node = 0;
 512     int sk_node = 0;
 513
 514     struct conf_service *service = 0;
 515     int num_metadata = 0;
 516     int num_sortkeys = 0;
 517     int got_settings = 0;
 518
 519     // count num_metadata and num_sortkeys
 520     for (n = node->children; n; n = n->next)
 521         if (n->type == XML_ELEMENT_NODE && !strcmp((const char *)
 522                                                    n->name, "metadata"))
 523         {
 524             xmlChar *sortkey = xmlGetProp(n, (xmlChar *) "sortkey");
 525             num_metadata++;
 526             if (sortkey && strcmp((const char *) sortkey, "no"))
 527                 num_sortkeys++;
 528             xmlFree(sortkey);
 529         }
 530
 531     service = service_init(server, num_metadata, num_sortkeys, service_id);
 532
 533     for (n = node->children; n; n = n->next)
 534     {
 535         if (n->type != XML_ELEMENT_NODE)
 536             continue;
 537         if (!strcmp((const char *) n->name, "timeout"))
 538         {
 539             xmlChar *src = xmlGetProp(n, (xmlChar *) "session");
 540             if (src)
 541             {
 542                 service->session_timeout = atoi((const char *) src);
 543                 xmlFree(src);
 544                 if (service->session_timeout < 9)
 545                 {
 546                     yaz_log(YLOG_FATAL, "session timeout out of range");
 547                     return 0;
 548                 }
 549             }
 550             src = xmlGetProp(n, (xmlChar *) "z3950_operation");
 551             if (src)
 552             {
 553                 service->z3950_operation_timeout = atoi((const char *) src);
 554                 xmlFree(src);
 555                 if (service->z3950_session_timeout < 9)
 556                 {
 557                     yaz_log(YLOG_FATAL, "Z39.50 operation timeout out of range");
 558                     return 0;
 559                 }
 560             }
 561             src = xmlGetProp(n, (xmlChar *) "z3950_session");
 562             if (src)
 563             {
 564                 service->z3950_session_timeout = atoi((const char *) src);
 565                 xmlFree(src);
 566                 if (service->z3950_session_timeout < 9)
 567                 {
 568                     yaz_log(YLOG_FATAL, "Z39.50 session timeout out of range");
 569                     return 0;
 570                 }
 571             }
 572         }
 573         else if (!strcmp((const char *) n->name, "ccldirective"))
 574         {
 575             char *name;
 576             char *value;
 577             if (!service->ccl_bibset)
 578                 service->ccl_bibset = ccl_qual_mk();
 579             name = (char *) xmlGetProp(n, (xmlChar *) "name");
 580             if (!name)
 581             {
 582                 yaz_log(YLOG_FATAL, "ccldirective: missing @name");
 583                 return 0;
 584             }
 585             value = (char *) xmlGetProp(n, (xmlChar *) "value");
 586             if (!value)
 587             {
 588                 xmlFree(name);
 589                 yaz_log(YLOG_FATAL, "ccldirective: missing @value");
 590                 return 0;
 591             }
 592             ccl_qual_add_special(service->ccl_bibset, name, value);
 593             xmlFree(value);
 594             xmlFree(name);
 595         }
 596         else if (!strcmp((const char *) n->name, "settings"))
 597             got_settings++;
 598         else if (!strcmp((const char *) n->name, "icu_chain"))
 599         {
 600             if (!service->charsets)
 601                 service->charsets = pp2_charset_fact_create();
 602             if (pp2_charset_fact_define(service->charsets, n, 0))
 603             {
 604                 yaz_log(YLOG_FATAL, "ICU chain definition error");
 605                 return 0;
 606             }
 607         }
 608         else if (!strcmp((const char *) n->name, "relevance")
 609                  || !strcmp((const char *) n->name, "sort")
 610                  || !strcmp((const char *) n->name, "mergekey")
 611                  || !strcmp((const char *) n->name, "facet"))
 612
 613         {
 614             if (!service->charsets)
 615                 service->charsets = pp2_charset_fact_create();
 616             if (pp2_charset_fact_define(service->charsets,
 617                                         n->children, (const char *) n->name))
 618             {
 619                 yaz_log(YLOG_FATAL, "ICU chain definition error");
 620                 return 0;
 621             }
 622         }
 623         else if (!strcmp((const char *) n->name, (const char *) "metadata"))
 624         {
 625             if (parse_metadata(service, n, &md_node, &sk_node))
 626                 return 0;
 627         }
 628         else if (!strcmp((const char *) n->name, (const char *) "xslt"))
 629         {
 630             if (service_xslt_config(service, n))
 631                 return 0;
 632         }
 633         else if (!strcmp((const char *) n->name, "rank"))
 634         {
 635             char *rank_cluster = (char *) xmlGetProp(n, (xmlChar *) "cluster");
 636             char *rank_debug = (char *) xmlGetProp(n, (xmlChar *) "debug");
 637             char *rank_follow = (char *) xmlGetProp(n, (xmlChar *) "follow");
 638             char *rank_lead = (char *) xmlGetProp(n, (xmlChar *) "lead");
 639             char *rank_length= (char *) xmlGetProp(n, (xmlChar *) "length");
 640             if (rank_cluster)
 641             {
 642                 if (!strcmp(rank_cluster, "yes"))
 643                     service->rank_cluster = 1;
 644                 else if (!strcmp(rank_cluster, "no"))
 645                     service->rank_cluster = 0;
 646                 else
 647                 {
 648                     yaz_log(YLOG_FATAL, "service: rank@cluster boolean");
 649                     return 0;
 650                 }
 651             }
 652             if (rank_debug)
 653             {
 654                 if (!strcmp(rank_debug, "yes"))
 655                     service->rank_debug = 1;
 656                 else if (!strcmp(rank_debug, "no"))
 657                     service->rank_debug = 0;
 658                 else
 659                 {
 660                     yaz_log(YLOG_FATAL, "service: rank@debug boolean");
 661                     return 0;
 662                 }
 663             }
 664             if (rank_follow)
 665             {
 666                 service->rank_follow = atof(rank_follow);
 667             }
 668             if (rank_lead)
 669             {
 670                 service->rank_lead = atof(rank_lead);
 671             }
 672             if (rank_length)
 673             {
 674                 if (!strcmp(rank_length, "linear"))
 675                     service->rank_length = 2;
 676                 else if (!strcmp(rank_length, "log"))
 677                     service->rank_length = 1;
 678                 else if (!strcmp(rank_length, "none"))
 679                     service->rank_length = 0;
 680                 else
 681                 {
 682                     yaz_log(YLOG_FATAL, "service: rank@length linear|log|none");
 683                     return 0;
 684                 }
 685             }
 686             xmlFree(rank_cluster);
 687             xmlFree(rank_debug);
 688             xmlFree(rank_follow);
 689             xmlFree(rank_lead);
 690             xmlFree(rank_length);
 691         }
 692         else if (!strcmp((const char *) n->name, "sort-default"))
 693         {
 694             char *default_sort = (char *) xmlGetProp(n, (xmlChar *) "field");
 695
 696             if (default_sort && strcmp(default_sort, "")) {
 697                 service->default_sort = nmem_strdup(service->nmem, default_sort);
 698                 yaz_log(YLOG_LOG, "service %s: default sort order configured to: %s",
 699                         service_id ? service_id : "unnamed", default_sort);
 700             }
 701             else
 702             {
 703                 yaz_log(YLOG_FATAL, "default sort order is invalid: %s", default_sort);
 704                 return 0;
 705             }
 706             xmlFree(default_sort);
 707         }
 708         else
 709         {
 710             char tmp[80];
 711             yaz_log(YLOG_FATAL, "Bad element: %s . Context: %s", n->name,
 712                     xml_context(n, tmp, sizeof tmp));
 713             return 0;
 714         }
 715     }
 716     if (got_settings)
 717     {
 718         int pass;
 719         /* metadata has been read.. Consider now settings */
 720         init_settings(service);
 721         for (pass = 1; pass <= 2; pass++)
 722         {
 723             for (n = node->children; n; n = n->next)
 724             {
 725                 if (n->type != XML_ELEMENT_NODE)
 726                     continue;
 727                 if (!strcmp((const char *) n->name, "settings"))
 728                 {
 729                     int ret;
 730                     xmlChar *src = xmlGetProp(n, (xmlChar *) "src");
 731                     if (src)
 732                     {
 733                         WRBUF w = wrbuf_alloc();
 734                         conf_dir_path(server->config, w, (const char *) src);
 735                         ret = settings_read_file(service, wrbuf_cstr(w), pass);
 736                         wrbuf_destroy(w);
 737                         xmlFree(src);
 738                     }
 739                     else
 740                     {
 741                         ret = settings_read_node(service, n, pass);
 742                     }
 743                     if (ret)
 744                         return 0;
 745                 }
 746             }
 747         }
 748     }
 749     service->xml_node = xmlCopyNode(node, 1);
 750     return service;
 751 }
 752
 753 static int inherit_server_settings(struct conf_service *s)
 754 {
 755     int ret = 0;
 756     struct conf_server *server = s->server;
 757     if (!s->dictionary) /* service has no config settings ? */
 758     {
 759         if (server->settings_fname)
 760         {
 761             /* inherit settings from server */
 762             init_settings(s);
 763             if (settings_read_file(s, server->settings_fname, 1))
 764                 ret = -1;
 765             if (settings_read_file(s, server->settings_fname, 2))
 766                 ret = -1;
 767         }
 768         else
 769         {
 770             yaz_log(YLOG_WARN, "server '%s' has no settings", s->id ? s->id : "unnamed");
 771             init_settings(s);
 772         }
 773     }
 774
 775     /* use relevance/sort/mergekey/facet from server if not defined
 776        for this service.. */
 777     if (!s->charsets)
 778     {
 779         if (server->charsets)
 780         {
 781             s->charsets = server->charsets;
 782             pp2_charset_fact_incref(s->charsets);
 783         }
 784         else
 785         {
 786             s->charsets = pp2_charset_fact_create();
 787         }
 788     }
 789     return ret;
 790 }
 791
 792 struct conf_service *service_create(struct conf_server *server,
 793                                     xmlNode *node)
 794 {
 795     struct conf_service *service = service_create_static(server, node, 0);
 796     if (service)
 797     {
 798         inherit_server_settings(service);
 799         assert(service->mutex == 0);
 800         pazpar2_mutex_create(&service->mutex, "conf");
 801     }
 802     return service;
 803 }
 804
 805 static struct conf_server *server_create(struct conf_config *config,
 806                                          NMEM nmem, xmlNode *node)
 807 {
 808     xmlNode *n;
 809     struct conf_server *server = nmem_malloc(nmem, sizeof(struct conf_server));
 810     xmlChar *server_id = xmlGetProp(node, (xmlChar *) "id");
 811
 812     server->host = "@";
 813     server->port = 0;
 814     server->proxy_host = 0;
 815     server->proxy_port = 0;
 816     server->myurl = 0;
 817     server->service = 0;
 818     server->config = config;
 819     server->next = 0;
 820     server->charsets = 0;
 821     server->http_server = 0;
 822     server->iochan_man = 0;
 823     server->database_hosts = config->database_hosts;
 824     server->settings_fname = 0;
 825
 826     if (server_id)
 827     {
 828         server->server_id = nmem_strdup(nmem, (const char *)server_id);
 829         xmlFree(server_id);
 830     }
 831     else
 832         server->server_id = 0;
 833     for (n = node->children; n; n = n->next)
 834     {
 835         if (n->type != XML_ELEMENT_NODE)
 836             continue;
 837         if (!strcmp((const char *) n->name, "listen"))
 838         {
 839             xmlChar *port = xmlGetProp(n, (xmlChar *) "port");
 840             xmlChar *host = xmlGetProp(n, (xmlChar *) "host");
 841
 842             if (port)
 843                 server->port = nmem_strdup(nmem, (const char *) port);
 844             if (host)
 845                 server->host = nmem_strdup(nmem, (const char *) host);
 846
 847             xmlFree(port);
 848             xmlFree(host);
 849         }
 850         else if (!strcmp((const char *) n->name, "proxy"))
 851         {
 852             xmlChar *port = xmlGetProp(n, (xmlChar *) "port");
 853             xmlChar *host = xmlGetProp(n, (xmlChar *) "host");
 854             xmlChar *myurl = xmlGetProp(n, (xmlChar *) "myurl");
 855             if (port)
 856                 server->proxy_port = atoi((const char *) port);
 857             if (host)
 858                 server->proxy_host = nmem_strdup(nmem, (const char *) host);
 859             if (myurl)
 860                 server->myurl = nmem_strdup(nmem, (const char *) myurl);
 861             xmlFree(port);
 862             xmlFree(host);
 863             xmlFree(myurl);
 864         }
 865         else if (!strcmp((const char *) n->name, "settings"))
 866         {
 867             xmlChar *src = xmlGetProp(n, (xmlChar *) "src");
 868             WRBUF w;
 869             if (!src)
 870             {
 871                 yaz_log(YLOG_FATAL, "Missing src attribute for settings");
 872                 return 0;
 873             }
 874             if (server->settings_fname)
 875             {
 876                 xmlFree(src);
 877                 yaz_log(YLOG_FATAL, "Can't repeat 'settings'");
 878                 return 0;
 879             }
 880             w = wrbuf_alloc();
 881             conf_dir_path(config, w, (const char *) src);
 882             server->settings_fname = nmem_strdup(nmem, wrbuf_cstr(w));
 883             wrbuf_destroy(w);
 884             xmlFree(src);
 885         }
 886         else if (!strcmp((const char *) n->name, "icu_chain"))
 887         {
 888             if (!server->charsets)
 889                 server->charsets = pp2_charset_fact_create();
 890             if (pp2_charset_fact_define(server->charsets, n, 0))
 891             {
 892                 yaz_log(YLOG_FATAL, "ICU chain definition error");
 893                 return 0;
 894             }
 895         }
 896         else if (!strcmp((const char *) n->name, "relevance")
 897                  || !strcmp((const char *) n->name, "sort")
 898                  || !strcmp((const char *) n->name, "mergekey")
 899                  || !strcmp((const char *) n->name, "facet"))
 900         {
 901             if (!server->charsets)
 902                 server->charsets = pp2_charset_fact_create();
 903             if (pp2_charset_fact_define(server->charsets,
 904                                         n->children, (const char *) n->name))
 905             {
 906                 yaz_log(YLOG_FATAL, "ICU chain definition error");
 907                 return 0;
 908             }
 909         }
 910         else if (!strcmp((const char *) n->name, "service"))
 911         {
 912             char *service_id = (char *)
 913                 xmlGetProp(n, (xmlChar *) "id");
 914
 915             struct conf_service **sp = &server->service;
 916             for (; *sp; sp = &(*sp)->next)
 917                 if ((*sp)->id && service_id &&
 918                     0 == strcmp((*sp)->id, service_id))
 919                 {
 920                     yaz_log(YLOG_FATAL, "Duplicate service: %s", service_id);
 921                     break;
 922                 }
 923                 else if (!(*sp)->id && !service_id)
 924                 {
 925                     yaz_log(YLOG_FATAL, "Duplicate unnamed service");
 926                     break;
 927                 }
 928
 929             if (*sp)  /* service already exist */
 930             {
 931                 xmlFree(service_id);
 932                 return 0;
 933             }
 934             else
 935             {
 936                 struct conf_service *s = service_create_static(server, n,
 937                                                                service_id);
 938                 xmlFree(service_id);
 939                 if (!s)
 940                     return 0;
 941                 *sp = s;
 942             }
 943         }
 944         else
 945         {
 946             yaz_log(YLOG_FATAL, "Bad element: %s", n->name);
 947             return 0;
 948         }
 949     }
 950     if (!server->port)
 951     {
 952         yaz_log(YLOG_FATAL, "No listening port given");
 953         return 0;
 954     }
 955     if (server->service)
 956     {
 957         struct conf_service *s;
 958         for (s = server->service; s; s = s->next)
 959             inherit_server_settings(s);
 960     }
 961     return server;
 962 }
 963
 964 WRBUF conf_get_fname(struct conf_config *config, const char *fname)
 965 {
 966     WRBUF w = wrbuf_alloc();
 967
 968     conf_dir_path(config, w, fname);
 969     return w;
 970 }
 971
 972 struct conf_service *locate_service(struct conf_server *server,
 973                                     const char *service_id)
 974 {
 975     struct conf_service *s = server->service;
 976     for (; s; s = s->next)
 977         if (s->id && service_id && 0 == strcmp(s->id, service_id))
 978             break;
 979         else if (!s->id && !service_id)
 980             break;
 981     if (s)
 982         service_incref(s);
 983     return s;
 984 }
 985
 986 void info_services(struct conf_server *server, WRBUF w)
 987 {
 988     struct conf_service *s = server->service;
 989     wrbuf_puts(w, " <services>\n");
 990     for (; s; s = s->next)
 991     {
 992         wrbuf_puts(w, "  <service");
 993         if (s->id)
 994         {
 995             wrbuf_puts(w, " id=\"");
 996             wrbuf_xmlputs(w, s->id);
 997             wrbuf_puts(w, "\"");
 998         }
 999         wrbuf_puts(w, "/>");
1000
1001         wrbuf_puts(w, "\n");
1002     }
1003     wrbuf_puts(w, " </services>\n");
1004 }
1005
1006 static int parse_config(struct conf_config *config, xmlNode *root)
1007 {
1008     xmlNode *n;
1009
1010     for (n = root->children; n; n = n->next)
1011     {
1012         if (n->type != XML_ELEMENT_NODE)
1013             continue;
1014         if (!strcmp((const char *) n->name, "server"))
1015         {
1016             struct conf_server *tmp = server_create(config, config->nmem, n);
1017             if (!tmp)
1018                 return -1;
1019             tmp->next = config->servers;
1020             config->servers = tmp;
1021         }
1022         else if (!strcmp((const char *) n->name, "threads"))
1023         {
1024             xmlChar *number = xmlGetProp(n, (xmlChar *) "number");
1025             if (number)
1026             {
1027                 config->no_threads = atoi((const char *) number);
1028                 xmlFree(number);
1029             }
1030         }
1031         else if (!strcmp((const char *) n->name, "targetprofiles"))
1032         {
1033             yaz_log(YLOG_FATAL, "targetprofiles unsupported here. Must be part of service");
1034             return -1;
1035
1036         }
1037         else
1038         {
1039             yaz_log(YLOG_FATAL, "Bad element: %s", n->name);
1040             return -1;
1041         }
1042     }
1043     return 0;
1044 }
1045
1046 struct conf_config *config_create(const char *fname, int verbose)
1047 {
1048     xmlDoc *doc = xmlParseFile(fname);
1049     xmlNode *n;
1050     const char *p;
1051     int r;
1052     NMEM nmem = nmem_create();
1053     struct conf_config *config = nmem_malloc(nmem, sizeof(struct conf_config));
1054
1055     xmlSubstituteEntitiesDefault(1);
1056     xmlLoadExtDtdDefaultValue = 1;
1057     if (!doc)
1058     {
1059         yaz_log(YLOG_FATAL, "Failed to read %s", fname);
1060         nmem_destroy(nmem);
1061         return 0;
1062     }
1063
1064     config->nmem = nmem;
1065     config->servers = 0;
1066     config->no_threads = 0;
1067     config->iochan_man = 0;
1068     config->database_hosts = database_hosts_create();
1069
1070     config->confdir = wrbuf_alloc();
1071     if ((p = strrchr(fname,
1072 #ifdef WIN32
1073                      '\\'
1074 #else
1075                      '/'
1076 #endif
1077              )))
1078     {
1079         int len = p - fname;
1080         wrbuf_write(config->confdir, fname, len);
1081     }
1082     wrbuf_puts(config->confdir, "");
1083
1084     n = xmlDocGetRootElement(doc);
1085     r = yaz_xml_include_simple(n, wrbuf_cstr(config->confdir));
1086     if (r == 0) /* OK */
1087     {
1088         if (verbose)
1089         {
1090             yaz_log(YLOG_LOG, "Configuration %s after include processing",
1091                     fname);
1092 #if LIBXML_VERSION >= 20600
1093             xmlDocFormatDump(yaz_log_file(), doc, 0);
1094 #else
1095             xmlDocDump(yaz_log_file(), doc);
1096 #endif
1097         }
1098         r = parse_config(config, n);
1099     }
1100     xmlFreeDoc(doc);
1101
1102     if (r)
1103     {
1104         config_destroy(config);
1105         return 0;
1106     }
1107     return config;
1108 }
1109
1110 void server_destroy(struct conf_server *server)
1111 {
1112     struct conf_service *s = server->service;
1113     while (s)
1114     {
1115         struct conf_service *s_next = s->next;
1116         service_destroy(s);
1117         s = s_next;
1118     }
1119     pp2_charset_fact_destroy(server->charsets);
1120     yaz_log(YLOG_LOG, "server_destroy server=%p", server);
1121     http_server_destroy(server->http_server);
1122 }
1123
1124 void config_destroy(struct conf_config *config)
1125 {
1126     if (config)
1127     {
1128         struct conf_server *server = config->servers;
1129         iochan_man_destroy(&config->iochan_man);
1130         while (server)
1131         {
1132             struct conf_server *s_next = server->next;
1133             server_destroy(server);
1134             server = s_next;
1135             database_hosts_destroy(&config->database_hosts);
1136         }
1137         wrbuf_destroy(config->confdir);
1138         nmem_destroy(config->nmem);
1139     }
1140 }
1141
1142 void config_stop_listeners(struct conf_config *conf)
1143 {
1144     struct conf_server *ser;
1145     for (ser = conf->servers; ser; ser = ser->next)
1146         http_close_server(ser);
1147 }
1148
1149 void config_process_events(struct conf_config *conf)
1150 {
1151     struct conf_server *ser;
1152
1153     for (ser = conf->servers; ser; ser = ser->next)
1154     {
1155         struct conf_service *s = ser->service;
1156
1157         for (;s ; s = s->next)
1158         {
1159             assert(s->mutex == 0);
1160             pazpar2_mutex_create(&s->mutex, "service");
1161         }
1162         http_mutex_init(ser);
1163     }
1164     iochan_man_events(conf->iochan_man);
1165 }
1166
1167 int config_start_listeners(struct conf_config *conf,
1168                            const char *listener_override,
1169                            const char *record_fname)
1170 {
1171     struct conf_server *ser;
1172
1173     conf->iochan_man = iochan_man_create(conf->no_threads);
1174     for (ser = conf->servers; ser; ser = ser->next)
1175     {
1176         WRBUF w;
1177         int r;
1178
1179         ser->iochan_man = conf->iochan_man;
1180         if (listener_override)
1181         {
1182             const char *cp = strrchr(listener_override, ':');
1183             if (cp)
1184             {
1185                 ser->host = nmem_strdupn(conf->nmem, listener_override,
1186                                          cp - listener_override);
1187                 ser->port = nmem_strdup(conf->nmem, cp + 1);
1188             }
1189             else
1190             {
1191                 ser->host = "@";
1192                 ser->port = nmem_strdup(conf->nmem, listener_override);
1193             }
1194             listener_override = 0; /* only first server is overriden */
1195         }
1196         r = http_init(ser, record_fname);
1197         if (r)
1198             return -1;
1199
1200         w = wrbuf_alloc();
1201         if (ser->proxy_host || ser->proxy_port)
1202         {
1203             if (ser->proxy_host)
1204                 wrbuf_puts(w, ser->proxy_host);
1205             if (ser->proxy_port)
1206             {
1207                 if (wrbuf_len(w))
1208                     wrbuf_puts(w, ":");
1209                 wrbuf_printf(w, "%d", ser->proxy_port);
1210             }
1211         }
1212         if (wrbuf_len(w))
1213             http_set_proxyaddr(wrbuf_cstr(w), ser);
1214         wrbuf_destroy(w);
1215     }
1216     return 0;
1217 }
1218
1219 /*
1220  * Local variables:
1221  * c-basic-offset: 4
1222  * c-file-style: "Stroustrup"
1223  * indent-tabs-mode: nil
1224  * End:
1225  * vim: shiftwidth=4 tabstop=8 expandtab
1226  */
1227