src/zoom-sru.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 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     char *fdatabase = 0;
  40
  41     if (database)
  42         fdatabase = yaz_encode_sru_dbpath_odr(c->odr_out, database);
  43     gdu = z_get_HTTP_Request_host_path(c->odr_out, c->host_port,
  44                                        fdatabase ? fdatabase : c->path);
  45
  46     if (c->sru_mode == zoom_sru_get)
  47     {
  48         yaz_sru_get_encode(gdu->u.HTTP_Request, sr, c->odr_out, c->charset);
  49     }
  50     else if (c->sru_mode == zoom_sru_post)
  51     {
  52         yaz_sru_post_encode(gdu->u.HTTP_Request, sr, c->odr_out, c->charset);
  53     }
  54     else if (c->sru_mode == zoom_sru_soap)
  55     {
  56         yaz_sru_soap_encode(gdu->u.HTTP_Request, sr, c->odr_out, c->charset);
  57     }
  58     else if (c->sru_mode == zoom_sru_solr)
  59     {
  60         yaz_solr_encode_request(gdu->u.HTTP_Request, sr, c->odr_out, c->charset);
  61     }
  62     if (!z_GDU(c->odr_out, &gdu, 0, 0))
  63         return zoom_complete;
  64     if (c->odr_print)
  65         z_GDU(c->odr_print, &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             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             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         }
 165         break;
 166     case ZOOM_TASK_RETRIEVE:
 167         resultset = c->tasks->u.retrieve.resultset;
 168
 169         start = &c->tasks->u.retrieve.start;
 170         count = &c->tasks->u.retrieve.count;
 171
 172         if (*start >= resultset->size)
 173             return zoom_complete;
 174         if (*start + *count > resultset->size)
 175             *count = resultset->size - *start;
 176
 177         for (i = 0; i < *count; i++)
 178         {
 179             ZOOM_record rec =
 180                 ZOOM_record_cache_lookup(resultset, i + *start,
 181                                          c->tasks->u.retrieve.syntax,
 182                                          c->tasks->u.retrieve.elementSetName);
 183             if (!rec)
 184                 break;
 185             else
 186             {
 187                 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_RECV_RECORD);
 188                 ZOOM_connection_put_event(c, event);
 189             }
 190         }
 191         *start += i;
 192         *count -= i;
 193
 194         if (*count == 0)
 195             return zoom_complete;
 196         break;
 197     default:
 198         return zoom_complete;
 199     }
 200     assert(resultset->query);
 201
 202     sr = ZOOM_srw_get_pdu(c, Z_SRW_searchRetrieve_request);
 203     z_query = ZOOM_query_get_Z_Query(resultset->query);
 204
 205     if (z_query->which == Z_Query_type_104
 206         && z_query->u.type_104->which == Z_External_CQL)
 207     {
 208         sr->u.request->query_type = Z_SRW_query_type_cql;
 209         sr->u.request->query.cql = z_query->u.type_104->u.cql;
 210     }
 211     else if (z_query->which == Z_Query_type_1 && z_query->u.type_1)
 212     {
 213         sr->u.request->query_type = Z_SRW_query_type_pqf;
 214         sr->u.request->query.pqf =
 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     sr->u.request->startRecord = odr_intdup(c->odr_out, *start + 1);
 223     sr->u.request->maximumRecords = odr_intdup(
 224         c->odr_out, (resultset->step > 0 && resultset->step < *count) ?
 225         resultset->step : *count);
 226     sr->u.request->recordSchema = resultset->schema;
 227     sr->u.request->facetList = facet_list;
 228
 229     option_val = ZOOM_resultset_option_get(resultset, "recordPacking");
 230     if (option_val)
 231         sr->u.request->recordPacking = odr_strdup(c->odr_out, option_val);
 232
 233     option_val = ZOOM_resultset_option_get(resultset, "extraArgs");
 234     yaz_encode_sru_extra(sr, c->odr_out, option_val);
 235     return send_srw(c, sr);
 236 }
 237 #else
 238 zoom_ret ZOOM_connection_srw_send_search(ZOOM_connection c)
 239 {
 240     return zoom_complete;
 241 }
 242 #endif
 243
 244 #if YAZ_HAVE_XML2
 245 static zoom_ret handle_srw_response(ZOOM_connection c,
 246                                     Z_SRW_searchRetrieveResponse *res)
 247 {
 248     ZOOM_resultset resultset = 0;
 249     int i;
 250     NMEM nmem;
 251     ZOOM_Event event;
 252     int *start, *count;
 253     const char *syntax, *elementSetName;
 254
 255     if (!c->tasks)
 256         return zoom_complete;
 257
 258     switch(c->tasks->which)
 259     {
 260     case ZOOM_TASK_SEARCH:
 261         resultset = c->tasks->u.search.resultset;
 262         start = &c->tasks->u.search.start;
 263         count = &c->tasks->u.search.count;
 264         syntax = c->tasks->u.search.syntax;
 265         elementSetName = c->tasks->u.search.elementSetName;
 266
 267         /* Required not for reporting client hit count multiple times into session */
 268         if (!c->tasks->u.search.recv_search_fired) {
 269             yaz_log(YLOG_DEBUG, "posting ZOOM_EVENT_RECV_SEARCH");
 270             event = ZOOM_Event_create(ZOOM_EVENT_RECV_SEARCH);
 271             ZOOM_connection_put_event(c, event);
 272             c->tasks->u.search.recv_search_fired = 1;
 273         }
 274         if (res->facetList)
 275             handle_facet_list(resultset, res->facetList);
 276         break;
 277     case ZOOM_TASK_RETRIEVE:
 278         resultset = c->tasks->u.retrieve.resultset;
 279         start = &c->tasks->u.retrieve.start;
 280         count = &c->tasks->u.retrieve.count;
 281         syntax = c->tasks->u.retrieve.syntax;
 282         elementSetName = c->tasks->u.retrieve.elementSetName;
 283         break;
 284     default:
 285         return zoom_complete;
 286     }
 287
 288     resultset->size = 0;
 289
 290     if (res->resultSetId)
 291         ZOOM_resultset_option_set(resultset, "resultSetId", res->resultSetId);
 292
 293     yaz_log(c->log_details, "%p handle_srw_response got SRW response OK", c);
 294
 295     if (res->num_diagnostics > 0)
 296     {
 297         set_SRU_error(c, &res->diagnostics[0]);
 298     }
 299     else
 300     {
 301         if (res->numberOfRecords) {
 302             resultset->size = *res->numberOfRecords;
 303         }
 304         for (i = 0; i<res->num_records; i++)
 305         {
 306             int pos;
 307             Z_SRW_record *sru_rec;
 308             Z_SRW_diagnostic *diag = 0;
 309             int num_diag;
 310
 311             Z_NamePlusRecord *npr = (Z_NamePlusRecord *)
 312                 odr_malloc(c->odr_in, sizeof(Z_NamePlusRecord));
 313             /*
 314              * TODO This does not work with 0-based recordPositions.
 315              * We will iterate over one twice
 316              */
 317             if (res->records[i].recordPosition &&
 318                 *res->records[i].recordPosition > 0)
 319                 pos = *res->records[i].recordPosition - 1;
 320             else
 321                 pos = *start + i;
 322
 323             sru_rec = &res->records[i];
 324
 325             npr->databaseName = 0;
 326             npr->which = Z_NamePlusRecord_databaseRecord;
 327             npr->u.databaseRecord = (Z_External *)
 328                 odr_malloc(c->odr_in, sizeof(Z_External));
 329             npr->u.databaseRecord->descriptor = 0;
 330             npr->u.databaseRecord->direct_reference =
 331                 odr_oiddup(c->odr_in, yaz_oid_recsyn_xml);
 332             npr->u.databaseRecord->which = Z_External_octet;
 333
 334             npr->u.databaseRecord->u.octet_aligned = (Odr_oct *)
 335                 odr_malloc(c->odr_in, sizeof(Odr_oct));
 336             npr->u.databaseRecord->u.octet_aligned->buf = (unsigned char*)
 337                 sru_rec->recordData_buf;
 338             npr->u.databaseRecord->u.octet_aligned->len =
 339                 npr->u.databaseRecord->u.octet_aligned->size =
 340                 sru_rec->recordData_len;
 341
 342             if (sru_rec->recordSchema
 343                 && !strcmp(sru_rec->recordSchema,
 344                            "info:srw/schema/1/diagnostics-v1.1"))
 345             {
 346                 sru_decode_surrogate_diagnostics(sru_rec->recordData_buf,
 347                                                  sru_rec->recordData_len,
 348                                                  &diag, &num_diag,
 349                                                  resultset->odr);
 350             }
 351             ZOOM_record_cache_add(resultset, npr, pos, syntax, elementSetName,
 352                                   sru_rec->recordSchema, diag);
 353         }
 354         *count -= i;
 355         *start += i;
 356         if (*count + *start > resultset->size)
 357             *count = resultset->size - *start;
 358         yaz_log(YLOG_DEBUG, "SRU result set size " ODR_INT_PRINTF " start %d count %d", resultset->size, *start, *count);
 359         if (*count < 0)
 360             *count = 0;
 361         nmem = odr_extract_mem(c->odr_in);
 362         nmem_transfer(odr_getmem(resultset->odr), nmem);
 363         nmem_destroy(nmem);
 364
 365         if (*count > 0)
 366             return ZOOM_connection_srw_send_search(c);
 367     }
 368     return zoom_complete;
 369 }
 370 #endif
 371
 372 #if YAZ_HAVE_XML2
 373 static void handle_srw_scan_response(ZOOM_connection c,
 374                                      Z_SRW_scanResponse *res)
 375 {
 376     NMEM nmem = odr_extract_mem(c->odr_in);
 377     ZOOM_scanset scan;
 378
 379     if (!c->tasks || c->tasks->which != ZOOM_TASK_SCAN)
 380         return;
 381     scan = c->tasks->u.scan.scan;
 382
 383     if (res->num_diagnostics > 0)
 384         set_SRU_error(c, &res->diagnostics[0]);
 385
 386     scan->scan_response = 0;
 387     scan->srw_scan_response = res;
 388     nmem_transfer(odr_getmem(scan->odr), nmem);
 389
 390     ZOOM_options_set_int(scan->options, "number", res->num_terms);
 391     nmem_destroy(nmem);
 392 }
 393 #endif
 394
 395 int ZOOM_handle_sru(ZOOM_connection c, Z_HTTP_Response *hres,
 396                     zoom_ret *cret)
 397 {
 398 #if YAZ_HAVE_XML2
 399     int ret = 0;
 400     const char *addinfo = 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             if (sr->which == Z_SRW_searchRetrieve_response)
 414                 *cret = handle_srw_response(c, sr->u.response);
 415     }
 416     else
 417     {
 418         Z_SOAP *soap_package = 0;
 419         ODR o = c->odr_in;
 420         Z_SOAP_Handler soap_handlers[2] = {
 421             {YAZ_XMLNS_SRU_v1_1, 0, (Z_SOAP_fun) yaz_srw_codec},
 422             {0, 0, 0}
 423         };
 424         ret = z_soap_codec(o, &soap_package,
 425                            &hres->content_buf, &hres->content_len,
 426                            soap_handlers);
 427         if (!ret && soap_package->which == Z_SOAP_generic &&
 428             soap_package->u.generic->no == 0)
 429         {
 430             Z_SRW_PDU *sr = (Z_SRW_PDU*) soap_package->u.generic->p;
 431
 432             ZOOM_options_set(c->options, "sru_version", sr->srw_version);
 433             ZOOM_options_setl(c->options, "sru_extra_response_data",
 434                               sr->extraResponseData_buf, sr->extraResponseData_len);
 435             if (sr->which == Z_SRW_searchRetrieve_response)
 436                 *cret = handle_srw_response(c, sr->u.response);
 437             else if (sr->which == Z_SRW_scan_response)
 438                 handle_srw_scan_response(c, sr->u.scan_response);
 439             else
 440                 ret = -1;
 441         }
 442         else if (!ret && (soap_package->which == Z_SOAP_fault
 443                           || soap_package->which == Z_SOAP_error))
 444         {
 445             ZOOM_set_HTTP_error(c, hres->code,
 446                                 soap_package->u.fault->fault_code,
 447                                 soap_package->u.fault->fault_string);
 448         }
 449         else
 450             ret = -1;
 451     }
 452     return ret;
 453 #else
 454     return -1;
 455 #endif
 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