X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=src%2Fsettings.c;h=2d99c78a7b851921862e2e01d07832f5fe3d0f28;hb=f00bd32b54ee3dd8fed73fdb3b8e78549837e174;hp=6ec2d745c0bd73758f066dfbf512c9cb418eb2ce;hpb=22fd6276ea142c135f125edde76e46741bb7b545;p=pazpar2-moved-to-github.git diff --git a/src/settings.c b/src/settings.c index 6ec2d74..2d99c78 100644 --- a/src/settings.c +++ b/src/settings.c @@ -1,57 +1,488 @@ -// $Id: settings.c,v 1.1 2007-03-27 15:31:34 quinn Exp $ -// This module implements a generic system of settings (attribute-value) that can -// be associated with search targets. The system supports both default values, -// per-target overrides, and per-user settings. -// +/* This file is part of Pazpar2. + Copyright (C) 2006-2010 Index Data + +Pazpar2 is free software; you can redistribute it and/or modify it under +the terms of the GNU General Public License as published by the Free +Software Foundation; either version 2, or (at your option) any later +version. + +Pazpar2 is distributed in the hope that it will be useful, but WITHOUT ANY +WARRANTY; without even the implied warranty of MERCHANTABILITY or +FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +for more details. + +You should have received a copy of the GNU General Public License +along with this program; if not, write to the Free Software +Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA + +*/ + +// This module implements a generic system of settings +// (attribute-value) that can be associated with search targets. The +// system supports both default values, per-target overrides, and +// per-user settings. + +#if HAVE_CONFIG_H +#include +#endif + #include +#include +#include +#include +#include +#include +#include + +#include +#include #include +#include -static NMEM nmem = 0; +#include "session.h" +#include "database.h" +#include "settings.h" -struct setting -{ +// Used for initializing setting_dictionary with pazpar2-specific settings +static char *hard_settings[] = { + "pz:piggyback", + "pz:elements", + "pz:requestsyntax", + "pz:cclmap:", + "pz:xslt", + "pz:nativesyntax", + "pz:authentication", + "pz:allow", + "pz:maxrecs", + "pz:id", + "pz:name", + "pz:queryencoding", + "pz:ip", + "pz:zproxy", + "pz:apdulog", + "pz:sru", + "pz:sru_version", + "pz:pqf_prefix", + "pz:sort", + "pz:recordfilter", + "pz:pqf_strftime", + "pz:negotiation_charset", + 0 }; struct setting_dictionary { + char **dict; + int size; + int num; +}; + +// This establishes the precedence of wildcard expressions +#define SETTING_WILDCARD_NO 0 // No wildcard +#define SETTING_WILDCARD_DB 1 // Database wildcard 'host:port/*' +#define SETTING_WILDCARD_YES 2 // Complete wildcard '*' + +// Returns size of settings directory +int settings_num(struct conf_service *service) +{ + return service->dictionary->num; +} + +static int settings_lookup(struct conf_service *service, const char *name, + int allow_create) +{ + size_t maxlen; + int i; + const char *p; + struct setting_dictionary *dictionary = service->dictionary; + + assert(name); + + if (!strncmp("pz:", name, 3) && (p = strchr(name + 3, ':'))) + maxlen = (p - name) + 1; + else + maxlen = strlen(name) + 1; + for (i = 0; i < dictionary->num; i++) + if (!strncmp(name, dictionary->dict[i], maxlen)) + return i; + if (!allow_create) + return -1; + if (!strncmp("pz:", name, 3)) + yaz_log(YLOG_WARN, "Adding pz-type setting name %s", name); + if (dictionary->num + 1 > dictionary->size) + { + char **tmp = + nmem_malloc(service->nmem, dictionary->size * 2 * sizeof(char*)); + memcpy(tmp, dictionary->dict, dictionary->size * sizeof(char*)); + dictionary->dict = tmp; + dictionary->size *= 2; + } + dictionary->dict[dictionary->num] = nmem_strdup(service->nmem, name); + dictionary->dict[dictionary->num][maxlen-1] = '\0'; + return dictionary->num++; +} + +int settings_create_offset(struct conf_service *service, const char *name) +{ + return settings_lookup(service, name, 1); +} + +int settings_lookup_offset(struct conf_service *service, const char *name) +{ + return settings_lookup(service, name, 0); +} + +char *settings_name(struct conf_service *service, int offset) +{ + assert(offset < service->dictionary->num); + return service->dictionary->dict[offset]; +} + +static int isdir(const char *path) +{ + struct stat st; + + if (stat(path, &st) < 0) + { + yaz_log(YLOG_FATAL|YLOG_ERRNO, "stat %s", path); + exit(1); + } + return st.st_mode & S_IFDIR; +} + +// Read settings from an XML file, calling handler function for each setting +void settings_read_node_x(xmlNode *n, + void *client_data, + void (*fun)(void *client_data, + struct setting *set)) +{ + xmlChar *namea, *targeta, *valuea, *usera, *precedencea; + + namea = xmlGetProp(n, (xmlChar *) "name"); + targeta = xmlGetProp(n, (xmlChar *) "target"); + valuea = xmlGetProp(n, (xmlChar *) "value"); + usera = xmlGetProp(n, (xmlChar *) "user"); + precedencea = xmlGetProp(n, (xmlChar *) "precedence"); + for (n = n->children; n; n = n->next) + { + if (n->type != XML_ELEMENT_NODE) + continue; + if (!strcmp((const char *) n->name, "set")) + { + char *name, *target, *value, *user, *precedence; + + name = (char *) xmlGetProp(n, (xmlChar *) "name"); + target = (char *) xmlGetProp(n, (xmlChar *) "target"); + value = (char *) xmlGetProp(n, (xmlChar *) "value"); + user = (char *) xmlGetProp(n, (xmlChar *) "user"); + precedence = (char *) xmlGetProp(n, (xmlChar *) "precedence"); + + if ((!name && !namea) || (!value && !valuea) || (!target && !targeta)) + { + yaz_log(YLOG_FATAL, "set must specify name, value, and target"); + exit(1); + } + else + { + struct setting set; + char nameb[1024]; + char targetb[1024]; + char valueb[1024]; + + // Copy everything into a temporary buffer -- we decide + // later if we are keeping it. + if (precedence) + set.precedence = atoi((char *) precedence); + else if (precedencea) + set.precedence = atoi((char *) precedencea); + else + set.precedence = 0; + if (target) + strcpy(targetb, target); + else + strcpy(targetb, (const char *) targeta); + set.target = targetb; + if (name) + strcpy(nameb, name); + else + strcpy(nameb, (const char *) namea); + set.name = nameb; + if (value) + strcpy(valueb, value); + else + strcpy(valueb, (const char *) valuea); + set.value = valueb; + set.next = 0; + (*fun)(client_data, &set); + } + xmlFree(name); + xmlFree(precedence); + xmlFree(value); + xmlFree(user); + xmlFree(target); + } + else + { + yaz_log(YLOG_FATAL, "Unknown element %s in settings file", (char*) n->name); + exit(1); + } + } + xmlFree(namea); + xmlFree(precedencea); + xmlFree(valuea); + xmlFree(usera); + xmlFree(targeta); +} + +static void read_settings_file(const char *path, + void *client_data, + void (*fun)(void *client_data, + struct setting *set)) +{ + xmlDoc *doc = xmlParseFile(path); + xmlNode *n; + + if (!doc) + { + yaz_log(YLOG_FATAL, "Failed to parse %s", path); + exit(1); + } + n = xmlDocGetRootElement(doc); + settings_read_node_x(n, client_data, fun); + + xmlFreeDoc(doc); +} + + +// Recursively read files or directories, invoking a +// callback for each one +static void read_settings(const char *path, + void *client_data, + void (*fun)(void *client_data, + struct setting *set)) +{ + DIR *d; + struct dirent *de; + char *dot; + + if (isdir(path)) + { + if (!(d = opendir(path))) + { + yaz_log(YLOG_FATAL|YLOG_ERRNO, "%s", path); + exit(1); + } + while ((de = readdir(d))) + { + char tmp[1024]; + if (*de->d_name == '.' || !strcmp(de->d_name, "CVS")) + continue; + sprintf(tmp, "%s/%s", path, de->d_name); + read_settings(tmp, client_data, fun); + } + closedir(d); + } + else if ((dot = strrchr(path, '.')) && !strcmp(dot + 1, "xml")) + read_settings_file(path, client_data, fun); +} + +// Determines if a ZURL is a wildcard, and what kind +static int zurl_wildcard(const char *zurl) +{ + if (!zurl) + return SETTING_WILDCARD_NO; + if (*zurl == '*') + return SETTING_WILDCARD_YES; + else if (*(zurl + strlen(zurl) - 1) == '*') + return SETTING_WILDCARD_DB; + else + return SETTING_WILDCARD_NO; +} + +struct update_database_context { + struct setting *set; + struct conf_service *service; }; -// Recursively read files in a directory structure, calling -static void read_settings(const char *path, void *context, - void (*fun)(void *context, struct setting *set)) +void expand_settings_array(struct setting ***set_ar, int *num, int offset, + NMEM nmem) +{ + assert(offset >= 0); + assert(*set_ar); + if (offset >= *num) + { + int i, n_num = offset + 10; + struct setting **n_ar = nmem_malloc(nmem, n_num * sizeof(*n_ar)); + for (i = 0; i < *num; i++) + n_ar[i] = (*set_ar)[i]; + for (; i < n_num; i++) + n_ar[i] = 0; + *num = n_num; + *set_ar = n_ar; + } +} + +// This is called from grep_databases -- adds/overrides setting for a target +// This is also where the rules for precedence of settings are implemented +static void update_database(void *context, struct database *db) +{ + struct setting *set = ((struct update_database_context *) + context)->set; + struct conf_service *service = ((struct update_database_context *) + context)->service; + struct setting **sp; + int offset; + + // Is this the right database? + if (!match_zurl(db->url, set->target)) + return; + + offset = settings_create_offset(service, set->name); + expand_settings_array(&db->settings, &db->num_settings, offset, + service->nmem); + + // First we determine if this setting is overriding any existing settings + // with the same name. + assert(offset < db->num_settings); + for (sp = &db->settings[offset]; *sp; ) + if (!strcmp((*sp)->name, set->name)) + { + if ((*sp)->precedence < set->precedence) + { + // We discard the value (nmem keeps track of the space) + *sp = (*sp)->next; // unlink value from existing setting + } + else if ((*sp)->precedence > set->precedence) + { + // Db contains a higher-priority setting. Abort search + break; + } + else if (zurl_wildcard((*sp)->target) > zurl_wildcard(set->target)) + { + // target-specific value trumps wildcard. Delete. + *sp = (*sp)->next; // unlink..... + } + else if (zurl_wildcard((*sp)->target) < zurl_wildcard(set->target)) + // Db already contains higher-priority setting. Abort search + break; + else + sp = &(*sp)->next; + } + else + sp = &(*sp)->next; + if (!*sp) // is null when there are no higher-priority settings, so we add one + { + struct setting *new = nmem_malloc(service->nmem, sizeof(*new)); + + memset(new, 0, sizeof(*new)); + new->precedence = set->precedence; + new->target = nmem_strdup(service->nmem, set->target); + new->name = nmem_strdup(service->nmem, set->name); + new->value = nmem_strdup(service->nmem, set->value); + new->next = db->settings[offset]; + db->settings[offset] = new; + } +} + +// Callback -- updates database records with dictionary entries as appropriate +// This is used in pass 2 to assign name/value pairs to databases +static void update_databases(void *client_data, struct setting *set) +{ + struct conf_service *service = (struct conf_service *) client_data; + struct update_database_context context; + context.set = set; + context.service = service; + predef_grep_databases(&context, service, update_database); +} + +// This simply copies the 'hard' (application-specific) settings +// to the settings dictionary. +static void initialize_hard_settings(struct conf_service *service) { + struct setting_dictionary *dict = service->dictionary; + dict->dict = nmem_malloc(service->nmem, sizeof(hard_settings) - sizeof(char*)); + dict->size = (sizeof(hard_settings) - sizeof(char*)) / sizeof(char*); + memcpy(dict->dict, hard_settings, dict->size * sizeof(char*)); + dict->num = dict->size; } -static void prepare_dictionary(void *context, struct setting *set) +// Read any settings names introduced in service definition (config) and add to dictionary +// This is done now to avoid errors if user settings are declared in session overrides +static void initialize_soft_settings(struct conf_service *service) { + int i; + + for (i = 0; i < service->num_metadata; i++) + { + struct conf_metadata *md = &service->metadata[i]; + + if (md->setting == Metadata_setting_no) + continue; + + settings_create_offset(service, md->name); + } } -static void update_databases(void *context, struct setting *set) +static void prepare_target_dictionary(void *client_data, struct setting *set) { + struct conf_service *service = (struct conf_service *) client_data; + struct setting_dictionary *dictionary = service->dictionary; + + int i; + char *p; + + // If target address is not wildcard, add the database + if (*set->target && !zurl_wildcard(set->target)) + find_database(set->target, service); + + // Determine if we already have a dictionary entry + if (!strncmp(set->name, "pz:", 3) && (p = strchr(set->name + 3, ':'))) + *(p + 1) = '\0'; + for (i = 0; i < dictionary->num; i++) + if (!strcmp(dictionary->dict[i], set->name)) + return; + yaz_log(YLOG_WARN, "Setting '%s' not configured as metadata", set->name); } -// If we ever decide we need to be able to specify multiple settings directories, -// the two calls to read_settings must be split -- so the dictionary is prepared -// for the contents of every directory before the databases are updated. -void settings_read(const char *path) +void init_settings(struct conf_service *service) { struct setting_dictionary *new; - if (!nmem) - nmem = nmem_create(); + + assert(service->nmem); + + new = nmem_malloc(service->nmem, sizeof(*new)); + memset(new, 0, sizeof(*new)); + service->dictionary = new; + initialize_hard_settings(service); + initialize_soft_settings(service); +} + +void settings_read_file(struct conf_service *service, const char *path, + int pass) +{ + if (pass == 1) + read_settings(path, service, prepare_target_dictionary); else - nmem_reset(nmem); - new = nmem_malloc(nmem, sizeof(*new)); - memset(new, sizeof(*new), 0); - read_settings(path, new, prepare_dictionary); - read_settings(path, new, update_databases); + read_settings(path, service, update_databases); +} + +void settings_read_node(struct conf_service *service, xmlNode *n, + int pass) +{ + if (pass == 1) + settings_read_node_x(n, service, prepare_target_dictionary); + else + settings_read_node_x(n, service, update_databases); } /* * Local variables: * c-basic-offset: 4 + * c-file-style: "Stroustrup" * indent-tabs-mode: nil * End: * vim: shiftwidth=4 tabstop=8 expandtab */ +