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>
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[] = {
70 "pz:negotiation_charset",
72 "pz:reuse_connections",
73 "pz:termlist_term_factor",
74 "pz:termlist_term_count",
85 "pz:authentication_mode",
93 struct setting_dictionary
100 // This establishes the precedence of wildcard expressions
101 #define SETTING_WILDCARD_NO 0 // No wildcard
102 #define SETTING_WILDCARD_DB 1 // Database wildcard 'host:port/*'
103 #define SETTING_WILDCARD_YES 2 // Complete wildcard '*'
105 // Returns size of settings directory
106 int settings_num(struct conf_service *service)
108 return service->dictionary->num;
111 /* Find and possible create a new dictionary entry. Pass valid NMEM pointer if creation is allowed, otherwise null */
112 static int settings_index_lookup(struct setting_dictionary *dictionary, const char *name, NMEM nmem)
120 if (!strncmp("pz:", name, 3) && (p = strchr(name + 3, ':')))
121 maxlen = (p - name) + 1;
123 maxlen = strlen(name) + 1;
124 for (i = 0; i < dictionary->num; i++)
125 if (!strncmp(name, dictionary->dict[i], maxlen))
129 if (!strncmp("pz:", name, 3))
130 yaz_log(YLOG_WARN, "Adding pz-type setting name %s", name);
131 if (dictionary->num + 1 > dictionary->size)
134 nmem_malloc(nmem, dictionary->size * 2 * sizeof(char*));
135 memcpy(tmp, dictionary->dict, dictionary->size * sizeof(char*));
136 dictionary->dict = tmp;
137 dictionary->size *= 2;
139 dictionary->dict[dictionary->num] = nmem_strdup(nmem, name);
140 dictionary->dict[dictionary->num][maxlen-1] = '\0';
141 return dictionary->num++;
144 int settings_create_offset(struct conf_service *service, const char *name)
146 return settings_index_lookup(service->dictionary, name, service->nmem);
149 int settings_lookup_offset(struct conf_service *service, const char *name)
151 return settings_index_lookup(service->dictionary, name, 0);
154 char *settings_name(struct conf_service *service, int offset)
156 assert(offset < service->dictionary->num);
157 return service->dictionary->dict[offset];
161 // Apply a session override to a database
162 void service_apply_setting(struct conf_service *service, char *name, char *value)
165 int offset = settings_create_offset(service, name);
166 expand_settings_array(&service->settings->settings, &service->settings->num_settings, offset, service->nmem);
167 for (s = service->settings->settings[offset]; s; s = s->next)
168 if (!strcmp(s->name, name))
173 s = nmem_malloc(service->nmem, sizeof(*s));
178 s->next = service->settings->settings[offset];
179 service->settings->settings[offset] = s;
183 static int isdir(const char *path)
187 if (stat(path, &st) < 0)
189 yaz_log(YLOG_FATAL|YLOG_ERRNO, "stat %s", path);
192 return st.st_mode & S_IFDIR;
195 // Read settings from an XML file, calling handler function for each setting
196 int settings_read_node_x(xmlNode *n,
198 void (*fun)(void *client_data,
199 struct setting *set))
201 int ret_val = 0; /* success */
202 char *namea = (char *) xmlGetProp(n, (xmlChar *) "name");
203 char *targeta = (char *) xmlGetProp(n, (xmlChar *) "target");
204 char *valuea = (char *) xmlGetProp(n, (xmlChar *) "value");
205 char *usera = (char *) xmlGetProp(n, (xmlChar *) "user");
206 char *precedencea = (char *) xmlGetProp(n, (xmlChar *) "precedence");
208 for (n = n->children; n; n = n->next)
210 if (n->type != XML_ELEMENT_NODE)
212 if (!strcmp((const char *) n->name, "set"))
214 xmlNode *root = n->children;
216 char *name = (char *) xmlGetProp(n, (xmlChar *) "name");
217 char *target = (char *) xmlGetProp(n, (xmlChar *) "target");
218 char *value = (char *) xmlGetProp(n, (xmlChar *) "value");
219 char *user = (char *) xmlGetProp(n, (xmlChar *) "user");
220 char *precedence = (char *) xmlGetProp(n, (xmlChar *) "precedence");
221 xmlChar *buf_out = 0;
226 set.precedence = atoi((char *) precedence);
227 else if (precedencea)
228 set.precedence = atoi((char *) precedencea);
232 set.target = target ? target : targeta;
233 set.name = name ? name : namea;
235 while (root && root->type != XML_ELEMENT_NODE)
238 set.value = value ? value : valuea;
240 { /* xml document content for this setting */
241 xmlDoc *doc = xmlNewDoc(BAD_CAST "1.0");
245 yaz_log(YLOG_WARN, "bad XML content for setting "
246 "name=%s", set.name);
248 yaz_log(YLOG_WARN, "bad XML content for setting");
254 xmlDocSetRootElement(doc, xmlCopyNode(root, 1));
255 xmlDocDumpMemory(doc, &buf_out, &len_out);
256 /* xmlDocDumpMemory 0-terminates */
257 set.value = (char *) buf_out;
262 if (set.name && set.value && set.target)
263 (*fun)(client_data, &set);
267 yaz_log(YLOG_WARN, "missing value and/or target for "
268 "setting name=%s", set.name);
270 yaz_log(YLOG_WARN, "missing name/value/target for setting");
282 yaz_log(YLOG_WARN, "Unknown element %s in settings file",
288 xmlFree(precedencea);
295 static int read_settings_file(const char *path,
297 void (*fun)(void *client_data,
298 struct setting *set))
300 xmlDoc *doc = xmlParseFile(path);
306 yaz_log(YLOG_FATAL, "Failed to parse %s", path);
309 n = xmlDocGetRootElement(doc);
310 ret = settings_read_node_x(n, client_data, fun);
317 // Recursively read files or directories, invoking a
318 // callback for each one
319 static int read_settings(const char *path,
321 void (*fun)(void *client_data,
322 struct setting *set))
331 if (!(d = opendir(path)))
333 yaz_log(YLOG_FATAL|YLOG_ERRNO, "%s", path);
336 while ((de = readdir(d)))
339 if (*de->d_name == '.' || !strcmp(de->d_name, "CVS"))
341 sprintf(tmp, "%s/%s", path, de->d_name);
342 if (read_settings(tmp, client_data, fun))
347 else if ((dot = strrchr(path, '.')) && !strcmp(dot + 1, "xml"))
348 ret = read_settings_file(path, client_data, fun);
352 // Determines if a ZURL is a wildcard, and what kind
353 static int zurl_wildcard(const char *zurl)
356 return SETTING_WILDCARD_NO;
358 return SETTING_WILDCARD_YES;
359 else if (*(zurl + strlen(zurl) - 1) == '*')
360 return SETTING_WILDCARD_DB;
362 return SETTING_WILDCARD_NO;
365 struct update_database_context {
367 struct conf_service *service;
370 void expand_settings_array(struct setting ***set_ar, int *num, int offset,
377 int i, n_num = offset + 10;
378 struct setting **n_ar = nmem_malloc(nmem, n_num * sizeof(*n_ar));
379 for (i = 0; i < *num; i++)
380 n_ar[i] = (*set_ar)[i];
381 for (; i < n_num; i++)
388 void expand_settings_array2(struct settings_array *settings, int offset, NMEM nmem)
392 if (offset >= settings->num_settings)
394 int i, n_num = offset + 10;
395 struct setting **n_ar = nmem_malloc(nmem, n_num * sizeof(*n_ar));
396 for (i = 0; i < settings->num_settings; i++)
397 n_ar[i] = settings->settings[i];
398 for (; i < n_num; i++)
400 settings->num_settings = n_num;
401 settings->settings = n_ar;
405 static void update_settings(struct setting *set, struct settings_array *settings, int offset, NMEM nmem)
408 yaz_log(YLOG_DEBUG, "update service settings offset %d with %s=%s", offset, set->name, set->value);
409 expand_settings_array2(settings, offset, nmem);
411 // First we determine if this setting is overriding any existing settings
412 // with the same name.
413 assert(offset < settings->num_settings);
414 for (sp = &settings->settings[offset]; *sp; )
415 if (!strcmp((*sp)->name, set->name))
417 if ((*sp)->precedence < set->precedence)
419 // We discard the value (nmem keeps track of the space)
420 *sp = (*sp)->next; // unlink value from existing setting
422 else if ((*sp)->precedence > set->precedence)
424 // Db contains a higher-priority setting. Abort search
427 else if (zurl_wildcard((*sp)->target) > zurl_wildcard(set->target))
429 // target-specific value trumps wildcard. Delete.
430 *sp = (*sp)->next; // unlink.....
432 else if (zurl_wildcard((*sp)->target) < zurl_wildcard(set->target))
433 // Db already contains higher-priority setting. Abort search
440 if (!*sp) // is null when there are no higher-priority settings, so we add one
442 struct setting *new = nmem_malloc(nmem, sizeof(*new));
443 memset(new, 0, sizeof(*new));
444 new->precedence = set->precedence;
445 new->target = nmem_strdup_null(nmem, set->target);
446 new->name = nmem_strdup_null(nmem, set->name);
447 new->value = nmem_strdup_null(nmem, set->value);
448 new->next = settings->settings[offset];
449 settings->settings[offset] = new;
454 // This is called from grep_databases -- adds/overrides setting for a target
455 // This is also where the rules for precedence of settings are implemented
456 static void update_database_fun(void *context, struct database *db)
458 struct setting *set = ((struct update_database_context *)
460 struct conf_service *service = ((struct update_database_context *)
465 // Is this the right database?
466 if (!match_zurl(db->id, set->target))
469 offset = settings_create_offset(service, set->name);
470 expand_settings_array(&db->settings, &db->num_settings, offset, service->nmem);
472 // First we determine if this setting is overriding any existing settings
473 // with the same name.
474 assert(offset < db->num_settings);
475 for (sp = &db->settings[offset]; *sp; )
476 if (!strcmp((*sp)->name, set->name))
478 if ((*sp)->precedence < set->precedence)
480 // We discard the value (nmem keeps track of the space)
481 *sp = (*sp)->next; // unlink value from existing setting
483 else if ((*sp)->precedence > set->precedence)
485 // Db contains a higher-priority setting. Abort search
488 else if (zurl_wildcard((*sp)->target) > zurl_wildcard(set->target))
490 // target-specific value trumps wildcard. Delete.
491 *sp = (*sp)->next; // unlink.....
493 else if (zurl_wildcard((*sp)->target) < zurl_wildcard(set->target))
494 // Db already contains higher-priority setting. Abort search
501 if (!*sp) // is null when there are no higher-priority settings, so we add one
503 struct setting *new = nmem_malloc(service->nmem, sizeof(*new));
505 memset(new, 0, sizeof(*new));
506 new->precedence = set->precedence;
507 new->target = nmem_strdup(service->nmem, set->target);
508 new->name = nmem_strdup(service->nmem, set->name);
509 new->value = nmem_strdup(service->nmem, set->value);
510 new->next = db->settings[offset];
511 db->settings[offset] = new;
515 // Callback -- updates database records with dictionary entries as appropriate
516 // This is used in pass 2 to assign name/value pairs to databases
517 static void update_databases(void *client_data, struct setting *set)
519 struct conf_service *service = (struct conf_service *) client_data;
520 struct update_database_context context;
522 context.service = service;
523 predef_grep_databases(&context, service, update_database_fun);
526 // This simply copies the 'hard' (application-specific) settings
527 // to the settings dictionary.
528 static void initialize_hard_settings(struct conf_service *service)
530 struct setting_dictionary *dict = service->dictionary;
531 dict->dict = nmem_malloc(service->nmem, sizeof(hard_settings) - sizeof(char*));
532 dict->size = (sizeof(hard_settings) - sizeof(char*)) / sizeof(char*);
533 memcpy(dict->dict, hard_settings, dict->size * sizeof(char*));
534 dict->num = dict->size;
537 // Read any settings names introduced in service definition (config) and add to dictionary
538 // This is done now to avoid errors if user settings are declared in session overrides
539 void initialize_soft_settings(struct conf_service *service)
542 for (i = 0; i < service->num_metadata; i++)
544 struct conf_metadata *md = &service->metadata[i];
546 if (md->setting != Metadata_setting_no)
547 settings_create_offset(service, md->name);
549 // Also create setting for some metadata attributes.
552 WRBUF wrbuf = wrbuf_alloc();
553 yaz_log(YLOG_DEBUG, "Metadata %s has limitmap: %s ",md->name, md->limitmap);
554 wrbuf_printf(wrbuf, "pz:limitmap:%s", md->name);
555 index = settings_create_offset(service, wrbuf_cstr(wrbuf));
559 yaz_log(YLOG_DEBUG, "Service %s default %s=%s",
560 (service->id ? service->id: "unknown"), wrbuf_cstr(wrbuf), md->limitmap);
561 new.name = (char *) wrbuf_cstr(wrbuf);
562 new.value = md->limitmap;
566 offset = settings_create_offset(service, new.name);
567 update_settings(&new, service->settings, offset, service->nmem);
569 wrbuf_destroy(wrbuf);
570 // TODO same for facetmap
575 static void prepare_target_dictionary(void *client_data, struct setting *set)
577 struct conf_service *service = (struct conf_service *) client_data;
579 // If target address is not wildcard, add the database
580 if (*set->target && !zurl_wildcard(set->target))
581 create_database_for_service(set->target, service);
584 void init_settings(struct conf_service *service)
586 struct setting_dictionary *new;
588 assert(service->nmem);
590 new = nmem_malloc(service->nmem, sizeof(*new));
591 memset(new, 0, sizeof(*new));
592 service->dictionary = new;
593 initialize_hard_settings(service);
594 initialize_soft_settings(service);
597 int settings_read_file(struct conf_service *service, const char *path,
601 return read_settings(path, service, prepare_target_dictionary);
603 return read_settings(path, service, update_databases);
606 int settings_read_node(struct conf_service *service, xmlNode *n,
610 return settings_read_node_x(n, service, prepare_target_dictionary);
612 return settings_read_node_x(n, service, update_databases);
618 * c-file-style: "Stroustrup"
619 * indent-tabs-mode: nil
621 * vim: shiftwidth=4 tabstop=8 expandtab