124d9db7eb23f3fb8495ab44dd2112af6f261086
[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 void settings_read_node_x(xmlNode *n,
184                           void *client_data,
185                           void (*fun)(void *client_data,
186                                       struct setting *set))
187 {
188     xmlChar *namea, *targeta, *valuea, *usera, *precedencea;
189
190     namea = xmlGetProp(n, (xmlChar *) "name");
191     targeta = xmlGetProp(n, (xmlChar *) "target");
192     valuea = xmlGetProp(n, (xmlChar *) "value");
193     usera = xmlGetProp(n, (xmlChar *) "user");
194     precedencea = xmlGetProp(n, (xmlChar *) "precedence");
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             char *name, *target, *value, *user, *precedence;
202
203             name = (char *) xmlGetProp(n, (xmlChar *) "name");
204             target = (char *) xmlGetProp(n, (xmlChar *) "target");
205             value = (char *) xmlGetProp(n, (xmlChar *) "value");
206             user = (char *) xmlGetProp(n, (xmlChar *) "user");
207             precedence = (char *) xmlGetProp(n, (xmlChar *) "precedence");
208
209             if ((!name && !namea) || (!value && !valuea) || (!target && !targeta))
210             {
211                 yaz_log(YLOG_FATAL, "set must specify name, value, and target");
212                 exit(1);
213             }
214             else
215             {
216                 struct setting set;
217                 char nameb[1024];
218                 char targetb[1024];
219                 char valueb[1024];
220
221                 // Copy everything into a temporary buffer -- we decide
222                 // later if we are keeping it.
223                 if (precedence)
224                     set.precedence = atoi((char *) precedence);
225                 else if (precedencea)
226                     set.precedence = atoi((char *) precedencea);
227                 else
228                     set.precedence = 0;
229                 if (target)
230                     strcpy(targetb, target);
231                 else
232                     strcpy(targetb, (const char *) targeta);
233                 set.target = targetb;
234                 if (name)
235                     strcpy(nameb, name);
236                 else
237                     strcpy(nameb, (const char *) namea);
238                 set.name = nameb;
239                 if (value)
240                     strcpy(valueb, value);
241                 else
242                     strcpy(valueb, (const char *) valuea);
243                 set.value = valueb;
244                 set.next = 0;
245                 (*fun)(client_data, &set);
246             }
247             xmlFree(name);
248             xmlFree(precedence);
249             xmlFree(value);
250             xmlFree(user);
251             xmlFree(target);
252         }
253         else
254         {
255             yaz_log(YLOG_FATAL, "Unknown element %s in settings file", (char*) n->name);
256             exit(1);
257         }
258     }
259     xmlFree(namea);
260     xmlFree(precedencea);
261     xmlFree(valuea);
262     xmlFree(usera);
263     xmlFree(targeta);
264 }
265  
266 static void read_settings_file(const char *path,
267                                void *client_data,
268                                void (*fun)(void *client_data,
269                                            struct setting *set))
270 {
271     xmlDoc *doc = xmlParseFile(path);
272     xmlNode *n;
273
274     if (!doc)
275     {
276         yaz_log(YLOG_FATAL, "Failed to parse %s", path);
277         exit(1);
278     }
279     n = xmlDocGetRootElement(doc);
280     settings_read_node_x(n, client_data, fun);
281
282     xmlFreeDoc(doc);
283 }
284
285
286 // Recursively read files or directories, invoking a 
287 // callback for each one
288 static void read_settings(const char *path,
289                           void *client_data,
290                           void (*fun)(void *client_data,
291                                       struct setting *set))
292 {
293     DIR *d;
294     struct dirent *de;
295     char *dot;
296
297     if (isdir(path))
298     {
299         if (!(d = opendir(path)))
300         {
301             yaz_log(YLOG_FATAL|YLOG_ERRNO, "%s", path);
302             exit(1);
303         }
304         while ((de = readdir(d)))
305         {
306             char tmp[1024];
307             if (*de->d_name == '.' || !strcmp(de->d_name, "CVS"))
308                 continue;
309             sprintf(tmp, "%s/%s", path, de->d_name);
310             read_settings(tmp, client_data, fun);
311         }
312         closedir(d);
313     }
314     else if ((dot = strrchr(path, '.')) && !strcmp(dot + 1, "xml"))
315         read_settings_file(path, client_data, fun);
316 }
317
318 // Determines if a ZURL is a wildcard, and what kind
319 static int zurl_wildcard(const char *zurl)
320 {
321     if (!zurl)
322         return SETTING_WILDCARD_NO;
323     if (*zurl == '*')
324         return SETTING_WILDCARD_YES;
325     else if (*(zurl + strlen(zurl) - 1) == '*')
326         return SETTING_WILDCARD_DB;
327     else
328         return SETTING_WILDCARD_NO;
329 }
330
331 struct update_database_context {
332     struct setting *set;
333     struct conf_service *service;
334 };
335
336 void expand_settings_array(struct setting ***set_ar, int *num, int offset,
337                            NMEM nmem)
338 {
339     assert(offset >= 0);
340     assert(*set_ar);
341     if (offset >= *num)
342     {
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++)
348             n_ar[i] = 0;
349         *num = n_num;
350         *set_ar = n_ar;
351     }
352 }
353
354 void expand_settings_array2(struct settings *settings, int offset, NMEM nmem)
355 {
356     assert(offset >= 0);
357     assert(settings);
358     if (offset >= settings->num_settings)
359     {
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++)
365             n_ar[i] = 0;
366         settings->num_settings = n_num;
367         settings->settings = n_ar;
368     }
369 }
370
371 static void update_settings(struct setting *set, struct settings *settings, int offset, NMEM nmem)
372 {
373     struct setting **sp;
374     yaz_log(YLOG_LOG, "update service settings offset %d with %s=%s", offset, set->name, set->value);
375     expand_settings_array2(settings, offset, nmem);
376
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))
382         {
383             if ((*sp)->precedence < set->precedence)
384             {
385                 // We discard the value (nmem keeps track of the space)
386                 *sp = (*sp)->next; // unlink value from existing setting
387             }
388             else if ((*sp)->precedence > set->precedence)
389             {
390                 // Db contains a higher-priority setting. Abort search
391                 break;
392             }
393             else if (zurl_wildcard((*sp)->target) > zurl_wildcard(set->target))
394             {
395                 // target-specific value trumps wildcard. Delete.
396                 *sp = (*sp)->next; // unlink.....
397             }
398             else if (zurl_wildcard((*sp)->target) < zurl_wildcard(set->target))
399                 // Db already contains higher-priority setting. Abort search
400                 break;
401             else
402                 sp = &(*sp)->next;
403         }
404         else
405             sp = &(*sp)->next;
406     if (!*sp) // is null when there are no higher-priority settings, so we add one
407     {
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;
416     }
417 }
418
419
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)
423 {
424     struct setting *set = ((struct update_database_context *)
425                            context)->set;
426     struct conf_service *service = ((struct update_database_context *) 
427                                     context)->service;
428     struct setting **sp;
429     int offset;
430
431     // Is this the right database?
432     if (!match_zurl(db->id, set->target))
433         return;
434
435     offset = settings_create_offset(service, set->name);
436     expand_settings_array(&db->settings, &db->num_settings, offset, service->nmem);
437
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))
443         {
444             if ((*sp)->precedence < set->precedence)
445             {
446                 // We discard the value (nmem keeps track of the space)
447                 *sp = (*sp)->next; // unlink value from existing setting
448             }
449             else if ((*sp)->precedence > set->precedence)
450             {
451                 // Db contains a higher-priority setting. Abort search
452                 break;
453             }
454             else if (zurl_wildcard((*sp)->target) > zurl_wildcard(set->target))
455             {
456                 // target-specific value trumps wildcard. Delete.
457                 *sp = (*sp)->next; // unlink.....
458             }
459             else if (zurl_wildcard((*sp)->target) < zurl_wildcard(set->target))
460                 // Db already contains higher-priority setting. Abort search
461                 break;
462             else
463                 sp = &(*sp)->next;
464         }
465         else
466             sp = &(*sp)->next;
467     if (!*sp) // is null when there are no higher-priority settings, so we add one
468     {
469         struct setting *new = nmem_malloc(service->nmem, sizeof(*new));
470
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;
478     }
479 }
480
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)
484 {
485     struct conf_service *service = (struct conf_service *) client_data;
486     struct update_database_context context;
487     context.set = set;
488     context.service = service;
489     predef_grep_databases(&context, service, update_database_fun);
490 }
491
492 // This simply copies the 'hard' (application-specific) settings
493 // to the settings dictionary.
494 static void initialize_hard_settings(struct conf_service *service)
495 {
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;
501 }
502
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)
506 {
507     int i;
508     for (i = 0; i < service->num_metadata; i++)
509     {
510         struct conf_metadata *md = &service->metadata[i];
511
512         if (md->setting != Metadata_setting_no)
513             settings_create_offset(service, md->name);
514
515         // Also create setting for some metadata attributes.
516         if (md->limitmap) {
517             int index; 
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));
522             if (index >= 0) {
523                 struct setting new;
524                 int offset;
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;
529                 new.next = 0;
530                 new.target = 0;
531                 new.precedence = 0;
532                 offset = settings_create_offset(service, new.name);
533                 update_settings(&new, service->settings, offset, service->nmem);
534             }
535             wrbuf_destroy(wrbuf);
536         // TODO same for facetmap
537         }
538     }
539 }
540
541 static void prepare_target_dictionary(void *client_data, struct setting *set)
542 {
543     struct conf_service *service = (struct conf_service *) client_data;
544
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);
548 }
549
550 void init_settings(struct conf_service *service)
551 {
552     struct setting_dictionary *new;
553     
554     assert(service->nmem);
555     
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);
561 }
562
563 void settings_read_file(struct conf_service *service, const char *path,
564                         int pass)
565 {
566     if (pass == 1)
567         read_settings(path, service, prepare_target_dictionary);
568     else
569         read_settings(path, service, update_databases);
570 }
571
572 void settings_read_node(struct conf_service *service, xmlNode *n,
573                         int pass)
574 {
575     if (pass == 1)
576         settings_read_node_x(n, service, prepare_target_dictionary);
577     else
578         settings_read_node_x(n, service, update_databases);
579 }
580
581 /*
582  * Local variables:
583  * c-basic-offset: 4
584  * c-file-style: "Stroustrup"
585  * indent-tabs-mode: nil
586  * End:
587  * vim: shiftwidth=4 tabstop=8 expandtab
588  */
589