Rename some functions to indicate Z39.50 handling
[yaz-moved-to-github.git] / src / zoom-c.c
index a2a0235..d95b04d 100644 (file)
@@ -27,6 +27,7 @@
 #include <yaz/query-charset.h>
 #include <yaz/copy_types.h>
 #include <yaz/snprintf.h>
+#include <yaz/facet.h>
 
 #include <yaz/shptr.h>
 
@@ -793,6 +794,29 @@ ZOOM_API(int)
 
 static zoom_ret do_write(ZOOM_connection c);
 
+ZOOM_API(void) ZOOM_resultset_release(ZOOM_resultset r)
+{
+#if ZOOM_RESULT_LISTS
+#else
+    if (r->connection)
+    {
+        /* remove ourselves from the resultsets in connection */
+        ZOOM_resultset *rp = &r->connection->resultsets;
+        while (1)
+        {
+            assert(*rp);   /* we must be in this list!! */
+            if (*rp == r)
+            {   /* OK, we're here - take us out of it */
+                *rp = (*rp)->next;
+                break;
+            }
+            rp = &(*rp)->next;
+        }
+        r->connection = 0;
+    }
+#endif
+}
+
 ZOOM_API(void)
     ZOOM_connection_destroy(ZOOM_connection c)
 {
@@ -883,6 +907,9 @@ ZOOM_resultset ZOOM_resultset_create(void)
     r->connection = 0;
     r->databaseNames = 0;
     r->num_databaseNames = 0;
+    r->facets = 0;
+    r->num_facets = 0;
+    r->facets_names = 0;
     r->mutex = 0;
     yaz_mutex_create(&r->mutex);
 #if SHPTR
@@ -1102,24 +1129,7 @@ static void resultset_destroy(ZOOM_resultset r)
 
         yaz_log(log_details, "%p ZOOM_connection resultset_destroy: Deleting resultset (%p) ", r->connection, r);
         ZOOM_resultset_cache_reset(r);
-#if ZOOM_RESULT_LISTS
-#else
-        if (r->connection)
-        {
-            /* remove ourselves from the resultsets in connection */
-            ZOOM_resultset *rp = &r->connection->resultsets;
-            while (1)
-            {
-                assert(*rp);   /* we must be in this list!! */
-                if (*rp == r)
-                {   /* OK, we're here - take us out of it */
-                    *rp = (*rp)->next;
-                    break;
-                }
-                rp = &(*rp)->next;
-            }
-        }
-#endif
+        ZOOM_resultset_release(r);
         ZOOM_query_destroy(r->query);
         ZOOM_options_destroy(r->options);
         odr_destroy(r->odr);
@@ -1248,6 +1258,56 @@ ZOOM_API(void)
     }
 }
 
+ZOOM_API(size_t)
+    ZOOM_resultset_facets_size(ZOOM_resultset r) {
+    return r->num_facets;
+}
+
+ZOOM_API(ZOOM_facet_field)
+    ZOOM_resultset_get_facet_field(ZOOM_resultset r, const char *name) {
+    int num = r->num_facets;
+    ZOOM_facet_field *facets = r->facets;
+    int index;
+    for (index = 0; index < num; index++) {
+        if (!strcmp(facets[index]->facet_name, name)) {
+            return facets[index];
+        }
+    }
+    return 0;
+}
+
+
+ZOOM_API(ZOOM_facet_field *)
+    ZOOM_resultset_facets(ZOOM_resultset r)
+{
+    return r->facets;
+}
+
+ZOOM_API(const char**)
+    ZOOM_resultset_facet_names(ZOOM_resultset r)
+{
+    return (const char **) r->facets_names;
+}
+
+ZOOM_API(const char*)
+    ZOOM_facet_field_name(ZOOM_facet_field field)
+{
+    return field->facet_name;
+}
+
+ZOOM_API(size_t)
+    ZOOM_facet_field_term_count(ZOOM_facet_field field)
+{
+    return field->num_terms;
+}
+
+ZOOM_API(const char*)
+    ZOOM_facet_field_get_term(ZOOM_facet_field field, size_t idx, int *freq) {
+    *freq = field->facet_terms[idx].frequency;
+    return field->facet_terms[idx].term;
+}
+
+
 static void get_cert(ZOOM_connection c)
 {
     char *cert_buf;
@@ -1661,7 +1721,7 @@ static zoom_ret ZOOM_connection_srw_send_search(ZOOM_connection c)
 }
 #endif
 
