Happy new year
[pazpar2-moved-to-github.git] / src / database.c
index 214d3a0..2064fee 100644 (file)
@@ -1,7 +1,5 @@
-/* $Id: database.c,v 1.9 2007-04-11 02:14:15 quinn Exp $
-   Copyright (c) 2006-2007, Index Data.
-
-This file is part of Pazpar2.
+/* This file is part of Pazpar2.
+   Copyright (C) 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,183 +12,111 @@ 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
+
+*/
+
+#if HAVE_CONFIG_H
+#include <config.h>
+#endif
 
-#include <libxml/parser.h>
-#include <libxml/tree.h>
-#include <libxslt/xslt.h>
-#include <libxslt/transform.h>
-#include <libxslt/xsltutils.h>
 #include <assert.h>
 #include <sys/types.h>
 #include <sys/stat.h>
+#include <yaz/log.h>
+#include <yaz/nmem.h>
 
-#include "pazpar2.h"
-#include "config.h"
+#include "ppmutex.h"
+#include "session.h"
+#include "pazpar2_config.h"
 #include "settings.h"
 #include "http.h"
-#include "zeerex.h"
+#include "database.h"
 
 #include <sys/types.h>
-#include <sys/socket.h>
-#include <netdb.h>
-#include <netinet/in.h>
 
-static struct host *hosts = 0;  // The hosts we know about 
-static struct database *databases = 0; // The databases we know about
-static NMEM nmem = 0;
+enum pazpar2_database_criterion_type {
+    PAZPAR2_STRING_MATCH,
+    PAZPAR2_SUBSTRING_MATCH
+};
 
-static xmlDoc *get_explain_xml(const char *id)
-{
-    struct stat st;
-    char *dir;
-    char path[256];
-    char ide[256];
-    if (!config || !config->targetprofiles)
-    {
-        yaz_log(YLOG_WARN, "Config must be loaded and specify targetprofiles");
-        return 0;
-    }
-    if (config->targetprofiles->type != Targetprofiles_local)
-    {
-        yaz_log(YLOG_FATAL, "Only supports local type");
-        return 0;
-    }
-    dir = config->targetprofiles->src;
-    urlencode(id, ide);
-    sprintf(path, "%s/%s", dir, ide);
-    if (!stat(path, &st))
-        return xmlParseFile(path);
-    else
-        return 0;
-}
+struct database_criterion_value {
+    char *value;
+    struct database_criterion_value *next;
+};
 
-// Create a new host structure for hostport
-static struct host *create_host(const char *hostport)
-{
-    struct addrinfo *addrinfo, hints;
-    struct host *host;
-    char *port;
-    char ipport[128];
-    unsigned char addrbuf[4];
-    int res;
-
-    host = xmalloc(sizeof(struct host));
-    host->hostport = xstrdup(hostport);
-    host->connections = 0;
-
-    if ((port = strchr(hostport, ':')))
-        *(port++) = '\0';
-    else
-        port = "210";
-
-    hints.ai_flags = 0;
-    hints.ai_family = PF_INET;
-    hints.ai_socktype = SOCK_STREAM;
-    hints.ai_protocol = IPPROTO_TCP;
-    hints.ai_addrlen = 0;
-    hints.ai_addr = 0;
-    hints.ai_canonname = 0;
-    hints.ai_next = 0;
-    // This is not robust code. It assumes that getaddrinfo always
-    // returns AF_INET address.
-    if ((res = getaddrinfo(hostport, port, &hints, &addrinfo)))
-    {
-        yaz_log(YLOG_WARN, "Failed to resolve %s: %s", hostport, gai_strerror(res));
-        xfree(host->hostport);
-        xfree(host);
-        return 0;
-    }
-    assert(addrinfo->ai_family == PF_INET);
-    memcpy(addrbuf, &((struct sockaddr_in*)addrinfo->ai_addr)->sin_addr.s_addr, 4);
-    sprintf(ipport, "%u.%u.%u.%u:%s",
-            addrbuf[0], addrbuf[1], addrbuf[2], addrbuf[3], port);
-    host->ipport = xstrdup(ipport);
-    freeaddrinfo(addrinfo);
-    host->next = hosts;
-    hosts = host;
-    return host;
-}
+struct database_criterion {
+    char *name;
+    enum pazpar2_database_criterion_type type;
+    struct database_criterion_value *values;
+    struct database_criterion *next;
+};
 
-static struct host *find_host(const char *hostport)
+struct database *new_database(const char *id, NMEM nmem)
 {
-    struct host *p;
-    for (p = hosts; p; p = p->next)
-        if (!strcmp(p->hostport, hostport))
-            return p;
-    return create_host(hostport);
+    return new_database_inherit_settings(id, nmem, 0);
 }
