Added check for Unix specific headers and harmonize with Win32 build.
[pazpar2-moved-to-github.git] / src / settings.c
index e86b9d1..bea5da7 100644 (file)
@@ -1,7 +1,5 @@
-/* $Id: settings.c,v 1.13 2007-04-11 18:42:25 quinn Exp $
-   Copyright (c) 2006-2007, Index Data.
-
-This file is part of Pazpar2.
+/* This file is part of Pazpar2.
+   Copyright (C) 2006-2008 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
@@ -14,20 +12,25 @@ FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 for more details.
 
 You should have received a copy of the GNU General Public License
-along with Pazpar2; see the file LICENSE.  If not, write to the
-Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA
-02111-1307, USA.
- */
+along with this program; if not, write to the Free Software
+Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+
+*/
 
+// This module implements a generic system of settings
+// (attribute-value) that can be associated with search targets. The
+// system supports both default values, per-target overrides, and
+// per-user settings.
+
+#if HAVE_CONFIG_H
+#include <config.h>
+#endif
 
-// This module implements a generic system of settings (attribute-value) that can 
-// be associated with search targets. The system supports both default values,
-// per-target overrides, and per-user settings.
 
 #include <string.h>
 #include <stdio.h>
 #include <sys/types.h>
-#include <dirent.h>
+#include "direntz.h"
 #include <stdlib.h>
 #include <sys/stat.h>
 
