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