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
  43 #define SHPTR 1
  44
  45 typedef struct ZOOM_Event_p *ZOOM_Event;
  46
  47 typedef enum {
  48     zoom_sru_error,
  49     zoom_sru_soap,
  50     zoom_sru_get,
  51     zoom_sru_post,
  52     zoom_sru_solr
  53 } zoom_sru_mode;
  54
  55
  56 typedef struct ZOOM_task_p *ZOOM_task;
  57
  58 #define STATE_IDLE 0
  59 #define STATE_CONNECTING 1
  60 #define STATE_ESTABLISHED 2
  61
  62 struct ZOOM_connection_p {
  63     enum oid_proto proto;
  64     COMSTACK cs;
  65     char *host_port;
  66     int error;
  67     char *addinfo;
  68     char *diagset;
  69     int state;
  70     int mask;
  71     int reconnect_ok;
  72     ODR odr_in;
  73     ODR odr_out;
  74     ODR odr_print;
  75     ODR odr_save;
  76
  77     char *buf_in;
  78     int len_in;
  79     char *buf_out;
  80     int len_out;
  81     char *proxy;
  82     char *tproxy;
  83     char *charset;
  84     char *lang;
  85     char *cookie_out;
  86     char *cookie_in;
  87     char *client_IP;
  88     char *sru_version;
  89
  90     char *user;
  91     char *group;
  92     char *password;
  93     int url_authentication;
  94
  95     int async;
  96     int support_named_resultsets;
  97     int last_event;
  98
  99     int maximum_record_size;
 100     int preferred_message_size;
 101
 102     ZOOM_task tasks;
 103     ZOOM_options options;
 104     ZOOM_resultset resultsets;
 105     ZOOM_Event m_queue_front;
 106     ZOOM_Event m_queue_back;
 107     zoom_sru_mode sru_mode;
 108     int no_redirects; /* 0 for no redirects. >0 for number of redirects */
 109     yaz_cookies_t cookies;
 110     char *location;
 111
 112     int log_details;
 113     int log_api;
 114     WRBUF saveAPDU_wrbuf;
 115 #if HAVE_LIBMEMCACHED_MEMCACHED_H
 116     memcached_st *mc_st;
 117 #endif
 118 };
 119
 120 typedef struct ZOOM_record_cache_p *ZOOM_record_cache;
 121
 122 #define RECORD_HASH_SIZE  131
 123
 124 struct ZOOM_resultset_p {
 125     Z_SortKeySpecList *r_sort_spec;
 126     ZOOM_query query;
 127     int refcount;
 128     Odr_int size;
 129     int step;
 130     int piggyback;
 131     char *setname;
 132     ODR odr;
 133     ZOOM_record_cache record_hash[RECORD_HASH_SIZE];
 134     ZOOM_options options;
 135     ZOOM_connection connection;
 136     char **databaseNames;
 137     int num_databaseNames;
 138     YAZ_MUTEX mutex;
 139 #if SHPTR
 140     struct WRBUF_shptr *record_wrbuf;
 141 #endif
 142     ZOOM_resultset next;
 143     char *req_facets;
 144     ZOOM_facet_field *res_facets;
 145     int num_res_facets;
 146     char **facets_names; /* redundant. For ZOOM_resultset_facets_names only */
 147     WRBUF mc_key;
 148     int live_set; /* 0=no hit count, 1=cached hit, 2=hits + real set */
 149 };
 150
 151 struct facet_term_p {
 152     char *term;
 153     int frequency;
 154 };
 155
 156 struct ZOOM_facet_field_p {
 157     char *facet_name;
 158     int num_terms;
 159     struct facet_term_p *facet_terms;
 160 };
 161
 162 struct ZOOM_scanset_p {
 163     int refcount;
 164     ODR odr;
 165     ZOOM_options options;
 166     ZOOM_connection connection;
 167     ZOOM_query query;
 168     Z_ScanResponse *scan_response;
 169     Z_SRW_scanResponse *srw_scan_response;
 170
 171     char **databaseNames;
 172     int num_databaseNames;
 173 };
 174
 175 struct ZOOM_package_p {
 176     int refcount;
 177     ODR odr_out;
 178     ZOOM_options options;
 179     ZOOM_connection connection;
 180     char *buf_out;
 181     int len_out;
 182 };
 183
 184 struct ZOOM_task_p {
 185     int running;
 186     int which;
 187     union {
 188 #define ZOOM_TASK_SEARCH 1
 189         struct {
 190             int count;
 191             int start;
 192             ZOOM_resultset resultset;
 193             char *syntax;
 194             char *elementSetName;
 195             char *schema;
 196         } search;
 197 #define ZOOM_TASK_CONNECT 3
 198 #define ZOOM_TASK_SCAN 4
 199         struct {
 200             ZOOM_scanset scan;
 201         } scan;
 202 #define ZOOM_TASK_PACKAGE 5
 203         ZOOM_package package;
 204 #define ZOOM_TASK_SORT 6
 205         struct {
 206             ZOOM_resultset resultset;
 207             ZOOM_query q;
 208         } sort;
 209     } u;
 210     ZOOM_task next;
 211 };
 212
 213 typedef enum {
 214     zoom_pending,
 215     zoom_complete
 216 } zoom_ret;
 217
 218 void ZOOM_options_addref (ZOOM_options opt);
 219
 220 void ZOOM_handle_Z3950_apdu(ZOOM_connection c, Z_APDU *apdu);
 221
 222 void ZOOM_set_dset_error(ZOOM_connection c, int error,
 223                          const char *dset,
 224                          const char *addinfo, const char *addinfo2);
 225
 226 void ZOOM_set_error(ZOOM_connection c, int error, const char *addinfo);
 227
 228 ZOOM_Event ZOOM_Event_create(int kind);
 229 void ZOOM_connection_put_event(ZOOM_connection c, ZOOM_Event event);
 230
 231 zoom_ret ZOOM_connection_Z3950_search(ZOOM_connection c);
 232 zoom_ret ZOOM_connection_Z3950_send_scan(ZOOM_connection c);
 233 zoom_ret ZOOM_send_buf(ZOOM_connection c);
 234 zoom_ret send_Z3950_sort(ZOOM_connection c, ZOOM_resultset resultset);
 235 char **ZOOM_connection_get_databases(ZOOM_connection con, ZOOM_options options,
 236                                      int *num, ODR odr);
 237 zoom_ret ZOOM_connection_Z3950_send_init(ZOOM_connection c);
 238
 239 ZOOM_task ZOOM_connection_add_task(ZOOM_connection c, int which);
 240 void ZOOM_connection_remove_task(ZOOM_connection c);
 241 int ZOOM_test_reconnect(ZOOM_connection c);
 242
 243 ZOOM_record ZOOM_record_cache_lookup(ZOOM_resultset r, int pos,
 244                                      const char *syntax,
 245                                      const char *elementSetName,
 246                                      const char *schema);
 247 void ZOOM_record_cache_add(ZOOM_resultset r, Z_NamePlusRecord *npr,
 248                            int pos,
 249                            const char *syntax, const char *elementSetName,
 250                            const char *schema,
 251                            Z_SRW_diagnostic *diag);
 252
 253 Z_Query *ZOOM_query_get_Z_Query(ZOOM_query s);
 254 Z_SortKeySpecList *ZOOM_query_get_sortspec(ZOOM_query s);
 255 const char *ZOOM_query_get_query_string(ZOOM_query s);
 256 const char *ZOOM_query_get_sru11(ZOOM_query s);
 257 void ZOOM_query_get_hash(ZOOM_query s, WRBUF w);
 258
 259 int ZOOM_uri_to_code(const char *uri);
 260
 261 zoom_ret ZOOM_connection_srw_send_search(ZOOM_connection c);
 262 zoom_ret ZOOM_connection_srw_send_scan(ZOOM_connection c);
 263
 264 int ZOOM_handle_sru(ZOOM_connection c, Z_HTTP_Response *hres,
 265                     zoom_ret *cret, char **addinfo);
 266
 267 void ZOOM_set_HTTP_error(ZOOM_connection c, int error,
 268                          const char *addinfo, const char *addinfo2);
 269
 270 ZOOM_Event ZOOM_connection_get_event(ZOOM_connection c);
 271 void ZOOM_connection_remove_events(ZOOM_connection c);
 272 void ZOOM_Event_destroy(ZOOM_Event event);
 273 zoom_ret ZOOM_send_GDU(ZOOM_connection c, Z_GDU *gdu);
 274 void ZOOM_handle_facet_list(ZOOM_resultset r, Z_FacetList *fl);
 275
 276 void ZOOM_memcached_init(ZOOM_connection c);
 277 int ZOOM_memcached_configure(ZOOM_connection c);
 278 void ZOOM_memcached_destroy(ZOOM_connection c);
 279 void ZOOM_memcached_resultset(ZOOM_resultset r, ZOOM_query q);
 280 void ZOOM_memcached_search(ZOOM_connection c, ZOOM_resultset r);
 281 void ZOOM_memcached_hitcount(ZOOM_connection c, ZOOM_resultset result,
 282                              Z_OtherInformation *oi, const char *precision);
 283 void ZOOM_memcached_add(ZOOM_resultset r, Z_NamePlusRecord *npr,
 284                         int pos,
 285                         const char *syntax, const char *elementSetName,
 286                         const char *schema,
 287                         Z_SRW_diagnostic *diag);
 288 Z_NamePlusRecord *ZOOM_memcached_lookup(ZOOM_resultset r, int pos,
 289                                         const char *syntax,
 290                                         const char *elementSetName,
 291                                         const char *schema);
 292 ZOOM_record ZOOM_record_cache_lookup_i(ZOOM_resultset r, int pos,
 293                                        const char *syntax,
 294                                        const char *elementSetName,
 295                                        const char *schema);
 296 void ZOOM_handle_facet_result(ZOOM_connection c, ZOOM_resultset r,
 297                               Z_OtherInformation *o);
 298 void ZOOM_handle_search_result(ZOOM_connection c, ZOOM_resultset resultset,
 299                                Z_OtherInformation *o);
 300
 301 /*
 302  * Local variables:
 303  * c-basic-offset: 4
 304  * c-file-style: "Stroustrup"
 305  * indent-tabs-mode: nil
 306  * End:
 307  * vim: shiftwidth=4 tabstop=8 expandtab
 308  */
 309