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 #if HAVE_LIBMEMCACHED_MEMCACHED_H
167 /* TODO: add sorting */
168 if (c->mc_st && resultset->live_set == 0)
172 memcached_return_t rc;
173 char *v = memcached_get(c->mc_st, wrbuf_buf(resultset->mc_key),
174 wrbuf_len(resultset->mc_key),
175 &v_len, &flags, &rc);
179 WRBUF w = wrbuf_alloc();
181 wrbuf_write(w, v, v_len);
183 resultset->size = odr_atoi(wrbuf_cstr(w));
185 yaz_log(YLOG_LOG, "For key %s got value %s",
186 wrbuf_cstr(resultset->mc_key), wrbuf_cstr(w));
189 event = ZOOM_Event_create(ZOOM_EVENT_RECV_SEARCH);
190 ZOOM_connection_put_event(c, event);
191 resultset->live_set = 1;
195 if (!resultset->setname)
196 resultset->setname = xstrdup("default");
197 ZOOM_options_set(resultset->options, "setname", resultset->setname);
198 start = &c->tasks->u.search.start;
199 count = &c->tasks->u.search.count;
200 facets = ZOOM_options_get(resultset->options, "facets");
202 facet_list = yaz_pqf_parse_facet_list(c->odr_out, facets);
203 schema = c->tasks->u.search.schema;
205 if (resultset->live_set)
207 if (*start >= resultset->size)
208 return zoom_complete;
209 if (*start + *count > resultset->size)
210 *count = resultset->size - *start;
212 for (i = 0; i < *count; i++)
215 ZOOM_record_cache_lookup(resultset, i + *start,
216 c->tasks->u.search.syntax,
217 c->tasks->u.search.elementSetName,
225 if (*count == 0 && resultset->live_set)
226 return zoom_complete;
228 assert(resultset->query);
230 sr = ZOOM_srw_get_pdu(c, Z_SRW_searchRetrieve_request);
231 z_query = ZOOM_query_get_Z_Query(resultset->query);
233 if (z_query->which == Z_Query_type_104
234 && z_query->u.type_104->which == Z_External_CQL)
236 sr->u.request->queryType = "cql";
237 sr->u.request->query = z_query->u.type_104->u.cql;
239 else if (z_query->which == Z_Query_type_1 && z_query->u.type_1)
241 sr->u.request->queryType = "pqf";
242 sr->u.request->query =
243 odr_strdup(c->odr_out,
244 ZOOM_query_get_query_string(resultset->query));
248 ZOOM_set_error(c, ZOOM_ERROR_UNSUPPORTED_QUERY, 0);
249 return zoom_complete;
252 option_val = ZOOM_query_get_sru11(resultset->query);
255 sr->u.request->sort_type = Z_SRW_sort_type_sort;
256 sr->u.request->sort.sortKeys = odr_strdup(c->odr_out, option_val);
258 sr->u.request->startRecord = odr_intdup(c->odr_out, *start + 1);
259 sr->u.request->maximumRecords = odr_intdup(
260 c->odr_out, (resultset->step > 0 && resultset->step < *count) ?
261 resultset->step : *count);
262 sr->u.request->recordSchema = odr_strdup_null(c->odr_out, schema);
263 sr->u.request->facetList = facet_list;
265 option_val = ZOOM_resultset_option_get(resultset, "recordPacking");
267 sr->u.request->recordPacking = odr_strdup(c->odr_out, option_val);
269 option_val = ZOOM_resultset_option_get(resultset, "extraArgs");
270 yaz_encode_sru_extra(sr, c->odr_out, option_val);
271 return send_srw(c, sr);
274 zoom_ret ZOOM_connection_srw_send_search(ZOOM_connection c)
276 return zoom_complete;
281 static zoom_ret handle_srw_response(ZOOM_connection c,
282 Z_SRW_searchRetrieveResponse *res)
284 ZOOM_resultset resultset = 0;
288 const char *syntax, *elementSetName, *schema;
291 return zoom_complete;
293 if (c->tasks->which != ZOOM_TASK_SEARCH)
294 return zoom_complete;
296 resultset = c->tasks->u.search.resultset;
297 syntax = c->tasks->u.search.syntax;
298 elementSetName = c->tasks->u.search.elementSetName;
299 schema = c->tasks->u.search.schema;
301 if (resultset->live_set == 0)
303 event = ZOOM_Event_create(ZOOM_EVENT_RECV_SEARCH);
304 ZOOM_connection_put_event(c, event);
307 ZOOM_handle_facet_list(resultset, res->facetList);
311 if (res->resultSetId)
312 ZOOM_resultset_option_set(resultset, "resultSetId", res->resultSetId);
314 yaz_log(c->log_details, "%p handle_srw_response got SRW response OK", c);
316 if (res->num_diagnostics > 0)
318 resultset->live_set = 2;
319 set_SRU_error(c, &res->diagnostics[0]);
323 if (res->numberOfRecords)
325 resultset->size = *res->numberOfRecords;
326 #if HAVE_LIBMEMCACHED_MEMCACHED_H
327 if (c->mc_st && resultset->live_set == 0)
330 memcached_return_t rc;
331 time_t expiration = 36000;
334 sprintf(str, ODR_INT_PRINTF, resultset->size);
335 rc = memcached_set(c->mc_st,
336 wrbuf_buf(resultset->mc_key),wrbuf_len(resultset->mc_key),
337 str, strlen(str), expiration, flags);
338 yaz_log(YLOG_LOG, "Store SRU hit count key=%s value=%s rc=%u %s",
339 wrbuf_cstr(resultset->mc_key), str, (unsigned) rc,
340 memcached_last_error_message(c->mc_st));
344 resultset->live_set = 2;
345 if (res->suggestions)
346 ZOOM_resultset_option_set(resultset, "suggestions",
348 for (i = 0; i < res->num_records; i++)
350 int pos = c->tasks->u.search.start + i;
351 Z_SRW_record *sru_rec;
352 Z_SRW_diagnostic *diag = 0;
355 /* only trust recordPosition if >= calculated position */
356 if (res->records[i].recordPosition &&
357 *res->records[i].recordPosition >= pos + 1)
358 pos = *res->records[i].recordPosition - 1;
360 if (!ZOOM_record_cache_lookup(resultset,
362 syntax, elementSetName, schema))
364 Z_NamePlusRecord *npr = (Z_NamePlusRecord *)
365 odr_malloc(c->odr_in, sizeof(Z_NamePlusRecord));
366 sru_rec = &res->records[i];
368 npr->databaseName = 0;
369 npr->which = Z_NamePlusRecord_databaseRecord;
370 npr->u.databaseRecord = (Z_External *)
371 odr_malloc(c->odr_in, sizeof(Z_External));
372 npr->u.databaseRecord->descriptor = 0;
373 npr->u.databaseRecord->direct_reference =
374 odr_oiddup(c->odr_in, yaz_oid_recsyn_xml);
375 npr->u.databaseRecord->indirect_reference = 0;
376 npr->u.databaseRecord->which = Z_External_octet;
378 npr->u.databaseRecord->u.octet_aligned =
379 odr_create_Odr_oct(c->odr_in,
380 sru_rec->recordData_buf,
381 sru_rec->recordData_len);
382 if (sru_rec->recordSchema
383 && !strcmp(sru_rec->recordSchema,
384 "info:srw/schema/1/diagnostics-v1.1"))
386 sru_decode_surrogate_diagnostics(sru_rec->recordData_buf,
387 sru_rec->recordData_len,
391 ZOOM_record_cache_add(resultset, npr,
392 pos, syntax, elementSetName,
396 nmem = odr_extract_mem(c->odr_in);
397 nmem_transfer(odr_getmem(resultset->odr), nmem);
400 return ZOOM_connection_srw_send_search(c);
402 return zoom_complete;
407 static void handle_srw_scan_response(ZOOM_connection c,
408 Z_SRW_scanResponse *res)
410 NMEM nmem = odr_extract_mem(c->odr_in);
413 if (!c->tasks || c->tasks->which != ZOOM_TASK_SCAN)
415 scan = c->tasks->u.scan.scan;
417 if (res->num_diagnostics > 0)
418 set_SRU_error(c, &res->diagnostics[0]);
420 scan->scan_response = 0;
421 scan->srw_scan_response = res;
422 nmem_transfer(odr_getmem(scan->odr), nmem);
424 ZOOM_options_set_int(scan->options, "number", res->num_terms);
429 int ZOOM_handle_sru(ZOOM_connection c, Z_HTTP_Response *hres,
430 zoom_ret *cret, char **addinfo)
435 /* not redirect (normal response) */
436 if (!yaz_srw_check_content_type(hres))
438 *addinfo = "content-type";
441 else if (c->sru_mode == zoom_sru_solr)
444 ret = yaz_solr_decode_response(c->odr_in, hres, &sr);
447 if (sr->which == Z_SRW_searchRetrieve_response)
448 *cret = handle_srw_response(c, sr->u.response);
449 else if (sr->which == Z_SRW_scan_response)
450 handle_srw_scan_response(c, sr->u.scan_response);
455 Z_SOAP *soap_package = 0;
457 Z_SOAP_Handler soap_handlers[4] = {
458 {YAZ_XMLNS_SRU_v1_response, 0, (Z_SOAP_fun) yaz_srw_codec},
459 {YAZ_XMLNS_SRU_v2_mask, 0, (Z_SOAP_fun) yaz_srw_codec},
460 {"searchRetrieveResponse", 0, (Z_SOAP_fun) yaz_srw_codec},
463 ret = z_soap_codec(o, &soap_package,
464 &hres->content_buf, &hres->content_len,
466 if (!ret && soap_package->which == Z_SOAP_generic)
468 Z_SRW_PDU *sr = (Z_SRW_PDU*) soap_package->u.generic->p;
470 ZOOM_options_set(c->options, "sru_version", sr->srw_version);
471 ZOOM_options_setl(c->options, "sru_extra_response_data",
472 sr->extraResponseData_buf, sr->extraResponseData_len);
473 if (sr->which == Z_SRW_searchRetrieve_response)
474 *cret = handle_srw_response(c, sr->u.response);
475 else if (sr->which == Z_SRW_scan_response)
476 handle_srw_scan_response(c, sr->u.scan_response);
480 else if (!ret && (soap_package->which == Z_SOAP_fault
481 || soap_package->which == Z_SOAP_error))
483 ZOOM_set_HTTP_error(c, hres->code,
484 soap_package->u.fault->fault_code,
485 soap_package->u.fault->fault_string);
489 size_t max_chars = 1000;
490 size_t sz = hres->content_len;
491 if (sz > max_chars - 1)
493 *addinfo = odr_malloc(c->odr_in, sz + 4);
494 memcpy(*addinfo, hres->content_buf, sz);
496 strcpy(*addinfo + sz, "...");
498 strcpy(*addinfo + sz, "");
511 * c-file-style: "Stroustrup"
512 * indent-tabs-mode: nil
514 * vim: shiftwidth=4 tabstop=8 expandtab