-
-static struct database *load_database(const char *id)
+struct database *new_database_inherit_settings(const char *id, NMEM nmem, struct settings_array *service_settings)
 {
-    xmlDoc *doc = get_explain_xml(id);
-    struct zr_explain *explain = 0;
     struct database *db;
-    struct host *host;
-    char hostport[256];
-    char *dbname;
+    struct setting *idset;
 
-    if (!nmem)
-        nmem = nmem_create();
-    if (doc)
-    {
-        explain = zr_read_xml(nmem, xmlDocGetRootElement(doc));
-        if (!explain)
-            return 0;
-    }
-    if (strlen(id) > 255)
-        return 0;
-    strcpy(hostport, id);
-    if ((dbname = strchr(hostport, '/')))
-        *(dbname++) = '\0';
-    else
-        dbname = "Default";
-    if (!(host = find_host(hostport)))
-        return 0;
     db = nmem_malloc(nmem, sizeof(*db));
-    memset(db, 0, sizeof(*db));
-    db->host = host;
-    db->url = nmem_strdup(nmem, id);
-    db->name = 0;
-    db->databases = xmalloc(2 * sizeof(char *));
-    db->databases[0] = nmem_strdup(nmem, dbname);
-    db->databases[1] = 0;
-    db->errors = 0;
-    db->explain = explain;
-    db->settings = 0;
-    db->next = databases;
-    db->ccl_map = 0;
-    db->yaz_marc = 0;
-    db->map = 0;
-    databases = db;
+    db->id = nmem_strdup(nmem, id);
+    db->next = 0;
+
+    if (service_settings && service_settings->num_settings > 0) {
+        yaz_log(YLOG_DEBUG, "copying settings from service to database %s settings", db->id);
+        db->num_settings = service_settings->num_settings;
+        db->settings = nmem_malloc(nmem, sizeof(*db->settings) * db->num_settings);
+        // Initialize database settings with service settings
+        memcpy(db->settings, service_settings->settings,  sizeof(*db->settings) * db->num_settings);
+    }
+    else {
+        yaz_log(YLOG_DEBUG, "No service settings to database %s ", db->id);
+        db->num_settings = PZ_MAX_EOF;
+        db->settings = nmem_malloc(nmem, sizeof(*db->settings) * db->num_settings);
+        memset(db->settings, 0, sizeof(*db->settings) * db->num_settings);
+    }
+    idset = nmem_malloc(nmem, sizeof(*idset));
+    idset->precedence = 0;
+    idset->name = "pz:id";
+    idset->target = idset->value = db->id;
+    idset->next = db->settings[PZ_ID];
+    db->settings[PZ_ID] = idset;
 
     return db;
 }
 
 // Return a database structure by ID. Load and add to list if necessary
 // new==1 just means we know it's not in the list
-struct database *find_database(const char *id, int new)
+struct database *create_database_for_service(const char *id,
+                                             struct conf_service *service)
 {
     struct database *p;
-    if (!new)
-    {
-        for (p = databases; p; p = p->next)
-            if (!strcmp(p->url, id))
-                return p;
-    }
-    return load_database(id);
+    for (p = service->databases; p; p = p->next)
+        if (!strcmp(p->id, id))
+            return p;
+
+    yaz_log(YLOG_DEBUG, "new database %s under service %s", id,
+       service->id ? service->id : "null");
+    p = new_database_inherit_settings(id, service->nmem, service->settings);
+    p->next = service->databases;
+    service->databases = p;
+
+    return p;
 }
 
-// This whole session_grep database thing should be moved to pazpar2.c
+// This whole session_grep database thing should be moved elsewhere
 
 int match_zurl(const char *zurl, const char *pattern)
 {
+    int len;
+
     if (!strcmp(pattern, "*"))
         return 1;
-    else if (!strncmp(pattern, "*/", 2))
+    else if (!strncmp(pattern, "*/", 2))   // host wildcard.. what the heck is that for?
     {
         char *db = strchr(zurl, '/');
         if (!db)
@@ -200,6 +126,13 @@ int match_zurl(const char *zurl, const char *pattern)
         else
             return 0;
     }
+    else if (*(pattern + (len = strlen(pattern) - 1)) == '*')  // db wildcard
+    {
+        if (!strncmp(pattern, zurl, len))
+            return 1;
+        else
+            return 0;
+    }
     else if (!strcmp(pattern, zurl))
         return 1;
     else
@@ -207,9 +140,11 @@ int match_zurl(const char *zurl, const char *pattern)
 }
 
 // This will be generalized at some point
