1 /* This file is part of the YAZ toolkit.
2 * Copyright (C) 1995-2011 Index Data
3 * See the file LICENSE for details.
7 * \brief Implements ZOOM SRU
19 #include <yaz/pquery.h>
21 void handle_facet_list(ZOOM_resultset r, Z_FacetList *fl);
24 static void set_SRU_error(ZOOM_connection c, Z_SRW_diagnostic *d)
26 const char *uri = d->uri;
28 ZOOM_set_dset_error(c, ZOOM_uri_to_code(uri), uri, d->details, 0);
34 static zoom_ret send_srw(ZOOM_connection c, Z_SRW_PDU *sr)
38 const char *database = ZOOM_options_get(c->options, "databaseName");
40 gdu = z_get_HTTP_Request_uri(c->odr_out, c->host_port,
44 if (c->sru_mode == zoom_sru_get)
46 yaz_sru_get_encode(gdu->u.HTTP_Request, sr, c->odr_out, c->charset);
48 else if (c->sru_mode == zoom_sru_post)
50 yaz_sru_post_encode(gdu->u.HTTP_Request, sr, c->odr_out, c->charset);
52 else if (c->sru_mode == zoom_sru_soap)
54 yaz_sru_soap_encode(gdu->u.HTTP_Request, sr, c->odr_out, c->charset);
56 else if (c->sru_mode == zoom_sru_solr)
58 yaz_solr_encode_request(gdu->u.HTTP_Request, sr, c->odr_out, c->charset);
60 if (!z_GDU(c->odr_out, &gdu, 0, 0))
63 z_GDU(c->odr_print, &gdu, 0, 0);
64 c->buf_out = odr_getbuf(c->odr_out, &c->len_out, 0);
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);
74 static Z_SRW_PDU *ZOOM_srw_get_pdu(ZOOM_connection c, int type)
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;
84 zoom_ret ZOOM_connection_srw_send_scan(ZOOM_connection c)
88 const char *option_val = 0;
93 assert (c->tasks->which == ZOOM_TASK_SCAN);
94 scan = c->tasks->u.scan.scan;
96 sr = ZOOM_srw_get_pdu(c, Z_SRW_scan_request);
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)
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));
106 else if (z_query->which == Z_Query_type_1
107 || z_query->which == Z_Query_type_101)
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));
115 ZOOM_set_error(c, ZOOM_ERROR_UNSUPPORTED_QUERY, 0);
116 return zoom_complete;
119 sr->u.scan_request->maximumTerms = odr_intdup(
120 c->odr_out, ZOOM_options_get_int(scan->options, "number", 10));
122 sr->u.scan_request->responsePosition = odr_intdup(
123 c->odr_out, ZOOM_options_get_int(scan->options, "position", 1));
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);
130 zoom_ret ZOOM_connection_srw_send_scan(ZOOM_connection c)
132 return zoom_complete;
137 zoom_ret ZOOM_connection_srw_send_search(ZOOM_connection c)
139 const char *facets = 0;
142 ZOOM_resultset resultset = 0;
144 const char *option_val = 0;
146 Z_FacetList *facet_list = 0;
147 if (c->error) /* don't continue on error */
148 return zoom_complete;
150 switch(c->tasks->which)
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");
161 facet_list = yaz_pqf_parse_facet_list(c->odr_out, facets);
163 case ZOOM_TASK_RETRIEVE:
164 resultset = c->tasks->u.retrieve.resultset;
166 start = &c->tasks->u.retrieve.start;
167 count = &c->tasks->u.retrieve.count;
169 if (*start >= resultset->size)
170 return zoom_complete;
171 if (*start + *count > resultset->size)
172 *count = resultset->size - *start;
174 for (i = 0; i < *count; i++)
177 ZOOM_record_cache_lookup(resultset, i + *start,
178 c->tasks->u.retrieve.syntax,
179 c->tasks->u.retrieve.elementSetName);
184 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_RECV_RECORD);
185 ZOOM_connection_put_event(c, event);
192 return zoom_complete;
195 return zoom_complete;
197 assert(resultset->query);
199 sr = ZOOM_srw_get_pdu(c, Z_SRW_searchRetrieve_request);
200 z_query = ZOOM_query_get_Z_Query(resultset->query);
202 if (z_query->which == Z_Query_type_104
203 && z_query->u.type_104->which == Z_External_CQL)
205 sr->u.request->query_type = Z_SRW_query_type_cql;
206 sr->u.request->query.cql = z_query->u.type_104->u.cql;
208 else if (z_query->which == Z_Query_type_1 && z_query->u.type_1)
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));
217 ZOOM_set_error(c, ZOOM_ERROR_UNSUPPORTED_QUERY, 0);
218 return zoom_complete;
221 option_val = ZOOM_query_get_sru11(resultset->query);
224 sr->u.request->sort_type = Z_SRW_sort_type_sort;
225 sr->u.request->sort.sortKeys = odr_strdup(c->odr_out, option_val);
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;
234 option_val = ZOOM_resultset_option_get(resultset, "recordPacking");
236 sr->u.request->recordPacking = odr_strdup(c->odr_out, option_val);
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);
243 zoom_ret ZOOM_connection_srw_send_search(ZOOM_connection c)
245 return zoom_complete;
250 static zoom_ret handle_srw_response(ZOOM_connection c,
251 Z_SRW_searchRetrieveResponse *res)
253 ZOOM_resultset resultset = 0;
258 const char *syntax, *elementSetName;
261 return zoom_complete;
263 switch(c->tasks->which)
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;
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;
280 handle_facet_list(resultset, res->facetList);
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;
290 return zoom_complete;
295 if (res->resultSetId)
296 ZOOM_resultset_option_set(resultset, "resultSetId", res->resultSetId);
298 yaz_log(c->log_details, "%p handle_srw_response got SRW response OK", c);
300 if (res->num_diagnostics > 0)
302 set_SRU_error(c, &res->diagnostics[0]);
306 if (res->numberOfRecords) {
307 resultset->size = *res->numberOfRecords;
309 if (res->suggestions) {
310 ZOOM_resultset_option_set(resultset, "suggestions", res->suggestions);
312 for (i = 0; i<res->num_records; i++)
315 Z_SRW_record *sru_rec;
316 Z_SRW_diagnostic *diag = 0;
319 Z_NamePlusRecord *npr = (Z_NamePlusRecord *)
320 odr_malloc(c->odr_in, sizeof(Z_NamePlusRecord));
322 * TODO This does not work with 0-based recordPositions.
323 * We will iterate over one twice
325 if (res->records[i].recordPosition &&
326 *res->records[i].recordPosition > 0)
327 pos = *res->records[i].recordPosition - 1;
331 sru_rec = &res->records[i];
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;
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;
351 if (sru_rec->recordSchema
352 && !strcmp(sru_rec->recordSchema,
353 "info:srw/schema/1/diagnostics-v1.1"))
355 sru_decode_surrogate_diagnostics(sru_rec->recordData_buf,
356 sru_rec->recordData_len,
360 ZOOM_record_cache_add(resultset, npr, pos, syntax, elementSetName,
361 sru_rec->recordSchema, diag);
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);
370 nmem = odr_extract_mem(c->odr_in);
371 nmem_transfer(odr_getmem(resultset->odr), nmem);
375 return ZOOM_connection_srw_send_search(c);
377 return zoom_complete;
382 static void handle_srw_scan_response(ZOOM_connection c,
383 Z_SRW_scanResponse *res)
385 NMEM nmem = odr_extract_mem(c->odr_in);
388 if (!c->tasks || c->tasks->which != ZOOM_TASK_SCAN)
390 scan = c->tasks->u.scan.scan;
392 if (res->num_diagnostics > 0)
393 set_SRU_error(c, &res->diagnostics[0]);
395 scan->scan_response = 0;
396 scan->srw_scan_response = res;
397 nmem_transfer(odr_getmem(scan->odr), nmem);
399 ZOOM_options_set_int(scan->options, "number", res->num_terms);
404 int ZOOM_handle_sru(ZOOM_connection c, Z_HTTP_Response *hres,
405 zoom_ret *cret, char **addinfo)
410 /* not redirect (normal response) */
411 if (!yaz_srw_check_content_type(hres))
413 *addinfo = "content-type";
416 else if (c->sru_mode == zoom_sru_solr)
419 ret = yaz_solr_decode_response(c->odr_in, hres, &sr);
421 if (sr->which == Z_SRW_searchRetrieve_response)
422 *cret = handle_srw_response(c, sr->u.response);
426 Z_SOAP *soap_package = 0;
428 Z_SOAP_Handler soap_handlers[2] = {
429 {YAZ_XMLNS_SRU_v1_1, 0, (Z_SOAP_fun) yaz_srw_codec},
432 ret = z_soap_codec(o, &soap_package,
433 &hres->content_buf, &hres->content_len,
435 if (!ret && soap_package->which == Z_SOAP_generic &&
436 soap_package->u.generic->no == 0)
438 Z_SRW_PDU *sr = (Z_SRW_PDU*) soap_package->u.generic->p;
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);
450 else if (!ret && (soap_package->which == Z_SOAP_fault
451 || soap_package->which == Z_SOAP_error))
453 ZOOM_set_HTTP_error(c, hres->code,
454 soap_package->u.fault->fault_code,
455 soap_package->u.fault->fault_string);
459 size_t max_chars = 1000;
460 size_t sz = hres->content_len;
461 if (sz > max_chars - 1)
463 *addinfo = odr_malloc(c->odr_in, sz + 4);
464 memcpy(*addinfo, hres->content_buf, sz);
466 strcpy(*addinfo + sz, "...");
468 strcpy(*addinfo + sz, "");
481 * c-file-style: "Stroustrup"
482 * indent-tabs-mode: nil
484 * vim: shiftwidth=4 tabstop=8 expandtab