src/solr.c

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