Rename attr facet specific functions
[yaz-moved-to-github.git] / src / zoom-c.c
index 4e2bea0..4ed5d8d 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
@@ -1063,10 +1090,6 @@ static void ZOOM_record_release(ZOOM_record rec)
         wrbuf_destroy(rec->wrbuf);
 #endif
 
-#if YAZ_HAVE_XML2
-    if (rec->xml_mem)
-        xmlFree(rec->xml_mem);
-#endif
     if (rec->odr)
         odr_destroy(rec->odr);
 }
@@ -1106,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);
@@ -1252,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;
@@ -1675,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);
@@ -1696,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_oid(oi, c->odr_out, yaz_oid_userinfo_facet_1, 1, facet_list);
+            }
+        }
+    }
+
     assert(r);
     assert(r->query);
 
@@ -1880,10 +1949,6 @@ ZOOM_API(ZOOM_record)
 #else
     nrec->wrbuf = 0;
 #endif
-#if YAZ_HAVE_XML2
-    nrec->xml_mem = 0;
-    nrec->xml_size = 0;
-#endif
     odr_setbuf(nrec->odr, buf, size, 0);
     z_NamePlusRecord(nrec->odr, &nrec->npr, 0, 0);
     
@@ -1968,7 +2033,7 @@ static yaz_iconv_t iconv_create_charset(const char *record_charset)
     return cd;
 }
 
