Support for suggestions

[pazpar2-moved-to-github.git] / src / client.c

diff --git a/src/client.c b/src/client.c
index 825d900..c910c55 100644 (file)
--- a/src/client.c
+++ b/src/client.c
@@ -114,6 +114,7 @@ struct client {
     int startrecs;
     int diagnostic;
     int preferred;
+    struct suggestions *suggestions;
     enum client_state state;
     struct show_raw *show_raw;
     ZOOM_resultset resultset;
@@ -122,6 +123,13 @@ struct client {
     char *id;
 };
 
+struct suggestions {
+    NMEM nmem;
+    int num;
+    char **misspelled;
+    char **suggest;
+};
+
 struct show_raw {
     int active; // whether this request has been sent to the server
     int position;
@@ -502,10 +510,12 @@ void client_check_preferred_watch(struct client *cl)
 
 }
 
+struct suggestions* client_suggestions_create(const char* suggestions_string);
+static void client_suggestions_destroy(struct client *cl);
+
 void client_search_response(struct client *cl)
 {
     struct connection *co = cl->connection;
-    struct session *se = cl->session;
     ZOOM_connection link = connection_get_link(co);
     ZOOM_resultset resultset = cl->resultset;
 
@@ -525,11 +535,9 @@ void client_search_response(struct client *cl)
         client_report_facets(cl, resultset);
         cl->record_offset = cl->startrecs;
         cl->hits = ZOOM_resultset_size(resultset);
-        if (se) {
-            se->total_hits += cl->hits;
-            yaz_log(YLOG_DEBUG, "client_search_response: total hits "
-                    ODR_INT_PRINTF, se->total_hits);
-        }
+        if (cl->suggestions)
+            client_suggestions_destroy(cl);
+        cl->suggestions = client_suggestions_create(ZOOM_resultset_option_get(resultset, "suggestions"));
     }
 }
 
@@ -665,7 +673,8 @@ int client_has_facet(struct client *cl, const char *name)
     return 0;
 }
 
-void client_start_search(struct client *cl)
+void client_start_search(struct client *cl, const char *sort_strategy_and_spec,
+                         int increasing)
 {
     struct session_database *sdb = client_get_database(cl);
     struct connection *co = client_get_connection(cl);
@@ -681,10 +690,10 @@ void client_start_search(struct client *cl)
     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];
+    ZOOM_query q;
 
     assert(link);
 
-    cl->hits = -1;
     cl->record_offset = 0;
     cl->diagnostic = 0;
 
@@ -733,22 +742,42 @@ void client_start_search(struct client *cl)
     /* facets definition is in PQF */
     client_set_facets_request(cl, link);
 
+    q = ZOOM_query_create();
     if (cl->cqlquery)
     {
-        ZOOM_query q = ZOOM_query_create();
         yaz_log(YLOG_LOG, "Search %s CQL: %s", client_get_id(cl),
                 cl->cqlquery);
         ZOOM_query_cql(q, cl->cqlquery);
         if (*opt_sort)
             ZOOM_query_sortby(q, opt_sort);
-        rs = ZOOM_connection_search(link, q);
-        ZOOM_query_destroy(q);
     }
     else
     {
         yaz_log(YLOG_LOG, "Search %s PQF: %s", client_get_id(cl), cl->pquery);
-        rs = ZOOM_connection_search_pqf(link, cl->pquery);
+        
+        ZOOM_query_prefix(q, cl->pquery);
     }
+    if (sort_strategy_and_spec &&
+        strlen(sort_strategy_and_spec) < 40 /* spec below */)
+    {
+        char spec[50], *p;
+        strcpy(spec, sort_strategy_and_spec);
+        p = strchr(spec, ':');
+        if (p)
+        {
+            *p++ = '\0'; /* cut the string in two */
+            while (*p == ' ')
+                p++;
+            if (increasing)
+                strcat(p, " <");
+            else
+                strcat(p, " >");
+            yaz_log(YLOG_LOG, "applying %s %s", spec, p);
+            ZOOM_query_sortby2(q, spec, p);
+        }
+    }
+    rs = ZOOM_connection_search(link, q);
+    ZOOM_query_destroy(q);
     ZOOM_resultset_destroy(cl->resultset);
     cl->resultset = rs;
     connection_continue(co);
@@ -770,6 +799,7 @@ struct client *client_create(const char *id)
     cl->state = Client_Disconnected;
     cl->show_raw = 0;
     cl->resultset = 0;
+    cl->suggestions = 0;
     cl->mutex = 0;
     pazpar2_mutex_create(&cl->mutex, "client");
     cl->preferred = 0;
@@ -1020,6 +1050,7 @@ int client_parse_query(struct client *cl, const char *query,
     if (!ccl_map)
         return -1;
 
+    cl->hits = -1;
     w_ccl = wrbuf_alloc();
     wrbuf_puts(w_ccl, query);
 
@@ -1149,6 +1180,26 @@ int client_get_diagnostic(struct client *cl)
     return cl->diagnostic;
 }
 
+const char * client_get_suggestions_xml(struct client *cl, WRBUF wrbuf)
+{
+    int idx;
+    struct suggestions *suggestions = cl->suggestions;
+    if (!suggestions || suggestions->num == 0) {
+        return "";
+    }
+    for (idx = 0; idx < suggestions->num; idx++) {
+        wrbuf_printf(wrbuf, "<suggest term=\"%s\"", suggestions->suggest[idx]);
+        if (suggestions->misspelled[idx] && suggestions->misspelled[idx]) {
+            wrbuf_puts(wrbuf, suggestions->misspelled[idx]);
+            wrbuf_puts(wrbuf, "</suggest>\n");
+        }
+        else
+            wrbuf_puts(wrbuf, "/>\n");
+    }
+    return wrbuf_cstr(wrbuf);
+}
+
+
 void client_set_database(struct client *cl, struct session_database *db)
 {
     cl->database = db;
@@ -1180,6 +1231,39 @@ void client_set_preferred(struct client *cl, int v)
 }
 
 
+struct suggestions* client_suggestions_create(const char* suggestions_string) {
+    if (suggestions_string == 0)
+        return 0;
+    int i;
+    NMEM nmem = nmem_create();
+    struct suggestions *suggestions = nmem_malloc(nmem, sizeof(*suggestions));
+    suggestions->nmem = nmem;
+    suggestions->num = 0;
+    suggestions->misspelled = 0;
+    suggestions->suggest = 0;
+    if (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));
+    /* replace = with \0 .. for each item */
+    for (i = 0; i < suggestions->num; i++)
+    {
+        char *cp = strchr(suggestions->suggest[i], '=');
+        if (cp) {
+            *cp = '\0';
+            suggestions->misspelled[i] = cp+1;
+        }
+    }
+    return suggestions;
+}
+
+static void client_suggestions_destroy(struct client *cl)
+{
+    nmem_destroy(cl->suggestions->nmem);
+    cl->suggestions = 0;
+}
+
 /*
  * Local variables:
  * c-basic-offset: 4