Added logging of CQL/PQF queries for ZOOM-based code
[pazpar2-moved-to-github.git] / src / client.c
index 26d1f51..ff3c0fb 100644 (file)
@@ -34,14 +34,7 @@ Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 #if HAVE_UNISTD_H
 #include <unistd.h>
 #endif
-#if HAVE_SYS_SOCKET_H
-#include <sys/socket.h>
-#endif
-#if HAVE_NETDB_H
-#include <netdb.h>
-#endif
 #include <signal.h>
-#include <ctype.h>
 #include <assert.h>
 
 #include <yaz/marcdisp.h>
@@ -58,16 +51,13 @@ Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 #include <yaz/oid_db.h>
 #include <yaz/diagbib1.h>
 #include <yaz/snprintf.h>
+#include <yaz/rpn2cql.h>
 
 #define USE_TIMING 0
 #if USE_TIMING
 #include <yaz/timing.h>
 #endif
 
-#if HAVE_NETINET_IN_H
-#include <netinet/in.h>
-#endif
-
 #include "pazpar2.h"
 
 #include "client.h"
@@ -80,10 +70,9 @@ struct client {
     struct connection *connection;
     struct session *session;
     char *pquery; // Current search
+    char *cqlquery; // used for SRU targets only
     int hits;
-    int records;
-    int setno;
-    int requestid;            // ID of current outstanding request
+    int record_offset;
     int diagnostic;
     enum client_state state;
     struct show_raw *show_raw;
@@ -104,16 +93,11 @@ struct show_raw {
 
 static const char *client_states[] = {
     "Client_Connecting",
-    "Client_Connected",
     "Client_Idle",
-    "Client_Initializing",
-    "Client_Searching",
-    "Client_Presenting",
+    "Client_Working",
     "Client_Error",
     "Client_Failed",
-    "Client_Disconnected",
-    "Client_Stopped",
-    "Client_Continue"
+    "Client_Disconnected"
 };
 
 static struct client *client_freelist = 0;
@@ -144,7 +128,6 @@ static void client_show_raw_error(struct client *cl, const char *addinfo);
 // Close connection and set state to error
 void client_fatal(struct client *cl)
 {
-    //client_show_raw_error(cl, "client connection failure");
     yaz_log(YLOG_WARN, "Fatal error from %s", client_get_url(cl));
     connection_destroy(cl->connection);
     client_set_state(cl, Client_Error);
@@ -170,12 +153,6 @@ const char *client_get_pquery(struct client *cl)
     return cl->pquery;
 }
 
-void client_set_requestid(struct client *cl, int id)
-{
-    cl->requestid = id;
-}
-
-
 static void client_send_raw_present(struct client *cl);
 
 int client_show_raw_begin(struct client *cl, int position,
@@ -259,15 +236,6 @@ static void client_show_raw_error(struct client *cl, const char *addinfo)
     }
 }
 
-static void client_show_raw_cancel(struct client *cl)
-{
-    while (cl->show_raw)
-    {
-        cl->show_raw->error_handler(cl->show_raw->data, "cancel");
-        client_show_raw_dequeue(cl);
-    }
-}
-
 static void client_send_raw_present(struct client *cl)
 {
     struct session_database *sdb = client_get_database(cl);
@@ -320,7 +288,6 @@ static int nativesyntax_to_type(struct session_database *sdb, char *type)
         }
         else
             return -1;
-        yaz_log(YLOG_LOG, "Returned type %s", type);
         return 0;
     }
     return -1;
@@ -345,70 +312,6 @@ static void ingest_raw_record(struct client *cl, ZOOM_record rec)
     client_show_raw_dequeue(cl);
 }
 
