1 /* This file is part of Pazpar2.
2 Copyright (C) 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>
35 #include <yaz/xml_get.h>
39 #include <libxml/parser.h>
40 #include <libxml/tree.h>
49 // Used for initializing setting_dictionary with pazpar2-specific settings
50 static char *hard_settings[] = {
71 "pz:negotiation_charset",
73 "pz:reuse_connections",
74 "pz:termlist_term_factor",
75 "pz:termlist_term_count",
86 "pz:authentication_mode",
94 struct setting_dictionary
101 // This establishes the precedence of wildcard expressions
102 #define SETTING_WILDCARD_NO 0 // No wildcard
103 #define SETTING_WILDCARD_DB 1 // Database wildcard 'host:port/*'
104 #define SETTING_WILDCARD_YES 2 // Complete wildcard '*'
106 // Returns size of settings directory
107 int settings_num(struct conf_service *service)
109 return service->dictionary->num;
112 /* Find and possible create a new dictionary entry. Pass valid NMEM pointer if creation is allowed, otherwise null */
113 static int settings_index_lookup(struct setting_dictionary *dictionary, const char *name, NMEM nmem)
121 if (!strncmp("pz:", name, 3) && (p = strchr(name + 3, ':')))
122 maxlen = (p - name) + 1;
124 maxlen = strlen(name) + 1;
125 for (i = 0; i < dictionary->num; i++)
126 if (!strncmp(name, dictionary->dict[i], maxlen))
130 if (!strncmp("pz:", name, 3))
131 yaz_log(YLOG_WARN, "Adding pz-type setting name %s", name);
132 if (dictionary->num + 1 > dictionary->size)
135 nmem_malloc(nmem, dictionary->size * 2 * sizeof(char*));
136 memcpy(tmp, dictionary->dict, dictionary->size * sizeof(char*));
137 dictionary->dict = tmp;
138 dictionary->size *= 2;
140 dictionary->dict[dictionary->num] = nmem_strdup(nmem, name);
141 dictionary->dict[dictionary->num][maxlen-1] = '\0';
142 return dictionary->num++;
145 int settings_create_offset(struct conf_service *service, const char *name)
147 return settings_index_lookup(service->dictionary, name, service->nmem);
150 int settings_lookup_offset(struct conf_service *service, const char *name)
152 return settings_index_lookup(service->dictionary, name, 0);
155 char *settings_name(struct conf_service *service, int offset)
157 assert(offset < service->dictionary->num);
158 return service->dictionary->dict[offset];
161 static int isdir(const char *path)
165 if (stat(path, &st) < 0)
167 yaz_log(YLOG_FATAL|YLOG_ERRNO, "stat %s", path);
170 return st.st_mode & S_IFDIR;
173 // Read settings from an XML file, calling handler function for each setting
174 int settings_read_node_x(xmlNode *n,
176 void (*fun)(void *client_data,
177 struct setting *set))
179 int ret_val = 0; /* success */
180 const char *namea = yaz_xml_get_prop(n, "name");
181 const char *targeta = yaz_xml_get_prop(n, "target");
182 const char *valuea = yaz_xml_get_prop(n, "value");
183 const char *precedencea = yaz_xml_get_prop(n, "precedence");
185 for (n = n->children; n; n = n->next)
187 if (n->type != XML_ELEMENT_NODE)
189 if (!strcmp((const char *) n->name, "set"))
191 xmlNode *root = n->children;
193 const char *name = yaz_xml_get_prop(n, "name");
194 const char *target = yaz_xml_get_prop(n, "target");
195 const char *value = yaz_xml_get_prop(n, "value");
196 const char *precedence = yaz_xml_get_prop(n, "precedence");
197 xmlChar *buf_out = 0;
202 set.precedence = atoi((char *) precedence);
203 else if (precedencea)
204 set.precedence = atoi((char *) precedencea);
208 set.target = target ? target : targeta;
209 set.name = name ? name : namea;
211 while (root && root->type != XML_ELEMENT_NODE)
214 set.value = value ? value : valuea;
216 { /* xml document content for this setting */
217 xmlDoc *doc = xmlNewDoc(BAD_CAST "1.0");
221 yaz_log(YLOG_WARN, "bad XML content for setting "
222 "name=%s", set.name);
224 yaz_log(YLOG_WARN, "bad XML content for setting");
230 xmlDocSetRootElement(doc, xmlCopyNode(root, 1));
231 xmlDocDumpMemory(doc, &buf_out, &len_out);
232 /* xmlDocDumpMemory 0-terminates */
233 set.value = (const char *) buf_out;
238 if (set.name && set.value && set.target)
239 (*fun)(client_data, &set);
243 yaz_log(YLOG_WARN, "missing value and/or target for "
244 "setting name=%s", set.name);
246 yaz_log(YLOG_WARN, "missing name/value/target for setting");
253 yaz_log(YLOG_WARN, "Unknown element %s in settings file",
261 static int read_settings_file(const char *path,
263 void (*fun)(void *client_data,
264 struct setting *set))
266 xmlDoc *doc = xmlParseFile(path);
272 yaz_log(YLOG_FATAL, "Failed to parse %s", path);
275 n = xmlDocGetRootElement(doc);
276 ret = settings_read_node_x(n, client_data, fun);
283 // Recursively read files or directories, invoking a
284 // callback for each one
285 static int read_settings(const char *path,
287 void (*fun)(void *client_data,
288 struct setting *set))
297 if (!(d = opendir(path)))
299 yaz_log(YLOG_FATAL|YLOG_ERRNO, "%s", path);
302 while ((de = readdir(d)))
305 if (*de->d_name == '.' || !strcmp(de->d_name, "CVS"))
307 sprintf(tmp, "%s/%s", path, de->d_name);
308 if (read_settings(tmp, client_data, fun))
313 else if ((dot = strrchr(path, '.')) && !strcmp(dot + 1, "xml"))
314 ret = read_settings_file(path, client_data, fun);
318 // Determines if a ZURL is a wildcard, and what kind
319 static int zurl_wildcard(const char *zurl)
322 return SETTING_WILDCARD_NO;
324 return SETTING_WILDCARD_YES;
325 else if (*(zurl + strlen(zurl) - 1) == '*')
326 return SETTING_WILDCARD_DB;
328 return SETTING_WILDCARD_NO;
331 struct update_database_context {
333 struct conf_service *service;
336 void expand_settings_array(struct setting ***set_ar, int *num, int offset,
343 int i, n_num = offset + 10;
344 struct setting **n_ar = nmem_malloc(nmem, n_num * sizeof(*n_ar));
345 for (i = 0; i < *num; i++)
346 n_ar[i] = (*set_ar)[i];
347 for (; i < n_num; i++)
354 void expand_settings_array2(struct settings_array *settings, int offset, NMEM nmem)
358 if (offset >= settings->num_settings)
360 int i, n_num = offset + 10;
361 struct setting **n_ar = nmem_malloc(nmem, n_num * sizeof(*n_ar));
362 for (i = 0; i < settings->num_settings; i++)
363 n_ar[i] = settings->settings[i];
364 for (; i < n_num; i++)
366 settings->num_settings = n_num;
367 settings->settings = n_ar;
371 static void update_settings(struct setting *set, struct settings_array *settings, int offset, NMEM nmem)
374 yaz_log(YLOG_DEBUG, "update service settings offset %d with %s=%s", offset, set->name, set->value);
375 expand_settings_array2(settings, offset, nmem);
377 // First we determine if this setting is overriding any existing settings
378 // with the same name.
379 assert(offset < settings->num_settings);
380 for (sp = &settings->settings[offset]; *sp; )
381 if (!strcmp((*sp)->name, set->name))
383 if ((*sp)->precedence < set->precedence)
385 // We discard the value (nmem keeps track of the space)
386 *sp = (*sp)->next; // unlink value from existing setting
388 else if ((*sp)->precedence > set->precedence)
390 // Db contains a higher-priority setting. Abort search
393 else if (zurl_wildcard((*sp)->target) > zurl_wildcard(set->target))
395 // target-specific value trumps wildcard. Delete.
396 *sp = (*sp)->next; // unlink.....
398 else if (zurl_wildcard((*sp)->target) < zurl_wildcard(set->target))
399 // Db already contains higher-priority setting. Abort search
406 if (!*sp) // is null when there are no higher-priority settings, so we add one
408 struct setting *new = nmem_malloc(nmem, sizeof(*new));
409 memset(new, 0, sizeof(*new));
410 new->precedence = set->precedence;
411 new->target = nmem_strdup_null(nmem, set->target);
412 new->name = nmem_strdup_null(nmem, set->name);
413 new->value = nmem_strdup_null(nmem, set->value);
414 new->next = settings->settings[offset];
415 settings->settings[offset] = new;
420 // This is called from grep_databases -- adds/overrides setting for a target
421 // This is also where the rules for precedence of settings are implemented
422 static void update_database_fun(void *context, struct database *db)
424 struct setting *set = ((struct update_database_context *)
426 struct conf_service *service = ((struct update_database_context *)
431 // Is this the right database?
432 if (!match_zurl(db->id, set->target))
435 offset = settings_create_offset(service, set->name);
436 expand_settings_array(&db->settings, &db->num_settings, offset, service->nmem);
438 // First we determine if this setting is overriding any existing settings
439 // with the same name.
440 assert(offset < db->num_settings);
441 for (sp = &db->settings[offset]; *sp; )
442 if (!strcmp((*sp)->name, set->name))
444 if ((*sp)->precedence < set->precedence)
446 // We discard the value (nmem keeps track of the space)
447 *sp = (*sp)->next; // unlink value from existing setting
449 else if ((*sp)->precedence > set->precedence)
451 // Db contains a higher-priority setting. Abort search
454 else if (zurl_wildcard((*sp)->target) > zurl_wildcard(set->target))
456 // target-specific value trumps wildcard. Delete.
457 *sp = (*sp)->next; // unlink.....
459 else if (zurl_wildcard((*sp)->target) < zurl_wildcard(set->target))
460 // Db already contains higher-priority setting. Abort search
467 if (!*sp) // is null when there are no higher-priority settings, so we add one
469 struct setting *new = nmem_malloc(service->nmem, sizeof(*new));
471 memset(new, 0, sizeof(*new));
472 new->precedence = set->precedence;
473 new->target = nmem_strdup(service->nmem, set->target);
474 new->name = nmem_strdup(service->nmem, set->name);
475 new->value = nmem_strdup(service->nmem, set->value);
476 new->next = db->settings[offset];
477 db->settings[offset] = new;
481 // Callback -- updates database records with dictionary entries as appropriate
482 // This is used in pass 2 to assign name/value pairs to databases
483 static void update_databases(void *client_data, struct setting *set)
485 struct conf_service *service = (struct conf_service *) client_data;
486 struct update_database_context context;
488 context.service = service;
489 predef_grep_databases(&context, service, update_database_fun);
492 // This simply copies the 'hard' (application-specific) settings
493 // to the settings dictionary.
494 static void initialize_hard_settings(struct conf_service *service)
496 struct setting_dictionary *dict = service->dictionary;
497 dict->dict = nmem_malloc(service->nmem, sizeof(hard_settings) - sizeof(char*));
498 dict->size = (sizeof(hard_settings) - sizeof(char*)) / sizeof(char*);
499 memcpy(dict->dict, hard_settings, dict->size * sizeof(char*));
500 dict->num = dict->size;
503 // Read any settings names introduced in service definition (config) and add to dictionary
504 // This is done now to avoid errors if user settings are declared in session overrides
505 void initialize_soft_settings(struct conf_service *service)
508 for (i = 0; i < service->num_metadata; i++)
510 struct conf_metadata *md = &service->metadata[i];
512 if (md->setting != Metadata_setting_no)
513 settings_create_offset(service, md->name);
515 // Also create setting for some metadata attributes.
518 WRBUF wrbuf = wrbuf_alloc();
519 yaz_log(YLOG_DEBUG, "Metadata %s has limitmap: %s ",md->name, md->limitmap);
520 wrbuf_printf(wrbuf, "pz:limitmap:%s", md->name);
521 index = settings_create_offset(service, wrbuf_cstr(wrbuf));
525 yaz_log(YLOG_DEBUG, "Service %s default %s=%s",
526 (service->id ? service->id: "unknown"), wrbuf_cstr(wrbuf), md->limitmap);
527 new.name = (char *) wrbuf_cstr(wrbuf);
528 new.value = md->limitmap;
532 offset = settings_create_offset(service, new.name);
533 update_settings(&new, service->settings, offset, service->nmem);
535 wrbuf_destroy(wrbuf);
536 // TODO same for facetmap
541 static void prepare_target_dictionary(void *client_data, struct setting *set)
543 struct conf_service *service = (struct conf_service *) client_data;
545 // If target address is not wildcard, add the database
546 if (*set->target && !zurl_wildcard(set->target))
547 create_database_for_service(set->target, service);
550 void init_settings(struct conf_service *service)
552 struct setting_dictionary *new;
554 assert(service->nmem);
556 new = nmem_malloc(service->nmem, sizeof(*new));
557 memset(new, 0, sizeof(*new));
558 service->dictionary = new;
559 initialize_hard_settings(service);
560 initialize_soft_settings(service);
563 int settings_read_file(struct conf_service *service, const char *path,
567 return read_settings(path, service, prepare_target_dictionary);
569 return read_settings(path, service, update_databases);
572 int settings_read_node(struct conf_service *service, xmlNode *n,
576 return settings_read_node_x(n, service, prepare_target_dictionary);
578 return settings_read_node_x(n, service, update_databases);
584 * c-file-style: "Stroustrup"
585 * indent-tabs-mode: nil
587 * vim: shiftwidth=4 tabstop=8 expandtab