src/settings.c

   1 /* This file is part of Pazpar2.
   2    Copyright (C) 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:zproxy",
  63     "pz:apdulog",
  64     "pz:sru",
  65     "pz:sru_version",
  66     "pz:pqf_prefix",
  67     "pz:sort",
  68     "pz:recordfilter",
  69     "pz:pqf_strftime",
  70     "pz:negotiation_charset",
  71     "pz:max_connections",
  72     "pz:reuse_connections",
  73     "pz:termlist_term_factor",
  74     "pz:termlist_term_count",
  75     "pz:preferred",
  76     "pz:extra_args",
  77     "pz:query_syntax",
  78     "pz:facetmap:",
  79     "pz:limitmap:",
  80     "pz:url",
  81     "pz:sortmap:",
  82     "pz:present_chunk",
  83     "pz:block_timeout",
  84     "pz:extendrecs",
  85     "pz:authentication_mode",
  86     "pz:native_score",
  87     "pz:memcached",
  88     "pz:redis",
  89     "pz:timeout",
  90     0
  91 };
  92
  93 struct setting_dictionary
  94 {
  95     char **dict;
  96     int size;
  97     int num;
  98 };
  99
 100 // This establishes the precedence of wildcard expressions
 101 #define SETTING_WILDCARD_NO     0 // No wildcard
 102 #define SETTING_WILDCARD_DB     1 // Database wildcard 'host:port/*'
 103 #define SETTING_WILDCARD_YES    2 // Complete wildcard '*'
 104
 105 // Returns size of settings directory
 106 int settings_num(struct conf_service *service)
 107 {
 108     return service->dictionary->num;
 109 }
 110
 111 /* Find and possible create a new dictionary entry. Pass valid NMEM pointer if creation is allowed, otherwise null */
 112 static int settings_index_lookup(struct setting_dictionary *dictionary, const char *name, NMEM nmem)
 113 {
 114     size_t maxlen;
 115     int i;
 116     const char *p;
 117
 118     assert(name);
 119
 120     if (!strncmp("pz:", name, 3) && (p = strchr(name + 3, ':')))
 121         maxlen = (p - name) + 1;
 122     else
 123         maxlen = strlen(name) + 1;
 124     for (i = 0; i < dictionary->num; i++)
 125         if (!strncmp(name, dictionary->dict[i], maxlen))
 126             return i;
 127     if (!nmem)
 128         return -1;
 129     if (!strncmp("pz:", name, 3))
 130         yaz_log(YLOG_WARN, "Adding pz-type setting name %s", name);
 131     if (dictionary->num + 1 > dictionary->size)
 132     {
 133         char **tmp =
 134             nmem_malloc(nmem, dictionary->size * 2 * sizeof(char*));
 135         memcpy(tmp, dictionary->dict, dictionary->size * sizeof(char*));
 136         dictionary->dict = tmp;
 137         dictionary->size *= 2;
 138     }
 139     dictionary->dict[dictionary->num] = nmem_strdup(nmem, name);
 140     dictionary->dict[dictionary->num][maxlen-1] = '\0';
 141     return dictionary->num++;
 142 }
 143
 144 int settings_create_offset(struct conf_service *service, const char *name)
 145 {
 146     return settings_index_lookup(service->dictionary, name, service->nmem);
 147 }
 148
 149 int settings_lookup_offset(struct conf_service *service, const char *name)
 150 {
 151     return settings_index_lookup(service->dictionary, name, 0);
 152 }
 153
 154 char *settings_name(struct conf_service *service, int offset)
 155 {
 156     assert(offset < service->dictionary->num);
 157     return service->dictionary->dict[offset];
 158 }
 159
 160 static int isdir(const char *path)
 161 {
 162     struct stat st;
 163
 164     if (stat(path, &st) < 0)
 165     {
 166         yaz_log(YLOG_FATAL|YLOG_ERRNO, "stat %s", path);
 167         exit(1);
 168     }
 169     return st.st_mode & S_IFDIR;
 170 }
 171
 172 // Read settings from an XML file, calling handler function for each setting
 173 int settings_read_node_x(xmlNode *n,
 174                          void *client_data,
 175                          void (*fun)(void *client_data,
 176                                      struct setting *set))
 177 {
 178     int ret_val = 0; /* success */
 179     char *namea = (char *) xmlGetProp(n, (xmlChar *) "name");
 180     char *targeta = (char *) xmlGetProp(n, (xmlChar *) "target");
 181     char *valuea = (char *) xmlGetProp(n, (xmlChar *) "value");
 182     char *usera = (char *) xmlGetProp(n, (xmlChar *) "user");
 183     char *precedencea = (char *) xmlGetProp(n, (xmlChar *) "precedence");
 184
 185     for (n = n->children; n; n = n->next)
 186     {
 187         if (n->type != XML_ELEMENT_NODE)
 188             continue;
 189         if (!strcmp((const char *) n->name, "set"))
 190         {
 191             xmlNode *root = n->children;
 192             struct setting set;
 193             char *name = (char *) xmlGetProp(n, (xmlChar *) "name");
 194             char *target = (char *) xmlGetProp(n, (xmlChar *) "target");
 195             char *value = (char *) xmlGetProp(n, (xmlChar *) "value");
 196             char *user = (char *) xmlGetProp(n, (xmlChar *) "user");
 197             char *precedence = (char *) xmlGetProp(n, (xmlChar *) "precedence");
 198             xmlChar *buf_out = 0;
 199
 200             set.next = 0;
 201
 202             if (precedence)
 203                 set.precedence = atoi((char *) precedence);
 204             else if (precedencea)
 205                 set.precedence = atoi((char *) precedencea);
 206             else
 207                 set.precedence = 0;
 208
 209             set.target = target ? target : targeta;
 210             set.name = name ? name : namea;
 211
 212             while (root && root->type != XML_ELEMENT_NODE)
 213                 root = root->next;
 214             if (!root)
 215                 set.value = value ? value : valuea;
 216             else
 217             {   /* xml document content for this setting */
 218                 xmlDoc *doc = xmlNewDoc(BAD_CAST "1.0");
 219                 if (!doc)
 220                 {
 221                     if (set.name)
 222                         yaz_log(YLOG_WARN, "bad XML content for setting "
 223                                 "name=%s", set.name);
 224                     else
 225                         yaz_log(YLOG_WARN, "bad XML content for setting");
 226                     ret_val = -1;
 227                 }
 228                 else
 229                 {
 230                     int len_out;
 231                     xmlDocSetRootElement(doc, xmlCopyNode(root, 1));
 232                     xmlDocDumpMemory(doc, &buf_out, &len_out);
 233                     /* xmlDocDumpMemory 0-terminates */
 234                     set.value = (char *) buf_out;
 235                     xmlFreeDoc(doc);
 236                 }
 237             }
 238
 239             if (set.name && set.value && set.target)
 240                 (*fun)(client_data, &set);
 241             else
 242             {
 243                 if (set.name)
 244                     yaz_log(YLOG_WARN, "missing value and/or target for "
 245                             "setting name=%s", set.name);
 246                 else
 247                     yaz_log(YLOG_WARN, "missing name/value/target for setting");
 248                 ret_val = -1;
 249             }
 250             xmlFree(buf_out);
 251             xmlFree(name);
 252             xmlFree(precedence);
 253             xmlFree(value);
 254             xmlFree(user);
 255             xmlFree(target);
 256         }
 257         else
 258         {
 259             yaz_log(YLOG_WARN, "Unknown element %s in settings file",
 260                     (char*) n->name);
 261             ret_val = -1;
 262         }
 263     }
 264     xmlFree(namea);
 265     xmlFree(precedencea);
 266     xmlFree(valuea);
 267     xmlFree(usera);
 268     xmlFree(targeta);
 269     return ret_val;
 270 }
 271
 272 static int read_settings_file(const char *path,
 273                               void *client_data,
 274                               void (*fun)(void *client_data,
 275                                           struct setting *set))
 276 {
 277     xmlDoc *doc = xmlParseFile(path);
 278     xmlNode *n;
 279     int ret;
 280
 281     if (!doc)
 282     {
 283         yaz_log(YLOG_FATAL, "Failed to parse %s", path);
 284         return -1;
 285     }
 286     n = xmlDocGetRootElement(doc);
 287     ret = settings_read_node_x(n, client_data, fun);
 288
 289     xmlFreeDoc(doc);
 290     return ret;
 291 }
 292
 293
 294 // Recursively read files or directories, invoking a
 295 // callback for each one
 296 static int read_settings(const char *path,
 297                           void *client_data,
 298                           void (*fun)(void *client_data,
 299                                       struct setting *set))
 300 {
 301     int ret = 0;
 302     DIR *d;
 303     struct dirent *de;
 304     char *dot;
 305
 306     if (isdir(path))
 307     {
 308         if (!(d = opendir(path)))
 309         {
 310             yaz_log(YLOG_FATAL|YLOG_ERRNO, "%s", path);
 311             return -1;
 312         }
 313         while ((de = readdir(d)))
 314         {
 315             char tmp[1024];
 316             if (*de->d_name == '.' || !strcmp(de->d_name, "CVS"))
 317                 continue;
 318             sprintf(tmp, "%s/%s", path, de->d_name);
 319             if (read_settings(tmp, client_data, fun))
 320                 ret = -1;
 321         }
 322         closedir(d);
 323     }
 324     else if ((dot = strrchr(path, '.')) && !strcmp(dot + 1, "xml"))
 325         ret = read_settings_file(path, client_data, fun);
 326     return ret;
 327 }
 328
 329 // Determines if a ZURL is a wildcard, and what kind
 330 static int zurl_wildcard(const char *zurl)
 331 {
 332     if (!zurl)
 333         return SETTING_WILDCARD_NO;
 334     if (*zurl == '*')
 335         return SETTING_WILDCARD_YES;
 336     else if (*(zurl + strlen(zurl) - 1) == '*')
 337         return SETTING_WILDCARD_DB;
 338     else
 339         return SETTING_WILDCARD_NO;
 340 }
 341
 342 struct update_database_context {
 343     struct setting *set;
 344     struct conf_service *service;
 345 };
 346
 347 void expand_settings_array(struct setting ***set_ar, int *num, int offset,
 348                            NMEM nmem)
 349 {
 350     assert(offset >= 0);
 351     assert(*set_ar);
 352     if (offset >= *num)
 353     {
 354         int i, n_num = offset + 10;
 355         struct setting **n_ar = nmem_malloc(nmem, n_num * sizeof(*n_ar));
 356         for (i = 0; i < *num; i++)
 357             n_ar[i] = (*set_ar)[i];
 358         for (; i < n_num; i++)
 359             n_ar[i] = 0;
 360         *num = n_num;
 361         *set_ar = n_ar;
 362     }
 363 }
 364
 365 void expand_settings_array2(struct settings_array *settings, int offset, NMEM nmem)
 366 {
 367     assert(offset >= 0);
 368     assert(settings);
 369     if (offset >= settings->num_settings)
 370     {
 371         int i, n_num = offset + 10;
 372         struct setting **n_ar = nmem_malloc(nmem, n_num * sizeof(*n_ar));
 373         for (i = 0; i < settings->num_settings; i++)
 374             n_ar[i] = settings->settings[i];
 375         for (; i < n_num; i++)
 376             n_ar[i] = 0;
 377         settings->num_settings = n_num;
 378         settings->settings = n_ar;
 379     }
 380 }
 381
 382 static void update_settings(struct setting *set, struct settings_array *settings, int offset, NMEM nmem)
 383 {
 384     struct setting **sp;
 385     yaz_log(YLOG_DEBUG, "update service settings offset %d with %s=%s", offset, set->name, set->value);
 386     expand_settings_array2(settings, offset, nmem);
 387
 388     // First we determine if this setting is overriding any existing settings
 389     // with the same name.
 390     assert(offset < settings->num_settings);
 391     for (sp = &settings->settings[offset]; *sp; )
 392         if (!strcmp((*sp)->name, set->name))
 393         {
 394             if ((*sp)->precedence < set->precedence)
 395             {
 396                 // We discard the value (nmem keeps track of the space)
 397                 *sp = (*sp)->next; // unlink value from existing setting
 398             }
 399             else if ((*sp)->precedence > set->precedence)
 400             {
 401                 // Db contains a higher-priority setting. Abort search
 402                 break;
 403             }
 404             else if (zurl_wildcard((*sp)->target) > zurl_wildcard(set->target))
 405             {
 406                 // target-specific value trumps wildcard. Delete.
 407                 *sp = (*sp)->next; // unlink.....
 408             }
 409             else if (zurl_wildcard((*sp)->target) < zurl_wildcard(set->target))
 410                 // Db already contains higher-priority setting. Abort search
 411                 break;
 412             else
 413                 sp = &(*sp)->next;
 414         }
 415         else
 416             sp = &(*sp)->next;
 417     if (!*sp) // is null when there are no higher-priority settings, so we add one
 418     {
 419         struct setting *new = nmem_malloc(nmem, sizeof(*new));
 420         memset(new, 0, sizeof(*new));
 421         new->precedence = set->precedence;
 422         new->target = nmem_strdup_null(nmem, set->target);
 423         new->name = nmem_strdup_null(nmem, set->name);
 424         new->value = nmem_strdup_null(nmem, set->value);
 425         new->next = settings->settings[offset];
 426         settings->settings[offset] = new;
 427     }
 428 }
 429
 430
 431 // This is called from grep_databases -- adds/overrides setting for a target
 432 // This is also where the rules for precedence of settings are implemented
 433 static void update_database_fun(void *context, struct database *db)
 434 {
 435     struct setting *set = ((struct update_database_context *)
 436                            context)->set;
 437     struct conf_service *service = ((struct update_database_context *)
 438                                     context)->service;
 439     struct setting **sp;
 440     int offset;
 441
 442     // Is this the right database?
 443     if (!match_zurl(db->id, set->target))
 444         return;
 445
 446     offset = settings_create_offset(service, set->name);
 447     expand_settings_array(&db->settings, &db->num_settings, offset, service->nmem);
 448
 449     // First we determine if this setting is overriding  any existing settings
 450     // with the same name.
 451     assert(offset < db->num_settings);
 452     for (sp = &db->settings[offset]; *sp; )
 453         if (!strcmp((*sp)->name, set->name))
 454         {
 455             if ((*sp)->precedence < set->precedence)
 456             {
 457                 // We discard the value (nmem keeps track of the space)
 458                 *sp = (*sp)->next; // unlink value from existing setting
 459             }
 460             else if ((*sp)->precedence > set->precedence)
 461             {
 462                 // Db contains a higher-priority setting. Abort search
 463                 break;
 464             }
 465             else if (zurl_wildcard((*sp)->target) > zurl_wildcard(set->target))
 466             {
 467                 // target-specific value trumps wildcard. Delete.
 468                 *sp = (*sp)->next; // unlink.....
 469             }
 470             else if (zurl_wildcard((*sp)->target) < zurl_wildcard(set->target))
 471                 // Db already contains higher-priority setting. Abort search
 472                 break;
 473             else
 474                 sp = &(*sp)->next;
 475         }
 476         else
 477             sp = &(*sp)->next;
 478     if (!*sp) // is null when there are no higher-priority settings, so we add one
 479     {
 480         struct setting *new = nmem_malloc(service->nmem, sizeof(*new));
 481
 482         memset(new, 0, sizeof(*new));
 483         new->precedence = set->precedence;
 484         new->target = nmem_strdup(service->nmem, set->target);
 485         new->name = nmem_strdup(service->nmem, set->name);
 486         new->value = nmem_strdup(service->nmem, set->value);
 487         new->next = db->settings[offset];
 488         db->settings[offset] = new;
 489     }
 490 }
 491
 492 // Callback -- updates database records with dictionary entries as appropriate
 493 // This is used in pass 2 to assign name/value pairs to databases
 494 static void update_databases(void *client_data, struct setting *set)
 495 {
 496     struct conf_service *service = (struct conf_service *) client_data;
 497     struct update_database_context context;
 498     context.set = set;
 499     context.service = service;
 500     predef_grep_databases(&context, service, update_database_fun);
 501 }
 502
 503 // This simply copies the 'hard' (application-specific) settings
 504 // to the settings dictionary.
 505 static void initialize_hard_settings(struct conf_service *service)
 506 {
 507     struct setting_dictionary *dict = service->dictionary;
 508     dict->dict = nmem_malloc(service->nmem, sizeof(hard_settings) - sizeof(char*));
 509     dict->size = (sizeof(hard_settings) - sizeof(char*)) / sizeof(char*);
 510     memcpy(dict->dict, hard_settings, dict->size * sizeof(char*));
 511     dict->num = dict->size;
 512 }
 513
 514 // Read any settings names introduced in service definition (config) and add to dictionary
 515 // This is done now to avoid errors if user settings are declared in session overrides
 516 void initialize_soft_settings(struct conf_service *service)
 517 {
 518     int i;
 519     for (i = 0; i < service->num_metadata; i++)
 520     {
 521         struct conf_metadata *md = &service->metadata[i];
 522
 523         if (md->setting != Metadata_setting_no)
 524             settings_create_offset(service, md->name);
 525
 526         // Also create setting for some metadata attributes.
 527         if (md->limitmap) {
 528             int index;
 529             WRBUF wrbuf = wrbuf_alloc();
 530             yaz_log(YLOG_DEBUG, "Metadata %s has limitmap: %s ",md->name,  md->limitmap);
 531             wrbuf_printf(wrbuf, "pz:limitmap:%s", md->name);
 532             index = settings_create_offset(service, wrbuf_cstr(wrbuf));
 533             if (index >= 0) {
 534                 struct setting new;
 535                 int offset;
 536                 yaz_log(YLOG_DEBUG, "Service %s default %s=%s",
 537                         (service->id ? service->id: "unknown"), wrbuf_cstr(wrbuf), md->limitmap);
 538                 new.name = (char *) wrbuf_cstr(wrbuf);
 539                 new.value = md->limitmap;
 540                 new.next = 0;
 541                 new.target = 0;
 542                 new.precedence = 0;
 543                 offset = settings_create_offset(service, new.name);
 544                 update_settings(&new, service->settings, offset, service->nmem);
 545             }
 546             wrbuf_destroy(wrbuf);
 547         // TODO same for facetmap
 548         }
 549     }
 550 }
 551
 552 static void prepare_target_dictionary(void *client_data, struct setting *set)
 553 {
 554     struct conf_service *service = (struct conf_service *) client_data;
 555
 556     // If target address is not wildcard, add the database
 557     if (*set->target && !zurl_wildcard(set->target))
 558         create_database_for_service(set->target, service);
 559 }
 560
 561 void init_settings(struct conf_service *service)
 562 {
 563     struct setting_dictionary *new;
 564
 565     assert(service->nmem);
 566
 567     new = nmem_malloc(service->nmem, sizeof(*new));
 568     memset(new, 0, sizeof(*new));
 569     service->dictionary = new;
 570     initialize_hard_settings(service);
 571     initialize_soft_settings(service);
 572 }
 573
 574 int settings_read_file(struct conf_service *service, const char *path,
 575                        int pass)
 576 {
 577     if (pass == 1)
 578         return read_settings(path, service, prepare_target_dictionary);
 579     else
 580         return read_settings(path, service, update_databases);
 581 }
 582
 583 int settings_read_node(struct conf_service *service, xmlNode *n,
 584                         int pass)
 585 {
 586     if (pass == 1)
 587         return settings_read_node_x(n, service, prepare_target_dictionary);
 588     else
 589         return settings_read_node_x(n, service, update_databases);
 590 }
 591
 592 /*
 593  * Local variables:
 594  * c-basic-offset: 4
 595  * c-file-style: "Stroustrup"
 596  * indent-tabs-mode: nil
 597  * End:
 598  * vim: shiftwidth=4 tabstop=8 expandtab
 599  */
 600