2 * Copyright (c) 1998-2003, Index Data.
3 * See the file LICENSE for details.
5 * $Id: proxy.h,v 1.9 2003-10-03 13:01:42 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,
54 class YAZ_EXPORT Yaz_RecordCache {
58 void add (ODR o, Z_NamePlusRecordList *npr, int start, int hits);
60 int lookup (ODR o, Z_NamePlusRecordList **npr, int start, int num,
61 Odr_oid *syntax, Z_RecordComposition *comp);
64 void copy_searchRequest(Z_SearchRequest *sr);
65 void copy_presentRequest(Z_PresentRequest *pr);
68 Yaz_RecordCache_Entry *m_entries;
69 Z_SearchRequest *m_searchRequest;
70 Z_PresentRequest *m_presentRequest;
71 int match (Yaz_RecordCache_Entry *entry,
72 Odr_oid *syntax, int offset,
73 Z_RecordComposition *comp);
76 class YAZ_EXPORT Yaz_bw {
80 void add_bytes(int m);
83 long m_sec; // time of most recent bucket
90 class YAZ_EXPORT Yaz_ProxyClient : public Yaz_Z_Assoc {
91 friend class Yaz_Proxy;
92 Yaz_ProxyClient(IYaz_PDU_Observable *the_PDU_Observable);
94 void recv_Z_PDU(Z_APDU *apdu, int len);
95 IYaz_PDU_Observer* sessionNotify
96 (IYaz_PDU_Observable *the_PDU_Observable, int fd);
100 void timeoutNotify();
101 void connectNotify();
102 int send_to_target(Z_APDU *apdu);
103 const char *get_session_str();
105 Yaz_ProxyClient *m_next;
106 Yaz_ProxyClient **m_prev;
108 Yaz_Z_Query *m_last_query;
109 Yaz_Z_Databases m_last_databases;
110 char *m_last_resultSetId;
112 int m_last_resultCount;
116 int m_resultSetStartPoint;
120 Z_APDU *m_initResponse;
121 Yaz_RecordCache m_cache;
124 /// Information Retrieval Proxy Server.
125 class YAZ_EXPORT Yaz_Proxy : public Yaz_Z_Assoc {
127 char *get_cookie(Z_OtherInformation **otherInfo);
128 char *get_proxy(Z_OtherInformation **otherInfo);
129 Yaz_ProxyClient *get_client(Z_APDU *apdu);
130 Z_APDU *result_set_optimize(Z_APDU *apdu);
133 Yaz_ProxyClient *m_client;
134 IYaz_PDU_Observable *m_PDU_Observable;
135 Yaz_ProxyClient *m_clientPool;
140 int m_client_idletime;
141 int m_target_idletime;
143 char *m_default_target;
144 char *m_proxy_authentication;
147 int m_session_no; // sequence for each client session
148 char m_session_str[20]; // session string (time:session_no)
149 Yaz_ProxyConfig m_config;
156 Z_APDU *m_bw_hold_PDU;
157 int m_max_record_retrieve;
158 void handle_max_record_retrieve(Z_APDU *apdu);
159 void display_diagrecs(Z_DiagRec **pp, int num);
160 Z_Records *create_nonSurrogateDiagnostics(ODR o, int error,
161 const char *addinfo);
163 Z_APDU *handle_query_validation(Z_APDU *apdu);
165 Yaz_Proxy(IYaz_PDU_Observable *the_PDU_Observable);
167 void recv_Z_PDU(Z_APDU *apdu, int len);
168 void recv_Z_PDU_0(Z_APDU *apdu);
169 IYaz_PDU_Observer* sessionNotify
170 (IYaz_PDU_Observable *the_PDU_Observable, int fd);
172 void timeoutNotify();
173 void connectNotify();
174 const char *option(const char *name, const char *value);
175 void set_default_target(const char *target);
176 void set_proxy_authentication (const char *auth);
177 char *get_proxy_target() { return m_proxyTarget; };
178 char *get_session_str() { return m_session_str; };
179 void set_max_clients(int m) { m_max_clients = m; };
180 void set_client_idletime (int t) { m_client_idletime = (t > 1) ? t : 600; };
181 void set_target_idletime (int t) { m_target_idletime = (t > 1) ? t : 600; };
182 int get_target_idletime () { return m_target_idletime; }
183 int set_config(const char *name);
184 int send_to_client(Z_APDU *apdu);