Fix present chunk
[pazpar2-moved-to-github.git] / src / client.c
index 44d7f57..9e52b0a 100644 (file)
@@ -1,5 +1,5 @@
 /* This file is part of Pazpar2.
-   Copyright (C) 2006-2011 Index Data
+   Copyright (C) 2006-2012 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
@@ -111,6 +111,7 @@ struct client {
     char *addinfo; // diagnostic info for most resent error
     Odr_int hits;
     int record_offset;
+    int filtered; // When using local:, this will count the number of filtered records.
     int maxrecs;
     int startrecs;
     int diagnostic;
@@ -237,7 +238,7 @@ static void client_show_immediate(
         error_handler(data, "no resultset");
         return;
     }
-    rec = ZOOM_resultset_record(resultset, position-1);
+    rec = ZOOM_resultset_record_immediate(resultset, position-1);
     if (!rec)
     {
         error_handler(data, "no record");
@@ -546,11 +547,10 @@ void client_search_response(struct client *cl)
     }
     else
     {
-        yaz_log(YLOG_DEBUG, "client_search_response: hits "
-                ODR_INT_PRINTF, cl->hits);
         client_report_facets(cl, resultset);
         cl->record_offset = cl->startrecs;
         cl->hits = ZOOM_resultset_size(resultset);
+        yaz_log(YLOG_DEBUG, "client_search_response: hits " ODR_INT_PRINTF, cl->hits);
         if (cl->suggestions)
             client_suggestions_destroy(cl);
         cl->suggestions = client_suggestions_create(ZOOM_resultset_option_get(resultset, "suggestions"));
@@ -580,16 +580,16 @@ static void client_record_ingest(struct client *cl)
     ZOOM_record rec = 0;
     ZOOM_resultset resultset = cl->resultset;
     int offset = cl->record_offset;
-    if ((rec = ZOOM_resultset_record(resultset, offset)))
+    if ((rec = ZOOM_resultset_record_immediate(resultset, offset)))
     {
         cl->record_offset++;
-        if (cl->session == 0)
-            ;
+        if (cl->session == 0) {
+            /* no operation */
+        }
         else if (ZOOM_record_error(rec, &msg, &addinfo, 0))
         {
             yaz_log(YLOG_WARN, "Record error %s (%s): %s (rec #%d)",
-                    msg, addinfo, client_get_id(cl),
-                    cl->record_offset);
+                    msg, addinfo, client_get_id(cl), cl->record_offset);
         }
         else
         {
@@ -608,8 +608,11 @@ static void client_record_ingest(struct client *cl)
             else
             {
                 /* OK = 0, -1 = failure, -2 = Filtered */
-                if (ingest_record(cl, xmlrec, cl->record_offset, nmem) == -1)
+                int rc = ingest_record(cl, xmlrec, cl->record_offset, nmem);
+                if (rc == -1)
                     yaz_log(YLOG_WARN, "Failed to ingest from %s", client_get_id(cl));
+                if (rc == -2)
+                    cl->filtered += 1;
             }
             nmem_destroy(nmem);
         }