-static zoom_ret ZOOM_connection_send_search(ZOOM_connection c)
+static zoom_ret ZOOM_connection_Z3950_send_search(ZOOM_connection c)
 {
     ZOOM_resultset r;
     int lslb, ssub, mspn;
@@ -1671,6 +1731,7 @@ static zoom_ret ZOOM_connection_send_search(ZOOM_connection c)
     const char *elementSetName;
     const char *smallSetElementSetName;
     const char *mediumSetElementSetName;
+    const char *facets;
 
     assert(c->tasks);
     assert(c->tasks->which == ZOOM_TASK_SEARCH);
@@ -1692,6 +1753,18 @@ static zoom_ret ZOOM_connection_send_search(ZOOM_connection c)
     if (!mediumSetElementSetName)
         mediumSetElementSetName = elementSetName;
 
+    facets = ZOOM_options_get(r->options, "facets");
+    if (facets) {
+        Z_FacetList *facet_list = yaz_pqf_parse_facet_list(c->odr_out, facets);
+        if (facet_list) {
+            Z_OtherInformation **oi;
+            yaz_oi_APDU(apdu, &oi);
+            if (facet_list) {
+                yaz_oi_set_facetlist(oi, c->odr_out, facet_list);
+            }
+        }
+    }
+
     assert(r);
     assert(r->query);
 
@@ -2405,8 +2478,8 @@ static ZOOM_record record_cache_lookup(ZOOM_resultset r, int pos,
     return 0;
 }
                                              
-static void handle_records(ZOOM_connection c, Z_Records *sr,
-                           int present_phase)
+static void handle_Z3950_records(ZOOM_connection c, Z_Records *sr,
+                                 int present_phase)
 {
     ZOOM_resultset resultset;
     int *start, *count;
@@ -2497,9 +2570,10 @@ static void handle_records(ZOOM_connection c, Z_Records *sr,
     }
 }
 
-static void handle_present_response(ZOOM_connection c, Z_PresentResponse *pr)
+static void handle_Z3950_present_response(ZOOM_connection c,
+                                          Z_PresentResponse *pr)
 {
-    handle_records(c, pr->records, 1);
+    handle_Z3950_records(c, pr->records, 1);
 }
 
 static void handle_queryExpressionTerm(ZOOM_options opt, const char *name,
@@ -2540,7 +2614,7 @@ static void handle_queryExpression(ZOOM_options opt, const char *name,
     }
 }
 
-static void handle_searchResult(ZOOM_connection c, ZOOM_resultset resultset,
+static void handle_search_result(ZOOM_connection c, ZOOM_resultset resultset,
                                 Z_OtherInformation *o)
 {
     int i;
@@ -2608,7 +2682,69 @@ static void handle_searchResult(ZOOM_connection c, ZOOM_resultset resultset,
     }
 }
 
-static void handle_search_response(ZOOM_connection c, Z_SearchResponse *sr)
+static char *get_term_cstr(ODR odr, Z_Term *term) {
+
+    switch (term->which) {
+    case Z_Term_general:
+            return odr_strdupn(odr, (const char *) term->u.general->buf, (size_t) term->u.general->len);
+        break;
+    case Z_Term_characterString:
+        return odr_strdup(odr, term->u.characterString);
+    }
+    return 0;
+}
+
+static ZOOM_facet_field get_zoom_facet_field(ODR odr, Z_FacetField *facet) {
+    int term_index;
+    struct yaz_facet_attr attr_values;
+    ZOOM_facet_field facet_field = odr_malloc(odr, sizeof(*facet_field));
+    yaz_facet_attr_init(&attr_values);
+    yaz_facet_attr_get_z_attributes(facet->attributes, &attr_values);
+    facet_field->facet_name = odr_strdup(odr, attr_values.useattr);
+    facet_field->num_terms = facet->num_terms;
+    yaz_log(YLOG_DEBUG, "ZOOM_facet_field %s %d terms %d", attr_values.useattr, attr_values.limit, facet->num_terms);
+    facet_field->facet_terms = odr_malloc(odr, facet_field->num_terms * sizeof(*facet_field->facet_terms));
+    for (term_index = 0 ; term_index < facet->num_terms; term_index++) {
+        Z_FacetTerm *facetTerm = facet->terms[term_index];
+        facet_field->facet_terms[term_index].frequency = *facetTerm->count;
+        facet_field->facet_terms[term_index].term = get_term_cstr(odr, facetTerm->term);
+        yaz_log(YLOG_DEBUG, "    term[%d] %s %d",
+                term_index, facet_field->facet_terms[term_index].term, facet_field->facet_terms[term_index].frequency);
+    }
+    return facet_field;
+}
+
+static void handle_facet_result(ZOOM_connection c, ZOOM_resultset r,
+                                Z_OtherInformation *o)
+{
+    int i;
+    for (i = 0; o && i < o->num_elements; i++)
+    {
+        if (o->list[i]->which == Z_OtherInfo_externallyDefinedInfo)
+        {
+            Z_External *ext = o->list[i]->information.externallyDefinedInfo;
+            if (ext->which == Z_External_userFacets)
+            {
+                int j;
+                Z_FacetList *fl = ext->u.facetList;
+                r->num_facets   = fl->num;
+                yaz_log(YLOG_DEBUG, "Facets found: %d", fl->num);
+                r->facets       =  odr_malloc(r->odr, r->num_facets * sizeof(*r->facets));
+                r->facets_names =  odr_malloc(r->odr, r->num_facets * sizeof(*r->facets_names));
+                for (j = 0; j < fl->num; j++)
+                {
+                    r->facets[j] = get_zoom_facet_field(r->odr, fl->elements[j]);
+                    if (!r->facets[j])
+                        yaz_log(YLOG_DEBUG, "Facet field missing on index %d !", j);
+                    r->facets_names[j] = (char *) ZOOM_facet_field_name(r->facets[j]);
+                }
+            }
+        }
+    }
+}
+
+static void handle_Z3950_search_response(ZOOM_connection c,
+                                         Z_SearchResponse *sr)
 {
     ZOOM_resultset resultset;
     ZOOM_Event event;
@@ -2631,19 +2767,21 @@ static void handle_search_response(ZOOM_connection c, Z_SearchResponse *sr)
         ZOOM_options_set_int(resultset->options, "presentStatus",
                              *sr->presentStatus);
     }
-    handle_searchResult(c, resultset, sr->additionalSearchInfo);
+    handle_search_result(c, resultset, sr->additionalSearchInfo);
+
+    handle_facet_result(c, resultset, sr->additionalSearchInfo);
 
     resultset->size = *sr->resultCount;
-    handle_records(c, sr->records, 0);
+    handle_Z3950_records(c, sr->records, 0);
 }
 
-static void sort_response(ZOOM_connection c, Z_SortResponse *res)
+static void handle_Z3950_sort_response(ZOOM_connection c, Z_SortResponse *res)
 {
     if (res->diagnostics && res->num_diagnostics > 0)
         response_diag(c, res->diagnostics[0]);
 }
 
-static int scan_response(ZOOM_connection c, Z_ScanResponse *res)
+static int handle_Z3950_scan_response(ZOOM_connection c, Z_ScanResponse *res)
 {
     NMEM nmem = odr_extract_mem(c->odr_in);
     ZOOM_scanset scan;
@@ -2670,8 +2808,8 @@ static int scan_response(ZOOM_connection c, Z_ScanResponse *res)
     return 1;
 }
 
-static zoom_ret send_sort(ZOOM_connection c,
-                          ZOOM_resultset resultset)
+static zoom_ret send_Z3950_sort(ZOOM_connection c,
+                                ZOOM_resultset resultset)
 {
     if (c->error)
         resultset->r_sort_spec = 0;
@@ -2693,7 +2831,7 @@ static zoom_ret send_sort(ZOOM_connection c,
     return zoom_complete;
 }
 
-static zoom_ret send_present(ZOOM_connection c)
+static zoom_ret send_Z3950_present(ZOOM_connection c)
 {
     Z_APDU *apdu = 0;
     Z_PresentRequest *req = 0;
@@ -2928,7 +3066,7 @@ static zoom_ret send_package(ZOOM_connection c)
     return do_write(c);
 }
 
-static zoom_ret ZOOM_connection_send_scan(ZOOM_connection c)
+static zoom_ret ZOOM_connection_Z3950_send_scan(ZOOM_connection c)
 {
     ZOOM_scanset scan;
     Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_scanRequest);
@@ -3734,13 +3872,13 @@ ZOOM_API(int)
             if (c->proto == PROTO_HTTP)
                 ret = ZOOM_connection_srw_send_search(c);
             else
-                ret = ZOOM_connection_send_search(c);
+                ret = ZOOM_connection_Z3950_send_search(c);
             break;
         case ZOOM_TASK_RETRIEVE:
             if (c->proto == PROTO_HTTP)
                 ret = ZOOM_connection_srw_send_search(c);
             else
-                ret = send_present(c);
+                ret = send_Z3950_present(c);
             break;
         case ZOOM_TASK_CONNECT:
             ret = do_connect(c);
@@ -3749,7 +3887,7 @@ ZOOM_API(int)
             if (c->proto == PROTO_HTTP)
                 ret = ZOOM_connection_srw_send_scan(c);
             else
-                ret = ZOOM_connection_send_scan(c);
+                ret = ZOOM_connection_Z3950_send_scan(c);
             break;
         case ZOOM_TASK_PACKAGE:
             ret = send_package(c);
@@ -3757,7 +3895,7 @@ ZOOM_API(int)
         case ZOOM_TASK_SORT:
             c->tasks->u.sort.resultset->r_sort_spec = 
                 c->tasks->u.sort.q->sort_spec;
-            ret = send_sort(c, c->tasks->u.sort.resultset);
+            ret = send_Z3950_sort(c, c->tasks->u.sort.resultset);
             break;
         }
     }
