2 * Copyright (c) 1998-2003, Index Data.
3 * See the file LICENSE for details.
5 * $Id: proxy.h,v 1.10 2003-10-06 08:08:49 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 struct Yaz_RecordCache_Entry;
21 class YAZ_EXPORT Yaz_ProxyConfig {
25 int read_xml(const char *fname);
26 void get_target_info(const char *name, const char **url, int *keepalive,
27 int *limit_bw, int *limit_pdu, int *limit_req,
28 int *target_idletime, int *client_idletime,
30 void operator=(const Yaz_ProxyConfig &conf);
31 int check_query(ODR odr, const char *name, Z_Query *query, char **addinfo);
35 xmlNodePtr m_proxyPtr;
36 void return_target_info(xmlNodePtr ptr, const char **url, int *keepalive,
37 int *limit_bw, int *limit_pdu, int *limit_req,
38 int *target_idletime, int *client_idletime);
39 void return_limit(xmlNodePtr ptr,
40 int *limit_bw, int *limit_pdu, int *limit_req);
41 int check_type_1(ODR odr, xmlNodePtr ptr, Z_RPNQuery *query,
43 xmlNodePtr find_target_node(const char *name);
44 const char *get_text(xmlNodePtr ptr);
45 int check_type_1_attributes(ODR odr, xmlNodePtr ptr,
46 Z_AttributeList *attrs,
48 int check_type_1_structure(ODR odr, xmlNodePtr ptr, Z_RPNStructure *q,
52 int match_list(int v, const char *m);
53 int atoi_l(const char **cp);
57 class YAZ_EXPORT Yaz_RecordCache {
61 void add (ODR o, Z_NamePlusRecordList *npr, int start, int hits);
63 int lookup (ODR o, Z_NamePlusRecordList **npr, int start, int num,
64 Odr_oid *syntax, Z_RecordComposition *comp);
67 void copy_searchRequest(Z_SearchRequest *sr);
68 void copy_presentRequest(Z_PresentRequest *pr);
71 Yaz_RecordCache_Entry *m_entries;
72 Z_SearchRequest *m_searchRequest;
73 Z_PresentRequest *m_presentRequest;
74 int match (Yaz_RecordCache_Entry *entry,
75 Odr_oid *syntax, int offset,
76 Z_RecordComposition *comp);
79 class YAZ_EXPORT Yaz_bw {
83 void add_bytes(int m);
86 long m_sec; // time of most recent bucket
93 class YAZ_EXPORT Yaz_ProxyClient : public Yaz_Z_Assoc {
94 friend class Yaz_Proxy;
95 Yaz_ProxyClient(IYaz_PDU_Observable *the_PDU_Observable);
97 void recv_Z_PDU(Z_APDU *apdu, int len);
98 IYaz_PDU_Observer* sessionNotify
99 (IYaz_PDU_Observable *the_PDU_Observable, int fd);
103 void timeoutNotify();
104 void connectNotify();
105 int send_to_target(Z_APDU *apdu);
106 const char *get_session_str();
108 Yaz_ProxyClient *m_next;
109 Yaz_ProxyClient **m_prev;
111 Yaz_Z_Query *m_last_query;
112 Yaz_Z_Databases m_last_databases;
113 char *m_last_resultSetId;
115 int m_last_resultCount;
119 int m_resultSetStartPoint;
123 Z_APDU *m_initResponse;
124 Yaz_RecordCache m_cache;
127 /// Information Retrieval Proxy Server.
128 class YAZ_EXPORT Yaz_Proxy : public Yaz_Z_Assoc {
130 char *get_cookie(Z_OtherInformation **otherInfo);
131 char *get_proxy(Z_OtherInformation **otherInfo);
132 Yaz_ProxyClient *get_client(Z_APDU *apdu);
133 Z_APDU *result_set_optimize(Z_APDU *apdu);
136 Yaz_ProxyClient *m_client;
137 IYaz_PDU_Observable *m_PDU_Observable;
138 Yaz_ProxyClient *m_clientPool;
143 int m_client_idletime;
144 int m_target_idletime;
146 char *m_default_target;
147 char *m_proxy_authentication;
150 int m_session_no; // sequence for each client session
151 char m_session_str[20]; // session string (time:session_no)
152 Yaz_ProxyConfig m_config;
159 Z_APDU *m_bw_hold_PDU;
160 int m_max_record_retrieve;
161 void handle_max_record_retrieve(Z_APDU *apdu);
162 void display_diagrecs(Z_DiagRec **pp, int num);
163 Z_Records *create_nonSurrogateDiagnostics(ODR o, int error,
164 const char *addinfo);
166 Z_APDU *handle_query_validation(Z_APDU *apdu);
168 Yaz_Proxy(IYaz_PDU_Observable *the_PDU_Observable);
170 void recv_Z_PDU(Z_APDU *apdu, int len);
171 void recv_Z_PDU_0(Z_APDU *apdu);
172 IYaz_PDU_Observer* sessionNotify
173 (IYaz_PDU_Observable *the_PDU_Observable, int fd);
175 void timeoutNotify();
176 void connectNotify();
177 const char *option(const char *name, const char *value);
178 void set_default_target(const char *target);
179 void set_proxy_authentication (const char *auth);
180 char *get_proxy_target() { return m_proxyTarget; };
181 char *get_session_str() { return m_session_str; };
182 void set_max_clients(int m) { m_max_clients = m; };
183 void set_client_idletime (int t) { m_client_idletime = (t > 1) ? t : 600; };
184 void set_target_idletime (int t) { m_target_idletime = (t > 1) ? t : 600; };
185 int get_target_idletime () { return m_target_idletime; }
186 int set_config(const char *name);
187 int send_to_client(Z_APDU *apdu);