src/settings.c

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