src/solr.c

   1 /* This file is part of the YAZ toolkit.
   2  * Copyright (C) 1995-2011 Index Data
   3  * See the file LICENSE for details.
   4  */
   5 /**
   6  * \file solr.c
   7  * \brief Implements SOAP Webservice decoding/encoding
   8  */
   9 #if HAVE_CONFIG_H
  10 #include <config.h>
  11 #endif
  12
  13 #include <stdlib.h>
  14 #include <assert.h>
  15 #include <yaz/srw.h>
  16 #include <yaz/matchstr.h>
  17 #include <yaz/yaz-iconv.h>
  18 #include <yaz/log.h>
  19 #include <yaz/facet.h>
  20 #include <yaz/wrbuf.h>
  21
  22 #include "sru-p.h"
  23
  24 #define SOLR_MAX_PARAMETERS  100
  25
  26 #if YAZ_HAVE_XML2
  27 #include <libxml/parser.h>
  28 #include <libxml/tree.h>
  29
  30 static int match_xml_node_attribute(
  31     xmlNodePtr ptr,
  32     const char *node_name, const char *attribute_name, const char *value)
  33 {
  34     const char *attribute_value;
  35     // check if the node name matches
  36     if (strcmp((const char*) ptr->name, node_name))
  37         return 0;
  38     if (attribute_name)
  39     {
  40         attribute_value = yaz_element_attribute_value_get(ptr, node_name,
  41                                                           attribute_name);
  42         if (attribute_value && !strcmp(attribute_value, value))
  43             return 1;
  44     }
  45     else /* No attribute to check */
  46         return 1;
  47     return 0;
  48 }
  49
  50 static void yaz_solr_decode_result_docs(ODR o, xmlNodePtr ptr,
  51                                         Odr_int start,
  52                                         Z_SRW_searchRetrieveResponse *sr)
  53 {
  54     xmlNodePtr node;
  55     int offset = 0;
  56     int i = 0;
  57
  58     sr->num_records = 0;
  59     for (node = ptr->children; node; node = node->next)
  60         if (node->type == XML_ELEMENT_NODE)
  61             sr->num_records++;
  62
  63     if (sr->num_records)
  64         sr->records = odr_malloc(o, sizeof(*sr->records) * sr->num_records);
  65
  66     for (node = ptr->children; node; node = node->next)
  67     {
  68         if (node->type == XML_ELEMENT_NODE)
  69         {
  70             Z_SRW_record *record = sr->records + i;
  71             xmlBufferPtr buf = xmlBufferCreate();
  72             xmlNode *tmp = xmlCopyNode(node, 1);
  73
  74             xmlNodeDump(buf, tmp->doc, tmp, 0, 0);
  75
  76             xmlFreeNode(tmp);
  77
  78             record->recordSchema = 0;
  79             record->recordPacking = Z_SRW_recordPacking_XML;
  80             record->recordData_len = buf->use;
  81             record->recordData_buf = odr_malloc(o, buf->use + 1);
  82             memcpy(record->recordData_buf, buf->content, buf->use);
  83             record->recordData_buf[buf->use] = '\0';
  84             // TODO Solve the real problem in zoom-sru, that doesnt work with 0-based indexes.
  85             // Work-around: Making the recordPosition 1-based.
  86             record->recordPosition = odr_intdup(o, start + offset + 1);
  87
  88             xmlBufferFree(buf);
  89
  90             offset++;
  91             i++;
  92         }
  93     }
  94 }
  95
  96 static int yaz_solr_decode_result(ODR o, xmlNodePtr ptr,
  97                                   Z_SRW_searchRetrieveResponse *sr)
  98 {
  99     Odr_int start = 0;
 100     struct _xmlAttr *attr;
 101     for (attr = ptr->properties; attr; attr = attr->next)
 102         if (attr->children && attr->children->type == XML_TEXT_NODE)
 103         {
 104             if (!strcmp((const char *) attr->name, "numFound"))
 105             {
 106                 sr->numberOfRecords = odr_intdup(o, odr_atoi(
 107                         (const char *) attr->children->content));
 108             }
 109             else if (!strcmp((const char *) attr->name, "start"))
 110             {
 111                 start = odr_atoi((const char *) attr->children->content);
 112             }
 113         }
 114     if (sr->numberOfRecords && *sr->numberOfRecords > 0)
 115         yaz_solr_decode_result_docs(o, ptr, start, sr);
 116     if (sr->numberOfRecords)
 117         return 0;
 118     return -1;
 119 }
 120
 121 static const char *get_facet_term_count(xmlNodePtr node, Odr_int *freq)
 122 {
 123     const char *term = yaz_element_attribute_value_get(node, "int", "name");
 124     xmlNodePtr child;
 125     WRBUF wrbuf = wrbuf_alloc();
 126     if (!term)
 127         return term;
 128
 129     for (child = node->children; child ; child = child->next)
 130     {
 131         if (child->type == XML_TEXT_NODE)
 132             wrbuf_puts(wrbuf, (const char *) child->content);
 133     }
 134     *freq = odr_atoi(wrbuf_cstr(wrbuf));
 135     wrbuf_destroy(wrbuf);
 136     return term;
 137 }
 138
 139 Z_FacetField *yaz_solr_decode_facet_field(ODR o, xmlNodePtr ptr,
 140                                           Z_SRW_searchRetrieveResponse *sr)
 141
 142 {
 143     Z_AttributeList *list;
 144     Z_FacetField *facet_field;
 145     int num_terms = 0;
 146     int index = 0;
 147     xmlNodePtr node;
 148     // USE attribute
 149     const char* name = yaz_element_attribute_value_get(ptr, "lst", "name");
 150     list = yaz_use_attribute_create(o, name);
 151     for (node = ptr->children; node; node = node->next)
 152         num_terms++;
 153     facet_field = facet_field_create(o, list, num_terms);
 154     index = 0;
 155     for (node = ptr->children; node; node = node->next)
 156     {
 157         Odr_int count = 0;
 158         const char *term = get_facet_term_count(node, &count);
 159         facet_field_term_set(o, facet_field,
 160                              facet_term_create_cstr(o, term, count), index);
 161         index++;
 162     }
 163     return facet_field;
 164 }
 165
 166 static int yaz_solr_decode_facet_counts(ODR o, xmlNodePtr root,
 167                                         Z_SRW_searchRetrieveResponse *sr)
 168 {
 169     xmlNodePtr ptr;
 170     for (ptr = root->children; ptr; ptr = ptr->next)
 171     {
 172         if (match_xml_node_attribute(ptr, "lst", "name", "facet_fields"))
 173         {
 174             xmlNodePtr node;
 175             Z_FacetList *facet_list;
 176             int num_facets = 0;
 177             for (node = ptr->children; node; node= node->next)
 178             {
 179                 num_facets++;
 180             }
 181             facet_list = facet_list_create(o, num_facets);
 182             num_facets = 0;
 183             for (node = ptr->children; node; node= node->next)
 184             {
 185                 facet_list_field_set(o, facet_list,
 186                                      yaz_solr_decode_facet_field(o, node, sr),
 187                                      num_facets);
 188                 num_facets++;
 189             }
 190             sr->facetList = facet_list;
 191             break;
 192         }
 193     }
 194     return 0;
 195 }
 196
 197 #endif
 198
 199 int yaz_solr_decode_response(ODR o, Z_HTTP_Response *hres, Z_SRW_PDU **pdup)
 200 {
 201 #if YAZ_HAVE_XML2
 202     const char *content_buf = hres->content_buf;
 203     int content_len = hres->content_len;
 204     xmlDocPtr doc = xmlParseMemory(content_buf, content_len);
 205     int ret = 0;
 206     xmlNodePtr ptr = 0;
 207     Z_SRW_PDU *pdu = yaz_srw_get(o, Z_SRW_searchRetrieve_response);
 208     Z_SRW_searchRetrieveResponse *sr = pdu->u.response;
 209
 210     if (!doc)
 211     {
 212         ret = -1;
 213     }
 214     if (doc)
 215     {
 216         xmlNodePtr root = xmlDocGetRootElement(doc);
 217         if (!root)
 218         {
 219             ret = -1;
 220         }
 221         else if (strcmp((const char *) root->name, "response"))
 222         {
 223             ret = -1;
 224         }
 225         else
 226         {
 227             /** look for result (required) and facets node (optional) */
 228             int rc_result = -1;
 229             int rc_facets = 0;
 230             for (ptr = root->children; ptr; ptr = ptr->next)
 231             {
 232                 if (ptr->type == XML_ELEMENT_NODE &&
 233                     !strcmp((const char *) ptr->name, "result"))
 234                         rc_result = yaz_solr_decode_result(o, ptr, sr);
 235                 /* TODO The check on hits is a work-around to avoid garbled facets on zero results from the SOLR server.
 236                  * The work-around works because the results is before the facets in the xml. */
 237                 if (rc_result == 0 &&  *sr->numberOfRecords > 0 &&
 238                     match_xml_node_attribute(ptr, "lst", "name",
 239                                              "facet_counts"))
 240                     rc_facets =  yaz_solr_decode_facet_counts(o, ptr, sr);
 241             }
 242             ret = rc_result + rc_facets;
 243         }
 244     }
 245     if (doc)
 246         xmlFreeDoc(doc);
 247     if (ret == 0)
 248         *pdup = pdu;
 249     return ret;
 250 #else
 251     return -1;
 252 #endif
 253 }
 254
 255 static int yaz_solr_encode_facet_field(
 256     ODR encode, char **name, char **value, int *i,
 257     Z_FacetField *facet_field)
 258 {
 259     Z_AttributeList *attribute_list = facet_field->attributes;
 260     struct yaz_facet_attr attr_values;
 261     yaz_facet_attr_init(&attr_values);
 262     yaz_facet_attr_get_z_attributes(attribute_list, &attr_values);
 263     // TODO do we want to support server decided
 264
 265     if (attr_values.errcode)
 266         return -1;
 267     if (attr_values.useattr)
 268     {
 269         WRBUF wrbuf = wrbuf_alloc();
 270         wrbuf_puts(wrbuf, (char *) attr_values.useattr);
 271         yaz_add_name_value_str(encode, name, value, i,
 272                                "facet.field",
 273                                odr_strdup(encode, wrbuf_cstr(wrbuf)));
 274         if (attr_values.limit > 0)
 275         {
 276             WRBUF wrbuf2 = wrbuf_alloc();
 277             Odr_int olimit;
 278             wrbuf_puts(wrbuf2, "f.");
 279             wrbuf_puts(wrbuf2, wrbuf_cstr(wrbuf));
 280             wrbuf_puts(wrbuf2, ".facet.limit");
 281             olimit = attr_values.limit;
 282             yaz_add_name_value_int(encode, name, value, i,
 283                                    odr_strdup(encode, wrbuf_cstr(wrbuf2)),
 284                                    &olimit);
 285             wrbuf_destroy(wrbuf2);
 286         }
 287         wrbuf_destroy(wrbuf);
 288     }
 289     return 0;
 290 }
 291
 292 static int yaz_solr_encode_facet_list(
 293     ODR encode, char **name, char **value,
 294     int *i, Z_FacetList *facet_list)
 295 {
 296     int index;
 297     for (index = 0; index < facet_list->num; index++)
 298     {
 299         int r = yaz_solr_encode_facet_field(encode, name, value, i,
 300                                             facet_list->elements[index]);
 301         if (r)
 302             return -1;
 303
 304     }
 305     return 0;
 306 }
 307
 308 int yaz_solr_encode_request(Z_HTTP_Request *hreq, Z_SRW_PDU *srw_pdu,
 309                             ODR encode, const char *charset)
 310 {
 311     const char *solr_op = 0;
 312     //TODO Change. not a nice hard coded, unchecked limit.
 313     char *name[SOLR_MAX_PARAMETERS], *value[SOLR_MAX_PARAMETERS];
 314     char *uri_args;
 315     char *path;
 316     int i = 0;
 317
 318     z_HTTP_header_add_basic_auth(encode, &hreq->headers,
 319                                  srw_pdu->username, srw_pdu->password);
 320     if (srw_pdu->which == Z_SRW_searchRetrieve_request)
 321     {
 322         Z_SRW_searchRetrieveRequest *request = srw_pdu->u.request;
 323         solr_op = "select";
 324         switch (srw_pdu->u.request->query_type)
 325         {
 326         case Z_SRW_query_type_pqf:
 327             yaz_add_name_value_str(encode, name, value, &i,
 328                                    "q", request->query.pqf);
 329             break;
 330         case Z_SRW_query_type_cql:
 331             yaz_add_name_value_str(encode, name, value, &i,
 332                                    "q", request->query.cql);
 333             break;
 334         default:
 335             return -1;
 336         }
 337         if (srw_pdu->u.request->startRecord)
 338         {
 339             Odr_int start = *request->startRecord - 1;
 340             yaz_add_name_value_int(encode, name, value, &i,
 341                                    "start", &start);
 342         }
 343         yaz_add_name_value_int(encode, name, value, &i,
 344                                "rows", request->maximumRecords);
 345         yaz_add_name_value_str(encode, name, value, &i,
 346                                "fl", request->recordSchema);
 347
 348         if (request->facetList)
 349         {
 350             Z_FacetList *facet_list = request->facetList;
 351             yaz_add_name_value_str(encode, name, value, &i, "facet", "true");
 352             yaz_add_name_value_str(encode, name, value, &i, "facet.mincount", "1");
 353             if (yaz_solr_encode_facet_list(encode, name, value, &i, facet_list))
 354                 return -1;
 355         }
 356     }
 357     else
 358         return -1;
 359     name[i] = 0;
 360     yaz_array_to_uri(&uri_args, encode, name, value);
 361
 362     hreq->method = "GET";
 363
 364     path = (char *)
 365         odr_malloc(encode, strlen(hreq->path) +
 366                    strlen(uri_args) + strlen(solr_op) + 4);
 367
 368     sprintf(path, "%s/%s?%s", hreq->path, solr_op, uri_args);
 369     hreq->path = path;
 370
 371     z_HTTP_header_add_content_type(encode, &hreq->headers,
 372                                    "text/xml", charset);
 373     return 0;
 374 }
 375
 376
 377 /*
 378  * Local variables:
 379  * c-basic-offset: 4
 380  * c-file-style: "Stroustrup"
 381  * indent-tabs-mode: nil
 382  * End:
 383  * vim: shiftwidth=4 tabstop=8 expandtab
 384  */
 385