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     if (c->error)                  /* don't continue on error */
 158         return zoom_complete;
 159     assert(c->tasks);
 160     switch(c->tasks->which)
 161     {
 162     case ZOOM_TASK_SEARCH:
 163         resultset = c->tasks->u.search.resultset;
 164         if (!resultset->setname)
 165             resultset->setname = xstrdup("default");
 166         ZOOM_options_set(resultset->options, "setname", resultset->setname);
 167         start = &c->tasks->u.search.start;
 168         count = &c->tasks->u.search.count;
 169         facets = ZOOM_options_get(resultset->options, "facets");
 170         if (facets)
 171             facet_list = yaz_pqf_parse_facet_list(c->odr_out, facets);
 172         schema = c->tasks->u.search.schema;
 173         break;
 174
 175         if (*start >= resultset->size)
 176             return zoom_complete;
 177         if (*start + *count > resultset->size)
 178             *count = resultset->size - *start;
 179
 180         for (i = 0; i < *count; i++)
 181         {
 182             ZOOM_record rec =
 183                 ZOOM_record_cache_lookup(resultset, i + *start,
 184                                          c->tasks->u.search.syntax,
 185                                          c->tasks->u.search.elementSetName,
 186                                          schema);
 187             if (!rec)
 188                 break;
 189             else
 190             {
 191                 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_RECV_RECORD);
 192                 ZOOM_connection_put_event(c, event);
 193             }
 194         }
 195         *start += i;
 196         *count -= i;
 197
 198         if (*count == 0)
 199             return zoom_complete;
 200         break;
 201     default:
 202         return zoom_complete;
 203     }
 204     assert(resultset->query);
 205
 206     sr = ZOOM_srw_get_pdu(c, Z_SRW_searchRetrieve_request);
 207     z_query = ZOOM_query_get_Z_Query(resultset->query);
 208
 209     if (z_query->which == Z_Query_type_104
 210         && z_query->u.type_104->which == Z_External_CQL)
 211     {
 212         sr->u.request->queryType = "cql";
 213         sr->u.request->query = z_query->u.type_104->u.cql;
 214     }
 215     else if (z_query->which == Z_Query_type_1 && z_query->u.type_1)
 216     {
 217         sr->u.request->queryType = "pqf";
 218         sr->u.request->query =
 219             odr_strdup(c->odr_out,
 220                        ZOOM_query_get_query_string(resultset->query));
 221     }
 222     else
 223     {
 224         ZOOM_set_error(c, ZOOM_ERROR_UNSUPPORTED_QUERY, 0);
 225         return zoom_complete;
 226     }
 227
 228     option_val = ZOOM_query_get_sru11(resultset->query);
 229     if (option_val)
 230     {
 231         sr->u.request->sort_type = Z_SRW_sort_type_sort;
 232         sr->u.request->sort.sortKeys = odr_strdup(c->odr_out, option_val);
 233     }
 234     sr->u.request->startRecord = odr_intdup(c->odr_out, *start + 1);
 235     sr->u.request->maximumRecords = odr_intdup(
 236         c->odr_out, (resultset->step > 0 && resultset->step < *count) ?
 237         resultset->step : *count);
 238     sr->u.request->recordSchema = odr_strdup_null(c->odr_out, schema);
 239     sr->u.request->facetList = facet_list;
 240
 241     option_val = ZOOM_resultset_option_get(resultset, "recordPacking");
 242     if (option_val)
 243         sr->u.request->recordPacking = odr_strdup(c->odr_out, option_val);
 244
 245     option_val = ZOOM_resultset_option_get(resultset, "extraArgs");
 246     yaz_encode_sru_extra(sr, c->odr_out, option_val);
 247     return send_srw(c, sr);
 248 }
 249 #else
 250 zoom_ret ZOOM_connection_srw_send_search(ZOOM_connection c)
 251 {
 252     return zoom_complete;
 253 }
 254 #endif
 255
 256 #if YAZ_HAVE_XML2
 257 static zoom_ret handle_srw_response(ZOOM_connection c,
 258                                     Z_SRW_searchRetrieveResponse *res)
 259 {
 260     ZOOM_resultset resultset = 0;
 261     int i;
 262     NMEM nmem;
 263     ZOOM_Event event;
 264     int *start, *count;
 265     const char *syntax, *elementSetName, *schema;
 266
 267     if (!c->tasks)
 268         return zoom_complete;
 269
 270     switch(c->tasks->which)
 271     {
 272     case ZOOM_TASK_SEARCH:
 273         resultset = c->tasks->u.search.resultset;
 274         start = &c->tasks->u.search.start;
 275         count = &c->tasks->u.search.count;
 276         syntax = c->tasks->u.search.syntax;
 277         elementSetName = c->tasks->u.search.elementSetName;
 278         schema = c->tasks->u.search.schema;
 279         /* Required not for reporting client hit count multiple times into session */
 280         if (!c->tasks->u.search.recv_search_fired) {
 281             yaz_log(YLOG_DEBUG, "posting ZOOM_EVENT_RECV_SEARCH");
 282             event = ZOOM_Event_create(ZOOM_EVENT_RECV_SEARCH);
 283             ZOOM_connection_put_event(c, event);
 284             c->tasks->u.search.recv_search_fired = 1;
 285         }
 286         if (res->facetList)
 287             ZOOM_handle_facet_list(resultset, res->facetList);
 288         break;
 289     default:
 290         return zoom_complete;
 291     }
 292
 293     resultset->size = 0;
 294
 295     if (res->resultSetId)
 296         ZOOM_resultset_option_set(resultset, "resultSetId", res->resultSetId);
 297
 298     yaz_log(c->log_details, "%p handle_srw_response got SRW response OK", c);
 299
 300     if (res->num_diagnostics > 0)
 301     {
 302         set_SRU_error(c, &res->diagnostics[0]);
 303     }
 304     else
 305     {
 306         if (res->numberOfRecords) {
 307             resultset->size = *res->numberOfRecords;
 308         }
 309         if (res->suggestions) {
 310             ZOOM_resultset_option_set(resultset, "suggestions", res->suggestions);
 311         }
 312         for (i = 0; i<res->num_records; i++)
 313         {
 314             int pos = *start + i;
 315             Z_SRW_record *sru_rec;
 316             Z_SRW_diagnostic *diag = 0;
 317             int num_diag;
 318
 319             Z_NamePlusRecord *npr = (Z_NamePlusRecord *)
 320                 odr_malloc(c->odr_in, sizeof(Z_NamePlusRecord));
 321
 322             /* only trust recordPosition if >= calculated position */
 323             if (res->records[i].recordPosition &&
 324                 *res->records[i].recordPosition >= pos + 1)
 325                 pos = *res->records[i].recordPosition - 1;
 326
 327             sru_rec = &res->records[i];
 328
 329             npr->databaseName = 0;
 330             npr->which = Z_NamePlusRecord_databaseRecord;
 331             npr->u.databaseRecord = (Z_External *)
 332                 odr_malloc(c->odr_in, sizeof(Z_External));
 333             npr->u.databaseRecord->descriptor = 0;
 334             npr->u.databaseRecord->direct_reference =
 335                 odr_oiddup(c->odr_in, yaz_oid_recsyn_xml);
 336             npr->u.databaseRecord->indirect_reference = 0;
 337             npr->u.databaseRecord->which = Z_External_octet;
 338
 339             npr->u.databaseRecord->u.octet_aligned =
 340                 odr_create_Odr_oct(c->odr_in,
 341                                    sru_rec->recordData_buf,
 342                                    sru_rec->recordData_len);
 343             if (sru_rec->recordSchema
 344                 && !strcmp(sru_rec->recordSchema,
 345                            "info:srw/schema/1/diagnostics-v1.1"))
 346             {
 347                 sru_decode_surrogate_diagnostics(sru_rec->recordData_buf,
 348                                                  sru_rec->recordData_len,
 349                                                  &diag, &num_diag,
 350                                                  resultset->odr);
 351             }
 352             ZOOM_record_cache_add(resultset, npr, pos, syntax, elementSetName,
 353                                   schema, diag);
 354         }
 355         *count -= i;
 356         *start += i;
 357         if (*count + *start > resultset->size)
 358             *count = resultset->size - *start;
 359         yaz_log(YLOG_DEBUG, "SRU result set size " ODR_INT_PRINTF " start %d count %d", resultset->size, *start, *count);
 360         if (*count < 0)
 361             *count = 0;
 362         nmem = odr_extract_mem(c->odr_in);
 363         nmem_transfer(odr_getmem(resultset->odr), nmem);
 364         nmem_destroy(nmem);
 365
 366         if (*count > 0)
 367             return ZOOM_connection_srw_send_search(c);
 368     }
 369     return zoom_complete;
 370 }
 371 #endif
 372
 373 #if YAZ_HAVE_XML2
 374 static void handle_srw_scan_response(ZOOM_connection c,
 375                                      Z_SRW_scanResponse *res)
 376 {
 377     NMEM nmem = odr_extract_mem(c->odr_in);
 378     ZOOM_scanset scan;
 379
 380     if (!c->tasks || c->tasks->which != ZOOM_TASK_SCAN)
 381         return;
 382     scan = c->tasks->u.scan.scan;
 383
 384     if (res->num_diagnostics > 0)
 385         set_SRU_error(c, &res->diagnostics[0]);
 386
 387     scan->scan_response = 0;
 388     scan->srw_scan_response = res;
 389     nmem_transfer(odr_getmem(scan->odr), nmem);
 390
 391     ZOOM_options_set_int(scan->options, "number", res->num_terms);
 392     nmem_destroy(nmem);
 393 }
 394 #endif
 395
 396 int ZOOM_handle_sru(ZOOM_connection c, Z_HTTP_Response *hres,
 397                     zoom_ret *cret, char **addinfo)
 398 {
 399 #if YAZ_HAVE_XML2
 400     int ret = 0;
 401
 402     /* not redirect (normal response) */
 403     if (!yaz_srw_check_content_type(hres))
 404     {
 405         *addinfo = "content-type";
 406         ret = -1;
 407     }
 408     else if (c->sru_mode == zoom_sru_solr)
 409     {
 410         Z_SRW_PDU *sr;
 411         ret = yaz_solr_decode_response(c->odr_in, hres, &sr);
 412         if (ret == 0)
 413         {
 414             if (sr->which == Z_SRW_searchRetrieve_response)
 415                 *cret = handle_srw_response(c, sr->u.response);
 416             else if (sr->which == Z_SRW_scan_response)
 417                 handle_srw_scan_response(c, sr->u.scan_response);
 418         }
 419     }
 420     else
 421     {
 422         Z_SOAP *soap_package = 0;
 423         ODR o = c->odr_in;
 424         Z_SOAP_Handler soap_handlers[4] = {
 425             {YAZ_XMLNS_SRU_v1_response, 0, (Z_SOAP_fun) yaz_srw_codec},
 426             {YAZ_XMLNS_SRU_v2_mask, 0, (Z_SOAP_fun) yaz_srw_codec},
 427             {"searchRetrieveResponse", 0, (Z_SOAP_fun) yaz_srw_codec},
 428             {0, 0, 0}
 429         };
 430         ret = z_soap_codec(o, &soap_package,
 431                            &hres->content_buf, &hres->content_len,
 432                            soap_handlers);
 433         if (!ret && soap_package->which == Z_SOAP_generic)
 434         {
 435             Z_SRW_PDU *sr = (Z_SRW_PDU*) soap_package->u.generic->p;
 436
 437             ZOOM_options_set(c->options, "sru_version", sr->srw_version);
 438             ZOOM_options_setl(c->options, "sru_extra_response_data",
 439                               sr->extraResponseData_buf, sr->extraResponseData_len);
 440             if (sr->which == Z_SRW_searchRetrieve_response)
 441                 *cret = handle_srw_response(c, sr->u.response);
 442             else if (sr->which == Z_SRW_scan_response)
 443                 handle_srw_scan_response(c, sr->u.scan_response);
 444             else
 445                 ret = -1;
 446         }
 447         else if (!ret && (soap_package->which == Z_SOAP_fault
 448                           || soap_package->which == Z_SOAP_error))
 449         {
 450             ZOOM_set_HTTP_error(c, hres->code,
 451                                 soap_package->u.fault->fault_code,
 452                                 soap_package->u.fault->fault_string);
 453         }
 454         else
 455         {
 456             size_t max_chars = 1000;
 457             size_t sz = hres->content_len;
 458             if (sz > max_chars - 1)
 459                 sz = max_chars;
 460             *addinfo = odr_malloc(c->odr_in, sz + 4);
 461             memcpy(*addinfo, hres->content_buf, sz);
 462             if (sz == max_chars)
 463                 strcpy(*addinfo + sz, "...");
 464             else
 465                 strcpy(*addinfo + sz, "");
 466             ret = -1;
 467         }
 468     }
 469     return ret;
 470 #else
 471     return -1;
 472 #endif
 473 }
 474
 475 /*
 476  * Local variables:
 477  * c-basic-offset: 4
 478  * c-file-style: "Stroustrup"
 479  * indent-tabs-mode: nil
 480  * End:
 481  * vim: shiftwidth=4 tabstop=8 expandtab
 482  */
 483