New rank tweaks: follow, lead, length
[pazpar2-moved-to-github.git] / src / client.c
index 2b270ae..00d92ad 100644 (file)
@@ -18,7 +18,7 @@ Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 */
 
 /** \file client.c
-    \brief Z39.50 client 
+    \brief Z39.50 client
 */
 
 #if HAVE_CONFIG_H
@@ -286,7 +286,7 @@ int client_show_raw_begin(struct client *cl, int position,
 
         if (!cl->connection)
             return -1;
-    
+
 
         rr = xmalloc(sizeof(*rr));
         rr->position = position;
@@ -306,13 +306,13 @@ int client_show_raw_begin(struct client *cl, int position,
 
         assert(nativesyntax);
         rr->nativesyntax = xstrdup(nativesyntax);
-            
+
         rr->next = 0;
-        
+
         for (rrp = &cl->show_raw; *rrp; rrp = &(*rrp)->next)
             ;
         *rrp = rr;
-        
+
         if (cl->state == Client_Failed)
         {
             client_show_raw_error(cl, "client failed");
@@ -533,7 +533,7 @@ void client_search_response(struct client *cl)
     ZOOM_resultset resultset = cl->resultset;
 
     const char *error, *addinfo = 0;
-    
+
     if (ZOOM_connection_error(link, &error, &addinfo))
     {
         cl->hits = 0;
@@ -593,7 +593,7 @@ static void client_record_ingest(struct client *cl)
             NMEM nmem = nmem_create();
             const char *xmlrec;
             char type[80];
-            
+
             const char *s = session_setting_oneval(sdb, PZ_NATIVESYNTAX);
             if (nativesyntax_to_type(s, type, rec))
                 yaz_log(YLOG_WARN, "Failed to determine record type");
@@ -673,7 +673,7 @@ static void client_set_facets_request(struct client *cl, ZOOM_connection link)
     struct session_database *sdb = client_get_database(cl);
 
     WRBUF w = wrbuf_alloc();
-    
+
     struct setting *s;
 
     for (s = sdb->settings[PZ_FACETMAP]; s; s = s->next)
@@ -717,7 +717,7 @@ static const char *get_strategy_plus_sort(struct client *l, const char *field)
     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, ':');
@@ -817,16 +817,15 @@ void client_start_search(struct client *cl)
     q = ZOOM_query_create();
     if (cl->cqlquery)
     {
-        yaz_log(YLOG_LOG, "Search %s 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(q, cl->cqlquery);
         if (*opt_sort)
             ZOOM_query_sortby(q, opt_sort);
     }
     else
     {
-        yaz_log(YLOG_LOG, "Search %s 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(q, cl->pquery);
     }
     if (se->sorted_results)
@@ -834,6 +833,7 @@ void client_start_search(struct client *cl)
         const char *sort_strategy_and_spec =
             get_strategy_plus_sort(cl, se->sorted_results->field);
         int increasing = se->sorted_results->increasing;
+        // int position = se->sorted_results->position;
         if (sort_strategy_and_spec && strlen(sort_strategy_and_spec) < 40)
         {
             char spec[50], *p;
@@ -848,7 +848,7 @@ void client_start_search(struct client *cl)
                     strcat(p, " <");
                 else
                     strcat(p, " >");
-                yaz_log(YLOG_LOG, "applying %s %s", spec, p);
+                yaz_log(YLOG_LOG, "Client %s: applying sorting %s %s", client_get_id(cl), spec, p);
                 ZOOM_query_sortby2(q, spec, p);
             }
         }
@@ -858,11 +858,13 @@ void client_start_search(struct client *cl)
                skip it entirely */
             if (se->sorted_results->next)
             {
+                yaz_log(YLOG_DEBUG,"Client %s: Do not (re)search anyway", client_get_id(cl));
                 ZOOM_query_destroy(q);
                 return;
             }
         }
     }
+    yaz_log(YLOG_DEBUG,"Client %s: Starting search", client_get_id(cl));
     client_set_state(cl, Client_Working);
     cl->hits = 0;
     cl->record_offset = 0;
@@ -900,7 +902,7 @@ struct client *client_create(const char *id)
     assert(id);
     cl->id = xstrdup(id);
     client_use(1);
-    
+
     return cl;
 }
 
@@ -978,7 +980,7 @@ void client_disconnect(struct client *cl)
 
 
 // Initialize CCL map for a target
-static CCL_bibset prepare_cclmap(struct client *cl)
+static CCL_bibset prepare_cclmap(struct client *cl, CCL_bibset base_bibset)
 {
     struct session_database *sdb = client_get_database(cl);
     struct setting *s;
@@ -986,7 +988,10 @@ static CCL_bibset prepare_cclmap(struct client *cl)
 
     if (!sdb->settings)
         return 0;
-    res = ccl_qual_mk();
+    if (base_bibset)
+        res = ccl_qual_dup(base_bibset);
+    else
+        res = ccl_qual_mk();
     for (s = sdb->settings[PZ_CCLMAP]; s; s = s->next)
     {
         char *p = strchr(s->name + 3, ':');
@@ -1017,7 +1022,7 @@ static char *make_cqlquery(struct client *cl, Z_RPNQuery *zquery)
     else
     {
         r = xstrdup(wrbuf_cstr(wrb));
-    }     
+    }
     wrbuf_destroy(wrb);
     cql_transform_close(cqlt);
     return r;
@@ -1031,7 +1036,7 @@ static char *make_solrquery(struct client *cl, Z_RPNQuery *zquery)
     char *r = 0;
     WRBUF wrb = wrbuf_alloc();
     int status;
-    
+
     if ((status = solr_transform_rpn2solr_wrbuf(sqlt, wrb, zquery)))
     {
         yaz_log(YLOG_WARN, "Failed to generate SOLR query, code=%d", status);
@@ -1055,7 +1060,7 @@ const char *client_get_facet_limit_local(struct client *cl,
     for (; (name = facet_limits_get(cl->facet_limits, *l, &value)); (*l)++)
     {
         struct setting *s = 0;
-        
+
         for (s = sdb->settings[PZ_LIMITMAP]; s; s = s->next)
         {
             const char *p = strchr(s->name + 3, ':');
@@ -1065,7 +1070,7 @@ const char *client_get_facet_limit_local(struct client *cl,
                 const char *cp = s->value + 6;
                 while (*cp == ' ')
                     cp++;
-                    
+
                 nmem_strsplit_escape2(nmem, "|", value, values,
                                       num, 1, '\\', 1);
                 (*l)++;
@@ -1078,12 +1083,13 @@ const char *client_get_facet_limit_local(struct client *cl,
 
 static int apply_limit(struct session_database *sdb,
                        facet_limits_t facet_limits,
-                       WRBUF w_pqf, WRBUF w_ccl)
+                       WRBUF w_pqf, CCL_bibset ccl_map)
 {
     int ret = 0;
     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++)
     {
@@ -1117,20 +1123,34 @@ static int apply_limit(struct session_database *sdb,
                 else if (!strncmp(s->value, "ccl:", 4))
                 {
                     const char *ccl = s->value + 4;
-
-                    wrbuf_puts(w_ccl, " and (");
-
+                    WRBUF ccl_w = wrbuf_alloc();
                     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, "\"");
+                        int cerror, cpos;
+                        struct ccl_rpn_node *cn;
+
+                        wrbuf_rewind(ccl_w);
+                        wrbuf_puts(ccl_w, ccl);
+                        wrbuf_puts(ccl_w, "=\"");
+                        wrbuf_puts(ccl_w, values[i]);
+                        wrbuf_puts(ccl_w, "\"");
+
+                        cn = ccl_find_str(ccl_map, wrbuf_cstr(ccl_w),
+                                          &cerror, &cpos);
+                        if (cn)
+                        {
+                            if (i == 0)
+                                wrbuf_printf(w_pqf, "@and ");
+
+                            /* or multiple values.. could be bad if last CCL
+                               parse fails, but this is unlikely to happen */
+                            if (i < num - 1)
+                                wrbuf_printf(w_pqf, "@or ");
+                            ccl_pquery(w_pqf, cn);
+                            ccl_rpn_delete(cn);
+                        }
                     }
-                    wrbuf_puts(w_ccl, ")");
-
+                    wrbuf_destroy(ccl_w);
                 }
                 else if (!strncmp(s->value, "local:", 6)) {
                     /* no operation */
@@ -1153,7 +1173,7 @@ static int apply_limit(struct session_database *sdb,
     nmem_destroy(nmem_tmp);
     return ret;
 }
-                        
+
 // 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
@@ -1161,14 +1181,15 @@ static int apply_limit(struct session_database *sdb,
 // 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)
+                       const char *startrecs, const char *maxrecs,
+                       CCL_bibset bibset)
 {
     struct session *se = client_get_session(cl);
     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);
+    CCL_bibset ccl_map = prepare_cclmap(cl, bibset);
     const char *sru = session_setting_oneval(sdb, PZ_SRU);
     const char *pqf_prefix = session_setting_oneval(sdb, PZ_PQF_PREFIX);
     const char *pqf_strftime = session_setting_oneval(sdb, PZ_PQF_STRFTIME);
@@ -1202,21 +1223,24 @@ int client_parse_query(struct client *cl, const char *query,
         wrbuf_puts(w_pqf, " ");
     }
 
-    if (apply_limit(sdb, facet_limits, w_pqf, w_ccl))
+    if (apply_limit(sdb, facet_limits, w_pqf, ccl_map))
+    {
+        ccl_qual_rm(&ccl_map);
         return -2;
+    }
 
     facet_limits_destroy(cl->facet_limits);
     cl->facet_limits = facet_limits_dup(facet_limits);
 
-    yaz_log(YLOG_LOG, "CCL query: %s", wrbuf_cstr(w_ccl));
+    yaz_log(YLOG_LOG, "Client %s: CCL query: %s", client_get_id(cl), wrbuf_cstr(w_ccl));
     cn = ccl_find_str(ccl_map, wrbuf_cstr(w_ccl), &cerror, &cpos);
     ccl_qual_rm(&ccl_map);
     if (!cn)
     {
         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_id(cl));
+        session_log(se, YLOG_WARN, "Client %s: Failed to parse CCL query '%s'",
+                    client_get_id(cl),
+                    wrbuf_cstr(w_ccl));
         wrbuf_destroy(w_ccl);
         wrbuf_destroy(w_pqf);
         return -1;
@@ -1251,24 +1275,24 @@ int client_parse_query(struct client *cl, const char *query,
         ret_value = 0;
     }
     wrbuf_destroy(w_pqf);
-    
+
     xfree(cl->cqlquery);
     cl->cqlquery = 0;
 
-    odr_out = odr_createmem(ODR_ENCODE);    
+    odr_out = odr_createmem(ODR_ENCODE);
     zquery = p_query_rpn(odr_out, cl->pquery);
     if (!zquery)
     {
 
-        session_log(se, YLOG_WARN, "Invalid PQF query for %s: %s",
+        session_log(se, YLOG_WARN, "Invalid PQF query for Client %s: %s",
                     client_get_id(cl), cl->pquery);
         ret_value = -1;
     }
     else
     {
-        session_log(se, YLOG_LOG, "PQF for %s: %s",
+        session_log(se, YLOG_LOG, "PQF for Client %s: %s",
                     client_get_id(cl), cl->pquery);
-        
+
         /* Support for PQF on SRU targets. */
         if (strcmp(query_syntax, "pqf") != 0 && *sru)
         {
@@ -1286,7 +1310,11 @@ int client_parse_query(struct client *cl, const char *query,
     if (!se->relevance)
     {
         // Initialize relevance structure with query terms
-        se->relevance = relevance_create_ccl(se->service->charsets, cn);
+        se->relevance = relevance_create_ccl(se->service->charsets, cn,
+                                             se->service->rank_cluster,
+                                             se->service->rank_follow,
+                                             se->service->rank_lead,
+                                             se->service->rank_length);
     }
     ccl_rpn_delete(cn);
     return ret_value;
@@ -1416,11 +1444,11 @@ struct suggestions* client_suggestions_create(const char* suggestions_string)
     int i;
     NMEM nmem;
     struct suggestions *suggestions;
-    if (suggestions_string == 0)
+    if (suggestions_string == 0 || suggestions_string[0] == 0 )
         return 0;
     nmem = nmem_create();
     suggestions = nmem_malloc(nmem, sizeof(*suggestions));
-    yaz_log(YLOG_DEBUG, "client target suggestions: %s", suggestions_string);
+    yaz_log(YLOG_DEBUG, "client target suggestions: %s.", suggestions_string);
 
     suggestions->nmem = nmem;
     suggestions->num = 0;