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;
40 namespace yf = metaproxy_1::filter;
42 namespace metaproxy_1 {
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;
61 class FrontendNet::My_Timer_Thread : public yazpp_1::ISocketObserver {
63 yazpp_1::ISocketObservable *m_obs;
67 My_Timer_Thread(yazpp_1::ISocketObservable *obs, int duration);
68 void socketNotify(int event);
71 class FrontendNet::ZAssocChild : public yazpp_1::Z_Assoc {
74 ZAssocChild(yazpp_1::IPDU_Observable *the_PDU_Observable,
75 mp::ThreadPoolSocketObserver *m_thread_pool_observer,
76 const mp::Package *package,
78 const char *msg_config);
82 yazpp_1::IPDU_Observer* sessionNotify(
83 yazpp_1::IPDU_Observable *the_PDU_Observable,
85 void recv_GDU(Z_GDU *apdu, int len);
91 mp::ThreadPoolSocketObserver *m_thread_pool_observer;
92 mp::Session m_session;
95 const mp::Package *m_package;
96 const char *m_msg_config;
98 class FrontendNet::ThreadPoolPackage : public mp::IThreadPoolMsg {
100 ThreadPoolPackage(mp::Package *package,
101 yf::FrontendNet::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 ZAssocChild *m_assoc_child;
110 mp::Package *m_package;
111 const char *m_msg_config;
113 class FrontendNet::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;
142 yf::FrontendNet::ThreadPoolPackage::ThreadPoolPackage(mp::Package *package,
144 const char *msg_config) :
145 m_assoc_child(ses), m_package(package), m_msg_config(msg_config)
148 timer = yaz_timing_create();
153 yf::FrontendNet::ThreadPoolPackage::~ThreadPoolPackage()
155 yaz_timing_destroy(&timer); // timer may be NULL
159 bool yf::FrontendNet::ThreadPoolPackage::cleanup(void *info)
161 mp::Session *ses = (mp::Session *) info;
163 return *ses == m_package->session();
166 void yf::FrontendNet::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 *yf::FrontendNet::ThreadPoolPackage::handle()
236 m_package->move(m_assoc_child->m_route);
241 yf::FrontendNet::ZAssocChild::ZAssocChild(
242 yazpp_1::IPDU_Observable *PDU_Observable,
243 mp::ThreadPoolSocketObserver *my_thread_pool,
244 const mp::Package *package,
246 const char *msg_config)
247 : Z_Assoc(PDU_Observable), m_msg_config(msg_config)
249 m_thread_pool_observer = my_thread_pool;
251 m_delete_flag = false;
254 const char *peername = PDU_Observable->getpeername();
256 peername = "unknown";
257 m_origin.set_tcpip_address(std::string(peername), m_session.id());
261 yazpp_1::IPDU_Observer *yf::FrontendNet::ZAssocChild::sessionNotify(
262 yazpp_1::IPDU_Observable
263 *the_PDU_Observable, int fd)
268 yf::FrontendNet::ZAssocChild::~ZAssocChild()
272 void yf::FrontendNet::ZAssocChild::recv_GDU(Z_GDU *z_pdu, int len)
276 mp::Package *p = new mp::Package(m_session, m_origin);
278 ThreadPoolPackage *tp = new ThreadPoolPackage(p, this, m_msg_config);
279 p->copy_route(*m_package);
280 p->request() = yazpp_1::GDU(z_pdu);
286 std::ostringstream os;
287 os << m_msg_config << " "
291 yaz_log(YLOG_LOG, "%s", os.str().c_str());
294 m_thread_pool_observer->put(tp);
297 void yf::FrontendNet::ZAssocChild::failNotify()
299 // TODO: send Package to signal "close"
300 if (m_session.is_closed())
302 if (m_no_requests == 0)
310 mp::Package *p = new mp::Package(m_session, m_origin);
312 ThreadPoolPackage *tp = new ThreadPoolPackage(p, this, m_msg_config);
313 p->copy_route(*m_package);
314 m_thread_pool_observer->cleanup(tp, &m_session);
315 m_thread_pool_observer->put(tp);
318 void yf::FrontendNet::ZAssocChild::timeoutNotify()
323 void yf::FrontendNet::ZAssocChild::connectNotify()
328 yf::FrontendNet::ZAssocServer::ZAssocServer(
329 yazpp_1::IPDU_Observable *PDU_Observable,
330 int timeout, int connect_max,
331 std::string route, const char *msg_config)
333 Z_Assoc(PDU_Observable), m_session_timeout(timeout),
334 m_connect_max(connect_max), m_route(route), m_msg_config(msg_config)
340 void yf::FrontendNet::ZAssocServer::set_package(const mp::Package *package)
345 void yf::FrontendNet::ZAssocServer::set_thread_pool(ThreadPoolSocketObserver *observer)
347 m_thread_pool_observer = observer;
350 yazpp_1::IPDU_Observer *yf::FrontendNet::ZAssocServer::sessionNotify(yazpp_1::IPDU_Observable
351 *the_PDU_Observable, int fd)
354 const char *peername = the_PDU_Observable->getpeername();
357 limit_connect.add_connect(peername);
358 limit_connect.cleanup(false);
359 int con_sz = limit_connect.get_total(peername);
360 if (m_connect_max && con_sz > m_connect_max)
363 ZAssocChild *my = new ZAssocChild(the_PDU_Observable,
364 m_thread_pool_observer,
365 m_package, m_route, m_msg_config);
366 my->timeout(m_session_timeout);
370 yf::FrontendNet::ZAssocServer::~ZAssocServer()
374 void yf::FrontendNet::ZAssocServer::recv_GDU(Z_GDU *apdu, int len)
378 void yf::FrontendNet::ZAssocServer::failNotify()
382 void yf::FrontendNet::ZAssocServer::timeoutNotify()
386 void yf::FrontendNet::ZAssocServer::connectNotify()
390 yf::FrontendNet::FrontendNet() : m_p(new Rep)
392 m_p->m_no_threads = 5;
393 m_p->m_listen_duration = 0;
394 m_p->m_session_timeout = 300; // 5 minutes
395 m_p->m_connect_max = 0;
399 yf::FrontendNet::~FrontendNet()
404 for (i = 0; i<m_p->m_ports.size(); i++)
411 void yf::FrontendNet::stop() const
416 for (i = 0; i<m_p->m_ports.size(); i++)
417 m_p->az[i]->server("");
421 bool yf::FrontendNet::My_Timer_Thread::timeout()
426 yf::FrontendNet::My_Timer_Thread::My_Timer_Thread(
427 yazpp_1::ISocketObservable *obs,
429 m_obs(obs), m_pipe(9123), m_timeout(false)
431 obs->addObserver(m_pipe.read_fd(), this);
432 obs->maskObserver(this, yazpp_1::SOCKET_OBSERVE_READ);
433 obs->timeoutObserver(this, duration);
436 void yf::FrontendNet::My_Timer_Thread::socketNotify(int event)
439 m_obs->deleteObserver(this);
442 void yf::FrontendNet::process(Package &package) const
447 My_Timer_Thread *tt = 0;
449 if (m_p->m_listen_duration)
450 tt = new My_Timer_Thread(&m_p->mySocketManager,
451 m_p->m_listen_duration);
453 ThreadPoolSocketObserver tp(&m_p->mySocketManager, m_p->m_no_threads);
455 for (i = 0; i<m_p->m_ports.size(); i++)
457 m_p->az[i]->set_package(&package);
458 m_p->az[i]->set_thread_pool(&tp);
460 while (m_p->mySocketManager.processEvent() > 0)
462 int no = m_p->mySocketManager.getNumberOfObservers();
465 if (tt && tt->timeout())
471 void yf::FrontendNet::configure(const xmlNode * ptr, bool test_only,
474 if (!ptr || !ptr->children)
476 throw yf::FilterException("No ports for Frontend");
478 std::vector<Port> ports;
479 for (ptr = ptr->children; ptr; ptr = ptr->next)
481 if (ptr->type != XML_ELEMENT_NODE)
483 if (!strcmp((const char *) ptr->name, "port"))
486 const struct _xmlAttr *attr;
487 for (attr = ptr->properties; attr; attr = attr->next)
489 if (!strcmp((const char *) attr->name, "route"))
490 port.route = mp::xml::get_text(attr);
492 port.port = mp::xml::get_text(ptr);
493 ports.push_back(port);
496 else if (!strcmp((const char *) ptr->name, "threads"))
498 std::string threads_str = mp::xml::get_text(ptr);
499 int threads = atoi(threads_str.c_str());
501 throw yf::FilterException("Bad value for threads: "
503 m_p->m_no_threads = threads;
505 else if (!strcmp((const char *) ptr->name, "timeout"))
507 std::string timeout_str = mp::xml::get_text(ptr);
508 int timeout = atoi(timeout_str.c_str());
510 throw yf::FilterException("Bad value for timeout: "
512 m_p->m_session_timeout = timeout;
514 else if (!strcmp((const char *) ptr->name, "connect-max"))
516 m_p->m_connect_max = mp::xml::get_int(ptr, 0);
518 else if (!strcmp((const char *) ptr->name, "message"))
520 m_p->m_msg_config = mp::xml::get_text(ptr);
524 throw yf::FilterException("Bad element "
525 + std::string((const char *)
534 void yf::FrontendNet::set_ports(std::vector<std::string> &ports)
536 std::vector<Port> nports;
539 for (i = 0; i < ports.size(); i++)
543 nport.port = ports[i];
545 nports.push_back(nport);
551 void yf::FrontendNet::set_ports(std::vector<Port> &ports)
553 m_p->m_ports = ports;
555 m_p->az = new yf::FrontendNet::ZAssocServer *[m_p->m_ports.size()];
557 // Create yf::FrontendNet::ZAssocServer for each port
559 for (i = 0; i<m_p->m_ports.size(); i++)
561 // create a PDU assoc object (one per yf::FrontendNet::ZAssocServer)
562 yazpp_1::PDU_Assoc *as = new yazpp_1::PDU_Assoc(&m_p->mySocketManager);
564 // create ZAssoc with PDU Assoc
565 m_p->az[i] = new yf::FrontendNet::ZAssocServer(as,
566 m_p->m_session_timeout,
568 m_p->m_ports[i].route,
569 m_p->m_msg_config.length() > 0 ?
570 m_p->m_msg_config.c_str() : 0);
571 if (m_p->az[i]->server(m_p->m_ports[i].port.c_str()))
573 throw yf::FilterException("Unable to bind to address "
574 + std::string(m_p->m_ports[i].port));
579 void yf::FrontendNet::set_listen_duration(int d)
581 m_p->m_listen_duration = d;
584 static yf::Base* filter_creator()
586 return new yf::FrontendNet;
590 struct metaproxy_1_filter_struct metaproxy_1_filter_frontend_net = {
600 * c-file-style: "Stroustrup"
601 * indent-tabs-mode: nil
603 * vim: shiftwidth=4 tabstop=8 expandtab