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