1 /* This file is part of Pazpar2.
2 Copyright (C) 2006-2008 Index Data
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
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
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
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
32 #include <sys/types.h>
37 #include <libxml/parser.h>
38 #include <libxml/tree.h>
49 // Used for initializing setting_dictionary with pazpar2-specific settings
50 static char *hard_settings[] = {
71 struct setting_dictionary
78 static struct setting_dictionary *dictionary = 0;
80 // This establishes the precedence of wildcard expressions
81 #define SETTING_WILDCARD_NO 0 // No wildcard
82 #define SETTING_WILDCARD_DB 1 // Database wildcard 'host:port/*'
83 #define SETTING_WILDCARD_YES 2 // Complete wildcard '*'
85 // Returns size of settings directory
86 int settings_num(void)
88 return dictionary->num;
91 int settings_offset(const char *name)
97 for (i = 0; i < dictionary->num; i++)
98 if (!strcmp(name, dictionary->dict[i]))
103 // Ignores everything after second colon, if present
104 // A bit of a hack to support the pz:cclmap: scheme (and more to come?)
105 int settings_offset_cprefix(const char *name)
111 if (!strncmp("pz:", name, 3) && (p = strchr(name + 3, ':')))
112 maxlen = (p - name) + 1;
113 for (i = 0; i < dictionary->num; i++)
114 if (!strncmp(name, dictionary->dict[i], maxlen))
119 char *settings_name(int offset)
121 return dictionary->dict[offset];
124 static int isdir(const char *path)
128 if (stat(path, &st) < 0)
130 yaz_log(YLOG_FATAL|YLOG_ERRNO, "%s", path);
133 return st.st_mode & S_IFDIR;
136 // Read settings from an XML file, calling handler function for each setting
137 static void read_settings_file(const char *path,
138 void (*fun)(struct setting *set))
140 xmlDoc *doc = xmlParseFile(path);
142 xmlChar *namea, *targeta, *valuea, *usera, *precedencea;
146 yaz_log(YLOG_FATAL, "Failed to parse %s", path);
149 n = xmlDocGetRootElement(doc);
150 namea = xmlGetProp(n, (xmlChar *) "name");
151 targeta = xmlGetProp(n, (xmlChar *) "target");
152 valuea = xmlGetProp(n, (xmlChar *) "value");
153 usera = xmlGetProp(n, (xmlChar *) "user");
154 precedencea = xmlGetProp(n, (xmlChar *) "precedence");
155 for (n = n->children; n; n = n->next)
157 if (n->type != XML_ELEMENT_NODE)
159 if (!strcmp((const char *) n->name, "set"))
161 char *name, *target, *value, *user, *precedence;
163 name = (char *) xmlGetProp(n, (xmlChar *) "name");
164 target = (char *) xmlGetProp(n, (xmlChar *) "target");
165 value = (char *) xmlGetProp(n, (xmlChar *) "value");
166 user = (char *) xmlGetProp(n, (xmlChar *) "user");
167 precedence = (char *) xmlGetProp(n, (xmlChar *) "precedence");
169 if ((!name && !namea) || (!value && !valuea) || (!target && !targeta))
171 yaz_log(YLOG_FATAL, "set must specify name, value, and target");
181 // Copy everything into a temporary buffer -- we decide
182 // later if we are keeping it.
184 set.precedence = atoi((char *) precedence);
185 else if (precedencea)
186 set.precedence = atoi((char *) precedencea);
190 strcpy(targetb, target);
192 strcpy(targetb, (const char *) targeta);
193 set.target = targetb;
197 strcpy(nameb, (const char *) namea);
200 strcpy(valueb, value);
202 strcpy(valueb, (const char *) valuea);
215 yaz_log(YLOG_FATAL, "Unknown element %s in settings file", (char*) n->name);
220 xmlFree(precedencea);
228 // Recursively read files or directories, invoking a
229 // callback for each one
230 static void read_settings(const char *path,
231 void (*fun)(struct setting *set))
239 if (!(d = opendir(path)))
241 yaz_log(YLOG_FATAL|YLOG_ERRNO, "%s", path);
244 while ((de = readdir(d)))
247 if (*de->d_name == '.' || !strcmp(de->d_name, "CVS"))
249 sprintf(tmp, "%s/%s", path, de->d_name);
250 read_settings(tmp, fun);
254 else if ((dot = strrchr(path, '.')) && !strcmp(dot + 1, "xml"))
255 read_settings_file(path, fun);
258 // Determines if a ZURL is a wildcard, and what kind
259 static int zurl_wildcard(const char *zurl)
262 return SETTING_WILDCARD_NO;
264 return SETTING_WILDCARD_YES;
265 else if (*(zurl + strlen(zurl) - 1) == '*')
266 return SETTING_WILDCARD_DB;
268 return SETTING_WILDCARD_NO;
271 // Callback. Adds a new entry to the dictionary if necessary
272 // This is used in pass 1 to determine layout of dictionary
273 // and to load any databases mentioned
274 static void prepare_dictionary(struct setting *set)
279 // If target address is not wildcard, add the database
280 if (*set->target && !zurl_wildcard(set->target))
281 find_database(set->target, 0);
283 // Determine if we already have a dictionary entry
284 if (!strncmp(set->name, "pz:", 3) && (p = strchr(set->name + 3, ':')))
286 for (i = 0; i < dictionary->num; i++)
287 if (!strcmp(dictionary->dict[i], set->name))
290 if (!strncmp(set->name, "pz:", 3)) // Probably a typo in config file
292 yaz_log(YLOG_FATAL, "Unknown pz: setting '%s'", set->name);
296 // Create a new dictionary entry
297 // Grow dictionary if necessary
298 if (!dictionary->size)
299 dictionary->dict = nmem_malloc(nmem, (dictionary->size = 50) * sizeof(char*));
300 else if (dictionary->num + 1 > dictionary->size)
302 char **tmp = nmem_malloc(nmem, dictionary->size * 2 * sizeof(char*));
303 memcpy(tmp, dictionary->dict, dictionary->size * sizeof(char*));
304 dictionary->dict = tmp;
305 dictionary->size *= 2;
307 dictionary->dict[dictionary->num++] = nmem_strdup(nmem, set->name);
310 // This is called from grep_databases -- adds/overrides setting for a target
311 // This is also where the rules for precedence of settings are implemented
312 static void update_database(void *context, struct database *db)
314 struct setting *set = (struct setting *) context;
315 struct setting *s, **sp;
318 // Is this the right database?
319 if (!match_zurl(db->url, set->target))
322 if ((offset = settings_offset_cprefix(set->name)) < 0)
323 abort(); // Should never get here
325 // First we determine if this setting is overriding any existing settings
326 // with the same name.
327 for (s = db->settings[offset], sp = &db->settings[offset]; s;
328 sp = &s->next, s = s->next)
329 if (!strcmp(s->name, set->name))
331 if (s->precedence < set->precedence)
332 // We discard the value (nmem keeps track of the space)
333 *sp = (*sp)->next; // unlink value from existing setting
334 else if (s->precedence > set->precedence)
335 // Db contains a higher-priority setting. Abort search
337 if (zurl_wildcard(s->target) > zurl_wildcard(set->target))
338 // target-specific value trumps wildcard. Delete.
339 *sp = (*sp)->next; // unlink.....
340 else if (!zurl_wildcard(s->target))
341 // Db already contains higher-priority setting. Abort search
344 if (!s) // s will be null when there are no higher-priority settings -- we add one
346 struct setting *new = nmem_malloc(nmem, sizeof(*new));
348 memset(new, 0, sizeof(*new));
349 new->precedence = set->precedence;
350 new->target = nmem_strdup(nmem, set->target);
351 new->name = nmem_strdup(nmem, set->name);
352 new->value = nmem_strdup(nmem, set->value);
353 new->next = db->settings[offset];
354 db->settings[offset] = new;
358 // Callback -- updates database records with dictionary entries as appropriate
359 // This is used in pass 2 to assign name/value pairs to databases
360 static void update_databases(struct setting *set)
362 predef_grep_databases(set, 0, update_database);
365 // This simply copies the 'hard' (application-specific) settings
366 // to the settings dictionary.
367 static void initialize_hard_settings(struct setting_dictionary *dict)
369 dict->dict = nmem_malloc(nmem, sizeof(hard_settings) - sizeof(char*));
370 dict->size = (sizeof(hard_settings) - sizeof(char*)) / sizeof(char*);
371 memcpy(dict->dict, hard_settings, dict->size * sizeof(char*));
372 dict->num = dict->size;
375 // Read any settings names introduced in service definition (config) and add to dictionary
376 // This is done now to avoid errors if user settings are declared in session overrides
377 static void initialize_soft_settings()
379 struct conf_service *service = config->servers->service;
382 for (i = 0; i < service->num_metadata; i++)
385 struct conf_metadata *md = &service->metadata[i];
387 if (md->setting == Metadata_setting_no)
395 prepare_dictionary(&set);
399 // If we ever decide we need to be able to specify multiple settings directories,
400 // the two calls to read_settings must be split -- so the dictionary is prepared
401 // for the contents of every directory before the databases are updated.
402 void settings_read(const char *path)
404 read_settings(path, prepare_dictionary);
405 read_settings(path, update_databases);
408 void init_settings(void)
410 struct setting_dictionary *new;
412 nmem = nmem_create();
415 new = nmem_malloc(nmem, sizeof(*new));
416 memset(new, 0, sizeof(*new));
417 initialize_hard_settings(new);
419 initialize_soft_settings();
425 * indent-tabs-mode: nil
427 * vim: shiftwidth=4 tabstop=8 expandtab