Added error-reporting for the case where a HTTP response is 200 OK but
[pazpar2-moved-to-github.git] / src / logic.c
index 09fb3fd..d5c8f76 100644 (file)
@@ -68,7 +68,6 @@ Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 #include "client.h"
 #include "settings.h"
 #include "normalize7bit.h"
-#include "marcmap.h"
 
 #define TERMLIST_HIGH_SCORE 25
 
@@ -78,8 +77,7 @@ Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 struct parameters global_parameters = 
 {
     0,   // dump_records
-    0,   // debug_mode
-    100,
+    0    // debug_mode
 };
 
 static void log_xml_doc(xmlDoc *doc)
@@ -147,14 +145,13 @@ static void add_facet(struct session *s, const char *type, const char *value)
 
         s->termlists[i].name = nmem_strdup(s->nmem, type);
         s->termlists[i].termlist 
-            = termlist_create(s->nmem, s->expected_maxrecs,
-                              TERMLIST_HIGH_SCORE);
+            = termlist_create(s->nmem, TERMLIST_HIGH_SCORE);
         s->num_termlists = i + 1;
     }
     termlist_insert(s->termlists[i].termlist, value);
 }
 
-xmlDoc *record_to_xml(struct session_database *sdb, const char *rec)
+static xmlDoc *record_to_xml(struct session_database *sdb, const char *rec)
 {
     struct database *db = sdb->database;
     xmlDoc *rdoc = 0;
@@ -194,7 +191,7 @@ static void insert_settings_parameters(struct session_database *sdb,
         int setting;
 
         if (md->setting == Metadata_setting_parameter &&
-            (setting = settings_offset(service, md->name)) > 0)
+            (setting = settings_lookup_offset(service, md->name)) >= 0)
         {
             const char *val = session_setting_oneval(sdb, setting);
             if (val && nparms < MAX_XSLT_ARGS)
@@ -227,7 +224,7 @@ static void insert_settings_values(struct session_database *sdb, xmlDoc *doc,
         int offset;
 
         if (md->setting == Metadata_setting_postproc &&
-            (offset = settings_offset(service, md->name)) > 0)
+            (offset = settings_lookup_offset(service, md->name)) >= 0)
         {
             const char *val = session_setting_oneval(sdb, offset);
             if (val)
@@ -241,58 +238,59 @@ static void insert_settings_values(struct session_database *sdb, xmlDoc *doc,
     }
 }
 
-xmlDoc *normalize_record(struct session_database *sdb, struct session *se,
-                         const char *rec)
+static xmlDoc *normalize_record(struct session_database *sdb,
+                                struct session *se,
+                                const char *rec)
 {
-    struct database_retrievalmap *m;
     xmlDoc *rdoc = record_to_xml(sdb, rec);
+
     if (rdoc)
     {
-        for (m = sdb->map; m; m = m->next)
+        char *parms[MAX_XSLT_ARGS*2+1];
+        
+        insert_settings_parameters(sdb, se, parms);
+        
+        if (normalize_record_transform(sdb->map, &rdoc, (const char **)parms))
+        {
+            yaz_log(YLOG_WARN, "Normalize failed from %s", sdb->database->url);
+        }
+        else
         {
-            xmlDoc *new = 0;
+            insert_settings_values(sdb, rdoc, se->service);
             
+            if (global_parameters.dump_records)
             {
-                xmlNodePtr root = 0;
-                char *parms[MAX_XSLT_ARGS*2+1];
-
-                insert_settings_parameters(sdb, se, parms);
-
-                if (m->stylesheet)
-                {
-                    new = xsltApplyStylesheet(m->stylesheet, rdoc, (const char **) parms);
-                }
-                else if (m->marcmap)
-                {
-                    new = marcmap_apply(m->marcmap, rdoc);
-                }
-
-                root = xmlDocGetRootElement(new);
-
-                if (!new || !root || !(root->children))
-                {
-                    yaz_log(YLOG_WARN, "XSLT transformation failed from %s",
-                            sdb->database->url);
-                    xmlFreeDoc(new);
-                    xmlFreeDoc(rdoc);
-                    return 0;
-                }
+                yaz_log(YLOG_LOG, "Normalized record from %s", 
+                        sdb->database->url);
+                log_xml_doc(rdoc);
             }
-            
-            xmlFreeDoc(rdoc);
-            rdoc = new;
         }
+    }
+    return rdoc;
+}
 
-        insert_settings_values(sdb, rdoc, se->service);
-
-        if (global_parameters.dump_records)
+void session_settings_dump(struct session *se,
+                           struct session_database *db,
+                           WRBUF w)
+{
+    if (db->settings)
+    {
+        int i, num = db->num_settings;
+        for (i = 0; i < num; i++)
         {
-            yaz_log(YLOG_LOG, "Normalized record from %s", 
-                    sdb->database->url);
-            log_xml_doc(rdoc);
+            struct setting *s = db->settings[i];
+            for (;s ; s = s->next)
+            {
+                wrbuf_puts(w, "<set name=\"");
+                wrbuf_xmlputs(w, s->name);
+                wrbuf_puts(w, "\" value=\"");
+                wrbuf_xmlputs(w, s->value);
+                wrbuf_puts(w, "\"/>");
+            }
+            if (db->settings[i])
+                wrbuf_puts(w, "\n");
         }
     }
-    return rdoc;
 }
 
 // Retrieve first defined value for 'name' for given database.
@@ -320,9 +318,6 @@ static int prepare_map(struct session *se, struct session_database *sdb)
     }
     if ((s = session_setting_oneval(sdb, PZ_XSLT)))
     {
-        char **stylesheets;
-        struct database_retrievalmap **m = &sdb->map;
-        int num, i;
         char auto_stylesheet[256];
 
         if (!strcmp(s, "auto"))
@@ -347,46 +342,11 @@ static int prepare_map(struct session *se, struct session_database *sdb)
                 yaz_log(YLOG_WARN, "No pz:requestsyntax for auto stylesheet");
             }
         }
