Release Z39.50 sessions properly.
[metaproxy-moved-to-github.git] / src / filter_z3950_client.cpp
1 /* $Id: filter_z3950_client.cpp,v 1.2 2005-10-16 21:55:36 adam Exp $
2    Copyright (c) 2005, Index Data.
3
4 %LICENSE%
5  */
6
7 #include "config.hpp"
8
9 #include "filter.hpp"
10 #include "router.hpp"
11 #include "package.hpp"
12
13 #include <boost/thread/mutex.hpp>
14
15 #include "filter_z3950_client.hpp"
16
17 #include <yaz/zgdu.h>
18 #include <yaz/log.h>
19 #include <yaz/otherinfo.h>
20 #include <yaz/diagbib1.h>
21
22 #include <yaz++/socket-manager.h>
23 #include <yaz++/pdu-assoc.h>
24 #include <yaz++/z-assoc.h>
25
26 #include <iostream>
27
28 namespace yf = yp2::filter;
29
30 namespace yp2 {
31     namespace filter {
32         class Z3950Client::Assoc : public yazpp_1::Z_Assoc{
33             friend class Pimpl;
34         public:
35             Assoc(yp2::Session id, yazpp_1::SocketManager *socket_manager,
36                   yazpp_1::IPDU_Observable *PDU_Observable,
37                   std::string host);
38             ~Assoc();
39             void connectNotify();
40             void failNotify();
41             void timeoutNotify();
42             void recv_GDU(Z_GDU *gdu, int len);
43             yazpp_1::IPDU_Observer* sessionNotify(
44                 yazpp_1::IPDU_Observable *the_PDU_Observable,
45                 int fd);
46         private:
47             yp2::Session m_session_id;
48             yazpp_1::SocketManager *m_socket_manager;
49             yazpp_1::IPDU_Observable *m_PDU_Observable;
50             Package *m_package;
51             bool m_waiting;
52             bool m_connected;
53             std::string m_host;
54         };
55
56         class Z3950Client::Pimpl {
57         public:
58             boost::mutex m_mutex;
59             std::list<Z3950Client::Assoc *> m_clients;
60             Z3950Client::Assoc *get_assoc(Package &package);
61             void send_and_receive(Package &package,
62                                   yf::Z3950Client::Assoc *c);
63             void release_assoc(Package &package,
64                                yf::Z3950Client::Assoc *c);
65         };
66     }
67 }
68
69
70 yf::Z3950Client::Assoc::Assoc(yp2::Session id,
71                               yazpp_1::SocketManager *socket_manager,
72                               yazpp_1::IPDU_Observable *PDU_Observable,
73                               std::string host)
74     :  Z_Assoc(PDU_Observable), m_session_id(id),
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::list<yf::Z3950Client::Assoc *>::iterator it;
161
162     for (it = m_clients.begin(); it != m_clients.end(); it++)
163     {
164         if ((*it)->m_session_id == package.session())
165             break;
166     }
167     if (it != m_clients.end())
168         return *it;
169
170     // only deal with Z39.50
171     Z_GDU *gdu = package.request().get();
172
173     if (!gdu || gdu->which != Z_GDU_Z3950)
174     {
175         package.move();
176         return 0;
177     }
178     Z_APDU *apdu = gdu->u.z3950;
179
180     // new Z39.50 session ..
181
182     // check that it is init. If not, close
183     if (apdu->which != Z_APDU_initRequest)
184     {
185         ODR odr = odr_createmem(ODR_ENCODE);
186         Z_APDU *apdu = zget_APDU(odr, Z_APDU_close);
187         
188         *apdu->u.close->closeReason = Z_Close_protocolError;
189         package.response() = apdu;
190         
191         package.session().close();
192         odr_destroy(odr);
193         return 0;
194     }
195     // check virtual host
196     const char *vhost =
197         yaz_oi_get_string_oidval(&apdu->u.initRequest->otherInfo,
198                                  VAL_PROXY, 1, 0);
199     if (!vhost)
200     {
201         ODR odr = odr_createmem(ODR_ENCODE);
202         Z_APDU *apdu = zget_APDU(odr, Z_APDU_initResponse);
203         
204         apdu->u.initResponse->userInformationField =
205             zget_init_diagnostics(odr, 
206                                   YAZ_BIB1_INIT_NEGOTIATION_OPTION_REQUIRED,
207                                   "Virtual host not given");
208         package.response() = apdu;
209             
210         package.session().close();
211         odr_destroy(odr);
212         return 0;
213     }
214     
215     yazpp_1::SocketManager *sm = new yazpp_1::SocketManager;
216     yazpp_1::PDU_Assoc *pdu_as = new yazpp_1::PDU_Assoc(sm);
217     yf::Z3950Client::Assoc *as = new yf::Z3950Client::Assoc(package.session(),
218                                                             sm, pdu_as,
219                                                             vhost);
220     m_clients.push_back(as);
221     return as;
222 }
223
224 void yf::Z3950Client::Pimpl::send_and_receive(Package &package,
225                                               yf::Z3950Client::Assoc *c)
226 {
227     Z_GDU *gdu = package.request().get();
228
229     if (!gdu || gdu->which != Z_GDU_Z3950)
230         return;
231
232     // we should lock c!
233
234     c->m_package = &package;
235     c->m_waiting = true;
236     if (!c->m_connected)
237     {
238         c->client(c->m_host.c_str());
239
240         while (c->m_waiting && c->m_socket_manager->processEvent() > 0)
241             ;
242     }
243     if (!c->m_connected)
244     {
245         return;
246     }
247
248     // prepare response
249     c->m_waiting = true;
250     
251     // relay the package  ..
252     int len;
253     c->send_GDU(gdu, &len);
254     
255     while (c->m_waiting && c->m_socket_manager->processEvent() > 0)
256         ;
257 }
258
259 void yf::Z3950Client::Pimpl::release_assoc(Package &package,
260                                            yf::Z3950Client::Assoc *c)
261 {
262     if (package.session().is_closed())
263     {
264         boost::mutex::scoped_lock lock(m_mutex);
265         std::list<yf::Z3950Client::Assoc *>::iterator it;
266
267         for (it = m_clients.begin(); it != m_clients.end(); it++)
268         {
269             if ((*it)->m_session_id == package.session())
270                 break;
271         }
272         if (it != m_clients.end())
273         {
274             // the Z_Assoc and PDU_Assoc must be destroyed before
275             // the socket manager.. so pull that out.. first..
276             yazpp_1::SocketManager *s = (*it)->m_socket_manager;
277             delete *it;  // destroy Z_Assoc
278             delete s;    // then manager
279             m_clients.erase(it);
280         }
281     }
282 }
283
284 void yf::Z3950Client::process(Package &package) const
285 {
286     yf::Z3950Client::Assoc *c = m_p->get_assoc(package);
287     if (c)
288     {
289         m_p->send_and_receive(package, c);
290         m_p->release_assoc(package, c);
291     }
292 }
293
294
295 /*
296  * Local variables:
297  * c-basic-offset: 4
298  * indent-tabs-mode: nil
299  * c-file-style: "stroustrup"
300  * End:
301  * vim: shiftwidth=4 tabstop=8 expandtab
302  */