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