src/config.c

   1 /* $Id: config.c,v 1.34 2007-05-23 11:19:31 marc Exp $
   2    Copyright (c) 2006-2007, Index Data.
   3
   4 This file is part of Pazpar2.
   5
   6 Pazpar2 is free software; you can redistribute it and/or modify it under
   7 the terms of the GNU General Public License as published by the Free
   8 Software Foundation; either version 2, or (at your option) any later
   9 version.
  10
  11 Pazpar2 is distributed in the hope that it will be useful, but WITHOUT ANY
  12 WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14 for more details.
  15
  16 You should have received a copy of the GNU General Public License
  17 along with Pazpar2; see the file LICENSE.  If not, write to the
  18 Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA
  19 02111-1307, USA.
  20  */
  21
  22 /* $Id: config.c,v 1.34 2007-05-23 11:19:31 marc Exp $ */
  23
  24 #include <string.h>
  25
  26 #include <libxml/parser.h>
  27 #include <libxml/tree.h>
  28 #include <libxslt/xslt.h>
  29 #include <libxslt/transform.h>
  30 #include <libxslt/xsltutils.h>
  31
  32 #if HAVE_CONFIG_H
  33 #include <cconfig.h>
  34 #endif
  35
  36 #include <yaz/yaz-util.h>
  37 #include <yaz/nmem.h>
  38
  39 #define CONFIG_NOEXTERNS
  40 #include "config.h"
  41
  42
  43 static NMEM nmem = 0;
  44 static char confdir[256] = ".";
  45
  46 struct conf_config *config = 0;
  47
  48
  49 struct conf_metadata * conf_metadata_assign(NMEM nmem,
  50                                             struct conf_metadata * metadata,
  51                                             const char *name,
  52                                             enum conf_metadata_type type,
  53                                             enum conf_metadata_merge merge,
  54                                             int brief,
  55                                             int termlist,
  56                                             int rank,
  57                                             int sortkey_offset)
  58 {
  59     if (!nmem || !metadata || !name)
  60         return 0;
  61
  62     metadata->name = nmem_strdup(nmem, name);
  63
  64     // enforcing that merge_range is always type_year
  65     if (merge == Metadata_merge_range)
  66         metadata->type = Metadata_type_year;
  67     else
  68         metadata->type = type;
  69
  70     // enforcing that type_year is always range_merge
  71     if (metadata->type == Metadata_type_year)
  72         metadata->merge = Metadata_merge_range;
  73     else
  74         metadata->merge = merge;
  75
  76     metadata->brief = brief;
  77     metadata->termlist = termlist;
  78     metadata->rank = rank;
  79     metadata->sortkey_offset = sortkey_offset;
  80     return metadata;
  81 }
  82
  83
  84 struct conf_sortkey * conf_sortkey_assign(NMEM nmem,
  85                                           struct conf_sortkey * sortkey,
  86                                           const char *name,
  87                                           enum conf_sortkey_type type)
  88 {
  89     if (!nmem || !sortkey || !name)
  90         return 0;
  91
  92     sortkey->name = nmem_strdup(nmem, name);
  93     sortkey->type = type;
  94
  95     return sortkey;
  96 }
  97
  98
  99 struct conf_service * conf_service_create(NMEM nmem,
 100                                           int num_metadata, int num_sortkeys)
 101 {
 102     struct conf_service * service = 0;
 103
 104     //assert(nmem);
 105
 106     service = nmem_malloc(nmem, sizeof(struct conf_service));
 107
 108     service->num_metadata = num_metadata;
 109     service->metadata = 0;
 110     if (service->num_metadata)
 111       service->metadata
 112           = nmem_malloc(nmem,
 113                         sizeof(struct conf_metadata) * service->num_metadata);
 114     service->num_sortkeys = num_sortkeys;
 115     service->sortkeys = 0;
 116     if (service->num_sortkeys)
 117         service->sortkeys
 118             = nmem_malloc(nmem,
 119                           sizeof(struct conf_sortkey) * service->num_sortkeys);
 120
 121     return service;
 122 }
 123
 124 struct conf_metadata* conf_service_add_metadata(NMEM nmem,
 125                                                 struct conf_service *service,
 126                                                 int field_id,
 127                                                 const char *name,
 128                                                 enum conf_metadata_type type,
 129                                                 enum conf_metadata_merge merge,
 130                                                 int brief,
 131                                                 int termlist,
 132                                                 int rank,
 133                                                 int sortkey_offset)
 134 {
 135     struct conf_metadata * md = 0;
 136
 137     if (!service || !service->metadata || !service->num_metadata
 138         || field_id < 0  || !(field_id < service->num_metadata))
 139         return 0;
 140
 141     //md = &((service->metadata)[field_id]);
 142     md = service->metadata + field_id;
 143     md = conf_metadata_assign(nmem, md, name, type, merge,
 144                              brief, termlist, rank, sortkey_offset);
 145     return md;
 146 }
 147
 148
 149 struct conf_sortkey * conf_service_add_sortkey(NMEM nmem,
 150                                                struct conf_service *service,
 151                                                int field_id,
 152                                                const char *name,
 153                                                enum conf_sortkey_type type)
 154 {
 155     struct conf_sortkey * sk = 0;
 156
 157     if (!service || !service->sortkeys || !service->num_sortkeys
 158         || field_id < 0  || !(field_id < service->num_sortkeys))
 159         return 0;
 160
 161     //sk = &((service->sortkeys)[field_id]);
 162     sk = service->sortkeys + field_id;
 163     sk = conf_sortkey_assign(nmem, sk, name, type);
 164
 165     return sk;
 166 }
 167
 168
 169 int conf_service_metadata_field_id(struct conf_service *service,
 170                                    const char * name)
 171 {
 172     int i = 0;
 173
 174     if (!service || !service->metadata || !service->num_metadata)
 175         return -1;
 176
 177     for(i = 0; i < service->num_metadata; i++) {
 178         if (!strcmp(name, (service->metadata[i]).name))
 179             return i;
 180     }
 181
 182     return -1;
 183 };
 184
 185
 186 int conf_service_sortkey_field_id(struct conf_service *service,
 187                                   const char * name)
 188 {
 189     int i = 0;
 190
 191     if (!service || !service->sortkeys || !service->num_sortkeys)
 192         return -1;
 193
 194     for(i = 0; i < service->num_sortkeys; i++) {
 195         if (!strcmp(name, (service->sortkeys[i]).name))
 196             return i;
 197     }
 198
 199     return -1;
 200 };
 201
 202
 203
 204 /* Code to parse configuration file */
 205 /* ==================================================== */
 206
 207 static struct conf_service *parse_service(xmlNode *node)
 208 {
 209     xmlNode *n;
 210     int md_node = 0;
 211     int sk_node = 0;
 212
 213     struct conf_service *service = 0;
 214     int num_metadata = 0;
 215     int num_sortkeys = 0;
 216
 217     // count num_metadata and num_sortkeys
 218     for (n = node->children; n; n = n->next)
 219         if (n->type == XML_ELEMENT_NODE && !strcmp((const char *)
 220                                                    n->name, "metadata"))
 221         {
 222             xmlChar *sortkey = xmlGetProp(n, (xmlChar *) "sortkey");
 223             num_metadata++;
 224             if (sortkey && strcmp((const char *) sortkey, "no"))
 225                 num_sortkeys++;
 226             xmlFree(sortkey);
 227         }
 228
 229     service = conf_service_create(nmem, num_metadata, num_sortkeys);
 230
 231     for (n = node->children; n; n = n->next)
 232     {
 233         if (n->type != XML_ELEMENT_NODE)
 234             continue;
 235         if (!strcmp((const char *) n->name, (const char *) "metadata"))
 236         {
 237             xmlChar *xml_name = xmlGetProp(n, (xmlChar *) "name");
 238             xmlChar *xml_brief = xmlGetProp(n, (xmlChar *) "brief");
 239             xmlChar *xml_sortkey = xmlGetProp(n, (xmlChar *) "sortkey");
 240             xmlChar *xml_merge = xmlGetProp(n, (xmlChar *) "merge");
 241             xmlChar *xml_type = xmlGetProp(n, (xmlChar *) "type");
 242             xmlChar *xml_termlist = xmlGetProp(n, (xmlChar *) "termlist");
 243             xmlChar *xml_rank = xmlGetProp(n, (xmlChar *) "rank");
 244
 245             enum conf_metadata_type type = Metadata_type_generic;
 246             enum conf_metadata_merge merge = Metadata_merge_no;
 247             int brief = 0;
 248             int termlist = 0;
 249             int rank = 0;
 250             int sortkey_offset = 0;
 251             enum conf_sortkey_type sk_type = Metadata_sortkey_relevance;
 252
 253             // now do the parsing logic
 254             if (!xml_name)
 255             {
 256                 yaz_log(YLOG_FATAL, "Must specify name in metadata element");
 257                 return 0;
 258             }
 259             if (xml_brief)
 260             {
 261                 if (!strcmp((const char *) xml_brief, "yes"))
 262                     brief = 1;
 263                  else if (strcmp((const char *) xml_brief, "no"))
 264                 {
 265                     yaz_log(YLOG_FATAL, "metadata/brief must be yes or no");
 266                     return 0;
 267                 }
 268             }
 269             else
 270                 brief = 0;
 271
 272             if (xml_termlist)
 273             {
 274                 if (!strcmp((const char *) xml_termlist, "yes"))
 275                     termlist = 1;
 276                 else if (strcmp((const char *) xml_termlist, "no"))
 277                 {
 278                     yaz_log(YLOG_FATAL, "metadata/termlist must be yes or no");
 279                     return 0;
 280                 }
 281             }
 282             else
 283                 termlist = 0;
 284
 285             if (xml_rank)
 286                 rank = atoi((const char *) xml_rank);
 287             else
 288                 rank = 0;
 289
 290             if (xml_type)
 291             {
 292                 if (!strcmp((const char *) xml_type, "generic"))
 293                     type = Metadata_type_generic;
 294                 else if (!strcmp((const char *) xml_type, "year"))
 295                     type = Metadata_type_year;
 296                 else
 297                 {
 298                     yaz_log(YLOG_FATAL,
 299                             "Unknown value for metadata/type: %s", xml_type);
 300                     return 0;
 301                 }
 302             }
 303             else
 304                 type = Metadata_type_generic;
 305
 306             if (xml_merge)
 307             {
 308                 if (!strcmp((const char *) xml_merge, "no"))
 309                     merge = Metadata_merge_no;
 310                 else if (!strcmp((const char *) xml_merge, "unique"))
 311                     merge = Metadata_merge_unique;
 312                 else if (!strcmp((const char *) xml_merge, "longest"))
 313                     merge = Metadata_merge_longest;
 314                 else if (!strcmp((const char *) xml_merge, "range"))
 315                     merge = Metadata_merge_range;
 316                 else if (!strcmp((const char *) xml_merge, "all"))
 317                     merge = Metadata_merge_all;
 318                 else
 319                 {
 320                     yaz_log(YLOG_FATAL,
 321                             "Unknown value for metadata/merge: %s", xml_merge);
 322                     return 0;
 323                 }
 324             }
 325             else
 326                 merge = Metadata_merge_no;
 327
 328             // add a sortkey if so specified
 329             if (xml_sortkey && strcmp((const char *) xml_sortkey, "no"))
 330             {
 331                 if (merge == Metadata_merge_no)
 332                 {
 333                     yaz_log(YLOG_FATAL,
 334                             "Can't specify sortkey on a non-merged field");
 335                     return 0;
 336                 }
 337                 if (!strcmp((const char *) xml_sortkey, "numeric"))
 338                     sk_type = Metadata_sortkey_numeric;
 339                 else if (!strcmp((const char *) xml_sortkey, "skiparticle"))
 340                     sk_type = Metadata_sortkey_skiparticle;
 341                 else
 342                 {
 343                     yaz_log(YLOG_FATAL,
 344                             "Unknown sortkey in metadata element: %s",
 345                             xml_sortkey);
 346                     return 0;
 347                 }
 348                 sortkey_offset = sk_node;
 349
 350                 conf_service_add_sortkey(nmem, service, sk_node,
 351                                          (const char *) xml_name, sk_type);
 352
 353                 sk_node++;
 354             }
 355             else
 356                 sortkey_offset = -1;
 357
 358             // metadata known, assign values
 359             conf_service_add_metadata(nmem, service, md_node,
 360                                       (const char *) xml_name,
 361                                       type, merge,
 362                                       brief, termlist, rank, sortkey_offset);
 363
 364             xmlFree(xml_name);
 365             xmlFree(xml_brief);
 366             xmlFree(xml_sortkey);
 367             xmlFree(xml_merge);
 368             xmlFree(xml_type);
 369             xmlFree(xml_termlist);
 370             xmlFree(xml_rank);
 371             md_node++;
 372         }
 373         else
 374         {
 375             yaz_log(YLOG_FATAL, "Bad element: %s", n->name);
 376             return 0;
 377         }
 378     }
 379     return service;
 380 }
 381
 382 static char *parse_settings(xmlNode *node)
 383 {
 384     xmlChar *src = xmlGetProp(node, (xmlChar *) "src");
 385     char *r;
 386
 387     if (src)
 388         r = nmem_strdup(nmem, (const char *) src);
 389     else
 390     {
 391         yaz_log(YLOG_FATAL, "Must specify src in targetprofile");
 392         return 0;
 393     }
 394     xmlFree(src);
 395     return r;
 396 }
 397
 398 static struct conf_server *parse_server(xmlNode *node)
 399 {
 400     xmlNode *n;
 401     struct conf_server *server = nmem_malloc(nmem, sizeof(struct conf_server));
 402
 403     server->host = 0;
 404     server->port = 0;
 405     server->proxy_host = 0;
 406     server->proxy_port = 0;
 407     server->myurl = 0;
 408     server->zproxy_host = 0;
 409     server->zproxy_port = 0;
 410     server->service = 0;
 411     server->next = 0;
 412     server->settings = 0;
 413
 414 #ifdef HAVE_ICU
 415     server->icu_chn = 0;
 416 #endif // HAVE_ICU
 417
 418
 419     for (n = node->children; n; n = n->next)
 420     {
 421         if (n->type != XML_ELEMENT_NODE)
 422             continue;
 423         if (!strcmp((const char *) n->name, "listen"))
 424         {
 425             xmlChar *port = xmlGetProp(n, (xmlChar *) "port");
 426             xmlChar *host = xmlGetProp(n, (xmlChar *) "host");
 427             if (port)
 428                 server->port = atoi((const char *) port);
 429             if (host)
 430                 server->host = nmem_strdup(nmem, (const char *) host);
 431             xmlFree(port);
 432             xmlFree(host);
 433         }
 434         else if (!strcmp((const char *) n->name, "proxy"))
 435         {
 436             xmlChar *port = xmlGetProp(n, (xmlChar *) "port");
 437             xmlChar *host = xmlGetProp(n, (xmlChar *) "host");
 438             xmlChar *myurl = xmlGetProp(n, (xmlChar *) "myurl");
 439             if (port)
 440                 server->proxy_port = atoi((const char *) port);
 441             if (host)
 442                 server->proxy_host = nmem_strdup(nmem, (const char *) host);
 443             if (myurl)
 444                 server->myurl = nmem_strdup(nmem, (const char *) myurl);
 445 #ifdef GAGA
 446             else
 447             {
 448                 yaz_log(YLOG_FATAL, "Must specify @myurl for proxy");
 449                 return 0;
 450             }
 451 #endif
 452             xmlFree(port);
 453             xmlFree(host);
 454             xmlFree(myurl);
 455         }
 456         else if (!strcmp((const char *) n->name, "zproxy"))
 457         {
 458             xmlChar *port = 0;
 459             xmlChar *host = 0;
 460
 461             port = xmlGetProp(n, (xmlChar *) "port");
 462             host = xmlGetProp(n, (xmlChar *) "host");
 463
 464             if (port)
 465                 server->zproxy_port = atoi((const char *) port);
 466             if (host)
 467                 server->zproxy_host = nmem_strdup(nmem, (const char *) host);
 468
 469             xmlFree(port);
 470             xmlFree(host);
 471         }
 472         else if (!strcmp((const char *) n->name, "settings"))
 473         {
 474             if (server->settings)
 475             {
 476                 yaz_log(YLOG_FATAL, "Can't repeat 'settings'");
 477                 return 0;
 478             }
 479             if (!(server->settings = parse_settings(n)))
 480                 return 0;
 481         }
 482         else if (!strcmp((const char *) n->name, "icu_chain"))
 483         {
 484 #ifdef HAVE_ICU
 485             UErrorCode status = U_ZERO_ERROR;
 486             struct icu_chain *chain = icu_chain_xml_config(n, &status);
 487             if (!chain || U_FAILURE(status)){
 488                 //xmlDocPtr icu_doc = 0;
 489                 //xmlChar *xmlstr = 0;
 490                 //int size = 0;
 491                 //xmlDocDumpMemory(icu_doc, size);
 492
 493                 yaz_log(YLOG_FATAL, "Could not parse ICU chain config:\n"
 494                         "<%s>\n ... \n</%s>",
 495                         n->name, n->name);
 496                 return 0;
 497             }
 498             server->icu_chn = chain;
 499 #else // HAVE_ICU
 500             yaz_log(YLOG_FATAL, "Error: ICU support requested with element:\n"
 501                     "<%s>\n ... \n</%s>",
 502                     n->name, n->name);
 503             yaz_log(YLOG_FATAL,
 504                     "But no ICU support compiled into pazpar2 server.");
 505             yaz_log(YLOG_FATAL,
 506                     "Please install libicu36-dev and icu-doc or similar, "
 507                     "re-configure and re-compile");
 508             return 0;
 509 #endif // HAVE_ICU
 510         }
 511         else if (!strcmp((const char *) n->name, "service"))
 512         {
 513             struct conf_service *s = parse_service(n);
 514             if (!s)
 515                 return 0;
 516             server->service = s;
 517         }
 518         else
 519         {
 520             yaz_log(YLOG_FATAL, "Bad element: %s", n->name);
 521             return 0;
 522         }
 523     }
 524     return server;
 525 }
 526
 527 xsltStylesheet *conf_load_stylesheet(const char *fname)
 528 {
 529     char path[256];
 530     sprintf(path, "%s/%s", confdir, fname);
 531     return xsltParseStylesheetFile((xmlChar *) path);
 532 }
 533
 534 static struct conf_targetprofiles *parse_targetprofiles(xmlNode *node)
 535 {
 536     struct conf_targetprofiles *r = nmem_malloc(nmem, sizeof(*r));
 537     xmlChar *type = xmlGetProp(node, (xmlChar *) "type");
 538     xmlChar *src = xmlGetProp(node, (xmlChar *) "src");
 539
 540     memset(r, 0, sizeof(*r));
 541
 542     if (type)
 543     {
 544         if (!strcmp((const char *) type, "local"))
 545             r->type = Targetprofiles_local;
 546         else
 547         {
 548             yaz_log(YLOG_FATAL, "Unknown targetprofile type");
 549             return 0;
 550         }
 551     }
 552     else
 553     {
 554         yaz_log(YLOG_FATAL, "Must specify type for targetprofile");
 555         return 0;
 556     }
 557
 558     if (src)
 559         r->src = nmem_strdup(nmem, (const char *) src);
 560     else
 561     {
 562         yaz_log(YLOG_FATAL, "Must specify src in targetprofile");
 563         return 0;
 564     }
 565     xmlFree(type);
 566     xmlFree(src);
 567     return r;
 568 }
 569
 570 static struct conf_config *parse_config(xmlNode *root)
 571 {
 572     xmlNode *n;
 573     struct conf_config *r = nmem_malloc(nmem, sizeof(struct conf_config));
 574
 575     r->servers = 0;
 576     r->targetprofiles = 0;
 577
 578     for (n = root->children; n; n = n->next)
 579     {
 580         if (n->type != XML_ELEMENT_NODE)
 581             continue;
 582         if (!strcmp((const char *) n->name, "server"))
 583         {
 584             struct conf_server *tmp = parse_server(n);
 585             if (!tmp)
 586                 return 0;
 587             tmp->next = r->servers;
 588             r->servers = tmp;
 589         }
 590         else if (!strcmp((const char *) n->name, "targetprofiles"))
 591         {
 592             // It would be fun to be able to fix this sometime
 593             if (r->targetprofiles)
 594             {
 595                 yaz_log(YLOG_FATAL, "Can't repeat targetprofiles");
 596                 return 0;
 597             }
 598             if (!(r->targetprofiles = parse_targetprofiles(n)))
 599                 return 0;
 600         }
 601         else
 602         {
 603             yaz_log(YLOG_FATAL, "Bad element: %s", n->name);
 604             return 0;
 605         }
 606     }
 607     return r;
 608 }
 609
 610 int read_config(const char *fname)
 611 {
 612     xmlDoc *doc = xmlParseFile(fname);
 613     const char *p;
 614
 615     if (!nmem)  // Initialize
 616     {
 617         nmem = nmem_create();
 618         xmlSubstituteEntitiesDefault(1);
 619         xmlLoadExtDtdDefaultValue = 1;
 620     }
 621     if (!doc)
 622     {
 623         yaz_log(YLOG_FATAL, "Failed to read %s", fname);
 624         exit(1);
 625     }
 626     if ((p = strrchr(fname, '/')))
 627     {
 628         int len = p - fname;
 629         strncpy(confdir, fname, len);
 630         confdir[len] = '\0';
 631     }
 632     config = parse_config(xmlDocGetRootElement(doc));
 633     xmlFreeDoc(doc);
 634
 635     if (config)
 636         return 1;
 637     else
 638         return 0;
 639 }
 640
 641
 642 /*
 643  * Local variables:
 644  * c-basic-offset: 4
 645  * indent-tabs-mode: nil
 646  * End:
 647  * vim: shiftwidth=4 tabstop=8 expandtab
 648  */