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)
150 ZOOM_resultset resultset = 0;
152 const char *option_val = 0;
153 const char *schema = 0;
155 Z_FacetList *facet_list = 0;
157 if (c->error) /* don't continue on error */
158 return zoom_complete;
160 if (c->tasks->which != ZOOM_TASK_SEARCH)
161 return zoom_complete;
163 resultset = c->tasks->u.search.resultset;
165 ZOOM_memcached_search(c, resultset);
167 if (!resultset->setname)
168 resultset->setname = odr_strdup(resultset->odr, "default");
169 ZOOM_options_set(resultset->options, "setname", resultset->setname);
170 start = &c->tasks->u.search.start;
171 count = &c->tasks->u.search.count;
172 if (resultset->req_facets)
173 facet_list = yaz_pqf_parse_facet_list(c->odr_out,
174 resultset->req_facets);
175 schema = c->tasks->u.search.schema;
177 if (resultset->live_set)
179 if (*start >= resultset->size)
180 return zoom_complete;
181 if (*start + *count > resultset->size)
182 *count = resultset->size - *start;
184 for (i = 0; i < *count; i++)
187 ZOOM_record_cache_lookup(resultset, i + *start,
188 c->tasks->u.search.syntax,
189 c->tasks->u.search.elementSetName,
197 if (*count == 0 && resultset->live_set)
198 return zoom_complete;
200 assert(resultset->query);
202 sr = ZOOM_srw_get_pdu(c, Z_SRW_searchRetrieve_request);
203 z_query = ZOOM_query_get_Z_Query(resultset->query);
205 if (z_query->which == Z_Query_type_104
206 && z_query->u.type_104->which == Z_External_CQL)
208 sr->u.request->queryType = "cql";
209 sr->u.request->query = z_query->u.type_104->u.cql;
211 else if (z_query->which == Z_Query_type_1 && z_query->u.type_1)
213 sr->u.request->queryType = "pqf";
214 sr->u.request->query =
215 odr_strdup(c->odr_out,
216 ZOOM_query_get_query_string(resultset->query));
220 ZOOM_set_error(c, ZOOM_ERROR_UNSUPPORTED_QUERY, 0);
221 return zoom_complete;
224 option_val = ZOOM_query_get_sru11(resultset->query);
227 sr->u.request->sort_type = Z_SRW_sort_type_sort;
228 sr->u.request->sort.sortKeys = odr_strdup(c->odr_out, option_val);
230 sr->u.request->startRecord = odr_intdup(c->odr_out, *start + 1);
231 sr->u.request->maximumRecords = odr_intdup(
232 c->odr_out, (resultset->step > 0 && resultset->step < *count) ?
233 resultset->step : *count);
234 sr->u.request->recordSchema = odr_strdup_null(c->odr_out, schema);
235 sr->u.request->facetList = facet_list;
237 option_val = ZOOM_resultset_option_get(resultset, "recordPacking");
239 sr->u.request->recordPacking = odr_strdup(c->odr_out, option_val);
241 option_val = ZOOM_resultset_option_get(resultset, "extraArgs");
242 yaz_encode_sru_extra(sr, c->odr_out, option_val);
243 return send_srw(c, sr);
246 zoom_ret ZOOM_connection_srw_send_search(ZOOM_connection c)
248 return zoom_complete;
253 static zoom_ret handle_srw_response(ZOOM_connection c,
254 Z_SRW_searchRetrieveResponse *res)
256 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 start = &c->tasks->u.search.start;
271 count = &c->tasks->u.search.count;
272 syntax = c->tasks->u.search.syntax;
273 elementSetName = c->tasks->u.search.elementSetName;
274 schema = c->tasks->u.search.schema;
276 if (resultset->live_set == 0)
278 event = ZOOM_Event_create(ZOOM_EVENT_RECV_SEARCH);
279 ZOOM_connection_put_event(c, event);
282 ZOOM_handle_facet_list(resultset, res->facetList);
286 if (res->resultSetId)
287 ZOOM_resultset_option_set(resultset, "resultSetId", res->resultSetId);
289 yaz_log(c->log_details, "%p handle_srw_response got SRW response OK", c);
291 if (res->num_diagnostics > 0)
293 resultset->live_set = 2;
294 set_SRU_error(c, &res->diagnostics[0]);
298 if (res->numberOfRecords)
300 Z_OtherInformation *oi = 0;
304 Z_External *ext = (Z_External *)
305 odr_malloc(o, sizeof(*ext));
307 ext->which = Z_External_userFacets;
308 ext->u.facetList = res->facetList;
309 ext->direct_reference =
310 odr_oiddup(o, yaz_oid_userinfo_facet_1);
311 ext->indirect_reference = 0;
313 oi = (Z_OtherInformation *) odr_malloc(o, sizeof(*oi));
314 oi->num_elements = 1;
315 oi->list = (Z_OtherInformationUnit **)
316 odr_malloc(o, sizeof(*oi->list));
317 oi->list[0] = (Z_OtherInformationUnit *)
318 odr_malloc(o, sizeof(**oi->list));
319 oi->list[0]->category = 0;
320 oi->list[0]->which = Z_OtherInfo_externallyDefinedInfo;
321 oi->list[0]->information.externallyDefinedInfo = ext;
323 resultset->size = *res->numberOfRecords;
324 ZOOM_memcached_hitcount(c, resultset, oi,
325 res->resultCountPrecision ?
326 res->resultCountPrecision : "exact");
328 resultset->live_set = 2;
329 if (res->suggestions)
330 ZOOM_resultset_option_set(resultset, "suggestions",
332 for (i = 0; i < res->num_records; i++)
334 int pos = c->tasks->u.search.start + i;
335 Z_SRW_record *sru_rec;
336 Z_SRW_diagnostic *diag = 0;
339 /* only trust recordPosition if >= calculated position */
340 if (res->records[i].recordPosition &&
341 *res->records[i].recordPosition >= pos + 1)
342 pos = *res->records[i].recordPosition - 1;
344 if (!ZOOM_record_cache_lookup(resultset,
346 syntax, elementSetName, schema))
348 Z_NamePlusRecord *npr = (Z_NamePlusRecord *)
349 odr_malloc(c->odr_in, sizeof(Z_NamePlusRecord));
350 sru_rec = &res->records[i];
352 npr->databaseName = 0;
353 npr->which = Z_NamePlusRecord_databaseRecord;
354 npr->u.databaseRecord = (Z_External *)
355 odr_malloc(c->odr_in, sizeof(Z_External));
356 npr->u.databaseRecord->descriptor = 0;
357 npr->u.databaseRecord->direct_reference =
358 odr_oiddup(c->odr_in, yaz_oid_recsyn_xml);
359 npr->u.databaseRecord->indirect_reference = 0;
360 npr->u.databaseRecord->which = Z_External_octet;
362 npr->u.databaseRecord->u.octet_aligned =
363 odr_create_Odr_oct(c->odr_in,
364 sru_rec->recordData_buf,
365 sru_rec->recordData_len);
366 if (sru_rec->recordSchema
367 && !strcmp(sru_rec->recordSchema,
368 "info:srw/schema/1/diagnostics-v1.1"))
370 sru_decode_surrogate_diagnostics(sru_rec->recordData_buf,
371 sru_rec->recordData_len,
375 ZOOM_record_cache_add(resultset, npr,
376 pos, syntax, elementSetName,
384 nmem = odr_extract_mem(c->odr_in);
385 nmem_transfer(odr_getmem(resultset->odr), nmem);
388 return ZOOM_connection_srw_send_search(c);
390 return zoom_complete;
395 static void handle_srw_scan_response(ZOOM_connection c,
396 Z_SRW_scanResponse *res)
398 NMEM nmem = odr_extract_mem(c->odr_in);
401 if (!c->tasks || c->tasks->which != ZOOM_TASK_SCAN)
403 scan = c->tasks->u.scan.scan;
405 if (res->num_diagnostics > 0)
406 set_SRU_error(c, &res->diagnostics[0]);
408 scan->scan_response = 0;
409 scan->srw_scan_response = res;
410 nmem_transfer(odr_getmem(scan->odr), nmem);
412 ZOOM_options_set_int(scan->options, "number", res->num_terms);
417 int ZOOM_handle_sru(ZOOM_connection c, Z_HTTP_Response *hres,
418 zoom_ret *cret, char **addinfo)
423 /* not redirect (normal response) */
424 if (!yaz_srw_check_content_type(hres))
426 *addinfo = "content-type";
429 else if (c->sru_mode == zoom_sru_solr)
432 ret = yaz_solr_decode_response(c->odr_in, hres, &sr);
435 if (sr->which == Z_SRW_searchRetrieve_response)
436 *cret = handle_srw_response(c, sr->u.response);
437 else if (sr->which == Z_SRW_scan_response)
438 handle_srw_scan_response(c, sr->u.scan_response);
443 Z_SOAP *soap_package = 0;
445 Z_SOAP_Handler soap_handlers[4] = {
446 {YAZ_XMLNS_SRU_v1_response, 0, (Z_SOAP_fun) yaz_srw_codec},
447 {YAZ_XMLNS_SRU_v2_mask, 0, (Z_SOAP_fun) yaz_srw_codec},
448 {"searchRetrieveResponse", 0, (Z_SOAP_fun) yaz_srw_codec},
451 ret = z_soap_codec(o, &soap_package,
452 &hres->content_buf, &hres->content_len,
454 if (!ret && soap_package->which == Z_SOAP_generic)
456 Z_SRW_PDU *sr = (Z_SRW_PDU*) soap_package->u.generic->p;
458 ZOOM_options_set(c->options, "sru_version", sr->srw_version);
459 ZOOM_options_setl(c->options, "sru_extra_response_data",
460 sr->extraResponseData_buf, sr->extraResponseData_len);
461 if (sr->which == Z_SRW_searchRetrieve_response)
462 *cret = handle_srw_response(c, sr->u.response);
463 else if (sr->which == Z_SRW_scan_response)
464 handle_srw_scan_response(c, sr->u.scan_response);
468 else if (!ret && (soap_package->which == Z_SOAP_fault
469 || soap_package->which == Z_SOAP_error))
471 ZOOM_set_HTTP_error(c, hres->code,
472 soap_package->u.fault->fault_code,
473 soap_package->u.fault->fault_string);
477 size_t max_chars = 1000;
478 size_t sz = hres->content_len;
479 if (sz > max_chars - 1)
481 *addinfo = odr_malloc(c->odr_in, sz + 4);
482 memcpy(*addinfo, hres->content_buf, sz);
484 strcpy(*addinfo + sz, "...");
486 strcpy(*addinfo + sz, "");
499 * c-file-style: "Stroustrup"
500 * indent-tabs-mode: nil
502 * vim: shiftwidth=4 tabstop=8 expandtab