src/config.c

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