src/config.c

   1 /* $Id: config.c,v 1.26 2007-04-19 19:42:30 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.26 2007-04-19 19:42:30 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
  92         = nmem_malloc(nmem, sizeof(struct conf_service));
  93     service->num_metadata = num_metadata;
  94     service->metadata = 0;
  95     if (service->num_metadata)
  96       service->metadata
  97           = nmem_malloc(nmem,
  98                         sizeof(struct conf_metadata) * service->num_metadata);
  99     service->num_sortkeys = num_sortkeys;
 100     service->sortkeys = 0;
 101     if (service->num_sortkeys)
 102         service->sortkeys
 103             = nmem_malloc(nmem,
 104                           sizeof(struct conf_sortkey) * service->num_sortkeys);
 105     return service;
 106 }
 107
 108 struct conf_metadata* conf_service_add_metadata(NMEM nmem,
 109                                                 struct conf_service *service,
 110                                                 int position,
 111                                                 const char *name,
 112                                                 enum conf_metadata_type type,
 113                                                 enum conf_metadata_merge merge,
 114                                                 int brief,
 115                                                 int termlist,
 116                                                 int rank,
 117                                                 int sortkey_offset)
 118 {
 119     struct conf_metadata * md = 0;
 120
 121     if (!service || !service->metadata || !service->num_metadata
 122         || position < 0  || !(position < service->num_metadata))
 123         return 0;
 124
 125     //md = &((service->metadata)[position]);
 126     md = service->metadata + position;
 127     md = conf_metadata_assign(nmem, md, name, type, merge,
 128                              brief, termlist, rank, sortkey_offset);
 129     return md;
 130 }
 131
 132
 133 struct conf_sortkey * conf_service_add_sortkey(NMEM nmem,
 134                                                struct conf_service *service,
 135                                                int position,
 136                                                const char *name,
 137                                                enum conf_sortkey_type type)
 138 {
 139     struct conf_sortkey * sk = 0;
 140
 141     if (!service || !service->sortkeys || !service->num_sortkeys
 142         || position < 0  || !(position < service->num_sortkeys))
 143         return 0;
 144
 145     //sk = &((service->sortkeys)[position]);
 146     sk = service->sortkeys + position;
 147     sk = conf_sortkey_assign(nmem, sk, name, type);
 148
 149     return sk;
 150 }
 151
 152
 153
 154
 155
 156 /* Code to parse configuration file */
 157 /* ==================================================== */
 158
 159 static struct conf_service *parse_service(xmlNode *node)
 160 {
 161     xmlNode *n;
 162     struct conf_service *r = nmem_malloc(nmem, sizeof(struct conf_service));
 163     int md_node = 0;
 164     int sk_node = 0;
 165
 166     r->num_sortkeys = r->num_metadata = 0;
 167     // Allocate array of conf metadata and sortkey tructs, if necessary
 168     for (n = node->children; n; n = n->next)
 169         if (n->type == XML_ELEMENT_NODE && !strcmp((const char *)
 170                                                    n->name, "metadata"))
 171         {
 172             xmlChar *sortkey = xmlGetProp(n, (xmlChar *) "sortkey");
 173             r->num_metadata++;
 174             if (sortkey && strcmp((const char *) sortkey, "no"))
 175                 r->num_sortkeys++;
 176             xmlFree(sortkey);
 177         }
 178     if (r->num_metadata)
 179         r->metadata = nmem_malloc(nmem, sizeof(struct conf_metadata) * r->num_metadata);
 180     else
 181         r->metadata = 0;
 182     if (r->num_sortkeys)
 183         r->sortkeys = nmem_malloc(nmem, sizeof(struct conf_sortkey) * r->num_sortkeys);
 184     else
 185         r->sortkeys = 0;
 186
 187     for (n = node->children; n; n = n->next)
 188     {
 189         if (n->type != XML_ELEMENT_NODE)
 190             continue;
 191         if (!strcmp((const char *) n->name, (const char *) "metadata"))
 192         {
 193             struct conf_metadata *md = &r->metadata[md_node];
 194             xmlChar *name = xmlGetProp(n, (xmlChar *) "name");
 195             xmlChar *brief = xmlGetProp(n, (xmlChar *) "brief");
 196             xmlChar *sortkey = xmlGetProp(n, (xmlChar *) "sortkey");
 197             xmlChar *merge = xmlGetProp(n, (xmlChar *) "merge");
 198             xmlChar *type = xmlGetProp(n, (xmlChar *) "type");
 199             xmlChar *termlist = xmlGetProp(n, (xmlChar *) "termlist");
 200             xmlChar *rank = xmlGetProp(n, (xmlChar *) "rank");
 201
 202             if (!name)
 203             {
 204                 yaz_log(YLOG_FATAL, "Must specify name in metadata element");
 205                 return 0;
 206             }
 207             md->name = nmem_strdup(nmem, (const char *) name);
 208             if (brief)
 209             {
 210                 if (!strcmp((const char *) brief, "yes"))
 211                     md->brief = 1;
 212                 else if (strcmp((const char *) brief, "no"))
 213                 {
 214                     yaz_log(YLOG_FATAL, "metadata/brief must be yes or no");
 215                     return 0;
 216                 }
 217             }
 218             else
 219                 md->brief = 0;
 220
 221             if (termlist)
 222             {
 223                 if (!strcmp((const char *) termlist, "yes"))
 224                     md->termlist = 1;
 225                 else if (strcmp((const char *) termlist, "no"))
 226                 {
 227                     yaz_log(YLOG_FATAL, "metadata/termlist must be yes or no");
 228                     return 0;
 229                 }
 230             }
 231             else
 232                 md->termlist = 0;
 233
 234             if (rank)
 235                 md->rank = atoi((const char *) rank);
 236             else
 237                 md->rank = 0;
 238
 239             if (type)
 240             {
 241                 if (!strcmp((const char *) type, "generic"))
 242                     md->type = Metadata_type_generic;
 243                 else if (!strcmp((const char *) type, "year"))
 244                     md->type = Metadata_type_year;
 245                 else
 246                 {
 247                     yaz_log(YLOG_FATAL, "Unknown value for metadata/type: %s", type);
 248                     return 0;
 249                 }
 250             }
 251             else
 252                 md->type = Metadata_type_generic;
 253
 254             if (merge)
 255             {
 256                 if (!strcmp((const char *) merge, "no"))
 257                     md->merge = Metadata_merge_no;
 258                 else if (!strcmp((const char *) merge, "unique"))
 259                     md->merge = Metadata_merge_unique;
 260                 else if (!strcmp((const char *) merge, "longest"))
 261                     md->merge = Metadata_merge_longest;
 262                 else if (!strcmp((const char *) merge, "range"))
 263                     md->merge = Metadata_merge_range;
 264                 else if (!strcmp((const char *) merge, "all"))
 265                     md->merge = Metadata_merge_all;
 266                 else
 267                 {
 268                     yaz_log(YLOG_FATAL, "Unknown value for metadata/merge: %s", merge);
 269                     return 0;
 270                 }
 271             }
 272             else
 273                 md->merge = Metadata_merge_no;
 274
 275             if (sortkey && strcmp((const char *) sortkey, "no"))
 276             {
 277                 struct conf_sortkey *sk = &r->sortkeys[sk_node];
 278                 if (md->merge == Metadata_merge_no)
 279                 {
 280                     yaz_log(YLOG_FATAL, "Can't specify sortkey on a non-merged field");
 281                     return 0;
 282                 }
 283                 if (!strcmp((const char *) sortkey, "numeric"))
 284                     sk->type = Metadata_sortkey_numeric;
 285                 else if (!strcmp((const char *) sortkey, "skiparticle"))
 286                     sk->type = Metadata_sortkey_skiparticle;
 287                 else
 288                 {
 289                     yaz_log(YLOG_FATAL, "Unknown sortkey in metadata element: %s", sortkey);
 290                     return 0;
 291                 }
 292                 sk->name = md->name;
 293                 md->sortkey_offset = sk_node;
 294                 sk_node++;
 295             }
 296             else
 297                 md->sortkey_offset = -1;
 298
 299             xmlFree(name);
 300             xmlFree(brief);
 301             xmlFree(sortkey);
 302             xmlFree(merge);
 303             xmlFree(type);
 304             xmlFree(termlist);
 305             xmlFree(rank);
 306             md_node++;
 307         }
 308         else
 309         {
 310             yaz_log(YLOG_FATAL, "Bad element: %s", n->name);
 311             return 0;
 312         }
 313     }
 314     return r;
 315 }
 316
 317 static char *parse_settings(xmlNode *node)
 318 {
 319     xmlChar *src = xmlGetProp(node, (xmlChar *) "src");
 320     char *r;
 321
 322     if (src)
 323         r = nmem_strdup(nmem, (const char *) src);
 324     else
 325     {
 326         yaz_log(YLOG_FATAL, "Must specify src in targetprofile");
 327         return 0;
 328     }
 329     xmlFree(src);
 330     return r;
 331 }
 332
 333 static struct conf_server *parse_server(xmlNode *node)
 334 {
 335     xmlNode *n;
 336     struct conf_server *r = nmem_malloc(nmem, sizeof(struct conf_server));
 337
 338     r->host = 0;
 339     r->port = 0;
 340     r->proxy_host = 0;
 341     r->proxy_port = 0;
 342     r->myurl = 0;
 343     r->zproxy_host = 0;
 344     r->zproxy_port = 0;
 345     r->service = 0;
 346     r->next = 0;
 347     r->settings = 0;
 348
 349     for (n = node->children; n; n = n->next)
 350     {
 351         if (n->type != XML_ELEMENT_NODE)
 352             continue;
 353         if (!strcmp((const char *) n->name, "listen"))
 354         {
 355             xmlChar *port = xmlGetProp(n, (xmlChar *) "port");
 356             xmlChar *host = xmlGetProp(n, (xmlChar *) "host");
 357             if (port)
 358                 r->port = atoi((const char *) port);
 359             if (host)
 360                 r->host = nmem_strdup(nmem, (const char *) host);
 361             xmlFree(port);
 362             xmlFree(host);
 363         }
 364         else if (!strcmp((const char *) n->name, "proxy"))
 365         {
 366             xmlChar *port = xmlGetProp(n, (xmlChar *) "port");
 367             xmlChar *host = xmlGetProp(n, (xmlChar *) "host");
 368             xmlChar *myurl = xmlGetProp(n, (xmlChar *) "myurl");
 369             if (port)
 370                 r->proxy_port = atoi((const char *) port);
 371             if (host)
 372                 r->proxy_host = nmem_strdup(nmem, (const char *) host);
 373             if (myurl)
 374                 r->myurl = nmem_strdup(nmem, (const char *) myurl);
 375 #ifdef GAGA
 376             else
 377             {
 378                 yaz_log(YLOG_FATAL, "Must specify @myurl for proxy");
 379                 return 0;
 380             }
 381 #endif
 382             xmlFree(port);
 383             xmlFree(host);
 384             xmlFree(myurl);
 385         }
 386         else if (!strcmp((const char *) n->name, "zproxy"))
 387         {
 388             xmlChar *port = 0;
 389             xmlChar *host = 0;
 390
 391             port = xmlGetProp(n, (xmlChar *) "port");
 392             host = xmlGetProp(n, (xmlChar *) "host");
 393
 394             if (port)
 395                 r->zproxy_port = atoi((const char *) port);
 396             if (host)
 397                 r->zproxy_host = nmem_strdup(nmem, (const char *) host);
 398
 399             xmlFree(port);
 400             xmlFree(host);
 401         }
 402         else if (!strcmp((const char *) n->name, "settings"))
 403         {
 404             if (r->settings)
 405             {
 406                 yaz_log(YLOG_FATAL, "Can't repeat 'settings'");
 407                 return 0;
 408             }
 409             if (!(r->settings = parse_settings(n)))
 410                 return 0;
 411         }
 412         else if (!strcmp((const char *) n->name, "service"))
 413         {
 414             struct conf_service *s = parse_service(n);
 415             if (!s)
 416                 return 0;
 417             r->service = s;
 418         }
 419         else
 420         {
 421             yaz_log(YLOG_FATAL, "Bad element: %s", n->name);
 422             return 0;
 423         }
 424     }
 425     return r;
 426 }
 427
 428 xsltStylesheet *conf_load_stylesheet(const char *fname)
 429 {
 430     char path[256];
 431     sprintf(path, "%s/%s", confdir, fname);
 432     return xsltParseStylesheetFile((xmlChar *) path);
 433 }
 434
 435 static struct conf_targetprofiles *parse_targetprofiles(xmlNode *node)
 436 {
 437     struct conf_targetprofiles *r = nmem_malloc(nmem, sizeof(*r));
 438     xmlChar *type = xmlGetProp(node, (xmlChar *) "type");
 439     xmlChar *src = xmlGetProp(node, (xmlChar *) "src");
 440
 441     memset(r, 0, sizeof(*r));
 442
 443     if (type)
 444     {
 445         if (!strcmp((const char *) type, "local"))
 446             r->type = Targetprofiles_local;
 447         else
 448         {
 449             yaz_log(YLOG_FATAL, "Unknown targetprofile type");
 450             return 0;
 451         }
 452     }
 453     else
 454     {
 455         yaz_log(YLOG_FATAL, "Must specify type for targetprofile");
 456         return 0;
 457     }
 458
 459     if (src)
 460         r->src = nmem_strdup(nmem, (const char *) src);
 461     else
 462     {
 463         yaz_log(YLOG_FATAL, "Must specify src in targetprofile");
 464         return 0;
 465     }
 466     xmlFree(type);
 467     xmlFree(src);
 468     return r;
 469 }
 470
 471 static struct conf_config *parse_config(xmlNode *root)
 472 {
 473     xmlNode *n;
 474     struct conf_config *r = nmem_malloc(nmem, sizeof(struct conf_config));
 475
 476     r->servers = 0;
 477     r->targetprofiles = 0;
 478
 479     for (n = root->children; n; n = n->next)
 480     {
 481         if (n->type != XML_ELEMENT_NODE)
 482             continue;
 483         if (!strcmp((const char *) n->name, "server"))
 484         {
 485             struct conf_server *tmp = parse_server(n);
 486             if (!tmp)
 487                 return 0;
 488             tmp->next = r->servers;
 489             r->servers = tmp;
 490         }
 491         else if (!strcmp((const char *) n->name, "targetprofiles"))
 492         {
 493             // It would be fun to be able to fix this sometime
 494             if (r->targetprofiles)
 495             {
 496                 yaz_log(YLOG_FATAL, "Can't repeat targetprofiles");
 497                 return 0;
 498             }
 499             if (!(r->targetprofiles = parse_targetprofiles(n)))
 500                 return 0;
 501         }
 502         else
 503         {
 504             yaz_log(YLOG_FATAL, "Bad element: %s", n->name);
 505             return 0;
 506         }
 507     }
 508     return r;
 509 }
 510
 511 int read_config(const char *fname)
 512 {
 513     xmlDoc *doc = xmlParseFile(fname);
 514     const char *p;
 515
 516     if (!nmem)  // Initialize
 517     {
 518         nmem = nmem_create();
 519         xmlSubstituteEntitiesDefault(1);
 520         xmlLoadExtDtdDefaultValue = 1;
 521     }
 522     if (!doc)
 523     {
 524         yaz_log(YLOG_FATAL, "Failed to read %s", fname);
 525         exit(1);
 526     }
 527     if ((p = strrchr(fname, '/')))
 528     {
 529         int len = p - fname;
 530         strncpy(confdir, fname, len);
 531         confdir[len] = '\0';
 532     }
 533     config = parse_config(xmlDocGetRootElement(doc));
 534     xmlFreeDoc(doc);
 535
 536     if (config)
 537         return 1;
 538     else
 539         return 0;
 540 }
 541
 542
 543 /*
 544  * Local variables:
 545  * c-basic-offset: 4
 546  * indent-tabs-mode: nil
 547  * End:
 548  * vim: shiftwidth=4 tabstop=8 expandtab
 549  */