2 * Copyright (c) 1998-2003, Index Data.
3 * See the file LICENSE for details.
5 * $Id: proxy.h,v 1.13 2003-10-08 09:32:48 adam Exp $
8 #include <yaz++/z-assoc.h>
9 #include <yaz++/z-query.h>
10 #include <yaz++/z-databases.h>
13 #include <libxml/parser.h>
14 #include <libxml/tree.h>
19 #define MAX_ZURL_PLEX 10
21 struct Yaz_RecordCache_Entry;
23 class YAZ_EXPORT Yaz_ProxyConfig {
27 int read_xml(const char *fname);
28 void get_target_info(const char *name, const char **url, int *keepalive,
29 int *limit_bw, int *limit_pdu, int *limit_req,
30 int *target_idletime, int *client_idletime,
32 void operator=(const Yaz_ProxyConfig &conf);
33 int check_query(ODR odr, const char *name, Z_Query *query, char **addinfo);
34 int check_syntax(ODR odr, const char *name,
35 Odr_oid *syntax, char **addinfo);
39 xmlNodePtr m_proxyPtr;
40 void return_target_info(xmlNodePtr ptr, const char **url, int *keepalive,
41 int *limit_bw, int *limit_pdu, int *limit_req,
42 int *target_idletime, int *client_idletime);
43 void return_limit(xmlNodePtr ptr,
44 int *limit_bw, int *limit_pdu, int *limit_req);
45 int check_type_1(ODR odr, xmlNodePtr ptr, Z_RPNQuery *query,
47 xmlNodePtr find_target_node(const char *name);
48 const char *get_text(xmlNodePtr ptr);
49 int check_type_1_attributes(ODR odr, xmlNodePtr ptr,
50 Z_AttributeList *attrs,
52 int check_type_1_structure(ODR odr, xmlNodePtr ptr, Z_RPNStructure *q,
56 int match_list(int v, const char *m);
57 int atoi_l(const char **cp);
61 class YAZ_EXPORT Yaz_RecordCache {
65 void add (ODR o, Z_NamePlusRecordList *npr, int start, int hits);
67 int lookup (ODR o, Z_NamePlusRecordList **npr, int start, int num,
68 Odr_oid *syntax, Z_RecordComposition *comp);
71 void copy_searchRequest(Z_SearchRequest *sr);
72 void copy_presentRequest(Z_PresentRequest *pr);
73 void set_max_size(int sz);
76 Yaz_RecordCache_Entry *m_entries;
77 Z_SearchRequest *m_searchRequest;
78 Z_PresentRequest *m_presentRequest;
79 int match (Yaz_RecordCache_Entry *entry,
80 Odr_oid *syntax, int offset,
81 Z_RecordComposition *comp);
85 class YAZ_EXPORT Yaz_bw {
89 void add_bytes(int m);
92 long m_sec; // time of most recent bucket
99 class YAZ_EXPORT Yaz_ProxyClient : public Yaz_Z_Assoc {
100 friend class Yaz_Proxy;
101 Yaz_ProxyClient(IYaz_PDU_Observable *the_PDU_Observable);
103 void recv_Z_PDU(Z_APDU *apdu, int len);
104 IYaz_PDU_Observer* sessionNotify
105 (IYaz_PDU_Observable *the_PDU_Observable, int fd);
109 void timeoutNotify();
110 void connectNotify();
111 int send_to_target(Z_APDU *apdu);
112 const char *get_session_str();
114 Yaz_ProxyClient *m_next;
115 Yaz_ProxyClient **m_prev;
117 Yaz_Z_Query *m_last_query;
118 Yaz_Z_Databases m_last_databases;
119 char *m_last_resultSetId;
121 int m_last_resultCount;
125 int m_resultSetStartPoint;
129 Z_APDU *m_initResponse;
130 Yaz_RecordCache m_cache;
133 /// Information Retrieval Proxy Server.
134 class YAZ_EXPORT Yaz_Proxy : public Yaz_Z_Assoc {
136 char *get_cookie(Z_OtherInformation **otherInfo);
137 char *get_proxy(Z_OtherInformation **otherInfo);
138 Yaz_ProxyClient *get_client(Z_APDU *apdu);
139 Z_APDU *result_set_optimize(Z_APDU *apdu);
142 Yaz_ProxyClient *m_client;
143 IYaz_PDU_Observable *m_PDU_Observable;
144 Yaz_ProxyClient *m_clientPool;
149 int m_client_idletime;
150 int m_target_idletime;
152 char *m_default_target;
153 char *m_proxy_authentication;
156 int m_session_no; // sequence for each client session
157 char m_session_str[20]; // session string (time:session_no)
158 Yaz_ProxyConfig m_config;
165 Z_APDU *m_bw_hold_PDU;
166 int m_max_record_retrieve;
167 void handle_max_record_retrieve(Z_APDU *apdu);
168 void display_diagrecs(Z_DiagRec **pp, int num);
169 Z_Records *create_nonSurrogateDiagnostics(ODR o, int error,
170 const char *addinfo);
172 Z_APDU *handle_query_validation(Z_APDU *apdu);
173 Z_APDU *handle_syntax_validation(Z_APDU *apdu);
174 const char *load_balance(const char **url);
176 Yaz_Proxy(IYaz_PDU_Observable *the_PDU_Observable);
178 void recv_Z_PDU(Z_APDU *apdu, int len);
179 void recv_Z_PDU_0(Z_APDU *apdu);
180 IYaz_PDU_Observer* sessionNotify
181 (IYaz_PDU_Observable *the_PDU_Observable, int fd);
183 void timeoutNotify();
184 void connectNotify();
185 const char *option(const char *name, const char *value);
186 void set_default_target(const char *target);
187 void set_proxy_authentication (const char *auth);
188 char *get_proxy_target() { return m_proxyTarget; };
189 char *get_session_str() { return m_session_str; };
190 void set_max_clients(int m) { m_max_clients = m; };
191 void set_client_idletime (int t) { m_client_idletime = (t > 1) ? t : 600; };
192 void set_target_idletime (int t) { m_target_idletime = (t > 1) ? t : 600; };
193 int get_target_idletime () { return m_target_idletime; }
194 int set_config(const char *name);
195 int send_to_client(Z_APDU *apdu);