src/settings.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 // This module implements a generic system of settings
  21 // (attribute-value) that can be associated with search targets. The
  22 // system supports both default values, per-target overrides, and
  23 // per-user settings.
  24
  25 #if HAVE_CONFIG_H
  26 #include <config.h>
  27 #endif
  28
  29
  30 #include <string.h>
  31 #include <assert.h>
  32 #include <stdio.h>
  33 #include <sys/types.h>
  34 #include "direntz.h"
  35 #include <stdlib.h>
  36 #include <sys/stat.h>
  37
  38 #include <libxml/parser.h>
  39 #include <libxml/tree.h>
  40
  41 #include <yaz/nmem.h>
  42 #include <yaz/log.h>
  43
  44 #include "pazpar2.h"
  45 #include "database.h"
  46 #include "settings.h"
  47
  48 // Used for initializing setting_dictionary with pazpar2-specific settings
  49 static char *hard_settings[] = {
  50     "pz:piggyback",
  51     "pz:elements",
  52     "pz:requestsyntax",
  53     "pz:cclmap:",
  54     "pz:xslt",
  55     "pz:nativesyntax",
  56     "pz:authentication",
  57     "pz:allow",
  58     "pz:maxrecs",
  59     "pz:id",
  60     "pz:name",
  61     "pz:queryencoding",
  62     "pz:ip",
  63     "pz:zproxy",
  64     "pz:apdulog",
  65     "pz:sru",
  66     "pz:sru_version",
  67     "pz:pqf_prefix",
  68     0
  69 };
  70
  71 struct setting_dictionary
  72 {
  73     char **dict;
  74     int size;
  75     int num;
  76 };
  77
  78 // This establishes the precedence of wildcard expressions
  79 #define SETTING_WILDCARD_NO     0 // No wildcard
  80 #define SETTING_WILDCARD_DB     1 // Database wildcard 'host:port/*'
  81 #define SETTING_WILDCARD_YES    2 // Complete wildcard '*'
  82
  83 // Returns size of settings directory
  84 int settings_num(struct conf_service *service)
  85 {
  86     return service->dictionary->num;
  87 }
  88
  89 int settings_offset(struct conf_service *service, const char *name)
  90 {
  91     int i;
  92
  93     if (!name)
  94         name = "";
  95     for (i = 0; i < service->dictionary->num; i++)
  96         if (!strcmp(name, service->dictionary->dict[i]))
  97             return i;
  98     return -1;
  99 }
 100
 101 // Ignores everything after second colon, if present
 102 // A bit of a hack to support the pz:cclmap: scheme (and more to come?)
 103 int settings_offset_cprefix(struct conf_service *service, const char *name)
 104 {
 105     const char *p;
 106     int maxlen = 100;
 107     int i;
 108
 109     if (!strncmp("pz:", name, 3) && (p = strchr(name + 3, ':')))
 110         maxlen = (p - name) + 1;
 111     for (i = 0; i < service->dictionary->num; i++)
 112         if (!strncmp(name, service->dictionary->dict[i], maxlen))
 113             return i;
 114     return -1;
 115 }
 116
 117 char *settings_name(struct conf_service *service, int offset)
 118 {
 119     return service->dictionary->dict[offset];
 120 }
 121
 122 static int isdir(const char *path)
 123 {
 124     struct stat st;
 125
 126     if (stat(path, &st) < 0)
 127     {
 128         yaz_log(YLOG_FATAL|YLOG_ERRNO, "stat %s", path);
 129         exit(1);
 130     }
 131     return st.st_mode & S_IFDIR;
 132 }
 133
 134 // Read settings from an XML file, calling handler function for each setting
 135 static void read_settings_node(xmlNode *n,
 136                                struct conf_service *service,
 137                                void (*fun)(struct conf_service *service,
 138                                            struct setting *set))
 139 {
 140     xmlChar *namea, *targeta, *valuea, *usera, *precedencea;
 141
 142     namea = xmlGetProp(n, (xmlChar *) "name");
 143     targeta = xmlGetProp(n, (xmlChar *) "target");
 144     valuea = xmlGetProp(n, (xmlChar *) "value");
 145     usera = xmlGetProp(n, (xmlChar *) "user");
 146     precedencea = xmlGetProp(n, (xmlChar *) "precedence");
 147     for (n = n->children; n; n = n->next)
 148     {
 149         if (n->type != XML_ELEMENT_NODE)
 150             continue;
 151         if (!strcmp((const char *) n->name, "set"))
 152         {
 153             char *name, *target, *value, *user, *precedence;
 154
 155             name = (char *) xmlGetProp(n, (xmlChar *) "name");
 156             target = (char *) xmlGetProp(n, (xmlChar *) "target");
 157             value = (char *) xmlGetProp(n, (xmlChar *) "value");
 158             user = (char *) xmlGetProp(n, (xmlChar *) "user");
 159             precedence = (char *) xmlGetProp(n, (xmlChar *) "precedence");
 160
 161             if ((!name && !namea) || (!value && !valuea) || (!target && !targeta))
 162             {
 163                 yaz_log(YLOG_FATAL, "set must specify name, value, and target");
 164                 exit(1);
 165             }
 166             else
 167             {
 168                 struct setting set;
 169                 char nameb[1024];
 170                 char targetb[1024];
 171                 char valueb[1024];
 172
 173                 // Copy everything into a temporary buffer -- we decide
 174                 // later if we are keeping it.
 175                 if (precedence)
 176                     set.precedence = atoi((char *) precedence);
 177                 else if (precedencea)
 178                     set.precedence = atoi((char *) precedencea);
 179                 else
 180                     set.precedence = 0;
 181                 if (target)
 182                     strcpy(targetb, target);
 183                 else
 184                     strcpy(targetb, (const char *) targeta);
 185                 set.target = targetb;
 186                 if (name)
 187                     strcpy(nameb, name);
 188                 else
 189                     strcpy(nameb, (const char *) namea);
 190                 set.name = nameb;
 191                 if (value)
 192                     strcpy(valueb, value);
 193                 else
 194                     strcpy(valueb, (const char *) valuea);
 195                 set.value = valueb;
 196                 set.next = 0;
 197                 (*fun)(service, &set);
 198             }
 199             xmlFree(name);
 200             xmlFree(precedence);
 201             xmlFree(value);
 202             xmlFree(user);
 203             xmlFree(target);
 204         }
 205         else
 206         {
 207             yaz_log(YLOG_FATAL, "Unknown element %s in settings file", (char*) n->name);
 208             exit(1);
 209         }
 210     }
 211     xmlFree(namea);
 212     xmlFree(precedencea);
 213     xmlFree(valuea);
 214     xmlFree(usera);
 215     xmlFree(targeta);
 216 }
 217
 218 static void read_settings_file(const char *path,
 219                                struct conf_service *service,
 220                                void (*fun)(struct conf_service *service,
 221                                            struct setting *set))
 222 {
 223     xmlDoc *doc = xmlParseFile(path);
 224     xmlNode *n;
 225
 226     if (!doc)
 227     {
 228         yaz_log(YLOG_FATAL, "Failed to parse %s", path);
 229         exit(1);
 230     }
 231     n = xmlDocGetRootElement(doc);
 232     read_settings_node(n, service, fun);
 233
 234     xmlFreeDoc(doc);
 235 }
 236
 237
 238 // Recursively read files or directories, invoking a
 239 // callback for each one
 240 static void read_settings(const char *path,
 241                           struct conf_service *service,
 242                           void (*fun)(struct conf_service *service,
 243                                       struct setting *set))
 244 {
 245     DIR *d;
 246     struct dirent *de;
 247     char *dot;
 248
 249     if (isdir(path))
 250     {
 251         if (!(d = opendir(path)))
 252         {
 253             yaz_log(YLOG_FATAL|YLOG_ERRNO, "%s", path);
 254             exit(1);
 255         }
 256         while ((de = readdir(d)))
 257         {
 258             char tmp[1024];
 259             if (*de->d_name == '.' || !strcmp(de->d_name, "CVS"))
 260                 continue;
 261             sprintf(tmp, "%s/%s", path, de->d_name);
 262             read_settings(tmp, service, fun);
 263         }
 264         closedir(d);
 265     }
 266     else if ((dot = strrchr(path, '.')) && !strcmp(dot + 1, "xml"))
 267         read_settings_file(path, service, fun);
 268 }
 269
 270 // Determines if a ZURL is a wildcard, and what kind
 271 static int zurl_wildcard(const char *zurl)
 272 {
 273     if (!zurl)
 274         return SETTING_WILDCARD_NO;
 275     if (*zurl == '*')
 276         return SETTING_WILDCARD_YES;
 277     else if (*(zurl + strlen(zurl) - 1) == '*')
 278         return SETTING_WILDCARD_DB;
 279     else
 280         return SETTING_WILDCARD_NO;
 281 }
 282
 283 // Callback. Adds a new entry to the dictionary if necessary
 284 // This is used in pass 1 to determine layout of dictionary
 285 // and to load any databases mentioned
 286 static void prepare_dictionary(struct conf_service *service,
 287                                struct setting *set)
 288 {
 289     struct setting_dictionary *dictionary = service->dictionary;
 290
 291     int i;
 292     char *p;
 293
 294     // If target address is not wildcard, add the database
 295     if (*set->target && !zurl_wildcard(set->target))
 296         find_database(set->target, 0, service);
 297
 298     // Determine if we already have a dictionary entry
 299     if (!strncmp(set->name, "pz:", 3) && (p = strchr(set->name + 3, ':')))
 300         *(p + 1) = '\0';
 301     for (i = 0; i < dictionary->num; i++)
 302         if (!strcmp(dictionary->dict[i], set->name))
 303             return;
 304
 305     if (!strncmp(set->name, "pz:", 3)) // Probably a typo in config file
 306         {
 307             yaz_log(YLOG_FATAL, "Unknown pz: setting '%s'", set->name);
 308             exit(1);
 309         }
 310
 311     // Create a new dictionary entry
 312     // Grow dictionary if necessary
 313     if (!dictionary->size)
 314         dictionary->dict =
 315             nmem_malloc(service->nmem, (dictionary->size = 50) * sizeof(char*));
 316     else if (dictionary->num + 1 > dictionary->size)
 317     {
 318         char **tmp =
 319             nmem_malloc(service->nmem, dictionary->size * 2 * sizeof(char*));
 320         memcpy(tmp, dictionary->dict, dictionary->size * sizeof(char*));
 321         dictionary->dict = tmp;
 322         dictionary->size *= 2;
 323     }
 324     dictionary->dict[dictionary->num++] = nmem_strdup(service->nmem, set->name);
 325 }
 326
 327
 328 struct update_database_context {
 329     struct setting *set;
 330     struct conf_service *service;
 331 };
 332
 333 // This is called from grep_databases -- adds/overrides setting for a target
 334 // This is also where the rules for precedence of settings are implemented
 335 static void update_database(void *context, struct database *db)
 336 {
 337     struct setting *set = ((struct update_database_context *)
 338                            context)->set;
 339     struct conf_service *service = ((struct update_database_context *)
 340                                     context)->service;
 341     struct setting *s, **sp;
 342     int offset;
 343
 344     // Is this the right database?
 345     if (!match_zurl(db->url, set->target))
 346         return;
 347
 348     if ((offset = settings_offset_cprefix(service, set->name)) < 0)
 349         return ;
 350
 351     // First we determine if this setting is overriding  any existing settings
 352     // with the same name.
 353     for (s = db->settings[offset], sp = &db->settings[offset]; s;
 354             sp = &s->next, s = s->next)
 355         if (!strcmp(s->name, set->name))
 356         {
 357             if (s->precedence < set->precedence)
 358                 // We discard the value (nmem keeps track of the space)
 359                 *sp = (*sp)->next; // unlink value from existing setting
 360             else if (s->precedence > set->precedence)
 361                 // Db contains a higher-priority setting. Abort search
 362                 break;
 363             if (zurl_wildcard(s->target) > zurl_wildcard(set->target))
 364                 // target-specific value trumps wildcard. Delete.
 365                 *sp = (*sp)->next; // unlink.....
 366             else if (!zurl_wildcard(s->target))
 367                 // Db already contains higher-priority setting. Abort search
 368                 break;
 369         }
 370     if (!s) // s will be null when there are no higher-priority settings -- we add one
 371     {
 372         struct setting *new = nmem_malloc(service->nmem, sizeof(*new));
 373
 374         memset(new, 0, sizeof(*new));
 375         new->precedence = set->precedence;
 376         new->target = nmem_strdup(service->nmem, set->target);
 377         new->name = nmem_strdup(service->nmem, set->name);
 378         new->value = nmem_strdup(service->nmem, set->value);
 379         new->next = db->settings[offset];
 380         db->settings[offset] = new;
 381     }
 382 }
 383
 384 // Callback -- updates database records with dictionary entries as appropriate
 385 // This is used in pass 2 to assign name/value pairs to databases
 386 static void update_databases(struct conf_service *service,
 387                              struct setting *set)
 388 {
 389     struct update_database_context context;
 390     context.set = set;
 391     context.service = service;
 392     predef_grep_databases(&context, service, 0, update_database);
 393 }
 394
 395 // This simply copies the 'hard' (application-specific) settings
 396 // to the settings dictionary.
 397 static void initialize_hard_settings(struct conf_service *service)
 398 {
 399     struct setting_dictionary *dict = service->dictionary;
 400     dict->dict = nmem_malloc(service->nmem, sizeof(hard_settings) - sizeof(char*));
 401     dict->size = (sizeof(hard_settings) - sizeof(char*)) / sizeof(char*);
 402     memcpy(dict->dict, hard_settings, dict->size * sizeof(char*));
 403     dict->num = dict->size;
 404 }
 405
 406 // Read any settings names introduced in service definition (config) and add to dictionary
 407 // This is done now to avoid errors if user settings are declared in session overrides
 408 static void initialize_soft_settings(struct conf_service *service)
 409 {
 410     int i;
 411
 412     for (i = 0; i < service->num_metadata; i++)
 413     {
 414         struct setting set;
 415         struct conf_metadata *md = &service->metadata[i];
 416
 417         if (md->setting == Metadata_setting_no)
 418             continue;
 419
 420         set.precedence = 0;
 421         set.target = "";
 422         set.name = md->name;
 423         set.value = "";
 424         set.next = 0;
 425         prepare_dictionary(service, &set);
 426     }
 427 }
 428
 429 static void prepare_target_dictionary(struct conf_service *service,
 430                                       struct setting *set)
 431 {
 432     struct setting_dictionary *dictionary = service->dictionary;
 433
 434     int i;
 435     char *p;
 436
 437     // If target address is not wildcard, add the database
 438     if (*set->target && !zurl_wildcard(set->target))
 439         find_database(set->target, 0, service);
 440
 441     // Determine if we already have a dictionary entry
 442     if (!strncmp(set->name, "pz:", 3) && (p = strchr(set->name + 3, ':')))
 443         *(p + 1) = '\0';
 444     for (i = 0; i < dictionary->num; i++)
 445         if (!strcmp(dictionary->dict[i], set->name))
 446             return;
 447     yaz_log(YLOG_WARN, "Setting '%s' not configured as metadata", set->name);
 448 }
 449
 450 // If we ever decide we need to be able to specify multiple settings directories,
 451 // the two calls to read_settings must be split -- so the dictionary is prepared
 452 // for the contents of every directory before the databases are updated.
 453 void settings_read(struct conf_service *service, const char *path)
 454 {
 455     read_settings(path, service, prepare_target_dictionary);
 456     read_settings(path, service, update_databases);
 457 }
 458
 459 void init_settings(struct conf_service *service)
 460 {
 461     struct setting_dictionary *new;
 462
 463     assert(service->nmem);
 464
 465     new = nmem_malloc(service->nmem, sizeof(*new));
 466     memset(new, 0, sizeof(*new));
 467     service->dictionary = new;
 468     initialize_hard_settings(service);
 469     initialize_soft_settings(service);
 470 }
 471
 472 /*
 473  * Local variables:
 474  * c-basic-offset: 4
 475  * c-file-style: "Stroustrup"
 476  * indent-tabs-mode: nil
 477  * End:
 478  * vim: shiftwidth=4 tabstop=8 expandtab
 479  */
 480