src/zoom-sru.c

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