-static int match_criterion(struct setting **settings, struct database_criterion *c)
+static int match_criterion(struct setting **settings,
+                           struct conf_service *service,
+                           struct database_criterion *c)
 {
-    int offset = settings_offset(c->name);
+    int offset = settings_lookup_offset(service, c->name);
     struct database_criterion_value *v;
 
     if (offset < 0)
@@ -221,28 +156,90 @@ static int match_criterion(struct setting **settings, struct database_criterion
         return 0;
     for (v = c->values; v; v = v->next)
     {
-        if (offset == PZ_ID)
+        if (c->type == PAZPAR2_STRING_MATCH)
         {
-            if (match_zurl(settings[offset]->value, v->value))
-                return 1;
+            if (offset == PZ_ID)
+            {
+                if (match_zurl(settings[offset]->value, v->value))
+                    break;
+            }
             else
-                return 0;
+            {
+                if (!strcmp(settings[offset]->value, v->value))
+                    break;
+            }
         }
-        else 
+        else if (c->type == PAZPAR2_SUBSTRING_MATCH)
         {
-            if (!strcmp(settings[offset]->value, v->value))
-                return 1;
-            else
-                return 0;
+            if (strstr(settings[offset]->value, v->value))
+                break;
+        }
+    }
+    if (v)
+        return 1;
+    else
+        return 0;
+}
+
+// parses crit1=val1,crit2=val2|val3,...
+static struct database_criterion *create_database_criterion(NMEM m,
+                                                            const char *buf)
+{
+    struct database_criterion *res = 0;
+    char **values;
+    int num;
+    int i;
+
+    if (!buf || !*buf)
+        return 0;
+    nmem_strsplit(m, ",", buf,  &values, &num);
+    for (i = 0; i < num; i++)
+    {
+        char **subvalues;
+        int subnum;
+        int subi;
+        struct database_criterion *new = nmem_malloc(m, sizeof(*new));
+        char *eq;
+        for (eq = values[i]; *eq; eq++)
+            if (*eq == '=')
+            {
+                new->type = PAZPAR2_STRING_MATCH;
+                break;
+            }
+            else if (*eq == '~')
+            {
+                new->type = PAZPAR2_SUBSTRING_MATCH;
+                break;
+            }
+        if (!*eq)
+        {
+            yaz_log(YLOG_WARN, "Missing equal-sign/tilde in filter");
+            return 0;
+        }
+        *(eq++) = '\0';
+        new->name = values[i];
+        nmem_strsplit(m, "|", eq, &subvalues, &subnum);
+        new->values = 0;
+        for (subi = 0; subi < subnum; subi++)
+        {
+            struct database_criterion_value *newv
+                = nmem_malloc(m, sizeof(*newv));
+            newv->value = subvalues[subi];
+            newv->next = new->values;
+            new->values = newv;
         }
+        new->next = res;
+        res = new;
     }
-    return 0;
+    return res;
 }
 
-int database_match_criteria(struct setting **settings, struct database_criterion *cl)
+static int database_match_criteria(struct setting **settings,
+                                   struct conf_service *service,
+                                   struct database_criterion *cl)
 {
     for (; cl; cl = cl->next)
-        if (!match_criterion(settings, cl))
+        if (!match_criterion(settings, service, cl))
             break;
     if (cl) // one of the criteria failed to match -- skip this db
         return 0;
@@ -252,29 +249,38 @@ int database_match_criteria(struct setting **settings, struct database_criterion
 
 // Cycles through databases, calling a handler function on the ones for
 // which all criteria matched.
-int session_grep_databases(struct session *se, struct database_criterion *cl,
-        void (*fun)(void *context, struct session_database *db))
+int session_grep_databases(struct session *se, const char *filter,
+                           void (*fun)(struct session *se, struct session_database *db))
 {
     struct session_database *p;
+    NMEM nmem = nmem_create();
     int i = 0;
+    struct database_criterion *cl = create_database_criterion(nmem, filter);
 
     for (p = se->databases; p; p = p->next)
-        if (database_match_criteria(p->settings, cl))
+    {
+        if (p->settings && p->settings[PZ_ALLOW] && *p->settings[PZ_ALLOW]->value == '0')
+            continue;
+        if (!p->settings[PZ_NAME])
+            continue;
+        if (database_match_criteria(p->settings, se->service, cl))
         {
             (*fun)(se, p);
             i++;
         }
+    }
+    nmem_destroy(nmem);
     return i;
 }
 
-int grep_databases(void *context, struct database_criterion *cl,
-        void (*fun)(void *context, struct database *db))
+int predef_grep_databases(void *context, struct conf_service *service,
+                          void (*fun)(void *context, struct database *db))
 {
     struct database *p;
     int i = 0;
 
-    for (p = databases; p; p = p->next)
-        if (database_match_criteria(p->settings, cl))
+    for (p = service->databases; p; p = p->next)
+        if (database_match_criteria(p->settings, service, 0))
         {
             (*fun)(context, p);
             i++;
@@ -282,144 +288,12 @@ int grep_databases(void *context, struct database_criterion *cl,
     return i;
 }
 
-// Initialize CCL map for a target
-// Note: This approach ignores user-specific CCL maps, for which I
-// don't presently see any application.
-static void prepare_cclmap(void *ignore, struct database *db)
-{
-    struct setting *s;
-
-    if (!db->settings)
-        return;
-    db->ccl_map = ccl_qual_mk();
-    for (s = db->settings[PZ_CCLMAP]; s; s = s->next)
-        if (!*s->user)
-        {
-            char *p = strchr(s->name + 3, ':');
-            if (!p)
-            {
-                yaz_log(YLOG_FATAL, "Malformed cclmap name: %s", s->name);
-                exit(1);
-            }
-            p++;
-            ccl_qual_fitem(db->ccl_map, s->value, p);
-        }
-}
-
-// Initialize YAZ Map structures for MARC-based targets
-static void prepare_yazmarc(void *ignore, struct database *db)
-{
-    struct setting *s;
-
-    if (!db->settings)
-        return;
-    for (s = db->settings[PZ_NATIVESYNTAX]; s; s = s->next)
-        if (!*s->user && !strcmp(s->value, "iso2709"))
-        {
-            char *encoding = "marc-8s";
-            yaz_iconv_t cm;
-
-            db->yaz_marc = yaz_marc_create();
-            yaz_marc_subfield_str(db->yaz_marc, "\t");
-            // See if a native encoding is specified
-            for (s = db->settings[PZ_ENCODING]; s; s = s->next)
-                if (!*s->user)
-                {
-                    encoding = s->value;
-                    break;
-                }
-            if (!(cm = yaz_iconv_open("utf-8", encoding)))
-            {
-                yaz_log(YLOG_FATAL, "Unable to map from %s to UTF-8", encoding);
-                exit(1);
-            }
-            yaz_marc_iconv(db->yaz_marc, cm);
-            break;
-        }
-}
-
-// Prepare XSLT stylesheets for record normalization
-static void prepare_map(void *ignore, struct database *db)
-{
-    struct setting *s;
-
-    if (!db->settings)
-        return;
-    for (s = db->settings[PZ_XSLT]; s; s = s->next)
-        if (!*s->user)
-        {
-            char **stylesheets;
-            struct database_retrievalmap **m = &db->map;
-            int num, i;
-
-            nmem_strsplit(nmem, ",", s->value, &stylesheets, &num);
-            for (i = 0; i < num; i++)
-            {
-                (*m) = nmem_malloc(nmem, sizeof(**m));
-                (*m)->next = 0;
-                if (!((*m)->stylesheet = conf_load_stylesheet(stylesheets[i])))
-                {
-                    yaz_log(YLOG_FATAL, "Unable to load stylesheet: %s",
-                            stylesheets[i]);
-                    exit(1);
-                }
-                m = &(*m)->next;
-            }
-            break;
-        }
-    if (!s)
-        yaz_log(YLOG_WARN, "No Normalization stylesheet for target %s", db->url);
-}
-
-// Read settings for each database, and prepare support data structures
-void prepare_databases(void)
-{
-    grep_databases(0, 0, prepare_cclmap);
-    grep_databases(0, 0, prepare_yazmarc);
-    grep_databases(0, 0, prepare_map);
-}
-
-// This function will most likely vanish when a proper target profile mechanism is
-// introduced.
-void load_simpletargets(const char *fn)
-{
-    FILE *f = fopen(fn, "r");
-    char line[256];
-
-    if (!f)
-    {
-        yaz_log(YLOG_WARN|YLOG_ERRNO, "open %s", fn);
-        exit(1);
-    }
-
-    while (fgets(line, 255, f))
-    {
-        char *url;
-        char *name;
-        struct database *db;
-
-        if (strncmp(line, "target ", 7))
-            continue;
-        line[strlen(line) - 1] = '\0';
-
-        if ((name = strchr(line, ';')))
-            *(name++) = '\0';
-
-        url = line + 7;
-
-        if (!(db = find_database(url, 0)))
-            yaz_log(YLOG_WARN, "Unable to load database %s", url);
-        if (name && db)
-            db->name = nmem_strdup(nmem, name);
-    }
-    fclose(f);
-}
-
-
 /*
  * Local variables:
  * c-basic-offset: 4
+ * c-file-style: "Stroustrup"
  * indent-tabs-mode: nil
  * End:
  * vim: shiftwidth=4 tabstop=8 expandtab
  */
+