Re-ingest native facets PAZ-934
[pazpar2-moved-to-github.git] / src / client.c
index 5f2df7b..f78530c 100644 (file)
@@ -1,5 +1,5 @@
 /* This file is part of Pazpar2.
-   Copyright (C) 2006-2013 Index Data
+   Copyright (C) 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
@@ -73,7 +73,6 @@ Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 
 static YAZ_MUTEX g_mutex = 0;
 static int no_clients = 0;
-static int no_clients_total = 0;
 
 static int client_use(int delta)
 {
@@ -82,29 +81,18 @@ static int client_use(int delta)
         yaz_mutex_create(&g_mutex);
     yaz_mutex_enter(g_mutex);
     no_clients += delta;
-    if (delta > 0)
-        no_clients_total += delta;
     clients = no_clients;
     yaz_mutex_leave(g_mutex);
-    yaz_log(YLOG_DEBUG, "%s clients=%d", delta == 0 ? "" : (delta > 0 ? "INC" : "DEC"), clients);
+    yaz_log(YLOG_DEBUG, "%s clients=%d",
+            delta == 0 ? "" : (delta > 0 ? "INC" : "DEC"), clients);
     return clients;
 }
 
-int  clients_count(void) {
+int clients_count(void)
+{
     return client_use(0);
 }
 
-int  clients_count_total(void) {
-    int total = 0;
-    if (!g_mutex)
-        return 0;
-    yaz_mutex_enter(g_mutex);
-    total = no_clients_total;
-    yaz_mutex_leave(g_mutex);
-    return total;
-}
-
-
 /** \brief Represents client state for a connection to one search target */
 struct client {
     struct session_database *database;
@@ -221,11 +209,6 @@ struct session *client_get_session(struct client *cl)
     return cl->session;
 }
 
-const char *client_get_pquery(struct client *cl)
-{
-    return cl->pquery;
-}
-
 static void client_send_raw_present(struct client *cl);
 static int nativesyntax_to_type(const char *s, char *type, ZOOM_record rec);
 
@@ -359,7 +342,7 @@ void client_show_raw_remove(struct client *cl, void *data)
     }
 }
 
-void client_show_raw_dequeue(struct client *cl)
+static void client_show_raw_dequeue(struct client *cl)
 {
     struct show_raw *rr = cl->show_raw;
 
@@ -455,7 +438,7 @@ static int nativesyntax_to_type(const char *s, char *type,
  * TODO Consider thread safety!!!
  *
  */
-void client_report_facets(struct client *cl, ZOOM_resultset rs)
+static void client_report_facets(struct client *cl, ZOOM_resultset rs)
 {
     struct session_database *sdb = client_get_database(cl);
     ZOOM_facet_field *facets = ZOOM_resultset_facets(rs);
@@ -555,10 +538,13 @@ void client_search_response(struct client *cl)
         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);
+        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"));
+        cl->suggestions =
+            client_suggestions_create(ZOOM_resultset_option_get(
+                                          resultset, "suggestions"));
     }
 }
 
