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