src/zoom-p.h

   1 /* This file is part of the YAZ toolkit.
   2  * Copyright (C) Index Data.
   3  * All rights reserved.
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions are met:
   6  *
   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.
  15  *
  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.
  26  */
  27 /**
  28  * \file zoom-p.h
  29  * \brief Internal header for ZOOM implementation
  30  */
  31 #include <yaz/proto.h>
  32 #include <yaz/oid_db.h>
  33 #include <yaz/comstack.h>
  34 #include <yaz/wrbuf.h>
  35 #include <yaz/zoom.h>
  36 #include <yaz/srw.h>
  37 #include <yaz/cookie.h>
  38 #include <yaz/mutex.h>
  39 #if HAVE_LIBMEMCACHED_MEMCACHED_H
  40 #include <libmemcached/memcached.h>
  41 #endif
  42 #if HAVE_HIREDIS
  43 #include <hiredis/hiredis.h>
  44 #endif
  45
  46 #define SHPTR 1
  47
  48 typedef struct ZOOM_Event_p *ZOOM_Event;
  49
  50 typedef enum {
  51     zoom_sru_error,
  52     zoom_sru_soap,
  53     zoom_sru_get,
  54     zoom_sru_post,
  55     zoom_sru_solr
  56 } zoom_sru_mode;
  57
  58
  59 typedef struct ZOOM_task_p *ZOOM_task;
  60
  61 #define STATE_IDLE 0
  62 #define STATE_CONNECTING 1
  63 #define STATE_ESTABLISHED 2
  64
  65 struct ZOOM_connection_p {
  66     enum oid_proto proto;
  67     COMSTACK cs;
  68     char *host_port;
  69     int error;
  70     char *addinfo;
  71     char *diagset;
  72     int state;
  73     int mask;
  74     int reconnect_ok;
  75     ODR odr_in;
  76     ODR odr_out;
  77     ODR odr_print;
  78     ODR odr_save;
  79
  80     char *buf_in;
  81     int len_in;
  82     char *buf_out;
  83     int len_out;
  84     char *proxy;
  85     char *tproxy;
  86     char *charset;
  87     char *lang;
  88     char *cookie_out;
  89     char *cookie_in;
  90     char *client_IP;
  91     char *sru_version;
  92
  93     char *user;
  94     char *group;
  95     char *password;
  96     int url_authentication;
  97
  98     int async;
  99     int support_named_resultsets;
 100     int last_event;
 101
 102     int maximum_record_size;
 103     int preferred_message_size;
 104
 105     ZOOM_task tasks;
 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;
 113     char *location;
 114
 115     int log_details;
 116     int log_api;
 117     WRBUF saveAPDU_wrbuf;
 118 #if HAVE_LIBMEMCACHED_MEMCACHED_H
 119     memcached_st *mc_st;
 120 #endif
 121 #if HAVE_HIREDIS
 122     redisContext *redis_c;
 123 #endif
 124 };
 125
 126 typedef struct ZOOM_record_cache_p *ZOOM_record_cache;
 127
 128 #define RECORD_HASH_SIZE  131
 129
 130 struct ZOOM_resultset_p {
 131     Z_SortKeySpecList *r_sort_spec;
 132     ZOOM_query query;
 133     int refcount;
 134     Odr_int size;
 135     int step;
 136     int piggyback;
 137     char *setname;
 138     ODR odr;
 139     ZOOM_record_cache record_hash[RECORD_HASH_SIZE];
 140     ZOOM_options options;
 141     ZOOM_connection connection;
 142     char **databaseNames;
 143     int num_databaseNames;
 144     YAZ_MUTEX mutex;
 145 #if SHPTR
 146     struct WRBUF_shptr *record_wrbuf;
 147 #endif
 148     ZOOM_resultset next;
 149     char *req_facets;
 150     ZOOM_facet_field *res_facets;
 151     int num_res_facets;
 152     char **facets_names; /* redundant. For ZOOM_resultset_facets_names only */
 153     WRBUF mc_key;
 154     int live_set; /* 0=no hit count, 1=cached hit, 2=hits + real set */
 155 };
 156
 157 struct facet_term_p {
 158     char *term;
 159     int frequency;
 160 };
 161
 162 struct ZOOM_facet_field_p {
 163     char *facet_name;
 164     int num_terms;
 165     struct facet_term_p *facet_terms;
 166 };
 167
 168 struct ZOOM_scanset_p {
 169     int refcount;
 170     ODR odr;
 171     ZOOM_options options;
 172     ZOOM_connection connection;
 173     ZOOM_query query;
 174     Z_ScanResponse *scan_response;
 175     Z_SRW_scanResponse *srw_scan_response;
 176
 177     char **databaseNames;
 178     int num_databaseNames;
 179 };
 180
 181 struct ZOOM_package_p {
 182     int refcount;
 183     ODR odr_out;
 184     ZOOM_options options;
 185     ZOOM_connection connection;
 186     char *buf_out;
 187     int len_out;
 188 };
 189
 190 struct ZOOM_task_p {
 191     int running;
 192     int which;
 193     union {
 194 #define ZOOM_TASK_SEARCH 1
 195         struct {
 196             int count;
 197             int start;
 198             ZOOM_resultset resultset;
 199             char *syntax;
 200             char *elementSetName;
 201             char *schema;
 202         } search;
 203 #define ZOOM_TASK_CONNECT 3
 204 #define ZOOM_TASK_SCAN 4
 205         struct {
 206             ZOOM_scanset scan;
 207         } scan;
 208 #define ZOOM_TASK_PACKAGE 5
 209         ZOOM_package package;
 210 #define ZOOM_TASK_SORT 6
 211         struct {
 212             ZOOM_resultset resultset;
 213             ZOOM_query q;
 214         } sort;
 215     } u;
 216     ZOOM_task next;
 217 };
 218
 219 typedef enum {
 220     zoom_pending,
 221     zoom_complete
 222 } zoom_ret;
 223
 224 void ZOOM_options_addref (ZOOM_options opt);
 225
 226 void ZOOM_handle_Z3950_apdu(ZOOM_connection c, Z_APDU *apdu);
 227
 228 void ZOOM_set_dset_error(ZOOM_connection c, int error,
 229                          const char *dset,
 230                          const char *addinfo, const char *addinfo2);
 231
 232 void ZOOM_set_error(ZOOM_connection c, int error, const char *addinfo);
 233
 234 ZOOM_Event ZOOM_Event_create(int kind);
 235 void ZOOM_connection_put_event(ZOOM_connection c, ZOOM_Event event);
 236
 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,
 242                                      int *num, ODR odr);
 243 zoom_ret ZOOM_connection_Z3950_send_init(ZOOM_connection c);
 244
 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);
 248
 249 ZOOM_record ZOOM_record_cache_lookup(ZOOM_resultset r, int pos,
 250                                      const char *syntax,
 251                                      const char *elementSetName,
 252                                      const char *schema);
 253 void ZOOM_record_cache_add(ZOOM_resultset r, Z_NamePlusRecord *npr,
 254                            int pos,
 255                            const char *syntax, const char *elementSetName,
 256                            const char *schema,
 257                            Z_SRW_diagnostic *diag);
 258
 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);
 264
 265 int ZOOM_uri_to_code(const char *uri);
 266
 267 zoom_ret ZOOM_connection_srw_send_search(ZOOM_connection c);
 268 zoom_ret ZOOM_connection_srw_send_scan(ZOOM_connection c);
 269
 270 int ZOOM_handle_sru(ZOOM_connection c, Z_HTTP_Response *hres,
 271                     zoom_ret *cret, char **addinfo);
 272
 273 void ZOOM_set_HTTP_error(ZOOM_connection c, int error,
 274                          const char *addinfo, const char *addinfo2);
 275
 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);
 281
 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,
 290                         int pos,
 291                         const char *syntax, const char *elementSetName,
 292                         const char *schema,
 293                         Z_SRW_diagnostic *diag);
 294 Z_NamePlusRecord *ZOOM_memcached_lookup(ZOOM_resultset r, int pos,
 295                                         const char *syntax,
 296                                         const char *elementSetName,
 297                                         const char *schema);
 298 ZOOM_record ZOOM_record_cache_lookup_i(ZOOM_resultset r, int pos,
 299                                        const char *syntax,
 300                                        const char *elementSetName,
 301                                        const char *schema);
 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);
 306
 307 /*
 308  * Local variables:
 309  * c-basic-offset: 4
 310  * c-file-style: "Stroustrup"
 311  * indent-tabs-mode: nil
 312  * End:
 313  * vim: shiftwidth=4 tabstop=8 expandtab
 314  */
 315