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 Solr 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 #endif
  30
  31 static void extract_text_node(xmlNodePtr node, WRBUF wrbuf) {
  32     xmlNodePtr child;
  33     for (child = node->children; child ; child = child->next)
  34     {
  35         if (child->type == XML_TEXT_NODE)
  36             wrbuf_puts(wrbuf, (const char *) child->content);
  37     }
  38 }
  39
  40 static int match_xml_node_attribute(
  41     xmlNodePtr ptr,
  42     const char *node_name, const char *attribute_name, const char *value)
  43 {
  44     const char *attribute_value;
  45     // check if the node name matches
  46     if (strcmp((const char*) ptr->name, node_name))
  47         return 0;
  48     if (attribute_name)
  49     {
  50         attribute_value = yaz_element_attribute_value_get(ptr, node_name,
  51                                                           attribute_name);
  52         if (attribute_value && !strcmp(attribute_value, value))
  53             return 1;
  54     }
  55     else /* No attribute to check */
  56         return 1;
  57     return 0;
  58 }
  59
  60 static void yaz_solr_decode_result_docs(ODR o, xmlNodePtr ptr,
  61                                         Odr_int start,
  62                                         Z_SRW_searchRetrieveResponse *sr)
  63 {
  64     xmlNodePtr node;
  65     int offset = 0;
  66     int i = 0;
  67
  68     sr->num_records = 0;
  69     for (node = ptr->children; node; node = node->next)
  70         if (node->type == XML_ELEMENT_NODE)
  71             sr->num_records++;
  72
  73     if (sr->num_records)
  74         sr->records = odr_malloc(o, sizeof(*sr->records) * sr->num_records);
  75
  76     for (node = ptr->children; node; node = node->next)
  77     {
  78         if (node->type == XML_ELEMENT_NODE)
  79         {
  80             Z_SRW_record *record = sr->records + i;
  81             xmlBufferPtr buf = xmlBufferCreate();
  82             xmlNode *tmp = xmlCopyNode(node, 1);
  83
  84             xmlNodeDump(buf, tmp->doc, tmp, 0, 0);
  85
  86             xmlFreeNode(tmp);
  87
  88             record->recordSchema = 0;
  89             record->recordPacking = Z_SRW_recordPacking_XML;
  90             record->recordData_len = buf->use;
  91             record->recordData_buf = odr_malloc(o, buf->use + 1);
  92             memcpy(record->recordData_buf, buf->content, buf->use);
  93             record->recordData_buf[buf->use] = '\0';
  94             // TODO Solve the real problem in zoom-sru, that doesnt work with 0-based indexes.
  95             // Work-around: Making the recordPosition 1-based.
  96             record->recordPosition = odr_intdup(o, start + offset + 1);
  97
  98             xmlBufferFree(buf);
  99
 100             offset++;
 101             i++;
 102         }
 103     }
 104 }
 105
 106 static int yaz_solr_decode_result(ODR o, xmlNodePtr ptr,
 107                                   Z_SRW_searchRetrieveResponse *sr)
 108 {
 109     Odr_int start = 0;
 110     struct _xmlAttr *attr;
 111     for (attr = ptr->properties; attr; attr = attr->next)
 112         if (attr->children && attr->children->type == XML_TEXT_NODE)
 113         {
 114             if (!strcmp((const char *) attr->name, "numFound"))
 115             {
 116                 sr->numberOfRecords = odr_intdup(o, odr_atoi(
 117                         (const char *) attr->children->content));
 118             }
 119             else if (!strcmp((const char *) attr->name, "start"))
 120             {
 121                 start = odr_atoi((const char *) attr->children->content);
 122             }
 123         }
 124     if (sr->numberOfRecords && *sr->numberOfRecords > 0)
 125         yaz_solr_decode_result_docs(o, ptr, start, sr);
 126     if (sr->numberOfRecords)
 127         return 0;
 128     return -1;
 129 }
 130
 131 static const char *get_facet_term_count(xmlNodePtr node, Odr_int *freq)
 132 {
 133     const char *term = yaz_element_attribute_value_get(node, "int", "name");
 134     xmlNodePtr child;
 135     WRBUF wrbuf = wrbuf_alloc();
 136     if (!term)
 137         return term;
 138
 139     for (child = node->children; child ; child = child->next)
 140     {
 141         if (child->type == XML_TEXT_NODE)
 142             wrbuf_puts(wrbuf, (const char *) child->content);
 143     }
 144     *freq = odr_atoi(wrbuf_cstr(wrbuf));
 145     wrbuf_destroy(wrbuf);
 146     return term;
 147 }
 148
 149 Z_FacetField *yaz_solr_decode_facet_field(ODR o, xmlNodePtr ptr,
 150                                           Z_SRW_searchRetrieveResponse *sr)
 151
 152 {
 153     Z_AttributeList *list;
 154     Z_FacetField *facet_field;
 155     int num_terms = 0;
 156     int index = 0;
 157     xmlNodePtr node;
 158     // USE attribute
 159     const char* name = yaz_element_attribute_value_get(ptr, "lst", "name");
 160     list = yaz_use_attribute_create(o, name);
 161     for (node = ptr->children; node; node = node->next)
 162         num_terms++;
 163     facet_field = facet_field_create(o, list, num_terms);
 164     index = 0;
 165     for (node = ptr->children; node; node = node->next)
 166     {
 167         Odr_int count = 0;
 168         const char *term = get_facet_term_count(node, &count);
 169         facet_field_term_set(o, facet_field,
 170                              facet_term_create_cstr(o, term, count), index);
 171         index++;
 172     }
 173     return facet_field;
 174 }
 175
 176 static int yaz_solr_decode_facet_counts(ODR o, xmlNodePtr root,
 177                                         Z_SRW_searchRetrieveResponse *sr)
 178 {
 179     xmlNodePtr ptr;
 180     for (ptr = root->children; ptr; ptr = ptr->next)
 181     {
 182         if (match_xml_node_attribute(ptr, "lst", "name", "facet_fields"))
 183         {
 184             xmlNodePtr node;
 185             Z_FacetList *facet_list;
 186             int num_facets = 0;
 187             for (node = ptr->children; node; node= node->next)
 188             {
 189                 num_facets++;
 190             }
 191             facet_list = facet_list_create(o, num_facets);
 192             num_facets = 0;
 193             for (node = ptr->children; node; node= node->next)
 194             {
 195                 facet_list_field_set(o, facet_list,
 196                                      yaz_solr_decode_facet_field(o, node, sr),
 197                                      num_facets);
 198                 num_facets++;
 199             }
 200             sr->facetList = facet_list;
 201             break;
 202         }
 203     }
 204     return 0;
 205 }
 206
 207 static yaz_solr_decode_suggestion_values(xmlNodePtr ptr, WRBUF wrbuf) {
 208     xmlNodePtr node;
 209     for (node = ptr; node; node= node->next) {
 210         if (!strcmp(ptr->name,"lst")) {
 211             xmlNodePtr child;
 212             for (child = ptr->children; child; child= child->next) {
 213                 if (match(child, "str", "name", "word")) {
 214                     wrbuf_puts(wrbuf, "<suggestion>");
 215                     extract_text_node(child, wrbuf);
 216                     wrbuf_puts(wrbuf, "</suggestion>\n");
 217                 }
 218             }
 219         }
 220     }
 221 }
 222
 223 static yaz_solr_decode_suggestion_lst(xmlNodePtr lstPtr, WRBUF wrbuf) {
 224     xmlNodePtr node;
 225     for (node = lstPtr; node; node= node->next) {
 226         if (match_xml_node_attribute(node, "arr", "name", "suggestion")) {
 227             yaz_solr_decode_suggestion_values(node->children, wrbuf);
 228         }
 229     }
 230 }
 231
 232 static void yaz_solr_decode_misspelled(xmlNodePtr lstPtr, WRBUF wrbuf)
 233 {
 234     xmlNodePtr node;
 235     for (node = lstPtr; node; node= node->next)
 236     {
 237         if (strcmp((const char*) node->name, "lst")) {
 238             const char *misspelled = yaz_element_attribute_value_get(node, "lst", "name");
 239             if (misspelled) {
 240                 wrbuf_printf(wrbuf, "<misspelled term=\"%s\">", misspelled);
 241                 yaz_solr_decode_suggestion_lst(node->children, wrbuf);
 242                 wrbuf_puts(wrbuf, "</misspelled>\n");
 243             }
 244         }
 245     }
 246 }
 247
 248 static int yaz_solr_decode_spellcheck(ODR o, xmlNodePtr spellcheckPtr, Z_SRW_searchRetrieveResponse *sr)
 249 {
 250     xmlNodePtr ptr;
 251     WRBUF wrbuf = wrbuf_alloc();
 252     wrbuf_puts(wrbuf, "");
 253     for (ptr = spellcheckPtr->children; ptr; ptr = ptr->next)
 254     {
 255         if (match_xml_node_attribute(ptr, "lst", "name", "suggestions"))
 256         {
 257             yaz_solr_decode_misspelled(ptr->children, wrbuf);
 258         }
 259     }
 260     sr->suggestions = odr_strdup(o, wrbuf_cstr(wrbuf));
 261     return 0;
 262 }
 263
 264 int yaz_solr_decode_response(ODR o, Z_HTTP_Response *hres, Z_SRW_PDU **pdup)
 265 {
 266 #if YAZ_HAVE_XML2
 267     const char *content_buf = hres->content_buf;
 268     int content_len = hres->content_len;
 269     xmlDocPtr doc = xmlParseMemory(content_buf, content_len);
 270     int ret = 0;
 271     xmlNodePtr ptr = 0;
 272     Z_SRW_PDU *pdu = yaz_srw_get(o, Z_SRW_searchRetrieve_response);
 273     Z_SRW_searchRetrieveResponse *sr = pdu->u.response;
 274
 275     if (!doc)
 276     {
 277         ret = -1;
 278     }
 279     if (doc)
 280     {
 281         xmlNodePtr root = xmlDocGetRootElement(doc);
 282         if (!root)
 283         {
 284             ret = -1;
 285         }
 286         else if (strcmp((const char *) root->name, "response"))
 287         {
 288             ret = -1;
 289         }
 290         else
 291         {
 292             /** look for result (required) and facets node (optional) */
 293             int rc_result = -1;
 294             int rc_facets = 0;
 295             for (ptr = root->children; ptr; ptr = ptr->next)
 296             {
 297                 if (ptr->type == XML_ELEMENT_NODE &&
 298                     !strcmp((const char *) ptr->name, "result"))
 299                         rc_result = yaz_solr_decode_result(o, ptr, sr);
 300                 /* TODO The check on hits is a work-around to avoid garbled facets on zero results from the SOLR server.
 301                  * The work-around works because the results is before the facets in the xml. */
 302                 if (rc_result == 0 &&  *sr->numberOfRecords > 0 &&
 303                     match_xml_node_attribute(ptr, "lst", "name", "facet_counts"))
 304                     rc_facets =  yaz_solr_decode_facet_counts(o, ptr, sr);
 305                 if (rc_result == 0 &&  *sr->numberOfRecords == 0 &&
 306                     match_xml_node_attribute(ptr, "lst", "name", "spellcheck"))
 307                     rc_facets =  yaz_solr_decode_spellcheck(o, ptr, sr);
 308
 309             }
 310             ret = rc_result + rc_facets;
 311         }
 312     }
 313     if (doc)
 314         xmlFreeDoc(doc);
 315     if (ret == 0)
 316         *pdup = pdu;
 317     return ret;
 318 #else
 319     return -1;
 320 #endif
 321 }
 322
 323 static int yaz_solr_encode_facet_field(
 324     ODR encode, char **name, char **value, int *i,
 325     Z_FacetField *facet_field)
 326 {
 327     Z_AttributeList *attribute_list = facet_field->attributes;
 328     struct yaz_facet_attr attr_values;
 329     yaz_facet_attr_init(&attr_values);
 330     yaz_facet_attr_get_z_attributes(attribute_list, &attr_values);
 331     // TODO do we want to support server decided
 332
 333     if (attr_values.errcode)
 334         return -1;
 335     if (attr_values.useattr)
 336     {
 337         WRBUF wrbuf = wrbuf_alloc();
 338         wrbuf_puts(wrbuf, (char *) attr_values.useattr);
 339         yaz_add_name_value_str(encode, name, value, i,
 340                                "facet.field",
 341                                odr_strdup(encode, wrbuf_cstr(wrbuf)));
 342         if (attr_values.limit > 0)
 343         {
 344             WRBUF wrbuf2 = wrbuf_alloc();
 345             Odr_int olimit;
 346             wrbuf_puts(wrbuf2, "f.");
 347             wrbuf_puts(wrbuf2, wrbuf_cstr(wrbuf));
 348             wrbuf_puts(wrbuf2, ".facet.limit");
 349             olimit = attr_values.limit;
 350             yaz_add_name_value_int(encode, name, value, i,
 351                                    odr_strdup(encode, wrbuf_cstr(wrbuf2)),
 352                                    &olimit);
 353             wrbuf_destroy(wrbuf2);
 354         }
 355         wrbuf_destroy(wrbuf);
 356     }
 357     return 0;
 358 }
 359
 360 static int yaz_solr_encode_facet_list(
 361     ODR encode, char **name, char **value,
 362     int *i, Z_FacetList *facet_list)
 363 {
 364     int index;
 365     for (index = 0; index < facet_list->num; index++)
 366     {
 367         int r = yaz_solr_encode_facet_field(encode, name, value, i,
 368                                             facet_list->elements[index]);
 369         if (r)
 370             return -1;
 371
 372     }
 373     return 0;
 374 }
 375
 376 int yaz_solr_encode_request(Z_HTTP_Request *hreq, Z_SRW_PDU *srw_pdu,
 377                             ODR encode, const char *charset)
 378 {
 379     const char *solr_op = 0;
 380     //TODO Change. not a nice hard coded, unchecked limit.
 381     char *name[SOLR_MAX_PARAMETERS], *value[SOLR_MAX_PARAMETERS];
 382     char *uri_args;
 383     char *path;
 384     int i = 0;
 385
 386     z_HTTP_header_add_basic_auth(encode, &hreq->headers,
 387                                  srw_pdu->username, srw_pdu->password);
 388     if (srw_pdu->which == Z_SRW_searchRetrieve_request)
 389     {
 390         Z_SRW_searchRetrieveRequest *request = srw_pdu->u.request;
 391         solr_op = "select";
 392         switch (srw_pdu->u.request->query_type)
 393         {
 394         case Z_SRW_query_type_pqf:
 395             yaz_add_name_value_str(encode, name, value, &i,
 396                                    "q", request->query.pqf);
 397             break;
 398         case Z_SRW_query_type_cql:
 399             yaz_add_name_value_str(encode, name, value, &i,
 400                                    "q", request->query.cql);
 401             break;
 402         default:
 403             return -1;
 404         }
 405         if (srw_pdu->u.request->startRecord)
 406         {
 407             Odr_int start = *request->startRecord - 1;
 408             yaz_add_name_value_int(encode, name, value, &i,
 409                                    "start", &start);
 410         }
 411         yaz_add_name_value_int(encode, name, value, &i,
 412                                "rows", request->maximumRecords);
 413         yaz_add_name_value_str(encode, name, value, &i,
 414                                "fl", request->recordSchema);
 415
 416         if (request->facetList)
 417         {
 418             Z_FacetList *facet_list = request->facetList;
 419             yaz_add_name_value_str(encode, name, value, &i, "facet", "true");
 420             yaz_add_name_value_str(encode, name, value, &i, "facet.mincount", "1");
 421             if (yaz_solr_encode_facet_list(encode, name, value, &i, facet_list))
 422                 return -1;
 423         }
 424     }
 425     else
 426         return -1;
 427
 428     if (srw_pdu->extra_args)
 429     {
 430         Z_SRW_extra_arg *ea = srw_pdu->extra_args;
 431         for (; ea && i < SOLR_MAX_PARAMETERS; ea = ea->next)
 432         {
 433             name[i] = ea->name;
 434             value[i] = ea->value;
 435             i++;
 436         }
 437     }
 438
 439     name[i++] = 0;
 440
 441     yaz_array_to_uri(&uri_args, encode, name, value);
 442
 443     hreq->method = "GET";
 444
 445     path = (char *)
 446         odr_malloc(encode, strlen(hreq->path) +
 447                    strlen(uri_args) + strlen(solr_op) + 4);
 448
 449     sprintf(path, "%s/%s?%s", hreq->path, solr_op, uri_args);
 450     hreq->path = path;
 451
 452     z_HTTP_header_add_content_type(encode, &hreq->headers,
 453                                    "text/xml", charset);
 454     return 0;
 455 }
 456
 457
 458 /*
 459  * Local variables:
 460  * c-basic-offset: 4
 461  * c-file-style: "Stroustrup"
 462  * indent-tabs-mode: nil
 463  * End:
 464  * vim: shiftwidth=4 tabstop=8 expandtab
 465  */
 466