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