1 /* This file is part of Pazpar2.
2 Copyright (C) 2006-2010 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
33 #include <sys/types.h>
34 #include <yaz/dirent.h>
38 #include <libxml/parser.h>
39 #include <libxml/tree.h>
48 // Used for initializing setting_dictionary with pazpar2-specific settings
49 static char *hard_settings[] = {
71 "pz:negotiation_charset",
76 struct setting_dictionary
83 // This establishes the precedence of wildcard expressions
84 #define SETTING_WILDCARD_NO 0 // No wildcard
85 #define SETTING_WILDCARD_DB 1 // Database wildcard 'host:port/*'
86 #define SETTING_WILDCARD_YES 2 // Complete wildcard '*'
88 // Returns size of settings directory
89 int settings_num(struct conf_service *service)
91 return service->dictionary->num;
94 static int settings_lookup(struct conf_service *service, const char *name,
100 struct setting_dictionary *dictionary = service->dictionary;
104 if (!strncmp("pz:", name, 3) && (p = strchr(name + 3, ':')))
105 maxlen = (p - name) + 1;
107 maxlen = strlen(name) + 1;
108 for (i = 0; i < dictionary->num; i++)
109 if (!strncmp(name, dictionary->dict[i], maxlen))
113 if (!strncmp("pz:", name, 3))
114 yaz_log(YLOG_WARN, "Adding pz-type setting name %s", name);
115 if (dictionary->num + 1 > dictionary->size)
118 nmem_malloc(service->nmem, dictionary->size * 2 * sizeof(char*));
119 memcpy(tmp, dictionary->dict, dictionary->size * sizeof(char*));
120 dictionary->dict = tmp;
121 dictionary->size *= 2;
123 dictionary->dict[dictionary->num] = nmem_strdup(service->nmem, name);
124 dictionary->dict[dictionary->num][maxlen-1] = '\0';
125 return dictionary->num++;
128 int settings_create_offset(struct conf_service *service, const char *name)
130 return settings_lookup(service, name, 1);
133 int settings_lookup_offset(struct conf_service *service, const char *name)
135 return settings_lookup(service, name, 0);
138 char *settings_name(struct conf_service *service, int offset)
140 assert(offset < service->dictionary->num);
141 return service->dictionary->dict[offset];
144 static int isdir(const char *path)
148 if (stat(path, &st) < 0)
150 yaz_log(YLOG_FATAL|YLOG_ERRNO, "stat %s", path);
153 return st.st_mode & S_IFDIR;
156 // Read settings from an XML file, calling handler function for each setting
157 void settings_read_node_x(xmlNode *n,
159 void (*fun)(void *client_data,
160 struct setting *set))
162 xmlChar *namea, *targeta, *valuea, *usera, *precedencea;
164 namea = xmlGetProp(n, (xmlChar *) "name");
165 targeta = xmlGetProp(n, (xmlChar *) "target");
166 valuea = xmlGetProp(n, (xmlChar *) "value");
167 usera = xmlGetProp(n, (xmlChar *) "user");
168 precedencea = xmlGetProp(n, (xmlChar *) "precedence");
169 for (n = n->children; n; n = n->next)
171 if (n->type != XML_ELEMENT_NODE)
173 if (!strcmp((const char *) n->name, "set"))
175 char *name, *target, *value, *user, *precedence;
177 name = (char *) xmlGetProp(n, (xmlChar *) "name");
178 target = (char *) xmlGetProp(n, (xmlChar *) "target");
179 value = (char *) xmlGetProp(n, (xmlChar *) "value");
180 user = (char *) xmlGetProp(n, (xmlChar *) "user");
181 precedence = (char *) xmlGetProp(n, (xmlChar *) "precedence");
183 if ((!name && !namea) || (!value && !valuea) || (!target && !targeta))
185 yaz_log(YLOG_FATAL, "set must specify name, value, and target");
195 // Copy everything into a temporary buffer -- we decide
196 // later if we are keeping it.
198 set.precedence = atoi((char *) precedence);
199 else if (precedencea)
200 set.precedence = atoi((char *) precedencea);
204 strcpy(targetb, target);
206 strcpy(targetb, (const char *) targeta);
207 set.target = targetb;
211 strcpy(nameb, (const char *) namea);
214 strcpy(valueb, value);
216 strcpy(valueb, (const char *) valuea);
219 (*fun)(client_data, &set);
229 yaz_log(YLOG_FATAL, "Unknown element %s in settings file", (char*) n->name);
234 xmlFree(precedencea);
240 static void read_settings_file(const char *path,
242 void (*fun)(void *client_data,
243 struct setting *set))
245 xmlDoc *doc = xmlParseFile(path);
250 yaz_log(YLOG_FATAL, "Failed to parse %s", path);
253 n = xmlDocGetRootElement(doc);
254 settings_read_node_x(n, client_data, fun);
260 // Recursively read files or directories, invoking a
261 // callback for each one
262 static void read_settings(const char *path,
264 void (*fun)(void *client_data,
265 struct setting *set))
273 if (!(d = opendir(path)))
275 yaz_log(YLOG_FATAL|YLOG_ERRNO, "%s", path);
278 while ((de = readdir(d)))
281 if (*de->d_name == '.' || !strcmp(de->d_name, "CVS"))
283 sprintf(tmp, "%s/%s", path, de->d_name);
284 read_settings(tmp, client_data, fun);
288 else if ((dot = strrchr(path, '.')) && !strcmp(dot + 1, "xml"))
289 read_settings_file(path, client_data, fun);
292 // Determines if a ZURL is a wildcard, and what kind
293 static int zurl_wildcard(const char *zurl)
296 return SETTING_WILDCARD_NO;
298 return SETTING_WILDCARD_YES;
299 else if (*(zurl + strlen(zurl) - 1) == '*')
300 return SETTING_WILDCARD_DB;
302 return SETTING_WILDCARD_NO;
305 struct update_database_context {
307 struct conf_service *service;
310 void expand_settings_array(struct setting ***set_ar, int *num, int offset,
317 int i, n_num = offset + 10;
318 struct setting **n_ar = nmem_malloc(nmem, n_num * sizeof(*n_ar));
319 for (i = 0; i < *num; i++)
320 n_ar[i] = (*set_ar)[i];
321 for (; i < n_num; i++)
328 // This is called from grep_databases -- adds/overrides setting for a target
329 // This is also where the rules for precedence of settings are implemented
330 static void update_database(void *context, struct database *db)
332 struct setting *set = ((struct update_database_context *)
334 struct conf_service *service = ((struct update_database_context *)
339 // Is this the right database?
340 if (!match_zurl(db->url, set->target))
343 offset = settings_create_offset(service, set->name);
344 expand_settings_array(&db->settings, &db->num_settings, offset,
347 // First we determine if this setting is overriding any existing settings
348 // with the same name.
349 assert(offset < db->num_settings);
350 for (sp = &db->settings[offset]; *sp; )
351 if (!strcmp((*sp)->name, set->name))
353 if ((*sp)->precedence < set->precedence)
355 // We discard the value (nmem keeps track of the space)
356 *sp = (*sp)->next; // unlink value from existing setting
358 else if ((*sp)->precedence > set->precedence)
360 // Db contains a higher-priority setting. Abort search
363 else if (zurl_wildcard((*sp)->target) > zurl_wildcard(set->target))
365 // target-specific value trumps wildcard. Delete.
366 *sp = (*sp)->next; // unlink.....
368 else if (zurl_wildcard((*sp)->target) < zurl_wildcard(set->target))
369 // Db already contains higher-priority setting. Abort search
376 if (!*sp) // is null when there are no higher-priority settings, so we add one
378 struct setting *new = nmem_malloc(service->nmem, sizeof(*new));
380 memset(new, 0, sizeof(*new));
381 new->precedence = set->precedence;
382 new->target = nmem_strdup(service->nmem, set->target);
383 new->name = nmem_strdup(service->nmem, set->name);
384 new->value = nmem_strdup(service->nmem, set->value);
385 new->next = db->settings[offset];
386 db->settings[offset] = new;
390 // Callback -- updates database records with dictionary entries as appropriate
391 // This is used in pass 2 to assign name/value pairs to databases
392 static void update_databases(void *client_data, struct setting *set)
394 struct conf_service *service = (struct conf_service *) client_data;
395 struct update_database_context context;
397 context.service = service;
398 predef_grep_databases(&context, service, update_database);
401 // This simply copies the 'hard' (application-specific) settings
402 // to the settings dictionary.
403 static void initialize_hard_settings(struct conf_service *service)
405 struct setting_dictionary *dict = service->dictionary;
406 dict->dict = nmem_malloc(service->nmem, sizeof(hard_settings) - sizeof(char*));
407 dict->size = (sizeof(hard_settings) - sizeof(char*)) / sizeof(char*);
408 memcpy(dict->dict, hard_settings, dict->size * sizeof(char*));
409 dict->num = dict->size;
412 // Read any settings names introduced in service definition (config) and add to dictionary
413 // This is done now to avoid errors if user settings are declared in session overrides
414 static void initialize_soft_settings(struct conf_service *service)
418 for (i = 0; i < service->num_metadata; i++)
420 struct conf_metadata *md = &service->metadata[i];
422 if (md->setting == Metadata_setting_no)
425 settings_create_offset(service, md->name);
429 static void prepare_target_dictionary(void *client_data, struct setting *set)
431 struct conf_service *service = (struct conf_service *) client_data;
432 struct setting_dictionary *dictionary = service->dictionary;
437 // If target address is not wildcard, add the database
438 if (*set->target && !zurl_wildcard(set->target))
439 find_database(set->target, service);
441 // Determine if we already have a dictionary entry
442 if (!strncmp(set->name, "pz:", 3) && (p = strchr(set->name + 3, ':')))
444 for (i = 0; i < dictionary->num; i++)
445 if (!strcmp(dictionary->dict[i], set->name))
447 yaz_log(YLOG_WARN, "Setting '%s' not configured as metadata", set->name);
450 void init_settings(struct conf_service *service)
452 struct setting_dictionary *new;
454 assert(service->nmem);
456 new = nmem_malloc(service->nmem, sizeof(*new));
457 memset(new, 0, sizeof(*new));
458 service->dictionary = new;
459 initialize_hard_settings(service);
460 initialize_soft_settings(service);
463 void settings_read_file(struct conf_service *service, const char *path,
467 read_settings(path, service, prepare_target_dictionary);
469 read_settings(path, service, update_databases);
472 void settings_read_node(struct conf_service *service, xmlNode *n,
476 settings_read_node_x(n, service, prepare_target_dictionary);
478 settings_read_node_x(n, service, update_databases);
484 * c-file-style: "Stroustrup"
485 * indent-tabs-mode: nil
487 * vim: shiftwidth=4 tabstop=8 expandtab