-        nmem_strsplit(se->session_nmem, ",", s, &stylesheets, &num);
-        for (i = 0; i < num; i++)
-        {
-            WRBUF fname = conf_get_fname(se->service, stylesheets[i]);
-            
-            (*m) = nmem_malloc(se->session_nmem, sizeof(**m));
-            (*m)->next = 0;
-            
-            // XSLT
-            if (!strcmp(&stylesheets[i][strlen(stylesheets[i])-4], ".xsl")) 
-            {    
-                (*m)->marcmap = NULL;
-                if (!((*m)->stylesheet =
-                      xsltParseStylesheetFile((xmlChar *) wrbuf_cstr(fname))))
-                {
-                    yaz_log(YLOG_FATAL|YLOG_ERRNO, "Unable to load stylesheet: %s",
-                            stylesheets[i]);
-                    wrbuf_destroy(fname);
-                    return -1;
-                }
-            }
-            // marcmap
-            else if (!strcmp(&stylesheets[i][strlen(stylesheets[i])-5], ".mmap"))
-            {
-                (*m)->stylesheet = NULL;
-                if (!((*m)->marcmap = marcmap_load(wrbuf_cstr(fname), se->session_nmem)))
-                {
-                    yaz_log(YLOG_FATAL|YLOG_ERRNO, "Unable to load marcmap: %s",
-                            stylesheets[i]);
-                    wrbuf_destroy(fname);
-                    return -1;
-                }
-            }
-            wrbuf_destroy(fname);
-            m = &(*m)->next;
-        }
+        sdb->map = normalize_cache_get(se->normalize_cache,
+                                       se->service, s);
+        if (!sdb->map)
+            return -1;
     }
-    if (!sdb->map)
-        yaz_log(YLOG_WARN, "No Normalization stylesheet for target %s",
-                sdb->database->url);
     return 0;
 }
 
@@ -468,12 +428,12 @@ static void select_targets_callback(void *context, struct session_database *db)
 // Associates a set of clients with a session;
 // Note: Session-databases represent databases with per-session 
 // setting overrides
-int select_targets(struct session *se, struct database_criterion *crit)
+static int select_targets(struct session *se, const char *filter)
 {
     while (se->clients)
         client_destroy(se->clients);
 
-    return session_grep_databases(se, crit, select_targets_callback);
+    return session_grep_databases(se, filter, select_targets_callback);
 }
 
 int session_active_clients(struct session *s)
