Add fallback template
[pazpar2-moved-to-github.git] / src / client.c
index 5bebb59..510cf68 100644 (file)
@@ -114,13 +114,21 @@ struct client {
     int startrecs;
     int diagnostic;
     int preferred;
+    struct suggestions *suggestions;
     enum client_state state;
     struct show_raw *show_raw;
     ZOOM_resultset resultset;
     YAZ_MUTEX mutex;
     int ref_count;
-    /* copy of database->url */
-    char *url;
+    char *id;
+};
+
+struct suggestions {
+    NMEM nmem;
+    int num;
+    char **misspelled;
+    char **suggest;
+    char *passthrough;
 };
 
 struct show_raw {
@@ -154,6 +162,11 @@ enum client_state client_get_state(struct client *cl)
     return cl->state;
 }
 
+void client_set_state_nb(struct client *cl, enum client_state st)
+{
+    cl->state = st;
+}
+
 void client_set_state(struct client *cl, enum client_state st)
 {
     int was_active = 0;
@@ -167,9 +180,12 @@ void client_set_state(struct client *cl, enum client_state st)
     {
 
         int no_active = session_active_clients(cl->session);
-        yaz_log(YLOG_DEBUG, "%s: releasing watches on zero active: %d", client_get_url(cl), no_active);
+        yaz_log(YLOG_DEBUG, "%s: releasing watches on zero active: %d",
+                client_get_id(cl), no_active);
         if (no_active == 0) {
             session_alert_watch(cl->session, SESSION_WATCH_SHOW);
+            session_alert_watch(cl->session, SESSION_WATCH_BYTARGET);
+            session_alert_watch(cl->session, SESSION_WATCH_TERMLIST);
             session_alert_watch(cl->session, SESSION_WATCH_SHOW_PREF);
         }
     }
@@ -347,7 +363,7 @@ static void client_send_raw_present(struct client *cl)
     assert(set);
 
     yaz_log(YLOG_DEBUG, "%s: trying to present %d record(s) from %d",
-            client_get_url(cl), 1, offset);
+            client_get_id(cl), 1, offset);
 
     if (cl->show_raw->syntax)
         syntax = cl->show_raw->syntax;
@@ -484,7 +500,7 @@ static void ingest_raw_record(struct client *cl, ZOOM_record rec)
 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));
+    yaz_log(YLOG_DEBUG, "client_check_preferred_watch: %s ", client_get_id(cl));
     if (se)
     {
         client_unlock(cl);
@@ -498,14 +514,16 @@ void client_check_preferred_watch(struct client *cl)
         client_lock(cl);
     }
     else
-        yaz_log(YLOG_WARN, "client_check_preferred_watch: %s. No session!", client_get_url(cl));
+        yaz_log(YLOG_WARN, "client_check_preferred_watch: %s. No session!", client_get_id(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;
 
@@ -516,7 +534,7 @@ void client_search_response(struct client *cl)
         cl->hits = 0;
         client_set_state(cl, Client_Error);
         yaz_log(YLOG_WARN, "Search error %s (%s): %s",
-                error, addinfo, client_get_url(cl));
+                error, addinfo, client_get_id(cl));
     }
     else
     {
@@ -525,11 +543,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"));
     }
 }
 
@@ -540,6 +556,8 @@ void client_got_records(struct client *cl)
     {
         client_unlock(cl);
         session_alert_watch(se, SESSION_WATCH_SHOW);
+        session_alert_watch(se, SESSION_WATCH_BYTARGET);
+        session_alert_watch(se, SESSION_WATCH_TERMLIST);
         session_alert_watch(se, SESSION_WATCH_RECORD);
         client_lock(cl);
     }