-static const char *return_marc_record(ZOOM_record rec, WRBUF wrbuf,
+static const char *return_marc_record(WRBUF wrbuf,
                                       int marc_type,
                                       int *len,
                                       const char *buf, int sz,
@@ -1993,7 +2058,7 @@ static const char *return_marc_record(ZOOM_record rec, WRBUF wrbuf,
     return ret_string;
 }
 
-static const char *return_opac_record(ZOOM_record rec, WRBUF wrbuf,
+static const char *return_opac_record(WRBUF wrbuf,
                                       int marc_type,
                                       int *len,
                                       Z_OPACRecord *opac_rec,
@@ -2016,7 +2081,7 @@ static const char *return_opac_record(ZOOM_record rec, WRBUF wrbuf,
     return wrbuf_cstr(wrbuf);
 }
 
-static const char *return_string_record(ZOOM_record rec, WRBUF wrbuf,
+static const char *return_string_record(WRBUF wrbuf,
                                         int *len,
                                         const char *buf, int sz,
                                         const char *record_charset)
@@ -2037,35 +2102,22 @@ static const char *return_string_record(ZOOM_record rec, WRBUF wrbuf,
     return buf;
 }
 
-static const char *return_record(ZOOM_record rec, int *len,
-                                 Z_NamePlusRecord *npr,
-                                 int marctype, const char *charset)
+static const char *return_record_wrbuf(WRBUF wrbuf, int *len,
+                                       Z_NamePlusRecord *npr,
+                                       int marctype, const char *charset)
 {
     Z_External *r = (Z_External *) npr->u.databaseRecord;
     const Odr_oid *oid = r->direct_reference;
-    WRBUF wrbuf;
 
-#if SHPTR
-    if (!rec->record_wrbuf)
-    {
-        WRBUF w = wrbuf_alloc();
-        YAZ_SHPTR_INIT(rec->record_wrbuf, w);
-    }
-    wrbuf = rec->record_wrbuf->ptr;
-#else
-    if (!rec->wrbuf)
-        rec->wrbuf = wrbuf_alloc();
-    wrbuf = rec->wrbuf;
-#endif
     wrbuf_rewind(wrbuf);
     /* render bibliographic record .. */
     if (r->which == Z_External_OPAC)
     {
-        return return_opac_record(rec, wrbuf, marctype, len,
+        return return_opac_record(wrbuf, marctype, len,
                                   r->u.opac, charset);
     }
     if (r->which == Z_External_sutrs)
-        return return_string_record(rec, wrbuf, len,
+        return return_string_record(wrbuf, len,
                                     (char*) r->u.sutrs->buf,
                                     r->u.sutrs->len,
                                     charset);
@@ -2074,7 +2126,7 @@ static const char *return_record(ZOOM_record rec, int *len,
         if (yaz_oid_is_iso2709(oid))
         {
             const char *ret_buf = return_marc_record(
-                rec, wrbuf, marctype, len,
+                wrbuf, marctype, len,
                 (const char *) r->u.octet_aligned->buf,
                 r->u.octet_aligned->len,
                 charset);
@@ -2084,7 +2136,7 @@ static const char *return_record(ZOOM_record rec, int *len,
             if (marctype != YAZ_MARC_ISO2709)
                 return 0;
         }
-        return return_string_record(rec, wrbuf, len,
+        return return_string_record(wrbuf, len,
                                     (const char *) r->u.octet_aligned->buf,
                                     r->u.octet_aligned->len,
                                     charset);
@@ -2092,7 +2144,7 @@ static const char *return_record(ZOOM_record rec, int *len,
     else if (r->which == Z_External_grs1)
     {
         yaz_display_grs1(wrbuf, r->u.grs1, 0);
-        return return_string_record(rec, wrbuf, len,
+        return return_string_record(wrbuf, len,
                                     wrbuf_buf(wrbuf),
                                     wrbuf_len(wrbuf),
                                     charset);
@@ -2100,7 +2152,6 @@ static const char *return_record(ZOOM_record rec, int *len,
     return 0;
 }
     
-
 ZOOM_API(int)
     ZOOM_record_error(ZOOM_record rec, const char **cp,
                       const char **addinfo, const char **diagset)
@@ -2161,12 +2212,12 @@ ZOOM_API(int)
     return 0;
 }
 
-static const char *get_record_format(ZOOM_record rec, int *len,
+static const char *get_record_format(WRBUF wrbuf, int *len,
                                      Z_NamePlusRecord *npr,
                                      int marctype, const char *charset,
                                      const char *format)
 {
-    const char *res = return_record(rec, len, npr, marctype, charset);
+    const char *res = return_record_wrbuf(wrbuf, len, npr, marctype, charset);
 #if YAZ_HAVE_XML2
     if (*format == '1' && len)
     {
@@ -2176,12 +2227,15 @@ static const char *get_record_format(ZOOM_record rec, int *len,
         doc = xmlParseMemory(res, *len);
         if (doc)
         {
-            if (rec->xml_mem)
-                xmlFree(rec->xml_mem);
-            xmlDocDumpFormatMemory(doc, &rec->xml_mem, &rec->xml_size, 1);
+            xmlChar *xml_mem;
+            int xml_size;
+            xmlDocDumpFormatMemory(doc, &xml_mem, &xml_size, 1);
+            wrbuf_rewind(wrbuf);
+            wrbuf_write(wrbuf, (const char *) xml_mem, xml_size);
+            xmlFree(xml_mem);
             xmlFreeDoc(doc);
-            res = (char *) rec->xml_mem;
-            *len = rec->xml_size;
+            res = wrbuf_cstr(wrbuf);
+            *len = wrbuf_len(wrbuf);
         } 
     }
 #endif
@@ -2189,26 +2243,16 @@ static const char *get_record_format(ZOOM_record rec, int *len,
 }
 
 
-ZOOM_API(const char *)
-    ZOOM_record_get(ZOOM_record rec, const char *type_spec, int *len)
+static const char *npr_format(Z_NamePlusRecord *npr, const char *schema,
+                              WRBUF wrbuf,
+                              const char *type_spec, int *len)
 {
+    size_t i;
     char type[40];
     char charset[40];
     char format[3];
-    const char *cp;
-    size_t i;
-    Z_NamePlusRecord *npr;
-    
-    if (len)
-        *len = 0; /* default return */
-        
-    if (!rec)
-        return 0;
-    npr = rec->npr;
-    if (!npr)
-        return 0;
+    const char *cp = type_spec;
 
-    cp = type_spec;
     for (i = 0; cp[i] && cp[i] != ';' && cp[i] != ' ' && i < sizeof(type)-1;
          i++)
         type[i] = cp[i];
@@ -2256,8 +2300,8 @@ ZOOM_API(const char *)
     else if (!strcmp(type, "schema"))
     {
         if (len)
-            *len = rec->schema ? strlen(rec->schema) : 0;
-        return rec->schema;
+            *len = schema ? strlen(schema) : 0;
+        return schema;
     }
     else if (!strcmp(type, "syntax"))
     {
@@ -2279,21 +2323,21 @@ ZOOM_API(const char *)
     /* from now on - we have a database record .. */
     if (!strcmp(type, "render"))
     {
-        return get_record_format(rec, len, npr, YAZ_MARC_LINE, charset, format);
+        return get_record_format(wrbuf, len, npr, YAZ_MARC_LINE, charset, format);
     }
     else if (!strcmp(type, "xml"))
     {
-        return get_record_format(rec, len, npr, YAZ_MARC_MARCXML, charset,
+        return get_record_format(wrbuf, len, npr, YAZ_MARC_MARCXML, charset,
                                  format);
     }
     else if (!strcmp(type, "txml"))
     {
-        return get_record_format(rec, len, npr, YAZ_MARC_TURBOMARC, charset,
+        return get_record_format(wrbuf, len, npr, YAZ_MARC_TURBOMARC, charset,
                                  format);
     }
     else if (!strcmp(type, "raw"))
     {
-        return get_record_format(rec, len, npr, YAZ_MARC_ISO2709, charset,
+        return get_record_format(wrbuf, len, npr, YAZ_MARC_ISO2709, charset,
             format);
     }
     else if (!strcmp(type, "ext"))
@@ -2304,12 +2348,38 @@ ZOOM_API(const char *)
     else if (!strcmp(type, "opac"))
     {
         if (npr->u.databaseRecord->which == Z_External_OPAC)
-            return get_record_format(rec, len, npr, YAZ_MARC_MARCXML, charset,
-                format);
+            return get_record_format(wrbuf, len, npr, YAZ_MARC_MARCXML, charset,
+                                     format);
     }
     return 0;
 }
 
+ZOOM_API(const char *)
+    ZOOM_record_get(ZOOM_record rec, const char *type_spec, int *len)
+{
+    WRBUF wrbuf;
+    
+    if (len)
+        *len = 0; /* default return */
+        
+    if (!rec || !rec->npr)
+        return 0;
+
+#if SHPTR
+    if (!rec->record_wrbuf)
+    {
+        WRBUF w = wrbuf_alloc();
+        YAZ_SHPTR_INIT(rec->record_wrbuf, w);
+    }
+    wrbuf = rec->record_wrbuf->ptr;
+#else
+    if (!rec->wrbuf)
+        rec->wrbuf = wrbuf_alloc();
+    wrbuf = rec->wrbuf;
+#endif
+    return npr_format(rec->npr, rec->schema, wrbuf, type_spec, len);
+}
+
 static int strcmp_null(const char *v1, const char *v2)
 {
     if (!v1 && !v2)
@@ -2355,9 +2425,6 @@ static void record_cache_add(ZOOM_resultset r, Z_NamePlusRecord *npr,
 #else
         rc->rec.wrbuf = 0;
 #endif
-#if YAZ_HAVE_XML2
-        rc->rec.xml_mem = 0;
-#endif
         rc->elementSetName = odr_strdup_null(r->odr, elementSetName);
         
         rc->syntax = odr_strdup_null(r->odr, syntax);
@@ -2546,7 +2613,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;
@@ -2614,6 +2681,68 @@ static void handle_searchResult(ZOOM_connection c, ZOOM_resultset resultset,
     }
 }
 
+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_search_response(ZOOM_connection c, Z_SearchResponse *sr)
 {
     ZOOM_resultset resultset;
@@ -2637,7 +2766,9 @@ 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);
@@ -4241,17 +4372,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,
@@ -4356,18 +4508,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