1 /* This file is part of the YAZ toolkit.
2 * Copyright (C) Index Data
3 * See the file LICENSE for details.
7 * \brief Implements ZOOM SRU
19 #include <yaz/pquery.h>
22 static void set_SRU_error(ZOOM_connection c, Z_SRW_diagnostic *d)
24 const char *uri = d->uri;
26 ZOOM_set_dset_error(c, ZOOM_uri_to_code(uri), uri, d->details, 0);
32 static zoom_ret send_srw(ZOOM_connection c, Z_SRW_PDU *sr)
35 const char *database = ZOOM_options_get(c->options, "databaseName");
37 gdu = z_get_HTTP_Request_uri(c->odr_out, c->host_port,
41 if (c->sru_mode == zoom_sru_get)
43 yaz_sru_get_encode(gdu->u.HTTP_Request, sr, c->odr_out, c->charset);
45 else if (c->sru_mode == zoom_sru_post)
47 yaz_sru_post_encode(gdu->u.HTTP_Request, sr, c->odr_out, c->charset);
49 else if (c->sru_mode == zoom_sru_soap)
51 yaz_sru_soap_encode(gdu->u.HTTP_Request, sr, c->odr_out, c->charset);
53 else if (c->sru_mode == zoom_sru_solr)
55 yaz_solr_encode_request(gdu->u.HTTP_Request, sr, c->odr_out, c->charset);
57 return ZOOM_send_GDU(c, gdu);
62 static Z_SRW_PDU *ZOOM_srw_get_pdu(ZOOM_connection c, int type)
64 Z_SRW_PDU *sr = yaz_srw_get_pdu(c->odr_out, type, c->sru_version);
65 if (c->url_authentication && c->user)
67 Z_SRW_extra_arg **ea = &sr->extra_args;
70 *ea = (Z_SRW_extra_arg *) odr_malloc(c->odr_out, sizeof(**ea));
71 (*ea)->name = "x-username";
72 (*ea)->value = c->user;
76 *ea = (Z_SRW_extra_arg *) odr_malloc(c->odr_out, sizeof(**ea));
77 (*ea)->name = "x-password";
78 (*ea)->value = c->password;
85 sr->username = c->user;
86 sr->password = c->password;
93 zoom_ret ZOOM_connection_srw_send_scan(ZOOM_connection c)
97 const char *option_val = 0;
101 return zoom_complete;
102 assert (c->tasks->which == ZOOM_TASK_SCAN);
103 scan = c->tasks->u.scan.scan;
105 sr = ZOOM_srw_get_pdu(c, Z_SRW_scan_request);
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)
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));
115 else if (z_query->which == Z_Query_type_1
116 || z_query->which == Z_Query_type_101)
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));
124 ZOOM_set_error(c, ZOOM_ERROR_UNSUPPORTED_QUERY, 0);
125 return zoom_complete;
128 sr->u.scan_request->maximumTerms = odr_intdup(
129 c->odr_out, ZOOM_options_get_int(scan->options, "number", 10));
131 sr->u.scan_request->responsePosition = odr_intdup(
132 c->odr_out, ZOOM_options_get_int(scan->options, "position", 1));
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);
139 zoom_ret ZOOM_connection_srw_send_scan(ZOOM_connection c)
141 return zoom_complete;
146 zoom_ret ZOOM_connection_srw_send_search(ZOOM_connection c)
148 const char *facets = 0;
151 ZOOM_resultset resultset = 0;
153 const char *option_val = 0;
154 const char *schema = 0;
156 Z_FacetList *facet_list = 0;
158 if (c->error) /* don't continue on error */
159 return zoom_complete;
161 if (c->tasks->which != ZOOM_TASK_SEARCH)
162 return zoom_complete;
164 resultset = c->tasks->u.search.resultset;
166 ZOOM_memcached_search(c, resultset);
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");
175 facet_list = yaz_pqf_parse_facet_list(c->odr_out, facets);
176 schema = c->tasks->u.search.schema;
178 if (resultset->live_set)
180 if (*start >= resultset->size)
181 return zoom_complete;
182 if (*start + *count > resultset->size)
183 *count = resultset->size - *start;
185 for (i = 0; i < *count; i++)
188 ZOOM_record_cache_lookup(resultset, i + *start,
189 c->tasks->u.search.syntax,
190 c->tasks->u.search.elementSetName,
198 if (*count == 0 && resultset->live_set)
199 return zoom_complete;
201 assert(resultset->query);
203 sr = ZOOM_srw_get_pdu(c, Z_SRW_searchRetrieve_request);
204 z_query = ZOOM_query_get_Z_Query(resultset->query);
206 if (z_query->which == Z_Query_type_104
207 && z_query->u.type_104->which == Z_External_CQL)
209 sr->u.request->queryType = "cql";
210 sr->u.request->query = z_query->u.type_104->u.cql;
212 else if (z_query->which == Z_Query_type_1 && z_query->u.type_1)
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));
221 ZOOM_set_error(c, ZOOM_ERROR_UNSUPPORTED_QUERY, 0);
222 return zoom_complete;
225 option_val = ZOOM_query_get_sru11(resultset->query);
228 sr->u.request->sort_type = Z_SRW_sort_type_sort;
229 sr->u.request->sort.sortKeys = odr_strdup(c->odr_out, option_val);
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;
238 option_val = ZOOM_resultset_option_get(resultset, "recordPacking");
240 sr->u.request->recordPacking = odr_strdup(c->odr_out, option_val);
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);
247 zoom_ret ZOOM_connection_srw_send_search(ZOOM_connection c)
249 return zoom_complete;
254 static zoom_ret handle_srw_response(ZOOM_connection c,
255 Z_SRW_searchRetrieveResponse *res)
257 ZOOM_resultset resultset = 0;
261 const char *syntax, *elementSetName, *schema;
264 return zoom_complete;
266 if (c->tasks->which != ZOOM_TASK_SEARCH)
267 return zoom_complete;
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;
274 if (resultset->live_set == 0)
276 event = ZOOM_Event_create(ZOOM_EVENT_RECV_SEARCH);
277 ZOOM_connection_put_event(c, event);
280 ZOOM_handle_facet_list(resultset, res->facetList);
284 if (res->resultSetId)
285 ZOOM_resultset_option_set(resultset, "resultSetId", res->resultSetId);
287 yaz_log(c->log_details, "%p handle_srw_response got SRW response OK", c);
289 if (res->num_diagnostics > 0)
291 resultset->live_set = 2;
292 set_SRU_error(c, &res->diagnostics[0]);
296 if (res->numberOfRecords)
298 resultset->size = *res->numberOfRecords;
299 ZOOM_memcached_hitcount(c, resultset);
301 resultset->live_set = 2;
302 if (res->suggestions)
303 ZOOM_resultset_option_set(resultset, "suggestions",
305 for (i = 0; i < res->num_records; i++)
307 int pos = c->tasks->u.search.start + i;
308 Z_SRW_record *sru_rec;
309 Z_SRW_diagnostic *diag = 0;
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;
317 if (!ZOOM_record_cache_lookup(resultset,
319 syntax, elementSetName, schema))
321 Z_NamePlusRecord *npr = (Z_NamePlusRecord *)
322 odr_malloc(c->odr_in, sizeof(Z_NamePlusRecord));
323 sru_rec = &res->records[i];
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;
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"))
343 sru_decode_surrogate_diagnostics(sru_rec->recordData_buf,
344 sru_rec->recordData_len,
348 ZOOM_record_cache_add(resultset, npr,
349 pos, syntax, elementSetName,
353 nmem = odr_extract_mem(c->odr_in);
354 nmem_transfer(odr_getmem(resultset->odr), nmem);
357 return ZOOM_connection_srw_send_search(c);
359 return zoom_complete;
364 static void handle_srw_scan_response(ZOOM_connection c,
365 Z_SRW_scanResponse *res)
367 NMEM nmem = odr_extract_mem(c->odr_in);
370 if (!c->tasks || c->tasks->which != ZOOM_TASK_SCAN)
372 scan = c->tasks->u.scan.scan;
374 if (res->num_diagnostics > 0)
375 set_SRU_error(c, &res->diagnostics[0]);
377 scan->scan_response = 0;
378 scan->srw_scan_response = res;
379 nmem_transfer(odr_getmem(scan->odr), nmem);
381 ZOOM_options_set_int(scan->options, "number", res->num_terms);
386 int ZOOM_handle_sru(ZOOM_connection c, Z_HTTP_Response *hres,
387 zoom_ret *cret, char **addinfo)
392 /* not redirect (normal response) */
393 if (!yaz_srw_check_content_type(hres))
395 *addinfo = "content-type";
398 else if (c->sru_mode == zoom_sru_solr)
401 ret = yaz_solr_decode_response(c->odr_in, hres, &sr);
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);
412 Z_SOAP *soap_package = 0;
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},
420 ret = z_soap_codec(o, &soap_package,
421 &hres->content_buf, &hres->content_len,
423 if (!ret && soap_package->which == Z_SOAP_generic)
425 Z_SRW_PDU *sr = (Z_SRW_PDU*) soap_package->u.generic->p;
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);
437 else if (!ret && (soap_package->which == Z_SOAP_fault
438 || soap_package->which == Z_SOAP_error))
440 ZOOM_set_HTTP_error(c, hres->code,
441 soap_package->u.fault->fault_code,
442 soap_package->u.fault->fault_string);
446 size_t max_chars = 1000;
447 size_t sz = hres->content_len;
448 if (sz > max_chars - 1)
450 *addinfo = odr_malloc(c->odr_in, sz + 4);
451 memcpy(*addinfo, hres->content_buf, sz);
453 strcpy(*addinfo + sz, "...");
455 strcpy(*addinfo + sz, "");
468 * c-file-style: "Stroustrup"
469 * indent-tabs-mode: nil
471 * vim: shiftwidth=4 tabstop=8 expandtab