Version 1.5.0. Require YAZ 4.1.0
[pazpar2-moved-to-github.git] / src / client.c
index 6df84b2..7c563b2 100644 (file)
@@ -51,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
@@ -96,6 +97,7 @@ struct client {
     int maxrecs;
     int startrecs;
     int diagnostic;
+    int preferred;
     enum client_state state;
     struct show_raw *show_raw;
     ZOOM_resultset resultset;
@@ -145,9 +147,13 @@ void client_set_state(struct client *cl, enum client_state st)
        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)
+        yaz_log(YLOG_DEBUG, "%s: releasing watches on zero active: %d", client_get_url(cl), no_active);
+        if (no_active == 0) {
             session_alert_watch(cl->session, SESSION_WATCH_SHOW);
+            session_alert_watch(cl->session, SESSION_WATCH_SHOW_PREF);
+        }
     }
 }
 
@@ -441,6 +447,26 @@ static void ingest_raw_record(struct client *cl, ZOOM_record rec)
     client_show_raw_dequeue(cl);
 }
 
+void client_check_preferred_watch(struct client *cl)
+{
+    struct session *se = cl->session;
+    yaz_log(YLOG_DEBUG, "client_check_preferred_watch: %s ", client_get_url(cl));
+    if (se)
+    {
+        client_unlock(cl);
+        if (session_is_preferred_clients_ready(se)) {
+            session_alert_watch(se, SESSION_WATCH_SHOW_PREF);
+        }
+        else
+            yaz_log(YLOG_DEBUG, "client_check_preferred_watch: Still locked on preferred targets.");
+
+        client_lock(cl);
+    }
+    else
+        yaz_log(YLOG_WARN, "client_check_preferred_watch: %s. No session!", client_get_url(cl));
+
+}
+
 void client_search_response(struct client *cl)
 {
     struct connection *co = cl->connection;
@@ -459,11 +485,14 @@ void client_search_response(struct client *cl)
     }
     else
     {
+        yaz_log(YLOG_DEBUG, "client_search_response: hits %d", cl->hits);
         client_report_facets(cl, resultset);
         cl->record_offset = cl->startrecs;
         cl->hits = ZOOM_resultset_size(resultset);
-        if (se)
+        if (se) {
             se->total_hits += cl->hits;
+            yaz_log(YLOG_DEBUG, "client_search_response: total hits %d", se->total_hits);
+        }
     }
 }
 
@@ -556,44 +585,42 @@ void client_record_response(struct client *cl)
     }
 }
 
-static int client_set_facets_request(struct client *cl, ZOOM_connection link) {
-    int index = 0;
+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 == 0 || opt_facet_term_count[0] == '\0') {
-        yaz_log(YLOG_LOG, "Resetting ZOOM facets option to empty.");
-        ZOOM_connection_option_set(link, "facets", "");
-        return 0;
-    }
-    struct session *session = client_get_session(cl);
-    struct conf_service *service = session->service;
-    int num = service->num_metadata;
-    WRBUF wrbuf = wrbuf_alloc();
-    int first = 1;
-    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 (first)
-                first = 0;
-            else
-                wrbuf_puts(wrbuf, ",");
-            wrbuf_printf(wrbuf, "@attr 1=%s ", conf_meta->name);
-
-            if (opt_facet_term_sort && opt_facet_term_sort[0] != '\0') {
-                wrbuf_printf(wrbuf, " @attr 2=%s ", opt_facet_term_sort);
-            }
-            if (opt_facet_term_count && opt_facet_term_count[0] != '\0') {
-                wrbuf_printf(wrbuf, " @attr 3=%s ", opt_facet_term_count);
+    /* 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;
+        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;
 }
@@ -621,13 +648,14 @@ void client_start_search(struct client *cl)
     ZOOM_connection link = connection_get_link(co);
     ZOOM_resultset rs;
     char *databaseName = sdb->database->databases[0];
-    const char *opt_piggyback = session_setting_oneval(sdb, PZ_PIGGYBACK);
-    const char *opt_queryenc = session_setting_oneval(sdb, PZ_QUERYENCODING);
-    const char *opt_elements = session_setting_oneval(sdb, PZ_ELEMENTS);
-    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);
+    const char *opt_piggyback   = session_setting_oneval(sdb, PZ_PIGGYBACK);
+    const char *opt_queryenc    = session_setting_oneval(sdb, PZ_QUERYENCODING);
+    const char *opt_elements    = session_setting_oneval(sdb, PZ_ELEMENTS);
+    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);
+    const char *opt_preferred   = session_setting_oneval(sdb, PZ_PREFERRED);
     char maxrecs_str[24], startrecs_str[24];
 
     assert(link);
@@ -635,6 +663,12 @@ void client_start_search(struct client *cl)
     cl->hits = -1;
     cl->record_offset = 0;
     cl->diagnostic = 0;
+
+    if (opt_preferred) {
+        cl->preferred = atoi(opt_preferred);
+        if (cl->preferred)
+            yaz_log(YLOG_LOG, "Target %s has preferred status: %d", sdb->database->url, cl->preferred);
+    }
     client_set_state(cl, Client_Working);
 
     if (*opt_piggyback)
@@ -669,6 +703,10 @@ void client_start_search(struct client *cl)
     if (databaseName)
         ZOOM_connection_option_set(link, "databaseName", databaseName);
 
+    /* TODO Verify does it break something for CQL targets(non-SOLR) ? */
+    /* facets definition is in PQF */
+    client_set_facets_request(cl, link);
+
     if (cl->cqlquery)
     {
         ZOOM_query q = ZOOM_query_create();
@@ -681,7 +719,6 @@ void client_start_search(struct client *cl)
     }
     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);
     }
@@ -708,7 +745,7 @@ struct client *client_create(void)
     r->resultset = 0;
     r->mutex = 0;
     pazpar2_mutex_create(&r->mutex, "client");
-
+    r->preferred = 0;
     r->ref_count = 1;
     client_use(1);
     
@@ -844,6 +881,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)
 {
@@ -901,8 +966,14 @@ 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;
@@ -935,6 +1006,19 @@ int client_is_active(struct client *cl)
     return 0;
 }
 
+int client_is_active_preferred(struct client *cl)
+{
+    /* only count if this is a preferred target. */
+    if (!cl->preferred)
+        return 0;
+    /* TODO No sure this the condition that Seb wants */
+    if (cl->connection && (cl->state == Client_Connecting ||
+                           cl->state == Client_Working))
+        return 1;
+    return 0;
+}
+
+
 Odr_int client_get_hits(struct client *cl)
 {
     return cl->hits;
@@ -983,6 +1067,12 @@ void client_set_startrecs(struct client *cl, int v)
     cl->startrecs = v;
 }
 
+void client_set_preferred(struct client *cl, int v)
+{
+    cl->preferred = v;
+}
+
+
 /*
  * Local variables:
  * c-basic-offset: 4