1 /* This file is part of Pazpar2.
2 Copyright (C) 2006-2011 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",
73 "pz:reuse_connections", /* PZ_REUSE_CONNECTION */
74 "pz:termlist_term_sort", /* PZ_TERMLIST_TERM_SORT */
75 "pz:termlist_term_count", /* PZ_TERMLIST_TERM_COUNT */
76 "pz:termlist_term_factor", /* PZ_TERMLIST_TERM_FACTOR*/
77 "pz:preferred", /* PZ_PREFERRED */
81 struct setting_dictionary
88 // This establishes the precedence of wildcard expressions
89 #define SETTING_WILDCARD_NO 0 // No wildcard
90 #define SETTING_WILDCARD_DB 1 // Database wildcard 'host:port/*'
91 #define SETTING_WILDCARD_YES 2 // Complete wildcard '*'
93 // Returns size of settings directory
94 int settings_num(struct conf_service *service)
96 return service->dictionary->num;
99 static int settings_lookup(struct conf_service *service, const char *name,
105 struct setting_dictionary *dictionary = service->dictionary;
109 if (!strncmp("pz:", name, 3) && (p = strchr(name + 3, ':')))
110 maxlen = (p - name) + 1;
112 maxlen = strlen(name) + 1;
113 for (i = 0; i < dictionary->num; i++)
114 if (!strncmp(name, dictionary->dict[i], maxlen))
118 if (!strncmp("pz:", name, 3))
119 yaz_log(YLOG_WARN, "Adding pz-type setting name %s", name);
120 if (dictionary->num + 1 > dictionary->size)
123 nmem_malloc(service->nmem, dictionary->size * 2 * sizeof(char*));
124 memcpy(tmp, dictionary->dict, dictionary->size * sizeof(char*));
125 dictionary->dict = tmp;
126 dictionary->size *= 2;
128 dictionary->dict[dictionary->num] = nmem_strdup(service->nmem, name);
129 dictionary->dict[dictionary->num][maxlen-1] = '\0';
130 return dictionary->num++;
133 int settings_create_offset(struct conf_service *service, const char *name)
135 return settings_lookup(service, name, 1);
138 int settings_lookup_offset(struct conf_service *service, const char *name)
140 return settings_lookup(service, name, 0);
143 char *settings_name(struct conf_service *service, int offset)
145 assert(offset < service->dictionary->num);
146 return service->dictionary->dict[offset];
149 static int isdir(const char *path)
153 if (stat(path, &st) < 0)
155 yaz_log(YLOG_FATAL|YLOG_ERRNO, "stat %s", path);
158 return st.st_mode & S_IFDIR;
161 // Read settings from an XML file, calling handler function for each setting
162 void settings_read_node_x(xmlNode *n,
164 void (*fun)(void *client_data,
165 struct setting *set))
167 xmlChar *namea, *targeta, *valuea, *usera, *precedencea;
169 namea = xmlGetProp(n, (xmlChar *) "name");
170 targeta = xmlGetProp(n, (xmlChar *) "target");
171 valuea = xmlGetProp(n, (xmlChar *) "value");
172 usera = xmlGetProp(n, (xmlChar *) "user");
173 precedencea = xmlGetProp(n, (xmlChar *) "precedence");
174 for (n = n->children; n; n = n->next)
176 if (n->type != XML_ELEMENT_NODE)
178 if (!strcmp((const char *) n->name, "set"))
180 char *name, *target, *value, *user, *precedence;
182 name = (char *) xmlGetProp(n, (xmlChar *) "name");
183 target = (char *) xmlGetProp(n, (xmlChar *) "target");
184 value = (char *) xmlGetProp(n, (xmlChar *) "value");
185 user = (char *) xmlGetProp(n, (xmlChar *) "user");
186 precedence = (char *) xmlGetProp(n, (xmlChar *) "precedence");
188 if ((!name && !namea) || (!value && !valuea) || (!target && !targeta))
190 yaz_log(YLOG_FATAL, "set must specify name, value, and target");
200 // Copy everything into a temporary buffer -- we decide
201 // later if we are keeping it.
203 set.precedence = atoi((char *) precedence);
204 else if (precedencea)
205 set.precedence = atoi((char *) precedencea);
209 strcpy(targetb, target);
211 strcpy(targetb, (const char *) targeta);
212 set.target = targetb;
216 strcpy(nameb, (const char *) namea);
219 strcpy(valueb, value);
221 strcpy(valueb, (const char *) valuea);
224 (*fun)(client_data, &set);
234 yaz_log(YLOG_FATAL, "Unknown element %s in settings file", (char*) n->name);
239 xmlFree(precedencea);
245 static void read_settings_file(const char *path,
247 void (*fun)(void *client_data,
248 struct setting *set))
250 xmlDoc *doc = xmlParseFile(path);
255 yaz_log(YLOG_FATAL, "Failed to parse %s", path);
258 n = xmlDocGetRootElement(doc);
259 settings_read_node_x(n, client_data, fun);
265 // Recursively read files or directories, invoking a
266 // callback for each one
267 static void read_settings(const char *path,
269 void (*fun)(void *client_data,
270 struct setting *set))
278 if (!(d = opendir(path)))
280 yaz_log(YLOG_FATAL|YLOG_ERRNO, "%s", path);
283 while ((de = readdir(d)))
286 if (*de->d_name == '.' || !strcmp(de->d_name, "CVS"))
288 sprintf(tmp, "%s/%s", path, de->d_name);
289 read_settings(tmp, client_data, fun);
293 else if ((dot = strrchr(path, '.')) && !strcmp(dot + 1, "xml"))
294 read_settings_file(path, client_data, fun);
297 // Determines if a ZURL is a wildcard, and what kind
298 static int zurl_wildcard(const char *zurl)
301 return SETTING_WILDCARD_NO;
303 return SETTING_WILDCARD_YES;
304 else if (*(zurl + strlen(zurl) - 1) == '*')
305 return SETTING_WILDCARD_DB;
307 return SETTING_WILDCARD_NO;
310 struct update_database_context {
312 struct conf_service *service;
315 void expand_settings_array(struct setting ***set_ar, int *num, int offset,
322 int i, n_num = offset + 10;
323 struct setting **n_ar = nmem_malloc(nmem, n_num * sizeof(*n_ar));
324 for (i = 0; i < *num; i++)
325 n_ar[i] = (*set_ar)[i];
326 for (; i < n_num; i++)
333 // This is called from grep_databases -- adds/overrides setting for a target
334 // This is also where the rules for precedence of settings are implemented
335 static void update_database(void *context, struct database *db)
337 struct setting *set = ((struct update_database_context *)
339 struct conf_service *service = ((struct update_database_context *)
344 // Is this the right database?
345 if (!match_zurl(db->url, set->target))
348 offset = settings_create_offset(service, set->name);
349 expand_settings_array(&db->settings, &db->num_settings, offset,
352 // First we determine if this setting is overriding any existing settings
353 // with the same name.
354 assert(offset < db->num_settings);
355 for (sp = &db->settings[offset]; *sp; )
356 if (!strcmp((*sp)->name, set->name))
358 if ((*sp)->precedence < set->precedence)
360 // We discard the value (nmem keeps track of the space)
361 *sp = (*sp)->next; // unlink value from existing setting
363 else if ((*sp)->precedence > set->precedence)
365 // Db contains a higher-priority setting. Abort search
368 else if (zurl_wildcard((*sp)->target) > zurl_wildcard(set->target))
370 // target-specific value trumps wildcard. Delete.
371 *sp = (*sp)->next; // unlink.....
373 else if (zurl_wildcard((*sp)->target) < zurl_wildcard(set->target))
374 // Db already contains higher-priority setting. Abort search
381 if (!*sp) // is null when there are no higher-priority settings, so we add one
383 struct setting *new = nmem_malloc(service->nmem, sizeof(*new));
385 memset(new, 0, sizeof(*new));
386 new->precedence = set->precedence;
387 new->target = nmem_strdup(service->nmem, set->target);
388 new->name = nmem_strdup(service->nmem, set->name);
389 new->value = nmem_strdup(service->nmem, set->value);
390 new->next = db->settings[offset];
391 db->settings[offset] = new;
395 // Callback -- updates database records with dictionary entries as appropriate
396 // This is used in pass 2 to assign name/value pairs to databases
397 static void update_databases(void *client_data, struct setting *set)
399 struct conf_service *service = (struct conf_service *) client_data;
400 struct update_database_context context;
402 context.service = service;
403 predef_grep_databases(&context, service, update_database);
406 // This simply copies the 'hard' (application-specific) settings
407 // to the settings dictionary.
408 static void initialize_hard_settings(struct conf_service *service)
410 struct setting_dictionary *dict = service->dictionary;
411 dict->dict = nmem_malloc(service->nmem, sizeof(hard_settings) - sizeof(char*));
412 dict->size = (sizeof(hard_settings) - sizeof(char*)) / sizeof(char*);
413 memcpy(dict->dict, hard_settings, dict->size * sizeof(char*));
414 dict->num = dict->size;
417 // Read any settings names introduced in service definition (config) and add to dictionary
418 // This is done now to avoid errors if user settings are declared in session overrides
419 static void initialize_soft_settings(struct conf_service *service)
423 for (i = 0; i < service->num_metadata; i++)
425 struct conf_metadata *md = &service->metadata[i];
427 if (md->setting == Metadata_setting_no)
430 settings_create_offset(service, md->name);
434 static void prepare_target_dictionary(void *client_data, struct setting *set)
436 struct conf_service *service = (struct conf_service *) client_data;
437 struct setting_dictionary *dictionary = service->dictionary;
442 // If target address is not wildcard, add the database
443 if (*set->target && !zurl_wildcard(set->target))
444 find_database(set->target, service);
446 // Determine if we already have a dictionary entry
447 if (!strncmp(set->name, "pz:", 3) && (p = strchr(set->name + 3, ':')))
449 for (i = 0; i < dictionary->num; i++)
450 if (!strcmp(dictionary->dict[i], set->name))
452 yaz_log(YLOG_WARN, "Setting '%s' not configured as metadata", set->name);
455 void init_settings(struct conf_service *service)
457 struct setting_dictionary *new;
459 assert(service->nmem);
461 new = nmem_malloc(service->nmem, sizeof(*new));
462 memset(new, 0, sizeof(*new));
463 service->dictionary = new;
464 initialize_hard_settings(service);
465 initialize_soft_settings(service);
468 void settings_read_file(struct conf_service *service, const char *path,
472 read_settings(path, service, prepare_target_dictionary);
474 read_settings(path, service, update_databases);
477 void settings_read_node(struct conf_service *service, xmlNode *n,
481 settings_read_node_x(n, service, prepare_target_dictionary);
483 settings_read_node_x(n, service, update_databases);
489 * c-file-style: "Stroustrup"
490 * indent-tabs-mode: nil
492 * vim: shiftwidth=4 tabstop=8 expandtab