src/config.c

   1 /* $Id: config.c,v 1.42 2007-10-31 05:29: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.42 2007-10-31 05:29: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     metadata->type = type;
  67
  68     // enforcing that type_year is always range_merge
  69     if (metadata->type == Metadata_type_year)
  70         metadata->merge = Metadata_merge_range;
  71     else
  72         metadata->merge = merge;
  73
  74     metadata->setting = setting;
  75     metadata->brief = brief;
  76     metadata->termlist = termlist;
  77     metadata->rank = rank;
  78     metadata->sortkey_offset = sortkey_offset;
  79     return metadata;
  80 }
  81
  82
  83 struct conf_sortkey * conf_sortkey_assign(NMEM nmem,
  84                                           struct conf_sortkey * sortkey,
  85                                           const char *name,
  86                                           enum conf_sortkey_type type)
  87 {
  88     if (!nmem || !sortkey || !name)
  89         return 0;
  90
  91     sortkey->name = nmem_strdup(nmem, name);
  92     sortkey->type = type;
  93
  94     return sortkey;
  95 }
  96
  97
  98 struct conf_service * conf_service_create(NMEM nmem,
  99                                           int num_metadata, int num_sortkeys)
 100 {
 101     struct conf_service * service = 0;
 102
 103     //assert(nmem);
 104
 105     service = nmem_malloc(nmem, sizeof(struct conf_service));
 106
 107     service->num_metadata = num_metadata;
 108     service->metadata = 0;
 109     if (service->num_metadata)
 110       service->metadata
 111           = nmem_malloc(nmem,
 112                         sizeof(struct conf_metadata) * service->num_metadata);
 113     service->num_sortkeys = num_sortkeys;
 114     service->sortkeys = 0;
 115     if (service->num_sortkeys)
 116         service->sortkeys
 117             = nmem_malloc(nmem,
 118                           sizeof(struct conf_sortkey) * service->num_sortkeys);
 119
 120     return service;
 121 }
 122
 123 struct conf_metadata* conf_service_add_metadata(NMEM nmem,
 124                                                 struct conf_service *service,
 125                                                 int field_id,
 126                                                 const char *name,
 127                                                 enum conf_metadata_type type,
 128                                                 enum conf_metadata_merge merge,
 129                                                 enum conf_setting_type setting,
 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, setting,
 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             xmlChar *xml_setting = xmlGetProp(n, (xmlChar *) "setting");
 245
 246             enum conf_metadata_type type = Metadata_type_generic;
 247             enum conf_metadata_merge merge = Metadata_merge_no;
 248             enum conf_setting_type setting = Metadata_setting_no;
 249             enum conf_sortkey_type sk_type = Metadata_sortkey_relevance;
 250             int brief = 0;
 251             int termlist = 0;
 252             int rank = 0;
 253             int sortkey_offset = 0;
 254
 255             // now do the parsing logic
 256             if (!xml_name)
 257             {
 258                 yaz_log(YLOG_FATAL, "Must specify name in metadata element");
 259                 return 0;
 260             }
 261             if (xml_brief)
 262             {
 263                 if (!strcmp((const char *) xml_brief, "yes"))
 264                     brief = 1;
 265                  else if (strcmp((const char *) xml_brief, "no"))
 266                 {
 267                     yaz_log(YLOG_FATAL, "metadata/brief must be yes or no");
 268                     return 0;
 269                 }
 270             }
 271             else
 272                 brief = 0;
 273
 274             if (xml_termlist)
 275             {
 276                 if (!strcmp((const char *) xml_termlist, "yes"))
 277                     termlist = 1;
 278                 else if (strcmp((const char *) xml_termlist, "no"))
 279                 {
 280                     yaz_log(YLOG_FATAL, "metadata/termlist must be yes or no");
 281                     return 0;
 282                 }
 283             }
 284             else
 285                 termlist = 0;
 286
 287             if (xml_rank)
 288                 rank = atoi((const char *) xml_rank);
 289             else
 290                 rank = 0;
 291
 292             if (xml_type)
 293             {
 294                 if (!strcmp((const char *) xml_type, "generic"))
 295                     type = Metadata_type_generic;
 296                 else if (!strcmp((const char *) xml_type, "year"))
 297                     type = Metadata_type_year;
 298                 else if (!strcmp((const char *) xml_type, "date"))
 299                     type = Metadata_type_date;
 300                 else
 301                 {
 302                     yaz_log(YLOG_FATAL,
 303                             "Unknown value for metadata/type: %s", xml_type);
 304                     return 0;
 305                 }
 306             }
 307             else
 308                 type = Metadata_type_generic;
 309
 310             if (xml_merge)
 311             {
 312                 if (!strcmp((const char *) xml_merge, "no"))
 313                     merge = Metadata_merge_no;
 314                 else if (!strcmp((const char *) xml_merge, "unique"))
 315                     merge = Metadata_merge_unique;
 316                 else if (!strcmp((const char *) xml_merge, "longest"))
 317                     merge = Metadata_merge_longest;
 318                 else if (!strcmp((const char *) xml_merge, "range"))
 319                     merge = Metadata_merge_range;
 320                 else if (!strcmp((const char *) xml_merge, "all"))
 321                     merge = Metadata_merge_all;
 322                 else
 323                 {
 324                     yaz_log(YLOG_FATAL,
 325                             "Unknown value for metadata/merge: %s", xml_merge);
 326                     return 0;
 327                 }
 328             }
 329             else
 330                 merge = Metadata_merge_no;
 331
 332             if (xml_setting)
 333             {
 334                 if (!strcmp((const char *) xml_setting, "no"))
 335                     setting = Metadata_setting_no;
 336                 else if (!strcmp((const char *) xml_setting, "postproc"))
 337                     setting = Metadata_setting_postproc;
 338                 else if (!strcmp((const char *) xml_setting, "parameter"))
 339                     setting = Metadata_setting_parameter;
 340                 else
 341                 {
 342                     yaz_log(YLOG_FATAL,
 343                         "Unknown value for medadata/setting: %s", xml_setting);
 344                     return 0;
 345                 }
 346             }
 347
 348             // add a sortkey if so specified
 349             if (xml_sortkey && strcmp((const char *) xml_sortkey, "no"))
 350             {
 351                 if (merge == Metadata_merge_no)
 352                 {
 353                     yaz_log(YLOG_FATAL,
 354                             "Can't specify sortkey on a non-merged field");
 355                     return 0;
 356                 }
 357                 if (!strcmp((const char *) xml_sortkey, "numeric"))
 358                     sk_type = Metadata_sortkey_numeric;
 359                 else if (!strcmp((const char *) xml_sortkey, "skiparticle"))
 360                     sk_type = Metadata_sortkey_skiparticle;
 361                 else
 362                 {
 363                     yaz_log(YLOG_FATAL,
 364                             "Unknown sortkey in metadata element: %s",
 365                             xml_sortkey);
 366                     return 0;
 367                 }
 368                 sortkey_offset = sk_node;
 369
 370                 conf_service_add_sortkey(nmem, service, sk_node,
 371                                          (const char *) xml_name, sk_type);
 372
 373                 sk_node++;
 374             }
 375             else
 376                 sortkey_offset = -1;
 377
 378             // metadata known, assign values
 379             conf_service_add_metadata(nmem, service, md_node,
 380                                       (const char *) xml_name,
 381                                       type, merge, setting,
 382                                       brief, termlist, rank, sortkey_offset);
 383
 384             xmlFree(xml_name);
 385             xmlFree(xml_brief);
 386             xmlFree(xml_sortkey);
 387             xmlFree(xml_merge);
 388             xmlFree(xml_type);
 389             xmlFree(xml_termlist);
 390             xmlFree(xml_rank);
 391             md_node++;
 392         }
 393         else
 394         {
 395             yaz_log(YLOG_FATAL, "Bad element: %s", n->name);
 396             return 0;
 397         }
 398     }
 399     return service;
 400 }
 401
 402 static char *parse_settings(xmlNode *node)
 403 {
 404     xmlChar *src = xmlGetProp(node, (xmlChar *) "src");
 405     char *r;
 406
 407     if (src)
 408         r = nmem_strdup(nmem, (const char *) src);
 409     else
 410     {
 411         yaz_log(YLOG_FATAL, "Must specify src in targetprofile");
 412         return 0;
 413     }
 414     xmlFree(src);
 415     return r;
 416 }
 417
 418 static struct conf_server *parse_server(xmlNode *node)
 419 {
 420     xmlNode *n;
 421     struct conf_server *server = nmem_malloc(nmem, sizeof(struct conf_server));
 422
 423     server->host = 0;
 424     server->port = 0;
 425     server->proxy_host = 0;
 426     server->proxy_port = 0;
 427     server->myurl = 0;
 428     server->service = 0;
 429     server->next = 0;
 430     server->settings = 0;
 431     server->relevance_pct = 0;
 432     server->sort_pct = 0;
 433     server->mergekey_pct = 0;
 434
 435     for (n = node->children; n; n = n->next)
 436     {
 437         if (n->type != XML_ELEMENT_NODE)
 438             continue;
 439         if (!strcmp((const char *) n->name, "listen"))
 440         {
 441             xmlChar *port = xmlGetProp(n, (xmlChar *) "port");
 442             xmlChar *host = xmlGetProp(n, (xmlChar *) "host");
 443             if (port)
 444                 server->port = atoi((const char *) port);
 445             if (host)
 446                 server->host = nmem_strdup(nmem, (const char *) host);
 447             xmlFree(port);
 448             xmlFree(host);
 449         }
 450         else if (!strcmp((const char *) n->name, "proxy"))
 451         {
 452             xmlChar *port = xmlGetProp(n, (xmlChar *) "port");
 453             xmlChar *host = xmlGetProp(n, (xmlChar *) "host");
 454             xmlChar *myurl = xmlGetProp(n, (xmlChar *) "myurl");
 455             if (port)
 456                 server->proxy_port = atoi((const char *) port);
 457             if (host)
 458                 server->proxy_host = nmem_strdup(nmem, (const char *) host);
 459             if (myurl)
 460                 server->myurl = nmem_strdup(nmem, (const char *) myurl);
 461 #ifdef GAGA
 462             else
 463             {
 464                 yaz_log(YLOG_FATAL, "Must specify @myurl for proxy");
 465                 return 0;
 466             }
 467 #endif
 468             xmlFree(port);
 469             xmlFree(host);
 470             xmlFree(myurl);
 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, "relevance"))
 483         {
 484             server->relevance_pct = pp2_charset_create_xml(n->children);
 485         }
 486         else if (!strcmp((const char *) n->name, "sort"))
 487         {
 488             server->sort_pct = pp2_charset_create_xml(n->children);
 489         }
 490         else if (!strcmp((const char *) n->name, "mergekey"))
 491         {
 492             server->mergekey_pct = pp2_charset_create_xml(n->children);
 493         }
 494         else if (!strcmp((const char *) n->name, "service"))
 495         {
 496             struct conf_service *s = parse_service(n);
 497             if (!s)
 498                 return 0;
 499             server->service = s;
 500         }
 501         else
 502         {
 503             yaz_log(YLOG_FATAL, "Bad element: %s", n->name);
 504             return 0;
 505         }
 506     }
 507     if (!server->relevance_pct)
 508         server->relevance_pct = pp2_charset_create(0);
 509     if (!server->sort_pct)
 510         server->sort_pct = pp2_charset_create(0);
 511     if (!server->mergekey_pct)
 512         server->mergekey_pct = pp2_charset_create(0);
 513     return server;
 514 }
 515
 516 xsltStylesheet *conf_load_stylesheet(const char *fname)
 517 {
 518     char path[256];
 519     if (*fname == '/')
 520         yaz_snprintf(path, sizeof(path), fname);
 521     else
 522         yaz_snprintf(path, sizeof(path), "%s/%s", confdir, fname);
 523     return xsltParseStylesheetFile((xmlChar *) path);
 524 }
 525
 526 static struct conf_targetprofiles *parse_targetprofiles(xmlNode *node)
 527 {
 528     struct conf_targetprofiles *r = nmem_malloc(nmem, sizeof(*r));
 529     xmlChar *type = xmlGetProp(node, (xmlChar *) "type");
 530     xmlChar *src = xmlGetProp(node, (xmlChar *) "src");
 531
 532     memset(r, 0, sizeof(*r));
 533
 534     if (type)
 535     {
 536         if (!strcmp((const char *) type, "local"))
 537             r->type = Targetprofiles_local;
 538         else
 539         {
 540             yaz_log(YLOG_FATAL, "Unknown targetprofile type");
 541             return 0;
 542         }
 543     }
 544     else
 545     {
 546         yaz_log(YLOG_FATAL, "Must specify type for targetprofile");
 547         return 0;
 548     }
 549
 550     if (src)
 551         r->src = nmem_strdup(nmem, (const char *) src);
 552     else
 553     {
 554         yaz_log(YLOG_FATAL, "Must specify src in targetprofile");
 555         return 0;
 556     }
 557     xmlFree(type);
 558     xmlFree(src);
 559     return r;
 560 }
 561
 562 static struct conf_config *parse_config(xmlNode *root)
 563 {
 564     xmlNode *n;
 565     struct conf_config *r = nmem_malloc(nmem, sizeof(struct conf_config));
 566
 567     r->servers = 0;
 568     r->targetprofiles = 0;
 569
 570     for (n = root->children; n; n = n->next)
 571     {
 572         if (n->type != XML_ELEMENT_NODE)
 573             continue;
 574         if (!strcmp((const char *) n->name, "server"))
 575         {
 576             struct conf_server *tmp = parse_server(n);
 577             if (!tmp)
 578                 return 0;
 579             tmp->next = r->servers;
 580             r->servers = tmp;
 581         }
 582         else if (!strcmp((const char *) n->name, "targetprofiles"))
 583         {
 584             // It would be fun to be able to fix this sometime
 585             if (r->targetprofiles)
 586             {
 587                 yaz_log(YLOG_FATAL, "Can't repeat targetprofiles");
 588                 return 0;
 589             }
 590             if (!(r->targetprofiles = parse_targetprofiles(n)))
 591                 return 0;
 592         }
 593         else
 594         {
 595             yaz_log(YLOG_FATAL, "Bad element: %s", n->name);
 596             return 0;
 597         }
 598     }
 599     return r;
 600 }
 601
 602 int read_config(const char *fname)
 603 {
 604     xmlDoc *doc = xmlParseFile(fname);
 605     const char *p;
 606
 607     if (!nmem)  // Initialize
 608     {
 609         nmem = nmem_create();
 610         xmlSubstituteEntitiesDefault(1);
 611         xmlLoadExtDtdDefaultValue = 1;
 612     }
 613     if (!doc)
 614     {
 615         yaz_log(YLOG_FATAL, "Failed to read %s", fname);
 616         exit(1);
 617     }
 618     if ((p = strrchr(fname, '/')))
 619     {
 620         int len = p - fname;
 621         if (len >= sizeof(confdir))
 622             len = sizeof(confdir)-1;
 623         strncpy(confdir, fname, len);
 624         confdir[len] = '\0';
 625     }
 626     config = parse_config(xmlDocGetRootElement(doc));
 627     xmlFreeDoc(doc);
 628
 629     if (config)
 630         return 1;
 631     else
 632         return 0;
 633 }
 634
 635
 636 /*
 637  * Local variables:
 638  * c-basic-offset: 4
 639  * indent-tabs-mode: nil
 640  * End:
 641  * vim: shiftwidth=4 tabstop=8 expandtab
 642  */