src/settings.c

   1 /* $Id: settings.c,v 1.14 2007-04-11 19:55:57 quinn 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
  23 // This module implements a generic system of settings (attribute-value) that can
  24 // be associated with search targets. The system supports both default values,
  25 // per-target overrides, and per-user settings.
  26
  27 #include <string.h>
  28 #include <stdio.h>
  29 #include <sys/types.h>
  30 #include <dirent.h>
  31 #include <stdlib.h>
  32 #include <sys/stat.h>
  33
  34 #include <libxml/parser.h>
  35 #include <libxml/tree.h>
  36
  37 #include <yaz/nmem.h>
  38 #include <yaz/log.h>
  39
  40 #include "pazpar2.h"
  41 #include "database.h"
  42 #include "settings.h"
  43
  44 static NMEM nmem = 0;
  45
  46 // Used for initializing setting_dictionary with pazpar2-specific settings
  47 static char *hard_settings[] = {
  48     "pz:piggyback",
  49     "pz:elements",
  50     "pz:requestsyntax",
  51     "pz:cclmap:",
  52     "pz:encoding",
  53     "pz:xslt",
  54     "pz:nativesyntax",
  55     "pz:authentication",
  56     "pz:allow",
  57     "pz:maxrecs",
  58     "pz:id",
  59     "pz:name",
  60     0
  61 };
  62
  63 struct setting_dictionary
  64 {
  65     char **dict;
  66     int size;
  67     int num;
  68 };
  69
  70 static struct setting_dictionary *dictionary = 0;
  71
  72 // Returns size of settings directory
  73 int settings_num(void)
  74 {
  75     return dictionary->num;
  76 }
  77
  78 int settings_offset(const char *name)
  79 {
  80     int i;
  81
  82     if (!name)
  83         name = "";
  84     for (i = 0; i < dictionary->num; i++)
  85         if (!strcmp(name, dictionary->dict[i]))
  86             return i;
  87     return -1;
  88 }
  89
  90 // Ignores everything after second colon, if present
  91 // A bit of a hack to support the pz:cclmap: scheme (and more to come?)
  92 static int settings_offset_cprefix(const char *name)
  93 {
  94     const char *p;
  95     int maxlen = 100;
  96     int i;
  97
  98     if (!strncmp("pz:", name, 3) && (p = strchr(name + 3, ':')))
  99         maxlen = (p - name) + 1;
 100     for (i = 0; i < dictionary->num; i++)
 101         if (!strncmp(name, dictionary->dict[i], maxlen))
 102             return i;
 103     return -1;
 104 }
 105
 106 char *settings_name(int offset)
 107 {
 108     return dictionary->dict[offset];
 109 }
 110
 111 static int isdir(const char *path)
 112 {
 113     struct stat st;
 114
 115     if (stat(path, &st) < 0)
 116     {
 117         yaz_log(YLOG_FATAL|YLOG_ERRNO, "%s", path);
 118         exit(1);
 119     }
 120     return st.st_mode & S_IFDIR;
 121 }
 122
 123 // Read settings from an XML file, calling handler function for each setting
 124 static void read_settings_file(const char *path,
 125         void (*fun)(struct setting *set))
 126 {
 127     xmlDoc *doc = xmlParseFile(path);
 128     xmlNode *n;
 129     xmlChar *namea, *targeta, *valuea, *usera, *precedencea;
 130
 131     if (!doc)
 132     {
 133         yaz_log(YLOG_FATAL, "Failed to parse %s", path);
 134         exit(1);
 135     }
 136     n = xmlDocGetRootElement(doc);
 137     namea = xmlGetProp(n, (xmlChar *) "name");
 138     targeta = xmlGetProp(n, (xmlChar *) "target");
 139     valuea = xmlGetProp(n, (xmlChar *) "value");
 140     usera = xmlGetProp(n, (xmlChar *) "user");
 141     precedencea = xmlGetProp(n, (xmlChar *) "precedence");
 142     for (n = n->children; n; n = n->next)
 143     {
 144         if (n->type != XML_ELEMENT_NODE)
 145             continue;
 146         if (!strcmp((const char *) n->name, "set"))
 147         {
 148             char *name, *target, *value, *user, *precedence;
 149
 150             name = (char *) xmlGetProp(n, (xmlChar *) "name");
 151             target = (char *) xmlGetProp(n, (xmlChar *) "target");
 152             value = (char *) xmlGetProp(n, (xmlChar *) "value");
 153             user = (char *) xmlGetProp(n, (xmlChar *) "user");
 154             precedence = (char *) xmlGetProp(n, (xmlChar *) "precedence");
 155
 156             if ((!name && !namea) || (!value && !valuea) || (!target && !targeta))
 157             {
 158                 yaz_log(YLOG_FATAL, "set must specify name, value, and target");
 159                 exit(1);
 160             }
 161             else
 162             {
 163                 struct setting set;
 164                 char nameb[1024];
 165                 char targetb[1024];
 166                 char valueb[1024];
 167
 168                 // Copy everything into a temporary buffer -- we decide
 169                 // later if we are keeping it.
 170                 if (precedence)
 171                     set.precedence = atoi((char *) precedence);
 172                 else if (precedencea)
 173                     set.precedence = atoi((char *) precedencea);
 174                 else
 175                     set.precedence = 0;
 176                 if (target)
 177                     strcpy(targetb, target);
 178                 else
 179                     strcpy(targetb, (const char *) targeta);
 180                 set.target = targetb;
 181                 if (name)
 182                     strcpy(nameb, name);
 183                 else
 184                     strcpy(nameb, (const char *) namea);
 185                 set.name = nameb;
 186                 if (value)
 187                     strcpy(valueb, value);
 188                 else
 189                     strcpy(valueb, (const char *) valuea);
 190                 set.value = valueb;
 191                 set.next = 0;
 192                 (*fun)(&set);
 193             }
 194             xmlFree(name);
 195             xmlFree(precedence);
 196             xmlFree(value);
 197             xmlFree(user);
 198             xmlFree(target);
 199         }
 200         else
 201         {
 202             yaz_log(YLOG_FATAL, "Unknown element %s in settings file", (char*) n->name);
 203             exit(1);
 204         }
 205     }
 206     xmlFree(namea);
 207     xmlFree(precedencea);
 208     xmlFree(valuea);
 209     xmlFree(usera);
 210     xmlFree(targeta);
 211
 212     xmlFreeDoc(doc);
 213 }
 214
 215 // Recursively read files in a directory structure, calling
 216 // callback for each one
 217 static void read_settings(const char *path,
 218                 void (*fun)(struct setting *set))
 219 {
 220     DIR *d;
 221     struct dirent *de;
 222
 223     if (!(d = opendir(path)))
 224     {
 225         yaz_log(YLOG_FATAL|YLOG_ERRNO, "%s", path);
 226         exit(1);
 227     }
 228     while ((de = readdir(d)))
 229     {
 230         char tmp[1024];
 231         if (*de->d_name == '.' || !strcmp(de->d_name, "CVS"))
 232             continue;
 233         sprintf(tmp, "%s/%s", path, de->d_name);
 234         if (isdir(tmp))
 235             read_settings(tmp, fun);
 236         else
 237         {
 238             char *dot;
 239             if ((dot = rindex(de->d_name, '.')) && !strcmp(dot + 1, "xml"))
 240                 read_settings_file(tmp, fun);
 241         }
 242     }
 243     closedir(d);
 244 }
 245
 246 // Callback. Adds a new entry to the dictionary if necessary
 247 // This is used in pass 1 to determine layout of dictionary
 248 // and to load any databases mentioned
 249 static void prepare_dictionary(struct setting *set)
 250 {
 251     int i;
 252     char *p;
 253
 254     // If target address is not wildcard, add the database
 255     if (*set->target && set->target[strlen(set->target) - 1] != '*')
 256         find_database(set->target, 0);
 257
 258     // Determine if we already have a dictionary entry
 259     if (!strncmp(set->name, "pz:", 3) && (p = strchr(set->name + 3, ':')))
 260         *(p + 1) = '\0';
 261     for (i = 0; i < dictionary->num; i++)
 262         if (!strcmp(dictionary->dict[i], set->name))
 263             return;
 264
 265     if (!strncmp(set->name, "pz:", 3)) // Probably a typo in config fle
 266     {
 267         yaz_log(YLOG_FATAL, "Unknown pz: setting '%s'", set->name);
 268         exit(1);
 269     }
 270     // Create a new dictionary entry
 271     // Grow dictionary if necessary
 272     if (!dictionary->size)
 273         dictionary->dict = nmem_malloc(nmem, (dictionary->size = 50) * sizeof(char*));
 274     else if (dictionary->num + 1 > dictionary->size)
 275     {
 276         char **tmp = nmem_malloc(nmem, dictionary->size * 2 * sizeof(char*));
 277         memcpy(tmp, dictionary->dict, dictionary->size * sizeof(char*));
 278         dictionary->dict = tmp;
 279         dictionary->size *= 2;
 280     }
 281     dictionary->dict[dictionary->num++] = nmem_strdup(nmem, set->name);
 282 }
 283
 284 // This is called from grep_databases -- adds/overrides setting for a target
 285 // This is also where the rules for precedence of settings are implemented
 286 static void update_database(void *context, struct database *db)
 287 {
 288     struct setting *set = (struct setting *) context;
 289     struct setting *s, **sp;
 290     int offset;
 291
 292     // Is this the right database?
 293     if (!match_zurl(db->url, set->target))
 294         return;
 295
 296     // Initialize settings array if it doesn't exist.
 297     // If so, also set the 'id' automatic setting
 298     if (!db->settings)
 299     {
 300         struct setting *id = nmem_malloc(nmem, sizeof(struct setting));
 301
 302         db->settings = nmem_malloc(nmem, sizeof(struct settings*) * dictionary->num);
 303         memset(db->settings, 0, sizeof(struct settings*) * dictionary->num);
 304         id->precedence = 0;
 305         id->name = "pz:id";
 306         id->target = id->value = db->url;
 307         id->next = 0;
 308         db->settings[PZ_ID] = id;
 309     }
 310     if ((offset = settings_offset_cprefix(set->name)) < 0)
 311         abort(); // Should never get here
 312
 313     // First we determine if this setting is overriding  any existing settings
 314     // with the same name.
 315     for (s = db->settings[offset], sp = &db->settings[offset]; s;
 316             sp = &s->next, s = s->next)
 317         if (!strcmp(s->name, set->name))
 318         {
 319             if (s->precedence < set->precedence)
 320                 // We discard the value (nmem keeps track of the space)
 321                 *sp = (*sp)->next;
 322             else if (s->precedence > set->precedence)
 323                 // Db contains a higher-priority setting. Abort
 324                 break;
 325             if (*s->target == '*' && *set->target != '*')
 326                 // target-specific value trumps wildcard. Delete.
 327                 *sp = (*sp)->next;
 328             else if (*s->target != '*' && *set->target == '*')
 329                 // Db already contains higher-priority setting. Abort
 330                 break;
 331         }
 332     if (!s) // s will be null when there are no higher-priority settings -- we add one
 333     {
 334         struct setting *new = nmem_malloc(nmem, sizeof(*new));
 335
 336         memset(new, 0, sizeof(*new));
 337         new->precedence = set->precedence;
 338         new->target = nmem_strdup(nmem, set->target);
 339         new->name = nmem_strdup(nmem, set->name);
 340         new->value = nmem_strdup(nmem, set->value);
 341         new->next = db->settings[offset];
 342         db->settings[offset] = new;
 343     }
 344 }
 345
 346 // Callback -- updates database records with dictionary entries as appropriate
 347 // This is used in pass 2 to assign name/value pairs to databases
 348 static void update_databases(struct setting *set)
 349 {
 350     grep_databases(set, 0, update_database);
 351 }
 352
 353 // This simply copies the 'hard' (application-specific) settings
 354 // to the settings dictionary.
 355 static void initialize_hard_settings(struct setting_dictionary *dict)
 356 {
 357     dict->dict = nmem_malloc(nmem, sizeof(hard_settings) - sizeof(char*));
 358     dict->size = (sizeof(hard_settings) - sizeof(char*)) / sizeof(char*);
 359     memcpy(dict->dict, hard_settings, dict->size * sizeof(char*));
 360     dict->num = dict->size;
 361 }
 362
 363 // If we ever decide we need to be able to specify multiple settings directories,
 364 // the two calls to read_settings must be split -- so the dictionary is prepared
 365 // for the contents of every directory before the databases are updated.
 366 void settings_read(const char *path)
 367 {
 368     struct setting_dictionary *new;
 369     if (!nmem)
 370         nmem = nmem_create();
 371     else
 372         nmem_reset(nmem);
 373     new = nmem_malloc(nmem, sizeof(*new));
 374     memset(new, 0, sizeof(*new));
 375     initialize_hard_settings(new);
 376     dictionary = new;
 377     read_settings(path, prepare_dictionary);
 378     read_settings(path, update_databases);
 379 }
 380
 381 /*
 382  * Local variables:
 383  * c-basic-offset: 4
 384  * indent-tabs-mode: nil
 385  * End:
 386  * vim: shiftwidth=4 tabstop=8 expandtab
 387  */