1 /* This file is part of the YAZ toolkit.
2 * Copyright (C) Index Data.
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions are met:
7 * * Redistributions of source code must retain the above copyright
8 * notice, this list of conditions and the following disclaimer.
9 * * Redistributions in binary form must reproduce the above copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution.
12 * * Neither the name of Index Data nor the names of its contributors
13 * may be used to endorse or promote products derived from this
14 * software without specific prior written permission.
16 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND ANY
17 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
18 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
19 * DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY
20 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
21 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
22 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
23 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
25 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 * \brief Internal header for ZOOM implementation
31 #include <yaz/proto.h>
32 #include <yaz/oid_db.h>
33 #include <yaz/comstack.h>
34 #include <yaz/wrbuf.h>
37 #include <yaz/cookie.h>
38 #include <yaz/mutex.h>
40 #include <libmemcached/memcached.h>
43 #include <hiredis/hiredis.h>
48 typedef struct ZOOM_Event_p *ZOOM_Event;
59 typedef struct ZOOM_task_p *ZOOM_task;
62 #define STATE_CONNECTING 1
63 #define STATE_ESTABLISHED 2
65 struct ZOOM_connection_p {
96 int url_authentication;
99 int support_named_resultsets;
102 int maximum_record_size;
103 int preferred_message_size;
106 ZOOM_options options;
107 ZOOM_resultset resultsets;
108 ZOOM_Event m_queue_front;
109 ZOOM_Event m_queue_back;
110 zoom_sru_mode sru_mode;
111 int no_redirects; /* 0 for no redirects. >0 for number of redirects */
112 yaz_cookies_t cookies;
117 WRBUF saveAPDU_wrbuf;
118 #if HAVE_LIBMEMCACHED
122 redisContext *redis_c;
126 typedef struct ZOOM_record_cache_p *ZOOM_record_cache;
128 #define RECORD_HASH_SIZE 131
130 struct ZOOM_resultset_p {
131 Z_SortKeySpecList *r_sort_spec;
139 ZOOM_record_cache record_hash[RECORD_HASH_SIZE];
140 ZOOM_options options;
141 ZOOM_connection connection;
142 char **databaseNames;
143 int num_databaseNames;
146 struct WRBUF_shptr *record_wrbuf;
150 ZOOM_facet_field *res_facets;
152 char **facets_names; /* redundant. For ZOOM_resultset_facets_names only */
154 int live_set; /* 0=no hit count, 1=cached hit, 2=hits + real set */
157 struct facet_term_p {
162 struct ZOOM_facet_field_p {
165 struct facet_term_p *facet_terms;
168 struct ZOOM_scanset_p {
171 ZOOM_options options;
172 ZOOM_connection connection;
174 Z_ScanResponse *scan_response;
175 Z_SRW_scanResponse *srw_scan_response;
177 char **databaseNames;
178 int num_databaseNames;
181 struct ZOOM_package_p {
184 ZOOM_options options;
185 ZOOM_connection connection;
194 #define ZOOM_TASK_SEARCH 1
198 ZOOM_resultset resultset;
200 char *elementSetName;
203 #define ZOOM_TASK_CONNECT 3
204 #define ZOOM_TASK_SCAN 4
208 #define ZOOM_TASK_PACKAGE 5
209 ZOOM_package package;
210 #define ZOOM_TASK_SORT 6
212 ZOOM_resultset resultset;
224 void ZOOM_options_addref (ZOOM_options opt);
226 void ZOOM_handle_Z3950_apdu(ZOOM_connection c, Z_APDU *apdu);
228 void ZOOM_set_dset_error(ZOOM_connection c, int error,
230 const char *addinfo, const char *addinfo2);
232 void ZOOM_set_error(ZOOM_connection c, int error, const char *addinfo);
234 ZOOM_Event ZOOM_Event_create(int kind);
235 void ZOOM_connection_put_event(ZOOM_connection c, ZOOM_Event event);
237 zoom_ret ZOOM_connection_Z3950_search(ZOOM_connection c);
238 zoom_ret ZOOM_connection_Z3950_send_scan(ZOOM_connection c);
239 zoom_ret ZOOM_send_buf(ZOOM_connection c);
240 zoom_ret send_Z3950_sort(ZOOM_connection c, ZOOM_resultset resultset);
241 char **ZOOM_connection_get_databases(ZOOM_connection con, ZOOM_options options,
243 zoom_ret ZOOM_connection_Z3950_send_init(ZOOM_connection c);
245 ZOOM_task ZOOM_connection_add_task(ZOOM_connection c, int which);
246 void ZOOM_connection_remove_task(ZOOM_connection c);
247 int ZOOM_test_reconnect(ZOOM_connection c);
249 ZOOM_record ZOOM_record_cache_lookup(ZOOM_resultset r, int pos,
251 const char *elementSetName,
253 void ZOOM_record_cache_add(ZOOM_resultset r, Z_NamePlusRecord *npr,
255 const char *syntax, const char *elementSetName,
257 Z_SRW_diagnostic *diag);
259 Z_Query *ZOOM_query_get_Z_Query(ZOOM_query s);
260 Z_SortKeySpecList *ZOOM_query_get_sortspec(ZOOM_query s);
261 const char *ZOOM_query_get_query_string(ZOOM_query s);
262 const char *ZOOM_query_get_sru11(ZOOM_query s);
263 void ZOOM_query_get_hash(ZOOM_query s, WRBUF w);
265 int ZOOM_uri_to_code(const char *uri);
267 zoom_ret ZOOM_connection_srw_send_search(ZOOM_connection c);
268 zoom_ret ZOOM_connection_srw_send_scan(ZOOM_connection c);
270 int ZOOM_handle_sru(ZOOM_connection c, Z_HTTP_Response *hres,
271 zoom_ret *cret, char **addinfo);
273 void ZOOM_set_HTTP_error(ZOOM_connection c, int error,
274 const char *addinfo, const char *addinfo2);
276 ZOOM_Event ZOOM_connection_get_event(ZOOM_connection c);
277 void ZOOM_connection_remove_events(ZOOM_connection c);
278 void ZOOM_Event_destroy(ZOOM_Event event);
279 zoom_ret ZOOM_send_GDU(ZOOM_connection c, Z_GDU *gdu);
280 void ZOOM_handle_facet_list(ZOOM_resultset r, Z_FacetList *fl);
282 void ZOOM_memcached_init(ZOOM_connection c);
283 int ZOOM_memcached_configure(ZOOM_connection c);
284 void ZOOM_memcached_destroy(ZOOM_connection c);
285 void ZOOM_memcached_resultset(ZOOM_resultset r, ZOOM_query q);
286 void ZOOM_memcached_search(ZOOM_connection c, ZOOM_resultset r);
287 void ZOOM_memcached_hitcount(ZOOM_connection c, ZOOM_resultset result,
288 Z_OtherInformation *oi, const char *precision);
289 void ZOOM_memcached_add(ZOOM_resultset r, Z_NamePlusRecord *npr,
291 const char *syntax, const char *elementSetName,
293 Z_SRW_diagnostic *diag);
294 Z_NamePlusRecord *ZOOM_memcached_lookup(ZOOM_resultset r, int pos,
296 const char *elementSetName,
298 ZOOM_record ZOOM_record_cache_lookup_i(ZOOM_resultset r, int pos,
300 const char *elementSetName,
302 void ZOOM_handle_facet_result(ZOOM_connection c, ZOOM_resultset r,
303 Z_OtherInformation *o);
304 void ZOOM_handle_search_result(ZOOM_connection c, ZOOM_resultset resultset,
305 Z_OtherInformation *o);
310 * c-file-style: "Stroustrup"
311 * indent-tabs-mode: nil
313 * vim: shiftwidth=4 tabstop=8 expandtab