@@ -556,7 +574,7 @@ void client_record_response(struct client *cl)
     {
         client_set_state(cl, Client_Error);
         yaz_log(YLOG_WARN, "Search error %s (%s): %s",
-            error, addinfo, client_get_url(cl));
+            error, addinfo, client_get_id(cl));
     }
     else
     {
@@ -588,7 +606,7 @@ void client_record_response(struct client *cl)
                 else if (ZOOM_record_error(rec, &msg, &addinfo, 0))
                 {
                     yaz_log(YLOG_WARN, "Record error %s (%s): %s (rec #%d)",
-                            msg, addinfo, client_get_url(cl),
+                            msg, addinfo, client_get_id(cl),
                             cl->record_offset);
                 }
                 else
@@ -603,12 +621,12 @@ void client_record_response(struct client *cl)
                     xmlrec = ZOOM_record_get(rec, type, NULL);
                     if (!xmlrec)
                         yaz_log(YLOG_WARN, "ZOOM_record_get failed from %s",
-                                client_get_url(cl));
+                                client_get_id(cl));
                     else
                     {
                         /* OK = 0, -1 = failure, -2 = Filtered */
                         if (ingest_record(cl, xmlrec, cl->record_offset, nmem) == -1)
-                            yaz_log(YLOG_WARN, "Failed to ingest from %s", client_get_url(cl));
+                            yaz_log(YLOG_WARN, "Failed to ingest from %s", client_get_id(cl));
                     }
                     nmem_destroy(nmem);
                 }
@@ -665,13 +683,38 @@ int client_has_facet(struct client *cl, const char *name)
     return 0;
 }
 
+static const char *get_strategy_plus_sort(struct client *l, const char *field)
+{
+    struct session_database *sdb = client_get_database(l);
+    struct setting *s;
+
+    const char *strategy_plus_sort = 0;
+    
+    for (s = sdb->settings[PZ_SORTMAP]; s; s = s->next)
+    {
+        char *p = strchr(s->name + 3, ':');
+        if (!p)
+        {
+            yaz_log(YLOG_WARN, "Malformed sortmap name: %s", s->name);
+            continue;
+        }
+        p++;
+        if (!strcmp(p, field))
+        {
+            strategy_plus_sort = s->value;
+            break;
+        }
+    }
+    return strategy_plus_sort;
+}
+
 void client_start_search(struct client *cl)
 {
     struct session_database *sdb = client_get_database(cl);
     struct connection *co = client_get_connection(cl);
     ZOOM_connection link = connection_get_link(co);
+    struct session *se = client_get_session(cl);
     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);
@@ -682,10 +725,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;
 
@@ -695,7 +738,8 @@ void client_start_search(struct client *cl)
     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);
+            yaz_log(YLOG_LOG, "Target %s has preferred status: %d",
+                    client_get_id(cl), cl->preferred);
     }
     client_set_state(cl, Client_Working);
 
@@ -729,34 +773,68 @@ void client_start_search(struct client *cl)
     sprintf(startrecs_str, "%d", cl->startrecs);
     ZOOM_connection_option_set(link, "start", startrecs_str);
 
-    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);
 
+    q = ZOOM_query_create();
     if (cl->cqlquery)
     {
-        ZOOM_query q = ZOOM_query_create();
-        yaz_log(YLOG_LOG, "Search %s CQL: %s", sdb->database->url, cl->cqlquery);
+        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", sdb->database->url, cl->pquery);
-        rs = ZOOM_connection_search_pqf(link, cl->pquery);
+        yaz_log(YLOG_LOG, "Search %s PQF: %s", client_get_id(cl), cl->pquery);
+        
+        ZOOM_query_prefix(q, cl->pquery);
+    }
+    if (se->sorted_results)
+    {   /* first entry is current sorting ! */
+        const char *sort_strategy_and_spec =
+            get_strategy_plus_sort(cl, se->sorted_results->field);
+        int increasing = se->sorted_results->increasing;
+        if (sort_strategy_and_spec && strlen(sort_strategy_and_spec) < 40)
+        {
+            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);
+            }
+        }
+        else
+        {
+            /* no native sorting.. If this is not the first search, then
+               skip it entirely */
+            if (se->sorted_results->next)
+            {
+                ZOOM_query_destroy(q);
+                client_set_state_nb(cl, Client_Idle);
+                return;
+            }
+        }
     }
