X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=src%2Fsettings.c;h=3b7a923464a71e71a7a07ae9ddb5de5fea62bf8f;hb=04e11638dbba5080dff27666fd1bba78c5ae8acc;hp=449f7a04868daa353ad9f192e6667fb7c0e0aad0;hpb=9b4b753a6833eda435f995060f5d3f515381ce11;p=pazpar2-moved-to-github.git diff --git a/src/settings.c b/src/settings.c index 449f7a0..3b7a923 100644 --- a/src/settings.c +++ b/src/settings.c @@ -1,7 +1,5 @@ -/* $Id: settings.c,v 1.20 2007-04-23 09:06:20 marc Exp $ - Copyright (c) 2006-2007, Index Data. - -This file is part of Pazpar2. +/* This file is part of Pazpar2. + Copyright (C) 2006-2009 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,26 @@ 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 "direntz.h" #include #include @@ -42,8 +45,6 @@ Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA #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", @@ -59,6 +60,12 @@ static char *hard_settings[] = { "pz:name", "pz:queryencoding", "pz:ip", + "pz:zproxy", + "pz:apdulog", + "pz:sru", + "pz:sru_version", + "pz:pqf_prefix", + "pz:sort", 0 }; @@ -69,29 +76,32 @@ 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) +int settings_offset(struct conf_service *service, const char *name) { int i; if (!name) name = ""; - for (i = 0; i < dictionary->num; i++) - if (!strcmp(name, dictionary->dict[i])) + for (i = 0; i < service->dictionary->num; i++) + if (!strcmp(name, service->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?) -static int settings_offset_cprefix(const char *name) +int settings_offset_cprefix(struct conf_service *service, const char *name) { const char *p; int maxlen = 100; @@ -99,15 +109,15 @@ static int settings_offset_cprefix(const char *name) if (!strncmp("pz:", name, 3) && (p = strchr(name + 3, ':'))) maxlen = (p - name) + 1; - for (i = 0; i < dictionary->num; i++) - if (!strncmp(name, dictionary->dict[i], maxlen)) + for (i = 0; i < service->dictionary->num; i++) + if (!strncmp(name, service->dictionary->dict[i], maxlen)) return i; return -1; } -char *settings_name(int offset) +char *settings_name(struct conf_service *service, int offset) { - return dictionary->dict[offset]; + return service->dictionary->dict[offset]; } static int isdir(const char *path) @@ -116,26 +126,20 @@ 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)) +static void read_settings_node(xmlNode *n, + struct conf_service *service, + void (*fun)(struct conf_service *service, + struct setting *set)) { - xmlDoc *doc = xmlParseFile(path); - xmlNode *n; xmlChar *namea, *targeta, *valuea, *usera, *precedencea; - 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"); @@ -191,7 +195,7 @@ static void read_settings_file(const char *path, strcpy(valueb, (const char *) valuea); set.value = valueb; set.next = 0; - (*fun)(&set); + (*fun)(service, &set); } xmlFree(name); xmlFree(precedence); @@ -210,14 +214,34 @@ static void read_settings_file(const char *path, xmlFree(valuea); xmlFree(usera); xmlFree(targeta); +} + +static void read_settings_file(const char *path, + struct conf_service *service, + void (*fun)(struct conf_service *service, + 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); + read_settings_node(n, service, fun); xmlFreeDoc(doc); } - + + // Recursively read files or directories, invoking a // callback for each one static void read_settings(const char *path, - void (*fun)(struct setting *set)) + struct conf_service *service, + void (*fun)(struct conf_service *service, + struct setting *set)) { DIR *d; struct dirent *de; @@ -236,26 +260,38 @@ 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); + read_settings(tmp, service, fun); } 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")) + read_settings_file(path, service, 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; } // 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) +static void prepare_dictionary(struct conf_service *service, + struct setting *set) { + struct setting_dictionary *dictionary = service->dictionary; + int i; char *p; - // If target address is not wildcard, add the database - if (*set->target && set->target[strlen(set->target) - 1] != '*') - find_database(set->target, 0); - // Determine if we already have a dictionary entry if (!strncmp(set->name, "pz:", 3) && (p = strchr(set->name + 3, ':'))) *(p + 1) = '\0'; @@ -272,22 +308,33 @@ static void prepare_dictionary(struct setting *set) // Create a new dictionary entry // Grow dictionary if necessary if (!dictionary->size) - dictionary->dict = nmem_malloc(nmem, (dictionary->size = 50) * sizeof(char*)); + dictionary->dict = + nmem_malloc(service->nmem, (dictionary->size = 50) * sizeof(char*)); else if (dictionary->num + 1 > dictionary->size) { - char **tmp = nmem_malloc(nmem, dictionary->size * 2 * sizeof(char*)); + 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(nmem, set->name); + dictionary->dict[dictionary->num++] = nmem_strdup(service->nmem, set->name); } + +struct update_database_context { + struct setting *set; + struct conf_service *service; +}; + // 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 setting *) context; + struct setting *set = ((struct update_database_context *) + context)->set; + struct conf_service *service = ((struct update_database_context *) + context)->service; struct setting *s, **sp; int offset; @@ -295,22 +342,8 @@ static void update_database(void *context, struct database *db) if (!match_zurl(db->url, set->target)) return; - // 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; - } - if ((offset = settings_offset_cprefix(set->name)) < 0) - abort(); // Should never get here + if ((offset = settings_offset_cprefix(service, set->name)) < 0) + return ; // First we determine if this setting is overriding any existing settings // with the same name. @@ -320,26 +353,26 @@ static void update_database(void *context, struct database *db) { if (s->precedence < set->precedence) // We discard the value (nmem keeps track of the space) - *sp = (*sp)->next; + *sp = (*sp)->next; // unlink value from existing setting else if (s->precedence > set->precedence) - // Db contains a higher-priority setting. Abort + // Db contains a higher-priority setting. Abort search break; - if (*s->target == '*' && *set->target != '*') + if (zurl_wildcard(s->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(s->target)) + // Db already contains higher-priority setting. Abort search break; } if (!s) // s will be null when there are no higher-priority settings -- 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; } @@ -347,47 +380,107 @@ 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(struct conf_service *service, + struct setting *set) { - grep_databases(set, 0, update_database); + struct update_database_context context; + context.set = set; + context.service = service; + predef_grep_databases(&context, service, 0, update_database); } // 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 +static void initialize_soft_settings(struct conf_service *service) { - read_settings(path, prepare_dictionary); - read_settings(path, update_databases); + int i; + + for (i = 0; i < service->num_metadata; i++) + { + struct setting set; + struct conf_metadata *md = &service->metadata[i]; + + if (md->setting == Metadata_setting_no) + continue; + + set.precedence = 0; + set.target = ""; + set.name = md->name; + set.value = ""; + set.next = 0; + prepare_dictionary(service, &set); + } +} + +static void prepare_target_dictionary(struct conf_service *service, + struct setting *set) +{ + 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, 0, 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); } -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); +} + +void settings_read_file(struct conf_service *service, const char *path, + int pass) +{ + if (pass == 1) + read_settings(path, service, prepare_target_dictionary); + else + read_settings(path, service, update_databases); +} + +void settings_read_node(struct conf_service *service, xmlNode *n, + int pass) +{ + if (pass == 1) + read_settings_node(n, service, prepare_target_dictionary); + else + read_settings_node(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 */ +