1 /* This file is part of the YAZ toolkit.
2 * Copyright (C) 1995-2010 Index Data
3 * See the file LICENSE for details.
7 * \brief Implements ZOOM SRU
18 static void set_SRU_error(ZOOM_connection c, Z_SRW_diagnostic *d)
20 const char *uri = d->uri;
22 ZOOM_set_dset_error(c, ZOOM_uri_to_code(uri), uri, d->details, 0);
28 static zoom_ret send_srw(ZOOM_connection c, Z_SRW_PDU *sr)
32 const char *database = ZOOM_options_get(c->options, "databaseName");
36 fdatabase = yaz_encode_sru_dbpath_odr(c->odr_out, database);
37 gdu = z_get_HTTP_Request_host_path(c->odr_out, c->host_port,
38 fdatabase ? fdatabase : c->path);
40 if (c->sru_mode == zoom_sru_get)
42 yaz_sru_get_encode(gdu->u.HTTP_Request, sr, c->odr_out, c->charset);
44 else if (c->sru_mode == zoom_sru_post)
46 yaz_sru_post_encode(gdu->u.HTTP_Request, sr, c->odr_out, c->charset);
48 else if (c->sru_mode == zoom_sru_soap)
50 yaz_sru_soap_encode(gdu->u.HTTP_Request, sr, c->odr_out, c->charset);
52 else if (c->sru_mode == zoom_sru_solr)
54 yaz_solr_encode_request(gdu->u.HTTP_Request, sr, c->odr_out, c->charset);
56 if (!z_GDU(c->odr_out, &gdu, 0, 0))
59 z_GDU(c->odr_print, &gdu, 0, 0);
60 c->buf_out = odr_getbuf(c->odr_out, &c->len_out, 0);
62 event = ZOOM_Event_create(ZOOM_EVENT_SEND_APDU);
63 ZOOM_connection_put_event(c, event);
64 odr_reset(c->odr_out);
65 return ZOOM_send_buf(c);
70 static Z_SRW_PDU *ZOOM_srw_get_pdu(ZOOM_connection c, int type)
72 Z_SRW_PDU *sr = yaz_srw_get_pdu(c->odr_out, type, c->sru_version);
73 sr->username = c->user;
74 sr->password = c->password;
80 zoom_ret ZOOM_connection_srw_send_scan(ZOOM_connection c)
84 const char *option_val = 0;
89 assert (c->tasks->which == ZOOM_TASK_SCAN);
90 scan = c->tasks->u.scan.scan;
92 sr = ZOOM_srw_get_pdu(c, Z_SRW_scan_request);
94 z_query = ZOOM_query_get_Z_Query(scan->query);
95 /* SRU scan can only carry CQL and PQF */
96 if (z_query->which == Z_Query_type_104)
98 sr->u.scan_request->query_type = Z_SRW_query_type_cql;
99 sr->u.scan_request->scanClause.cql =
100 ZOOM_query_get_query_string(scan->query);
102 else if (z_query->which == Z_Query_type_1
103 || z_query->which == Z_Query_type_101)
105 sr->u.scan_request->query_type = Z_SRW_query_type_pqf;
106 sr->u.scan_request->scanClause.pqf =
107 ZOOM_query_get_query_string(scan->query);
111 ZOOM_set_error(c, ZOOM_ERROR_UNSUPPORTED_QUERY, 0);
112 return zoom_complete;
115 sr->u.scan_request->maximumTerms = odr_intdup(
116 c->odr_out, ZOOM_options_get_int(scan->options, "number", 10));
118 sr->u.scan_request->responsePosition = odr_intdup(
119 c->odr_out, ZOOM_options_get_int(scan->options, "position", 1));
121 option_val = ZOOM_options_get(scan->options, "extraArgs");
122 yaz_encode_sru_extra(sr, c->odr_out, option_val);
123 return send_srw(c, sr);
126 zoom_ret ZOOM_connection_srw_send_scan(ZOOM_connection c)
128 return zoom_complete;
133 zoom_ret ZOOM_connection_srw_send_search(ZOOM_connection c)
137 ZOOM_resultset resultset = 0;
139 const char *option_val = 0;
142 if (c->error) /* don't continue on error */
143 return zoom_complete;
145 switch(c->tasks->which)
147 case ZOOM_TASK_SEARCH:
148 resultset = c->tasks->u.search.resultset;
149 if (!resultset->setname)
150 resultset->setname = xstrdup("default");
151 ZOOM_options_set(resultset->options, "setname", resultset->setname);
152 start = &c->tasks->u.search.start;
153 count = &c->tasks->u.search.count;
155 case ZOOM_TASK_RETRIEVE:
156 resultset = c->tasks->u.retrieve.resultset;
158 start = &c->tasks->u.retrieve.start;
159 count = &c->tasks->u.retrieve.count;
161 if (*start >= resultset->size)
162 return zoom_complete;
163 if (*start + *count > resultset->size)
164 *count = resultset->size - *start;
166 for (i = 0; i < *count; i++)
169 ZOOM_record_cache_lookup(resultset, i + *start,
170 c->tasks->u.retrieve.syntax,
171 c->tasks->u.retrieve.elementSetName);
176 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_RECV_RECORD);
177 ZOOM_connection_put_event(c, event);
184 return zoom_complete;
187 return zoom_complete;
189 assert(resultset->query);
191 sr = ZOOM_srw_get_pdu(c, Z_SRW_searchRetrieve_request);
192 z_query = ZOOM_query_get_Z_Query(resultset->query);
194 if (z_query->which == Z_Query_type_104
195 && z_query->u.type_104->which == Z_External_CQL)
197 sr->u.request->query_type = Z_SRW_query_type_cql;
198 sr->u.request->query.cql = z_query->u.type_104->u.cql;
200 else if (z_query->which == Z_Query_type_1 && z_query->u.type_1)
202 sr->u.request->query_type = Z_SRW_query_type_pqf;
203 sr->u.request->query.pqf =
204 ZOOM_query_get_query_string(resultset->query);
208 ZOOM_set_error(c, ZOOM_ERROR_UNSUPPORTED_QUERY, 0);
209 return zoom_complete;
211 sr->u.request->startRecord = odr_intdup(c->odr_out, *start + 1);
212 sr->u.request->maximumRecords = odr_intdup(
213 c->odr_out, (resultset->step > 0 && resultset->step < *count) ?
214 resultset->step : *count);
215 sr->u.request->recordSchema = resultset->schema;
217 option_val = ZOOM_resultset_option_get(resultset, "recordPacking");
219 sr->u.request->recordPacking = odr_strdup(c->odr_out, option_val);
221 option_val = ZOOM_resultset_option_get(resultset, "extraArgs");
222 yaz_encode_sru_extra(sr, c->odr_out, option_val);
223 return send_srw(c, sr);
226 zoom_ret ZOOM_connection_srw_send_search(ZOOM_connection c)
228 return zoom_complete;
233 static zoom_ret handle_srw_response(ZOOM_connection c,
234 Z_SRW_searchRetrieveResponse *res)
236 ZOOM_resultset resultset = 0;
241 const char *syntax, *elementSetName;
244 return zoom_complete;
246 switch(c->tasks->which)
248 case ZOOM_TASK_SEARCH:
249 resultset = c->tasks->u.search.resultset;
250 start = &c->tasks->u.search.start;
251 count = &c->tasks->u.search.count;
252 syntax = c->tasks->u.search.syntax;
253 elementSetName = c->tasks->u.search.elementSetName;
255 if (!c->tasks->u.search.recv_search_fired)
257 event = ZOOM_Event_create(ZOOM_EVENT_RECV_SEARCH);
258 ZOOM_connection_put_event(c, event);
259 c->tasks->u.search.recv_search_fired = 1;
262 case ZOOM_TASK_RETRIEVE:
263 resultset = c->tasks->u.retrieve.resultset;
264 start = &c->tasks->u.retrieve.start;
265 count = &c->tasks->u.retrieve.count;
266 syntax = c->tasks->u.retrieve.syntax;
267 elementSetName = c->tasks->u.retrieve.elementSetName;
270 return zoom_complete;
275 if (res->resultSetId)
276 ZOOM_resultset_option_set(resultset, "resultSetId", res->resultSetId);
278 yaz_log(c->log_details, "%p handle_srw_response got SRW response OK", c);
280 if (res->num_diagnostics > 0)
282 set_SRU_error(c, &res->diagnostics[0]);
286 if (res->numberOfRecords) {
287 resultset->size = *res->numberOfRecords;
288 yaz_log(YLOG_DEBUG, "res numberOfRecords " ODR_INT_PRINTF, *res->numberOfRecords);
290 for (i = 0; i<res->num_records; i++)
293 Z_SRW_record *sru_rec;
294 Z_SRW_diagnostic *diag = 0;
297 Z_NamePlusRecord *npr = (Z_NamePlusRecord *)
298 odr_malloc(c->odr_in, sizeof(Z_NamePlusRecord));
300 * TODO This does not work with 0-based recordPositions.
301 * We will iterate over one twice
303 if (res->records[i].recordPosition &&
304 *res->records[i].recordPosition > 0)
305 pos = *res->records[i].recordPosition - 1;
308 yaz_log(YLOG_DEBUG, "pos %d start %d ", pos, *start);
310 sru_rec = &res->records[i];
312 npr->databaseName = 0;
313 npr->which = Z_NamePlusRecord_databaseRecord;
314 npr->u.databaseRecord = (Z_External *)
315 odr_malloc(c->odr_in, sizeof(Z_External));
316 npr->u.databaseRecord->descriptor = 0;
317 npr->u.databaseRecord->direct_reference =
318 odr_oiddup(c->odr_in, yaz_oid_recsyn_xml);
319 npr->u.databaseRecord->which = Z_External_octet;
321 npr->u.databaseRecord->u.octet_aligned = (Odr_oct *)
322 odr_malloc(c->odr_in, sizeof(Odr_oct));
323 npr->u.databaseRecord->u.octet_aligned->buf = (unsigned char*)
324 sru_rec->recordData_buf;
325 npr->u.databaseRecord->u.octet_aligned->len =
326 npr->u.databaseRecord->u.octet_aligned->size =
327 sru_rec->recordData_len;
329 if (sru_rec->recordSchema
330 && !strcmp(sru_rec->recordSchema,
331 "info:srw/schema/1/diagnostics-v1.1"))
333 sru_decode_surrogate_diagnostics(sru_rec->recordData_buf,
334 sru_rec->recordData_len,
338 ZOOM_record_cache_add(resultset, npr, pos, syntax, elementSetName,
339 sru_rec->recordSchema, diag);
343 if (*count + *start > resultset->size)
344 *count = resultset->size - *start;
345 yaz_log(YLOG_DEBUG, "SRU result set size " ODR_INT_PRINTF " start %d count %d", resultset->size, *start, *count);
348 nmem = odr_extract_mem(c->odr_in);
349 nmem_transfer(odr_getmem(resultset->odr), nmem);
353 return ZOOM_connection_srw_send_search(c);
355 return zoom_complete;
360 static void handle_srw_scan_response(ZOOM_connection c,
361 Z_SRW_scanResponse *res)
363 NMEM nmem = odr_extract_mem(c->odr_in);
366 if (!c->tasks || c->tasks->which != ZOOM_TASK_SCAN)
368 scan = c->tasks->u.scan.scan;
370 if (res->num_diagnostics > 0)
371 set_SRU_error(c, &res->diagnostics[0]);
373 scan->scan_response = 0;
374 scan->srw_scan_response = res;
375 nmem_transfer(odr_getmem(scan->odr), nmem);
377 ZOOM_options_set_int(scan->options, "number", res->num_terms);
382 int ZOOM_handle_sru(ZOOM_connection c, Z_HTTP_Response *hres,
386 const char *addinfo = 0;
388 /* not redirect (normal response) */
389 if (!yaz_srw_check_content_type(hres))
391 addinfo = "content-type";
394 else if (c->sru_mode == zoom_sru_solr)
397 ret = yaz_solr_decode_response(c->odr_in, hres, &sr);
399 if (sr->which == Z_SRW_searchRetrieve_response)
400 *cret = handle_srw_response(c, sr->u.response);
404 Z_SOAP *soap_package = 0;
406 Z_SOAP_Handler soap_handlers[2] = {
407 {YAZ_XMLNS_SRU_v1_1, 0, (Z_SOAP_fun) yaz_srw_codec},
410 ret = z_soap_codec(o, &soap_package,
411 &hres->content_buf, &hres->content_len,
413 if (!ret && soap_package->which == Z_SOAP_generic &&
414 soap_package->u.generic->no == 0)
416 Z_SRW_PDU *sr = (Z_SRW_PDU*) soap_package->u.generic->p;
418 ZOOM_options_set(c->options, "sru_version", sr->srw_version);
419 ZOOM_options_setl(c->options, "sru_extra_response_data",
420 sr->extraResponseData_buf, sr->extraResponseData_len);
421 if (sr->which == Z_SRW_searchRetrieve_response)
422 *cret = handle_srw_response(c, sr->u.response);
423 else if (sr->which == Z_SRW_scan_response)
424 handle_srw_scan_response(c, sr->u.scan_response);
428 else if (!ret && (soap_package->which == Z_SOAP_fault
429 || soap_package->which == Z_SOAP_error))
431 ZOOM_set_HTTP_error(c, hres->code,
432 soap_package->u.fault->fault_code,
433 soap_package->u.fault->fault_string);
444 * c-file-style: "Stroustrup"
445 * indent-tabs-mode: nil
447 * vim: shiftwidth=4 tabstop=8 expandtab