Pazpar2 1.4.4-2 for squeeze
[pazpar2-moved-to-github.git] / src / client.c
index 31c2543..6a7f6a4 100644 (file)
@@ -1,5 +1,5 @@
 /* This file is part of Pazpar2.
-   Copyright (C) 2006-2009 Index Data
+   Copyright (C) 2006-2010 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
@@ -24,7 +24,6 @@ Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 #if HAVE_CONFIG_H
 #include <config.h>
 #endif
-
 #include <stdlib.h>
 #include <stdio.h>
 #include <string.h>
@@ -58,11 +57,32 @@ Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 #include <yaz/timing.h>
 #endif
 
-#include "pazpar2.h"
-
+#include "ppmutex.h"
+#include "session.h"
+#include "parameters.h"
 #include "client.h"
 #include "connection.h"
 #include "settings.h"
+#include "relevance.h"
+#include "incref.h"
+
+/* client counting (1) , disable client counting (0) */
+#if 1
+static YAZ_MUTEX g_mutex = 0;
+static int no_clients = 0;
+
+static void client_use(int delta)
+{
+    if (!g_mutex)
+        yaz_mutex_create(&g_mutex);
+    yaz_mutex_enter(g_mutex);
+    no_clients += delta;
+    yaz_mutex_leave(g_mutex);
+    yaz_log(YLOG_DEBUG, "%s clients=%d", delta > 0 ? "INC" : "DEC", no_clients);
+}
+#else
+#define client_use(x)
+#endif
 
 /** \brief Represents client state for a connection to one search target */
 struct client {
@@ -71,13 +91,16 @@ struct client {
     struct session *session;
     char *pquery; // Current search
     char *cqlquery; // used for SRU targets only
-    int hits;
+    Odr_int hits;
     int record_offset;
+    int maxrecs;
+    int startrecs;
     int diagnostic;
     enum client_state state;
     struct show_raw *show_raw;
-    struct client *next;     // next client in session or next in free list
     ZOOM_resultset resultset;
+    YAZ_MUTEX mutex;
+    int ref_count;
 };
 
 struct show_raw {
@@ -101,8 +124,6 @@ static const char *client_states[] = {
     "Client_Disconnected"
 };
 
-static struct client *client_freelist = 0;
-
 const char *client_get_state_str(struct client *cl)
 {
     return client_states[cl->state];
@@ -115,8 +136,14 @@ enum client_state client_get_state(struct client *cl)
 
 void client_set_state(struct client *cl, enum client_state st)
 {
+    int was_active = 0;
+    if (client_is_active(cl))
+        was_active = 1;
     cl->state = st;
-    if (cl->session)
+    /* If client is going from being active to inactive and all clients
+       are now idle we fire a watch for the session . The assumption is
+       that session is not mutex locked if client is already active */
+    if (was_active && !client_is_active(cl) && cl->session)
     {
         int no_active = session_active_clients(cl->session);
         if (no_active == 0)
@@ -126,14 +153,6 @@ void client_set_state(struct client *cl, enum client_state st)
 
 static void client_show_raw_error(struct client *cl, const char *addinfo);
 
-// Close connection and set state to error
-void client_fatal(struct client *cl)
-{
-    yaz_log(YLOG_WARN, "Fatal error from %s", client_get_url(cl));
-    connection_destroy(cl->connection);
-    client_set_state(cl, Client_Error);
-}
-
 struct connection *client_get_connection(struct client *cl)
 {
     return cl->connection;
@@ -253,6 +272,13 @@ int client_show_raw_begin(struct client *cl, int position,
     return 0;
 }
 
+static void client_show_raw_delete(struct show_raw *r)
+{
+    xfree(r->syntax);
+    xfree(r->esn);
+    xfree(r);
+}
+
 void client_show_raw_remove(struct client *cl, void *data)
 {
     struct show_raw *rr = data;
@@ -262,7 +288,7 @@ void client_show_raw_remove(struct client *cl, void *data)
     if (*rrp)
     {
         *rrp = rr->next;
-        xfree(rr);
+        client_show_raw_delete(rr);
     }
 }
 
@@ -271,7 +297,7 @@ void client_show_raw_dequeue(struct client *cl)
     struct show_raw *rr = cl->show_raw;
 
     cl->show_raw = rr->next;
-    xfree(rr);
+    client_show_raw_delete(rr);
 }
 
 static void client_show_raw_error(struct client *cl, const char *addinfo)
@@ -334,6 +360,11 @@ static int nativesyntax_to_type(struct session_database *sdb, char *type,
         {
             strcpy(type, "xml");
         }
+        else if (!strncmp(s, "txml", 4))
+        {
+            const char *cp = strchr(s, ';');
+            yaz_snprintf(type, 80, "txml; charset=%s", cp ? cp+1 : "marc-8s");
+        }
         else
             return -1;
         return 0;
@@ -348,6 +379,11 @@ static int nativesyntax_to_type(struct session_database *sdb, char *type,
                 strcpy(type, "xml");
                 return 0;
             }
+            else if (!strcmp(syntax, "TXML"))
+                {
+                    strcpy(type, "txml");
+                    return 0;
+                }
             else if (!strcmp(syntax, "USmarc") || !strcmp(syntax, "MARC21"))
             {
                 strcpy(type, "xml; charset=marc8-s");
@@ -359,6 +395,33 @@ static int nativesyntax_to_type(struct session_database *sdb, char *type,
     }
 }
 
+/**
+ * TODO Consider thread safety!!!
+ *
+ */
+int client_report_facets(struct client *cl, ZOOM_resultset rs) {
+    int facet_idx;
+    ZOOM_facet_field *facets = ZOOM_resultset_facets(rs);
+    int facet_num;
+    struct session *se = client_get_session(cl);
+    facet_num = ZOOM_resultset_facets_size(rs);
+    yaz_log(YLOG_DEBUG, "client_report_facets: %d", facet_num);
+
+    for (facet_idx = 0; facet_idx < facet_num; facet_idx++) {
+        const char *name = ZOOM_facet_field_name(facets[facet_idx]);
+        size_t term_idx;
+        size_t term_num = ZOOM_facet_field_term_count(facets[facet_idx]);
+        for (term_idx = 0; term_idx < term_num; term_idx++ ) {
+            int freq;
+            const char *term = ZOOM_facet_field_get_term(facets[facet_idx], term_idx, &freq);
+            if (term)
+                add_facet(se, name, term, freq);
+        }
+    }
+
+    return 0;
+}
+
 static void ingest_raw_record(struct client *cl, ZOOM_record rec)
 {
     const char *buf;
@@ -384,23 +447,37 @@ void client_search_response(struct client *cl)
     struct session *se = cl->session;
     ZOOM_connection link = connection_get_link(co);
     ZOOM_resultset resultset = cl->resultset;
-    const char *error, *addinfo;
 
+    const char *error, *addinfo = 0;
+    
     if (ZOOM_connection_error(link, &error, &addinfo))
     {
         cl->hits = 0;
         client_set_state(cl, Client_Error);
         yaz_log(YLOG_WARN, "Search error %s (%s): %s",
-            error, addinfo, client_get_url(cl));
+                error, addinfo, client_get_url(cl));
     }
     else
     {
-        cl->record_offset = 0;
+        client_report_facets(cl, resultset);
+        cl->record_offset = cl->startrecs;
         cl->hits = ZOOM_resultset_size(resultset);
-        se->total_hits += cl->hits;
+        if (se)
+            se->total_hits += cl->hits;
     }
 }
 
+void client_got_records(struct client *cl)
+{
+    struct session *se = cl->session;
+    if (se)
+    {
+        client_unlock(cl);
+        session_alert_watch(se, SESSION_WATCH_SHOW);
+        session_alert_watch(se, SESSION_WATCH_RECORD);
+        client_lock(cl);
+    }
+}
 
 void client_record_response(struct client *cl)
 {
@@ -440,31 +517,35 @@ void client_record_response(struct client *cl)
             if ((rec = ZOOM_resultset_record(resultset, offset)))
             {
                 cl->record_offset++;
-                if (ZOOM_record_error(rec, &msg, &addinfo, 0))
+                if (cl->session == 0)
+                    ;
+                else if (ZOOM_record_error(rec, &msg, &addinfo, 0))
+                {
                     yaz_log(YLOG_WARN, "Record error %s (%s): %s (rec #%d)",
-                            error, addinfo, client_get_url(cl),
+                            msg, addinfo, client_get_url(cl),
                             cl->record_offset);
+                }
                 else
                 {
                     struct session_database *sdb = client_get_database(cl);
+                    NMEM nmem = nmem_create();
                     const char *xmlrec;
                     char type[80];
+
                     if (nativesyntax_to_type(sdb, type, rec))
                         yaz_log(YLOG_WARN, "Failed to determine record type");
-                    if ((xmlrec = ZOOM_record_get(rec, type, NULL)))
+                    xmlrec = ZOOM_record_get(rec, type, NULL);
+                    if (!xmlrec)
+                        yaz_log(YLOG_WARN, "ZOOM_record_get failed from %s",
+                                client_get_url(cl));
+                    else
                     {
-                        if (ingest_record(cl, xmlrec, cl->record_offset))
-                        {
-                            session_alert_watch(cl->session, SESSION_WATCH_SHOW);
-                            session_alert_watch(cl->session, SESSION_WATCH_RECORD);
-                        }
-                        else
-                            yaz_log(YLOG_WARN, "Failed to ingest");
+                        if (ingest_record(cl, xmlrec, cl->record_offset, nmem))
+                            yaz_log(YLOG_WARN, "Failed to ingest from %s",
+                                    client_get_url(cl));
                     }
-                    else
-                        yaz_log(YLOG_WARN, "Failed to extract ZOOM record");
+                    nmem_destroy(nmem);
                 }
-
             }
             else
             {
@@ -475,6 +556,61 @@ void client_record_response(struct client *cl)
     }
 }
 
+static int client_set_facets_request(struct client *cl, ZOOM_connection link)
+{
+    struct session_database *sdb = client_get_database(cl);
+    const char *opt_facet_term_sort  = session_setting_oneval(sdb, PZ_TERMLIST_TERM_SORT);
+    const char *opt_facet_term_count = session_setting_oneval(sdb, PZ_TERMLIST_TERM_COUNT);
+    /* Disable when no count is set */
+    if (opt_facet_term_count && *opt_facet_term_count)
+    {
+        int index = 0;
+        struct session *session = client_get_session(cl);
+        struct conf_service *service = session->service;
+        int num = service->num_metadata;
+        WRBUF wrbuf = wrbuf_alloc();
+        yaz_log(YLOG_DEBUG, "Facet settings, sort: %s count: %s",
+                opt_facet_term_sort, opt_facet_term_count);
+        for (index = 0; index < num; index++)
+        {
+            struct conf_metadata *conf_meta = &service->metadata[index];
+            if (conf_meta->termlist)
+            {
+                if (wrbuf_len(wrbuf))
+                    wrbuf_puts(wrbuf, ", ");
+                wrbuf_printf(wrbuf, "@attr 1=%s", conf_meta->name);
+                
+                if (opt_facet_term_sort && *opt_facet_term_sort)
+                    wrbuf_printf(wrbuf, " @attr 2=%s", opt_facet_term_sort);
+                wrbuf_printf(wrbuf, " @attr 3=%s", opt_facet_term_count);
+            }
+        }
+        if (wrbuf_len(wrbuf))
+        {
+            yaz_log(YLOG_LOG, "Setting ZOOM facets option: %s", wrbuf_cstr(wrbuf));
+            ZOOM_connection_option_set(link, "facets", wrbuf_cstr(wrbuf));
+            return 1;
+        }
+    }
+    return 0;
+}
+
+int client_has_facet(struct client *cl, const char *name) {
+    ZOOM_facet_field facet_field;
+    if (!cl || !cl->resultset || !name) {
+        yaz_log(YLOG_DEBUG, "client has facet: Missing %p %p %s", cl, (cl ? cl->resultset: 0), name);
+        return 0;
+    }
+    facet_field = ZOOM_resultset_get_facet_field(cl->resultset, name);
+    if (facet_field) {
+        yaz_log(YLOG_DEBUG, "client: has facets for %s", name);
+        return 1;
+    }
+    yaz_log(YLOG_DEBUG, "client: No facets for %s", name);
+    return 0;
+}
+
+
 void client_start_search(struct client *cl)
 {
     struct session_database *sdb = client_get_database(cl);
@@ -488,6 +624,8 @@ void client_start_search(struct client *cl)
     const char *opt_requestsyn = session_setting_oneval(sdb, PZ_REQUESTSYNTAX);
     const char *opt_maxrecs = session_setting_oneval(sdb, PZ_MAXRECS);
     const char *opt_sru = session_setting_oneval(sdb, PZ_SRU);
+    const char *opt_sort = session_setting_oneval(sdb, PZ_SORT);
+    char maxrecs_str[24], startrecs_str[24];
 
     assert(link);
 
@@ -508,29 +646,39 @@ void client_start_search(struct client *cl)
         ZOOM_connection_option_set(link, "elementSetName", opt_elements);
     if (*opt_requestsyn)
         ZOOM_connection_option_set(link, "preferredRecordSyntax", opt_requestsyn);
-    if (*opt_maxrecs)
-        ZOOM_connection_option_set(link, "count", opt_maxrecs);
-    else
+
+    if (!*opt_maxrecs)
     {
-        char n[128];
-        sprintf(n, "%d", global_parameters.toget);
-        ZOOM_connection_option_set(link, "count", n);
+        sprintf(maxrecs_str, "%d", cl->maxrecs);
+        opt_maxrecs = maxrecs_str;
     }
+    ZOOM_connection_option_set(link, "count", opt_maxrecs);
+
+
+    if (atoi(opt_maxrecs) > 20)
+        ZOOM_connection_option_set(link, "presentChunk", "20");
+    else
+        ZOOM_connection_option_set(link, "presentChunk", opt_maxrecs);
+
+    sprintf(startrecs_str, "%d", cl->startrecs);
+    ZOOM_connection_option_set(link, "start", startrecs_str);
+
     if (databaseName)
         ZOOM_connection_option_set(link, "databaseName", databaseName);
 
-    ZOOM_connection_option_set(link, "presentChunk", "20");
-        
     if (cl->cqlquery)
     {
         ZOOM_query q = ZOOM_query_create();
         yaz_log(YLOG_LOG, "Search %s CQL: %s", sdb->database->url, cl->cqlquery);
         ZOOM_query_cql(q, cl->cqlquery);
+        if (*opt_sort)
+            ZOOM_query_sortby(q, opt_sort);
         rs = ZOOM_connection_search(link, q);
         ZOOM_query_destroy(q);
     }
     else
     {
+        client_set_facets_request(cl, link);
         yaz_log(YLOG_LOG, "Search %s PQF: %s", sdb->database->url, cl->pquery);
         rs = ZOOM_connection_search_pqf(link, cl->pquery);
     }
@@ -541,14 +689,9 @@ void client_start_search(struct client *cl)
 
 struct client *client_create(void)
 {
-    struct client *r;
-    if (client_freelist)
-    {
-        r = client_freelist;
-        client_freelist = client_freelist->next;
-    }
-    else
-        r = xmalloc(sizeof(struct client));
+    struct client *r = xmalloc(sizeof(*r));
+    r->maxrecs = 100;
+    r->startrecs = 0;
     r->pquery = 0;
     r->cqlquery = 0;
     r->database = 0;
@@ -560,38 +703,74 @@ struct client *client_create(void)
     r->state = Client_Disconnected;
     r->show_raw = 0;
     r->resultset = 0;
-    r->next = 0;
+    r->mutex = 0;
+    pazpar2_mutex_create(&r->mutex, "client");
+
+    r->ref_count = 1;
+    client_use(1);
+    
     return r;
 }
 
-void client_destroy(struct client *c)
+void client_lock(struct client *c)
 {
-    struct session *se = c->session;
-    if (c == se->clients)
-        se->clients = c->next;
-    else
-    {
-        struct client *cc;
-        for (cc = se->clients; cc && cc->next != c; cc = cc->next)
-            ;
-        if (cc)
-            cc->next = c->next;
-    }
-    xfree(c->pquery);
-    xfree(c->cqlquery);
+    yaz_mutex_enter(c->mutex);
+}
+
+void client_unlock(struct client *c)
+{
+    yaz_mutex_leave(c->mutex);
+}
 
-    if (c->connection)
-        connection_release(c->connection);
+void client_incref(struct client *c)
+{
+    pazpar2_incref(&c->ref_count, c->mutex);
+    yaz_log(YLOG_DEBUG, "client_incref c=%p %s cnt=%d",
+            c, client_get_url(c), c->ref_count);
+}
 
-    ZOOM_resultset_destroy(c->resultset);
-    c->resultset = 0;
-    c->next = client_freelist;
-    client_freelist = c;
+int client_destroy(struct client *c)
+{
+    if (c)
+    {
+        yaz_log(YLOG_DEBUG, "client_destroy c=%p %s cnt=%d",
+                c, client_get_url(c), c->ref_count);
+        if (!pazpar2_decref(&c->ref_count, c->mutex))
+        {
+            xfree(c->pquery);
+            c->pquery = 0;
+            xfree(c->cqlquery);
+            c->cqlquery = 0;
+            assert(!c->connection);
+
+            if (c->resultset)
+            {
+                ZOOM_resultset_destroy(c->resultset);
+            }
+            yaz_mutex_destroy(&c->mutex);
+            xfree(c);
+            client_use(-1);
+            return 1;
+        }
+    }
+    return 0;
 }
 
 void client_set_connection(struct client *cl, struct connection *con)
 {
-    cl->connection = con;
+    if (cl->resultset)
+        ZOOM_resultset_release(cl->resultset);
+    if (con)
+    {
+        assert(cl->connection == 0);
+        cl->connection = con;
+        client_incref(cl);
+    }
+    else
+    {
+        cl->connection = con;
+        client_destroy(cl);
+    }
 }
 
 void client_disconnect(struct client *cl)
@@ -643,17 +822,21 @@ static char *make_cqlquery(struct client *cl)
     char *r;
     WRBUF wrb = wrbuf_alloc();
     int status;
+    ODR odr_out = odr_createmem(ODR_ENCODE);
 
-    zquery = p_query_rpn(global_parameters.odr_out, cl->pquery);
+    zquery = p_query_rpn(odr_out, cl->pquery);
+    yaz_log(YLOG_LOG, "PQF: %s", cl->pquery);
     if ((status = cql_transform_rpn2cql_wrbuf(cqlt, wrb, zquery)))
     {
-        yaz_log(YLOG_WARN, "failed to generate CQL query, code=%d", status);
-        return 0;
+        yaz_log(YLOG_WARN, "Failed to generate CQL query, code=%d", status);
+        r = 0;
     }
-    r = xstrdup(wrbuf_cstr(wrb));
-
+    else
+    {
+        r = xstrdup(wrbuf_cstr(wrb));
+    }     
     wrbuf_destroy(wrb);
-    odr_reset(global_parameters.odr_out); // releases the zquery
+    odr_destroy(odr_out);
     cql_transform_close(cqlt);
     return r;
 }
@@ -668,6 +851,7 @@ int client_parse_query(struct client *cl, const char *query)
     CCL_bibset ccl_map = prepare_cclmap(cl);
     const char *sru = session_setting_oneval(sdb, PZ_SRU);
     const char *pqf_prefix = session_setting_oneval(sdb, PZ_PQF_PREFIX);
+    const char *pqf_strftime = session_setting_oneval(sdb, PZ_PQF_STRFTIME);
 
     if (!ccl_map)
         return -1;
@@ -677,8 +861,9 @@ int client_parse_query(struct client *cl, const char *query)
     if (!cn)
     {
         client_set_state(cl, Client_Error);
-        yaz_log(YLOG_WARN, "Failed to parse query for %s",
-                         client_get_database(cl)->database->url);
+        yaz_log(YLOG_WARN, "Failed to parse CCL query %s for %s",
+                query,
+                client_get_database(cl)->database->url);
         return -1;
     }
     wrbuf_rewind(se->wrbuf);
@@ -687,7 +872,26 @@ int client_parse_query(struct client *cl, const char *query)
         wrbuf_puts(se->wrbuf, pqf_prefix);
         wrbuf_puts(se->wrbuf, " ");
     }
-    ccl_pquery(se->wrbuf, cn);
+    if (!pqf_strftime || !*pqf_strftime)
+        ccl_pquery(se->wrbuf, cn);
+    else
+    {
+        time_t cur_time = time(0);
+        struct tm *tm =  localtime(&cur_time);
+        char tmp_str[300];
+        const char *cp = tmp_str;
+
+        /* see man strftime(3) for things .. In particular %% gets converted
+         to %.. And That's our original query .. */
+        strftime(tmp_str, sizeof(tmp_str)-1, pqf_strftime, tm);
+        for (; *cp; cp++)
+        {
+            if (cp[0] == '%')
+                ccl_pquery(se->wrbuf, cn);
+            else
+                wrbuf_putc(se->wrbuf, cp[0]);
+        }
+    }
     xfree(cl->pquery);
     cl->pquery = xstrdup(wrbuf_cstr(se->wrbuf));
 
@@ -700,15 +904,15 @@ int client_parse_query(struct client *cl, const char *query)
     else
         cl->cqlquery = 0;
 
+    /* TODO FIX Not thread safe */
     if (!se->relevance)
     {
         // Initialize relevance structure with query terms
         char *p[512];
         extract_terms(se->nmem, cn, p);
         se->relevance = relevance_create(
-            global_parameters.server->relevance_pct,
-            se->nmem, (const char **) p,
-            se->expected_maxrecs);
+            se->service->relevance_pct,
+            se->nmem, (const char **) p);
     }
 
     ccl_rpn_delete(cn);
@@ -718,8 +922,6 @@ int client_parse_query(struct client *cl, const char *query)
 void client_set_session(struct client *cl, struct session *se)
 {
     cl->session = se;
-    cl->next = se->clients;
-    se->clients = cl;
 }
 
 int client_is_active(struct client *cl)
@@ -730,15 +932,7 @@ int client_is_active(struct client *cl)
     return 0;
 }
 
-struct client *client_next_in_session(struct client *cl)
-{
-    if (cl)
-        return cl->next;
-    return 0;
-
-}
-
-int client_get_hits(struct client *cl)
+Odr_int client_get_hits(struct client *cl)
 {
     return cl->hits;
 }
@@ -748,6 +942,11 @@ int client_get_num_records(struct client *cl)
     return cl->record_offset;
 }
 
+void client_set_diagnostic(struct client *cl, int diagnostic)
+{
+    cl->diagnostic = diagnostic;
+}
+
 int client_get_diagnostic(struct client *cl)
 {
     return cl->diagnostic;
@@ -765,7 +964,20 @@ struct host *client_get_host(struct client *cl)
 
 const char *client_get_url(struct client *cl)
 {
-    return client_get_database(cl)->database->url;
+    if (cl->database)
+        return client_get_database(cl)->database->url;
+    else
+        return "NOURL";
+}
+
+void client_set_maxrecs(struct client *cl, int v)
+{
+    cl->maxrecs = v;
+}
+
+void client_set_startrecs(struct client *cl, int v)
+{
+    cl->startrecs = v;
 }
 
 /*