/*
- * Copyright (c) 1998-2003, Index Data.
+ * Copyright (c) 1998-2004, Index Data.
* See the file LICENSE for details.
*
- * $Id: proxy.h,v 1.6 2003-09-03 11:25:08 adam Exp $
+ * $Id: proxy.h,v 1.41 2004-02-27 00:42:57 adam Exp $
*/
+#include <sys/time.h>
#include <yaz++/z-assoc.h>
#include <yaz++/z-query.h>
#include <yaz++/z-databases.h>
+#include <yaz/cql.h>
+#if HAVE_XSLT
+#include <libxml/parser.h>
+#include <libxml/tree.h>
+#include <libxslt/xsltutils.h>
+#include <libxslt/transform.h>
+#endif
class Yaz_Proxy;
-class Yaz_RecordCache_Entry;
+#define MAX_ZURL_PLEX 10
+
+#define PROXY_LOG_APDU_CLIENT 1
+#define PROXY_LOG_APDU_SERVER 2
+#define PROXY_LOG_REQ_CLIENT 4
+#define PROXY_LOG_REQ_SERVER 8
+
+struct Yaz_RecordCache_Entry;
+
+class YAZ_EXPORT Yaz_ProxyConfig {
+public:
+ Yaz_ProxyConfig();
+ ~Yaz_ProxyConfig();
+ int read_xml(const char *fname);
+
+ int get_target_no(int no,
+ const char **name,
+ const char **url,
+ int *limit_bw,
+ int *limit_pdu,
+ int *limit_req,
+ int *target_idletime,
+ int *client_idletime,
+ int *max_clients,
+ int *keepalive_limit_bw,
+ int *keepalive_limit_pdu,
+ int *pre_init,
+ const char **cql2rpn);
+
+ void get_generic_info(int *log_mask, int *max_clients);
+
+ void get_target_info(const char *name, const char **url,
+ int *limit_bw, int *limit_pdu, int *limit_req,
+ int *target_idletime, int *client_idletime,
+ int *max_clients,
+ int *keepalive_limit_bw, int *keepalive_limit_pdu,
+ int *pre_init,
+ const char **cql2rpn);
+
+ int check_query(ODR odr, const char *name, Z_Query *query, char **addinfo);
+ int check_syntax(ODR odr, const char *name,
+ Odr_oid *syntax, Z_RecordComposition *comp,
+ char **addinfo, char **stylesheet, char **schema);
+ char *get_explain(ODR odr, const char *name, const char *db,
+ int *len);
+private:
+ void operator=(const Yaz_ProxyConfig &conf);
+ int mycmp(const char *hay, const char *item, size_t len);
+#if HAVE_XSLT
+ int check_schema(xmlNodePtr ptr, Z_RecordComposition *comp,
+ const char *schema_identifier);
+ xmlDocPtr m_docPtr;
+ xmlNodePtr m_proxyPtr;
+ void return_target_info(xmlNodePtr ptr, const char **url,
+ int *limit_bw, int *limit_pdu, int *limit_req,
+ int *target_idletime, int *client_idletime,
+ int *keepalive_limit_bw, int *keepalive_limit_pdu,
+ int *pre_init, const char **cql2rpn);
+ void return_limit(xmlNodePtr ptr,
+ int *limit_bw, int *limit_pdu, int *limit_req);
+ int check_type_1(ODR odr, xmlNodePtr ptr, Z_RPNQuery *query,
+ char **addinfo);
+ xmlNodePtr find_target_node(const char *name, const char *db);
+ xmlNodePtr find_target_db(xmlNodePtr ptr, const char *db);
+ const char *get_text(xmlNodePtr ptr);
+ int check_type_1_attributes(ODR odr, xmlNodePtr ptr,
+ Z_AttributeList *attrs,
+ char **addinfo);
+ int check_type_1_structure(ODR odr, xmlNodePtr ptr, Z_RPNStructure *q,
+ char **addinfo);
+#endif
+ int m_copy;
+ int match_list(int v, const char *m);
+ int atoi_l(const char **cp);
+};
class YAZ_EXPORT Yaz_RecordCache {
public:
void copy_searchRequest(Z_SearchRequest *sr);
void copy_presentRequest(Z_PresentRequest *pr);
+ void set_max_size(int sz);
private:
NMEM m_mem;
Yaz_RecordCache_Entry *m_entries;
int match (Yaz_RecordCache_Entry *entry,
Odr_oid *syntax, int offset,
Z_RecordComposition *comp);
+ int m_max_size;
+};
+
+class YAZ_EXPORT Yaz_bw {
+ public:
+ Yaz_bw(int sz);
+ ~Yaz_bw();
+ void add_bytes(int m);
+ int get_total();
+ private:
+ long m_sec; // time of most recent bucket
+ int *m_bucket;
+ int m_ptr;
+ int m_size;
};
/// Private class
class YAZ_EXPORT Yaz_ProxyClient : public Yaz_Z_Assoc {
friend class Yaz_Proxy;
- Yaz_ProxyClient(IYaz_PDU_Observable *the_PDU_Observable);
+ Yaz_ProxyClient(IYaz_PDU_Observable *the_PDU_Observable,
+ Yaz_Proxy *parent);
~Yaz_ProxyClient();
- void recv_Z_PDU(Z_APDU *apdu);
+ void recv_GDU(Z_GDU *apdu, int len);
+ void recv_Z_PDU(Z_APDU *apdu, int len);
+ void recv_HTTP_response(Z_HTTP_Response *apdu, int len);
IYaz_PDU_Observer* sessionNotify
(IYaz_PDU_Observable *the_PDU_Observable, int fd);
void shutdown();
void failNotify();
void timeoutNotify();
void connectNotify();
+ int send_to_target(Z_APDU *apdu);
+ const char *get_session_str();
char *m_cookie;
Yaz_ProxyClient *m_next;
Yaz_ProxyClient **m_prev;
int m_seqno;
int m_waiting;
int m_resultSetStartPoint;
+ int m_bytes_sent;
+ int m_bytes_recv;
+ int m_pdu_recv;
ODR m_init_odr;
Z_APDU *m_initResponse;
+ Z_Options *m_initResponse_options;
+ Z_ProtocolVersion *m_initResponse_version;
+ int m_initResponse_preferredMessageSize;
+ int m_initResponse_maximumRecordSize;
Yaz_RecordCache m_cache;
+ void pre_init_client();
+ int m_target_idletime;
+ Yaz_Proxy *m_root;
};
+class YAZ_EXPORT Yaz_cql2rpn {
+ public:
+ Yaz_cql2rpn();
+ ~Yaz_cql2rpn();
+ void set_pqf_file(const char *fname);
+ int query_transform(const char *cql, Z_RPNQuery **rpnquery, ODR o,
+ char **addinfop);
+ private:
+ cql_transform_t m_transform;
+};
+
+
/// Information Retrieval Proxy Server.
class YAZ_EXPORT Yaz_Proxy : public Yaz_Z_Assoc {
private:
char *get_cookie(Z_OtherInformation **otherInfo);
char *get_proxy(Z_OtherInformation **otherInfo);
- Yaz_ProxyClient *get_client(Z_APDU *apdu);
+ Yaz_ProxyClient *get_client(Z_APDU *apdu, const char *cookie,
+ const char *proxy_host);
Z_APDU *result_set_optimize(Z_APDU *apdu);
void shutdown();
Yaz_Proxy *m_parent;
int m_seqno;
int m_max_clients;
- int m_keepalive;
- int m_idletime;
+ int m_log_mask;
+ int m_keepalive_limit_bw;
+ int m_keepalive_limit_pdu;
+ int m_client_idletime;
+ int m_target_idletime;
char *m_proxyTarget;
+ char *m_default_target;
char *m_proxy_authentication;
long m_seed;
char *m_optimize;
+ int m_session_no; // sequence for each client session
+ char m_session_str[30]; // session string (time:session_no)
+ Yaz_ProxyConfig *m_config;
+ char *m_config_fname;
+ int m_bytes_sent;
+ int m_bytes_recv;
+ int m_bw_max;
+ Yaz_bw m_bw_stat;
+ int m_pdu_max;
+ Yaz_bw m_pdu_stat;
+ Z_GDU *m_bw_hold_PDU;
+ int m_max_record_retrieve;
+ void handle_max_record_retrieve(Z_APDU *apdu);
+ void display_diagrecs(Z_DiagRec **pp, int num);
+ Z_Records *create_nonSurrogateDiagnostics(ODR o, int error,
+ const char *addinfo);
+
+ Z_APDU *handle_query_validation(Z_APDU *apdu);
+ Z_APDU *handle_query_transformation(Z_APDU *apdu);
+
+ Z_APDU *handle_syntax_validation(Z_APDU *apdu);
+ const char *load_balance(const char **url);
+ int m_reconfig_flag;
+ Yaz_ProxyConfig *check_reconfigure();
+ int m_request_no;
+ int m_invalid_session;
+ int m_marcxml_flag;
+ xsltStylesheetPtr m_stylesheet_xsp;
+ int m_stylesheet_offset;
+ Z_APDU *m_stylesheet_apdu;
+ Z_NamePlusRecordList *m_stylesheet_nprl;
+ char *m_schema;
+ void convert_to_marcxml(Z_NamePlusRecordList *p);
+ int convert_xsl(Z_NamePlusRecordList *p, Z_APDU *apdu);
+ void convert_xsl_delay();
+ Z_APDU *m_initRequest_apdu;
+ int m_initRequest_preferredMessageSize;
+ int m_initRequest_maximumRecordSize;
+ Z_Options *m_initRequest_options;
+ Z_ProtocolVersion *m_initRequest_version;
+ NMEM m_initRequest_mem;
+ Z_APDU *m_apdu_invalid_session;
+ NMEM m_mem_invalid_session;
+ int send_PDU_convert(Z_APDU *apdu);
+ ODR m_s2z_odr_init;
+ ODR m_s2z_odr_search;
+ int m_s2z_hit_count;
+ int m_s2z_packing;
+ char *m_s2z_database;
+ Z_APDU *m_s2z_init_apdu;
+ Z_APDU *m_s2z_search_apdu;
+ Z_APDU *m_s2z_present_apdu;
+ char *m_s2z_stylesheet;
+ char *m_soap_ns;
+ int send_to_srw_client_error(int error, const char *add);
+ int send_to_srw_client_ok(int hits, Z_Records *records, int start);
+ int send_http_response(int code);
+ int send_srw_response(Z_SRW_PDU *srw_pdu);
+ int send_srw_explain_response(Z_SRW_diagnostic *diagnostics,
+ int num_diagnostics);
+ int z_to_srw_diag(ODR o, Z_SRW_searchRetrieveResponse *srw_res,
+ Z_DefaultDiagFormat *ddf);
+ int m_http_keepalive;
+ const char *m_http_version;
+ Yaz_cql2rpn m_cql2rpn;
+ struct timeval m_time_tv;
+ void logtime();
+ Z_ElementSetNames *mk_esn_from_schema(ODR o, const char *schema);
+ Z_ReferenceId *m_referenceId;
+ NMEM m_referenceId_mem;
+#define NO_SPARE_SOLARIS_FD 10
+ int m_lo_fd[NO_SPARE_SOLARIS_FD];
+ void low_socket_open();
+ void low_socket_close();
public:
- Yaz_Proxy(IYaz_PDU_Observable *the_PDU_Observable);
+ Yaz_Proxy(IYaz_PDU_Observable *the_PDU_Observable,
+ Yaz_Proxy *parent = 0);
~Yaz_Proxy();
- void recv_Z_PDU(Z_APDU *apdu);
+ void inc_request_no();
+ void recv_GDU(Z_GDU *apdu, int len);
+ void handle_incoming_HTTP(Z_HTTP_Request *req);
+ void handle_incoming_Z_PDU(Z_APDU *apdu);
IYaz_PDU_Observer* sessionNotify
(IYaz_PDU_Observable *the_PDU_Observable, int fd);
void failNotify();
void timeoutNotify();
void connectNotify();
+ void markInvalid();
const char *option(const char *name, const char *value);
- void set_proxy_target(const char *target);
+ void set_default_target(const char *target);
void set_proxy_authentication (const char *auth);
char *get_proxy_target() { return m_proxyTarget; };
+ char *get_session_str() { return m_session_str; };
void set_max_clients(int m) { m_max_clients = m; };
- void set_idletime (int t) { m_idletime = (t > 1) ? t : 600; };
+ void set_client_idletime (int t) { m_client_idletime = (t > 1) ? t : 600; };
+ void set_target_idletime (int t) { m_target_idletime = (t > 1) ? t : 600; };
+ int get_target_idletime () { return m_target_idletime; }
+ int set_config(const char *name);
+ void reconfig() { m_reconfig_flag = 1; }
+ int send_to_client(Z_APDU *apdu);
+ int server(const char *addr);
+ void pre_init();
+ int get_log_mask() { return m_log_mask; };
+ int handle_init_response_for_invalid_session(Z_APDU *apdu);
};