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         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             ZOOM_query_get_query_string(resultset->query);
 215     }
 216     else
 217     {
 218         ZOOM_set_error(c, ZOOM_ERROR_UNSUPPORTED_QUERY, 0);
 219         return zoom_complete;
 220     }
 221     sr->u.request->startRecord = odr_intdup(c->odr_out, *start + 1);
 222     sr->u.request->maximumRecords = odr_intdup(
 223         c->odr_out, (resultset->step > 0 && resultset->step < *count) ?
 224         resultset->step : *count);
 225     sr->u.request->recordSchema = resultset->schema;
 226     sr->u.request->facetList = facet_list;
 227
 228     option_val = ZOOM_resultset_option_get(resultset, "recordPacking");
 229     if (option_val)
 230         sr->u.request->recordPacking = odr_strdup(c->odr_out, option_val);
 231
 232     option_val = ZOOM_resultset_option_get(resultset, "extraArgs");
 233     yaz_encode_sru_extra(sr, c->odr_out, option_val);
 234     return send_srw(c, sr);
 235 }
 236 #else
 237 zoom_ret ZOOM_connection_srw_send_search(ZOOM_connection c)
 238 {
 239     return zoom_complete;
 240 }
 241 #endif
 242
 243 #if YAZ_HAVE_XML2
 244 static zoom_ret handle_srw_response(ZOOM_connection c,
 245                                     Z_SRW_searchRetrieveResponse *res)
 246 {
 247     ZOOM_resultset resultset = 0;
 248     int i;
 249     NMEM nmem;
 250     ZOOM_Event event;
 251     int *start, *count;
 252     const char *syntax, *elementSetName;
 253
 254     if (!c->tasks)
 255         return zoom_complete;
 256
 257     switch(c->tasks->which)
 258     {
 259     case ZOOM_TASK_SEARCH:
 260         resultset = c->tasks->u.search.resultset;
 261         start = &c->tasks->u.search.start;
 262         count = &c->tasks->u.search.count;
 263         syntax = c->tasks->u.search.syntax;
 264         elementSetName = c->tasks->u.search.elementSetName;
 265
 266         /* Required not for reporting client hit count multiple times into session */
 267         if (!c->tasks->u.search.recv_search_fired) {
 268             yaz_log(YLOG_DEBUG, "posting ZOOM_EVENT_RECV_SEARCH");
 269             event = ZOOM_Event_create(ZOOM_EVENT_RECV_SEARCH);
 270             ZOOM_connection_put_event(c, event);
 271             c->tasks->u.search.recv_search_fired = 1;
 272         }
 273         if (res->facetList)
 274             handle_facet_list(resultset, res->facetList);
 275         break;
 276     case ZOOM_TASK_RETRIEVE:
 277         resultset = c->tasks->u.retrieve.resultset;
 278         start = &c->tasks->u.retrieve.start;
 279         count = &c->tasks->u.retrieve.count;
 280         syntax = c->tasks->u.retrieve.syntax;
 281         elementSetName = c->tasks->u.retrieve.elementSetName;
 282         break;
 283     default:
 284         return zoom_complete;
 285     }
 286
 287     resultset->size = 0;
 288
 289     if (res->resultSetId)
 290         ZOOM_resultset_option_set(resultset, "resultSetId", res->resultSetId);
 291
 292     yaz_log(c->log_details, "%p handle_srw_response got SRW response OK", c);
 293
 294     if (res->num_diagnostics > 0)
 295     {
 296         set_SRU_error(c, &res->diagnostics[0]);
 297     }
 298     else
 299     {
 300         if (res->numberOfRecords) {
 301             resultset->size = *res->numberOfRecords;
 302         }
 303         for (i = 0; i<res->num_records; i++)
 304         {
 305             int pos;
 306             Z_SRW_record *sru_rec;
 307             Z_SRW_diagnostic *diag = 0;
 308             int num_diag;
 309
 310             Z_NamePlusRecord *npr = (Z_NamePlusRecord *)
 311                 odr_malloc(c->odr_in, sizeof(Z_NamePlusRecord));
 312             /*
 313              * TODO This does not work with 0-based recordPositions.
 314              * We will iterate over one twice
 315              */
 316             if (res->records[i].recordPosition &&
 317                 *res->records[i].recordPosition > 0)
 318                 pos = *res->records[i].recordPosition - 1;
 319             else
 320                 pos = *start + i;
 321
 322             sru_rec = &res->records[i];
 323
 324             npr->databaseName = 0;
 325             npr->which = Z_NamePlusRecord_databaseRecord;
 326             npr->u.databaseRecord = (Z_External *)
 327                 odr_malloc(c->odr_in, sizeof(Z_External));
 328             npr->u.databaseRecord->descriptor = 0;
 329             npr->u.databaseRecord->direct_reference =
 330                 odr_oiddup(c->odr_in, yaz_oid_recsyn_xml);
 331             npr->u.databaseRecord->which = Z_External_octet;
 332
 333             npr->u.databaseRecord->u.octet_aligned = (Odr_oct *)
 334                 odr_malloc(c->odr_in, sizeof(Odr_oct));
 335             npr->u.databaseRecord->u.octet_aligned->buf = (unsigned char*)
 336                 sru_rec->recordData_buf;
 337             npr->u.databaseRecord->u.octet_aligned->len =
 338                 npr->u.databaseRecord->u.octet_aligned->size =
 339                 sru_rec->recordData_len;
 340
 341             if (sru_rec->recordSchema
 342                 && !strcmp(sru_rec->recordSchema,
 343                            "info:srw/schema/1/diagnostics-v1.1"))
 344             {
 345                 sru_decode_surrogate_diagnostics(sru_rec->recordData_buf,
 346                                                  sru_rec->recordData_len,
 347                                                  &diag, &num_diag,
 348                                                  resultset->odr);
 349             }
 350             ZOOM_record_cache_add(resultset, npr, pos, syntax, elementSetName,
 351                                   sru_rec->recordSchema, diag);
 352         }
 353         *count -= i;
 354         *start += i;
 355         if (*count + *start > resultset->size)
 356             *count = resultset->size - *start;
 357         yaz_log(YLOG_DEBUG, "SRU result set size " ODR_INT_PRINTF " start %d count %d", resultset->size, *start, *count);
 358         if (*count < 0)
 359             *count = 0;
 360         nmem = odr_extract_mem(c->odr_in);
 361         nmem_transfer(odr_getmem(resultset->odr), nmem);
 362         nmem_destroy(nmem);
 363
 364         if (*count > 0)
 365             return ZOOM_connection_srw_send_search(c);
 366     }
 367     return zoom_complete;
 368 }
 369 #endif
 370
 371 #if YAZ_HAVE_XML2
 372 static void handle_srw_scan_response(ZOOM_connection c,
 373                                      Z_SRW_scanResponse *res)
 374 {
 375     NMEM nmem = odr_extract_mem(c->odr_in);
 376     ZOOM_scanset scan;
 377
 378     if (!c->tasks || c->tasks->which != ZOOM_TASK_SCAN)
 379         return;
 380     scan = c->tasks->u.scan.scan;
 381
 382     if (res->num_diagnostics > 0)
 383         set_SRU_error(c, &res->diagnostics[0]);
 384
 385     scan->scan_response = 0;
 386     scan->srw_scan_response = res;
 387     nmem_transfer(odr_getmem(scan->odr), nmem);
 388
 389     ZOOM_options_set_int(scan->options, "number", res->num_terms);
 390     nmem_destroy(nmem);
 391 }
 392 #endif
 393
 394 int ZOOM_handle_sru(ZOOM_connection c, Z_HTTP_Response *hres,
 395                     zoom_ret *cret)
 396 {
 397 #if YAZ_HAVE_XML2
 398     int ret = 0;
 399     const char *addinfo = 0;
 400
 401     /* not redirect (normal response) */
 402     if (!yaz_srw_check_content_type(hres))
 403     {
 404         addinfo = "content-type";
 405         ret = -1;
 406     }
 407     else if (c->sru_mode == zoom_sru_solr)
 408     {
 409         Z_SRW_PDU *sr;
 410         ret = yaz_solr_decode_response(c->odr_in, hres, &sr);
 411         if (ret == 0)
 412             if (sr->which == Z_SRW_searchRetrieve_response)
 413                 *cret = handle_srw_response(c, sr->u.response);
 414     }
 415     else
 416     {
 417         Z_SOAP *soap_package = 0;
 418         ODR o = c->odr_in;
 419         Z_SOAP_Handler soap_handlers[2] = {
 420             {YAZ_XMLNS_SRU_v1_1, 0, (Z_SOAP_fun) yaz_srw_codec},
 421             {0, 0, 0}
 422         };
 423         ret = z_soap_codec(o, &soap_package,
 424                            &hres->content_buf, &hres->content_len,
 425                            soap_handlers);
 426         if (!ret && soap_package->which == Z_SOAP_generic &&
 427             soap_package->u.generic->no == 0)
 428         {
 429             Z_SRW_PDU *sr = (Z_SRW_PDU*) soap_package->u.generic->p;
 430
 431             ZOOM_options_set(c->options, "sru_version", sr->srw_version);
 432             ZOOM_options_setl(c->options, "sru_extra_response_data",
 433                               sr->extraResponseData_buf, sr->extraResponseData_len);
 434             if (sr->which == Z_SRW_searchRetrieve_response)
 435                 *cret = handle_srw_response(c, sr->u.response);
 436             else if (sr->which == Z_SRW_scan_response)
 437                 handle_srw_scan_response(c, sr->u.scan_response);
 438             else
 439                 ret = -1;
 440         }
 441         else if (!ret && (soap_package->which == Z_SOAP_fault
 442                           || soap_package->which == Z_SOAP_error))
 443         {
 444             ZOOM_set_HTTP_error(c, hres->code,
 445                                 soap_package->u.fault->fault_code,
 446                                 soap_package->u.fault->fault_string);
 447         }
 448         else
 449             ret = -1;
 450     }
 451     return ret;
 452 #else
 453     return -1;
 454 #endif
 455 }
 456
 457 /*
 458  * Local variables:
 459  * c-basic-offset: 4
 460  * c-file-style: "Stroustrup"
 461  * indent-tabs-mode: nil
 462  * End:
 463  * vim: shiftwidth=4 tabstop=8 expandtab
 464  */
 465