-#ifdef RETIRED
-
-static void ingest_raw_records(struct client *cl, Z_Records *r)
-{
-    Z_NamePlusRecordList *rlist;
-    Z_NamePlusRecord *npr;
-    xmlDoc *doc;
-    xmlChar *buf_out;
-    int len_out;
-    if (r->which != Z_Records_DBOSD)
-    {
-        client_show_raw_error(cl, "non-surrogate diagnostics");
-        return;
-    }
-
-    rlist = r->u.databaseOrSurDiagnostics;
-    if (rlist->num_records != 1 || !rlist->records || !rlist->records[0])
-    {
-        client_show_raw_error(cl, "no records");
-        return;
-    }
-    npr = rlist->records[0];
-    if (npr->which != Z_NamePlusRecord_databaseRecord)
-    {
-        client_show_raw_error(cl, "surrogate diagnostic");
-        return;
-    }
-
-    if (cl->show_raw && cl->show_raw->binary)
-    {
-        Z_External *rec = npr->u.databaseRecord;
-        if (rec->which == Z_External_octet)
-        {
-            cl->show_raw->record_handler(cl->show_raw->data,
-                                         (const char *)
-                                         rec->u.octet_aligned->buf,
-                                         rec->u.octet_aligned->len);
-            client_show_raw_dequeue(cl);
-        }
-        else
-            client_show_raw_error(cl, "no records");
-    }
-
-    doc = record_to_xml(client_get_database(cl), npr->u.databaseRecord);
-    if (!doc)
-    {
-        client_show_raw_error(cl, "unable to convert record to xml");
-        return;
-    }
-
-    xmlDocDumpMemory(doc, &buf_out, &len_out);
-    xmlFreeDoc(doc);
-
-    if (cl->show_raw)
-    {
-        cl->show_raw->record_handler(cl->show_raw->data,
-                                     (const char *) buf_out, len_out);
-        client_show_raw_dequeue(cl);
-    }
-    xmlFree(buf_out);
-}
-
-#endif // RETIRED show raw
-
 void client_search_response(struct client *cl)
 {
     struct connection *co = cl->connection;
@@ -420,12 +323,13 @@ void client_search_response(struct client *cl)
     if (ZOOM_connection_error(link, &error, &addinfo))
     {
         cl->hits = 0;
-        cl->state = Client_Error;
+        client_set_state(cl, Client_Error);
         yaz_log(YLOG_WARN, "Search error %s (%s): %s",
             error, addinfo, client_get_url(cl));
     }
     else
     {
+        cl->record_offset = 0;
         cl->hits = ZOOM_resultset_size(resultset);
         se->total_hits += cl->hits;
     }
@@ -439,10 +343,9 @@ void client_record_response(struct client *cl)
     ZOOM_resultset resultset = connection_get_resultset(co);
     const char *error, *addinfo;
 
-    yaz_log(YLOG_LOG, "client_record_response");
     if (ZOOM_connection_error(link, &error, &addinfo))
     {
-        cl->state = Client_Error;
+        client_set_state(cl, Client_Error);
         yaz_log(YLOG_WARN, "Search error %s (%s): %s",
             error, addinfo, client_get_url(cl));
     }
@@ -451,8 +354,6 @@ void client_record_response(struct client *cl)
         ZOOM_record rec = 0;
         const char *msg, *addinfo;
         
-        yaz_log(YLOG_LOG, "show_raw=%p show_raw->active=%d",
-                cl->show_raw, cl->show_raw ? cl->show_raw->active : 0);
         if (cl->show_raw && cl->show_raw->active)
         {
             if ((rec = ZOOM_resultset_record(resultset,
@@ -461,18 +362,22 @@ void client_record_response(struct client *cl)
                 cl->show_raw->active = 0;
                 ingest_raw_record(cl, rec);
             }
+            else
+            {
+                yaz_log(YLOG_WARN, "Expected record, but got NULL, offset=%d",
+                        cl->show_raw->position-1);
+            }
         }
         else
         {
-            int offset = cl->records;
+            int offset = cl->record_offset;
             if ((rec = ZOOM_resultset_record(resultset, offset)))
             {
-                yaz_log(YLOG_LOG, "Record with offset %d", offset);
-                
-                cl->records++;
+                cl->record_offset++;
                 if (ZOOM_record_error(rec, &msg, &addinfo, 0))
                     yaz_log(YLOG_WARN, "Record error %s (%s): %s (rec #%d)",
-                            error, addinfo, client_get_url(cl), cl->records);
+                            error, addinfo, client_get_url(cl),
+                            cl->record_offset);
                 else
                 {
                     struct session_database *sdb = client_get_database(cl);
@@ -481,7 +386,7 @@ void client_record_response(struct client *cl)
                     nativesyntax_to_type(sdb, type);
                     if ((xmlrec = ZOOM_record_get(rec, type, NULL)))
                     {
-                        if (ingest_record(cl, xmlrec, cl->records))
+                        if (ingest_record(cl, xmlrec, cl->record_offset))
                         {
                             session_alert_watch(cl->session, SESSION_WATCH_SHOW);
                             session_alert_watch(cl->session, SESSION_WATCH_RECORD);
@@ -494,102 +399,15 @@ void client_record_response(struct client *cl)
                 }
 
             }
+            else
+            {
+                yaz_log(YLOG_WARN, "Expected record, but got NULL, offset=%d",
+                        offset);
+            }
         }
-        if (!rec)
-            yaz_log(YLOG_WARN, "Expected record, but got NULL");
-    }
-}
-
-#ifdef RETIRED
-
-void client_present_response(struct client *cl, Z_APDU *a)
-{
-    Z_PresentResponse *r = a->u.presentResponse;
-    Z_Records *recs = r->records;
-        
-    if (recs && recs->which == Z_Records_NSD)
-    {
-        WRBUF w = wrbuf_alloc();
-        
-        Z_DiagRec dr, *dr_p = &dr;
-        dr.which = Z_DiagRec_defaultFormat;
-        dr.u.defaultFormat = recs->u.nonSurrogateDiagnostic;
-        
-        wrbuf_printf(w, "Present response NSD %s: ",
-                     cl->database->database->url);
-        
-        cl->diagnostic = diag_to_wrbuf(&dr_p, 1, w);
-        
-        yaz_log(YLOG_WARN, "%s", wrbuf_cstr(w));
-        
-        cl->state = Client_Error;
-        wrbuf_destroy(w);
-
-        client_show_raw_error(cl, "non surrogate diagnostics");
-    }
-    else if (recs && recs->which == Z_Records_multipleNSD)
-    {
-        WRBUF w = wrbuf_alloc();
-        
-        wrbuf_printf(w, "Present response multipleNSD %s: ",
-                     cl->database->database->url);
-        cl->diagnostic = 
-            diag_to_wrbuf(recs->u.multipleNonSurDiagnostics->diagRecs,
-                          recs->u.multipleNonSurDiagnostics->num_diagRecs,
-                          w);
-        yaz_log(YLOG_WARN, "%s", wrbuf_cstr(w));
-        cl->state = Client_Error;
-        wrbuf_destroy(w);
-    }
-    else if (recs && !*r->presentStatus && cl->state != Client_Error)
-    {
-        yaz_log(YLOG_DEBUG, "Good Present response %s",
-                cl->database->database->url);
-
-        // we can mix show raw and normal show ..
-        if (cl->show_raw && cl->show_raw->active)
-        {
-            cl->show_raw->active = 0; // no longer active
-            ingest_raw_records(cl, recs);
-        }
-        else
-            ingest_records(cl, recs);
-        cl->state = Client_Continue;
-    }
-    else if (*r->presentStatus) 
-    {
-        yaz_log(YLOG_WARN, "Bad Present response %s",
-                cl->database->database->url);
-        cl->state = Client_Error;
-        client_show_raw_error(cl, "bad present response");
     }
 }
 
-void client_close_response(struct client *cl, Z_APDU *a)
-{
-    struct connection *co = cl->connection;
-    /* Z_Close *r = a->u.close; */
-
-    yaz_log(YLOG_WARN, "Close response %s", cl->database->database->url);
-
-    cl->state = Client_Failed;
-    connection_destroy(co);
-}
-
-#endif // RETIRED show raw
-
-#ifdef RETIRED
-int client_is_our_response(struct client *cl)
-{
-    struct session *se = client_get_session(cl);
-
-    if (cl && (cl->requestid == se->requestid || 
-               cl->state == Client_Initializing))
-        return 1;
-    return 0;
-}
-#endif
-
 void client_start_search(struct client *cl)
 {
     struct session_database *sdb = client_get_database(cl);
@@ -602,12 +420,14 @@ void client_start_search(struct client *cl)
     const char *opt_elements = session_setting_oneval(sdb, PZ_ELEMENTS);
     const char *opt_requestsyn = session_setting_oneval(sdb, PZ_REQUESTSYNTAX);
     const char *opt_maxrecs = session_setting_oneval(sdb, PZ_MAXRECS);
+    const char *opt_sru = session_setting_oneval(sdb, PZ_SRU);
 
     assert(link);
 
     cl->hits = -1;
-    cl->records = 0;
+    cl->record_offset = 0;
     cl->diagnostic = 0;
+    client_set_state(cl, Client_Working);
 
     if (*opt_piggyback)
         ZOOM_connection_option_set(link, "piggyback", opt_piggyback);
@@ -615,7 +435,9 @@ void client_start_search(struct client *cl)
         ZOOM_connection_option_set(link, "piggyback", "1");
     if (*opt_queryenc)
         ZOOM_connection_option_set(link, "rpnCharset", opt_queryenc);
-    if (*opt_elements)
+    if (*opt_sru && *opt_elements)
+        ZOOM_connection_option_set(link, "schema", opt_elements);
+    else if (*opt_elements)
         ZOOM_connection_option_set(link, "elementSetName", opt_elements);
     if (*opt_requestsyn)
         ZOOM_connection_option_set(link, "preferredRecordSyntax", opt_requestsyn);
@@ -627,13 +449,24 @@ void client_start_search(struct client *cl)
         sprintf(n, "%d", global_parameters.toget);
         ZOOM_connection_option_set(link, "count", n);
     }
-    if (!databaseName || !*databaseName)
-        databaseName = "Default";
-    ZOOM_connection_option_set(link, "databaseName", databaseName);
+    if (databaseName)
+        ZOOM_connection_option_set(link, "databaseName", databaseName);
 
     ZOOM_connection_option_set(link, "presentChunk", "20");
 
-    rs = ZOOM_connection_search_pqf(link, cl->pquery);
+    if (cl->cqlquery)
+    {
+        yaz_log(YLOG_LOG, "Search %s CQL: %s", sdb->database->url, cl->cqlquery);
+        ZOOM_query q = ZOOM_query_create();
+        ZOOM_query_cql(q, cl->cqlquery);
+        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);
+    }
     connection_set_resultset(co, rs);
     connection_continue(co);
 }
