src/zoom-p.h

   1 /* This file is part of the YAZ toolkit.
   2  * Copyright (C) 1995-2008 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/sortspec.h>
  37 #include <yaz/srw.h>
  38
  39 typedef struct ZOOM_Event_p *ZOOM_Event;
  40
  41 struct ZOOM_query_p {
  42     Z_Query *z_query;
  43     Z_SortKeySpecList *sort_spec;
  44     int refcount;
  45     ODR odr;
  46     char *query_string;
  47 };
  48
  49 typedef enum {
  50     zoom_sru_error,
  51     zoom_sru_soap,
  52     zoom_sru_get,
  53     zoom_sru_post
  54 } zoom_sru_mode;
  55
  56
  57 typedef struct ZOOM_task_p *ZOOM_task;
  58
  59 #define STATE_IDLE 0
  60 #define STATE_CONNECTING 1
  61 #define STATE_ESTABLISHED 2
  62
  63 struct ZOOM_connection_p {
  64     enum oid_proto proto;
  65     COMSTACK cs;
  66     char *host_port;
  67     char *path;
  68     int error;
  69     char *addinfo;
  70     char *diagset;
  71     int state;
  72     int mask;
  73     int reconnect_ok;
  74     ODR odr_in;
  75     ODR odr_out;
  76     ODR odr_print;
  77     char *buf_in;
  78     int len_in;
  79     char *buf_out;
  80     int len_out;
  81     char *proxy;
  82     char *charset;
  83     char *lang;
  84     char *cookie_out;
  85     char *cookie_in;
  86     char *client_IP;
  87     char *sru_version;
  88
  89     char *user;
  90     char *group;
  91     char *password;
  92
  93     int async;
  94     int support_named_resultsets;
  95     int last_event;
  96
  97     int maximum_record_size;
  98     int preferred_message_size;
  99
 100     ZOOM_task tasks;
 101     ZOOM_options options;
 102     ZOOM_resultset resultsets;
 103     ZOOM_Event m_queue_front;
 104     ZOOM_Event m_queue_back;
 105     zoom_sru_mode sru_mode;
 106 };
 107
 108 struct ZOOM_options_entry {
 109     char *name;
 110     char *value;
 111     int len;                  /* of `value', which may contain NULs */
 112     struct ZOOM_options_entry *next;
 113 };
 114
 115 struct ZOOM_options_p {
 116     int refcount;
 117     void *callback_handle;
 118     ZOOM_options_callback callback_func;
 119     struct ZOOM_options_entry *entries;
 120     ZOOM_options parent1;
 121     ZOOM_options parent2;
 122 };
 123
 124
 125 typedef struct ZOOM_record_cache_p *ZOOM_record_cache;
 126
 127 #define RECORD_HASH_SIZE  131
 128
 129 struct ZOOM_resultset_p {
 130     Z_SortKeySpecList *r_sort_spec;
 131     ZOOM_query query;
 132     int refcount;
 133     int size;
 134     int step;
 135     int piggyback;
 136     char *setname;
 137     char *schema;
 138     ODR odr;
 139     ZOOM_record_cache record_hash[RECORD_HASH_SIZE];
 140     ZOOM_options options;
 141     ZOOM_connection connection;
 142     ZOOM_resultset next;
 143     char **databaseNames;
 144     int num_databaseNames;
 145 };
 146
 147 struct ZOOM_record_p {
 148     ODR odr;
 149     WRBUF wrbuf_marc;
 150     WRBUF wrbuf_iconv;
 151     WRBUF wrbuf_opac;
 152     Z_NamePlusRecord *npr;
 153     const char *schema;
 154
 155     const char *diag_uri;
 156     const char *diag_message;
 157     const char *diag_details;
 158     const char *diag_set;
 159 };
 160
 161 struct ZOOM_record_cache_p {
 162     struct ZOOM_record_p rec;
 163     char *elementSetName;
 164     char *syntax;
 165     char *schema;
 166     int pos;
 167     ZOOM_record_cache next;
 168 };
 169
 170 struct ZOOM_scanset_p {
 171     int refcount;
 172     ODR odr;
 173     ZOOM_options options;
 174     ZOOM_connection connection;
 175     ZOOM_query query;
 176     Z_ScanResponse *scan_response;
 177     Z_SRW_scanResponse *srw_scan_response;
 178
 179     char **databaseNames;
 180     int num_databaseNames;
 181 };
 182
 183 struct ZOOM_package_p {
 184     int refcount;
 185     ODR odr_out;
 186     ZOOM_options options;
 187     ZOOM_connection connection;
 188     char *buf_out;
 189     int len_out;
 190 };
 191
 192 struct ZOOM_task_p {
 193     int running;
 194     int which;
 195     union {
 196 #define ZOOM_TASK_SEARCH 1
 197         struct {
 198             int count;
 199             int start;
 200             ZOOM_resultset resultset;
 201             char *syntax;
 202             char *elementSetName;
 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         } retrieve;
 212 #define ZOOM_TASK_CONNECT 3
 213 #define ZOOM_TASK_SCAN 4
 214         struct {
 215             ZOOM_scanset scan;
 216         } scan;
 217 #define ZOOM_TASK_PACKAGE 5
 218         ZOOM_package package;
 219 #define ZOOM_TASK_SORT 6
 220         struct {
 221             ZOOM_resultset resultset;
 222             ZOOM_query q;
 223         } sort;
 224     } u;
 225     ZOOM_task next;
 226 };
 227
 228 struct ZOOM_Event_p {
 229     int kind;
 230     ZOOM_Event next;
 231     ZOOM_Event prev;
 232 };
 233
 234 void ZOOM_options_addref (ZOOM_options opt);
 235
 236 /*
 237  * Local variables:
 238  * c-basic-offset: 4
 239  * indent-tabs-mode: nil
 240  * End:
 241  * vim: shiftwidth=4 tabstop=8 expandtab
 242  */
 243