SOLR support (work in progress)
[pazpar2-moved-to-github.git] / src / client.c
index c238f0a..e69f832 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 <pthread.h>
 #include <stdlib.h>
 #include <stdio.h>
 #include <string.h>
@@ -52,6 +51,7 @@ Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 #include <yaz/diagbib1.h>
 #include <yaz/snprintf.h>
 #include <yaz/rpn2cql.h>
+#include <yaz/rpn2solr.h>
 
 #define USE_TIMING 0
 #if USE_TIMING
@@ -79,7 +79,7 @@ static void client_use(int delta)
     yaz_mutex_enter(g_mutex);
     no_clients += delta;
     yaz_mutex_leave(g_mutex);
-    yaz_log(YLOG_LOG, "%s clients=%d", delta > 0 ? "INC" : "DEC", no_clients);
+    yaz_log(YLOG_DEBUG, "%s clients=%d", delta > 0 ? "INC" : "DEC", no_clients);
 }
 #else
 #define client_use(x)
@@ -137,17 +137,19 @@ 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);
@@ -394,6 +396,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;
@@ -419,6 +448,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))
@@ -430,6 +460,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)
@@ -526,6 +557,62 @@ 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 */
+    /* TODO Verify: Do we need to reset the  ZOOM facets if a ZOOM Connection is being reused??? */
+    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);
@@ -586,13 +673,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);
     }
@@ -639,7 +727,7 @@ void client_unlock(struct client *c)
 void client_incref(struct client *c)
 {
     pazpar2_incref(&c->ref_count, c->mutex);
-    yaz_log(YLOG_LOG, "client_incref c=%p %s cnt=%d",
+    yaz_log(YLOG_DEBUG, "client_incref c=%p %s cnt=%d",
             c, client_get_url(c), c->ref_count);
 }
 
@@ -647,7 +735,7 @@ int client_destroy(struct client *c)
 {
     if (c)
     {
-        yaz_log(YLOG_LOG, "client_destroy c=%p %s cnt=%d",
+        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))
         {
@@ -656,8 +744,11 @@ int client_destroy(struct client *c)
             xfree(c->cqlquery);
             c->cqlquery = 0;
             assert(!c->connection);
-            assert(!c->resultset);
-            
+
+            if (c->resultset)
+            {
+                ZOOM_resultset_destroy(c->resultset);
+            }
             yaz_mutex_destroy(&c->mutex);
             xfree(c);
             client_use(-1);
@@ -670,10 +761,7 @@ int client_destroy(struct client *c)
 void client_set_connection(struct client *cl, struct connection *con)
 {
     if (cl->resultset)
-    {
-        ZOOM_resultset_destroy(cl->resultset);
-        cl->resultset = 0;
-    }
+        ZOOM_resultset_release(cl->resultset);
     if (con)
     {
         assert(cl->connection == 0);
@@ -755,6 +843,34 @@ static char *make_cqlquery(struct client *cl)
     return r;
 }
 
+// returns a xmalloced SOLR query corresponding to the pquery in client
+// TODO Could prob. be merge with the similar make_cqlquery
+static char *make_solrquery(struct client *cl)
+{
+    solr_transform_t sqlt = solr_transform_create();
+    Z_RPNQuery *zquery;
+    char *r;
+    WRBUF wrb = wrbuf_alloc();
+    int status;
+    ODR odr_out = odr_createmem(ODR_ENCODE);
+
+    zquery = p_query_rpn(odr_out, cl->pquery);
+    yaz_log(YLOG_LOG, "PQF: %s", cl->pquery);
+    if ((status = solr_transform_rpn2solr_wrbuf(sqlt, wrb, zquery)))
+    {
+        yaz_log(YLOG_WARN, "Failed to generate SOLR query, code=%d", status);
+        r = 0;
+    }
+    else
+    {
+        r = xstrdup(wrbuf_cstr(wrb));
+    }
+    wrbuf_destroy(wrb);
+    odr_destroy(odr_out);
+    solr_transform_close(sqlt);
+    return r;
+}
+
 // Parse the query given the settings specific to this client
 int client_parse_query(struct client *cl, const char *query)
 {
@@ -812,12 +928,19 @@ int client_parse_query(struct client *cl, const char *query)
     xfree(cl->cqlquery);
     if (*sru)
     {
-        if (!(cl->cqlquery = make_cqlquery(cl)))
-            return -1;
+        if (!strcmp(sru, "solr")) {
+            if (!(cl->cqlquery = make_solrquery(cl)))
+                return -1;
+        }
+        else {
+            if (!(cl->cqlquery = make_cqlquery(cl)))
+                return -1;
+        }
     }
     else
         cl->cqlquery = 0;
 
+    /* TODO FIX Not thread safe */
     if (!se->relevance)
     {
         // Initialize relevance structure with query terms