1 /* This file is part of the YAZ toolkit.
2 * Copyright (C) 1995-2013 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)
37 const char *database = ZOOM_options_get(c->options, "databaseName");
39 gdu = z_get_HTTP_Request_uri(c->odr_out, c->host_port,
43 if (c->sru_mode == zoom_sru_get)
45 yaz_sru_get_encode(gdu->u.HTTP_Request, sr, c->odr_out, c->charset);
47 else if (c->sru_mode == zoom_sru_post)
49 yaz_sru_post_encode(gdu->u.HTTP_Request, sr, c->odr_out, c->charset);
51 else if (c->sru_mode == zoom_sru_soap)
53 yaz_sru_soap_encode(gdu->u.HTTP_Request, sr, c->odr_out, c->charset);
55 else if (c->sru_mode == zoom_sru_solr)
57 yaz_solr_encode_request(gdu->u.HTTP_Request, sr, c->odr_out, c->charset);
59 return ZOOM_send_GDU(c, gdu);
64 static Z_SRW_PDU *ZOOM_srw_get_pdu(ZOOM_connection c, int type)
66 Z_SRW_PDU *sr = yaz_srw_get_pdu(c->odr_out, type, c->sru_version);
67 sr->username = c->user;
68 sr->password = c->password;
74 zoom_ret ZOOM_connection_srw_send_scan(ZOOM_connection c)
78 const char *option_val = 0;
83 assert (c->tasks->which == ZOOM_TASK_SCAN);
84 scan = c->tasks->u.scan.scan;
86 sr = ZOOM_srw_get_pdu(c, Z_SRW_scan_request);
88 z_query = ZOOM_query_get_Z_Query(scan->query);
89 /* SRU scan can only carry CQL and PQF */
90 if (z_query->which == Z_Query_type_104)
92 sr->u.scan_request->query_type = Z_SRW_query_type_cql;
93 sr->u.scan_request->scanClause.cql =
94 odr_strdup(c->odr_out, ZOOM_query_get_query_string(scan->query));
96 else if (z_query->which == Z_Query_type_1
97 || z_query->which == Z_Query_type_101)
99 sr->u.scan_request->query_type = Z_SRW_query_type_pqf;
100 sr->u.scan_request->scanClause.pqf =
101 odr_strdup(c->odr_out, ZOOM_query_get_query_string(scan->query));
105 ZOOM_set_error(c, ZOOM_ERROR_UNSUPPORTED_QUERY, 0);
106 return zoom_complete;
109 sr->u.scan_request->maximumTerms = odr_intdup(
110 c->odr_out, ZOOM_options_get_int(scan->options, "number", 10));
112 sr->u.scan_request->responsePosition = odr_intdup(
113 c->odr_out, ZOOM_options_get_int(scan->options, "position", 1));
115 option_val = ZOOM_options_get(scan->options, "extraArgs");
116 yaz_encode_sru_extra(sr, c->odr_out, option_val);
117 return send_srw(c, sr);
120 zoom_ret ZOOM_connection_srw_send_scan(ZOOM_connection c)
122 return zoom_complete;
127 zoom_ret ZOOM_connection_srw_send_search(ZOOM_connection c)
129 const char *facets = 0;
132 ZOOM_resultset resultset = 0;
134 const char *option_val = 0;
136 Z_FacetList *facet_list = 0;
137 if (c->error) /* don't continue on error */
138 return zoom_complete;
140 switch(c->tasks->which)
142 case ZOOM_TASK_SEARCH:
143 resultset = c->tasks->u.search.resultset;
144 if (!resultset->setname)
145 resultset->setname = xstrdup("default");
146 ZOOM_options_set(resultset->options, "setname", resultset->setname);
147 start = &c->tasks->u.search.start;
148 count = &c->tasks->u.search.count;
149 facets = ZOOM_options_get(resultset->options, "facets");
151 facet_list = yaz_pqf_parse_facet_list(c->odr_out, facets);
153 case ZOOM_TASK_RETRIEVE:
154 resultset = c->tasks->u.retrieve.resultset;
156 start = &c->tasks->u.retrieve.start;
157 count = &c->tasks->u.retrieve.count;
159 if (*start >= resultset->size)
160 return zoom_complete;
161 if (*start + *count > resultset->size)
162 *count = resultset->size - *start;
164 for (i = 0; i < *count; i++)
167 ZOOM_record_cache_lookup(resultset, i + *start,
168 c->tasks->u.retrieve.syntax,
169 c->tasks->u.retrieve.elementSetName);
174 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_RECV_RECORD);
175 ZOOM_connection_put_event(c, event);
182 return zoom_complete;
185 return zoom_complete;
187 assert(resultset->query);
189 sr = ZOOM_srw_get_pdu(c, Z_SRW_searchRetrieve_request);
190 z_query = ZOOM_query_get_Z_Query(resultset->query);
192 if (z_query->which == Z_Query_type_104
193 && z_query->u.type_104->which == Z_External_CQL)
195 sr->u.request->query_type = Z_SRW_query_type_cql;
196 sr->u.request->query.cql = z_query->u.type_104->u.cql;
198 else if (z_query->which == Z_Query_type_1 && z_query->u.type_1)
200 sr->u.request->query_type = Z_SRW_query_type_pqf;
201 sr->u.request->query.pqf =
202 odr_strdup(c->odr_out,
203 ZOOM_query_get_query_string(resultset->query));
207 ZOOM_set_error(c, ZOOM_ERROR_UNSUPPORTED_QUERY, 0);
208 return zoom_complete;
211 option_val = ZOOM_query_get_sru11(resultset->query);
214 sr->u.request->sort_type = Z_SRW_sort_type_sort;
215 sr->u.request->sort.sortKeys = odr_strdup(c->odr_out, option_val);
217 sr->u.request->startRecord = odr_intdup(c->odr_out, *start + 1);
218 sr->u.request->maximumRecords = odr_intdup(
219 c->odr_out, (resultset->step > 0 && resultset->step < *count) ?
220 resultset->step : *count);
221 sr->u.request->recordSchema = resultset->schema;
222 sr->u.request->facetList = facet_list;
224 option_val = ZOOM_resultset_option_get(resultset, "recordPacking");
226 sr->u.request->recordPacking = odr_strdup(c->odr_out, option_val);
228 option_val = ZOOM_resultset_option_get(resultset, "extraArgs");
229 yaz_encode_sru_extra(sr, c->odr_out, option_val);
230 return send_srw(c, sr);
233 zoom_ret ZOOM_connection_srw_send_search(ZOOM_connection c)
235 return zoom_complete;
240 static zoom_ret handle_srw_response(ZOOM_connection c,
241 Z_SRW_searchRetrieveResponse *res)
243 ZOOM_resultset resultset = 0;
248 const char *syntax, *elementSetName;
251 return zoom_complete;
253 switch(c->tasks->which)
255 case ZOOM_TASK_SEARCH:
256 resultset = c->tasks->u.search.resultset;
257 start = &c->tasks->u.search.start;
258 count = &c->tasks->u.search.count;
259 syntax = c->tasks->u.search.syntax;
260 elementSetName = c->tasks->u.search.elementSetName;
262 /* Required not for reporting client hit count multiple times into session */
263 if (!c->tasks->u.search.recv_search_fired) {
264 yaz_log(YLOG_DEBUG, "posting ZOOM_EVENT_RECV_SEARCH");
265 event = ZOOM_Event_create(ZOOM_EVENT_RECV_SEARCH);
266 ZOOM_connection_put_event(c, event);
267 c->tasks->u.search.recv_search_fired = 1;
270 handle_facet_list(resultset, res->facetList);
272 case ZOOM_TASK_RETRIEVE:
273 resultset = c->tasks->u.retrieve.resultset;
274 start = &c->tasks->u.retrieve.start;
275 count = &c->tasks->u.retrieve.count;
276 syntax = c->tasks->u.retrieve.syntax;
277 elementSetName = c->tasks->u.retrieve.elementSetName;
280 return zoom_complete;
285 if (res->resultSetId)
286 ZOOM_resultset_option_set(resultset, "resultSetId", res->resultSetId);
288 yaz_log(c->log_details, "%p handle_srw_response got SRW response OK", c);
290 if (res->num_diagnostics > 0)
292 set_SRU_error(c, &res->diagnostics[0]);
296 if (res->numberOfRecords) {
297 resultset->size = *res->numberOfRecords;
299 if (res->suggestions) {
300 ZOOM_resultset_option_set(resultset, "suggestions", res->suggestions);
302 for (i = 0; i<res->num_records; i++)
304 int pos = *start + i;
305 Z_SRW_record *sru_rec;
306 Z_SRW_diagnostic *diag = 0;
309 Z_NamePlusRecord *npr = (Z_NamePlusRecord *)
310 odr_malloc(c->odr_in, sizeof(Z_NamePlusRecord));
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 sru_rec = &res->records[i];
319 npr->databaseName = 0;
320 npr->which = Z_NamePlusRecord_databaseRecord;
321 npr->u.databaseRecord = (Z_External *)
322 odr_malloc(c->odr_in, sizeof(Z_External));
323 npr->u.databaseRecord->descriptor = 0;
324 npr->u.databaseRecord->direct_reference =
325 odr_oiddup(c->odr_in, yaz_oid_recsyn_xml);
326 npr->u.databaseRecord->indirect_reference = 0;
327 npr->u.databaseRecord->which = Z_External_octet;
329 npr->u.databaseRecord->u.octet_aligned = (Odr_oct *)
330 odr_malloc(c->odr_in, sizeof(Odr_oct));
331 npr->u.databaseRecord->u.octet_aligned->buf = (unsigned char*)
332 sru_rec->recordData_buf;
333 npr->u.databaseRecord->u.octet_aligned->len =
334 npr->u.databaseRecord->u.octet_aligned->size =
335 sru_rec->recordData_len;
337 if (sru_rec->recordSchema
338 && !strcmp(sru_rec->recordSchema,
339 "info:srw/schema/1/diagnostics-v1.1"))
341 sru_decode_surrogate_diagnostics(sru_rec->recordData_buf,
342 sru_rec->recordData_len,
346 ZOOM_record_cache_add(resultset, npr, pos, syntax, elementSetName,
347 sru_rec->recordSchema, diag);
351 if (*count + *start > resultset->size)
352 *count = resultset->size - *start;
353 yaz_log(YLOG_DEBUG, "SRU result set size " ODR_INT_PRINTF " start %d count %d", resultset->size, *start, *count);
356 nmem = odr_extract_mem(c->odr_in);
357 nmem_transfer(odr_getmem(resultset->odr), nmem);
361 return ZOOM_connection_srw_send_search(c);
363 return zoom_complete;
368 static void handle_srw_scan_response(ZOOM_connection c,
369 Z_SRW_scanResponse *res)
371 NMEM nmem = odr_extract_mem(c->odr_in);
374 if (!c->tasks || c->tasks->which != ZOOM_TASK_SCAN)
376 scan = c->tasks->u.scan.scan;
378 if (res->num_diagnostics > 0)
379 set_SRU_error(c, &res->diagnostics[0]);
381 scan->scan_response = 0;
382 scan->srw_scan_response = res;
383 nmem_transfer(odr_getmem(scan->odr), nmem);
385 ZOOM_options_set_int(scan->options, "number", res->num_terms);
390 int ZOOM_handle_sru(ZOOM_connection c, Z_HTTP_Response *hres,
391 zoom_ret *cret, char **addinfo)
396 /* not redirect (normal response) */
397 if (!yaz_srw_check_content_type(hres))
399 *addinfo = "content-type";
402 else if (c->sru_mode == zoom_sru_solr)
405 ret = yaz_solr_decode_response(c->odr_in, hres, &sr);
408 if (sr->which == Z_SRW_searchRetrieve_response)
409 *cret = handle_srw_response(c, sr->u.response);
410 else if (sr->which == Z_SRW_scan_response)
411 handle_srw_scan_response(c, sr->u.scan_response);
416 Z_SOAP *soap_package = 0;
418 Z_SOAP_Handler soap_handlers[3] = {
419 {YAZ_XMLNS_SRU_v1_response, 0, (Z_SOAP_fun) yaz_srw_codec},
420 {YAZ_XMLNS_SRU_v2_response, 0, (Z_SOAP_fun) yaz_srw_codec},
423 ret = z_soap_codec(o, &soap_package,
424 &hres->content_buf, &hres->content_len,
426 if (!ret && soap_package->which == Z_SOAP_generic)
428 Z_SRW_PDU *sr = (Z_SRW_PDU*) soap_package->u.generic->p;
430 ZOOM_options_set(c->options, "sru_version", sr->srw_version);
431 ZOOM_options_setl(c->options, "sru_extra_response_data",
432 sr->extraResponseData_buf, sr->extraResponseData_len);
433 if (sr->which == Z_SRW_searchRetrieve_response)
434 *cret = handle_srw_response(c, sr->u.response);
435 else if (sr->which == Z_SRW_scan_response)
436 handle_srw_scan_response(c, sr->u.scan_response);
440 else if (!ret && (soap_package->which == Z_SOAP_fault
441 || soap_package->which == Z_SOAP_error))
443 ZOOM_set_HTTP_error(c, hres->code,
444 soap_package->u.fault->fault_code,
445 soap_package->u.fault->fault_string);
449 size_t max_chars = 1000;
450 size_t sz = hres->content_len;
451 if (sz > max_chars - 1)
453 *addinfo = odr_malloc(c->odr_in, sz + 4);
454 memcpy(*addinfo, hres->content_buf, sz);
456 strcpy(*addinfo + sz, "...");
458 strcpy(*addinfo + sz, "");
471 * c-file-style: "Stroustrup"
472 * indent-tabs-mode: nil
474 * vim: shiftwidth=4 tabstop=8 expandtab