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