@@ -639,8 +642,8 @@ void client_record_response(struct client *cl)
         if (cl->show_raw && cl->show_raw->active)
         {
             ZOOM_record rec = 0;
-            if ((rec = ZOOM_resultset_record(resultset,
-                                             cl->show_raw->position-1)))
+            if ((rec = ZOOM_resultset_record_immediate(
+                     resultset, cl->show_raw->position-1)))
             {
                 cl->show_raw->active = 0;
                 ingest_raw_record(cl, rec);
@@ -662,6 +665,7 @@ void client_reingest(struct client *cl)
 {
     int i = cl->startrecs;
     int to = cl->record_offset;
+    cl->filtered = 0;
 
     cl->record_offset = i;
     for (; i < to; i++)
@@ -752,8 +756,14 @@ void client_start_search(struct client *cl)
     const char *opt_sort        = session_setting_oneval(sdb, PZ_SORT);
     const char *opt_preferred   = session_setting_oneval(sdb, PZ_PREFERRED);
     const char *extra_args      = session_setting_oneval(sdb, PZ_EXTRA_ARGS);
-    char maxrecs_str[24], startrecs_str[24];
+    const char *opt_present_chunk = session_setting_oneval(sdb, PZ_PRESENT_CHUNK);
     ZOOM_query q;
+    char maxrecs_str[24], startrecs_str[24], present_chunk_str[24];
+    int present_chunk = 20; // Default chunk size
+    if (opt_present_chunk && strcmp(opt_present_chunk,"")) {
+        present_chunk = atoi(opt_present_chunk);
+        yaz_log(YLOG_DEBUG, "Present chunk set to %d", present_chunk);
+    }
 
     assert(link);
 
@@ -768,7 +778,6 @@ void client_start_search(struct client *cl)
             yaz_log(YLOG_LOG, "Target %s has preferred status: %d",
                     client_get_id(cl), cl->preferred);
     }
-    client_set_state(cl, Client_Working);
 
     if (*opt_piggyback)
         ZOOM_connection_option_set(link, "piggyback", opt_piggyback);
@@ -792,11 +801,16 @@ void client_start_search(struct client *cl)
     sprintf(maxrecs_str, "%d", cl->maxrecs);
     ZOOM_connection_option_set(link, "count", maxrecs_str);
 
-    if (cl->maxrecs > 20)
-        ZOOM_connection_option_set(link, "presentChunk", "20");
-    else
+    /* A present_chunk less than 1 will disable chunking. */
+    if (present_chunk > 0 && cl->maxrecs > present_chunk) {
+        sprintf(present_chunk_str, "%d", present_chunk);
+        ZOOM_connection_option_set(link, "presentChunk", present_chunk_str);
+        yaz_log(YLOG_DEBUG, "Present chunk set to %s", present_chunk_str);
+    }
+    else {
         ZOOM_connection_option_set(link, "presentChunk", maxrecs_str);
-
+        yaz_log(YLOG_DEBUG, "Present chunk set to %s (maxrecs)", maxrecs_str);
+    }
     sprintf(startrecs_str, "%d", cl->startrecs);
     ZOOM_connection_option_set(link, "start", startrecs_str);
 
@@ -849,11 +863,11 @@ void client_start_search(struct client *cl)
             if (se->sorted_results->next)
             {
                 ZOOM_query_destroy(q);
-                client_set_state_nb(cl, Client_Idle);
                 return;
             }
         }
     }
+    client_set_state(cl, Client_Working);
     cl->hits = 0;
     cl->record_offset = 0;
     rs = ZOOM_connection_search(link, q);
@@ -876,6 +890,7 @@ struct client *client_create(const char *id)
     cl->session = 0;
     cl->hits = 0;
     cl->record_offset = 0;
+    cl->filtered = 0;
     cl->diagnostic = 0;
     cl->state = Client_Disconnected;
     cl->show_raw = 0;
@@ -992,60 +1007,44 @@ static CCL_bibset prepare_cclmap(struct client *cl)
 }
 
 // returns a xmalloced CQL query corresponding to the pquery in client
-static char *make_cqlquery(struct client *cl)
+static char *make_cqlquery(struct client *cl, Z_RPNQuery *zquery)
 {
     cql_transform_t cqlt = cql_transform_create();
-    Z_RPNQuery *zquery;
-    char *r;
+    char *r = 0;
     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 = cql_transform_rpn2cql_wrbuf(cqlt, wrb, zquery)))
     {
         yaz_log(YLOG_WARN, "Failed to generate CQL query, code=%d", status);
-        r = 0;
     }
     else
     {
         r = xstrdup(wrbuf_cstr(wrb));
     }     
     wrbuf_destroy(wrb);
-    odr_destroy(odr_out);
     cql_transform_close(cqlt);
     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)
+static char *make_solrquery(struct client *cl, Z_RPNQuery *zquery)
 {
     solr_transform_t sqlt = solr_transform_create();
-    Z_RPNQuery *zquery;
-    char *r;
+    char *r = 0;
     WRBUF wrb = wrbuf_alloc();
     int status;
-    ODR odr_out = odr_createmem(ODR_ENCODE);
-
-    zquery = p_query_rpn(odr_out, cl->pquery);
-    if (zquery == 0) {
-        yaz_log(YLOG_WARN, "Failed to generate RPN from PQF: %s", cl->pquery);
-        return 0;
-    }
-    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 from PQF %s, code=%d", cl->pquery, status);
-        r = 0;
+        yaz_log(YLOG_WARN, "Failed to generate SOLR query, code=%d", status);
     }
     else
     {
         r = xstrdup(wrbuf_cstr(wrb));
     }
     wrbuf_destroy(wrb);
-    odr_destroy(odr_out);
     solr_transform_close(sqlt);
     return r;
 }
@@ -1137,8 +1136,9 @@ static int apply_limit(struct session_database *sdb,
                     wrbuf_puts(w_ccl, ")");
 
                 }