@@ -649,13 +482,12 @@ struct client *client_create(void)
     else
         r = xmalloc(sizeof(struct client));
     r->pquery = 0;
+    r->cqlquery = 0;
     r->database = 0;
     r->connection = 0;
     r->session = 0;
     r->hits = 0;
-    r->records = 0;
-    r->setno = 0;
-    r->requestid = -1;
+    r->record_offset = 0;
     r->diagnostic = 0;
     r->state = Client_Disconnected;
     r->show_raw = 0;
@@ -677,6 +509,7 @@ void client_destroy(struct client *c)
             cc->next = c->next;
     }
     xfree(c->pquery);
+    xfree(c->cqlquery);
 
     if (c->connection)
         connection_release(c->connection);
@@ -730,13 +563,39 @@ static CCL_bibset prepare_cclmap(struct client *cl)
     return res;
 }
 
+// returns a xmalloced CQL query corresponding to the pquery in client
+static char *make_cqlquery(struct client *cl)
+{
+    cql_transform_t cqlt = cql_transform_create();
+    Z_RPNQuery *zquery;
+    char *r;
+    WRBUF wrb = wrbuf_alloc();
+    int status;
+
+    zquery = p_query_rpn(global_parameters.odr_out, cl->pquery);
+    if ((status = cql_transform_rpn2cql_wrbuf(cqlt, wrb, zquery)))
+    {
+        yaz_log(YLOG_WARN, "failed to generate CQL query, code=%d", status);
+        return 0;
+    }
+    r = xstrdup(wrbuf_cstr(wrb));
+
+    wrbuf_destroy(wrb);
+    odr_reset(global_parameters.odr_out); // releases the zquery
+    cql_transform_close(cqlt);
+    return r;
+}
+
 // Parse the query given the settings specific to this client
 int client_parse_query(struct client *cl, const char *query)
 {
     struct session *se = client_get_session(cl);
+    struct session_database *sdb = client_get_database(cl);
     struct ccl_rpn_node *cn;
     int cerror, cpos;
     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);
 
     if (!ccl_map)
         return -1;
