Pazpar2 1.4.4-2 for squeeze
[pazpar2-moved-to-github.git] / src / client.c
index b4d323e..6a7f6a4 100644 (file)
@@ -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,6 +57,7 @@ Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 #include <yaz/timing.h>
 #endif
 
+#include "ppmutex.h"
 #include "session.h"
 #include "parameters.h"
 #include "client.h"
@@ -66,6 +66,24 @@ Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 #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 {
     struct session_database *database;
@@ -80,7 +98,6 @@ struct client {
     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;
@@ -119,29 +136,23 @@ 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;
-    /* no need to check for all client being non-active if this one
-       already is. Note that session_active_clients also LOCKS session */
-#if 0
-    if (!client_is_active(cl) && 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)
             session_alert_watch(cl->session, SESSION_WATCH_SHOW);
     }
-#endif
 }
 
 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;
@@ -349,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;
@@ -363,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");
@@ -374,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;
@@ -399,6 +447,7 @@ 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 = 0;
     
     if (ZOOM_connection_error(link, &error, &addinfo))
@@ -410,6 +459,7 @@ void client_search_response(struct client *cl)
     }
     else
     {
+        client_report_facets(cl, resultset);
         cl->record_offset = cl->startrecs;
         cl->hits = ZOOM_resultset_size(resultset);
         if (se)
@@ -417,6 +467,18 @@ void client_search_response(struct client *cl)
     }
 }
 
+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)
 {
     struct connection *co = cl->connection;
@@ -458,15 +520,18 @@ void client_record_response(struct client *cl)
                 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");
                     xmlrec = ZOOM_record_get(rec, type, NULL);
@@ -478,11 +543,6 @@ void client_record_response(struct client *cl)
                         if (ingest_record(cl, xmlrec, cl->record_offset, nmem))
                             yaz_log(YLOG_WARN, "Failed to ingest from %s",
                                     client_get_url(cl));
-                        else
-                        {
-                            session_alert_watch(cl->session, SESSION_WATCH_SHOW);
-                            session_alert_watch(cl->session, SESSION_WATCH_RECORD);
-                        }
                     }
                     nmem_destroy(nmem);
                 }
@@ -496,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);
@@ -556,13 +671,14 @@ void client_start_search(struct client *cl)
         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);
+        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);
     }
@@ -587,37 +703,53 @@ struct client *client_create(void)
     r->state = Client_Disconnected;
     r->show_raw = 0;
     r->resultset = 0;
-    r->next = 0;
     r->mutex = 0;
-    yaz_mutex_create(&r->mutex);
+    pazpar2_mutex_create(&r->mutex, "client");
+
     r->ref_count = 1;
+    client_use(1);
     
     return r;
 }
 
+void client_lock(struct client *c)
+{
+    yaz_mutex_enter(c->mutex);
+}
+
+void client_unlock(struct client *c)
+{
+    yaz_mutex_leave(c->mutex);
+}
+
 void client_incref(struct client *c)
 {
     pazpar2_incref(&c->ref_count, c->mutex);
-    yaz_log(YLOG_LOG, "client_incref %s %d", client_get_url(c), c->ref_count);
+    yaz_log(YLOG_DEBUG, "client_incref c=%p %s cnt=%d",
+            c, client_get_url(c), c->ref_count);
 }
 
 int client_destroy(struct client *c)
 {
     if (c)
     {
-        yaz_log(YLOG_LOG, "client_destroy %s %d",
-                client_get_url(c), c->ref_count);
+        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))
         {
-            c->next = 0;
             xfree(c->pquery);
             c->pquery = 0;
             xfree(c->cqlquery);
             c->cqlquery = 0;
+            assert(!c->connection);
 
-            ZOOM_resultset_destroy(c->resultset);
+            if (c->resultset)
+            {
+                ZOOM_resultset_destroy(c->resultset);
+            }
             yaz_mutex_destroy(&c->mutex);
             xfree(c);
+            client_use(-1);
             return 1;
         }
     }
@@ -626,6 +758,8 @@ int client_destroy(struct client *c)
 
 void client_set_connection(struct client *cl, struct connection *con)
 {
+    if (cl->resultset)
+        ZOOM_resultset_release(cl->resultset);
     if (con)
     {
         assert(cl->connection == 0);
@@ -770,6 +904,7 @@ 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
@@ -784,34 +919,9 @@ int client_parse_query(struct client *cl, const char *query)
     return 0;
 }
 
-
-void client_remove_from_session(struct client *c)
-{
-    struct session *se;
-    client_incref(c);
-
-    se = c->session;
-    assert(se);
-    if (se)
-    {
-        struct client **ccp = &se->clients;
-        
-        while (*ccp && *ccp != c)
-            ccp = &(*ccp)->next;
-        assert(*ccp == c);
-        *ccp = c->next;
-        
-        c->session = 0;
-        c->next = 0;
-    }
-    client_destroy(c);
-}
-
 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)
@@ -822,14 +932,6 @@ 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;
-
-}
-
 Odr_int client_get_hits(struct client *cl)
 {
     return cl->hits;
@@ -862,7 +964,10 @@ 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)