src/pazpar2_config.c

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