@@ -488,60 +448,17 @@ int session_active_clients(struct session *s)
     return res;
 }
 
-// parses crit1=val1,crit2=val2|val3,...
-static struct database_criterion *parse_filter(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;
-        if ((eq = strchr(values[i], '=')))
-            new->type = PAZPAR2_STRING_MATCH;
-        if ((eq = strchr(values[i], '~')))
-            new->type = PAZPAR2_SUBSTRING_MATCH;
-        if (!eq)
-        {
-            yaz_log(YLOG_WARN, "Missing equal-signi/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 res;
-}
 
 enum pazpar2_error_code search(struct session *se,
-                               const char *query, const char *filter,
+                               const char *query,
+                               const char *startrecs, const char *maxrecs,
+                               const char *filter,
                                const char **addinfo)
 {
     int live_channels = 0;
     int no_working = 0;
     int no_failed = 0;
     struct client *cl;
-    struct database_criterion *criteria;
 
     yaz_log(YLOG_DEBUG, "Search");
 
@@ -551,24 +468,22 @@ enum pazpar2_error_code search(struct session *se,
     se->total_records = se->total_hits = se->total_merged = 0;
     se->reclist = 0;
     se->num_termlists = 0;
-    criteria = parse_filter(se->nmem, filter);
-    live_channels = select_targets(se, criteria);
+    live_channels = select_targets(se, filter);
     if (live_channels)
     {
-        int maxrecs = live_channels * global_parameters.toget; // This is buggy!!!
-        se->reclist = reclist_create(se->nmem, maxrecs);
-        se->expected_maxrecs = maxrecs;
+        se->reclist = reclist_create(se->nmem);
     }
     else
         return PAZPAR2_NO_TARGETS;
 
     for (cl = se->clients; cl; cl = client_next_in_session(cl))
     {
+        if (maxrecs)
+            client_set_maxrecs(cl, atoi(maxrecs));
+        if (startrecs)
+            client_set_startrecs(cl, atoi(startrecs));
         if (prepare_session_database(se, client_get_database(cl)) < 0)
-        {
-            *addinfo = client_get_database(cl)->database->url;
-            return PAZPAR2_CONFIG_TARGET;
-        }
+            continue;
         // Parse query for target
         if (client_parse_query(cl, query) < 0)
             no_failed++;
@@ -576,16 +491,19 @@ enum pazpar2_error_code search(struct session *se,
         {
             no_working++;
             if (client_prep_connection(cl, se->service->z3950_operation_timeout,
-                    se->service->z3950_session_timeout))
+                                       se->service->z3950_session_timeout))
                 client_start_search(cl);
         }
     }
-
-    // If no queries could be mapped, we signal an error
     if (no_working == 0)
     {
-        *addinfo = "query";
-        return PAZPAR2_MALFORMED_PARAMETER_VALUE;
+        if (no_failed > 0)
+        {
+            *addinfo = "query";
+            return PAZPAR2_MALFORMED_PARAMETER_VALUE;
+        }
+        else
+            return PAZPAR2_NO_TARGETS;
     }
     return PAZPAR2_NO_ERROR;
 }
@@ -594,23 +512,18 @@ enum pazpar2_error_code search(struct session *se,
 static void session_init_databases_fun(void *context, struct database *db)
 {
     struct session *se = (struct session *) context;
-    struct conf_service *service = se->service;
     struct session_database *new = nmem_malloc(se->session_nmem, sizeof(*new));
-    int num = settings_num(service);
     int i;
 
     new->database = db;
     
     new->map = 0;
-    new->settings 
-        = nmem_malloc(se->session_nmem, sizeof(struct settings *) * num);
-    memset(new->settings, 0, sizeof(struct settings*) * num);
-
-    if (db->settings)
-    {
-        for (i = 0; i < num; i++)
-            new->settings[i] = db->settings[i];
-    }
+    assert(db->settings);
+    new->settings = nmem_malloc(se->session_nmem,
+                                sizeof(struct settings *) * db->num_settings);
+    new->num_settings = db->num_settings;
+    for (i = 0; i < db->num_settings; i++)
+        new->settings[i] = db->settings[i];
     new->next = se->databases;
     se->databases = new;
 }
@@ -618,10 +531,7 @@ static void session_init_databases_fun(void *context, struct database *db)
 // Doesn't free memory associated with sdb -- nmem takes care of that
 static void session_database_destroy(struct session_database *sdb)
 {
-    struct database_retrievalmap *m;
-
-    for (m = sdb->map; m; m = m->next)
-        xsltFreeStylesheet(m->stylesheet);
+    sdb->map = 0;
 }
 
 // Initialize session_database list -- this represents this session's view
@@ -629,7 +539,7 @@ static void session_database_destroy(struct session_database *sdb)
 void session_init_databases(struct session *se)
 {
     se->databases = 0;
-    predef_grep_databases(se, se->service, 0, session_init_databases_fun);
+    predef_grep_databases(se, se->service, session_init_databases_fun);
 }
 
 // Probably session_init_databases_fun should be refactored instead of
@@ -637,7 +547,7 @@ void session_init_databases(struct session *se)
 static struct session_database *load_session_database(struct session *se, 
                                                       char *id)
 {
-    struct database *db = find_database(id, 0, se->service);
+    struct database *db = find_database(id, se->service);
 
     resolve_database(db);
 
@@ -665,19 +575,10 @@ void session_apply_setting(struct session *se, char *dbname, char *setting,
     struct session_database *sdb = find_session_database(se, dbname);
     struct conf_service *service = se->service;
     struct setting *new = nmem_malloc(se->session_nmem, sizeof(*new));
-    int offset = settings_offset_cprefix(service, setting);
+    int offset = settings_create_offset(service, setting);
 
-    if (offset < 0)
-    {
-        yaz_log(YLOG_WARN, "Unknown setting %s", setting);
-        return;
-    }
-    // Jakub: This breaks the filter setting.
-    /*if (offset == PZ_ID)
-      {
-      yaz_log(YLOG_WARN, "No need to set pz:id setting. Ignoring");
-      return;
-      }*/
+    expand_settings_array(&sdb->settings, &sdb->num_settings, offset,
+                          se->session_nmem);
     new->precedence = 0;
     new->target = dbname;
     new->name = setting;
@@ -692,10 +593,6 @@ void session_apply_setting(struct session *se, char *dbname, char *setting,
     case PZ_XSLT:
         if (sdb->map)
         {
-            struct database_retrievalmap *m;
-            // We don't worry about the map structure -- it's in nmem
-            for (m = sdb->map; m; m = m->next)
-                xsltFreeStylesheet(m->stylesheet);
             sdb->map = 0;
         }
         break;
@@ -710,6 +607,7 @@ void destroy_session(struct session *s)
         client_destroy(s->clients);
     for (sdb = s->databases; sdb; sdb = sdb->next)
         session_database_destroy(sdb);
+    normalize_cache_destroy(s->normalize_cache);
     nmem_destroy(s->nmem);
     service_destroy(s->service);
     wrbuf_destroy(s->wrbuf);
@@ -731,7 +629,6 @@ struct session *new_session(NMEM nmem, struct conf_service *service)
     session->num_termlists = 0;
     session->reclist = 0;
     session->clients = 0;
-    session->expected_maxrecs = 0;
     session->session_nmem = nmem;
     session->nmem = nmem_create();
     session->wrbuf = wrbuf_alloc();
@@ -741,6 +638,8 @@ struct session *new_session(NMEM nmem, struct conf_service *service)
         session->watchlist[i].data = 0;
         session->watchlist[i].fun = 0;
     }
+    session->normalize_cache = normalize_cache_create();
+
     return session;
 }
 
@@ -757,6 +656,7 @@ struct hitsbytarget *hitsbytarget(struct session *se, int *count, NMEM nmem)
     *count = 0;
     for (cl = se->clients; cl; cl = client_next_in_session(cl))
     {
+        WRBUF w = wrbuf_alloc();
         const char *name = session_setting_oneval(client_get_database(cl),
                                                   PZ_NAME);
 
@@ -767,6 +667,8 @@ struct hitsbytarget *hitsbytarget(struct session *se, int *count, NMEM nmem)
         res[*count].diagnostic = client_get_diagnostic(cl);
         res[*count].state = client_get_state_str(cl);
         res[*count].connected  = client_get_connection(cl) ? 1 : 0;
+        session_settings_dump(se, client_get_database(cl), w);
+        res[*count].settings_xml = w;
         (*count)++;
     }
     return res;
@@ -845,7 +747,7 @@ struct record_cluster **show(struct session *s, struct reclist_sortparms *sp,
             }
         reclist_sort(s->reclist, sp);
         
-        *total = s->reclist->num_records;
+        *total = reclist_get_num_records(s->reclist);
         *sumhits = s->total_hits;
         
         for (i = 0; i < start; i++)
@@ -920,15 +822,38 @@ void pazpar2_event_loop()
 }
 
 static struct record_metadata *record_metadata_init(
-    NMEM nmem, char *value, enum conf_metadata_type type)
+    NMEM nmem, const char *value, enum conf_metadata_type type,
+    struct _xmlAttr *attr)
 {
     struct record_metadata *rec_md = record_metadata_create(nmem);
+    struct record_metadata_attr **attrp = &rec_md->attributes;
+    
+    for (; attr; attr = attr->next)
+    {
+        if (attr->children && attr->children->content)
+        {
+            if (strcmp((const char *) attr->name, "type"))
+            {  /* skip the "type" attribute.. Its value is already part of
+                  the element in output (md-%s) and so repeating it here
+                  is redundant */
+                *attrp = nmem_malloc(nmem, sizeof(**attrp));
+                (*attrp)->name =
+                    nmem_strdup(nmem, (const char *) attr->name);
+                (*attrp)->value =
+                    nmem_strdup(nmem, (const char *) attr->children->content);
+                attrp = &(*attrp)->next;
+            }
+        }
+    }
+    *attrp = 0;
+
     if (type == Metadata_type_generic)
     {
-        char * p = value;
+        char *p = nmem_strdup(nmem, value);
+
         p = normalize7bit_generic(p, " ,/.:([");
         
-        rec_md->data.text.disp = nmem_strdup(nmem, p);
+        rec_md->data.text.disp = p;
         rec_md->data.text.sort = 0;
     }
     else if (type == Metadata_type_year || type == Metadata_type_date)
@@ -1088,7 +1013,7 @@ static int check_record_filter(xmlNode *root, struct session_database *sdb)
             if (type)
             {
                 size_t len;
-                const char *eq = strchr(s, '=');
+                const char *eq = strchr(s, '~');
                 if (eq)
                     len = eq - s;
                 else
@@ -1160,15 +1085,15 @@ struct record *ingest_record(struct client *cl, const char *rec,
                              service, 
                              record, (char *) mergekey_norm, 
                              &se->total_merged);
-    if (global_parameters.dump_records)
-        yaz_log(YLOG_LOG, "Cluster id %s from %s (#%d)", cluster->recid,
-                sdb->database->url, record_no);
     if (!cluster)
     {
         /* no room for record */
         xmlFreeDoc(xdoc);
         return 0;
     }
+    if (global_parameters.dump_records)
+        yaz_log(YLOG_LOG, "Cluster id %s from %s (#%d)", cluster->recid,
+                sdb->database->url, record_no);
     relevance_newrec(se->relevance, cluster);
     
     // now parsing XML record and adding data to cluster or record metadata
@@ -1219,8 +1144,8 @@ struct record *ingest_record(struct client *cl, const char *rec,
             }
 
             // non-merged metadata
-            rec_md = record_metadata_init(se->nmem, (char *) value,
-                                          ser_md->type);
+            rec_md = record_metadata_init(se->nmem, (const char *) value,
+                                          ser_md->type, n->properties);
             if (!rec_md)
             {
                 yaz_log(YLOG_WARN, "bad metadata data '%s' for element '%s'",
@@ -1233,8 +1158,8 @@ struct record *ingest_record(struct client *cl, const char *rec,
             *wheretoput = rec_md;
 
             // merged metadata
-            rec_md = record_metadata_init(se->nmem, (char *) value,
-                                          ser_md->type);
+            rec_md = record_metadata_init(se->nmem, (const char *) value,
+                                          ser_md->type, 0);
             wheretoput = &cluster->metadata[md_field_id];
 
             // and polulate with data: