src/filter_frontend_net.cpp

   1 /* $Id: filter_frontend_net.cpp,v 1.19 2006-06-10 14:29:12 adam Exp $
   2    Copyright (c) 2005-2006, Index Data.
   3
   4    See the LICENSE file for details
   5  */
   6
   7 #include "config.hpp"
   8
   9 #include "util.hpp"
  10 #include "pipe.hpp"
  11 #include "filter.hpp"
  12 #include "package.hpp"
  13 #include "thread_pool_observer.hpp"
  14 #include "filter_frontend_net.hpp"
  15 #include <yazpp/z-assoc.h>
  16 #include <yazpp/pdu-assoc.h>
  17 #include <yazpp/socket-manager.h>
  18 #include <yaz/log.h>
  19
  20 #include <iostream>
  21
  22 namespace mp = metaproxy_1;
  23
  24 namespace metaproxy_1 {
  25     namespace filter {
  26         class FrontendNet::Rep {
  27             friend class FrontendNet;
  28             int m_no_threads;
  29             std::vector<std::string> m_ports;
  30             int m_listen_duration;
  31         };
  32     }
  33     class My_Timer_Thread : public yazpp_1::ISocketObserver {
  34     private:
  35         yazpp_1::ISocketObservable *m_obs;
  36         Pipe m_pipe;
  37         bool m_timeout;
  38     public:
  39         My_Timer_Thread(yazpp_1::ISocketObservable *obs, int duration);
  40         void socketNotify(int event);
  41         bool timeout();
  42     };
  43     class ZAssocChild : public yazpp_1::Z_Assoc {
  44     public:
  45         ~ZAssocChild();
  46         ZAssocChild(yazpp_1::IPDU_Observable *the_PDU_Observable,
  47                           mp::ThreadPoolSocketObserver *m_thread_pool_observer,
  48                           const mp::Package *package);
  49         int m_no_requests;
  50     private:
  51         yazpp_1::IPDU_Observer* sessionNotify(
  52             yazpp_1::IPDU_Observable *the_PDU_Observable,
  53             int fd);
  54         void recv_GDU(Z_GDU *apdu, int len);
  55
  56         void failNotify();
  57         void timeoutNotify();
  58         void connectNotify();
  59     private:
  60         mp::ThreadPoolSocketObserver *m_thread_pool_observer;
  61         mp::Session m_session;
  62         mp::Origin m_origin;
  63         bool m_delete_flag;
  64         const mp::Package *m_package;
  65     };
  66     class ThreadPoolPackage : public mp::IThreadPoolMsg {
  67     public:
  68         ThreadPoolPackage(mp::Package *package, mp::ZAssocChild *ses) :
  69             m_session(ses), m_package(package) { };
  70         ~ThreadPoolPackage();
  71         IThreadPoolMsg *handle();
  72         void result();
  73
  74     private:
  75         mp::ZAssocChild *m_session;
  76         mp::Package *m_package;
  77
  78     };
  79     class ZAssocServer : public yazpp_1::Z_Assoc {
  80     public:
  81         ~ZAssocServer();
  82         ZAssocServer(yazpp_1::IPDU_Observable *PDU_Observable,
  83                      mp::ThreadPoolSocketObserver *m_thread_pool_observer,
  84                      const mp::Package *package);
  85     private:
  86         yazpp_1::IPDU_Observer* sessionNotify(
  87             yazpp_1::IPDU_Observable *the_PDU_Observable,
  88             int fd);
  89         void recv_GDU(Z_GDU *apdu, int len);
  90
  91         void failNotify();
  92         void timeoutNotify();
  93     void connectNotify();
  94     private:
  95         mp::ThreadPoolSocketObserver *m_thread_pool_observer;
  96         const mp::Package *m_package;
  97     };
  98 }
  99
 100 mp::ThreadPoolPackage::~ThreadPoolPackage()
 101 {
 102     delete m_package;
 103 }
 104
 105 void mp::ThreadPoolPackage::result()
 106 {
 107     m_session->m_no_requests--;
 108
 109     yazpp_1::GDU *gdu = &m_package->response();
 110
 111     if (gdu->get())
 112     {
 113         int len;
 114         m_session->send_GDU(gdu->get(), &len);
 115     }
 116     else if (!m_package->session().is_closed())
 117     {
 118         // no response package and yet the session is still open..
 119         // means that request is unhandled..
 120         yazpp_1::GDU *gdu_req = &m_package->request();
 121         Z_GDU *z_gdu = gdu_req->get();
 122         if (z_gdu && z_gdu->which == Z_GDU_Z3950)
 123         {
 124             // For Z39.50, response with a Close and shutdown
 125             mp::odr odr;
 126             int len;
 127             Z_APDU *apdu_response = odr.create_close(
 128                 z_gdu->u.z3950, Z_Close_systemProblem,
 129                 "unhandled Z39.50 request");
 130
 131             m_session->send_Z_PDU(apdu_response, &len);
 132             m_package->session().close();
 133         }
 134     }
 135
 136     if (m_session->m_no_requests == 0 && m_package->session().is_closed())
 137         delete m_session;
 138     delete this;
 139 }
 140
 141 mp::IThreadPoolMsg *mp::ThreadPoolPackage::handle()
 142 {
 143     m_package->move();
 144     return this;
 145 }
 146
 147
 148 mp::ZAssocChild::ZAssocChild(yazpp_1::IPDU_Observable *PDU_Observable,
 149                                      mp::ThreadPoolSocketObserver *my_thread_pool,
 150                                      const mp::Package *package)
 151     :  Z_Assoc(PDU_Observable)
 152 {
 153     m_thread_pool_observer = my_thread_pool;
 154     m_no_requests = 0;
 155     m_delete_flag = false;
 156     m_package = package;
 157 }
 158
 159
 160 yazpp_1::IPDU_Observer *mp::ZAssocChild::sessionNotify(yazpp_1::IPDU_Observable
 161                                                   *the_PDU_Observable, int fd)
 162 {
 163     return 0;
 164 }
 165
 166 mp::ZAssocChild::~ZAssocChild()
 167 {
 168 }
 169
 170 void mp::ZAssocChild::recv_GDU(Z_GDU *z_pdu, int len)
 171 {
 172     m_no_requests++;
 173
 174     mp::Package *p = new mp::Package(m_session, m_origin);
 175
 176     mp::ThreadPoolPackage *tp = new mp::ThreadPoolPackage(p, this);
 177     p->copy_filter(*m_package);
 178     p->request() = yazpp_1::GDU(z_pdu);
 179     m_thread_pool_observer->put(tp);
 180 }
 181
 182 void mp::ZAssocChild::failNotify()
 183 {
 184     // TODO: send Package to signal "close"
 185     if (m_session.is_closed())
 186         return;
 187     m_no_requests++;
 188
 189     m_session.close();
 190
 191     mp::Package *p = new mp::Package(m_session, m_origin);
 192
 193     mp::ThreadPoolPackage *tp = new mp::ThreadPoolPackage(p, this);
 194     p->copy_filter(*m_package);
 195     m_thread_pool_observer->put(tp);
 196 }
 197
 198 void mp::ZAssocChild::timeoutNotify()
 199 {
 200     failNotify();
 201 }
 202
 203 void mp::ZAssocChild::connectNotify()
 204 {
 205
 206 }
 207
 208 mp::ZAssocServer::ZAssocServer(yazpp_1::IPDU_Observable *PDU_Observable,
 209                            mp::ThreadPoolSocketObserver *thread_pool_observer,
 210                            const mp::Package *package)
 211     :  Z_Assoc(PDU_Observable)
 212 {
 213     m_thread_pool_observer = thread_pool_observer;
 214     m_package = package;
 215
 216 }
 217
 218 yazpp_1::IPDU_Observer *mp::ZAssocServer::sessionNotify(yazpp_1::IPDU_Observable
 219                                                  *the_PDU_Observable, int fd)
 220 {
 221     mp::ZAssocChild *my =
 222         new mp::ZAssocChild(the_PDU_Observable, m_thread_pool_observer,
 223                              m_package);
 224     return my;
 225 }
 226
 227 mp::ZAssocServer::~ZAssocServer()
 228 {
 229 }
 230
 231 void mp::ZAssocServer::recv_GDU(Z_GDU *apdu, int len)
 232 {
 233 }
 234
 235 void mp::ZAssocServer::failNotify()
 236 {
 237 }
 238
 239 void mp::ZAssocServer::timeoutNotify()
 240 {
 241 }
 242
 243 void mp::ZAssocServer::connectNotify()
 244 {
 245 }
 246
 247 mp::filter::FrontendNet::FrontendNet() : m_p(new Rep)
 248 {
 249     m_p->m_no_threads = 5;
 250     m_p->m_listen_duration = 0;
 251 }
 252
 253 mp::filter::FrontendNet::~FrontendNet()
 254 {
 255 }
 256
 257 bool mp::My_Timer_Thread::timeout()
 258 {
 259     return m_timeout;
 260 }
 261
 262 mp::My_Timer_Thread::My_Timer_Thread(yazpp_1::ISocketObservable *obs,
 263                                  int duration) :
 264     m_obs(obs), m_pipe(9123), m_timeout(false)
 265 {
 266     obs->addObserver(m_pipe.read_fd(), this);
 267     obs->maskObserver(this, yazpp_1::SOCKET_OBSERVE_READ);
 268     obs->timeoutObserver(this, duration);
 269 }
 270
 271 void mp::My_Timer_Thread::socketNotify(int event)
 272 {
 273     m_timeout = true;
 274     m_obs->deleteObserver(this);
 275 }
 276
 277 void mp::filter::FrontendNet::process(Package &package) const
 278 {
 279     if (m_p->m_ports.size() == 0)
 280         return;
 281
 282     yazpp_1::SocketManager mySocketManager;
 283
 284     My_Timer_Thread *tt = 0;
 285     if (m_p->m_listen_duration)
 286         tt = new My_Timer_Thread(&mySocketManager, m_p->m_listen_duration);
 287
 288     ThreadPoolSocketObserver threadPool(&mySocketManager, m_p->m_no_threads);
 289
 290     mp::ZAssocServer **az = new mp::ZAssocServer *[m_p->m_ports.size()];
 291
 292     // Create mp::ZAssocServer for each port
 293     size_t i;
 294     for (i = 0; i<m_p->m_ports.size(); i++)
 295     {
 296         // create a PDU assoc object (one per mp::ZAssocServer)
 297         yazpp_1::PDU_Assoc *as = new yazpp_1::PDU_Assoc(&mySocketManager);
 298
 299         // create ZAssoc with PDU Assoc
 300         az[i] = new mp::ZAssocServer(as, &threadPool, &package);
 301         az[i]->server(m_p->m_ports[i].c_str());
 302     }
 303     while (mySocketManager.processEvent() > 0)
 304     {
 305         if (tt && tt->timeout())
 306             break;
 307     }
 308     for (i = 0; i<m_p->m_ports.size(); i++)
 309         delete az[i];
 310
 311     delete [] az;
 312     delete tt;
 313 }
 314
 315 void mp::filter::FrontendNet::configure(const xmlNode * ptr)
 316 {
 317     if (!ptr || !ptr->children)
 318     {
 319         throw mp::filter::FilterException("No ports for Frontend");
 320     }
 321     std::vector<std::string> ports;
 322     for (ptr = ptr->children; ptr; ptr = ptr->next)
 323     {
 324         if (ptr->type != XML_ELEMENT_NODE)
 325             continue;
 326         if (!strcmp((const char *) ptr->name, "port"))
 327         {
 328             std::string port = mp::xml::get_text(ptr);
 329             ports.push_back(port);
 330
 331         }
 332         else if (!strcmp((const char *) ptr->name, "threads"))
 333         {
 334             std::string threads_str = mp::xml::get_text(ptr);
 335             int threads = atoi(threads_str.c_str());
 336             if (threads < 1)
 337                 throw mp::filter::FilterException("Bad value for threads: "
 338                                                    + threads_str);
 339             m_p->m_no_threads = threads;
 340         }
 341         else
 342         {
 343             throw mp::filter::FilterException("Bad element "
 344                                                + std::string((const char *)
 345                                                              ptr->name));
 346         }
 347     }
 348     m_p->m_ports = ports;
 349 }
 350
 351 std::vector<std::string> &mp::filter::FrontendNet::ports()
 352 {
 353     return m_p->m_ports;
 354 }
 355
 356 int &mp::filter::FrontendNet::listen_duration()
 357 {
 358     return m_p->m_listen_duration;
 359 }
 360
 361 static mp::filter::Base* filter_creator()
 362 {
 363     return new mp::filter::FrontendNet;
 364 }
 365
 366 extern "C" {
 367     struct metaproxy_1_filter_struct metaproxy_1_filter_frontend_net = {
 368         0,
 369         "frontend_net",
 370         filter_creator
 371     };
 372 }
 373
 374 /*
 375  * Local variables:
 376  * c-basic-offset: 4
 377  * indent-tabs-mode: nil
 378  * c-file-style: "stroustrup"
 379  * End:
 380  * vim: shiftwidth=4 tabstop=8 expandtab
 381  */