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
  18 #include "sru-p.h"
  19
  20 #if YAZ_HAVE_XML2
  21 #include <libxml/parser.h>
  22 #include <libxml/tree.h>
  23
  24 #define SOLR_MAX_PARAMETERS  100
  25
  26 const char *xml_node_attribute_value_get(xmlNodePtr ptr, const char *node_name, const char *attribute_name) {
  27
  28     struct _xmlAttr *attr;
  29     // check if the node name matches
  30     if (strcmp((const char*) ptr->name, node_name))
  31         return 0;
  32     // check if the attribute name and return the value
  33     for (attr = ptr->properties; attr; attr = attr->next)
  34         if (attr->children && attr->children->type == XML_TEXT_NODE) {
  35             if (!strcmp((const char *) attr->name, attribute_name))
  36                 return (const char *) attr->children->content;
  37         }
  38     return 0;
  39 }
  40
  41
  42 static int match_xml_node_attribute(xmlNodePtr ptr, 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     attribute_value = xml_node_attribute_value_get(ptr, node_name, attribute_name);
  49     if (attribute_value && !strcmp(attribute_value, value))
  50         return 1;
  51     return 0;
  52 }
  53
  54 static void yaz_solr_decode_result_docs(ODR o, xmlNodePtr ptr, Odr_int start, Z_SRW_searchRetrieveResponse *sr) {
  55     xmlNodePtr node;
  56     int offset = 0;
  57     int i = 0;
  58
  59     sr->num_records = 0;
  60     for (node = ptr->children; node; node = node->next)
  61         if (node->type == XML_ELEMENT_NODE)
  62             sr->num_records++;
  63
  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 void yaz_solr_decode_result(ODR o, xmlNodePtr ptr, Z_SRW_searchRetrieveResponse *sr) {
  97     Odr_int start = 0;
  98     struct _xmlAttr *attr;
  99     for (attr = ptr->properties; attr; attr = attr->next)
 100         if (attr->children && attr->children->type == XML_TEXT_NODE) {
 101             if (!strcmp((const char *) attr->name, "numFound")) {
 102                 sr->numberOfRecords = odr_intdup(o, odr_atoi(
 103                         (const char *) attr->children->content));
 104             } else if (!strcmp((const char *) attr->name, "start")) {
 105                 start = odr_atoi((const char *) attr->children->content);
 106             }
 107         }
 108     yaz_solr_decode_result_docs(o, ptr, start, sr);
 109 }
 110
 111 static Z_AttributeList *yaz_solr_use_atttribute_create(ODR o, const char *name) {
 112     // TODO IMPLEMENT
 113     return 0;
 114 }
 115
 116
 117 static const char *get_facet_term_count(xmlNodePtr node, int *freq) {
 118     // TODO implement
 119     return 0;
 120 }
 121
 122 Z_FacetField *yaz_solr_decode_facet_field(ODR o, xmlNodePtr ptr, Z_SRW_searchRetrieveResponse *sr)
 123 {
 124     // USE attribute
 125     const char* name = xml_node_attribute_value_get(ptr, "lst", "name");
 126     Z_AttributeList *list = yaz_solr_use_atttribute_create(o, name);
 127     Z_FacetField *facet_field;
 128     int num_terms = 0;
 129     int index = 0;
 130     xmlNodePtr node;
 131     for (node = ptr->children; node; node = node->next) {
 132         num_terms++;
 133     }
 134     facet_field = facet_field_create(o, list, num_terms);
 135     index = 0;
 136     for (node = ptr->children; node; node = node->next) {
 137         int count = 0;
 138         const char *term = get_facet_term_count(node, &count);
 139         facet_field_term_set(o, facet_field, facet_term_create(o, term_create(o, term), count), index);
 140         index++;
 141     }
 142     return facet_field;
 143 }
 144
 145 static void yaz_solr_decode_facet_counts(ODR o, xmlNodePtr root, Z_SRW_searchRetrieveResponse *sr) {
 146     xmlNodePtr ptr;
 147     for (ptr = root->children; ptr; ptr = ptr->next)
 148     {
 149         if (match_xml_node_attribute(ptr, "lst", "name", "facet_fields"))
 150         {
 151             xmlNodePtr node;
 152             Z_FacetList *facet_list;
 153             int num_facets = 0;
 154             for (node = ptr->children; node; node= node->next)
 155             {
 156                 num_facets++;
 157             }
 158             facet_list = facet_list_create(o, num_facets);
 159             num_facets = 0;
 160             for (node = ptr->children; node; node= node->next)
 161             {
 162                 facet_list_field_set(o, facet_list, yaz_solr_decode_facet_field(o, node, sr), num_facets);
 163                 num_facets++;
 164             }
 165             sr->facetList = facet_list;
 166             break;
 167         }
 168     }
 169 }
 170
 171 static void yaz_solr_decode_facets(ODR o, xmlNodePtr ptr, Z_SRW_searchRetrieveResponse *sr) {
 172     if (match_xml_node_attribute(ptr, "lst", "name", "facet_counts"))
 173         yaz_solr_decode_facet_counts(o, ptr->children, sr);
 174 }
 175 #endif
 176
 177 int yaz_solr_decode_response(ODR o, Z_HTTP_Response *hres, Z_SRW_PDU **pdup)
 178 {
 179 #if YAZ_HAVE_XML2
 180     const char *content_buf = hres->content_buf;
 181     int content_len = hres->content_len;
 182     xmlDocPtr doc = xmlParseMemory(content_buf, content_len);
 183     int ret = 0;
 184     xmlNodePtr ptr = 0;
 185     Z_SRW_PDU *pdu = yaz_srw_get(o, Z_SRW_searchRetrieve_response);
 186     Z_SRW_searchRetrieveResponse *sr = pdu->u.response;
 187
 188     if (!doc)
 189     {
 190         ret = -1;
 191     }
 192     if (doc)
 193     {
 194         xmlNodePtr root = xmlDocGetRootElement(doc);
 195         if (!root)
 196         {
 197             ret = -1;
 198         }
 199         else if (strcmp((const char *) root->name, "response"))
 200         {
 201             ret = -1;
 202         }
 203         else
 204         {
 205             /** look for result node */
 206             for (ptr = root->children; ptr; ptr = ptr->next)
 207             {
 208                 if (ptr->type == XML_ELEMENT_NODE &&
 209                     !strcmp((const char *) ptr->name, "result"))
 210                         yaz_solr_decode_result(o, ptr, sr);
 211                 if (match_xml_node_attribute(ptr, "lst", "name", "facet_counts"))
 212                         yaz_solr_decode_facet_counts(o, ptr, sr);
 213             }
 214             if (!ptr)
 215             {
 216                 ret = -1;
 217             }
 218         }
 219     }
 220     if (doc)
 221         xmlFreeDoc(doc);
 222     if (ret == 0)
 223         *pdup = pdu;
 224     return ret;
 225 #else
 226     return -1;
 227 #endif
 228 }
 229
 230 static void yaz_solr_encode_facet_field(ODR encode, char **name, char **value, int *i, Z_FacetField *facet_field, int *limit) {
 231       Z_AttributeList *attribute_list = facet_field->attributes;
 232       struct yaz_facet_attr attr_values;
 233       yaz_facet_attr_init(&attr_values);
 234       yaz_facet_attr_get_z_attributes(attribute_list, &attr_values);
 235       // TODO do we want to support server decided
 236       if (!attr_values.errcode && attr_values.useattr) {
 237           yaz_add_name_value_str(encode, name, value, i, "facet.field", (char *) attr_values.useattr);
 238           // TODO max(attr_values, *limit);
 239           if (attr_values.limit > 0 && attr_values.limit > *limit) {
 240               *limit = attr_values.limit;
 241           }
 242       }
 243 }
 244
 245 static void yaz_solr_encode_facet_list(ODR encode, char **name, char **value, int *i, Z_FacetList *facet_list, int *limit) {
 246
 247     int index;
 248     for (index = 0; index < facet_list->num; index++)  {
 249         yaz_solr_encode_facet_field(encode, name, value, i, facet_list->elements[index], limit);
 250
 251     }
 252 }
 253
 254
 255 int yaz_solr_encode_request(Z_HTTP_Request *hreq, Z_SRW_PDU *srw_pdu,
 256                             ODR encode, const char *charset)
 257 {
 258     const char *solr_op = 0;
 259     //TODO Change. not a nice hard coded, unchecked limit.
 260     char *name[SOLR_MAX_PARAMETERS], *value[SOLR_MAX_PARAMETERS];
 261     char *uri_args;
 262     char *path;
 263     int i = 0;
 264
 265     z_HTTP_header_add_basic_auth(encode, &hreq->headers,
 266                                  srw_pdu->username, srw_pdu->password);
 267
 268     switch (srw_pdu->which)
 269     {
 270     case Z_SRW_searchRetrieve_request: {
 271         Z_SRW_searchRetrieveRequest *request = srw_pdu->u.request;
 272         solr_op = "select";
 273         switch(srw_pdu->u.request->query_type)
 274         {
 275         case Z_SRW_query_type_pqf:
 276             yaz_add_name_value_str(encode, name, value, &i,
 277                                    "q", request->query.pqf);
 278             break;
 279         case Z_SRW_query_type_cql:
 280             yaz_add_name_value_str(encode, name, value, &i,
 281                                    "q", request->query.cql);
 282             break;
 283         default:
 284             return -1;
 285         }
 286         if (srw_pdu->u.request->startRecord)
 287         {
 288             Odr_int start = *request->startRecord - 1;
 289             yaz_add_name_value_int(encode, name, value, &i,
 290                                    "start", &start);
 291         }
 292         yaz_add_name_value_int(encode, name, value, &i,
 293                                "rows", request->maximumRecords);
 294         yaz_add_name_value_str(encode, name, value, &i,
 295                                "fl", request->recordSchema);
 296
 297         if (request->facetList) {
 298             Z_FacetList *facet_list = request->facetList;
 299             int limit;
 300             Odr_int olimit;
 301             yaz_add_name_value_str(encode, name, value, &i, "facet", "true");
 302             yaz_solr_encode_facet_list(encode, name, value, &i, facet_list, &limit);
 303             olimit = limit;
 304             yaz_add_name_value_int(encode, name, value, &i, "facet.limit", &olimit);
 305
 306         }
 307         break;
 308     }
 309     default:
 310         return -1;
 311     }
 312     name[i] = 0;
 313     yaz_array_to_uri(&uri_args, encode, name, value);
 314
 315     hreq->method = "GET";
 316
 317     path = (char *)
 318         odr_malloc(encode, strlen(hreq->path) +
 319                    strlen(uri_args) + strlen(solr_op) + 4);
 320
 321     sprintf(path, "%s/%s?%s", hreq->path, solr_op, uri_args);
 322     hreq->path = path;
 323
 324     z_HTTP_header_add_content_type(encode, &hreq->headers,
 325                                    "text/xml", charset);
 326     return 0;
 327 }
 328
 329
 330 /*
 331  * Local variables:
 332  * c-basic-offset: 4
 333  * c-file-style: "Stroustrup"
 334  * indent-tabs-mode: nil
 335  * End:
 336  * vim: shiftwidth=4 tabstop=8 expandtab
 337  */
 338