src/config.c

   1 /* $Id: config.c,v 1.30 2007-04-23 12:33:00 marc Exp $
   2    Copyright (c) 2006-2007, Index Data.
   3
   4 This file is part of Pazpar2.
   5
   6 Pazpar2 is free software; you can redistribute it and/or modify it under
   7 the terms of the GNU General Public License as published by the Free
   8 Software Foundation; either version 2, or (at your option) any later
   9 version.
  10
  11 Pazpar2 is distributed in the hope that it will be useful, but WITHOUT ANY
  12 WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14 for more details.
  15
  16 You should have received a copy of the GNU General Public License
  17 along with Pazpar2; see the file LICENSE.  If not, write to the
  18 Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA
  19 02111-1307, USA.
  20  */
  21
  22 /* $Id: config.c,v 1.30 2007-04-23 12:33:00 marc Exp $ */
  23
  24 #include <string.h>
  25
  26 #include <libxml/parser.h>
  27 #include <libxml/tree.h>
  28 #include <libxslt/xslt.h>
  29 #include <libxslt/transform.h>
  30 #include <libxslt/xsltutils.h>
  31
  32 #if HAVE_CONFIG_H
  33 #include <cconfig.h>
  34 #endif
  35
  36 #include <yaz/yaz-util.h>
  37 #include <yaz/nmem.h>
  38
  39 #define CONFIG_NOEXTERNS
  40 #include "config.h"
  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                                             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     metadata->type = type;
  63     metadata->merge = merge;
  64     metadata->brief = brief;
  65     metadata->termlist = termlist;
  66     metadata->rank = rank;
  67     metadata->sortkey_offset = sortkey_offset;
  68
  69     return metadata;
  70 }
  71
  72
  73 struct conf_sortkey * conf_sortkey_assign(NMEM nmem,
  74                                           struct conf_sortkey * sortkey,
  75                                           const char *name,
  76                                           enum conf_sortkey_type type)
  77 {
  78     if (!nmem || !sortkey || !name)
  79         return 0;
  80
  81     sortkey->name = nmem_strdup(nmem, name);
  82     sortkey->type = type;
  83
  84     return sortkey;
  85 }
  86
  87
  88 struct conf_service * conf_service_create(NMEM nmem,
  89                                           int num_metadata, int num_sortkeys)
  90 {
  91     struct conf_service * service = 0;
  92
  93     //assert(nmem);
  94
  95     service = nmem_malloc(nmem, sizeof(struct conf_service));
  96
  97     service->num_metadata = num_metadata;
  98     service->metadata = 0;
  99     if (service->num_metadata)
 100       service->metadata
 101           = nmem_malloc(nmem,
 102                         sizeof(struct conf_metadata) * service->num_metadata);
 103     service->num_sortkeys = num_sortkeys;
 104     service->sortkeys = 0;
 105     if (service->num_sortkeys)
 106         service->sortkeys
 107             = nmem_malloc(nmem,
 108                           sizeof(struct conf_sortkey) * service->num_sortkeys);
 109     return service;
 110 }
 111
 112 struct conf_metadata* conf_service_add_metadata(NMEM nmem,
 113                                                 struct conf_service *service,
 114                                                 int position,
 115                                                 const char *name,
 116                                                 enum conf_metadata_type type,
 117                                                 enum conf_metadata_merge merge,
 118                                                 int brief,
 119                                                 int termlist,
 120                                                 int rank,
 121                                                 int sortkey_offset)
 122 {
 123     struct conf_metadata * md = 0;
 124
 125     if (!service || !service->metadata || !service->num_metadata
 126         || position < 0  || !(position < service->num_metadata))
 127         return 0;
 128
 129     //md = &((service->metadata)[position]);
 130     md = service->metadata + position;
 131     md = conf_metadata_assign(nmem, md, name, type, merge,
 132                              brief, termlist, rank, sortkey_offset);
 133     return md;
 134 }
 135
 136
 137 struct conf_sortkey * conf_service_add_sortkey(NMEM nmem,
 138                                                struct conf_service *service,
 139                                                int position,
 140                                                const char *name,
 141                                                enum conf_sortkey_type type)
 142 {
 143     struct conf_sortkey * sk = 0;
 144
 145     if (!service || !service->sortkeys || !service->num_sortkeys
 146         || position < 0  || !(position < service->num_sortkeys))
 147         return 0;
 148
 149     //sk = &((service->sortkeys)[position]);
 150     sk = service->sortkeys + position;
 151     sk = conf_sortkey_assign(nmem, sk, name, type);
 152
 153     return sk;
 154 }
 155
 156
 157 int conf_service_metadata_field_id(struct conf_service *service, const char * name)
 158 {
 159     int i = 0;
 160
 161     if (!service || !service->metadata || !service->num_metadata)
 162         return -1;
 163
 164     for(i = 0; i < service->num_metadata; i++) {
 165         if (!strcmp(name, (service->metadata[i]).name))
 166             return i;
 167     }
 168
 169     return -1;
 170 };
 171
 172
 173 int conf_service_sortkey_field_id(struct conf_service *service, const char * name)
 174 {
 175     int i = 0;
 176
 177     if (!service || !service->sortkeys || !service->num_sortkeys)
 178         return -1;
 179
 180     for(i = 0; i < service->num_sortkeys; i++) {
 181         if (!strcmp(name, (service->sortkeys[i]).name))
 182             return i;
 183     }
 184
 185     return -1;
 186 };
 187
 188
 189
 190 /* Code to parse configuration file */
 191 /* ==================================================== */
 192
 193 static struct conf_service *parse_service(xmlNode *node)
 194 {
 195     xmlNode *n;
 196     int md_node = 0;
 197     int sk_node = 0;
 198
 199     struct conf_service *service = 0;
 200     int num_metadata = 0;
 201     int num_sortkeys = 0;
 202
 203     // count num_metadata and num_sortkeys
 204     for (n = node->children; n; n = n->next)
 205         if (n->type == XML_ELEMENT_NODE && !strcmp((const char *)
 206                                                    n->name, "metadata"))
 207         {
 208             xmlChar *sortkey = xmlGetProp(n, (xmlChar *) "sortkey");
 209             num_metadata++;
 210             if (sortkey && strcmp((const char *) sortkey, "no"))
 211                 num_sortkeys++;
 212             xmlFree(sortkey);
 213         }
 214
 215     service = conf_service_create(nmem, num_metadata, num_sortkeys);
 216
 217     for (n = node->children; n; n = n->next)
 218     {
 219         if (n->type != XML_ELEMENT_NODE)
 220             continue;
 221         if (!strcmp((const char *) n->name, (const char *) "metadata"))
 222         {
 223             xmlChar *xml_name = xmlGetProp(n, (xmlChar *) "name");
 224             xmlChar *xml_brief = xmlGetProp(n, (xmlChar *) "brief");
 225             xmlChar *xml_sortkey = xmlGetProp(n, (xmlChar *) "sortkey");
 226             xmlChar *xml_merge = xmlGetProp(n, (xmlChar *) "merge");
 227             xmlChar *xml_type = xmlGetProp(n, (xmlChar *) "type");
 228             xmlChar *xml_termlist = xmlGetProp(n, (xmlChar *) "termlist");
 229             xmlChar *xml_rank = xmlGetProp(n, (xmlChar *) "rank");
 230
 231             enum conf_metadata_type type = Metadata_type_generic;
 232             enum conf_metadata_merge merge = Metadata_merge_no;
 233             int brief = 0;
 234             int termlist = 0;
 235             int rank = 0;
 236             int sortkey_offset = 0;
 237             enum conf_sortkey_type sk_type = Metadata_sortkey_relevance;
 238
 239             // now do the parsing logic
 240             if (!xml_name)
 241             {
 242                 yaz_log(YLOG_FATAL, "Must specify name in metadata element");
 243                 return 0;
 244             }
 245             if (xml_brief)
 246             {
 247                 if (!strcmp((const char *) xml_brief, "yes"))
 248                     brief = 1;
 249                  else if (strcmp((const char *) xml_brief, "no"))
 250                 {
 251                     yaz_log(YLOG_FATAL, "metadata/brief must be yes or no");
 252                     return 0;
 253                 }
 254             }
 255             else
 256                 brief = 0;
 257
 258             if (xml_termlist)
 259             {
 260                 if (!strcmp((const char *) xml_termlist, "yes"))
 261                     termlist = 1;
 262                 else if (strcmp((const char *) xml_termlist, "no"))
 263                 {
 264                     yaz_log(YLOG_FATAL, "metadata/termlist must be yes or no");
 265                     return 0;
 266                 }
 267             }
 268             else
 269                 termlist = 0;
 270
 271             if (xml_rank)
 272                 rank = atoi((const char *) xml_rank);
 273             else
 274                 rank = 0;
 275
 276             if (xml_type)
 277             {
 278                 if (!strcmp((const char *) xml_type, "generic"))
 279                     type = Metadata_type_generic;
 280                 else if (!strcmp((const char *) xml_type, "year"))
 281                     type = Metadata_type_year;
 282                 else
 283                 {
 284                     yaz_log(YLOG_FATAL, "Unknown value for metadata/type: %s", xml_type);
 285                     return 0;
 286                 }
 287             }
 288             else
 289                 type = Metadata_type_generic;
 290
 291             if (xml_merge)
 292             {
 293                 if (!strcmp((const char *) xml_merge, "no"))
 294                     merge = Metadata_merge_no;
 295                 else if (!strcmp((const char *) xml_merge, "unique"))
 296                     merge = Metadata_merge_unique;
 297                 else if (!strcmp((const char *) xml_merge, "longest"))
 298                     merge = Metadata_merge_longest;
 299                 else if (!strcmp((const char *) xml_merge, "range"))
 300                     merge = Metadata_merge_range;
 301                 else if (!strcmp((const char *) xml_merge, "all"))
 302                     merge = Metadata_merge_all;
 303                 else
 304                 {
 305                     yaz_log(YLOG_FATAL,
 306                             "Unknown value for metadata/merge: %s", xml_merge);
 307                     return 0;
 308                 }
 309             }
 310             else
 311                 merge = Metadata_merge_no;
 312
 313             // add a sortkey if so specified
 314             if (xml_sortkey && strcmp((const char *) xml_sortkey, "no"))
 315             {
 316                 if (merge == Metadata_merge_no)
 317                 {
 318                     yaz_log(YLOG_FATAL,
 319                             "Can't specify sortkey on a non-merged field");
 320                     return 0;
 321                 }
 322                 if (!strcmp((const char *) xml_sortkey, "numeric"))
 323                     sk_type = Metadata_sortkey_numeric;
 324                 else if (!strcmp((const char *) xml_sortkey, "skiparticle"))
 325                     sk_type = Metadata_sortkey_skiparticle;
 326                 else
 327                 {
 328                     yaz_log(YLOG_FATAL,
 329                             "Unknown sortkey in metadata element: %s",
 330                             xml_sortkey);
 331                     return 0;
 332                 }
 333                 sortkey_offset = sk_node;
 334
 335                 conf_service_add_sortkey(nmem, service, sk_node,
 336                                          (const char *) xml_name, sk_type);
 337
 338                 sk_node++;
 339             }
 340             else
 341                 sortkey_offset = -1;
 342
 343             // metadata known, assign values
 344             conf_service_add_metadata(nmem, service, md_node,
 345                                       (const char *) xml_name,
 346                                       type, merge,
 347                                       brief, termlist, rank, sortkey_offset);
 348
 349             xmlFree(xml_name);
 350             xmlFree(xml_brief);
 351             xmlFree(xml_sortkey);
 352             xmlFree(xml_merge);
 353             xmlFree(xml_type);
 354             xmlFree(xml_termlist);
 355             xmlFree(xml_rank);
 356             md_node++;
 357         }
 358         else
 359         {
 360             yaz_log(YLOG_FATAL, "Bad element: %s", n->name);
 361             return 0;
 362         }
 363     }
 364     return service;
 365 }
 366
 367 static char *parse_settings(xmlNode *node)
 368 {
 369     xmlChar *src = xmlGetProp(node, (xmlChar *) "src");
 370     char *r;
 371
 372     if (src)
 373         r = nmem_strdup(nmem, (const char *) src);
 374     else
 375     {
 376         yaz_log(YLOG_FATAL, "Must specify src in targetprofile");
 377         return 0;
 378     }
 379     xmlFree(src);
 380     return r;
 381 }
 382
 383 static struct conf_server *parse_server(xmlNode *node)
 384 {
 385     xmlNode *n;
 386     struct conf_server *r = nmem_malloc(nmem, sizeof(struct conf_server));
 387
 388     r->host = 0;
 389     r->port = 0;
 390     r->proxy_host = 0;
 391     r->proxy_port = 0;
 392     r->myurl = 0;
 393     r->zproxy_host = 0;
 394     r->zproxy_port = 0;
 395     r->service = 0;
 396     r->next = 0;
 397     r->settings = 0;
 398
 399     for (n = node->children; n; n = n->next)
 400     {
 401         if (n->type != XML_ELEMENT_NODE)
 402             continue;
 403         if (!strcmp((const char *) n->name, "listen"))
 404         {
 405             xmlChar *port = xmlGetProp(n, (xmlChar *) "port");
 406             xmlChar *host = xmlGetProp(n, (xmlChar *) "host");
 407             if (port)
 408                 r->port = atoi((const char *) port);
 409             if (host)
 410                 r->host = nmem_strdup(nmem, (const char *) host);
 411             xmlFree(port);
 412             xmlFree(host);
 413         }
 414         else if (!strcmp((const char *) n->name, "proxy"))
 415         {
 416             xmlChar *port = xmlGetProp(n, (xmlChar *) "port");
 417             xmlChar *host = xmlGetProp(n, (xmlChar *) "host");
 418             xmlChar *myurl = xmlGetProp(n, (xmlChar *) "myurl");
 419             if (port)
 420                 r->proxy_port = atoi((const char *) port);
 421             if (host)
 422                 r->proxy_host = nmem_strdup(nmem, (const char *) host);
 423             if (myurl)
 424                 r->myurl = nmem_strdup(nmem, (const char *) myurl);
 425 #ifdef GAGA
 426             else
 427             {
 428                 yaz_log(YLOG_FATAL, "Must specify @myurl for proxy");
 429                 return 0;
 430             }
 431 #endif
 432             xmlFree(port);
 433             xmlFree(host);
 434             xmlFree(myurl);
 435         }
 436         else if (!strcmp((const char *) n->name, "zproxy"))
 437         {
 438             xmlChar *port = 0;
 439             xmlChar *host = 0;
 440
 441             port = xmlGetProp(n, (xmlChar *) "port");
 442             host = xmlGetProp(n, (xmlChar *) "host");
 443
 444             if (port)
 445                 r->zproxy_port = atoi((const char *) port);
 446             if (host)
 447                 r->zproxy_host = nmem_strdup(nmem, (const char *) host);
 448
 449             xmlFree(port);
 450             xmlFree(host);
 451         }
 452         else if (!strcmp((const char *) n->name, "settings"))
 453         {
 454             if (r->settings)
 455             {
 456                 yaz_log(YLOG_FATAL, "Can't repeat 'settings'");
 457                 return 0;
 458             }
 459             if (!(r->settings = parse_settings(n)))
 460                 return 0;
 461         }
 462         else if (!strcmp((const char *) n->name, "service"))
 463         {
 464             struct conf_service *s = parse_service(n);
 465             if (!s)
 466                 return 0;
 467             r->service = s;
 468         }
 469         else
 470         {
 471             yaz_log(YLOG_FATAL, "Bad element: %s", n->name);
 472             return 0;
 473         }
 474     }
 475     return r;
 476 }
 477
 478 xsltStylesheet *conf_load_stylesheet(const char *fname)
 479 {
 480     char path[256];
 481     sprintf(path, "%s/%s", confdir, fname);
 482     return xsltParseStylesheetFile((xmlChar *) path);
 483 }
 484
 485 static struct conf_targetprofiles *parse_targetprofiles(xmlNode *node)
 486 {
 487     struct conf_targetprofiles *r = nmem_malloc(nmem, sizeof(*r));
 488     xmlChar *type = xmlGetProp(node, (xmlChar *) "type");
 489     xmlChar *src = xmlGetProp(node, (xmlChar *) "src");
 490
 491     memset(r, 0, sizeof(*r));
 492
 493     if (type)
 494     {
 495         if (!strcmp((const char *) type, "local"))
 496             r->type = Targetprofiles_local;
 497         else
 498         {
 499             yaz_log(YLOG_FATAL, "Unknown targetprofile type");
 500             return 0;
 501         }
 502     }
 503     else
 504     {
 505         yaz_log(YLOG_FATAL, "Must specify type for targetprofile");
 506         return 0;
 507     }
 508
 509     if (src)
 510         r->src = nmem_strdup(nmem, (const char *) src);
 511     else
 512     {
 513         yaz_log(YLOG_FATAL, "Must specify src in targetprofile");
 514         return 0;
 515     }
 516     xmlFree(type);
 517     xmlFree(src);
 518     return r;
 519 }
 520
 521 static struct conf_config *parse_config(xmlNode *root)
 522 {
 523     xmlNode *n;
 524     struct conf_config *r = nmem_malloc(nmem, sizeof(struct conf_config));
 525
 526     r->servers = 0;
 527     r->targetprofiles = 0;
 528
 529     for (n = root->children; n; n = n->next)
 530     {
 531         if (n->type != XML_ELEMENT_NODE)
 532             continue;
 533         if (!strcmp((const char *) n->name, "server"))
 534         {
 535             struct conf_server *tmp = parse_server(n);
 536             if (!tmp)
 537                 return 0;
 538             tmp->next = r->servers;
 539             r->servers = tmp;
 540         }
 541         else if (!strcmp((const char *) n->name, "targetprofiles"))
 542         {
 543             // It would be fun to be able to fix this sometime
 544             if (r->targetprofiles)
 545             {
 546                 yaz_log(YLOG_FATAL, "Can't repeat targetprofiles");
 547                 return 0;
 548             }
 549             if (!(r->targetprofiles = parse_targetprofiles(n)))
 550                 return 0;
 551         }
 552         else
 553         {
 554             yaz_log(YLOG_FATAL, "Bad element: %s", n->name);
 555             return 0;
 556         }
 557     }
 558     return r;
 559 }
 560
 561 int read_config(const char *fname)
 562 {
 563     xmlDoc *doc = xmlParseFile(fname);
 564     const char *p;
 565
 566     if (!nmem)  // Initialize
 567     {
 568         nmem = nmem_create();
 569         xmlSubstituteEntitiesDefault(1);
 570         xmlLoadExtDtdDefaultValue = 1;
 571     }
 572     if (!doc)
 573     {
 574         yaz_log(YLOG_FATAL, "Failed to read %s", fname);
 575         exit(1);
 576     }
 577     if ((p = strrchr(fname, '/')))
 578     {
 579         int len = p - fname;
 580         strncpy(confdir, fname, len);
 581         confdir[len] = '\0';
 582     }
 583     config = parse_config(xmlDocGetRootElement(doc));
 584     xmlFreeDoc(doc);
 585
 586     if (config)
 587         return 1;
 588     else
 589         return 0;
 590 }
 591
 592
 593 /*
 594  * Local variables:
 595  * c-basic-offset: 4
 596  * indent-tabs-mode: nil
 597  * End:
 598  * vim: shiftwidth=4 tabstop=8 expandtab
 599  */