X-Git-Url: http://jsfdemo.indexdata.com/?a=blobdiff_plain;f=src%2Fsettings.c;h=b70a4cc83ab93e4c25d337ad4a938d85aaedd978;hb=ed886db22397360898fa5ef764543237e99b1774;hp=6ec2d745c0bd73758f066dfbf512c9cb418eb2ce;hpb=22fd6276ea142c135f125edde76e46741bb7b545;p=pazpar2-moved-to-github.git diff --git a/src/settings.c b/src/settings.c index 6ec2d74..b70a4cc 100644 --- a/src/settings.c +++ b/src/settings.c @@ -1,35 +1,369 @@ -// $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. -// +/* $Id: settings.c,v 1.25 2007-07-03 11:21:48 adam Exp $ + Copyright (c) 2006-2007, Index Data. + +This file is part of Pazpar2. + +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 Pazpar2; see the file LICENSE. If not, write to the +Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA +02111-1307, 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. #include +#include +#include +#include +#include +#include + +#include +#include #include +#include + +#include "pazpar2.h" +#include "database.h" +#include "settings.h" static NMEM nmem = 0; -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", + 0 }; struct setting_dictionary { + char **dict; + int size; + int num; }; -// Recursively read files in a directory structure, calling -static void read_settings(const char *path, void *context, - void (*fun)(void *context, struct setting *set)) +static struct setting_dictionary *dictionary = 0; + +// Returns size of settings directory +int settings_num(void) +{ + return dictionary->num; +} + +int settings_offset(const char *name) { + int i; + + if (!name) + name = ""; + for (i = 0; i < dictionary->num; i++) + if (!strcmp(name, dictionary->dict[i])) + return i; + return -1; } -static void prepare_dictionary(void *context, struct setting *set) +// 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; + + 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)) + return i; + return -1; } -static void update_databases(void *context, struct setting *set) +char *settings_name(int offset) { + return dictionary->dict[offset]; +} + +static int isdir(const char *path) +{ + struct stat st; + + if (stat(path, &st) < 0) + { + yaz_log(YLOG_FATAL|YLOG_ERRNO, "%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)) +{ + 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"); + 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)(&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); + + 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)) +{ + 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, fun); + } + closedir(d); + } + else if ((dot = rindex(path, '.')) && !strcmp(dot + 1, "xml")) + read_settings_file(path, fun); +} + +// 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) +{ + 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'; + for (i = 0; i < dictionary->num; i++) + if (!strcmp(dictionary->dict[i], set->name)) + return; + + if (!strncmp(set->name, "pz:", 3)) // Probably a typo in config file + { + yaz_log(YLOG_FATAL, "Unknown pz: setting '%s'", set->name); + exit(1); + } + + // 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) + { + 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, 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) +{ + struct setting *set = (struct setting *) context; + struct setting *s, **sp; + int offset; + + // Is this the right database? + if (!match_zurl(db->url, 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 + + // 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)) + { + if (s->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 + break; + if (*s->target == '*' && *set->target != '*') + // target-specific value trumps wildcard. Delete. + *sp = (*sp)->next; + else if (*s->target != '*' && *set->target == '*') + // Db already contains higher-priority setting. Abort + 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)); + + 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->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(struct setting *set) +{ + predef_grep_databases(set, 0, update_database); +} + +// This simply copies the 'hard' (application-specific) settings +// to the settings dictionary. +static void initialize_hard_settings(struct setting_dictionary *dict) +{ + dict->dict = nmem_malloc(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, @@ -37,15 +371,21 @@ static void update_databases(void *context, struct setting *set) // for the contents of every directory before the databases are updated. void settings_read(const char *path) { + read_settings(path, prepare_dictionary); + read_settings(path, update_databases); +} + +void init_settings(void) +{ struct setting_dictionary *new; if (!nmem) nmem = nmem_create(); 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); + memset(new, 0, sizeof(*new)); + initialize_hard_settings(new); + dictionary = new; } /*