+    rs = ZOOM_connection_search(link, q);
+    ZOOM_query_destroy(q);
     ZOOM_resultset_destroy(cl->resultset);
     cl->resultset = rs;
     connection_continue(co);
 }
 
-struct client *client_create(void)
+struct client *client_create(const char *id)
 {
     struct client *cl = xmalloc(sizeof(*cl));
     cl->maxrecs = 100;
@@ -772,11 +850,13 @@ struct client *client_create(void)
     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;
     cl->ref_count = 1;
-    cl->url = 0;
+    assert(id);
+    cl->id = xstrdup(id);
     client_use(1);
     
     return cl;
@@ -796,7 +876,7 @@ void client_incref(struct client *c)
 {
     pazpar2_incref(&c->ref_count, c->mutex);
     yaz_log(YLOG_DEBUG, "client_incref c=%p %s cnt=%d",
-            c, client_get_url(c), c->ref_count);
+            c, client_get_id(c), c->ref_count);
 }
 
 int client_destroy(struct client *c)
@@ -804,14 +884,14 @@ int client_destroy(struct client *c)
     if (c)
     {
         yaz_log(YLOG_DEBUG, "client_destroy c=%p %s cnt=%d",
-                c, client_get_url(c), c->ref_count);
+                c, client_get_id(c), c->ref_count);
         if (!pazpar2_decref(&c->ref_count, c->mutex))
         {
             xfree(c->pquery);
             c->pquery = 0;
             xfree(c->cqlquery);
             c->cqlquery = 0;
-            xfree(c->url);
+            xfree(c->id);
             assert(!c->connection);
 
             if (c->resultset)
@@ -916,10 +996,14 @@ static char *make_solrquery(struct client *cl)
     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, code=%d", status);
+        yaz_log(YLOG_WARN, "Failed to generate SOLR query from PQF %s, code=%d", cl->pquery, status);
         r = 0;
     }
     else
@@ -939,6 +1023,7 @@ static void apply_limit(struct session_database *sdb,
     int i = 0;
     const char *name;
     const char *value;
+    NMEM nmem_tmp = nmem_create();
     for (i = 0; (name = facet_limits_get(facet_limits, i, &value)); i++)
     {
         struct setting *s = 0;
@@ -948,32 +1033,55 @@ static void apply_limit(struct session_database *sdb,
             const char *p = strchr(s->name + 3, ':');
             if (p && !strcmp(p + 1, name) && s->value)
             {
+                char **values = 0;
+                int i, num = 0;
+                nmem_strsplit_escape2(nmem_tmp, "|", value, &values,
+                                      &num, 1, '\\', 1);
+
                 if (!strncmp(s->value, "rpn:", 4))
                 {
                     const char *pqf = s->value + 4;
+
                     wrbuf_puts(w_pqf, "@and ");
                     wrbuf_puts(w_pqf, pqf);
                     wrbuf_puts(w_pqf, " ");
-                    yaz_encode_pqf_term(w_pqf, value, strlen(value));
+                    for (i = 0; i < num; i++)
+                    {
+                        if (i < num - 1)
+                            wrbuf_puts(w_pqf, "@or ");
+                        yaz_encode_pqf_term(w_pqf, values[i],
+                                            strlen(values[i]));
+                    }
                 }
                 else if (!strncmp(s->value, "ccl:", 4))
                 {
                     const char *ccl = s->value + 4;
-                    wrbuf_puts(w_ccl, " and ");
-                    wrbuf_puts(w_ccl, ccl);
-                    wrbuf_puts(w_ccl, "=\"");
-                    wrbuf_puts(w_ccl, value);
-                    wrbuf_puts(w_ccl, "\"");
+
+                    wrbuf_puts(w_ccl, " and (");
+
+                    for (i = 0; i < num; i++)
+                    {
+                        if (i)
+                            wrbuf_puts(w_ccl, " or ");
+                        wrbuf_puts(w_ccl, ccl);
+                        wrbuf_puts(w_ccl, "=\"");
+                        wrbuf_puts(w_ccl, values[i]);
+                        wrbuf_puts(w_ccl, "\"");
+                    }
+                    wrbuf_puts(w_ccl, ")");
+
                 }
                 break;
             }
         }
+        nmem_reset(nmem_tmp);
         if (!s)
         {
             yaz_log(YLOG_WARN, "Target %s: limit %s used, but no limitmap defined",
-                    (sdb->database ? sdb->database->url : "<no url>"), name);
+                    (sdb->database ? sdb->database->id : "<no id>"), name);
         }
     }
