ups, mispelling
[pazpar2-moved-to-github.git] / src / settings.c
index 3b7a923..124d9db 100644 (file)
@@ -1,5 +1,5 @@
 /* This file is part of Pazpar2.
-   Copyright (C) 2006-2009 Index Data
+   Copyright (C) 2006-2012 Index Data
 
 Pazpar2 is free software; you can redistribute it and/or modify it under
 the terms of the GNU General Public License as published by the Free
@@ -31,7 +31,7 @@ Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 #include <assert.h>
 #include <stdio.h>
 #include <sys/types.h>
-#include "direntz.h"
+#include <yaz/dirent.h>
 #include <stdlib.h>
 #include <sys/stat.h>
 
@@ -41,7 +41,7 @@ Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 #include <yaz/nmem.h>
 #include <yaz/log.h>
 
-#include "pazpar2.h"
+#include "session.h"
 #include "database.h"
 #include "settings.h"
 
@@ -59,13 +59,28 @@ static char *hard_settings[] = {
     "pz:id",
     "pz:name",
     "pz:queryencoding",
-    "pz:ip",
     "pz:zproxy",
     "pz:apdulog",
     "pz:sru",
     "pz:sru_version",
     "pz:pqf_prefix",
     "pz:sort",
+    "pz:recordfilter",
+    "pz:pqf_strftime",
+    "pz:negotiation_charset",
+    "pz:max_connections",
+    "pz:reuse_connections",
+    "pz:termlist_term_factor",
+    "pz:termlist_term_count",
+    "pz:preferred",
+    "pz:extra_args",
+    "pz:query_syntax",
+    "pz:facetmap:",
+    "pz:limitmap:",
+    "pz:url",
+    "pz:sortmap:",
+    "pz:present_chunk",
+    "pz:block_timeout",
     0
 };
 
@@ -87,39 +102,71 @@ int settings_num(struct conf_service *service)
     return service->dictionary->num;
 }
 
-int settings_offset(struct conf_service *service, const char *name)
+/* Find and possible create a new dictionary entry. Pass valid NMEM pointer if creation is allowed, otherwise null */
+static int settings_index_lookup(struct setting_dictionary *dictionary, const char *name, NMEM nmem)
 {
+    size_t maxlen;
     int i;
+    const char *p;
+    
+    assert(name);
 
-    if (!name)
-        name = "";
-    for (i = 0; i < service->dictionary->num; i++)
-        if (!strcmp(name, service->dictionary->dict[i]))
+    if (!strncmp("pz:", name, 3) && (p = strchr(name + 3, ':')))
+        maxlen = (p - name) + 1;
+    else
+        maxlen = strlen(name) + 1;
+    for (i = 0; i < dictionary->num; i++)
+        if (!strncmp(name, dictionary->dict[i], maxlen))
             return i;
-    return -1;
+    if (!nmem)
+        return -1;
+    if (!strncmp("pz:", name, 3))
+        yaz_log(YLOG_WARN, "Adding pz-type setting name %s", name);
+    if (dictionary->num + 1 > dictionary->size)
+    {
+        char **tmp =
+            nmem_malloc(nmem, dictionary->size * 2 * sizeof(char*));
+        memcpy(tmp, dictionary->dict, dictionary->size * sizeof(char*));
+        dictionary->dict = tmp;
+        dictionary->size *= 2;
+    }
+    dictionary->dict[dictionary->num] = nmem_strdup(nmem, name);
+    dictionary->dict[dictionary->num][maxlen-1] = '\0';
+    return dictionary->num++;
 }
 
-// Ignores everything after second colon, if present
-// A bit of a hack to support the pz:cclmap: scheme (and more to come?)
-int settings_offset_cprefix(struct conf_service *service, const char *name)
+int settings_create_offset(struct conf_service *service, const char *name)
 {
-    const char *p;
-    int maxlen = 100;
-    int i;
+    return settings_index_lookup(service->dictionary, name, service->nmem);
+}
 
-    if (!strncmp("pz:", name, 3) && (p = strchr(name + 3, ':')))
-        maxlen = (p - name) + 1;
-    for (i = 0; i < service->dictionary->num; i++)
-        if (!strncmp(name, service->dictionary->dict[i], maxlen))
-            return i;
-    return -1;
+int settings_lookup_offset(struct conf_service *service, const char *name)
+{
+    return settings_index_lookup(service->dictionary, name, 0);
 }
 
 char *settings_name(struct conf_service *service, int offset)
 {
+    assert(offset < service->dictionary->num);
     return service->dictionary->dict[offset];
 }
 
