src/zoom-sru.c

   1 /* This file is part of the YAZ toolkit.
   2  * Copyright (C) Index Data
   3  * See the file LICENSE for details.
   4  */
   5 /**
   6  * \file zoom-sru.c
   7  * \brief Implements ZOOM SRU
   8  */
   9 #if HAVE_CONFIG_H
  10 #include <config.h>
  11 #endif
  12
  13 #include <assert.h>
  14 #include <string.h>
  15 #include <errno.h>
  16 #include "zoom-p.h"
  17
  18 #include <yaz/log.h>
  19 #include <yaz/pquery.h>
  20
  21 #if YAZ_HAVE_XML2
  22 static void set_SRU_error(ZOOM_connection c, Z_SRW_diagnostic *d)
  23 {
  24     const char *uri = d->uri;
  25     if (uri)
  26         ZOOM_set_dset_error(c, ZOOM_uri_to_code(uri), uri, d->details, 0);
  27 }
  28 #endif
  29
  30
  31 #if YAZ_HAVE_XML2
  32 static zoom_ret send_srw(ZOOM_connection c, Z_SRW_PDU *sr)
  33 {
  34     Z_GDU *gdu;
  35     const char *database =  ZOOM_options_get(c->options, "databaseName");
  36
  37     gdu = z_get_HTTP_Request_uri(c->odr_out, c->host_port,
  38                                  database,
  39                                  c->proxy ? 1 : 0);
  40
  41     if (c->sru_mode == zoom_sru_get)
  42     {
  43         yaz_sru_get_encode(gdu->u.HTTP_Request, sr, c->odr_out, c->charset);
  44     }
  45     else if (c->sru_mode == zoom_sru_post)
  46     {
  47         yaz_sru_post_encode(gdu->u.HTTP_Request, sr, c->odr_out, c->charset);
  48     }
  49     else if (c->sru_mode == zoom_sru_soap)
  50     {
  51         yaz_sru_soap_encode(gdu->u.HTTP_Request, sr, c->odr_out, c->charset);
  52     }
  53     else if (c->sru_mode == zoom_sru_solr)
  54     {
  55         yaz_solr_encode_request(gdu->u.HTTP_Request, sr, c->odr_out, c->charset);
  56     }
  57     return ZOOM_send_GDU(c, gdu);
  58 }
  59 #endif
  60
  61 #if YAZ_HAVE_XML2
  62 static Z_SRW_PDU *ZOOM_srw_get_pdu(ZOOM_connection c, int type)
  63 {
  64     Z_SRW_PDU *sr = yaz_srw_get_pdu(c->odr_out, type, c->sru_version);
  65     if (c->url_authentication && c->user)
  66     {
  67         Z_SRW_extra_arg **ea = &sr->extra_args;
  68         while (*ea)
  69             ea = &(*ea)->next;
  70         *ea = (Z_SRW_extra_arg *) odr_malloc(c->odr_out, sizeof(**ea));
  71         (*ea)->name = "x-username";
  72         (*ea)->value = c->user;
  73         ea = &(*ea)->next;
  74         if (c->password)
  75         {
  76             *ea = (Z_SRW_extra_arg *) odr_malloc(c->odr_out, sizeof(**ea));
  77             (*ea)->name = "x-password";
  78             (*ea)->value = c->password;
  79             ea = &(*ea)->next;
  80         }
  81         *ea = 0;
  82     }
  83     else
  84     {
  85         sr->username = c->user;
  86         sr->password = c->password;
  87     }
  88     return sr;
  89 }
  90 #endif
  91
  92 #if YAZ_HAVE_XML2
  93 zoom_ret ZOOM_connection_srw_send_scan(ZOOM_connection c)
  94 {
  95     ZOOM_scanset scan;
  96     Z_SRW_PDU *sr = 0;
  97     const char *option_val = 0;
  98     Z_Query *z_query;
  99
 100     if (!c->tasks)
 101         return zoom_complete;
 102     assert (c->tasks->which == ZOOM_TASK_SCAN);
 103     scan = c->tasks->u.scan.scan;
 104
 105     sr = ZOOM_srw_get_pdu(c, Z_SRW_scan_request);
 106
 107     z_query = ZOOM_query_get_Z_Query(scan->query);
 108     /* SRU scan can only carry CQL and PQF */
 109     if (z_query->which == Z_Query_type_104)
 110     {
 111         sr->u.scan_request->queryType = "cql";
 112         sr->u.scan_request->scanClause =
 113             odr_strdup(c->odr_out, ZOOM_query_get_query_string(scan->query));
 114     }
 115     else if (z_query->which == Z_Query_type_1
 116              || z_query->which == Z_Query_type_101)
 117     {
 118         sr->u.scan_request->queryType = "pqf";
 119         sr->u.scan_request->scanClause =
 120             odr_strdup(c->odr_out, ZOOM_query_get_query_string(scan->query));
 121     }
 122     else
 123     {
 124         ZOOM_set_error(c, ZOOM_ERROR_UNSUPPORTED_QUERY, 0);
 125         return zoom_complete;
 126     }
 127
 128     sr->u.scan_request->maximumTerms = odr_intdup(
 129         c->odr_out, ZOOM_options_get_int(scan->options, "number", 10));
 130
 131     sr->u.scan_request->responsePosition = odr_intdup(
 132         c->odr_out, ZOOM_options_get_int(scan->options, "position", 1));
 133
 134     option_val = ZOOM_options_get(scan->options, "extraArgs");
 135     yaz_encode_sru_extra(sr, c->odr_out, option_val);
 136     return send_srw(c, sr);
 137 }
 138 #else
 139 zoom_ret ZOOM_connection_srw_send_scan(ZOOM_connection c)
 140 {
 141     return zoom_complete;
 142 }
 143 #endif
 144
 145 #if YAZ_HAVE_XML2
 146 zoom_ret ZOOM_connection_srw_send_search(ZOOM_connection c)
 147 {
 148     const char *facets = 0;
 149     int i;
 150     int *start, *count;
 151     ZOOM_resultset resultset = 0;
 152     Z_SRW_PDU *sr = 0;
 153     const char *option_val = 0;
 154     const char *schema = 0;
 155     Z_Query *z_query;
 156     Z_FacetList *facet_list = 0;
 157
 158     if (c->error)                  /* don't continue on error */
 159         return zoom_complete;
 160     assert(c->tasks);
 161     if (c->tasks->which != ZOOM_TASK_SEARCH)
 162         return zoom_complete;
 163
 164     resultset = c->tasks->u.search.resultset;
 165     if (!resultset->setname)
 166         resultset->setname = xstrdup("default");
 167     ZOOM_options_set(resultset->options, "setname", resultset->setname);
 168     start = &c->tasks->u.search.start;
 169     count = &c->tasks->u.search.count;
 170     facets = ZOOM_options_get(resultset->options, "facets");
 171     if (facets)
 172         facet_list = yaz_pqf_parse_facet_list(c->odr_out, facets);
 173     schema = c->tasks->u.search.schema;
 174
 175     if (resultset->live_set)
 176     {
 177         if (*start >= resultset->size)
 178             return zoom_complete;
 179         if (*start + *count > resultset->size)
 180             *count = resultset->size - *start;
 181     }
 182     for (i = 0; i < *count; i++)
 183     {
 184         ZOOM_record rec =
 185             ZOOM_record_cache_lookup(resultset, i + *start,
 186                                      c->tasks->u.search.syntax,
 187                                      c->tasks->u.search.elementSetName,
 188                                      schema);
 189         if (!rec)
 190             break;
 191         else
 192         {
 193             ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_RECV_RECORD);
 194             ZOOM_connection_put_event(c, event);
 195         }
 196     }
 197     *start += i;
 198     *count -= i;
 199
 200     if (*count == 0 && resultset->live_set)
 201         return zoom_complete;
 202
 203     assert(resultset->query);
 204
 205     sr = ZOOM_srw_get_pdu(c, Z_SRW_searchRetrieve_request);
 206     z_query = ZOOM_query_get_Z_Query(resultset->query);
 207
 208     if (z_query->which == Z_Query_type_104
 209         && z_query->u.type_104->which == Z_External_CQL)
 210     {
 211         sr->u.request->queryType = "cql";
 212         sr->u.request->query = z_query->u.type_104->u.cql;
 213     }
 214     else if (z_query->which == Z_Query_type_1 && z_query->u.type_1)
 215     {
 216         sr->u.request->queryType = "pqf";
 217         sr->u.request->query =
 218             odr_strdup(c->odr_out,
 219                        ZOOM_query_get_query_string(resultset->query));
 220     }
 221     else
 222     {
 223         ZOOM_set_error(c, ZOOM_ERROR_UNSUPPORTED_QUERY, 0);
 224         return zoom_complete;
 225     }
 226
 227     option_val = ZOOM_query_get_sru11(resultset->query);
 228     if (option_val)
 229     {
 230         sr->u.request->sort_type = Z_SRW_sort_type_sort;
 231         sr->u.request->sort.sortKeys = odr_strdup(c->odr_out, option_val);
 232     }
 233     sr->u.request->startRecord = odr_intdup(c->odr_out, *start + 1);
 234     sr->u.request->maximumRecords = odr_intdup(
 235         c->odr_out, (resultset->step > 0 && resultset->step < *count) ?
 236         resultset->step : *count);
 237     sr->u.request->recordSchema = odr_strdup_null(c->odr_out, schema);
 238     sr->u.request->facetList = facet_list;
 239
 240     option_val = ZOOM_resultset_option_get(resultset, "recordPacking");
 241     if (option_val)
 242         sr->u.request->recordPacking = odr_strdup(c->odr_out, option_val);
 243
 244     option_val = ZOOM_resultset_option_get(resultset, "extraArgs");
 245     yaz_encode_sru_extra(sr, c->odr_out, option_val);
 246     return send_srw(c, sr);
 247 }
 248 #else
 249 zoom_ret ZOOM_connection_srw_send_search(ZOOM_connection c)
 250 {
 251     return zoom_complete;
 252 }
 253 #endif
 254
 255 #if YAZ_HAVE_XML2
 256 static zoom_ret handle_srw_response(ZOOM_connection c,
 257                                     Z_SRW_searchRetrieveResponse *res)
 258 {
 259     ZOOM_resultset resultset = 0;
 260     int i;
 261     NMEM nmem;
 262     ZOOM_Event event;
 263     const char *syntax, *elementSetName, *schema;
 264
 265     if (!c->tasks)
 266         return zoom_complete;
 267
 268     if (c->tasks->which != ZOOM_TASK_SEARCH)
 269         return zoom_complete;
 270
 271     resultset = c->tasks->u.search.resultset;
 272     syntax = c->tasks->u.search.syntax;
 273     elementSetName = c->tasks->u.search.elementSetName;
 274     schema = c->tasks->u.search.schema;
 275
 276     if (resultset->live_set == 0)
 277     {
 278         event = ZOOM_Event_create(ZOOM_EVENT_RECV_SEARCH);
 279         ZOOM_connection_put_event(c, event);
 280     }
 281     if (res->facetList)
 282         ZOOM_handle_facet_list(resultset, res->facetList);
 283
 284     resultset->size = 0;
 285
 286     if (res->resultSetId)
 287         ZOOM_resultset_option_set(resultset, "resultSetId", res->resultSetId);
 288
 289     yaz_log(c->log_details, "%p handle_srw_response got SRW response OK", c);
 290
 291     if (res->num_diagnostics > 0)
 292     {
 293         resultset->live_set = 2;
 294         set_SRU_error(c, &res->diagnostics[0]);
 295     }
 296     else
 297     {
 298         if (res->numberOfRecords)
 299         {
 300             resultset->size = *res->numberOfRecords;
 301 #if HAVE_LIBMEMCACHED_MEMCACHED_H
 302             if (c->mc_st && resultset->live_set == 0)
 303             {
 304                 uint32_t flags = 0;
 305                 memcached_return_t rc;
 306                 time_t expiration = 36000;
 307                 char str[40];
 308
 309                 sprintf(str, ODR_INT_PRINTF, resultset->size);
 310                 rc = memcached_set(c->mc_st,
 311                                    wrbuf_buf(resultset->mc_key),wrbuf_len(resultset->mc_key),
 312                                    str, strlen(str), expiration, flags);
 313                 yaz_log(YLOG_LOG, "Store SRU hit count key=%s value=%s rc=%u %s",
 314                         wrbuf_cstr(resultset->mc_key), str, (unsigned) rc,
 315                         memcached_last_error_message(c->mc_st));
 316             }
 317 #endif
 318         }
 319         resultset->live_set = 2;
 320         if (res->suggestions)
 321             ZOOM_resultset_option_set(resultset, "suggestions",
 322                                       res->suggestions);
 323         for (i = 0; i < res->num_records; i++)
 324         {
 325             int pos = c->tasks->u.search.start + i;
 326             Z_SRW_record *sru_rec;
 327             Z_SRW_diagnostic *diag = 0;
 328             int num_diag;
 329
 330             /* only trust recordPosition if >= calculated position */
 331             if (res->records[i].recordPosition &&
 332                 *res->records[i].recordPosition >= pos + 1)
 333                 pos = *res->records[i].recordPosition - 1;
 334
 335             if (!ZOOM_record_cache_lookup(resultset,
 336                                           pos,
 337                                           syntax, elementSetName, schema))
 338             {
 339                 Z_NamePlusRecord *npr = (Z_NamePlusRecord *)
 340                     odr_malloc(c->odr_in, sizeof(Z_NamePlusRecord));
 341                 sru_rec = &res->records[i];
 342
 343                 npr->databaseName = 0;
 344                 npr->which = Z_NamePlusRecord_databaseRecord;
 345                 npr->u.databaseRecord = (Z_External *)
 346                     odr_malloc(c->odr_in, sizeof(Z_External));
 347                 npr->u.databaseRecord->descriptor = 0;
 348                 npr->u.databaseRecord->direct_reference =
 349                     odr_oiddup(c->odr_in, yaz_oid_recsyn_xml);
 350                 npr->u.databaseRecord->indirect_reference = 0;
 351                 npr->u.databaseRecord->which = Z_External_octet;
 352
 353                 npr->u.databaseRecord->u.octet_aligned =
 354                     odr_create_Odr_oct(c->odr_in,
 355                                        sru_rec->recordData_buf,
 356                                    sru_rec->recordData_len);
 357                 if (sru_rec->recordSchema
 358                     && !strcmp(sru_rec->recordSchema,
 359                                "info:srw/schema/1/diagnostics-v1.1"))
 360                 {
 361                     sru_decode_surrogate_diagnostics(sru_rec->recordData_buf,
 362                                                      sru_rec->recordData_len,
 363                                                      &diag, &num_diag,
 364                                                      resultset->odr);
 365                 }
 366                 ZOOM_record_cache_add(resultset, npr,
 367                                       pos, syntax, elementSetName,
 368                                       schema, diag);
 369             }
 370         }
 371         nmem = odr_extract_mem(c->odr_in);
 372         nmem_transfer(odr_getmem(resultset->odr), nmem);
 373         nmem_destroy(nmem);
 374
 375         return ZOOM_connection_srw_send_search(c);
 376     }
 377     return zoom_complete;
 378 }
 379 #endif
 380
 381 #if YAZ_HAVE_XML2
 382 static void handle_srw_scan_response(ZOOM_connection c,
 383                                      Z_SRW_scanResponse *res)
 384 {
 385     NMEM nmem = odr_extract_mem(c->odr_in);
 386     ZOOM_scanset scan;
 387
 388     if (!c->tasks || c->tasks->which != ZOOM_TASK_SCAN)
 389         return;
 390     scan = c->tasks->u.scan.scan;
 391
 392     if (res->num_diagnostics > 0)
 393         set_SRU_error(c, &res->diagnostics[0]);
 394
 395     scan->scan_response = 0;
 396     scan->srw_scan_response = res;
 397     nmem_transfer(odr_getmem(scan->odr), nmem);
 398
 399     ZOOM_options_set_int(scan->options, "number", res->num_terms);
 400     nmem_destroy(nmem);
 401 }
 402 #endif
 403
 404 int ZOOM_handle_sru(ZOOM_connection c, Z_HTTP_Response *hres,
 405                     zoom_ret *cret, char **addinfo)
 406 {
 407 #if YAZ_HAVE_XML2
 408     int ret = 0;
 409
 410     /* not redirect (normal response) */
 411     if (!yaz_srw_check_content_type(hres))
 412     {
 413         *addinfo = "content-type";
 414         ret = -1;
 415     }
 416     else if (c->sru_mode == zoom_sru_solr)
 417     {
 418         Z_SRW_PDU *sr;
 419         ret = yaz_solr_decode_response(c->odr_in, hres, &sr);
 420         if (ret == 0)
 421         {
 422             if (sr->which == Z_SRW_searchRetrieve_response)
 423                 *cret = handle_srw_response(c, sr->u.response);
 424             else if (sr->which == Z_SRW_scan_response)
 425                 handle_srw_scan_response(c, sr->u.scan_response);
 426         }
 427     }
 428     else
 429     {
 430         Z_SOAP *soap_package = 0;
 431         ODR o = c->odr_in;
 432         Z_SOAP_Handler soap_handlers[4] = {
 433             {YAZ_XMLNS_SRU_v1_response, 0, (Z_SOAP_fun) yaz_srw_codec},
 434             {YAZ_XMLNS_SRU_v2_mask, 0, (Z_SOAP_fun) yaz_srw_codec},
 435             {"searchRetrieveResponse", 0, (Z_SOAP_fun) yaz_srw_codec},
 436             {0, 0, 0}
 437         };
 438         ret = z_soap_codec(o, &soap_package,
 439                            &hres->content_buf, &hres->content_len,
 440                            soap_handlers);
 441         if (!ret && soap_package->which == Z_SOAP_generic)
 442         {
 443             Z_SRW_PDU *sr = (Z_SRW_PDU*) soap_package->u.generic->p;
 444
 445             ZOOM_options_set(c->options, "sru_version", sr->srw_version);
 446             ZOOM_options_setl(c->options, "sru_extra_response_data",
 447                               sr->extraResponseData_buf, sr->extraResponseData_len);
 448             if (sr->which == Z_SRW_searchRetrieve_response)
 449                 *cret = handle_srw_response(c, sr->u.response);
 450             else if (sr->which == Z_SRW_scan_response)
 451                 handle_srw_scan_response(c, sr->u.scan_response);
 452             else
 453                 ret = -1;
 454         }
 455         else if (!ret && (soap_package->which == Z_SOAP_fault
 456                           || soap_package->which == Z_SOAP_error))
 457         {
 458             ZOOM_set_HTTP_error(c, hres->code,
 459                                 soap_package->u.fault->fault_code,
 460                                 soap_package->u.fault->fault_string);
 461         }
 462         else
 463         {
 464             size_t max_chars = 1000;
 465             size_t sz = hres->content_len;
 466             if (sz > max_chars - 1)
 467                 sz = max_chars;
 468             *addinfo = odr_malloc(c->odr_in, sz + 4);
 469             memcpy(*addinfo, hres->content_buf, sz);
 470             if (sz == max_chars)
 471                 strcpy(*addinfo + sz, "...");
 472             else
 473                 strcpy(*addinfo + sz, "");
 474             ret = -1;
 475         }
 476     }
 477     return ret;
 478 #else
 479     return -1;
 480 #endif
 481 }
 482
 483 /*
 484  * Local variables:
 485  * c-basic-offset: 4
 486  * c-file-style: "Stroustrup"
 487  * indent-tabs-mode: nil
 488  * End:
 489  * vim: shiftwidth=4 tabstop=8 expandtab
 490  */
 491