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