+
+// Apply a session override to a database
+void service_apply_setting(struct conf_service *service, char *setting, char *value)
+{
+    struct setting *new = nmem_malloc(service->nmem, sizeof(*new));
+    int offset = settings_create_offset(service, setting);
+    expand_settings_array(&service->settings->settings, &service->settings->num_settings, offset, service->nmem);
+    new->precedence = 0;
+    new->target = NULL;
+    new->name = setting;
+    new->value = value;
+    new->next = service->settings->settings[offset];
+    service->settings->settings[offset] = new;
+}
+
+
 static int isdir(const char *path)
 {
     struct stat st;
@@ -133,10 +180,10 @@ static int isdir(const char *path)
 }
 
 // Read settings from an XML file, calling handler function for each setting
-static void read_settings_node(xmlNode *n,
-                               struct conf_service *service,
-                               void (*fun)(struct conf_service *service,
-                                           struct setting *set))
+void settings_read_node_x(xmlNode *n,
+                          void *client_data,
+                          void (*fun)(void *client_data,
+                                      struct setting *set))
 {
     xmlChar *namea, *targeta, *valuea, *usera, *precedencea;
 
@@ -195,7 +242,7 @@ static void read_settings_node(xmlNode *n,
                     strcpy(valueb, (const char *) valuea);
                 set.value = valueb;
                 set.next = 0;
-                (*fun)(service, &set);
+                (*fun)(client_data, &set);
             }
             xmlFree(name);
             xmlFree(precedence);
@@ -217,8 +264,8 @@ static void read_settings_node(xmlNode *n,
 }
  
 static void read_settings_file(const char *path,
-                               struct conf_service *service,
-                               void (*fun)(struct conf_service *service,
+                               void *client_data,
+                               void (*fun)(void *client_data,
                                            struct setting *set))
 {
     xmlDoc *doc = xmlParseFile(path);
@@ -230,7 +277,7 @@ static void read_settings_file(const char *path,
         exit(1);
     }
     n = xmlDocGetRootElement(doc);
-    read_settings_node(n, service, fun);
+    settings_read_node_x(n, client_data, fun);
 
     xmlFreeDoc(doc);
 }
@@ -239,8 +286,8 @@ static void read_settings_file(const char *path,
 // Recursively read files or directories, invoking a 
 // callback for each one
 static void read_settings(const char *path,
-                          struct conf_service *service,
-                          void (*fun)(struct conf_service *service,
+                          void *client_data,
+                          void (*fun)(void *client_data,
                                       struct setting *set))
 {
     DIR *d;
@@ -260,12 +307,12 @@ static void read_settings(const char *path,
             if (*de->d_name == '.' || !strcmp(de->d_name, "CVS"))
                 continue;
             sprintf(tmp, "%s/%s", path, de->d_name);
-            read_settings(tmp, service, fun);
+            read_settings(tmp, client_data, fun);
         }
         closedir(d);
     }
     else if ((dot = strrchr(path, '.')) && !strcmp(dot + 1, "xml"))
-        read_settings_file(path, service, fun);
+        read_settings_file(path, client_data, fun);
 }
 
 // Determines if a ZURL is a wildcard, and what kind
@@ -281,90 +328,143 @@ static int zurl_wildcard(const char *zurl)
         return SETTING_WILDCARD_NO;
 }
 
-// Callback. Adds a new entry to the dictionary if necessary
-// This is used in pass 1 to determine layout of dictionary
-// and to load any databases mentioned
-static void prepare_dictionary(struct conf_service *service,
-                               struct setting *set)
+struct update_database_context {
+    struct setting *set;
+    struct conf_service *service;
+};
+
+void expand_settings_array(struct setting ***set_ar, int *num, int offset,
+                           NMEM nmem)
 {
-    struct setting_dictionary *dictionary = service->dictionary;
+    assert(offset >= 0);
+    assert(*set_ar);
+    if (offset >= *num)
+    {
+        int i, n_num = offset + 10;
+        struct setting **n_ar = nmem_malloc(nmem, n_num * sizeof(*n_ar));
+        for (i = 0; i < *num; i++)
+            n_ar[i] = (*set_ar)[i];
+        for (; i < n_num; i++)
+            n_ar[i] = 0;
+        *num = n_num;
+        *set_ar = n_ar;
+    }
+}
 
-    int i;
-    char *p;
+void expand_settings_array2(struct settings *settings, int offset, NMEM nmem)
+{
+    assert(offset >= 0);
+    assert(settings);
+    if (offset >= settings->num_settings)
+    {
+        int i, n_num = offset + 10;
+        struct setting **n_ar = nmem_malloc(nmem, n_num * sizeof(*n_ar));
+        for (i = 0; i < settings->num_settings; i++)
+            n_ar[i] = settings->settings[i];
+        for (; i < n_num; i++)
+            n_ar[i] = 0;
+        settings->num_settings = n_num;
+        settings->settings = n_ar;
+    }
+}
 
-    // Determine if we already have a dictionary entry
-    if (!strncmp(set->name, "pz:", 3) && (p = strchr(set->name + 3, ':')))
-        *(p + 1) = '\0';
-    for (i = 0; i < dictionary->num; i++)
-        if (!strcmp(dictionary->dict[i], set->name))
-            return;
+static void update_settings(struct setting *set, struct settings *settings, int offset, NMEM nmem)
+{
+    struct setting **sp;
+    yaz_log(YLOG_LOG, "update service settings offset %d with %s=%s", offset, set->name, set->value);
+    expand_settings_array2(settings, offset, nmem);
 
-    if (!strncmp(set->name, "pz:", 3)) // Probably a typo in config file
+    // First we determine if this setting is overriding any existing settings
+    // with the same name.
+    assert(offset < settings->num_settings);
+    for (sp = &settings->settings[offset]; *sp; )
+        if (!strcmp((*sp)->name, set->name))
         {
-            yaz_log(YLOG_FATAL, "Unknown pz: setting '%s'", set->name);
-            exit(1);
+            if ((*sp)->precedence < set->precedence)
+            {
+                // We discard the value (nmem keeps track of the space)
+                *sp = (*sp)->next; // unlink value from existing setting
+            }
+            else if ((*sp)->precedence > set->precedence)
+            {
+                // Db contains a higher-priority setting. Abort search
+                break;
+            }
+            else if (zurl_wildcard((*sp)->target) > zurl_wildcard(set->target))
+            {
+                // target-specific value trumps wildcard. Delete.
+                *sp = (*sp)->next; // unlink.....
+            }
+            else if (zurl_wildcard((*sp)->target) < zurl_wildcard(set->target))
+                // Db already contains higher-priority setting. Abort search
+                break;
+            else
+                sp = &(*sp)->next;
         }
-
-    // Create a new dictionary entry
-    // Grow dictionary if necessary
-    if (!dictionary->size)
-        dictionary->dict =
-            nmem_malloc(service->nmem, (dictionary->size = 50) * sizeof(char*));
-    else if (dictionary->num + 1 > dictionary->size)
+        else
+            sp = &(*sp)->next;
+    if (!*sp) // is null when there are no higher-priority settings, so we add one
     {
-        char **tmp =
-            nmem_malloc(service->nmem, dictionary->size * 2 * sizeof(char*));
-        memcpy(tmp, dictionary->dict, dictionary->size * sizeof(char*));
-        dictionary->dict = tmp;
-        dictionary->size *= 2;
+        struct setting *new = nmem_malloc(nmem, sizeof(*new));
+        memset(new, 0, sizeof(*new));
+        new->precedence = set->precedence;
+        new->target = nmem_strdup_null(nmem, set->target);
+        new->name = nmem_strdup_null(nmem, set->name);
+        new->value = nmem_strdup_null(nmem, set->value);
+        new->next = settings->settings[offset];
+        settings->settings[offset] = new;
     }
-    dictionary->dict[dictionary->num++] = nmem_strdup(service->nmem, set->name);
 }
 
 
-struct update_database_context {
-    struct setting *set;
-    struct conf_service *service;
-};
-
 // This is called from grep_databases -- adds/overrides setting for a target
 // This is also where the rules for precedence of settings are implemented
-static void update_database(void *context, struct database *db)
+static void update_database_fun(void *context, struct database *db)
 {
     struct setting *set = ((struct update_database_context *)
                            context)->set;
     struct conf_service *service = ((struct update_database_context *) 
                                     context)->service;
-    struct setting *s, **sp;
+    struct setting **sp;
     int offset;
 
     // Is this the right database?
-    if (!match_zurl(db->url, set->target))
+    if (!match_zurl(db->id, set->target))
         return;
 
-    if ((offset = settings_offset_cprefix(service, set->name)) < 0)
-        return ;
+    offset = settings_create_offset(service, set->name);
+    expand_settings_array(&db->settings, &db->num_settings, offset, service->nmem);
 
     // First we determine if this setting is overriding  any existing settings
     // with the same name.
-    for (s = db->settings[offset], sp = &db->settings[offset]; s;
-            sp = &s->next, s = s->next)
-        if (!strcmp(s->name, set->name))
+    assert(offset < db->num_settings);
+    for (sp = &db->settings[offset]; *sp; )
+        if (!strcmp((*sp)->name, set->name))
         {
-            if (s->precedence < set->precedence)
+            if ((*sp)->precedence < set->precedence)
+            {
                 // We discard the value (nmem keeps track of the space)
                 *sp = (*sp)->next; // unlink value from existing setting
-            else if (s->precedence > set->precedence)
+            }
+            else if ((*sp)->precedence > set->precedence)
+            {
                 // Db contains a higher-priority setting. Abort search
                 break;
-            if (zurl_wildcard(s->target) > zurl_wildcard(set->target))
+            }
+            else if (zurl_wildcard((*sp)->target) > zurl_wildcard(set->target))
+            {
                 // target-specific value trumps wildcard. Delete.
                 *sp = (*sp)->next; // unlink.....
-            else if (!zurl_wildcard(s->target))
+            }
+            else if (zurl_wildcard((*sp)->target) < zurl_wildcard(set->target))
                 // Db already contains higher-priority setting. Abort search
                 break;
+            else
+                sp = &(*sp)->next;
         }
-    if (!s) // s will be null when there are no higher-priority settings -- we add one
+        else
+            sp = &(*sp)->next;
+    if (!*sp) // is null when there are no higher-priority settings, so we add one
     {
         struct setting *new = nmem_malloc(service->nmem, sizeof(*new));
 
@@ -380,13 +480,13 @@ static void update_database(void *context, struct database *db)
 
 // Callback -- updates database records with dictionary entries as appropriate
 // This is used in pass 2 to assign name/value pairs to databases
-static void update_databases(struct conf_service *service, 
-                             struct setting *set)
+static void update_databases(void *client_data, struct setting *set)
 {
+    struct conf_service *service = (struct conf_service *) client_data;
     struct update_database_context context;
     context.set = set;
     context.service = service;
-    predef_grep_databases(&context, service, 0, update_database);
+    predef_grep_databases(&context, service, update_database_fun);
 }
 
 // This simply copies the 'hard' (application-specific) settings
@@ -402,46 +502,49 @@ static void initialize_hard_settings(struct conf_service *service)
 
 // Read any settings names introduced in service definition (config) and add to dictionary
 // This is done now to avoid errors if user settings are declared in session overrides
-static void initialize_soft_settings(struct conf_service *service)
+void initialize_soft_settings(struct conf_service *service)
 {
     int i;
-
     for (i = 0; i < service->num_metadata; i++)
     {
-        struct setting set;
         struct conf_metadata *md = &service->metadata[i];
 
-        if (md->setting == Metadata_setting_no)
-            continue;
-
-        set.precedence = 0;
-        set.target = "";
-        set.name = md->name;
-        set.value = "";
-        set.next = 0;
-        prepare_dictionary(service, &set);
+        if (md->setting != Metadata_setting_no)
+            settings_create_offset(service, md->name);
+
+        // Also create setting for some metadata attributes.
+        if (md->limitmap) {
+            int index; 
+            WRBUF wrbuf = wrbuf_alloc();
+            yaz_log(YLOG_DEBUG, "Metadata %s has limitmap: %s ",md->name,  md->limitmap);
+            wrbuf_printf(wrbuf, "pz:limitmap:%s", md->name);
+            index = settings_create_offset(service, wrbuf_cstr(wrbuf));
+            if (index >= 0) {
+                struct setting new;
+                int offset;
+                yaz_log(YLOG_DEBUG, "Service %s default %s=%s",
+                        (service->id ? service->id: "unknown"), wrbuf_cstr(wrbuf), md->limitmap);
+                new.name = (char *) wrbuf_cstr(wrbuf);
+                new.value = md->limitmap;
+                new.next = 0;
+                new.target = 0;
+                new.precedence = 0;
+                offset = settings_create_offset(service, new.name);
+                update_settings(&new, service->settings, offset, service->nmem);
+            }
+            wrbuf_destroy(wrbuf);
+        // TODO same for facetmap
+        }
     }
 }
 
-static void prepare_target_dictionary(struct conf_service *service,
-                                      struct setting *set)
+static void prepare_target_dictionary(void *client_data, struct setting *set)
 {
-    struct setting_dictionary *dictionary = service->dictionary;
-
-    int i;
-    char *p;
+    struct conf_service *service = (struct conf_service *) client_data;
 
     // If target address is not wildcard, add the database
     if (*set->target && !zurl_wildcard(set->target))
-        find_database(set->target, 0, service);
-
-    // Determine if we already have a dictionary entry
-    if (!strncmp(set->name, "pz:", 3) && (p = strchr(set->name + 3, ':')))
-        *(p + 1) = '\0';
-    for (i = 0; i < dictionary->num; i++)
-        if (!strcmp(dictionary->dict[i], set->name))
-            return;
-    yaz_log(YLOG_WARN, "Setting '%s' not configured as metadata", set->name);
+        create_database_for_service(set->target, service);
 }
 
 void init_settings(struct conf_service *service)
@@ -470,9 +573,9 @@ void settings_read_node(struct conf_service *service, xmlNode *n,
                         int pass)
 {
     if (pass == 1)
-        read_settings_node(n, service, prepare_target_dictionary);
+        settings_read_node_x(n, service, prepare_target_dictionary);
     else
-        read_settings_node(n, service, update_databases);
+        settings_read_node_x(n, service, update_databases);
 }
 
 /*