src/settings.c

   1 /* This file is part of Pazpar2.
   2    Copyright (C) 2006-2011 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 <yaz/dirent.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 "session.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     "pz:sort",
  69     "pz:recordfilter",
  70     "pz:pqf_strftime",
  71     "pz:negotiation_charset",
  72     "pz:max_connections",
  73     "pz:reuse_connections",     /* PZ_REUSE_CONNECTION    */
  74     "pz:termlist_term_sort",    /* PZ_TERMLIST_TERM_SORT  */
  75     "pz:termlist_term_count",   /* PZ_TERMLIST_TERM_COUNT */
  76     "pz:termlist_term_factor",  /* PZ_TERMLIST_TERM_FACTOR*/
  77     "pz:preferred",             /* PZ_PREFERRED           */
  78     "pz:extra_args",            /* PZ_EXTRA_ARGS          */
  79     0
  80 };
  81
  82 struct setting_dictionary
  83 {
  84     char **dict;
  85     int size;
  86     int num;
  87 };
  88
  89 // This establishes the precedence of wildcard expressions
  90 #define SETTING_WILDCARD_NO     0 // No wildcard
  91 #define SETTING_WILDCARD_DB     1 // Database wildcard 'host:port/*'
  92 #define SETTING_WILDCARD_YES    2 // Complete wildcard '*'
  93
  94 // Returns size of settings directory
  95 int settings_num(struct conf_service *service)
  96 {
  97     return service->dictionary->num;
  98 }
  99
 100 static int settings_lookup(struct conf_service *service, const char *name,
 101                            int allow_create)
 102 {
 103     size_t maxlen;
 104     int i;
 105     const char *p;
 106     struct setting_dictionary *dictionary = service->dictionary;
 107
 108     assert(name);
 109
 110     if (!strncmp("pz:", name, 3) && (p = strchr(name + 3, ':')))
 111         maxlen = (p - name) + 1;
 112     else
 113         maxlen = strlen(name) + 1;
 114     for (i = 0; i < dictionary->num; i++)
 115         if (!strncmp(name, dictionary->dict[i], maxlen))
 116             return i;
 117     if (!allow_create)
 118         return -1;
 119     if (!strncmp("pz:", name, 3))
 120         yaz_log(YLOG_WARN, "Adding pz-type setting name %s", name);
 121     if (dictionary->num + 1 > dictionary->size)
 122     {
 123         char **tmp =
 124             nmem_malloc(service->nmem, dictionary->size * 2 * sizeof(char*));
 125         memcpy(tmp, dictionary->dict, dictionary->size * sizeof(char*));
 126         dictionary->dict = tmp;
 127         dictionary->size *= 2;
 128     }
 129     dictionary->dict[dictionary->num] = nmem_strdup(service->nmem, name);
 130     dictionary->dict[dictionary->num][maxlen-1] = '\0';
 131     return dictionary->num++;
 132 }
 133
 134 int settings_create_offset(struct conf_service *service, const char *name)
 135 {
 136     return settings_lookup(service, name, 1);
 137 }
 138
 139 int settings_lookup_offset(struct conf_service *service, const char *name)
 140 {
 141     return settings_lookup(service, name, 0);
 142 }
 143
 144 char *settings_name(struct conf_service *service, int offset)
 145 {
 146     assert(offset < service->dictionary->num);
 147     return service->dictionary->dict[offset];
 148 }
 149
 150 static int isdir(const char *path)
 151 {
 152     struct stat st;
 153
 154     if (stat(path, &st) < 0)
 155     {
 156         yaz_log(YLOG_FATAL|YLOG_ERRNO, "stat %s", path);
 157         exit(1);
 158     }
 159     return st.st_mode & S_IFDIR;
 160 }
 161
 162 // Read settings from an XML file, calling handler function for each setting
 163 void settings_read_node_x(xmlNode *n,
 164                           void *client_data,
 165                           void (*fun)(void *client_data,
 166                                       struct setting *set))
 167 {
 168     xmlChar *namea, *targeta, *valuea, *usera, *precedencea;
 169
 170     namea = xmlGetProp(n, (xmlChar *) "name");
 171     targeta = xmlGetProp(n, (xmlChar *) "target");
 172     valuea = xmlGetProp(n, (xmlChar *) "value");
 173     usera = xmlGetProp(n, (xmlChar *) "user");
 174     precedencea = xmlGetProp(n, (xmlChar *) "precedence");
 175     for (n = n->children; n; n = n->next)
 176     {
 177         if (n->type != XML_ELEMENT_NODE)
 178             continue;
 179         if (!strcmp((const char *) n->name, "set"))
 180         {
 181             char *name, *target, *value, *user, *precedence;
 182
 183             name = (char *) xmlGetProp(n, (xmlChar *) "name");
 184             target = (char *) xmlGetProp(n, (xmlChar *) "target");
 185             value = (char *) xmlGetProp(n, (xmlChar *) "value");
 186             user = (char *) xmlGetProp(n, (xmlChar *) "user");
 187             precedence = (char *) xmlGetProp(n, (xmlChar *) "precedence");
 188
 189             if ((!name && !namea) || (!value && !valuea) || (!target && !targeta))
 190             {
 191                 yaz_log(YLOG_FATAL, "set must specify name, value, and target");
 192                 exit(1);
 193             }
 194             else
 195             {
 196                 struct setting set;
 197                 char nameb[1024];
 198                 char targetb[1024];
 199                 char valueb[1024];
 200
 201                 // Copy everything into a temporary buffer -- we decide
 202                 // later if we are keeping it.
 203                 if (precedence)
 204                     set.precedence = atoi((char *) precedence);
 205                 else if (precedencea)
 206                     set.precedence = atoi((char *) precedencea);
 207                 else
 208                     set.precedence = 0;
 209                 if (target)
 210                     strcpy(targetb, target);
 211                 else
 212                     strcpy(targetb, (const char *) targeta);
 213                 set.target = targetb;
 214                 if (name)
 215                     strcpy(nameb, name);
 216                 else
 217                     strcpy(nameb, (const char *) namea);
 218                 set.name = nameb;
 219                 if (value)
 220                     strcpy(valueb, value);
 221                 else
 222                     strcpy(valueb, (const char *) valuea);
 223                 set.value = valueb;
 224                 set.next = 0;
 225                 (*fun)(client_data, &set);
 226             }
 227             xmlFree(name);
 228             xmlFree(precedence);
 229             xmlFree(value);
 230             xmlFree(user);
 231             xmlFree(target);
 232         }
 233         else
 234         {
 235             yaz_log(YLOG_FATAL, "Unknown element %s in settings file", (char*) n->name);
 236             exit(1);
 237         }
 238     }
 239     xmlFree(namea);
 240     xmlFree(precedencea);
 241     xmlFree(valuea);
 242     xmlFree(usera);
 243     xmlFree(targeta);
 244 }
 245
 246 static void read_settings_file(const char *path,
 247                                void *client_data,
 248                                void (*fun)(void *client_data,
 249                                            struct setting *set))
 250 {
 251     xmlDoc *doc = xmlParseFile(path);
 252     xmlNode *n;
 253
 254     if (!doc)
 255     {
 256         yaz_log(YLOG_FATAL, "Failed to parse %s", path);
 257         exit(1);
 258     }
 259     n = xmlDocGetRootElement(doc);
 260     settings_read_node_x(n, client_data, fun);
 261
 262     xmlFreeDoc(doc);
 263 }
 264
 265
 266 // Recursively read files or directories, invoking a
 267 // callback for each one
 268 static void read_settings(const char *path,
 269                           void *client_data,
 270                           void (*fun)(void *client_data,
 271                                       struct setting *set))
 272 {
 273     DIR *d;
 274     struct dirent *de;
 275     char *dot;
 276
 277     if (isdir(path))
 278     {
 279         if (!(d = opendir(path)))
 280         {
 281             yaz_log(YLOG_FATAL|YLOG_ERRNO, "%s", path);
 282             exit(1);
 283         }
 284         while ((de = readdir(d)))
 285         {
 286             char tmp[1024];
 287             if (*de->d_name == '.' || !strcmp(de->d_name, "CVS"))
 288                 continue;
 289             sprintf(tmp, "%s/%s", path, de->d_name);
 290             read_settings(tmp, client_data, fun);
 291         }
 292         closedir(d);
 293     }
 294     else if ((dot = strrchr(path, '.')) && !strcmp(dot + 1, "xml"))
 295         read_settings_file(path, client_data, fun);
 296 }
 297
 298 // Determines if a ZURL is a wildcard, and what kind
 299 static int zurl_wildcard(const char *zurl)
 300 {
 301     if (!zurl)
 302         return SETTING_WILDCARD_NO;
 303     if (*zurl == '*')
 304         return SETTING_WILDCARD_YES;
 305     else if (*(zurl + strlen(zurl) - 1) == '*')
 306         return SETTING_WILDCARD_DB;
 307     else
 308         return SETTING_WILDCARD_NO;
 309 }
 310
 311 struct update_database_context {
 312     struct setting *set;
 313     struct conf_service *service;
 314 };
 315
 316 void expand_settings_array(struct setting ***set_ar, int *num, int offset,
 317                            NMEM nmem)
 318 {
 319     assert(offset >= 0);
 320     assert(*set_ar);
 321     if (offset >= *num)
 322     {
 323         int i, n_num = offset + 10;
 324         struct setting **n_ar = nmem_malloc(nmem, n_num * sizeof(*n_ar));
 325         for (i = 0; i < *num; i++)
 326             n_ar[i] = (*set_ar)[i];
 327         for (; i < n_num; i++)
 328             n_ar[i] = 0;
 329         *num = n_num;
 330         *set_ar = n_ar;
 331     }
 332 }
 333
 334 // This is called from grep_databases -- adds/overrides setting for a target
 335 // This is also where the rules for precedence of settings are implemented
 336 static void update_database(void *context, struct database *db)
 337 {
 338     struct setting *set = ((struct update_database_context *)
 339                            context)->set;
 340     struct conf_service *service = ((struct update_database_context *)
 341                                     context)->service;
 342     struct setting **sp;
 343     int offset;
 344
 345     // Is this the right database?
 346     if (!match_zurl(db->url, set->target))
 347         return;
 348
 349     offset = settings_create_offset(service, set->name);
 350     expand_settings_array(&db->settings, &db->num_settings, offset,
 351                           service->nmem);
 352
 353     // First we determine if this setting is overriding  any existing settings
 354     // with the same name.
 355     assert(offset < db->num_settings);
 356     for (sp = &db->settings[offset]; *sp; )
 357         if (!strcmp((*sp)->name, set->name))
 358         {
 359             if ((*sp)->precedence < set->precedence)
 360             {
 361                 // We discard the value (nmem keeps track of the space)
 362                 *sp = (*sp)->next; // unlink value from existing setting
 363             }
 364             else if ((*sp)->precedence > set->precedence)
 365             {
 366                 // Db contains a higher-priority setting. Abort search
 367                 break;
 368             }
 369             else if (zurl_wildcard((*sp)->target) > zurl_wildcard(set->target))
 370             {
 371                 // target-specific value trumps wildcard. Delete.
 372                 *sp = (*sp)->next; // unlink.....
 373             }
 374             else if (zurl_wildcard((*sp)->target) < zurl_wildcard(set->target))
 375                 // Db already contains higher-priority setting. Abort search
 376                 break;
 377             else
 378                 sp = &(*sp)->next;
 379         }
 380         else
 381             sp = &(*sp)->next;
 382     if (!*sp) // is null when there are no higher-priority settings, so we add one
 383     {
 384         struct setting *new = nmem_malloc(service->nmem, sizeof(*new));
 385
 386         memset(new, 0, sizeof(*new));
 387         new->precedence = set->precedence;
 388         new->target = nmem_strdup(service->nmem, set->target);
 389         new->name = nmem_strdup(service->nmem, set->name);
 390         new->value = nmem_strdup(service->nmem, set->value);
 391         new->next = db->settings[offset];
 392         db->settings[offset] = new;
 393     }
 394 }
 395
 396 // Callback -- updates database records with dictionary entries as appropriate
 397 // This is used in pass 2 to assign name/value pairs to databases
 398 static void update_databases(void *client_data, struct setting *set)
 399 {
 400     struct conf_service *service = (struct conf_service *) client_data;
 401     struct update_database_context context;
 402     context.set = set;
 403     context.service = service;
 404     predef_grep_databases(&context, service, update_database);
 405 }
 406
 407 // This simply copies the 'hard' (application-specific) settings
 408 // to the settings dictionary.
 409 static void initialize_hard_settings(struct conf_service *service)
 410 {
 411     struct setting_dictionary *dict = service->dictionary;
 412     dict->dict = nmem_malloc(service->nmem, sizeof(hard_settings) - sizeof(char*));
 413     dict->size = (sizeof(hard_settings) - sizeof(char*)) / sizeof(char*);
 414     memcpy(dict->dict, hard_settings, dict->size * sizeof(char*));
 415     dict->num = dict->size;
 416 }
 417
 418 // Read any settings names introduced in service definition (config) and add to dictionary
 419 // This is done now to avoid errors if user settings are declared in session overrides
 420 static void initialize_soft_settings(struct conf_service *service)
 421 {
 422     int i;
 423
 424     for (i = 0; i < service->num_metadata; i++)
 425     {
 426         struct conf_metadata *md = &service->metadata[i];
 427
 428         if (md->setting == Metadata_setting_no)
 429             continue;
 430
 431         settings_create_offset(service, md->name);
 432     }
 433 }
 434
 435 static void prepare_target_dictionary(void *client_data, struct setting *set)
 436 {
 437     struct conf_service *service = (struct conf_service *) client_data;
 438     struct setting_dictionary *dictionary = service->dictionary;
 439
 440     int i;
 441     char *p;
 442
 443     // If target address is not wildcard, add the database
 444     if (*set->target && !zurl_wildcard(set->target))
 445         find_database(set->target, service);
 446
 447     // Determine if we already have a dictionary entry
 448     if (!strncmp(set->name, "pz:", 3) && (p = strchr(set->name + 3, ':')))
 449         *(p + 1) = '\0';
 450     for (i = 0; i < dictionary->num; i++)
 451         if (!strcmp(dictionary->dict[i], set->name))
 452             return;
 453     yaz_log(YLOG_WARN, "Setting '%s' not configured as metadata", set->name);
 454 }
 455
 456 void init_settings(struct conf_service *service)
 457 {
 458     struct setting_dictionary *new;
 459
 460     assert(service->nmem);
 461
 462     new = nmem_malloc(service->nmem, sizeof(*new));
 463     memset(new, 0, sizeof(*new));
 464     service->dictionary = new;
 465     initialize_hard_settings(service);
 466     initialize_soft_settings(service);
 467 }
 468
 469 void settings_read_file(struct conf_service *service, const char *path,
 470                         int pass)
 471 {
 472     if (pass == 1)
 473         read_settings(path, service, prepare_target_dictionary);
 474     else
 475         read_settings(path, service, update_databases);
 476 }
 477
 478 void settings_read_node(struct conf_service *service, xmlNode *n,
 479                         int pass)
 480 {
 481     if (pass == 1)
 482         settings_read_node_x(n, service, prepare_target_dictionary);
 483     else
 484         settings_read_node_x(n, service, update_databases);
 485 }
 486
 487 /*
 488  * Local variables:
 489  * c-basic-offset: 4
 490  * c-file-style: "Stroustrup"
 491  * indent-tabs-mode: nil
 492  * End:
 493  * vim: shiftwidth=4 tabstop=8 expandtab
 494  */
 495