@@ -589,9 +575,8 @@ static void client_record_ingest(struct client *cl)
     if ((rec = ZOOM_resultset_record_immediate(resultset, cl->record_offset)))
     {
         int offset = ++cl->record_offset;
-        if (cl->session == 0) {
-            /* no operation */
-        }
+        if (cl->session == 0)
+            ;  /* no operation */
         else if (ZOOM_record_error(rec, &msg, &addinfo, 0))
         {
             session_log(se, YLOG_WARN, "Record error %s (%s): %s #%d",
@@ -777,22 +762,22 @@ int client_fetch_more(struct client *cl)
     struct session_database *sdb = client_get_database(cl);
     const char *str;
     int extend_recs = 0;
-    int number;
+    int number = cl->hits - cl->record_offset;
+
+    str = session_setting_oneval(sdb, PZ_EXTENDRECS);
+    if (!str || !*str)
+        return 0;
+
+    extend_recs = atoi(str);
 
     yaz_log(YLOG_LOG, "cl=%s show_stat_no=%d got=%d",
             client_get_id(cl), cl->show_stat_no, cl->record_offset);
     if (cl->show_stat_no < cl->record_offset)
         return 0;
-    yaz_log(YLOG_LOG, "cl=%s Trying to get more", client_get_id(cl));
+    yaz_log(YLOG_LOG, "cl=%s Trying to fetch more", client_get_id(cl));
 
-    str = session_setting_oneval(sdb, PZ_EXTENDRECS);
-    if (str && *str)
-        extend_recs = atoi(str);
-
-    if (extend_recs > cl->hits)
-        extend_recs = cl->hits;
-
-    number = extend_recs - cl->record_offset;
+    if (number > extend_recs)
+        number = extend_recs;
     if (number > 0)
     {
         ZOOM_resultset set = cl->resultset;
@@ -825,7 +810,8 @@ int client_parse_init(struct client *cl, int same_search)
 /*
  * TODO consider how to extend the range
  * */
-int client_parse_range(struct client *cl, const char *startrecs, const char *maxrecs)
+int client_parse_range(struct client *cl, const char *startrecs,
+                       const char *maxrecs)
 {
     if (maxrecs && atoi(maxrecs) != cl->maxrecs)
     {
@@ -881,12 +867,15 @@ int client_start_search(struct client *cl)
     /* Nothing has changed and we already have a result */
     if (cl->same_search == 1 && rc_prep_connection == 2)
     {
-        session_log(se, YLOG_LOG, "client %s REUSE result", client_get_id(cl));
+        session_log(se, YLOG_LOG, "client %s resuse result", client_get_id(cl));
+        client_report_facets(cl, cl->resultset);
         return client_reingest(cl);
     }
     else if (!rc_prep_connection)
     {
-        session_log(se, YLOG_LOG, "client %s FAILED to search: No connection.", client_get_id(cl));
+        session_log(se, YLOG_LOG, "client %s postponing search: No connection",
+                    client_get_id(cl));
+        client_set_state_nb(cl, Client_Working);
         return -1;
     }
     co = client_get_connection(cl);
@@ -894,7 +883,7 @@ int client_start_search(struct client *cl)
     link = connection_get_link(co);
     assert(link);
 
-    session_log(se, YLOG_LOG, "client %s NEW search", client_get_id(cl));
+    session_log(se, YLOG_LOG, "client %s new search", client_get_id(cl));
 
     cl->diagnostic = 0;
     cl->filtered = 0;
@@ -951,19 +940,22 @@ int client_start_search(struct client *cl)
     query = ZOOM_query_create();
     if (cl->cqlquery)
     {
-        yaz_log(YLOG_LOG, "Client %s: Search CQL: %s", client_get_id(cl), cl->cqlquery);
+        yaz_log(YLOG_LOG, "Client %s: Search CQL: %s", client_get_id(cl),
+                cl->cqlquery);
         ZOOM_query_cql(query, cl->cqlquery);
         if (*opt_sort)
             ZOOM_query_sortby(query, opt_sort);
     }
     else
     {
-        yaz_log(YLOG_LOG, "Client %s: Search PQF: %s", client_get_id(cl), cl->pquery);
+        yaz_log(YLOG_LOG, "Client %s: Search PQF: %s", client_get_id(cl),
+                cl->pquery);
 
         ZOOM_query_prefix(query, cl->pquery);
     }
     if (cl->sort_strategy && cl->sort_criteria) {
-        yaz_log(YLOG_LOG, "Client %s: Setting ZOOM sort strategy and criteria: %s %s",
+        yaz_log(YLOG_LOG, "Client %s: "
+                "Set ZOOM sort strategy and criteria: %s %s",
                 client_get_id(cl), cl->sort_strategy, cl->sort_criteria);
         ZOOM_query_sortby2(query, cl->sort_strategy, cl->sort_criteria);
     }
@@ -1011,6 +1003,7 @@ struct client *client_create(const char *id)
     cl->id = xstrdup(id);
     client_use(1);
 
+    yaz_log(YLOG_DEBUG, "client_create c=%p %s", cl, id);
     return cl;
 }
 
@@ -1090,7 +1083,6 @@ void client_disconnect(struct client *cl)
     client_set_connection(cl, 0);
 }
 
-
 // Initialize CCL map for a target
 static CCL_bibset prepare_cclmap(struct client *cl, CCL_bibset base_bibset)
 {
@@ -1317,8 +1309,8 @@ static int apply_limit(struct session_database *sdb,
                                 sdb->database->id, cvalue);
                         ret = -1; /* bad limitmap */
                     }
-                    break;
                 }
+                break;
             }
         }
         if (!s)
@@ -1352,7 +1344,7 @@ static int apply_limit(struct session_database *sdb,
 // 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)
+                       facet_limits_t facet_limits, const char **error_msg)
 {
     struct session *se = client_get_session(cl);
     struct conf_service *service = se->service;
@@ -1391,11 +1383,14 @@ int client_parse_query(struct client *cl, const char *query,
     facet_limits_destroy(cl->facet_limits);
     cl->facet_limits = facet_limits_dup(facet_limits);
 
-    yaz_log(YLOG_LOG, "Client %s: CCL query: %s limit: %s", client_get_id(cl), wrbuf_cstr(w_ccl), wrbuf_cstr(w_pqf));
+    yaz_log(YLOG_LOG, "Client %s: CCL query: %s limit: %s",
+            client_get_id(cl), wrbuf_cstr(w_ccl), wrbuf_cstr(w_pqf));
     cn = ccl_find_str(ccl_map, wrbuf_cstr(w_ccl), &cerror, &cpos);
     ccl_qual_rm(&ccl_map);
     if (!cn)
     {
+        if (error_msg)
+            *error_msg = ccl_err_msg(cerror);
         client_set_state(cl, Client_Error);
         session_log(se, YLOG_WARN, "Client %s: Failed to parse CCL query '%s'",
                     client_get_id(cl),
@@ -1431,7 +1426,8 @@ int client_parse_query(struct client *cl, const char *query,
     if (!cl->pquery || strcmp(cl->pquery, wrbuf_cstr(w_pqf)))
     {
         if (cl->pquery)
-            session_log(se, YLOG_LOG, "Client %s: Re-search due query/limit change: %s to %s", 
+            session_log(se, YLOG_LOG, "Client %s: "
+                        "Re-search due query/limit change: %s to %s", 
                         client_get_id(cl), cl->pquery, wrbuf_cstr(w_pqf));
         xfree(cl->pquery);
         cl->pquery = xstrdup(wrbuf_cstr(w_pqf));
@@ -1453,6 +1449,7 @@ int client_parse_query(struct client *cl, const char *query,
         session_log(se, YLOG_WARN, "Invalid PQF query for Client %s: %s",
                     client_get_id(cl), cl->pquery);
         ret_value = -1;
+        *error_msg = "Invalid PQF after CCL to PQF conversion";
     }
     else
     {
@@ -1467,7 +1464,10 @@ int client_parse_query(struct client *cl, const char *query,
             else
                 cl->cqlquery = make_cqlquery(cl, zquery);
             if (!cl->cqlquery)
+            {
+                *error_msg = "Cannot convert PQF to Solr/CQL";
                 ret_value = -1;
+            }
             else
                 session_log(se, YLOG_LOG, "Client %s native query: %s (%s)",
                             client_get_id(cl), cl->cqlquery, sru);
@@ -1496,6 +1496,8 @@ int client_parse_sort(struct client *cl, struct reclist_sortparms *sp)
         const char *sort_strategy_and_spec =
             get_strategy_plus_sort(cl, sp->name);
         int increasing = sp->increasing;
+        if (!strcmp(sp->name, "relevance"))
+            increasing = 1;
         if (sort_strategy_and_spec && strlen(sort_strategy_and_spec) < 40)
         {
             char strategy[50], *p;
@@ -1511,7 +1513,9 @@ int client_parse_sort(struct client *cl, struct reclist_sortparms *sp)
                     strcat(p, " <");
                 else
                     strcat(p, " >");
-                yaz_log(YLOG_LOG, "Client %s: applying sorting %s %s", client_get_id(cl), strategy, p);
+                yaz_log(YLOG_LOG, "Client %s: "
+                        "applying sorting %s %s", client_get_id(cl),
+                        strategy, p);
                 if (!cl->sort_strategy || strcmp(cl->sort_strategy, strategy))
                     cl->same_search = 0;
                 if (!cl->sort_criteria || strcmp(cl->sort_criteria, p))
@@ -1524,14 +1528,19 @@ int client_parse_sort(struct client *cl, struct reclist_sortparms *sp)
                 }
             }
             else {
-                yaz_log(YLOG_LOG, "Client %s: Invalid sort strategy and spec found %s", client_get_id(cl), sort_strategy_and_spec);
+                yaz_log(YLOG_LOG, "Client %s: "
+                        "Invalid sort strategy and spec found %s",
+                        client_get_id(cl), sort_strategy_and_spec);
                 xfree(cl->sort_strategy);
                 cl->sort_strategy  = 0;
                 xfree(cl->sort_criteria);
                 cl->sort_criteria = 0;
             }
-        } else {
-            yaz_log(YLOG_DEBUG, "Client %s: No sort strategy and spec found.", client_get_id(cl));
+        }
+        else
+        {
+            yaz_log(YLOG_DEBUG, "Client %s: "
+                    "No sort strategy and spec found.", client_get_id(cl));
             xfree(cl->sort_strategy);
             cl->sort_strategy  = 0;
             xfree(cl->sort_criteria);
@@ -1574,9 +1583,13 @@ Odr_int client_get_hits(struct client *cl)
 
 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_DEBUG, "%s: Approx: %lld * %d / %d = %lld ", client_get_id(cl), cl->hits, cl->record_offset - cl->filtered, cl->record_offset, approx);
+    if (cl->record_offset > 0)
+    {
+        Odr_int approx = ((10 * cl->hits * (cl->record_offset - cl->filtered))
+                          / cl->record_offset + 5) /10;
+        yaz_log(YLOG_DEBUG, "%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;
@@ -1619,17 +1632,16 @@ const char * client_get_suggestions_xml(struct client *cl, WRBUF wrbuf)
     /* int idx; */
     struct suggestions *suggestions = cl->suggestions;
 
-    if (!suggestions) {
-        //yaz_log(YLOG_DEBUG, "No suggestions found");
+    if (!suggestions) 
         return "";
-    }
-    if (suggestions->passthrough) {
-        yaz_log(YLOG_DEBUG, "Passthrough Suggestions: \n%s\n", suggestions->passthrough);
+    if (suggestions->passthrough)
+    {
+        yaz_log(YLOG_DEBUG, "Passthrough Suggestions: \n%s\n",
+                suggestions->passthrough);
         return suggestions->passthrough;
     }
-    if (suggestions->num == 0) {
+    if (suggestions->num == 0)
         return "";
-    }
     /*
     for (idx = 0; idx < suggestions->num; idx++) {
         wrbuf_printf(wrbuf, "<suggest term=\"%s\"", suggestions->suggest[idx]);
@@ -1687,7 +1699,8 @@ struct suggestions* client_suggestions_create(const char* suggestions_string)
         nmem_strsplit_escape2(suggestions->nmem, "\n", suggestions_string, &suggestions->suggest,
                               &suggestions->num, 1, '\\', 0);
     /* Set up misspelled array */
-    suggestions->misspelled = (char **) nmem_malloc(nmem, suggestions->num * sizeof(**suggestions->misspelled));
+    suggestions->misspelled = (char **)
+        nmem_malloc(nmem, suggestions->num * sizeof(*suggestions->misspelled));
     /* replace = with \0 .. for each item */
     for (i = 0; i < suggestions->num; i++)
     {
@@ -1707,11 +1720,6 @@ static void client_suggestions_destroy(struct client *cl)
     nmem_destroy(nmem);
 }
 
-int client_test_sort_order(struct client *cl, struct reclist_sortparms *sp)
-{
-    //TODO implement correctly.
-    return 1;
-}
 /*
  * Local variables:
  * c-basic-offset: 4