7b707829a47acf82ea2830625bbf27346c91fd4b
[pazpar2-moved-to-github.git] / src / settings.c
1 /* This file is part of Pazpar2.
2    Copyright (C) 2006-2012 Index Data
3
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
7 version.
8
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
12 for more details.
13
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
17
18 */
19
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
23 // per-user settings.
24
25 #if HAVE_CONFIG_H
26 #include <config.h>
27 #endif
28
29
30 #include <string.h>
31 #include <assert.h>
32 #include <stdio.h>
33 #include <sys/types.h>
34 #include <yaz/dirent.h>
35 #include <stdlib.h>
36 #include <sys/stat.h>
37
38 #include <libxml/parser.h>
39 #include <libxml/tree.h>
40
41 #include <yaz/nmem.h>
42 #include <yaz/log.h>
43
44 #include "session.h"
45 #include "database.h"
46 #include "settings.h"
47
48 // Used for initializing setting_dictionary with pazpar2-specific settings
49 static char *hard_settings[] = {
50     "pz:piggyback",
51     "pz:elements",
52     "pz:requestsyntax",
53     "pz:cclmap:",
54     "pz:xslt",
55     "pz:nativesyntax",
56     "pz:authentication",
57     "pz:allow",
58     "pz:maxrecs",
59     "pz:id",
60     "pz:name",
61     "pz:queryencoding",
62     "pz:zproxy",
63     "pz:apdulog",
64     "pz:sru",
65     "pz:sru_version",
66     "pz:pqf_prefix",
67     "pz:sort",
68     "pz:recordfilter",
69     "pz:pqf_strftime",
70     "pz:negotiation_charset",
71     "pz:max_connections",
72     "pz:reuse_connections",
73     "pz:termlist_term_factor",
74     "pz:termlist_term_count",
75     "pz:preferred",
76     "pz:extra_args",
77     "pz:query_syntax",
78     "pz:facetmap:",
79     "pz:limitmap:",
80     "pz:url",
81     "pz:sortmap:",
82     "pz:present_chunk",
83     "pz:block_timeout",
84     0
85 };
86
87 struct setting_dictionary
88 {
89     char **dict;
90     int size;
91     int num;
92 };
93
94 // This establishes the precedence of wildcard expressions
95 #define SETTING_WILDCARD_NO     0 // No wildcard
96 #define SETTING_WILDCARD_DB     1 // Database wildcard 'host:port/*'
97 #define SETTING_WILDCARD_YES    2 // Complete wildcard '*'
98
99 // Returns size of settings directory
100 int settings_num(struct conf_service *service)
101 {
102     return service->dictionary->num;
103 }
104
105 /* Find and possible create a new dictionary entry. Pass valid NMEM pointer if creation is allowed, otherwise null */
106 static int settings_index_lookup(struct setting_dictionary *dictionary, const char *name, NMEM nmem)
107 {
108     size_t maxlen;
109     int i;
110     const char *p;
111     
112     assert(name);
113
114     if (!strncmp("pz:", name, 3) && (p = strchr(name + 3, ':')))
115         maxlen = (p - name) + 1;
116     else
117         maxlen = strlen(name) + 1;
118     for (i = 0; i < dictionary->num; i++)
119         if (!strncmp(name, dictionary->dict[i], maxlen))
120             return i;
121     if (!nmem)
122         return -1;
123     if (!strncmp("pz:", name, 3))
124         yaz_log(YLOG_WARN, "Adding pz-type setting name %s", name);
125     if (dictionary->num + 1 > dictionary->size)
126     {
127         char **tmp =
128             nmem_malloc(nmem, dictionary->size * 2 * sizeof(char*));
129         memcpy(tmp, dictionary->dict, dictionary->size * sizeof(char*));
130         dictionary->dict = tmp;
131         dictionary->size *= 2;
132     }
133     dictionary->dict[dictionary->num] = nmem_strdup(nmem, name);
134     dictionary->dict[dictionary->num][maxlen-1] = '\0';
135     return dictionary->num++;
136 }
137
138 int settings_create_offset(struct conf_service *service, const char *name)
139 {
140     return settings_index_lookup(service->dictionary, name, service->nmem);
141 }
142
143 int settings_lookup_offset(struct conf_service *service, const char *name)
144 {
145     return settings_index_lookup(service->dictionary, name, 0);
146 }
147
148 char *settings_name(struct conf_service *service, int offset)
149 {
150     assert(offset < service->dictionary->num);
151     return service->dictionary->dict[offset];
152 }
153
154
155 // Apply a session override to a database
156 void service_apply_setting(struct conf_service *service, char *setting, char *value)
157 {
158     struct setting *new = nmem_malloc(service->nmem, sizeof(*new));
159     int offset = settings_create_offset(service, setting);
160     expand_settings_array(&service->settings->settings, &service->settings->num_settings, offset, service->nmem);
161     new->precedence = 0;
162     new->target = NULL;
163     new->name = setting;
164     new->value = value;
165     new->next = service->settings->settings[offset];
166     service->settings->settings[offset] = new;
167 }
168
169
170 static int isdir(const char *path)
171 {
172     struct stat st;
173
174     if (stat(path, &st) < 0)
175     {
176         yaz_log(YLOG_FATAL|YLOG_ERRNO, "stat %s", path);
177         exit(1);
178     }
179     return st.st_mode & S_IFDIR;
180 }
181
182 // Read settings from an XML file, calling handler function for each setting
183 int settings_read_node_x(xmlNode *n,
184                          void *client_data,
185                          void (*fun)(void *client_data,
186                                      struct setting *set))
187 {
188     int ret_val = 0; /* success */
189     char *namea = (char *) xmlGetProp(n, (xmlChar *) "name");
190     char *targeta = (char *) xmlGetProp(n, (xmlChar *) "target");
191     char *valuea = (char *) xmlGetProp(n, (xmlChar *) "value");
192     char *usera = (char *) xmlGetProp(n, (xmlChar *) "user");
193     char *precedencea = (char *) xmlGetProp(n, (xmlChar *) "precedence");
194
195     for (n = n->children; n; n = n->next)
196     {
197         if (n->type != XML_ELEMENT_NODE)
198             continue;
199         if (!strcmp((const char *) n->name, "set"))
200         {
201             struct setting set;
202             char *name = (char *) xmlGetProp(n, (xmlChar *) "name");
203             char *target = (char *) xmlGetProp(n, (xmlChar *) "target");
204             char *value = (char *) xmlGetProp(n, (xmlChar *) "value");
205             char *user = (char *) xmlGetProp(n, (xmlChar *) "user");
206             char *precedence = (char *) xmlGetProp(n, (xmlChar *) "precedence");
207
208             if (precedence)
209                 set.precedence = atoi((char *) precedence);
210             else if (precedencea)
211                 set.precedence = atoi((char *) precedencea);
212             else
213                 set.precedence = 0;
214
215             set.target = target ? target : targeta;
216             set.name = name ? name : namea;
217             set.value = value ? value : valuea;
218             set.next = 0;
219
220             if (set.name && set.value && set.target)
221                 (*fun)(client_data, &set);
222             else
223             {
224                 if (set.name)
225                     yaz_log(YLOG_WARN, "missing value and/or target for "
226                             "setting name=%s", set.name);
227                 else
228                     yaz_log(YLOG_WARN, "missing name/value/target for setting");
229                 ret_val = -1;
230             }
231             xmlFree(name);
232             xmlFree(precedence);
233             xmlFree(value);
234             xmlFree(user);
235             xmlFree(target);
236         }
237         else
238         {
239             yaz_log(YLOG_WARN, "Unknown element %s in settings file", 
240                     (char*) n->name);
241             ret_val = -1;
242         }
243     }
244     xmlFree(namea);
245     xmlFree(precedencea);
246     xmlFree(valuea);
247     xmlFree(usera);
248     xmlFree(targeta);
249     return ret_val;
250 }
251  
252 static int read_settings_file(const char *path,
253                               void *client_data,
254                               void (*fun)(void *client_data,
255                                           struct setting *set))
256 {
257     xmlDoc *doc = xmlParseFile(path);
258     xmlNode *n;
259     int ret;
260
261     if (!doc)
262     {
263         yaz_log(YLOG_FATAL, "Failed to parse %s", path);
264         return -1;
265     }
266     n = xmlDocGetRootElement(doc);
267     ret = settings_read_node_x(n, client_data, fun);
268
269     xmlFreeDoc(doc);
270     return ret;
271 }
272
273
274 // Recursively read files or directories, invoking a 
275 // callback for each one
276 static int read_settings(const char *path,
277                           void *client_data,
278                           void (*fun)(void *client_data,
279                                       struct setting *set))
280 {
281     int ret = 0;
282     DIR *d;
283     struct dirent *de;
284     char *dot;
285
286     if (isdir(path))
287     {
288         if (!(d = opendir(path)))
289         {
290             yaz_log(YLOG_FATAL|YLOG_ERRNO, "%s", path);
291             return -1;
292         }
293         while ((de = readdir(d)))
294         {
295             char tmp[1024];
296             if (*de->d_name == '.' || !strcmp(de->d_name, "CVS"))
297                 continue;
298             sprintf(tmp, "%s/%s", path, de->d_name);
299             if (read_settings(tmp, client_data, fun))
300                 ret = -1;
301         }
302         closedir(d);
303     }
304     else if ((dot = strrchr(path, '.')) && !strcmp(dot + 1, "xml"))
305         ret = read_settings_file(path, client_data, fun);
306     return ret;
307 }
308
309 // Determines if a ZURL is a wildcard, and what kind
310 static int zurl_wildcard(const char *zurl)
311 {
312     if (!zurl)
313         return SETTING_WILDCARD_NO;
314     if (*zurl == '*')
315         return SETTING_WILDCARD_YES;
316     else if (*(zurl + strlen(zurl) - 1) == '*')
317         return SETTING_WILDCARD_DB;
318     else
319         return SETTING_WILDCARD_NO;
320 }
321
322 struct update_database_context {
323     struct setting *set;
324     struct conf_service *service;
325 };
326
327 void expand_settings_array(struct setting ***set_ar, int *num, int offset,
328                            NMEM nmem)
329 {
330     assert(offset >= 0);
331     assert(*set_ar);
332     if (offset >= *num)
333     {
334         int i, n_num = offset + 10;
335         struct setting **n_ar = nmem_malloc(nmem, n_num * sizeof(*n_ar));
336         for (i = 0; i < *num; i++)
337             n_ar[i] = (*set_ar)[i];
338         for (; i < n_num; i++)
339             n_ar[i] = 0;
340         *num = n_num;
341         *set_ar = n_ar;
342     }
343 }
344
345 void expand_settings_array2(struct settings *settings, int offset, NMEM nmem)
346 {
347     assert(offset >= 0);
348     assert(settings);
349     if (offset >= settings->num_settings)
350     {
351         int i, n_num = offset + 10;
352         struct setting **n_ar = nmem_malloc(nmem, n_num * sizeof(*n_ar));
353         for (i = 0; i < settings->num_settings; i++)
354             n_ar[i] = settings->settings[i];
355         for (; i < n_num; i++)
356             n_ar[i] = 0;
357         settings->num_settings = n_num;
358         settings->settings = n_ar;
359     }
360 }
361
362 static void update_settings(struct setting *set, struct settings *settings, int offset, NMEM nmem)
363 {
364     struct setting **sp;
365     yaz_log(YLOG_LOG, "update service settings offset %d with %s=%s", offset, set->name, set->value);
366     expand_settings_array2(settings, offset, nmem);
367
368     // First we determine if this setting is overriding any existing settings
369     // with the same name.
370     assert(offset < settings->num_settings);
371     for (sp = &settings->settings[offset]; *sp; )
372         if (!strcmp((*sp)->name, set->name))
373         {
374             if ((*sp)->precedence < set->precedence)
375             {
376                 // We discard the value (nmem keeps track of the space)
377                 *sp = (*sp)->next; // unlink value from existing setting
378             }
379             else if ((*sp)->precedence > set->precedence)
380             {
381                 // Db contains a higher-priority setting. Abort search
382                 break;
383             }
384             else if (zurl_wildcard((*sp)->target) > zurl_wildcard(set->target))
385             {
386                 // target-specific value trumps wildcard. Delete.
387                 *sp = (*sp)->next; // unlink.....
388             }
389             else if (zurl_wildcard((*sp)->target) < zurl_wildcard(set->target))
390                 // Db already contains higher-priority setting. Abort search
391                 break;
392             else
393                 sp = &(*sp)->next;
394         }
395         else
396             sp = &(*sp)->next;
397     if (!*sp) // is null when there are no higher-priority settings, so we add one
398     {
399         struct setting *new = nmem_malloc(nmem, sizeof(*new));
400         memset(new, 0, sizeof(*new));
401         new->precedence = set->precedence;
402         new->target = nmem_strdup_null(nmem, set->target);
403         new->name = nmem_strdup_null(nmem, set->name);
404         new->value = nmem_strdup_null(nmem, set->value);
405         new->next = settings->settings[offset];
406         settings->settings[offset] = new;
407     }
408 }
409
410
411 // This is called from grep_databases -- adds/overrides setting for a target
412 // This is also where the rules for precedence of settings are implemented
413 static void update_database_fun(void *context, struct database *db)
414 {
415     struct setting *set = ((struct update_database_context *)
416                            context)->set;
417     struct conf_service *service = ((struct update_database_context *) 
418                                     context)->service;
419     struct setting **sp;
420     int offset;
421
422     // Is this the right database?
423     if (!match_zurl(db->id, set->target))
424         return;
425
426     offset = settings_create_offset(service, set->name);
427     expand_settings_array(&db->settings, &db->num_settings, offset, service->nmem);
428
429     // First we determine if this setting is overriding  any existing settings
430     // with the same name.
431     assert(offset < db->num_settings);
432     for (sp = &db->settings[offset]; *sp; )
433         if (!strcmp((*sp)->name, set->name))
434         {
435             if ((*sp)->precedence < set->precedence)
436             {
437                 // We discard the value (nmem keeps track of the space)
438                 *sp = (*sp)->next; // unlink value from existing setting
439             }
440             else if ((*sp)->precedence > set->precedence)
441             {
442                 // Db contains a higher-priority setting. Abort search
443                 break;
444             }
445             else if (zurl_wildcard((*sp)->target) > zurl_wildcard(set->target))
446             {
447                 // target-specific value trumps wildcard. Delete.
448                 *sp = (*sp)->next; // unlink.....
449             }
450             else if (zurl_wildcard((*sp)->target) < zurl_wildcard(set->target))
451                 // Db already contains higher-priority setting. Abort search
452                 break;
453             else
454                 sp = &(*sp)->next;
455         }
456         else
457             sp = &(*sp)->next;
458     if (!*sp) // is null when there are no higher-priority settings, so we add one
459     {
460         struct setting *new = nmem_malloc(service->nmem, sizeof(*new));
461
462         memset(new, 0, sizeof(*new));
463         new->precedence = set->precedence;
464         new->target = nmem_strdup(service->nmem, set->target);
465         new->name = nmem_strdup(service->nmem, set->name);
466         new->value = nmem_strdup(service->nmem, set->value);
467         new->next = db->settings[offset];
468         db->settings[offset] = new;
469     }
470 }
471
472 // Callback -- updates database records with dictionary entries as appropriate
473 // This is used in pass 2 to assign name/value pairs to databases
474 static void update_databases(void *client_data, struct setting *set)
475 {
476     struct conf_service *service = (struct conf_service *) client_data;
477     struct update_database_context context;
478     context.set = set;
479     context.service = service;
480     predef_grep_databases(&context, service, update_database_fun);
481 }
482
483 // This simply copies the 'hard' (application-specific) settings
484 // to the settings dictionary.
485 static void initialize_hard_settings(struct conf_service *service)
486 {
487     struct setting_dictionary *dict = service->dictionary;
488     dict->dict = nmem_malloc(service->nmem, sizeof(hard_settings) - sizeof(char*));
489     dict->size = (sizeof(hard_settings) - sizeof(char*)) / sizeof(char*);
490     memcpy(dict->dict, hard_settings, dict->size * sizeof(char*));
491     dict->num = dict->size;
492 }
493
494 // Read any settings names introduced in service definition (config) and add to dictionary
495 // This is done now to avoid errors if user settings are declared in session overrides
496 void initialize_soft_settings(struct conf_service *service)
497 {
498     int i;
499     for (i = 0; i < service->num_metadata; i++)
500     {
501         struct conf_metadata *md = &service->metadata[i];
502
503         if (md->setting != Metadata_setting_no)
504             settings_create_offset(service, md->name);
505
506         // Also create setting for some metadata attributes.
507         if (md->limitmap) {
508             int index; 
509             WRBUF wrbuf = wrbuf_alloc();
510             yaz_log(YLOG_DEBUG, "Metadata %s has limitmap: %s ",md->name,  md->limitmap);
511             wrbuf_printf(wrbuf, "pz:limitmap:%s", md->name);
512             index = settings_create_offset(service, wrbuf_cstr(wrbuf));
513             if (index >= 0) {
514                 struct setting new;
515                 int offset;
516                 yaz_log(YLOG_DEBUG, "Service %s default %s=%s",
517                         (service->id ? service->id: "unknown"), wrbuf_cstr(wrbuf), md->limitmap);
518                 new.name = (char *) wrbuf_cstr(wrbuf);
519                 new.value = md->limitmap;
520                 new.next = 0;
521                 new.target = 0;
522                 new.precedence = 0;
523                 offset = settings_create_offset(service, new.name);
524                 update_settings(&new, service->settings, offset, service->nmem);
525             }
526             wrbuf_destroy(wrbuf);
527         // TODO same for facetmap
528         }
529     }
530 }
531
532 static void prepare_target_dictionary(void *client_data, struct setting *set)
533 {
534     struct conf_service *service = (struct conf_service *) client_data;
535
536     // If target address is not wildcard, add the database
537     if (*set->target && !zurl_wildcard(set->target))
538         create_database_for_service(set->target, service);
539 }
540
541 void init_settings(struct conf_service *service)
542 {
543     struct setting_dictionary *new;
544     
545     assert(service->nmem);
546     
547     new = nmem_malloc(service->nmem, sizeof(*new));
548     memset(new, 0, sizeof(*new));
549     service->dictionary = new;
550     initialize_hard_settings(service);
551     initialize_soft_settings(service);
552 }
553
554 int settings_read_file(struct conf_service *service, const char *path,
555                        int pass)
556 {
557     if (pass == 1)
558         return read_settings(path, service, prepare_target_dictionary);
559     else
560         return read_settings(path, service, update_databases);
561 }
562
563 int settings_read_node(struct conf_service *service, xmlNode *n,
564                         int pass)
565 {
566     if (pass == 1)
567         return settings_read_node_x(n, service, prepare_target_dictionary);
568     else
569         return settings_read_node_x(n, service, update_databases);
570 }
571
572 /*
573  * Local variables:
574  * c-basic-offset: 4
575  * c-file-style: "Stroustrup"
576  * indent-tabs-mode: nil
577  * End:
578  * vim: shiftwidth=4 tabstop=8 expandtab
579  */
580