src/zoom-p.h

   1 /* This file is part of the YAZ toolkit.
   2  * Copyright (C) 1995-2011 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     char *buf_in;
  77     int len_in;
  78     char *buf_out;
  79     int len_out;
  80     char *proxy;
  81     char *charset;
  82     char *lang;
  83     char *cookie_out;
  84     char *cookie_in;
  85     char *client_IP;
  86     char *sru_version;
  87
  88     char *user;
  89     char *group;
  90     char *password;
  91
  92     int async;
  93     int support_named_resultsets;
  94     int last_event;
  95
  96     int maximum_record_size;
  97     int preferred_message_size;
  98
  99     ZOOM_task tasks;
 100     ZOOM_options options;
 101 #if ZOOM_RESULT_LISTS
 102     ZOOM_resultsets resultsets;
 103 #else
 104     ZOOM_resultset resultsets;
 105 #endif
 106     ZOOM_Event m_queue_front;
 107     ZOOM_Event m_queue_back;
 108     zoom_sru_mode sru_mode;
 109     int no_redirects; /* 0 for no redirects. >0 for number of redirects */
 110
 111     int log_details;
 112     int log_api;
 113 };
 114
 115 #if ZOOM_RESULT_LISTS
 116 struct ZOOM_resultsets_p {
 117     ZOOM_resultset resultset;
 118     ZOOM_resultsets next;
 119 };
 120 #endif
 121
 122 typedef struct ZOOM_record_cache_p *ZOOM_record_cache;
 123
 124 #define RECORD_HASH_SIZE  131
 125
 126 struct ZOOM_resultset_p {
 127     Z_SortKeySpecList *r_sort_spec;
 128     ZOOM_query query;
 129     int refcount;
 130     Odr_int size;
 131     int step;
 132     int piggyback;
 133     char *setname;
 134     char *schema;
 135     ODR odr;
 136     ZOOM_record_cache record_hash[RECORD_HASH_SIZE];
 137     ZOOM_options options;
 138     ZOOM_connection connection;
 139     char **databaseNames;
 140     int num_databaseNames;
 141     YAZ_MUTEX mutex;
 142 #if SHPTR
 143     struct WRBUF_shptr *record_wrbuf;
 144 #endif
 145 #if ZOOM_RESULT_LISTS
 146 #else
 147     ZOOM_resultset next;
 148 #endif
 149     ZOOM_facet_field *facets;
 150     int num_facets;
 151     char **facets_names;
 152 };
 153
 154 struct facet_term_p {
 155     char *term;
 156     int frequency;
 157 };
 158
 159 struct ZOOM_facet_field_p {
 160     char *facet_name;
 161     int num_terms;
 162     struct facet_term_p *facet_terms;
 163 };
 164
 165 struct ZOOM_scanset_p {
 166     int refcount;
 167     ODR odr;
 168     ZOOM_options options;
 169     ZOOM_connection connection;
 170     ZOOM_query query;
 171     Z_ScanResponse *scan_response;
 172     Z_SRW_scanResponse *srw_scan_response;
 173
 174     char **databaseNames;
 175     int num_databaseNames;
 176 };
 177
 178 struct ZOOM_package_p {
 179     int refcount;
 180     ODR odr_out;
 181     ZOOM_options options;
 182     ZOOM_connection connection;
 183     char *buf_out;
 184     int len_out;
 185 };
 186
 187 struct ZOOM_task_p {
 188     int running;
 189     int which;
 190     union {
 191 #define ZOOM_TASK_SEARCH 1
 192         struct {
 193             int count;
 194             int start;
 195             ZOOM_resultset resultset;
 196             char *syntax;
 197             char *elementSetName;
 198             int recv_search_fired;
 199         } search;
 200 #define ZOOM_TASK_RETRIEVE 2
 201         struct {
 202             int start;
 203             ZOOM_resultset resultset;
 204             int count;
 205             char *syntax;
 206             char *elementSetName;
 207         } retrieve;
 208 #define ZOOM_TASK_CONNECT 3
 209 #define ZOOM_TASK_SCAN 4
 210         struct {
 211             ZOOM_scanset scan;
 212         } scan;
 213 #define ZOOM_TASK_PACKAGE 5
 214         ZOOM_package package;
 215 #define ZOOM_TASK_SORT 6
 216         struct {
 217             ZOOM_resultset resultset;
 218             ZOOM_query q;
 219         } sort;
 220     } u;
 221     ZOOM_task next;
 222 };
 223
 224 typedef enum {
 225     zoom_pending,
 226     zoom_complete
 227 } zoom_ret;
 228
 229 void ZOOM_options_addref (ZOOM_options opt);
 230
 231 void ZOOM_handle_Z3950_apdu(ZOOM_connection c, Z_APDU *apdu);
 232
 233 void ZOOM_set_dset_error(ZOOM_connection c, int error,
 234                          const char *dset,
 235                          const char *addinfo, const char *addinfo2);
 236
 237 void ZOOM_set_error(ZOOM_connection c, int error, const char *addinfo);
 238
 239 ZOOM_Event ZOOM_Event_create(int kind);
 240 void ZOOM_connection_put_event(ZOOM_connection c, ZOOM_Event event);
 241
 242 zoom_ret ZOOM_connection_Z3950_send_search(ZOOM_connection c);
 243 zoom_ret send_Z3950_present(ZOOM_connection c);
 244 zoom_ret ZOOM_connection_Z3950_send_scan(ZOOM_connection c);
 245 zoom_ret ZOOM_send_buf(ZOOM_connection c);
 246 zoom_ret send_Z3950_sort(ZOOM_connection c, ZOOM_resultset resultset);
 247 char **ZOOM_connection_get_databases(ZOOM_connection con, ZOOM_options options,
 248                                      int *num, ODR odr);
 249 zoom_ret ZOOM_connection_Z3950_send_init(ZOOM_connection c);
 250
 251 ZOOM_task ZOOM_connection_add_task(ZOOM_connection c, int which);
 252 void ZOOM_connection_remove_task(ZOOM_connection c);
 253 int ZOOM_test_reconnect(ZOOM_connection c);
 254
 255 ZOOM_record ZOOM_record_cache_lookup(ZOOM_resultset r, int pos,
 256                                      const char *syntax,
 257                                      const char *elementSetName);
 258 void ZOOM_record_cache_add(ZOOM_resultset r, Z_NamePlusRecord *npr,
 259                            int pos,
 260                            const char *syntax, const char *elementSetName,
 261                            const char *schema,
 262                            Z_SRW_diagnostic *diag);
 263
 264 Z_Query *ZOOM_query_get_Z_Query(ZOOM_query s);
 265 Z_SortKeySpecList *ZOOM_query_get_sortspec(ZOOM_query s);
 266 const char *ZOOM_query_get_query_string(ZOOM_query s);
 267 const char *ZOOM_query_get_sru11(ZOOM_query s);
 268
 269 int ZOOM_uri_to_code(const char *uri);
 270
 271 zoom_ret ZOOM_connection_srw_send_search(ZOOM_connection c);
 272 zoom_ret ZOOM_connection_srw_send_scan(ZOOM_connection c);
 273
 274 int ZOOM_handle_sru(ZOOM_connection c, Z_HTTP_Response *hres,
 275                     zoom_ret *cret, char **addinfo);
 276
 277 void ZOOM_set_HTTP_error(ZOOM_connection c, int error,
 278                          const char *addinfo, const char *addinfo2);
 279
 280 ZOOM_Event ZOOM_connection_get_event(ZOOM_connection c);
 281 void ZOOM_connection_remove_events(ZOOM_connection c);
 282 void ZOOM_Event_destroy(ZOOM_Event event);
 283
 284 /*
 285  * Local variables:
 286  * c-basic-offset: 4
 287  * c-file-style: "Stroustrup"
 288  * indent-tabs-mode: nil
 289  * End:
 290  * vim: shiftwidth=4 tabstop=8 expandtab
 291  */
 292