Experimented with template for session management in filter
[metaproxy-moved-to-github.git] / src / filter_z3950_client.cpp
1 /* $Id: filter_z3950_client.cpp,v 1.5 2005-10-25 21:32:01 adam Exp $
2    Copyright (c) 2005, Index Data.
3
4 %LICENSE%
5  */
6
7 #include "config.hpp"
8
9 #include <map>
10 #include "filter.hpp"
11 #include "router.hpp"
12 #include "package.hpp"
13
14 #include <boost/thread/mutex.hpp>
15
16 #include "filter_z3950_client.hpp"
17
18 #include <yaz/zgdu.h>
19 #include <yaz/log.h>
20 #include <yaz/otherinfo.h>
21 #include <yaz/diagbib1.h>
22
23 #include <yaz++/socket-manager.h>
24 #include <yaz++/pdu-assoc.h>
25 #include <yaz++/z-assoc.h>
26
27 #include <iostream>
28
29 namespace yf = yp2::filter;
30
31 namespace yp2 {
32     namespace filter {
33         class Z3950Client::Assoc : public yazpp_1::Z_Assoc{
34             friend class Pimpl;
35         public:
36             Assoc(yazpp_1::SocketManager *socket_manager,
37                   yazpp_1::IPDU_Observable *PDU_Observable,
38                   std::string host);
39             ~Assoc();
40             void connectNotify();
41             void failNotify();
42             void timeoutNotify();
43             void recv_GDU(Z_GDU *gdu, int len);
44             yazpp_1::IPDU_Observer* sessionNotify(
45                 yazpp_1::IPDU_Observable *the_PDU_Observable,
46                 int fd);
47         private:
48             // yp2::Session m_session_id;
49             yazpp_1::SocketManager *m_socket_manager;
50             yazpp_1::IPDU_Observable *m_PDU_Observable;
51             Package *m_package;
52             bool m_waiting;
53             bool m_connected;
54             std::string m_host;
55         };
56
57         class Z3950Client::Pimpl {
58         public:
59             boost::mutex m_mutex;
60             std::map<yp2::Session,Z3950Client::Assoc *> m_clients;
61             Z3950Client::Assoc *get_assoc(Package &package);
62             void send_and_receive(Package &package,
63                                   yf::Z3950Client::Assoc *c);
64             void release_assoc(Package &package,
65                                yf::Z3950Client::Assoc *c);
66         };
67     }
68 }
69
70
71 yf::Z3950Client::Assoc::Assoc(yazpp_1::SocketManager *socket_manager,
72                               yazpp_1::IPDU_Observable *PDU_Observable,
73                               std::string host)
74     :  Z_Assoc(PDU_Observable),
75        m_socket_manager(socket_manager), m_PDU_Observable(PDU_Observable),
76        m_package(0), m_waiting(false), m_connected(false),
77        m_host(host)
78 {
79     // std::cout << "create assoc " << this << "\n";
80 }
81
82 yf::Z3950Client::Assoc::~Assoc()
83 {
84     // std::cout << "destroy assoc " << this << "\n";
85 }
86
87 void yf::Z3950Client::Assoc::connectNotify()
88 {
89     m_waiting = false;
90
91     m_connected = true;
92 }
93
94 void yf::Z3950Client::Assoc::failNotify()
95 {
96     m_waiting = false;
97
98     ODR odr = odr_createmem(ODR_ENCODE);
99
100     Z_APDU *apdu = zget_APDU(odr, Z_APDU_close);
101
102     *apdu->u.close->closeReason = Z_Close_peerAbort;
103
104     if (m_package)
105     {
106         m_package->response() = apdu;
107         m_package->session().close();
108     }
109
110     odr_destroy(odr);
111 }
112
113 void yf::Z3950Client::Assoc::timeoutNotify()
114 {
115     m_waiting = false;
116
117     ODR odr = odr_createmem(ODR_ENCODE);
118
119     Z_APDU *apdu = zget_APDU(odr, Z_APDU_close);
120
121     *apdu->u.close->closeReason = Z_Close_lackOfActivity;
122
123     if (m_package)
124     {
125         m_package->response() = apdu;
126         m_package->session().close();
127     }
128     odr_destroy(odr);
129 }
130
131 void yf::Z3950Client::Assoc::recv_GDU(Z_GDU *gdu, int len)
132 {
133     m_waiting = false;
134
135     if (m_package)
136         m_package->response() = gdu;
137 }
138
139 yazpp_1::IPDU_Observer *yf::Z3950Client::Assoc::sessionNotify(
140     yazpp_1::IPDU_Observable *the_PDU_Observable,
141     int fd)
142 {
143     return 0;
144 }
145
146
147 yf::Z3950Client::Z3950Client() {
148     m_p = new yf::Z3950Client::Pimpl;
149 }
150
151 yf::Z3950Client::~Z3950Client() {
152     delete m_p;
153 }
154
155 yf::Z3950Client::Assoc *yf::Z3950Client::Pimpl::get_assoc(Package &package) 
156 {
157     // only one thread messes with the clients list at a time
158     boost::mutex::scoped_lock lock(m_mutex);
159
160     std::map<yp2::Session,yf::Z3950Client::Assoc *>::iterator it;
161     
162     it = m_clients.find(package.session());
163     if (it != m_clients.end())
164         return it->second;
165
166     // only deal with Z39.50
167     Z_GDU *gdu = package.request().get();
168
169     if (!gdu || gdu->which != Z_GDU_Z3950)
170     {
171         package.move();
172         return 0;
173     }
174     Z_APDU *apdu = gdu->u.z3950;
175
176     // new Z39.50 session ..
177
178     // check that it is init. If not, close
179     if (apdu->which != Z_APDU_initRequest)
180     {
181         ODR odr = odr_createmem(ODR_ENCODE);
182         Z_APDU *apdu = zget_APDU(odr, Z_APDU_close);
183         
184         *apdu->u.close->closeReason = Z_Close_protocolError;
185         apdu->u.close->diagnosticInformation =
186             odr_strdup(odr, "no init request for session");
187
188         package.response() = apdu;
189         
190         package.session().close();
191         odr_destroy(odr);
192         return 0;
193     }
194     // check virtual host
195     const char *vhost =
196         yaz_oi_get_string_oidval(&apdu->u.initRequest->otherInfo,
197                                  VAL_PROXY, 1, 0);
198     if (!vhost)
199     {
200         ODR odr = odr_createmem(ODR_ENCODE);
201         Z_APDU *apdu = zget_APDU(odr, Z_APDU_initResponse);
202         
203         apdu->u.initResponse->userInformationField =
204             zget_init_diagnostics(odr, 
205                                   YAZ_BIB1_INIT_NEGOTIATION_OPTION_REQUIRED,
206                                   "Virtual host not given");
207         package.response() = apdu;
208             
209         package.session().close();
210         odr_destroy(odr);
211         return 0;
212     }
213     
214     yazpp_1::SocketManager *sm = new yazpp_1::SocketManager;
215     yazpp_1::PDU_Assoc *pdu_as = new yazpp_1::PDU_Assoc(sm);
216     yf::Z3950Client::Assoc *as = new yf::Z3950Client::Assoc(sm, pdu_as, vhost);
217     m_clients[package.session()] = as;
218     return as;
219 }
220
221 void yf::Z3950Client::Pimpl::send_and_receive(Package &package,
222                                               yf::Z3950Client::Assoc *c)
223 {
224     Z_GDU *gdu = package.request().get();
225
226     if (!gdu || gdu->which != Z_GDU_Z3950)
227         return;
228
229     // we should lock c!
230
231     c->m_package = &package;
232     c->m_waiting = true;
233     if (!c->m_connected)
234     {
235         c->client(c->m_host.c_str());
236
237         while (c->m_waiting && c->m_socket_manager->processEvent() > 0)
238             ;
239     }
240     if (!c->m_connected)
241     {
242         return;
243     }
244
245     // prepare response
246     c->m_waiting = true;
247     
248     // relay the package  ..
249     int len;
250     c->send_GDU(gdu, &len);
251     
252     while (c->m_waiting && c->m_socket_manager->processEvent() > 0)
253         ;
254 }
255
256 void yf::Z3950Client::Pimpl::release_assoc(Package &package,
257                                            yf::Z3950Client::Assoc *c)
258 {
259     if (package.session().is_closed())
260     {
261         boost::mutex::scoped_lock lock(m_mutex);
262         std::map<yp2::Session,yf::Z3950Client::Assoc *>::iterator it;
263
264         it = m_clients.find(package.session());
265         if (it != m_clients.end())
266         {
267             // the Z_Assoc and PDU_Assoc must be destroyed before
268             // the socket manager.. so pull that out.. first..
269             yazpp_1::SocketManager *s = it->second->m_socket_manager;
270             delete it->second;  // destroy Z_Assoc
271             delete s;    // then manager
272             m_clients.erase(it);
273         }
274     }
275 }
276
277 void yf::Z3950Client::process(Package &package) const
278 {
279     yf::Z3950Client::Assoc *c = m_p->get_assoc(package);
280     if (c)
281     {
282         m_p->send_and_receive(package, c);
283         m_p->release_assoc(package, c);
284     }
285 }
286
287
288 /*
289  * Local variables:
290  * c-basic-offset: 4
291  * indent-tabs-mode: nil
292  * c-file-style: "stroustrup"
293  * End:
294  * vim: shiftwidth=4 tabstop=8 expandtab
295  */