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>
35 #include "gduutil.hpp"
39 namespace mp = metaproxy_1;
41 namespace metaproxy_1 {
42 class My_Timer_Thread;
45 class FrontendNet::Port {
47 friend class FrontendNet;
51 class FrontendNet::Rep {
52 friend class FrontendNet;
54 std::vector<Port> m_ports;
55 int m_listen_duration;
56 int m_session_timeout;
58 std::string m_msg_config;
59 yazpp_1::SocketManager mySocketManager;
63 class My_Timer_Thread : public yazpp_1::ISocketObserver {
65 yazpp_1::ISocketObservable *m_obs;
69 My_Timer_Thread(yazpp_1::ISocketObservable *obs, int duration);
70 void socketNotify(int event);
73 class ZAssocChild : public yazpp_1::Z_Assoc {
76 ZAssocChild(yazpp_1::IPDU_Observable *the_PDU_Observable,
77 mp::ThreadPoolSocketObserver *m_thread_pool_observer,
78 const mp::Package *package,
80 const char *msg_config);
84 yazpp_1::IPDU_Observer* sessionNotify(
85 yazpp_1::IPDU_Observable *the_PDU_Observable,
87 void recv_GDU(Z_GDU *apdu, int len);
93 mp::ThreadPoolSocketObserver *m_thread_pool_observer;
94 mp::Session m_session;
97 const mp::Package *m_package;
98 const char *m_msg_config;
100 class ThreadPoolPackage : public mp::IThreadPoolMsg {
102 ThreadPoolPackage(mp::Package *package, mp::ZAssocChild *ses,
103 const char *msg_config);
104 ~ThreadPoolPackage();
105 IThreadPoolMsg *handle();
106 void result(const char *t_info);
107 bool cleanup(void *info);
110 mp::ZAssocChild *m_assoc_child;
111 mp::Package *m_package;
112 const char *m_msg_config;
114 class ZAssocServer : public yazpp_1::Z_Assoc {
117 ZAssocServer(yazpp_1::IPDU_Observable *PDU_Observable, int timeout,
118 int connect_max, std::string route,
119 const char *msg_config);
120 void set_package(const mp::Package *package);
121 void set_thread_pool(ThreadPoolSocketObserver *m_thread_pool_observer);
123 yazpp_1::IPDU_Observer* sessionNotify(
124 yazpp_1::IPDU_Observable *the_PDU_Observable,
126 void recv_GDU(Z_GDU *apdu, int len);
129 void timeoutNotify();
130 void connectNotify();
132 mp::ThreadPoolSocketObserver *m_thread_pool_observer;
133 const mp::Package *m_package;
134 int m_session_timeout;
136 yazpp_1::LimitConnect limit_connect;
138 const char *m_msg_config;
142 mp::ThreadPoolPackage::ThreadPoolPackage(mp::Package *package,
143 mp::ZAssocChild *ses,
144 const char *msg_config) :
145 m_assoc_child(ses), m_package(package), m_msg_config(msg_config)
148 timer = yaz_timing_create();
153 mp::ThreadPoolPackage::~ThreadPoolPackage()
155 yaz_timing_destroy(&timer); // timer may be NULL
159 bool mp::ThreadPoolPackage::cleanup(void *info)
161 mp::Session *ses = (mp::Session *) info;
163 return *ses == m_package->session();
166 void mp::ThreadPoolPackage::result(const char *t_info)
168 m_assoc_child->m_no_requests--;
170 yazpp_1::GDU *gdu = &m_package->response();
175 m_assoc_child->send_GDU(gdu->get(), &len);
177 else if (!m_package->session().is_closed())
179 // no response package and yet the session is still open..
180 // means that request is unhandled..
181 yazpp_1::GDU *gdu_req = &m_package->request();
182 Z_GDU *z_gdu = gdu_req->get();
183 if (z_gdu && z_gdu->which == Z_GDU_Z3950)
185 // For Z39.50, response with a Close and shutdown
188 Z_APDU *apdu_response = odr.create_close(
189 z_gdu->u.z3950, Z_Close_systemProblem,
190 "unhandled Z39.50 request");
192 m_assoc_child->send_Z_PDU(apdu_response, &len);
194 else if (z_gdu && z_gdu->which == Z_GDU_HTTP_Request)
196 // For HTTP, respond with Server Error
200 = odr.create_HTTP_Response(m_package->session(),
201 z_gdu->u.HTTP_Request, 500);
202 m_assoc_child->send_GDU(zgdu_res, &len);
204 m_package->session().close();
207 if (m_assoc_child->m_no_requests == 0 && m_package->session().is_closed())
209 m_assoc_child->close();
214 yaz_timing_stop(timer);
215 double duration = yaz_timing_get_real(timer);
216 Z_GDU *z_gdu = gdu->get();
218 std::ostringstream os;
219 os << m_msg_config << " "
221 << std::fixed << std::setprecision (6) << duration << " ";
228 yaz_log(YLOG_LOG, "%s %s", os.str().c_str(), t_info);
234 mp::IThreadPoolMsg *mp::ThreadPoolPackage::handle()
236 m_package->move(m_assoc_child->m_route);
241 mp::ZAssocChild::ZAssocChild(yazpp_1::IPDU_Observable *PDU_Observable,
242 mp::ThreadPoolSocketObserver *my_thread_pool,
243 const mp::Package *package,
245 const char *msg_config)
246 : Z_Assoc(PDU_Observable), m_msg_config(msg_config)
248 m_thread_pool_observer = my_thread_pool;
250 m_delete_flag = false;
253 const char *peername = PDU_Observable->getpeername();
255 peername = "unknown";
256 m_origin.set_tcpip_address(std::string(peername), m_session.id());
260 yazpp_1::IPDU_Observer *mp::ZAssocChild::sessionNotify(yazpp_1::IPDU_Observable
261 *the_PDU_Observable, int fd)
266 mp::ZAssocChild::~ZAssocChild()
270 void mp::ZAssocChild::recv_GDU(Z_GDU *z_pdu, int len)
274 mp::Package *p = new mp::Package(m_session, m_origin);
276 mp::ThreadPoolPackage *tp = new mp::ThreadPoolPackage(p, this,
278 p->copy_route(*m_package);
279 p->request() = yazpp_1::GDU(z_pdu);
285 std::ostringstream os;
286 os << m_msg_config << " "
290 yaz_log(YLOG_LOG, "%s", os.str().c_str());
293 m_thread_pool_observer->put(tp);
296 void mp::ZAssocChild::failNotify()
298 // TODO: send Package to signal "close"
299 if (m_session.is_closed())
301 if (m_no_requests == 0)
309 mp::Package *p = new mp::Package(m_session, m_origin);
311 mp::ThreadPoolPackage *tp = new mp::ThreadPoolPackage(p, this,
313 p->copy_route(*m_package);
314 m_thread_pool_observer->cleanup(tp, &m_session);
315 m_thread_pool_observer->put(tp);
318 void mp::ZAssocChild::timeoutNotify()
323 void mp::ZAssocChild::connectNotify()
328 mp::ZAssocServer::ZAssocServer(yazpp_1::IPDU_Observable *PDU_Observable,
329 int timeout, int connect_max,
330 std::string route, const char *msg_config)
331 : Z_Assoc(PDU_Observable), m_session_timeout(timeout),
332 m_connect_max(connect_max), m_route(route), m_msg_config(msg_config)
338 void mp::ZAssocServer::set_package(const mp::Package *package)
343 void mp::ZAssocServer::set_thread_pool(ThreadPoolSocketObserver *observer)
345 m_thread_pool_observer = observer;
348 yazpp_1::IPDU_Observer *mp::ZAssocServer::sessionNotify(yazpp_1::IPDU_Observable
349 *the_PDU_Observable, int fd)
352 const char *peername = the_PDU_Observable->getpeername();
355 limit_connect.add_connect(peername);
356 limit_connect.cleanup(false);
357 int con_sz = limit_connect.get_total(peername);
358 if (m_connect_max && con_sz > m_connect_max)
361 mp::ZAssocChild *my =
362 new mp::ZAssocChild(the_PDU_Observable, m_thread_pool_observer,
363 m_package, m_route, m_msg_config);
364 my->timeout(m_session_timeout);
368 mp::ZAssocServer::~ZAssocServer()
372 void mp::ZAssocServer::recv_GDU(Z_GDU *apdu, int len)
376 void mp::ZAssocServer::failNotify()
380 void mp::ZAssocServer::timeoutNotify()
384 void mp::ZAssocServer::connectNotify()
388 mp::filter::FrontendNet::FrontendNet() : m_p(new Rep)
390 m_p->m_no_threads = 5;
391 m_p->m_listen_duration = 0;
392 m_p->m_session_timeout = 300; // 5 minutes
393 m_p->m_connect_max = 0;
397 mp::filter::FrontendNet::~FrontendNet()
402 for (i = 0; i<m_p->m_ports.size(); i++)
409 void mp::filter::FrontendNet::stop() const
414 for (i = 0; i<m_p->m_ports.size(); i++)
415 m_p->az[i]->server("");
419 bool mp::My_Timer_Thread::timeout()
424 mp::My_Timer_Thread::My_Timer_Thread(yazpp_1::ISocketObservable *obs,
426 m_obs(obs), m_pipe(9123), m_timeout(false)
428 obs->addObserver(m_pipe.read_fd(), this);
429 obs->maskObserver(this, yazpp_1::SOCKET_OBSERVE_READ);
430 obs->timeoutObserver(this, duration);
433 void mp::My_Timer_Thread::socketNotify(int event)
436 m_obs->deleteObserver(this);
439 void mp::filter::FrontendNet::process(Package &package) const
444 My_Timer_Thread *tt = 0;
446 if (m_p->m_listen_duration)
447 tt = new My_Timer_Thread(&m_p->mySocketManager,
448 m_p->m_listen_duration);
450 ThreadPoolSocketObserver tp(&m_p->mySocketManager, m_p->m_no_threads);
452 for (i = 0; i<m_p->m_ports.size(); i++)
454 m_p->az[i]->set_package(&package);
455 m_p->az[i]->set_thread_pool(&tp);
457 while (m_p->mySocketManager.processEvent() > 0)
459 int no = m_p->mySocketManager.getNumberOfObservers();
462 if (tt && tt->timeout())
468 void mp::filter::FrontendNet::configure(const xmlNode * ptr, bool test_only,
471 if (!ptr || !ptr->children)
473 throw mp::filter::FilterException("No ports for Frontend");
475 std::vector<Port> ports;
476 for (ptr = ptr->children; ptr; ptr = ptr->next)
478 if (ptr->type != XML_ELEMENT_NODE)
480 if (!strcmp((const char *) ptr->name, "port"))
483 const struct _xmlAttr *attr;
484 for (attr = ptr->properties; attr; attr = attr->next)
486 if (!strcmp((const char *) attr->name, "route"))
487 port.route = mp::xml::get_text(attr);
489 port.port = mp::xml::get_text(ptr);
490 ports.push_back(port);
493 else if (!strcmp((const char *) ptr->name, "threads"))
495 std::string threads_str = mp::xml::get_text(ptr);
496 int threads = atoi(threads_str.c_str());
498 throw mp::filter::FilterException("Bad value for threads: "
500 m_p->m_no_threads = threads;
502 else if (!strcmp((const char *) ptr->name, "timeout"))
504 std::string timeout_str = mp::xml::get_text(ptr);
505 int timeout = atoi(timeout_str.c_str());
507 throw mp::filter::FilterException("Bad value for timeout: "
509 m_p->m_session_timeout = timeout;
511 else if (!strcmp((const char *) ptr->name, "connect-max"))
513 m_p->m_connect_max = mp::xml::get_int(ptr, 0);
515 else if (!strcmp((const char *) ptr->name, "message"))
517 m_p->m_msg_config = mp::xml::get_text(ptr);
521 throw mp::filter::FilterException("Bad element "
522 + std::string((const char *)
531 void mp::filter::FrontendNet::set_ports(std::vector<std::string> &ports)
533 std::vector<Port> nports;
536 for (i = 0; i < ports.size(); i++)
540 nport.port = ports[i];
542 nports.push_back(nport);
548 void mp::filter::FrontendNet::set_ports(std::vector<Port> &ports)
550 m_p->m_ports = ports;
552 m_p->az = new mp::ZAssocServer *[m_p->m_ports.size()];
554 // Create mp::ZAssocServer for each port
556 for (i = 0; i<m_p->m_ports.size(); i++)
558 // create a PDU assoc object (one per mp::ZAssocServer)
559 yazpp_1::PDU_Assoc *as = new yazpp_1::PDU_Assoc(&m_p->mySocketManager);
561 // create ZAssoc with PDU Assoc
562 m_p->az[i] = new mp::ZAssocServer(as,
563 m_p->m_session_timeout,
565 m_p->m_ports[i].route,
566 m_p->m_msg_config.length() > 0 ?
567 m_p->m_msg_config.c_str() : 0);
568 if (m_p->az[i]->server(m_p->m_ports[i].port.c_str()))
570 throw mp::filter::FilterException("Unable to bind to address "
571 + std::string(m_p->m_ports[i].port));
576 void mp::filter::FrontendNet::set_listen_duration(int d)
578 m_p->m_listen_duration = d;
581 static mp::filter::Base* filter_creator()
583 return new mp::filter::FrontendNet;
587 struct metaproxy_1_filter_struct metaproxy_1_filter_frontend_net = {
597 * c-file-style: "Stroustrup"
598 * indent-tabs-mode: nil
600 * vim: shiftwidth=4 tabstop=8 expandtab