src/zoom-sru.c

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