src/zoom-p.h

   1 /* This file is part of the YAZ toolkit.
   2  * Copyright (C) 1995-2013 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/mutex.h>
  38
  39 #define SHPTR 1
  40 #define ZOOM_RESULT_LISTS 0
  41
  42 typedef struct ZOOM_Event_p *ZOOM_Event;
  43
  44 typedef enum {
  45     zoom_sru_error,
  46     zoom_sru_soap,
  47     zoom_sru_get,
  48     zoom_sru_post,
  49     zoom_sru_solr
  50 } zoom_sru_mode;
  51
  52
  53 typedef struct ZOOM_task_p *ZOOM_task;
  54
  55 #define STATE_IDLE 0
  56 #define STATE_CONNECTING 1
  57 #define STATE_ESTABLISHED 2
  58
  59 #if ZOOM_RESULT_LISTS
  60 typedef struct ZOOM_resultsets_p *ZOOM_resultsets;
  61 #endif
  62
  63 struct ZOOM_connection_p {
  64     enum oid_proto proto;
  65     COMSTACK cs;
  66     char *host_port;
  67     int error;
  68     char *addinfo;
  69     char *diagset;
  70     int state;
  71     int mask;
  72     int reconnect_ok;
  73     ODR odr_in;
  74     ODR odr_out;
  75     ODR odr_print;
  76     ODR odr_save;
  77
  78     char *buf_in;
  79     int len_in;
  80     char *buf_out;
  81     int len_out;
  82     char *proxy;
  83     char *tproxy;
  84     char *charset;
  85     char *lang;
  86     char *cookie_out;
  87     char *cookie_in;
  88     char *client_IP;
  89     char *sru_version;
  90
  91     char *user;
  92     char *group;
  93     char *password;
  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 #if ZOOM_RESULT_LISTS
 105     ZOOM_resultsets resultsets;
 106 #else
 107     ZOOM_resultset resultsets;
 108 #endif
 109     ZOOM_Event m_queue_front;
 110     ZOOM_Event m_queue_back;
 111     zoom_sru_mode sru_mode;
 112     int no_redirects; /* 0 for no redirects. >0 for number of redirects */
 113
 114     int log_details;
 115     int log_api;
 116     WRBUF saveAPDU_wrbuf;
 117 };
 118
 119 #if ZOOM_RESULT_LISTS
 120 struct ZOOM_resultsets_p {
 121     ZOOM_resultset resultset;
 122     ZOOM_resultsets next;
 123 };
 124 #endif
 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 #if ZOOM_RESULT_LISTS
 149 #else
 150     ZOOM_resultset next;
 151 #endif
 152     ZOOM_facet_field *facets;
 153     int num_facets;
 154     char **facets_names;
 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             int recv_search_fired;
 203         } search;
 204 #define ZOOM_TASK_RETRIEVE 2
 205         struct {
 206             int start;
 207             ZOOM_resultset resultset;
 208             int count;
 209             char *syntax;
 210             char *elementSetName;
 211             char *schema;
 212         } retrieve;
 213 #define ZOOM_TASK_CONNECT 3
 214 #define ZOOM_TASK_SCAN 4
 215         struct {
 216             ZOOM_scanset scan;
 217         } scan;
 218 #define ZOOM_TASK_PACKAGE 5
 219         ZOOM_package package;
 220 #define ZOOM_TASK_SORT 6
 221         struct {
 222             ZOOM_resultset resultset;
 223             ZOOM_query q;
 224         } sort;
 225     } u;
 226     ZOOM_task next;
 227 };
 228
 229 typedef enum {
 230     zoom_pending,
 231     zoom_complete
 232 } zoom_ret;
 233
 234 void ZOOM_options_addref (ZOOM_options opt);
 235
 236 void ZOOM_handle_Z3950_apdu(ZOOM_connection c, Z_APDU *apdu);
 237
 238 void ZOOM_set_dset_error(ZOOM_connection c, int error,
 239                          const char *dset,
 240                          const char *addinfo, const char *addinfo2);
 241
 242 void ZOOM_set_error(ZOOM_connection c, int error, const char *addinfo);
 243
 244 ZOOM_Event ZOOM_Event_create(int kind);
 245 void ZOOM_connection_put_event(ZOOM_connection c, ZOOM_Event event);
 246
 247 zoom_ret ZOOM_connection_Z3950_send_search(ZOOM_connection c);
 248 zoom_ret send_Z3950_present(ZOOM_connection c);
 249 zoom_ret ZOOM_connection_Z3950_send_scan(ZOOM_connection c);
 250 zoom_ret ZOOM_send_buf(ZOOM_connection c);
 251 zoom_ret send_Z3950_sort(ZOOM_connection c, ZOOM_resultset resultset);
 252 char **ZOOM_connection_get_databases(ZOOM_connection con, ZOOM_options options,
 253                                      int *num, ODR odr);
 254 zoom_ret ZOOM_connection_Z3950_send_init(ZOOM_connection c);
 255
 256 ZOOM_task ZOOM_connection_add_task(ZOOM_connection c, int which);
 257 void ZOOM_connection_remove_task(ZOOM_connection c);
 258 int ZOOM_test_reconnect(ZOOM_connection c);
 259
 260 ZOOM_record ZOOM_record_cache_lookup(ZOOM_resultset r, int pos,
 261                                      const char *syntax,
 262                                      const char *elementSetName,
 263                                      const char *schema);
 264 void ZOOM_record_cache_add(ZOOM_resultset r, Z_NamePlusRecord *npr,
 265                            int pos,
 266                            const char *syntax, const char *elementSetName,
 267                            const char *schema,
 268                            Z_SRW_diagnostic *diag);
 269
 270 Z_Query *ZOOM_query_get_Z_Query(ZOOM_query s);
 271 Z_SortKeySpecList *ZOOM_query_get_sortspec(ZOOM_query s);
 272 const char *ZOOM_query_get_query_string(ZOOM_query s);
 273 const char *ZOOM_query_get_sru11(ZOOM_query s);
 274
 275 int ZOOM_uri_to_code(const char *uri);
 276
 277 zoom_ret ZOOM_connection_srw_send_search(ZOOM_connection c);
 278 zoom_ret ZOOM_connection_srw_send_scan(ZOOM_connection c);
 279
 280 int ZOOM_handle_sru(ZOOM_connection c, Z_HTTP_Response *hres,
 281                     zoom_ret *cret, char **addinfo);
 282
 283 void ZOOM_set_HTTP_error(ZOOM_connection c, int error,
 284                          const char *addinfo, const char *addinfo2);
 285
 286 ZOOM_Event ZOOM_connection_get_event(ZOOM_connection c);
 287 void ZOOM_connection_remove_events(ZOOM_connection c);
 288 void ZOOM_Event_destroy(ZOOM_Event event);
 289 zoom_ret ZOOM_send_GDU(ZOOM_connection c, Z_GDU *gdu);
 290 void ZOOM_handle_facet_list(ZOOM_resultset r, Z_FacetList *fl);
 291
 292 /*
 293  * Local variables:
 294  * c-basic-offset: 4
 295  * c-file-style: "Stroustrup"
 296  * indent-tabs-mode: nil
 297  * End:
 298  * vim: shiftwidth=4 tabstop=8 expandtab
 299  */
 300