@@ -49,7 +52,6 @@ static char *hard_settings[] = {
     "pz:elements",
     "pz:requestsyntax",
     "pz:cclmap:",
-    "pz:encoding",
     "pz:xslt",
     "pz:nativesyntax",
     "pz:authentication",
@@ -57,6 +59,10 @@ static char *hard_settings[] = {
     "pz:maxrecs",
     "pz:id",
     "pz:name",
+    "pz:queryencoding",
+    "pz:ip",
+    "pz:zproxy",
+    "pz:apdulog",
     0
 };
 
@@ -69,6 +75,11 @@ struct setting_dictionary
 
 static struct setting_dictionary *dictionary = 0;
 
+// This establishes the precedence of wildcard expressions
+#define SETTING_WILDCARD_NO     0 // No wildcard
+#define SETTING_WILDCARD_DB     1 // Database wildcard 'host:port/*'
+#define SETTING_WILDCARD_YES    2 // Complete wildcard '*'
+
 // Returns size of settings directory
 int settings_num(void)
 {
@@ -89,7 +100,7 @@ int settings_offset(const char *name)
 
 // Ignores everything after second colon, if present
 // A bit of a hack to support the pz:cclmap: scheme (and more to come?)
-static int settings_offset_cprefix(const char *name)
+int settings_offset_cprefix(const char *name)
 {
     const char *p;
     int maxlen = 100;
@@ -163,7 +174,6 @@ static void read_settings_file(const char *path,
                 struct setting set;
                 char nameb[1024];
                 char targetb[1024];
-                char userb[1024];
                 char valueb[1024];
 
                 // Copy everything into a temporary buffer -- we decide
@@ -174,13 +184,6 @@ static void read_settings_file(const char *path,
                     set.precedence = atoi((char *) precedencea);
                 else
                     set.precedence = 0;
-                set.user = userb;
-                if (user)
-                    strcpy(userb, user);
-                else if (usera)
-                    strcpy(userb, (const char *) usera);
-                else
-                    set.user = "";
                 if (target)
                     strcpy(targetb, target);
                 else
@@ -220,35 +223,47 @@ static void read_settings_file(const char *path,
     xmlFreeDoc(doc);
 }
  
-// Recursively read files in a directory structure, calling 
+// Recursively read files or directories, invoking a 
 // callback for each one
 static void read_settings(const char *path,
                void (*fun)(struct setting *set))
 {
     DIR *d;
     struct dirent *de;
+    char *dot;
 
-    if (!(d = opendir(path)))
+    if (isdir(path))
     {
-        yaz_log(YLOG_FATAL|YLOG_ERRNO, "%s", path);
-        exit(1);
-    }
-    while ((de = readdir(d)))
-    {
-        char tmp[1024];
-        if (*de->d_name == '.' || !strcmp(de->d_name, "CVS"))
-            continue;
-        sprintf(tmp, "%s/%s", path, de->d_name);
-        if (isdir(tmp))
-            read_settings(tmp, fun);
-        else
+        if (!(d = opendir(path)))
+        {
+            yaz_log(YLOG_FATAL|YLOG_ERRNO, "%s", path);
+            exit(1);
+        }
+        while ((de = readdir(d)))
         {
-            char *dot;
-            if ((dot = rindex(de->d_name, '.')) && !strcmp(dot + 1, "xml"))
-                read_settings_file(tmp, fun);
+            char tmp[1024];
+            if (*de->d_name == '.' || !strcmp(de->d_name, "CVS"))
+                continue;
+            sprintf(tmp, "%s/%s", path, de->d_name);
+            read_settings(tmp, fun);
         }
+        closedir(d);
     }
-    closedir(d);
+    else if ((dot = strrchr(path, '.')) && !strcmp(dot + 1, "xml"))
+        read_settings_file(path, fun);
+}
+
+// Determines if a ZURL is a wildcard, and what kind
+static int zurl_wildcard(const char *zurl)
+{
+    if (!zurl)
+        return SETTING_WILDCARD_NO;
+    if (*zurl == '*')
+        return SETTING_WILDCARD_YES;
+    else if (*(zurl + strlen(zurl) - 1) == '*')
+        return SETTING_WILDCARD_DB;
+    else
+        return SETTING_WILDCARD_NO;
 }
 
 // Callback. Adds a new entry to the dictionary if necessary
@@ -260,7 +275,7 @@ static void prepare_dictionary(struct setting *set)
     char *p;
 
     // If target address is not wildcard, add the database
-    if (*set->target && set->target[strlen(set->target) - 1] != '*')
+    if (*set->target && !zurl_wildcard(set->target))
         find_database(set->target, 0);
 
     // Determine if we already have a dictionary entry
@@ -270,11 +285,12 @@ static void prepare_dictionary(struct setting *set)
         if (!strcmp(dictionary->dict[i], set->name))
             return;
 
-    if (!strncmp(set->name, "pz:", 3)) // Probably a typo in config fle
-    {
-        yaz_log(YLOG_FATAL, "Unknown pz: setting '%s'", set->name);
-        exit(1);
-    }
+    if (!strncmp(set->name, "pz:", 3)) // Probably a typo in config file
+        {
+            yaz_log(YLOG_FATAL, "Unknown pz: setting '%s'", set->name);
+            exit(1);
+        }
+
     // Create a new dictionary entry
     // Grow dictionary if necessary
     if (!dictionary->size)
@@ -301,21 +317,6 @@ static void update_database(void *context, struct database *db)
     if (!match_zurl(db->url, set->target))
         return;
 
-    // Initialize settings array if it doesn't exist.
-    // If so, also set the 'id' automatic setting
-    if (!db->settings)
-    {
-        struct setting *id = nmem_malloc(nmem, sizeof(struct setting));
-
-        db->settings = nmem_malloc(nmem, sizeof(struct settings*) * dictionary->num);
-        memset(db->settings, 0, sizeof(struct settings*) * dictionary->num);
-        id->precedence = 0;
-        id->name = "pz:id";
-        id->target = id->value = db->url;
-        id->user = "";
-        id->next = 0;
-        db->settings[PZ_ID] = id;
-    }
     if ((offset = settings_offset_cprefix(set->name)) < 0)
         abort(); // Should never get here
 
@@ -323,19 +324,19 @@ static void update_database(void *context, struct database *db)
     // with the same name.
     for (s = db->settings[offset], sp = &db->settings[offset]; s;
             sp = &s->next, s = s->next)
-        if (!strcmp(s->user, set->user) && !strcmp(s->name, set->name))
+        if (!strcmp(s->name, set->name))
         {
             if (s->precedence < set->precedence)
                 // We discard the value (nmem keeps track of the space)
-                *sp = (*sp)->next;
+                *sp = (*sp)->next; // unlink value from existing setting
             else if (s->precedence > set->precedence)
-                // Db contains a higher-priority setting. Abort 
+                // Db contains a higher-priority setting. Abort search
                 break;
-            if (*s->target == '*' && *set->target != '*')
+            if (zurl_wildcard(s->target) > zurl_wildcard(set->target))
                 // target-specific value trumps wildcard. Delete.
-                *sp = (*sp)->next;
-            else if (*s->target != '*' && *set->target == '*')
-                // Db already contains higher-priority setting. Abort
+                *sp = (*sp)->next; // unlink.....
+            else if (!zurl_wildcard(s->target))
+                // Db already contains higher-priority setting. Abort search
                 break;
         }
     if (!s) // s will be null when there are no higher-priority settings -- we add one
@@ -347,7 +348,6 @@ static void update_database(void *context, struct database *db)
         new->target = nmem_strdup(nmem, set->target);
         new->name = nmem_strdup(nmem, set->name);
         new->value = nmem_strdup(nmem, set->value);
-        new->user = nmem_strdup(nmem, set->user);
         new->next = db->settings[offset];
         db->settings[offset] = new;
     }
@@ -357,7 +357,7 @@ static void update_database(void *context, struct database *db)
 // This is used in pass 2 to assign name/value pairs to databases
 static void update_databases(struct setting *set)
 {
-    grep_databases(set, 0, update_database);
+    predef_grep_databases(set, 0, update_database);
 }
 
 // This simply copies the 'hard' (application-specific) settings
@@ -370,11 +370,41 @@ static void initialize_hard_settings(struct setting_dictionary *dict)
     dict->num = dict->size;
 }
 
+// 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 = config->servers->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(&set);
+    }
+}
+
 // If we ever decide we need to be able to specify multiple settings directories,
 // the two calls to read_settings must be split -- so the dictionary is prepared
 // for the contents of every directory before the databases are updated.
 void settings_read(const char *path)
 {
+    read_settings(path, prepare_dictionary);
+    read_settings(path, update_databases);
+}
+
+void init_settings(void)
+{
     struct setting_dictionary *new;
     if (!nmem)
         nmem = nmem_create();
@@ -384,8 +414,7 @@ void settings_read(const char *path)
     memset(new, 0, sizeof(*new));
     initialize_hard_settings(new);
     dictionary = new;
-    read_settings(path, prepare_dictionary);
-    read_settings(path, update_databases);
+    initialize_soft_settings();
 }
 
 /*