+    nmem_destroy(nmem_tmp);
 }
                         
 // Parse the query given the settings specific to this client
@@ -993,6 +1101,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);
 
@@ -1013,7 +1122,7 @@ int client_parse_query(struct client *cl, const char *query,
         client_set_state(cl, Client_Error);
         session_log(se, YLOG_WARN, "Failed to parse CCL query '%s' for %s",
                     wrbuf_cstr(w_ccl),
-                    client_get_database(cl)->database->url);
+                    client_get_id(cl));
         wrbuf_destroy(w_ccl);
         wrbuf_destroy(w_pqf);
         return -1;
@@ -1102,7 +1211,6 @@ int client_is_active_preferred(struct client *cl)
     return 0;
 }
 
-
 Odr_int client_get_hits(struct client *cl)
 {
     return cl->hits;
@@ -1123,27 +1231,45 @@ int client_get_diagnostic(struct client *cl)
     return cl->diagnostic;
 }
 
-void client_set_database(struct client *cl, struct session_database *db)
+const char * client_get_suggestions_xml(struct client *cl, WRBUF wrbuf)
 {
-    cl->database = db;
-    /* Copy the URL for safe logging even after session is gone */
-    if (db) {
-        cl->url = xstrdup(db->database->url);
+    /* int idx; */
+    struct suggestions *suggestions = cl->suggestions;
+
+    if (!suggestions) {
+        //yaz_log(YLOG_DEBUG, "No suggestions found");
+        return "";
+    }
+    if (suggestions->passthrough) {
+        yaz_log(YLOG_DEBUG, "Passthrough Suggestions: \n%s\n", suggestions->passthrough);
+        return suggestions->passthrough;
     }
+    if (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);
 }
 
-struct host *client_get_host(struct client *cl)
+
+void client_set_database(struct client *cl, struct session_database *db)
 {
-    return client_get_database(cl)->database->host;
+    cl->database = db;
 }
 
-const char *client_get_url(struct client *cl)
+const char *client_get_id(struct client *cl)
 {
-    if (cl->url)
-        return cl->url;
-    else
-        /* This must not happen anymore, as the url is present until destruction of client  */
-        return "NOURL";
+    return cl->id;
 }
 
 void client_set_maxrecs(struct client *cl, int v)
@@ -1167,6 +1293,47 @@ void client_set_preferred(struct client *cl, int v)
 }
 
 
+struct suggestions* client_suggestions_create(const char* suggestions_string)
+{
+    int i;
+    NMEM nmem;
+    struct suggestions *suggestions;
+    if (suggestions_string == 0)
+        return 0;
+    nmem = nmem_create();
+    suggestions = nmem_malloc(nmem, sizeof(*suggestions));
+    yaz_log(YLOG_DEBUG, "client target suggestions: %s", suggestions_string);
+
+    suggestions->nmem = nmem;
+    suggestions->num = 0;
+    suggestions->misspelled = 0;
+    suggestions->suggest = 0;
+    suggestions->passthrough = nmem_strdup_null(nmem, suggestions_string);
+
+    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 nmem = cl->suggestions->nmem;
+    cl->suggestions = 0;
+    nmem_destroy(nmem);
+}
+
 /*
  * Local variables:
  * c-basic-offset: 4