New ZOOM events ZOOM_EVENT_RECV_{RECORD,SEARCH} for receiving a record
[yaz-moved-to-github.git] / zutil / zoom-c.c
index 72e7354..7ce62e7 100644 (file)
@@ -2,7 +2,7 @@
  * Copyright (c) 2000-2003, Index Data
  * See the file LICENSE for details.
  *
- * $Id: zoom-c.c,v 1.25 2003-02-19 15:22:11 adam Exp $
+ * $Id: zoom-c.c,v 1.32 2003-04-28 11:04:52 adam Exp $
  *
  * ZOOM layer for C, connections, result sets, queries.
  */
@@ -172,6 +172,7 @@ void ZOOM_connection_remove_task (ZOOM_connection c)
        switch (task->which)
        {
        case ZOOM_TASK_SEARCH:
+
            ZOOM_resultset_destroy (task->u.search.resultset);
            break;
        case ZOOM_TASK_RETRIEVE:
@@ -388,6 +389,7 @@ ZOOM_query_create(void)
     s->z_query = 0;
     s->sort_spec = 0;
     s->odr = odr_createmem (ODR_ENCODE);
+    s->query_string = 0;
 
     return s;
 }
@@ -410,6 +412,7 @@ ZOOM_query_destroy(ZOOM_query s)
 ZOOM_API(int)
 ZOOM_query_prefix(ZOOM_query s, const char *str)
 {
+    s->query_string = odr_strdup(s->odr, str);
     s->z_query = (Z_Query *) odr_malloc (s->odr, sizeof(*s->z_query));
     s->z_query->which = Z_Query_type_1;
     s->z_query->u.type_1 =  p_query_rpn(s->odr, PROTO_Z3950, str);
@@ -423,16 +426,19 @@ ZOOM_query_cql(ZOOM_query s, const char *str)
 {
     Z_External *ext;
 
+    s->query_string = odr_strdup(s->odr, str);
+
     ext = (Z_External *) odr_malloc(s->odr, sizeof(*ext));
     ext->direct_reference = odr_getoidbystr(s->odr, "1.2.840.10003.16.2");
     ext->indirect_reference = 0;
     ext->descriptor = 0;
     ext->which = Z_External_CQL;
-    ext->u.cql = odr_strdup(s->odr, str);
+    ext->u.cql = s->query_string;
     
     s->z_query = (Z_Query *) odr_malloc (s->odr, sizeof(*s->z_query));
     s->z_query->which = Z_Query_type_104;
     s->z_query->u.type_104 =  ext;
+
     return 0;
 }
 
@@ -499,8 +505,7 @@ ZOOM_resultset ZOOM_resultset_create ()
     r->count = 0;
     r->record_cache = 0;
     r->r_sort_spec = 0;
-    r->z_query = 0;
-    r->search = 0;
+    r->query = 0;
     r->connection = 0;
     r->next = 0;
     return r;
@@ -527,8 +532,7 @@ ZOOM_connection_search(ZOOM_connection c, ZOOM_query q)
     const char *cp;
 
     r->r_sort_spec = q->sort_spec;
-    r->z_query = q->z_query;
-    r->search = q;
+    r->query = q;
 
     r->options = ZOOM_options_create_with_parent(c->options);
 
@@ -547,7 +551,7 @@ ZOOM_connection_search(ZOOM_connection c, ZOOM_query q)
     r->next = c->resultsets;
     c->resultsets = r;
 
-    if (c->host_port && c->proto == PROTO_SRW)
+    if (c->host_port && c->proto == PROTO_HTTP)
     {
         if (!c->cs)
         {
@@ -605,7 +609,7 @@ ZOOM_resultset_destroy(ZOOM_resultset r)
                rp = &(*rp)->next;
            }
        }
-       ZOOM_query_destroy (r->search);
+       ZOOM_query_destroy (r->query);
        ZOOM_options_destroy (r->options);
        odr_destroy (r->odr);
         xfree (r->setname);
@@ -642,7 +646,7 @@ static void ZOOM_resultset_retrieve (ZOOM_resultset r,
     if (!c)
        return;
 
-    if (c->host_port && c->proto == PROTO_SRW)
+    if (c->host_port && c->proto == PROTO_HTTP)
     {
         if (!c->cs)
         {
@@ -709,29 +713,25 @@ static zoom_ret do_connect (ZOOM_connection c)
     yaz_log (LOG_DEBUG, "do_connect host=%s", effective_host);
 
     assert (!c->cs);
+    c->cs = cs_create_host (effective_host, 0, &add);
 
-    if (memcmp(c->host_port, "http:", 5) == 0)
+    if (c->cs && c->cs->protocol == PROTO_HTTP)
     {
 #if HAVE_XML2
-        const char *path;
-        c->proto = PROTO_SRW;
-        effective_host = c->host_port + 5;
-        if (*effective_host == '/')
-            effective_host++;
-        if (*effective_host == '/')
-            effective_host++;
-        if (!(path = strchr(effective_host, '/')))
-            path = "/";
+        const char *path = 0;
+
+        c->proto = PROTO_HTTP;
+        cs_get_host_args(c->host_port, &path);
         xfree(c->path);
-        c->path = xstrdup(path);
+        c->path = xmalloc(strlen(path)+2);
+        c->path[0] = '/';
+        strcpy (c->path+1, path);
 #else
-        c->state = STATE_IDLE;
         set_ZOOM_error(c, ZOOM_ERROR_UNSUPPORTED_PROTOCOL, "SRW");
+        do_close(c);
         return zoom_complete;
 #endif
     }
-    c->cs = cs_create_host (effective_host, 0, &add);
-    
     if (c->cs)
     {
         int ret = cs_connect (c->cs, add);
@@ -976,8 +976,9 @@ static zoom_ret ZOOM_connection_send_init (ZOOM_connection c)
 }
 
 #if HAVE_XML2
-static zoom_ret send_srw (ZOOM_connection c, Z_SRW_searchRetrieve *sr)
+static zoom_ret send_srw (ZOOM_connection c, Z_SRW_PDU *sr)
 {
+    char ctype[50];
     Z_SOAP_Handler h[2] = {
         {"http://www.loc.gov/zing/srw/v1.0/", 0, (Z_SOAP_fun) yaz_srw_codec},
         {0, 0, 0}
@@ -990,8 +991,38 @@ static zoom_ret send_srw (ZOOM_connection c, Z_SRW_searchRetrieve *sr)
 
     gdu = z_get_HTTP_Request(c->odr_out);
     gdu->u.HTTP_Request->path = c->path;
+
+    if (c->host_port)
+    {
+        const char *cp0 = strstr(c->host_port, "://");
+        const char *cp1 = 0;
+        if (cp0)
+            cp0 = cp0+3;
+        else
+            cp0 = c->host_port;
+
+        cp1 = strchr(cp0, '/');
+        if (!cp1)
+            cp1 = cp0+strlen(cp0);
+
+        if (cp0 && cp1)
+        {
+            char *h = odr_malloc(c->odr_out, cp1 - cp0 + 1);
+            memcpy (h, cp0, cp1 - cp0);
+            h[cp1-cp0] = '\0';
+            z_HTTP_header_add(c->odr_out, &gdu->u.HTTP_Request->headers,
+                              "host", h);
+        }
+    }
+
+    strcpy(ctype, "text/xml");
+    if (c->charset && strlen(c->charset) < 20)
+    {
+        strcat(ctype, "; charset=");
+        strcat(ctype, c->charset);
+    }
     z_HTTP_header_add(c->odr_out, &gdu->u.HTTP_Request->headers,
-                      "Content-Type", "text/xml");
+                      "Content-Type", ctype);
     z_HTTP_header_add(c->odr_out, &gdu->u.HTTP_Request->headers,
                       "SOAPAction", "\"\"");
     p->which = Z_SOAP_generic;
@@ -1001,9 +1032,10 @@ static zoom_ret send_srw (ZOOM_connection c, Z_SRW_searchRetrieve *sr)
     p->u.generic->p = sr;
     p->ns = "http://schemas.xmlsoap.org/soap/envelope/";
 
-    ret = z_soap_codec(o, &p,
-                       &gdu->u.HTTP_Request->content_buf,
-                       &gdu->u.HTTP_Request->content_len, h);
+    ret = z_soap_codec_enc(o, &p,
+                           &gdu->u.HTTP_Request->content_buf,
+                           &gdu->u.HTTP_Request->content_len, h,
+                           c->charset);
 
     if (!z_GDU(c->odr_out, &gdu, 0, 0))
         return zoom_complete;
@@ -1023,7 +1055,8 @@ static zoom_ret ZOOM_connection_srw_send_search(ZOOM_connection c)
 {
     int i;
     ZOOM_resultset resultset = 0;
-    Z_SRW_searchRetrieve *sr = 0;
+    Z_SRW_PDU *sr = 0;
+    const char *recordPacking = 0;
 
     if (c->error)                  /* don't continue on error */
        return zoom_complete;
@@ -1056,18 +1089,22 @@ static zoom_ret ZOOM_connection_srw_send_search(ZOOM_connection c)
         if (i == resultset->count)
             return zoom_complete;
     }
-    assert(resultset->z_query);
+    assert(resultset->query);
         
     sr = yaz_srw_get(c->odr_out, Z_SRW_searchRetrieve_request);
 
-    if (resultset->z_query->which == Z_Query_type_104
-        && resultset->z_query->u.type_104->which == Z_External_CQL)
-        sr->u.request->query = resultset->z_query->u.type_104->u.cql;
-    else if (resultset->z_query->which == Z_Query_type_1 &&
-             resultset->z_query->u.type_1)
+    if (resultset->query->z_query->which == Z_Query_type_104
+        && resultset->query->z_query->u.type_104->which == Z_External_CQL)
     {
-        set_ZOOM_error(c, ZOOM_ERROR_UNSUPPORTED_QUERY, 0);
-        return zoom_complete;
+
+        sr->u.request->query_type = Z_SRW_query_type_cql;
+        sr->u.request->query.cql =resultset->query->z_query->u.type_104->u.cql;
+    }
+    else if (resultset->query->z_query->which == Z_Query_type_1 &&
+             resultset->query->z_query->u.type_1)
+    {
+        sr->u.request->query_type = Z_SRW_query_type_pqf;
+        sr->u.request->query.pqf = resultset->query->query_string;
     }
     else
     {
@@ -1078,7 +1115,11 @@ static zoom_ret ZOOM_connection_srw_send_search(ZOOM_connection c)
     sr->u.request->maximumRecords = odr_intdup (c->odr_out, resultset->count);
     sr->u.request->recordSchema = resultset->schema;
 
+    recordPacking = ZOOM_resultset_option_get (resultset, "recordPacking");
+
+    if (recordPacking)
+        sr->u.request->recordPacking = odr_strdup(c->odr_out, recordPacking);
+    
     return send_srw(c, sr);
 }
 #else
@@ -1118,10 +1159,10 @@ static zoom_ret ZOOM_connection_send_search (ZOOM_connection c)
        mediumSetElementSetName = elementSetName;
 
     assert (r);
-    assert (r->z_query);
+    assert (r->query);
 
     /* prepare query for the search request */
-    search_req->query = r->z_query;
+    search_req->query = r->query->z_query;
 
     search_req->databaseNames =
        set_DatabaseNames (c, r->options, &search_req->num_databaseNames);
@@ -1267,8 +1308,14 @@ ZOOM_resultset_record_immediate (ZOOM_resultset s,size_t pos)
 ZOOM_API(ZOOM_record)
 ZOOM_resultset_record (ZOOM_resultset r, size_t pos)
 {
-    ZOOM_resultset_retrieve (r, 1, pos, 1);
-    return ZOOM_resultset_record_immediate (r, pos);
+    ZOOM_record rec = ZOOM_resultset_record_immediate(r, pos);
+
+    if (!rec)
+    {
+        ZOOM_resultset_retrieve (r, 1, pos, 1);
+        rec = ZOOM_resultset_record_immediate (r, pos);
+    }
+    return rec;
 }
 
 ZOOM_API(void)
@@ -1428,6 +1475,11 @@ ZOOM_record_get (ZOOM_record rec, const char *type, int *len)
             if (len) *len = 5;
             return "GRS-1";
         }
+       else if (r->which == Z_External_OPAC)
+        {
+            if (len) *len = 4;
+            return "OPAC";
+        }
        return 0;
     }
     else if (!strcmp (type, "raw"))
@@ -1481,6 +1533,9 @@ static void record_cache_add (ZOOM_resultset r, Z_NamePlusRecord *npr,
     const char *syntax = 
         ZOOM_resultset_option_get (r, "preferredRecordSyntax");
     
+    ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_RECV_RECORD);
+    ZOOM_connection_put_event(r->connection, event);
+
     for (rc = r->record_cache; rc; rc = rc->next)
     {
        if (pos == rc->pos)
@@ -1620,11 +1675,15 @@ static void handle_present_response (ZOOM_connection c, Z_PresentResponse *pr)
 static void handle_search_response (ZOOM_connection c, Z_SearchResponse *sr)
 {
     ZOOM_resultset resultset;
-
+    ZOOM_Event event;
+    
     yaz_log (LOG_DEBUG, "got search response");
-
+    
     if (!c->tasks || c->tasks->which != ZOOM_TASK_SEARCH)
        return ;
+    
+    event = ZOOM_Event_create(ZOOM_EVENT_RECV_SEARCH);
+    ZOOM_connection_put_event(c, event);
 
     resultset = c->tasks->u.search.resultset;
 
@@ -2071,21 +2130,26 @@ static Z_ItemOrder *encode_item_order(ZOOM_package p)
     req->u.esRequest->notToKeep = (Z_IOOriginPartNotToKeep *)
         odr_malloc(p->odr_out,sizeof(Z_IOOriginPartNotToKeep));
        
-    req->u.esRequest->notToKeep->resultSetItem = (Z_IOResultSetItem *)
-        odr_malloc(p->odr_out, sizeof(Z_IOResultSetItem));
-
     str = ZOOM_options_get(p->options, "itemorder-setname");
     if (!str)
         str = "default";
-    req->u.esRequest->notToKeep->resultSetItem->resultSetId =
-        nmem_strdup (p->odr_out->mem, str);
-    req->u.esRequest->notToKeep->resultSetItem->item =
-        (int *) odr_malloc(p->odr_out, sizeof(int));
+
+    if (!*str) 
+        req->u.esRequest->notToKeep->resultSetItem = 0;
+    else
+    {
+        req->u.esRequest->notToKeep->resultSetItem = (Z_IOResultSetItem *)
+           odr_malloc(p->odr_out, sizeof(Z_IOResultSetItem));
+
+        req->u.esRequest->notToKeep->resultSetItem->resultSetId =
+           nmem_strdup (p->odr_out->mem, str);
+        req->u.esRequest->notToKeep->resultSetItem->item =
+            (int *) odr_malloc(p->odr_out, sizeof(int));
        
-    str = ZOOM_options_get(p->options, "itemorder-item");
-    *req->u.esRequest->notToKeep->resultSetItem->item =
-        (str ? atoi(str) : 1);
-    
+        str = ZOOM_options_get(p->options, "itemorder-item");
+        *req->u.esRequest->notToKeep->resultSetItem->item =
+            (str ? atoi(str) : 1);
+    }
     req->u.esRequest->notToKeep->itemRequest = encode_ill_request(p);
     
     return req;
@@ -2217,13 +2281,13 @@ static int ZOOM_connection_exec_task (ZOOM_connection c)
         switch (task->which)
         {
         case ZOOM_TASK_SEARCH:
-            if (c->proto == PROTO_SRW)
+            if (c->proto == PROTO_HTTP)
                 ret = ZOOM_connection_srw_send_search(c);
             else
                 ret = ZOOM_connection_send_search(c);
             break;
         case ZOOM_TASK_RETRIEVE:
-            if (c->proto == PROTO_SRW)
+            if (c->proto == PROTO_HTTP)
                 ret = ZOOM_connection_srw_send_search(c);
             else
                 ret = send_present (c);
@@ -2399,6 +2463,7 @@ static void handle_srw_response(ZOOM_connection c,
     ZOOM_resultset resultset = 0;
     int i;
     NMEM nmem;
+    ZOOM_Event event;
 
     if (!c->tasks)
         return;
@@ -2410,6 +2475,9 @@ static void handle_srw_response(ZOOM_connection c,
     else
        return ;
 
+    event = ZOOM_Event_create(ZOOM_EVENT_RECV_SEARCH);
+    ZOOM_connection_put_event(c, event);
+
     resultset->size = 0;
 
     yaz_log(LOG_DEBUG, "got SRW response OK");
@@ -2484,7 +2552,7 @@ static void handle_http(ZOOM_connection c, Z_HTTP_Response *hres)
         if (!ret && soap_package->which == Z_SOAP_generic &&
             soap_package->u.generic->no == 0)
         {
-            Z_SRW_searchRetrieve *sr = soap_package->u.generic->p;
+            Z_SRW_PDU *sr = soap_package->u.generic->p;
             if (sr->which == Z_SRW_searchRetrieve_response)
                 handle_srw_response(c, sr->u.response);
             else
@@ -2558,6 +2626,7 @@ static int do_read (ZOOM_connection c)
     {
         Z_GDU *gdu;
         ZOOM_Event event;
+
        odr_reset (c->odr_in);
        odr_setbuf (c->odr_in, c->buf_in, r, 0);
         event = ZOOM_Event_create (ZOOM_EVENT_RECV_APDU);