src/pazpar2_config.c

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