include/yaz++/proxy.h

   1 /*
   2  * Copyright (c) 1998-2003, Index Data.
   3  * See the file LICENSE for details.
   4  *
   5  * $Id: proxy.h,v 1.11 2003-10-08 08:15:01 adam Exp $
   6  */
   7
   8 #include <yaz++/z-assoc.h>
   9 #include <yaz++/z-query.h>
  10 #include <yaz++/z-databases.h>
  11
  12 #if HAVE_XML2
  13 #include <libxml/parser.h>
  14 #include <libxml/tree.h>
  15 #endif
  16
  17 class Yaz_Proxy;
  18
  19 struct Yaz_RecordCache_Entry;
  20
  21 class YAZ_EXPORT Yaz_ProxyConfig {
  22 public:
  23     Yaz_ProxyConfig();
  24     ~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,
  29                          int *max_clients);
  30     void operator=(const Yaz_ProxyConfig &conf);
  31     int check_query(ODR odr, const char *name, Z_Query *query, char **addinfo);
  32     int check_syntax(ODR odr, const char *name,
  33                      Odr_oid *syntax, char **addinfo);
  34 private:
  35 #if HAVE_XML2
  36     xmlDocPtr m_docPtr;
  37     xmlNodePtr m_proxyPtr;
  38     void return_target_info(xmlNodePtr ptr, const char **url, int *keepalive,
  39                             int *limit_bw, int *limit_pdu, int *limit_req,
  40                             int *target_idletime, int *client_idletime);
  41     void return_limit(xmlNodePtr ptr,
  42                       int *limit_bw, int *limit_pdu, int *limit_req);
  43     int check_type_1(ODR odr, xmlNodePtr ptr, Z_RPNQuery *query,
  44                      char **addinfo);
  45     xmlNodePtr find_target_node(const char *name);
  46     const char *get_text(xmlNodePtr ptr);
  47     int check_type_1_attributes(ODR odr, xmlNodePtr ptr,
  48                                 Z_AttributeList *attrs,
  49                                 char **addinfo);
  50     int check_type_1_structure(ODR odr, xmlNodePtr ptr, Z_RPNStructure *q,
  51                                char **addinfo);
  52 #endif
  53     int m_copy;
  54     int match_list(int v, const char *m);
  55     int atoi_l(const char **cp);
  56
  57 };
  58
  59 class YAZ_EXPORT Yaz_RecordCache {
  60  public:
  61     Yaz_RecordCache ();
  62     ~Yaz_RecordCache ();
  63     void add (ODR o, Z_NamePlusRecordList *npr, int start, int hits);
  64
  65     int lookup (ODR o, Z_NamePlusRecordList **npr, int start, int num,
  66                 Odr_oid *syntax, Z_RecordComposition *comp);
  67     void clear();
  68
  69     void copy_searchRequest(Z_SearchRequest *sr);
  70     void copy_presentRequest(Z_PresentRequest *pr);
  71  private:
  72     NMEM m_mem;
  73     Yaz_RecordCache_Entry *m_entries;
  74     Z_SearchRequest *m_searchRequest;
  75     Z_PresentRequest *m_presentRequest;
  76     int match (Yaz_RecordCache_Entry *entry,
  77                Odr_oid *syntax, int offset,
  78                Z_RecordComposition *comp);
  79 };
  80
  81 class YAZ_EXPORT Yaz_bw {
  82  public:
  83     Yaz_bw(int sz);
  84     ~Yaz_bw();
  85     void add_bytes(int m);
  86     int get_total();
  87  private:
  88     long m_sec;   // time of most recent bucket
  89     int *m_bucket;
  90     int m_ptr;
  91     int m_size;
  92 };
  93
  94 /// Private class
  95 class YAZ_EXPORT Yaz_ProxyClient : public Yaz_Z_Assoc {
  96     friend class Yaz_Proxy;
  97     Yaz_ProxyClient(IYaz_PDU_Observable *the_PDU_Observable);
  98     ~Yaz_ProxyClient();
  99     void recv_Z_PDU(Z_APDU *apdu, int len);
 100     IYaz_PDU_Observer* sessionNotify
 101         (IYaz_PDU_Observable *the_PDU_Observable, int fd);
 102     void shutdown();
 103     Yaz_Proxy *m_server;
 104     void failNotify();
 105     void timeoutNotify();
 106     void connectNotify();
 107     int send_to_target(Z_APDU *apdu);
 108     const char *get_session_str();
 109     char *m_cookie;
 110     Yaz_ProxyClient *m_next;
 111     Yaz_ProxyClient **m_prev;
 112     int m_init_flag;
 113     Yaz_Z_Query *m_last_query;
 114     Yaz_Z_Databases m_last_databases;
 115     char *m_last_resultSetId;
 116     int m_last_ok;
 117     int m_last_resultCount;
 118     int m_sr_transform;
 119     int m_seqno;
 120     int m_waiting;
 121     int m_resultSetStartPoint;
 122     int m_bytes_sent;
 123     int m_bytes_recv;
 124     ODR m_init_odr;
 125     Z_APDU *m_initResponse;
 126     Yaz_RecordCache m_cache;
 127 };
 128
 129 /// Information Retrieval Proxy Server.
 130 class YAZ_EXPORT Yaz_Proxy : public Yaz_Z_Assoc {
 131  private:
 132     char *get_cookie(Z_OtherInformation **otherInfo);
 133     char *get_proxy(Z_OtherInformation **otherInfo);
 134     Yaz_ProxyClient *get_client(Z_APDU *apdu);
 135     Z_APDU *result_set_optimize(Z_APDU *apdu);
 136     void shutdown();
 137
 138     Yaz_ProxyClient *m_client;
 139     IYaz_PDU_Observable *m_PDU_Observable;
 140     Yaz_ProxyClient *m_clientPool;
 141     Yaz_Proxy *m_parent;
 142     int m_seqno;
 143     int m_max_clients;
 144     int m_keepalive;
 145     int m_client_idletime;
 146     int m_target_idletime;
 147     char *m_proxyTarget;
 148     char *m_default_target;
 149     char *m_proxy_authentication;
 150     long m_seed;
 151     char *m_optimize;
 152     int m_session_no;         // sequence for each client session
 153     char m_session_str[20];  // session string (time:session_no)
 154     Yaz_ProxyConfig m_config;
 155     int m_bytes_sent;
 156     int m_bytes_recv;
 157     int m_bw_max;
 158     Yaz_bw m_bw_stat;
 159     int m_pdu_max;
 160     Yaz_bw m_pdu_stat;
 161     Z_APDU *m_bw_hold_PDU;
 162     int m_max_record_retrieve;
 163     void handle_max_record_retrieve(Z_APDU *apdu);
 164     void display_diagrecs(Z_DiagRec **pp, int num);
 165     Z_Records *create_nonSurrogateDiagnostics(ODR o, int error,
 166                                               const char *addinfo);
 167
 168     Z_APDU *handle_query_validation(Z_APDU *apdu);
 169     Z_APDU *handle_syntax_validation(Z_APDU *apdu);
 170  public:
 171     Yaz_Proxy(IYaz_PDU_Observable *the_PDU_Observable);
 172     ~Yaz_Proxy();
 173     void recv_Z_PDU(Z_APDU *apdu, int len);
 174     void recv_Z_PDU_0(Z_APDU *apdu);
 175     IYaz_PDU_Observer* sessionNotify
 176         (IYaz_PDU_Observable *the_PDU_Observable, int fd);
 177     void failNotify();
 178     void timeoutNotify();
 179     void connectNotify();
 180     const char *option(const char *name, const char *value);
 181     void set_default_target(const char *target);
 182     void set_proxy_authentication (const char *auth);
 183     char *get_proxy_target() { return m_proxyTarget; };
 184     char *get_session_str() { return m_session_str; };
 185     void set_max_clients(int m) { m_max_clients = m; };
 186     void set_client_idletime (int t) { m_client_idletime = (t > 1) ? t : 600; };
 187     void set_target_idletime (int t) { m_target_idletime = (t > 1) ? t : 600; };
 188     int get_target_idletime () { return m_target_idletime; }
 189     int set_config(const char *name);
 190     int send_to_client(Z_APDU *apdu);
 191 };
 192