src/zoom-sru.c

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