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
 111     int log_details;
 112     int log_api;
 113     WRBUF saveAPDU_wrbuf;
 114 #if HAVE_LIBMEMCACHED_MEMCACHED_H
 115     memcached_st *mc_st;
 116 #endif
 117 };
 118
 119 typedef struct ZOOM_record_cache_p *ZOOM_record_cache;
 120
 121 #define RECORD_HASH_SIZE  131
 122
 123 struct ZOOM_resultset_p {
 124     Z_SortKeySpecList *r_sort_spec;
 125     ZOOM_query query;
 126     int refcount;
 127     Odr_int size;
 128     int step;
 129     int piggyback;
 130     char *setname;
 131     ODR odr;
 132     ZOOM_record_cache record_hash[RECORD_HASH_SIZE];
 133     ZOOM_options options;
 134     ZOOM_connection connection;
 135     char **databaseNames;
 136     int num_databaseNames;
 137     YAZ_MUTEX mutex;
 138 #if SHPTR
 139     struct WRBUF_shptr *record_wrbuf;
 140 #endif
 141     ZOOM_resultset next;
 142     char *req_facets;
 143     ZOOM_facet_field *res_facets;
 144     int num_res_facets;
 145     char **facets_names; /* redundant. For ZOOM_resultset_facets_names only */
 146     WRBUF mc_key;
 147     int live_set; /* 0=no hit count, 1=cached hit, 2=hits + real set */
 148 };
 149
 150 struct facet_term_p {
 151     char *term;
 152     int frequency;
 153 };
 154
 155 struct ZOOM_facet_field_p {
 156     char *facet_name;
 157     int num_terms;
 158     struct facet_term_p *facet_terms;
 159 };
 160
 161 struct ZOOM_scanset_p {
 162     int refcount;
 163     ODR odr;
 164     ZOOM_options options;
 165     ZOOM_connection connection;
 166     ZOOM_query query;
 167     Z_ScanResponse *scan_response;
 168     Z_SRW_scanResponse *srw_scan_response;
 169
 170     char **databaseNames;
 171     int num_databaseNames;
 172 };
 173
 174 struct ZOOM_package_p {
 175     int refcount;
 176     ODR odr_out;
 177     ZOOM_options options;
 178     ZOOM_connection connection;
 179     char *buf_out;
 180     int len_out;
 181 };
 182
 183 struct ZOOM_task_p {
 184     int running;
 185     int which;
 186     union {
 187 #define ZOOM_TASK_SEARCH 1
 188         struct {
 189             int count;
 190             int start;
 191             ZOOM_resultset resultset;
 192             char *syntax;
 193             char *elementSetName;
 194             char *schema;
 195         } search;
 196 #define ZOOM_TASK_CONNECT 3
 197 #define ZOOM_TASK_SCAN 4
 198         struct {
 199             ZOOM_scanset scan;
 200         } scan;
 201 #define ZOOM_TASK_PACKAGE 5
 202         ZOOM_package package;
 203 #define ZOOM_TASK_SORT 6
 204         struct {
 205             ZOOM_resultset resultset;
 206             ZOOM_query q;
 207         } sort;
 208     } u;
 209     ZOOM_task next;
 210 };
 211
 212 typedef enum {
 213     zoom_pending,
 214     zoom_complete
 215 } zoom_ret;
 216
 217 void ZOOM_options_addref (ZOOM_options opt);
 218
 219 void ZOOM_handle_Z3950_apdu(ZOOM_connection c, Z_APDU *apdu);
 220
 221 void ZOOM_set_dset_error(ZOOM_connection c, int error,
 222                          const char *dset,
 223                          const char *addinfo, const char *addinfo2);
 224
 225 void ZOOM_set_error(ZOOM_connection c, int error, const char *addinfo);
 226
 227 ZOOM_Event ZOOM_Event_create(int kind);
 228 void ZOOM_connection_put_event(ZOOM_connection c, ZOOM_Event event);
 229
 230 zoom_ret ZOOM_connection_Z3950_search(ZOOM_connection c);
 231 zoom_ret ZOOM_connection_Z3950_send_scan(ZOOM_connection c);
 232 zoom_ret ZOOM_send_buf(ZOOM_connection c);
 233 zoom_ret send_Z3950_sort(ZOOM_connection c, ZOOM_resultset resultset);
 234 char **ZOOM_connection_get_databases(ZOOM_connection con, ZOOM_options options,
 235                                      int *num, ODR odr);
 236 zoom_ret ZOOM_connection_Z3950_send_init(ZOOM_connection c);
 237
 238 ZOOM_task ZOOM_connection_add_task(ZOOM_connection c, int which);
 239 void ZOOM_connection_remove_task(ZOOM_connection c);
 240 int ZOOM_test_reconnect(ZOOM_connection c);
 241
 242 ZOOM_record ZOOM_record_cache_lookup(ZOOM_resultset r, int pos,
 243                                      const char *syntax,
 244                                      const char *elementSetName,
 245                                      const char *schema);
 246 void ZOOM_record_cache_add(ZOOM_resultset r, Z_NamePlusRecord *npr,
 247                            int pos,
 248                            const char *syntax, const char *elementSetName,
 249                            const char *schema,
 250                            Z_SRW_diagnostic *diag);
 251
 252 Z_Query *ZOOM_query_get_Z_Query(ZOOM_query s);
 253 Z_SortKeySpecList *ZOOM_query_get_sortspec(ZOOM_query s);
 254 const char *ZOOM_query_get_query_string(ZOOM_query s);
 255 const char *ZOOM_query_get_sru11(ZOOM_query s);
 256 void ZOOM_query_get_hash(ZOOM_query s, WRBUF w);
 257
 258 int ZOOM_uri_to_code(const char *uri);
 259
 260 zoom_ret ZOOM_connection_srw_send_search(ZOOM_connection c);
 261 zoom_ret ZOOM_connection_srw_send_scan(ZOOM_connection c);
 262
 263 int ZOOM_handle_sru(ZOOM_connection c, Z_HTTP_Response *hres,
 264                     zoom_ret *cret, char **addinfo);
 265
 266 void ZOOM_set_HTTP_error(ZOOM_connection c, int error,
 267                          const char *addinfo, const char *addinfo2);
 268
 269 ZOOM_Event ZOOM_connection_get_event(ZOOM_connection c);
 270 void ZOOM_connection_remove_events(ZOOM_connection c);
 271 void ZOOM_Event_destroy(ZOOM_Event event);
 272 zoom_ret ZOOM_send_GDU(ZOOM_connection c, Z_GDU *gdu);
 273 void ZOOM_handle_facet_list(ZOOM_resultset r, Z_FacetList *fl);
 274
 275 void ZOOM_memcached_init(ZOOM_connection c);
 276 int ZOOM_memcached_configure(ZOOM_connection c);
 277 void ZOOM_memcached_destroy(ZOOM_connection c);
 278 void ZOOM_memcached_resultset(ZOOM_resultset r, ZOOM_query q);
 279 void ZOOM_memcached_search(ZOOM_connection c, ZOOM_resultset r);
 280 void ZOOM_memcached_hitcount(ZOOM_connection c, ZOOM_resultset result,
 281                              Z_OtherInformation *oi, const char *precision);
 282 void ZOOM_memcached_add(ZOOM_resultset r, Z_NamePlusRecord *npr,
 283                         int pos,
 284                         const char *syntax, const char *elementSetName,
 285                         const char *schema,
 286                         Z_SRW_diagnostic *diag);
 287 Z_NamePlusRecord *ZOOM_memcached_lookup(ZOOM_resultset r, int pos,
 288                                         const char *syntax,
 289                                         const char *elementSetName,
 290                                         const char *schema);
 291
 292 void ZOOM_handle_facet_result(ZOOM_connection c, ZOOM_resultset r,
 293                               Z_OtherInformation *o);
 294 void ZOOM_handle_search_result(ZOOM_connection c, ZOOM_resultset resultset,
 295                                Z_OtherInformation *o);
 296
 297 /*
 298  * Local variables:
 299  * c-basic-offset: 4
 300  * c-file-style: "Stroustrup"
 301  * indent-tabs-mode: nil
 302  * End:
 303  * vim: shiftwidth=4 tabstop=8 expandtab
 304  */
 305