1 /* $Id: proxy.h,v 1.23 2005-08-15 12:54:02 adam Exp $
2 Copyright (c) 1998-2005, Index Data.
4 This file is part of the yaz-proxy.
6 YAZ proxy is free software; you can redistribute it and/or modify it under
7 the terms of the GNU General Public License as published by the Free
8 Software Foundation; either version 2, or (at your option) any later
11 YAZ proxy is distributed in the hope that it will be useful, but WITHOUT ANY
12 WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
16 You should have received a copy of the GNU General Public License
17 along with YAZ proxy; see the file LICENSE. If not, write to the
18 Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA
22 #ifndef YAZ_PROXY_H_INCLUDED
23 #define YAZ_PROXY_H_INCLUDED
25 #include <yaz++/socket-observer.h>
26 #include <yaz++/z-assoc.h>
27 #include <yaz++/z-query.h>
28 #include <yaz++/z-databases.h>
29 #include <yaz++/cql2rpn.h>
31 #include <yaz++/gdu.h>
32 #include <yazproxy/bw.h>
36 #define MAX_ZURL_PLEX 10
38 #define PROXY_LOG_APDU_CLIENT 1
39 #define PROXY_LOG_APDU_SERVER 2
40 #define PROXY_LOG_REQ_CLIENT 4
41 #define PROXY_LOG_REQ_SERVER 8
44 class Yaz_ProxyConfig;
45 class Yaz_ProxyClient;
46 class Yaz_CharsetConverter;
48 enum YAZ_Proxy_MARCXML_mode {
55 /// Information Retrieval Proxy Server.
56 class YAZ_EXPORT Yaz_Proxy : public yazpp_1::Z_Assoc {
57 friend class Proxy_Msg;
61 char *get_cookie(Z_OtherInformation **otherInfo);
62 char *get_proxy(Z_OtherInformation **otherInfo);
63 void get_charset_and_lang_negotiation(Z_OtherInformation **otherInfo,
64 char **charstes, char **langs, int *selected);
65 Yaz_ProxyClient *get_client(Z_APDU *apdu, const char *cookie,
66 const char *proxy_host);
67 void srw_get_client(const char *db, const char **backend_db);
68 Z_APDU *result_set_optimize(Z_APDU *apdu);
70 Yaz_ProxyClient *m_client;
71 yazpp_1::IPDU_Observable *m_PDU_Observable;
72 yazpp_1::ISocketObservable *m_socket_observable;
73 Yaz_ProxyClient *m_clientPool;
78 int m_keepalive_limit_bw;
79 int m_keepalive_limit_pdu;
80 int m_client_idletime;
81 int m_target_idletime;
84 char *m_default_target;
85 char *m_proxy_negotiation_charset;
86 char *m_proxy_negotiation_lang;
89 int m_session_no; // sequence for each client session
90 char m_session_str[30]; // session string (time:session_no)
91 Yaz_ProxyConfig *m_config;
97 yazpp_1::GDU *m_timeout_gdu;
108 Z_GDU *m_bw_hold_PDU;
109 int m_max_record_retrieve;
110 void handle_max_record_retrieve(Z_APDU *apdu);
111 void display_diagrecs(Z_DiagRec **pp, int num);
112 Z_Records *create_nonSurrogateDiagnostics(ODR o, int error,
113 const char *addinfo);
115 Z_APDU *handle_query_validation(Z_APDU *apdu);
116 Z_APDU *handle_query_transformation(Z_APDU *apdu);
117 Z_APDU *handle_target_charset_conversion(Z_APDU *apdu);
119 Z_APDU *handle_syntax_validation(Z_APDU *apdu);
121 void handle_charset_lang_negotiation(Z_APDU *apdu);
123 const char *load_balance(const char **url);
125 Yaz_ProxyConfig *check_reconfigure();
127 int m_flag_invalid_session;
128 YAZ_Proxy_MARCXML_mode m_marcxml_mode;
129 void *m_stylesheet_xsp; // Really libxslt's xsltStylesheetPtr
130 int m_stylesheet_offset;
131 Z_APDU *m_stylesheet_apdu;
132 Z_NamePlusRecordList *m_stylesheet_nprl;
134 char *m_backend_type;
135 char *m_backend_charset;
137 void convert_to_frontend_type(Z_NamePlusRecordList *p);
138 void convert_to_marcxml(Z_NamePlusRecordList *p, const char *charset);
139 void convert_records_charset(Z_NamePlusRecordList *p, const char *charset);
140 int convert_xsl(Z_NamePlusRecordList *p, Z_APDU *apdu);
141 void convert_xsl_delay();
142 Z_APDU *m_initRequest_apdu;
143 int m_initRequest_preferredMessageSize;
144 int m_initRequest_maximumRecordSize;
145 Z_Options *m_initRequest_options;
146 Z_ProtocolVersion *m_initRequest_version;
147 char **m_initRequest_oi_negotiation_charsets;
148 int m_initRequest_oi_negotiation_num_charsets;
149 char **m_initRequest_oi_negotiation_langs;
150 int m_initRequest_oi_negotiation_num_langs;
151 int m_initRequest_oi_negotiation_selected;
152 NMEM m_initRequest_mem;
153 Z_APDU *m_apdu_invalid_session;
154 NMEM m_mem_invalid_session;
155 int send_PDU_convert(Z_APDU *apdu);
157 ODR m_s2z_odr_search;
160 char *m_s2z_database;
161 Z_APDU *m_s2z_init_apdu;
162 Z_APDU *m_s2z_search_apdu;
163 Z_APDU *m_s2z_present_apdu;
164 char *m_s2z_stylesheet;
166 int file_access(Z_HTTP_Request *hreq);
167 int send_to_srw_client_error(int error, const char *add);
168 int send_to_srw_client_ok(int hits, Z_Records *records, int start);
169 int send_http_response(int code);
170 int send_srw_response(Z_SRW_PDU *srw_pdu);
171 int send_srw_explain_response(Z_SRW_diagnostic *diagnostics,
172 int num_diagnostics);
173 int z_to_srw_diag(ODR o, Z_SRW_searchRetrieveResponse *srw_res,
174 Z_DefaultDiagFormat *ddf);
175 int m_http_keepalive;
176 const char *m_http_version;
177 yazpp_1::Yaz_cql2rpn m_cql2rpn;
180 Z_ElementSetNames *mk_esn_from_schema(ODR o, const char *schema);
181 Z_ReferenceId *m_referenceId;
182 NMEM m_referenceId_mem;
184 #define NO_SPARE_SOLARIS_FD 10
185 int m_lo_fd[NO_SPARE_SOLARIS_FD];
186 void low_socket_open();
187 void low_socket_close();
188 char *m_usemarcon_ini_stage1;
189 char *m_usemarcon_ini_stage2;
190 Yaz_usemarcon *m_usemarcon;
191 Yaz_CharsetConverter *m_charset_converter;
192 yazpp_1::GDUQueue m_in_queue;
194 Yaz_Proxy(yazpp_1::IPDU_Observable *the_PDU_Observable,
195 yazpp_1::ISocketObservable *the_socket_observable,
196 Yaz_Proxy *parent = 0);
204 int handle_authentication(Z_APDU *apdu);
205 void result_authentication(Z_APDU *apdu, int ret);
206 void handle_init(Z_APDU *apdu);
207 void inc_request_no();
208 void recv_GDU(Z_GDU *apdu, int len);
209 void recv_GDU_reduce(yazpp_1::GDU *gdu);
210 void recv_GDU_normal(yazpp_1::GDU *gdu);
211 void recv_GDU_more(bool normal);
212 void handle_incoming_HTTP(Z_HTTP_Request *req);
213 void handle_incoming_Z_PDU(Z_APDU *apdu);
214 void handle_incoming_Z_PDU_2(Z_APDU *apdu);
215 IPDU_Observer *sessionNotify(yazpp_1::IPDU_Observable *the_PDU_Observable,
218 void timeoutNotify();
219 void connectNotify();
221 const char *option(const char *name, const char *value);
222 void set_default_target(const char *target);
223 void set_proxy_negotiation (const char *charset, const char *lang);
224 void set_target_charset(const char *charset);
225 char *get_proxy_target() { return m_proxyTarget; };
226 char *get_session_str() { return m_session_str; };
227 void set_max_clients(int m) { m_max_clients = m; };
228 void set_client_idletime (int t) { m_client_idletime = (t > 1) ? t : 600; };
229 void set_target_idletime (int t) { m_target_idletime = (t > 1) ? t : 600; };
230 int get_target_idletime () { return m_target_idletime; }
231 int set_config(const char *name);
232 void reconfig() { m_reconfig_flag = 1; }
233 int send_to_client(Z_APDU *apdu);
234 int server(const char *addr);
236 int get_log_mask() { return m_log_mask; };
237 int handle_init_response_for_invalid_session(Z_APDU *apdu);
238 void set_debug_mode(int mode);
239 Msg_Thread *m_my_thread;
246 * indent-tabs-mode: nil
248 * vim: shiftwidth=4 tabstop=8 expandtab