X-Git-Url: http://git.indexdata.com/?p=pazpar2-moved-to-github.git;a=blobdiff_plain;f=src%2Fsettings.c;h=1c52b3005dd2ba42063b38cbb4370555961d24bd;hp=8cc5e6c02433d48076f0cb18d66c7ef173f7e99b;hb=HEAD;hpb=dc9f59ce5f4bedc6cd1cc68e0309b74d241f434d diff --git a/src/settings.c b/src/settings.c index 8cc5e6c..1c52b30 100644 --- a/src/settings.c +++ b/src/settings.c @@ -1,7 +1,5 @@ -/* $Id: settings.c,v 1.23 2007-06-06 11:49:48 marc Exp $ - Copyright (c) 2006-2007, Index Data. - -This file is part of Pazpar2. +/* This file is part of Pazpar2. + Copyright (C) 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 @@ -14,21 +12,27 @@ 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 Pazpar2; see the file LICENSE. If not, write to the -Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA -02111-1307, USA. - */ +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 @@ -38,12 +42,10 @@ Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA #include #include -#include "pazpar2.h" +#include "session.h" #include "database.h" #include "settings.h" -static NMEM nmem = 0; - // Used for initializing setting_dictionary with pazpar2-specific settings static char *hard_settings[] = { "pz:piggyback", @@ -58,8 +60,34 @@ static char *hard_settings[] = { "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", + "pz:max_connections", + "pz:reuse_connections", + "pz:termlist_term_factor", + "pz:termlist_term_count", + "pz:preferred", + "pz:extra_args", + "pz:query_syntax", + "pz:facetmap:", + "pz:limitmap:", + "pz:url", + "pz:sortmap:", + "pz:present_chunk", + "pz:block_timeout", + "pz:extendrecs", + "pz:authentication_mode", + "pz:native_score", + "pz:memcached", + "pz:redis", + "pz:timeout", 0 }; @@ -70,45 +98,64 @@ struct setting_dictionary int num; }; -static struct setting_dictionary *dictionary = 0; +// 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(void) +int settings_num(struct conf_service *service) { - return dictionary->num; + return service->dictionary->num; } -int settings_offset(const char *name) +/* Find and possible create a new dictionary entry. Pass valid NMEM pointer if creation is allowed, otherwise null */ +static int settings_index_lookup(struct setting_dictionary *dictionary, const char *name, NMEM nmem) { + size_t maxlen; int i; - - if (!name) - name = ""; - for (i = 0; i < dictionary->num; i++) - if (!strcmp(name, dictionary->dict[i])) - return i; - return -1; -} - -// Ignores everything after second colon, if present -// A bit of a hack to support the pz:cclmap: scheme (and more to come?) -int settings_offset_cprefix(const char *name) -{ const char *p; - int maxlen = 100; - int i; + + 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; - return -1; + if (!nmem) + 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(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(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_index_lookup(service->dictionary, name, service->nmem); +} + +int settings_lookup_offset(struct conf_service *service, const char *name) +{ + return settings_index_lookup(service->dictionary, name, 0); } -char *settings_name(int offset) +char *settings_name(struct conf_service *service, int offset) { - return dictionary->dict[offset]; + assert(offset < service->dictionary->num); + return service->dictionary->dict[offset]; } static int isdir(const char *path) @@ -117,109 +164,130 @@ static int isdir(const char *path) if (stat(path, &st) < 0) { - yaz_log(YLOG_FATAL|YLOG_ERRNO, "%s", path); + 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 -static void read_settings_file(const char *path, - void (*fun)(struct setting *set)) +int settings_read_node_x(xmlNode *n, + void *client_data, + void (*fun)(void *client_data, + struct setting *set)) { - xmlDoc *doc = xmlParseFile(path); - xmlNode *n; - xmlChar *namea, *targeta, *valuea, *usera, *precedencea; + int ret_val = 0; /* success */ + const char *namea = yaz_xml_get_prop(n, "name"); + const char *targeta = yaz_xml_get_prop(n, "target"); + const char *valuea = yaz_xml_get_prop(n, "value"); + const char *precedencea = yaz_xml_get_prop(n, "precedence"); - if (!doc) - { - yaz_log(YLOG_FATAL, "Failed to parse %s", path); - exit(1); - } - n = xmlDocGetRootElement(doc); - 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; + xmlNode *root = n->children; + struct setting set; + const char *name = yaz_xml_get_prop(n, "name"); + const char *target = yaz_xml_get_prop(n, "target"); + const char *value = yaz_xml_get_prop(n, "value"); + const char *precedence = yaz_xml_get_prop(n, "precedence"); + xmlChar *buf_out = 0; + + set.next = 0; + + if (precedence) + set.precedence = atoi((char *) precedence); + else if (precedencea) + set.precedence = atoi((char *) precedencea); + else + set.precedence = 0; - 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"); + set.target = target ? target : targeta; + set.name = name ? name : namea; - if ((!name && !namea) || (!value && !valuea) || (!target && !targeta)) - { - yaz_log(YLOG_FATAL, "set must specify name, value, and target"); - exit(1); + while (root && root->type != XML_ELEMENT_NODE) + root = root->next; + if (!root) + set.value = value ? value : valuea; + else + { /* xml document content for this setting */ + xmlDoc *doc = xmlNewDoc(BAD_CAST "1.0"); + if (!doc) + { + if (set.name) + yaz_log(YLOG_WARN, "bad XML content for setting " + "name=%s", set.name); + else + yaz_log(YLOG_WARN, "bad XML content for setting"); + ret_val = -1; + } + else + { + int len_out; + xmlDocSetRootElement(doc, xmlCopyNode(root, 1)); + xmlDocDumpMemory(doc, &buf_out, &len_out); + /* xmlDocDumpMemory 0-terminates */ + set.value = (const char *) buf_out; + xmlFreeDoc(doc); + } } + + if (set.name && set.value && set.target) + (*fun)(client_data, &set); 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); + if (set.name) + yaz_log(YLOG_WARN, "missing value and/or target for " + "setting name=%s", set.name); 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)(&set); + yaz_log(YLOG_WARN, "missing name/value/target for setting"); + ret_val = -1; } - xmlFree(name); - xmlFree(precedence); - xmlFree(value); - xmlFree(user); - xmlFree(target); + xmlFree(buf_out); } else { - yaz_log(YLOG_FATAL, "Unknown element %s in settings file", (char*) n->name); - exit(1); + yaz_log(YLOG_WARN, "Unknown element %s in settings file", + (char*) n->name); + ret_val = -1; } } - xmlFree(namea); - xmlFree(precedencea); - xmlFree(valuea); - xmlFree(usera); - xmlFree(targeta); + return ret_val; +} + +static int read_settings_file(const char *path, + void *client_data, + void (*fun)(void *client_data, + struct setting *set)) +{ + xmlDoc *doc = xmlParseFile(path); + xmlNode *n; + int ret; + + if (!doc) + { + yaz_log(YLOG_FATAL, "Failed to parse %s", path); + return -1; + } + n = xmlDocGetRootElement(doc); + ret = settings_read_node_x(n, client_data, fun); xmlFreeDoc(doc); + return ret; } - -// Recursively read files or directories, invoking a + + +// Recursively read files or directories, invoking a // callback for each one -static void read_settings(const char *path, - void (*fun)(struct setting *set)) +static int read_settings(const char *path, + void *client_data, + void (*fun)(void *client_data, + struct setting *set)) { + int ret = 0; DIR *d; struct dirent *de; char *dot; @@ -229,7 +297,7 @@ static void read_settings(const char *path, if (!(d = opendir(path))) { yaz_log(YLOG_FATAL|YLOG_ERRNO, "%s", path); - exit(1); + return -1; } while ((de = readdir(d))) { @@ -237,112 +305,174 @@ static void read_settings(const char *path, if (*de->d_name == '.' || !strcmp(de->d_name, "CVS")) continue; sprintf(tmp, "%s/%s", path, de->d_name); - read_settings(tmp, fun); + if (read_settings(tmp, client_data, fun)) + ret = -1; } closedir(d); } - else if ((dot = rindex(path, '.')) && !strcmp(dot + 1, "xml")) - read_settings_file(path, fun); + else if ((dot = strrchr(path, '.')) && !strcmp(dot + 1, "xml")) + ret = read_settings_file(path, client_data, fun); + return ret; } -// Callback. Adds a new entry to the dictionary if necessary -// This is used in pass 1 to determine layout of dictionary -// and to load any databases mentioned -static void prepare_dictionary(struct setting *set) +// Determines if a ZURL is a wildcard, and what kind +static int zurl_wildcard(const char *zurl) { - int i; - char *p; + 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; +} - // If target address is not wildcard, add the database - if (*set->target && set->target[strlen(set->target) - 1] != '*') - find_database(set->target, 0); +struct update_database_context { + struct setting *set; + struct conf_service *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; +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; + } +} + +void expand_settings_array2(struct settings_array *settings, int offset, NMEM nmem) +{ + assert(offset >= 0); + assert(settings); + if (offset >= settings->num_settings) + { + int i, n_num = offset + 10; + struct setting **n_ar = nmem_malloc(nmem, n_num * sizeof(*n_ar)); + for (i = 0; i < settings->num_settings; i++) + n_ar[i] = settings->settings[i]; + for (; i < n_num; i++) + n_ar[i] = 0; + settings->num_settings = n_num; + settings->settings = n_ar; + } +} + +static void update_settings(struct setting *set, struct settings_array *settings, int offset, NMEM nmem) +{ + struct setting **sp; + yaz_log(YLOG_DEBUG, "update service settings offset %d with %s=%s", offset, set->name, set->value); + expand_settings_array2(settings, offset, nmem); - if (!strncmp(set->name, "pz:", 3)) // Probably a typo in config file + // First we determine if this setting is overriding any existing settings + // with the same name. + assert(offset < settings->num_settings); + for (sp = &settings->settings[offset]; *sp; ) + if (!strcmp((*sp)->name, set->name)) { - yaz_log(YLOG_FATAL, "Unknown pz: setting '%s'", set->name); - exit(1); + 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; } - - // Create a new dictionary entry - // Grow dictionary if necessary - if (!dictionary->size) - dictionary->dict = nmem_malloc(nmem, (dictionary->size = 50) * sizeof(char*)); - else if (dictionary->num + 1 > dictionary->size) + else + sp = &(*sp)->next; + if (!*sp) // is null when there are no higher-priority settings, so we add one { - char **tmp = nmem_malloc(nmem, dictionary->size * 2 * sizeof(char*)); - memcpy(tmp, dictionary->dict, dictionary->size * sizeof(char*)); - dictionary->dict = tmp; - dictionary->size *= 2; + struct setting *new = nmem_malloc(nmem, sizeof(*new)); + memset(new, 0, sizeof(*new)); + new->precedence = set->precedence; + new->target = nmem_strdup_null(nmem, set->target); + new->name = nmem_strdup_null(nmem, set->name); + new->value = nmem_strdup_null(nmem, set->value); + new->next = settings->settings[offset]; + settings->settings[offset] = new; } - dictionary->dict[dictionary->num++] = nmem_strdup(nmem, set->name); } + // 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) +static void update_database_fun(void *context, struct database *db) { - struct setting *set = (struct setting *) context; - struct setting *s, **sp; + 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)) + if (!match_zurl(db->id, set->target)) return; -#ifdef GAGA - // Initialize settings array if it doesn't exist. - // If so, also set the 'id' automatic setting - if (!db->settings) - { - struct setting *id = nmem_malloc(nmem, sizeof(struct setting)); - - db->settings = nmem_malloc(nmem, sizeof(struct settings*) * dictionary->num); - memset(db->settings, 0, sizeof(struct settings*) * dictionary->num); - id->precedence = 0; - id->name = "pz:id"; - id->target = id->value = db->url; - id->next = 0; - db->settings[PZ_ID] = id; - } -#endif - if ((offset = settings_offset_cprefix(set->name)) < 0) - abort(); // Should never get here + 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. - for (s = db->settings[offset], sp = &db->settings[offset]; s; - sp = &s->next, s = s->next) - if (!strcmp(s->name, set->name)) + assert(offset < db->num_settings); + for (sp = &db->settings[offset]; *sp; ) + if (!strcmp((*sp)->name, set->name)) { - if (s->precedence < set->precedence) + if ((*sp)->precedence < set->precedence) + { // We discard the value (nmem keeps track of the space) - *sp = (*sp)->next; - else if (s->precedence > set->precedence) - // Db contains a higher-priority setting. Abort + *sp = (*sp)->next; // unlink value from existing setting + } + else if ((*sp)->precedence > set->precedence) + { + // Db contains a higher-priority setting. Abort search break; - if (*s->target == '*' && *set->target != '*') + } + else if (zurl_wildcard((*sp)->target) > zurl_wildcard(set->target)) + { // target-specific value trumps wildcard. Delete. - *sp = (*sp)->next; - else if (*s->target != '*' && *set->target == '*') - // Db already contains higher-priority setting. Abort + *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; } - if (!s) // s will be null when there are no higher-priority settings -- we add one + else + sp = &(*sp)->next; + if (!*sp) // is null when there are no higher-priority settings, so we add one { - struct setting *new = nmem_malloc(nmem, sizeof(*new)); + struct setting *new = nmem_malloc(service->nmem, sizeof(*new)); memset(new, 0, sizeof(*new)); new->precedence = set->precedence; - new->target = nmem_strdup(nmem, set->target); - new->name = nmem_strdup(nmem, set->name); - new->value = nmem_strdup(nmem, set->value); + 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; } @@ -350,47 +480,110 @@ static void update_database(void *context, struct database *db) // 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(struct setting *set) +static void update_databases(void *client_data, struct setting *set) { - grep_databases(set, 0, update_database); + 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_fun); } // This simply copies the 'hard' (application-specific) settings // to the settings dictionary. -static void initialize_hard_settings(struct setting_dictionary *dict) +static void initialize_hard_settings(struct conf_service *service) { - dict->dict = nmem_malloc(nmem, sizeof(hard_settings) - sizeof(char*)); + 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; } -// 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) +// 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 +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) + settings_create_offset(service, md->name); + + // Also create setting for some metadata attributes. + if (md->limitmap) { + int index; + WRBUF wrbuf = wrbuf_alloc(); + yaz_log(YLOG_DEBUG, "Metadata %s has limitmap: %s ",md->name, md->limitmap); + wrbuf_printf(wrbuf, "pz:limitmap:%s", md->name); + index = settings_create_offset(service, wrbuf_cstr(wrbuf)); + if (index >= 0) { + struct setting new; + int offset; + yaz_log(YLOG_DEBUG, "Service %s default %s=%s", + (service->id ? service->id: "unknown"), wrbuf_cstr(wrbuf), md->limitmap); + new.name = (char *) wrbuf_cstr(wrbuf); + new.value = md->limitmap; + new.next = 0; + new.target = 0; + new.precedence = 0; + offset = settings_create_offset(service, new.name); + update_settings(&new, service->settings, offset, service->nmem); + } + wrbuf_destroy(wrbuf); + // TODO same for facetmap + } + } +} + +static void prepare_target_dictionary(void *client_data, struct setting *set) { - read_settings(path, prepare_dictionary); - read_settings(path, update_databases); + struct conf_service *service = (struct conf_service *) client_data; + + // If target address is not wildcard, add the database + if (*set->target && !zurl_wildcard(set->target)) + create_database_for_service(set->target, service); } -void init_settings(void) +void init_settings(struct conf_service *service) { struct setting_dictionary *new; - if (!nmem) - nmem = nmem_create(); - else - nmem_reset(nmem); - new = nmem_malloc(nmem, sizeof(*new)); + + assert(service->nmem); + + new = nmem_malloc(service->nmem, sizeof(*new)); memset(new, 0, sizeof(*new)); - initialize_hard_settings(new); - dictionary = new; + service->dictionary = new; + initialize_hard_settings(service); + initialize_soft_settings(service); +} + +int settings_read_file(struct conf_service *service, const char *path, + int pass) +{ + if (pass == 1) + return read_settings(path, service, prepare_target_dictionary); + else + return read_settings(path, service, update_databases); +} + +int settings_read_node(struct conf_service *service, xmlNode *n, + int pass) +{ + if (pass == 1) + return settings_read_node_x(n, service, prepare_target_dictionary); + else + return 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 */ +