@@ -745,16 +604,30 @@ int client_parse_query(struct client *cl, const char *query)
     ccl_qual_rm(&ccl_map);
     if (!cn)
     {
-        cl->state = Client_Error;
+        client_set_state(cl, Client_Error);
         yaz_log(YLOG_WARN, "Failed to parse query for %s",
                          client_get_database(cl)->database->url);
         return -1;
     }
     wrbuf_rewind(se->wrbuf);
+    if (*pqf_prefix)
+    {
+        wrbuf_puts(se->wrbuf, pqf_prefix);
+        wrbuf_puts(se->wrbuf, " ");
+    }
     ccl_pquery(se->wrbuf, cn);
     xfree(cl->pquery);
     cl->pquery = xstrdup(wrbuf_cstr(se->wrbuf));
 
+    xfree(cl->cqlquery);
+    if (*sru)
+    {
+        if (!(cl->cqlquery = make_cqlquery(cl)))
+            return -1;
+    }
+    else
+        cl->cqlquery = 0;
+
     if (!se->relevance)
     {
         // Initialize relevance structure with query terms
@@ -779,8 +652,7 @@ void client_set_session(struct client *cl, struct session *se)
 
 int client_is_active(struct client *cl)
 {
-    if (cl->connection && (cl->state == Client_Continue ||
-                           cl->state == Client_Connecting ||
+    if (cl->connection && (cl->state == Client_Connecting ||
                            cl->state == Client_Working))
         return 1;
     return 0;
@@ -801,7 +673,7 @@ int client_get_hits(struct client *cl)
 
 int client_get_num_records(struct client *cl)
 {
-    return cl->records;
+    return cl->record_offset;
 }
 
 int client_get_diagnostic(struct client *cl)