1 /* This file is part of Metaproxy.
2 Copyright (C) 2005-2012 Index Data
4 Metaproxy is free software; you can redistribute it and/or modify it under
5 the terms of the GNU General Public License as published by the Free
6 Software Foundation; either version 2, or (at your option) any later
9 Metaproxy is distributed in the hope that it will be useful, but WITHOUT ANY
10 WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 You should have received a copy of the GNU General Public License
15 along with this program; if not, write to the Free Software
16 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
23 #include <metaproxy/util.hpp>
25 #include <metaproxy/filter.hpp>
26 #include <metaproxy/package.hpp>
27 #include "thread_pool_observer.hpp"
28 #include "filter_frontend_net.hpp"
29 #include <yazpp/z-assoc.h>
30 #include <yazpp/pdu-assoc.h>
31 #include <yazpp/socket-manager.h>
32 #include <yazpp/limit-connect.h>
33 #include <yaz/timing.h>
38 namespace mp = metaproxy_1;
40 namespace metaproxy_1 {
41 class My_Timer_Thread;
44 class FrontendNet::Port {
46 friend class FrontendNet;
50 class FrontendNet::Rep {
51 friend class FrontendNet;
53 std::vector<Port> m_ports;
54 int m_listen_duration;
55 int m_session_timeout;
57 std::string m_msg_config;
58 yazpp_1::SocketManager mySocketManager;
62 class My_Timer_Thread : public yazpp_1::ISocketObserver {
64 yazpp_1::ISocketObservable *m_obs;
68 My_Timer_Thread(yazpp_1::ISocketObservable *obs, int duration);
69 void socketNotify(int event);
72 class ZAssocChild : public yazpp_1::Z_Assoc {
75 ZAssocChild(yazpp_1::IPDU_Observable *the_PDU_Observable,
76 mp::ThreadPoolSocketObserver *m_thread_pool_observer,
77 const mp::Package *package,
79 const char *msg_config);
83 yazpp_1::IPDU_Observer* sessionNotify(
84 yazpp_1::IPDU_Observable *the_PDU_Observable,
86 void recv_GDU(Z_GDU *apdu, int len);
92 mp::ThreadPoolSocketObserver *m_thread_pool_observer;
93 mp::Session m_session;
96 const mp::Package *m_package;
97 const char *m_msg_config;
99 class ThreadPoolPackage : public mp::IThreadPoolMsg {
101 ThreadPoolPackage(mp::Package *package, mp::ZAssocChild *ses,
102 const char *msg_config);
103 ~ThreadPoolPackage();
104 IThreadPoolMsg *handle();
105 void result(const char *t_info);
106 bool cleanup(void *info);
109 mp::ZAssocChild *m_assoc_child;
110 mp::Package *m_package;
111 const char *m_msg_config;
113 class ZAssocServer : public yazpp_1::Z_Assoc {
116 ZAssocServer(yazpp_1::IPDU_Observable *PDU_Observable, int timeout,
117 int connect_max, std::string route,
118 const char *msg_config);
119 void set_package(const mp::Package *package);
120 void set_thread_pool(ThreadPoolSocketObserver *m_thread_pool_observer);
122 yazpp_1::IPDU_Observer* sessionNotify(
123 yazpp_1::IPDU_Observable *the_PDU_Observable,
125 void recv_GDU(Z_GDU *apdu, int len);
128 void timeoutNotify();
129 void connectNotify();
131 mp::ThreadPoolSocketObserver *m_thread_pool_observer;
132 const mp::Package *m_package;
133 int m_session_timeout;
135 yazpp_1::LimitConnect limit_connect;
137 const char *m_msg_config;
141 mp::ThreadPoolPackage::ThreadPoolPackage(mp::Package *package,
142 mp::ZAssocChild *ses,
143 const char *msg_config) :
144 m_assoc_child(ses), m_package(package), m_msg_config(msg_config)
147 timer = yaz_timing_create();
152 mp::ThreadPoolPackage::~ThreadPoolPackage()
154 yaz_timing_destroy(&timer); // timer may be NULL
158 bool mp::ThreadPoolPackage::cleanup(void *info)
160 mp::Session *ses = (mp::Session *) info;
162 return *ses == m_package->session();
165 void mp::ThreadPoolPackage::result(const char *t_info)
167 m_assoc_child->m_no_requests--;
169 yazpp_1::GDU *gdu = &m_package->response();
174 m_assoc_child->send_GDU(gdu->get(), &len);
176 else if (!m_package->session().is_closed())
178 // no response package and yet the session is still open..
179 // means that request is unhandled..
180 yazpp_1::GDU *gdu_req = &m_package->request();
181 Z_GDU *z_gdu = gdu_req->get();
182 if (z_gdu && z_gdu->which == Z_GDU_Z3950)
184 // For Z39.50, response with a Close and shutdown
187 Z_APDU *apdu_response = odr.create_close(
188 z_gdu->u.z3950, Z_Close_systemProblem,
189 "unhandled Z39.50 request");
191 m_assoc_child->send_Z_PDU(apdu_response, &len);
193 else if (z_gdu && z_gdu->which == Z_GDU_HTTP_Request)
195 // For HTTP, respond with Server Error
199 = odr.create_HTTP_Response(m_package->session(),
200 z_gdu->u.HTTP_Request, 500);
201 m_assoc_child->send_GDU(zgdu_res, &len);
203 m_package->session().close();
206 if (m_assoc_child->m_no_requests == 0 && m_package->session().is_closed())
208 m_assoc_child->close();
213 yaz_timing_stop(timer);
214 double duration = yaz_timing_get_real(timer);
216 std::ostringstream os;
217 os << m_msg_config << " "
219 << std::fixed << std::setprecision (6) << duration;
221 yaz_log(YLOG_LOG, "%s %s", os.str().c_str(), t_info);
227 mp::IThreadPoolMsg *mp::ThreadPoolPackage::handle()
229 m_package->move(m_assoc_child->m_route);
234 mp::ZAssocChild::ZAssocChild(yazpp_1::IPDU_Observable *PDU_Observable,
235 mp::ThreadPoolSocketObserver *my_thread_pool,
236 const mp::Package *package,
238 const char *msg_config)
239 : Z_Assoc(PDU_Observable), m_msg_config(msg_config)
241 m_thread_pool_observer = my_thread_pool;
243 m_delete_flag = false;
246 const char *peername = PDU_Observable->getpeername();
248 peername = "unknown";
249 m_origin.set_tcpip_address(std::string(peername), m_session.id());
253 yazpp_1::IPDU_Observer *mp::ZAssocChild::sessionNotify(yazpp_1::IPDU_Observable
254 *the_PDU_Observable, int fd)
259 mp::ZAssocChild::~ZAssocChild()
263 void mp::ZAssocChild::recv_GDU(Z_GDU *z_pdu, int len)
267 mp::Package *p = new mp::Package(m_session, m_origin);
269 mp::ThreadPoolPackage *tp = new mp::ThreadPoolPackage(p, this,
271 p->copy_route(*m_package);
272 p->request() = yazpp_1::GDU(z_pdu);
273 m_thread_pool_observer->put(tp);
276 void mp::ZAssocChild::failNotify()
278 // TODO: send Package to signal "close"
279 if (m_session.is_closed())
281 if (m_no_requests == 0)
289 mp::Package *p = new mp::Package(m_session, m_origin);
291 mp::ThreadPoolPackage *tp = new mp::ThreadPoolPackage(p, this,
293 p->copy_route(*m_package);
294 m_thread_pool_observer->cleanup(tp, &m_session);
295 m_thread_pool_observer->put(tp);
298 void mp::ZAssocChild::timeoutNotify()
303 void mp::ZAssocChild::connectNotify()
308 mp::ZAssocServer::ZAssocServer(yazpp_1::IPDU_Observable *PDU_Observable,
309 int timeout, int connect_max,
310 std::string route, const char *msg_config)
311 : Z_Assoc(PDU_Observable), m_session_timeout(timeout),
312 m_connect_max(connect_max), m_route(route), m_msg_config(msg_config)
318 void mp::ZAssocServer::set_package(const mp::Package *package)
323 void mp::ZAssocServer::set_thread_pool(ThreadPoolSocketObserver *observer)
325 m_thread_pool_observer = observer;
328 yazpp_1::IPDU_Observer *mp::ZAssocServer::sessionNotify(yazpp_1::IPDU_Observable
329 *the_PDU_Observable, int fd)
332 const char *peername = the_PDU_Observable->getpeername();
335 limit_connect.add_connect(peername);
336 limit_connect.cleanup(false);
337 int con_sz = limit_connect.get_total(peername);
338 if (m_connect_max && con_sz > m_connect_max)
341 mp::ZAssocChild *my =
342 new mp::ZAssocChild(the_PDU_Observable, m_thread_pool_observer,
343 m_package, m_route, m_msg_config);
344 my->timeout(m_session_timeout);
348 mp::ZAssocServer::~ZAssocServer()
352 void mp::ZAssocServer::recv_GDU(Z_GDU *apdu, int len)
356 void mp::ZAssocServer::failNotify()
360 void mp::ZAssocServer::timeoutNotify()
364 void mp::ZAssocServer::connectNotify()
368 mp::filter::FrontendNet::FrontendNet() : m_p(new Rep)
370 m_p->m_no_threads = 5;
371 m_p->m_listen_duration = 0;
372 m_p->m_session_timeout = 300; // 5 minutes
373 m_p->m_connect_max = 0;
377 mp::filter::FrontendNet::~FrontendNet()
382 for (i = 0; i<m_p->m_ports.size(); i++)
389 void mp::filter::FrontendNet::stop() const
394 for (i = 0; i<m_p->m_ports.size(); i++)
395 m_p->az[i]->server("");
399 bool mp::My_Timer_Thread::timeout()
404 mp::My_Timer_Thread::My_Timer_Thread(yazpp_1::ISocketObservable *obs,
406 m_obs(obs), m_pipe(9123), m_timeout(false)
408 obs->addObserver(m_pipe.read_fd(), this);
409 obs->maskObserver(this, yazpp_1::SOCKET_OBSERVE_READ);
410 obs->timeoutObserver(this, duration);
413 void mp::My_Timer_Thread::socketNotify(int event)
416 m_obs->deleteObserver(this);
419 void mp::filter::FrontendNet::process(Package &package) const
424 My_Timer_Thread *tt = 0;
426 if (m_p->m_listen_duration)
427 tt = new My_Timer_Thread(&m_p->mySocketManager,
428 m_p->m_listen_duration);
430 ThreadPoolSocketObserver tp(&m_p->mySocketManager, m_p->m_no_threads);
432 for (i = 0; i<m_p->m_ports.size(); i++)
434 m_p->az[i]->set_package(&package);
435 m_p->az[i]->set_thread_pool(&tp);
437 while (m_p->mySocketManager.processEvent() > 0)
439 if (m_p->mySocketManager.getNumberOfObservers() <= 1)
441 if (tt && tt->timeout())
447 void mp::filter::FrontendNet::configure(const xmlNode * ptr, bool test_only,
450 if (!ptr || !ptr->children)
452 throw mp::filter::FilterException("No ports for Frontend");
454 std::vector<Port> ports;
455 for (ptr = ptr->children; ptr; ptr = ptr->next)
457 if (ptr->type != XML_ELEMENT_NODE)
459 if (!strcmp((const char *) ptr->name, "port"))
462 const struct _xmlAttr *attr;
463 for (attr = ptr->properties; attr; attr = attr->next)
465 if (!strcmp((const char *) attr->name, "route"))
466 port.route = mp::xml::get_text(attr);
468 port.port = mp::xml::get_text(ptr);
469 ports.push_back(port);
472 else if (!strcmp((const char *) ptr->name, "threads"))
474 std::string threads_str = mp::xml::get_text(ptr);
475 int threads = atoi(threads_str.c_str());
477 throw mp::filter::FilterException("Bad value for threads: "
479 m_p->m_no_threads = threads;
481 else if (!strcmp((const char *) ptr->name, "timeout"))
483 std::string timeout_str = mp::xml::get_text(ptr);
484 int timeout = atoi(timeout_str.c_str());
486 throw mp::filter::FilterException("Bad value for timeout: "
488 m_p->m_session_timeout = timeout;
490 else if (!strcmp((const char *) ptr->name, "connect-max"))
492 m_p->m_connect_max = mp::xml::get_int(ptr, 0);
494 else if (!strcmp((const char *) ptr->name, "message"))
496 m_p->m_msg_config = mp::xml::get_text(ptr);
500 throw mp::filter::FilterException("Bad element "
501 + std::string((const char *)
510 void mp::filter::FrontendNet::set_ports(std::vector<std::string> &ports)
512 std::vector<Port> nports;
515 for (i = 0; i < ports.size(); i++)
519 nport.port = ports[i];
521 nports.push_back(nport);
527 void mp::filter::FrontendNet::set_ports(std::vector<Port> &ports)
529 m_p->m_ports = ports;
531 m_p->az = new mp::ZAssocServer *[m_p->m_ports.size()];
533 // Create mp::ZAssocServer for each port
535 for (i = 0; i<m_p->m_ports.size(); i++)
537 // create a PDU assoc object (one per mp::ZAssocServer)
538 yazpp_1::PDU_Assoc *as = new yazpp_1::PDU_Assoc(&m_p->mySocketManager);
540 // create ZAssoc with PDU Assoc
541 m_p->az[i] = new mp::ZAssocServer(as,
542 m_p->m_session_timeout,
544 m_p->m_ports[i].route,
545 m_p->m_msg_config.length() > 0 ?
546 m_p->m_msg_config.c_str() : 0);
547 if (m_p->az[i]->server(m_p->m_ports[i].port.c_str()))
549 throw mp::filter::FilterException("Unable to bind to address "
550 + std::string(m_p->m_ports[i].port));
555 void mp::filter::FrontendNet::set_listen_duration(int d)
557 m_p->m_listen_duration = d;
560 static mp::filter::Base* filter_creator()
562 return new mp::filter::FrontendNet;
566 struct metaproxy_1_filter_struct metaproxy_1_filter_frontend_net = {
576 * c-file-style: "Stroustrup"
577 * indent-tabs-mode: nil
579 * vim: shiftwidth=4 tabstop=8 expandtab