-                else if (!strncmp(s->value, "local:", 6))
-                    ;
+                else if (!strncmp(s->value, "local:", 6)) {
+                    /* no operation */
+                }
                 else
                 {
                     yaz_log(YLOG_WARN, "Target %s: Bad limitmap '%s'",
@@ -1160,6 +1160,10 @@ static int apply_limit(struct session_database *sdb,
 }
                         
 // Parse the query given the settings specific to this client
+// return 0 if query is OK but different from before
+// return 1 if query is OK but same as before
+// return -1 on query error
+// return -2 on limit error
 int client_parse_query(struct client *cl, const char *query,
                        facet_limits_t facet_limits,
                        const char *startrecs, const char *maxrecs)
@@ -1168,6 +1172,7 @@ int client_parse_query(struct client *cl, const char *query,
     struct session_database *sdb = client_get_database(cl);
     struct ccl_rpn_node *cn;
     int cerror, cpos;
+    ODR odr_out;
     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);
@@ -1175,11 +1180,11 @@ int client_parse_query(struct client *cl, const char *query,
     const char *query_syntax = session_setting_oneval(sdb, PZ_QUERY_SYNTAX);
     WRBUF w_ccl, w_pqf;
     int ret_value = 1;
+    Z_RPNQuery *zquery;
 
     if (!ccl_map)
         return -1;
 
-
     if (maxrecs && atoi(maxrecs) != cl->maxrecs)
     {
         ret_value = 0;
@@ -1243,6 +1248,7 @@ int client_parse_query(struct client *cl, const char *query,
                 wrbuf_putc(w_pqf, cp[0]);
         }
     }
+
     if (!cl->pquery || strcmp(cl->pquery, wrbuf_cstr(w_pqf)))
     {
         xfree(cl->pquery);
@@ -1250,27 +1256,36 @@ int client_parse_query(struct client *cl, const char *query,
         ret_value = 0;
     }
     wrbuf_destroy(w_pqf);
-
-    yaz_log(YLOG_LOG, "PQF query: %s", cl->pquery);
-
+    
     xfree(cl->cqlquery);
+    cl->cqlquery = 0;
 
-    /* Support for PQF on SRU targets. */
-    /* TODO Refactor */
-    yaz_log(YLOG_DEBUG, "Query syntax: %s", query_syntax);
-    if (strcmp(query_syntax, "pqf") != 0 && *sru)
+    odr_out = odr_createmem(ODR_ENCODE);    
+    zquery = p_query_rpn(odr_out, cl->pquery);
+    if (!zquery)
     {
-        if (!strcmp(sru, "solr")) {
-            if (!(cl->cqlquery = make_solrquery(cl)))
-                return -1;
-        }
-        else {
-            if (!(cl->cqlquery = make_cqlquery(cl)))
-                return -1;
-        }
+
+        session_log(se, YLOG_WARN, "Invalid PQF query for %s: %s",
+                    client_get_id(cl), cl->pquery);
+        ret_value = -1;
     }
     else
-        cl->cqlquery = 0;
+    {
+        session_log(se, YLOG_LOG, "PQF for %s: %s",
+                    client_get_id(cl), cl->pquery);
+        
+        /* Support for PQF on SRU targets. */
+        if (strcmp(query_syntax, "pqf") != 0 && *sru)
+        {
+            if (!strcmp(sru, "solr"))
+                cl->cqlquery = make_solrquery(cl, zquery);
+            else
+                cl->cqlquery = make_cqlquery(cl, zquery);
+            if (!cl->cqlquery)
+                ret_value = -1;
+        }
+    }
+    odr_destroy(odr_out);
 
     /* TODO FIX Not thread safe */
     if (!se->relevance)
@@ -1279,7 +1294,6 @@ int client_parse_query(struct client *cl, const char *query,
         se->relevance = relevance_create_ccl(
             se->service->charsets, se->nmem, cn);
     }
-
     ccl_rpn_delete(cn);
     return ret_value;
 }
@@ -1314,11 +1328,26 @@ Odr_int client_get_hits(struct client *cl)
     return cl->hits;
 }
 
+Odr_int client_get_approximation(struct client *cl)
+{
+    if (cl->record_offset > 0) {
+        Odr_int approx = ((10 * cl->hits * (cl->record_offset - cl->filtered)) / cl->record_offset + 5) /10;
+        yaz_log(YLOG_LOG, "%s: Approx: %lld * %d / %d = %lld ", client_get_id(cl), cl->hits, cl->record_offset - cl->filtered, cl->record_offset, approx);
+        return approx;
+    }
+    return cl->hits;
+}
+
 int client_get_num_records(struct client *cl)
 {
     return cl->record_offset;
 }
 
+int client_get_num_records_filtered(struct client *cl)
+{
+    return cl->filtered;
+}
+
 void client_set_diagnostic(struct client *cl, int diagnostic,
                            const char *addinfo)
 {