@@ -3779,14 +3917,14 @@ ZOOM_API(int)
     return 1;
 }
 
-static zoom_ret send_sort_present(ZOOM_connection c)
+static zoom_ret send_Z3950_sort_present(ZOOM_connection c)
 {
     zoom_ret r = zoom_complete;
 
     if (c->tasks && c->tasks->which == ZOOM_TASK_SEARCH)
-        r = send_sort(c, c->tasks->u.search.resultset);
+        r = send_Z3950_sort(c, c->tasks->u.search.resultset);
     if (r == zoom_complete)
-        r = send_present(c);
+        r = send_Z3950_present(c);
     return r;
 }
 
@@ -3851,8 +3989,8 @@ static int es_response_taskpackage(ZOOM_connection c,
 }
 
 
-static int es_response(ZOOM_connection c,
-                       Z_ExtendedServicesResponse *res)
+static int handle_Z3950_es_response(ZOOM_connection c,
+                                    Z_ExtendedServicesResponse *res)
 {
     if (!c->tasks || c->tasks->which != ZOOM_TASK_PACKAGE)
         return 0;
@@ -3924,16 +4062,16 @@ static void set_init_option(const char *name, void *clientData) {
 }
 
 
-static void recv_apdu(ZOOM_connection c, Z_APDU *apdu)
+static void handle_Z3950_apdu(ZOOM_connection c, Z_APDU *apdu)
 {
     Z_InitResponse *initrs;
     
     ZOOM_connection_set_mask(c, 0);
-    yaz_log(log_details, "%p recv_apdu apdu->which=%d", c, apdu->which);
-    switch(apdu->which)
+    yaz_log(log_details, "%p handle_Z3950_apdu apdu->which=%d", c, apdu->which);
+    switch (apdu->which)
     {
     case Z_APDU_initResponse:
-        yaz_log(log_api, "%p recv_apdu: Received Init response", c);
+        yaz_log(log_api, "%p handle_Z3950_apdu: Received Init response", c);
         initrs = apdu->u.initResponse;
         ZOOM_connection_option_set(c, "serverImplementationId",
                                    initrs->implementationId ?
@@ -3998,7 +4136,7 @@ static void recv_apdu(ZOOM_connection c, Z_APDU *apdu)
                 int sel;
                 
                 yaz_get_response_charneg(tmpmem, p, &charset, &lang, &sel);
-                yaz_log(log_details, "%p recv_apdu target accepted: "
+                yaz_log(log_details, "%p handle_Z3950_apdu target accepted: "
                         "charset %s, language %s, select %d",
                         c,
                         charset ? charset : "none", lang ? lang : "none", sel);
@@ -4017,35 +4155,35 @@ static void recv_apdu(ZOOM_connection c, Z_APDU *apdu)
         }       
         break;
     case Z_APDU_searchResponse:
-        yaz_log(log_api, "%p recv_apdu Search response", c);
-        handle_search_response(c, apdu->u.searchResponse);
-        if (send_sort_present(c) == zoom_complete)
+        yaz_log(log_api, "%p handle_Z3950_apdu Search response", c);
+        handle_Z3950_search_response(c, apdu->u.searchResponse);
+        if (send_Z3950_sort_present(c) == zoom_complete)
             ZOOM_connection_remove_task(c);
         break;
     case Z_APDU_presentResponse:
-        yaz_log(log_api, "%p recv_apdu Present response", c);
-        handle_present_response(c, apdu->u.presentResponse);
-        if (send_present(c) == zoom_complete)
+        yaz_log(log_api, "%p handle_Z3950_apdu Present response", c);
+        handle_Z3950_present_response(c, apdu->u.presentResponse);
+        if (send_Z3950_present(c) == zoom_complete)
             ZOOM_connection_remove_task(c);
         break;
     case Z_APDU_sortResponse:
-        yaz_log(log_api, "%p recv_apdu Sort response", c);
-        sort_response(c, apdu->u.sortResponse);
-        if (send_present(c) == zoom_complete)
+        yaz_log(log_api, "%p handle_Z3950_apdu Sort response", c);
+        handle_Z3950_sort_response(c, apdu->u.sortResponse);
+        if (send_Z3950_present(c) == zoom_complete)
             ZOOM_connection_remove_task(c);
         break;
     case Z_APDU_scanResponse:
-        yaz_log(log_api, "%p recv_apdu Scan response", c);
-        scan_response(c, apdu->u.scanResponse);
+        yaz_log(log_api, "%p handle_Z3950_apdu Scan response", c);
+        handle_Z3950_scan_response(c, apdu->u.scanResponse);
         ZOOM_connection_remove_task(c);
         break;
     case Z_APDU_extendedServicesResponse:
-        yaz_log(log_api, "%p recv_apdu Extended Services response", c);
-        es_response(c, apdu->u.extendedServicesResponse);
+        yaz_log(log_api, "%p handle_Z3950_apdu Extended Services response", c);
+        handle_Z3950_es_response(c, apdu->u.extendedServicesResponse);
         ZOOM_connection_remove_task(c);
         break;
     case Z_APDU_close:
-        yaz_log(log_api, "%p recv_apdu Close PDU", c);
+        yaz_log(log_api, "%p handle_Z3950_apdu Close PDU", c);
         if (!ZOOM_test_reconnect(c))
         {
             set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
@@ -4235,17 +4373,38 @@ static zoom_ret send_SRW_redirect(ZOOM_connection c, const char *uri,
 {
     struct Z_HTTP_Header *h;
     Z_GDU *gdu = get_HTTP_Request_url(c->odr_out, uri);
+    char *combined_cookies;
+    int combined_cookies_len = 0;
 
     gdu->u.HTTP_Request->method = odr_strdup(c->odr_out, "GET");
     z_HTTP_header_add(c->odr_out, &gdu->u.HTTP_Request->headers, "Accept",
                       "text/xml");
-    
+
     for (h = cookie_hres->headers; h; h = h->next)
     {
         if (!strcmp(h->name, "Set-Cookie"))
-            z_HTTP_header_add(c->odr_out, &gdu->u.HTTP_Request->headers,
-                              "Cookie", h->value);
+        {
+            char *cp;
+
+            if (!(cp = strchr(h->value, ';')))
+                cp = h->value + strlen(h->value);
+            if (cp - h->value >= 1) {
+                combined_cookies = xrealloc(combined_cookies, combined_cookies_len + cp - h->value + 3);
+                memcpy(combined_cookies+combined_cookies_len, h->value, cp - h->value);
+                combined_cookies[combined_cookies_len + cp - h->value] = '\0';
+                strcat(combined_cookies,"; ");
+                combined_cookies_len = strlen(combined_cookies);
+            }
+        }
     }
+
+    if (combined_cookies_len)
+    {
+        z_HTTP_header_add(c->odr_out, &gdu->u.HTTP_Request->headers,
+                          "Cookie", combined_cookies);
+        xfree(combined_cookies);
+    }
+
     if (c->user && c->password)
     {
         z_HTTP_header_add_basic_auth(c->odr_out, &gdu->u.HTTP_Request->headers,
@@ -4350,18 +4509,34 @@ static void handle_http(ZOOM_connection c, Z_HTTP_Response *hres)
         do_close(c);
     }
     if (cret == zoom_complete)
-        ZOOM_connection_remove_task(c);
-    if (!strcmp(hres->version, "1.0"))
     {
-        /* HTTP 1.0: only if Keep-Alive we stay alive.. */
-        if (!connection_head || strcmp(connection_head, "Keep-Alive"))
-            do_close(c);
+        yaz_log(YLOG_LOG, "removing tasks in handle_http");
+        ZOOM_connection_remove_task(c);
     }
-    else 
     {
-        /* HTTP 1.1: only if no close we stay alive .. */
-        if (connection_head && !strcmp(connection_head, "close"))
+        int must_close = 0;
+        if (!strcmp(hres->version, "1.0"))
+        {
+            /* HTTP 1.0: only if Keep-Alive we stay alive.. */
+            if (!connection_head || strcmp(connection_head, "Keep-Alive"))
+                must_close = 1;
+        }
+        else
+        {
+            /* HTTP 1.1: only if no close we stay alive.. */
+            if (connection_head && !strcmp(connection_head, "close"))
+                must_close = 1;
+        }
+        if (must_close)
+        {
             do_close(c);
+            if (c->tasks)
+            {
+                c->tasks->running = 0;
+                ZOOM_connection_insert_task(c, ZOOM_TASK_CONNECT);
+                c->reconnect_ok = 0;
+            }
+        }
     }
 }
 #endif
@@ -4421,7 +4596,7 @@ static int do_read(ZOOM_connection c)
             if (c->odr_print)
                 z_GDU(c->odr_print, &gdu, 0, 0);
             if (gdu->which == Z_GDU_Z3950)
-                recv_apdu(c, gdu->u.z3950);
+                handle_Z3950_apdu(c, gdu->u.z3950);
             else if (gdu->which == Z_GDU_HTTP_Response)
             {
 #if YAZ_HAVE_XML2