Updated footer comment
[metaproxy-moved-to-github.git] / src / filter_z3950_client.cpp
index 594a66b..70f7703 100644 (file)
@@ -1,8 +1,20 @@
-/* $Id: filter_z3950_client.cpp,v 1.21 2006-01-17 13:34:51 adam Exp $
-   Copyright (c) 2005, Index Data.
+/* This file is part of Metaproxy.
+   Copyright (C) 2005-2008 Index Data
 
-%LICENSE%
- */
+Metaproxy is free software; you can redistribute it and/or modify it under
+the terms of the GNU General Public License as published by the Free
+Software Foundation; either version 2, or (at your option) any later
+version.
+
+Metaproxy is distributed in the hope that it will be useful, but WITHOUT ANY
+WARRANTY; without even the implied warranty of MERCHANTABILITY or
+FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
+for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program; if not, write to the Free Software
+Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+*/
 
 #include "config.hpp"
 
 
 #include <boost/thread/mutex.hpp>
 #include <boost/thread/condition.hpp>
+#include <boost/thread/xtime.hpp>
 
 #include <yaz/zgdu.h>
 #include <yaz/log.h>
 #include <yaz/otherinfo.h>
 #include <yaz/diagbib1.h>
 
-#include <yaz++/socket-manager.h>
-#include <yaz++/pdu-assoc.h>
-#include <yaz++/z-assoc.h>
+#include <yazpp/socket-manager.h>
+#include <yazpp/pdu-assoc.h>
+#include <yazpp/z-assoc.h>
 
-namespace yf = yp2::filter;
+namespace mp = metaproxy_1;
+namespace yf = mp::filter;
 
-namespace yp2 {
+namespace metaproxy_1 {
     namespace filter {
         class Z3950Client::Assoc : public yazpp_1::Z_Assoc{
             friend class Rep;
@@ -56,15 +70,20 @@ namespace yp2 {
             int m_queue_len;
             int m_time_elapsed;
             int m_time_max;
+            int m_time_connect_max;
             std::string m_host;
         };
 
         class Z3950Client::Rep {
         public:
+            // number of seconds to wait before we give up request
             int m_timeout_sec;
+            int m_max_sockets;
+            std::string m_default_target;
+            std::string m_force_target;
             boost::mutex m_mutex;
             boost::condition m_cond_session_ready;
-            std::map<yp2::Session,Z3950Client::Assoc *> m_clients;
+            std::map<mp::Session,Z3950Client::Assoc *> m_clients;
             Z3950Client::Assoc *get_assoc(Package &package);
             void send_and_receive(Package &package,
                                   yf::Z3950Client::Assoc *c);
@@ -73,7 +92,7 @@ namespace yp2 {
     }
 }
 
-using namespace yp2;
+using namespace mp;
 
 yf::Z3950Client::Assoc::Assoc(yazpp_1::SocketManager *socket_manager,
                               yazpp_1::IPDU_Observable *PDU_Observable,
@@ -82,7 +101,7 @@ yf::Z3950Client::Assoc::Assoc(yazpp_1::SocketManager *socket_manager,
        m_socket_manager(socket_manager), m_PDU_Observable(PDU_Observable),
        m_package(0), m_in_use(true), m_waiting(false), 
        m_destroyed(false), m_connected(false), m_queue_len(1),
-       m_time_elapsed(0), m_time_max(timeout_sec), 
+       m_time_elapsed(0), m_time_max(timeout_sec),  m_time_connect_max(10),
        m_host(host)
 {
     // std::cout << "create assoc " << this << "\n";
@@ -104,7 +123,7 @@ void yf::Z3950Client::Assoc::failNotify()
 {
     m_waiting = false;
 
-    yp2::odr odr;
+    mp::odr odr;
 
     if (m_package)
     {
@@ -121,11 +140,12 @@ void yf::Z3950Client::Assoc::failNotify()
 void yf::Z3950Client::Assoc::timeoutNotify()
 {
     m_time_elapsed++;
-    if (m_time_elapsed >= m_time_max)
+    if ((m_connected && m_time_elapsed >= m_time_max)
+        || (!m_connected && m_time_elapsed >= m_time_connect_max))
     {
         m_waiting = false;
 
-        yp2::odr odr;
+        mp::odr odr;
         
         if (m_package)
         {
@@ -165,6 +185,7 @@ yazpp_1::IPDU_Observer *yf::Z3950Client::Assoc::sessionNotify(
 yf::Z3950Client::Z3950Client() :  m_p(new yf::Z3950Client::Rep)
 {
     m_p->m_timeout_sec = 30;
+    m_p->m_max_sockets = 0;
 }
 
 yf::Z3950Client::~Z3950Client() {
@@ -175,7 +196,7 @@ yf::Z3950Client::Assoc *yf::Z3950Client::Rep::get_assoc(Package &package)
     // only one thread messes with the clients list at a time
     boost::mutex::scoped_lock lock(m_mutex);
 
-    std::map<yp2::Session,yf::Z3950Client::Assoc *>::iterator it;
+    std::map<mp::Session,yf::Z3950Client::Assoc *>::iterator it;
     
     Z_GDU *gdu = package.request().get();
     // only deal with Z39.50
@@ -184,13 +205,21 @@ yf::Z3950Client::Assoc *yf::Z3950Client::Rep::get_assoc(Package &package)
         package.move();
         return 0;
     }
+    
+    int max_sockets = package.origin().get_max_sockets();
+    if (max_sockets == 0)
+        max_sockets = m_max_sockets;
+    
+    std::string host;
+
     it = m_clients.find(package.session());
     if (it != m_clients.end())
     {
         it->second->m_queue_len++;
-        while(true)
+        while (true)
         {
 #if 0
+            // double init .. NOT working yet
             if (gdu && gdu->which == Z_GDU_Z3950 &&
                 gdu->u.z3950->which == Z_APDU_initRequest)
             {
@@ -214,7 +243,7 @@ yf::Z3950Client::Assoc *yf::Z3950Client::Rep::get_assoc(Package &package)
     // check that it is init. If not, close
     if (apdu->which != Z_APDU_initRequest)
     {
-        yp2::odr odr;
+        mp::odr odr;
         
         package.response() = odr.create_close(apdu,
                                               Z_Close_protocolError,
@@ -223,39 +252,82 @@ yf::Z3950Client::Assoc *yf::Z3950Client::Rep::get_assoc(Package &package)
         package.session().close();
         return 0;
     }
-    std::list<std::string> vhosts;
-    yp2::util::get_vhost_otherinfo(&apdu->u.initRequest->otherInfo,
-                                   true, vhosts);
-    size_t no_vhosts = vhosts.size();
-    if (no_vhosts == 0)
+    std::string target = m_force_target;
+    if (!target.length())
     {
-        yp2::odr odr;
-        package.response() = odr.create_initResponse(
-            apdu,
-            YAZ_BIB1_INIT_NEGOTIATION_OPTION_REQUIRED,
-            "z3950_client: No virtal host given");
-        
-        package.session().close();
-        return 0;
-    }
-    if (no_vhosts > 1)
-    {
-        yp2::odr odr;
-        package.response() = odr.create_initResponse(
-            apdu,
-            YAZ_BIB1_INIT_NEGOTIATION_OPTION_REQUIRED,
-            "z3950_client: Can not cope with multiple vhosts");
-        package.session().close();
-        return 0;
+        target = m_default_target;
+        std::list<std::string> vhosts;
+        mp::util::remove_vhost_otherinfo(&apdu->u.initRequest->otherInfo,
+                                             vhosts);
+        size_t no_vhosts = vhosts.size();
+        if (no_vhosts == 1)
+        {
+            std::list<std::string>::const_iterator v_it = vhosts.begin();
+            target = *v_it;
+        }
+        else if (no_vhosts == 0)
+        {
+            if (!target.length())
+            {
+                // no default target. So we don't know where to connect
+                mp::odr odr;
+                package.response() = odr.create_initResponse(
+                    apdu,
+                    YAZ_BIB1_INIT_NEGOTIATION_OPTION_REQUIRED,
+                    "z3950_client: No virtal host given");
+                
+                package.session().close();
+                return 0;
+            }
+        }
+        else if (no_vhosts > 1)
+        {
+            mp::odr odr;
+            package.response() = odr.create_initResponse(
+                apdu,
+                YAZ_BIB1_COMBI_OF_SPECIFIED_DATABASES_UNSUPP,
+                "z3950_client: Can not cope with multiple vhosts");
+            package.session().close();
+            return 0;
+        }
     }
-    std::list<std::string>::const_iterator v_it = vhosts.begin();
+    
     std::list<std::string> dblist;
-    std::string host;
-    yp2::util::split_zurl(*v_it, host, dblist);
+    mp::util::split_zurl(target, host, dblist);
     
     if (dblist.size())
     {
-        std::cout << "z3950_client: No databases in vhost supported\n";
+        ; // z3950_client: Databases in vhost ignored
+    }
+    
+    // see if we have reached max number of clients (max-sockets)
+
+    while (max_sockets)
+    {
+        int number = 0;
+        it = m_clients.begin();
+        for (; it != m_clients.end(); it++)
+        {
+            yf::Z3950Client::Assoc *as = it->second;
+            if (!strcmp(as->get_hostname(), host.c_str()))
+                number++;
+        }
+        yaz_log(YLOG_LOG, "Found %d connections for %s", number, host.c_str());
+        if (number < max_sockets)
+            break;
+        boost::xtime xt;
+        xtime_get(&xt, boost::TIME_UTC);
+        
+        xt.sec += 15;
+        if (!m_cond_session_ready.timed_wait(lock, xt))
+        {
+            mp::odr odr;
+            
+            package.response() = odr.create_initResponse(
+                apdu, YAZ_BIB1_TEMPORARY_SYSTEM_ERROR, "max sessions");
+            package.session().close();
+            return 0;
+        }
     }
 
     yazpp_1::SocketManager *sm = new yazpp_1::SocketManager;
@@ -284,7 +356,7 @@ void yf::Z3950Client::Rep::send_and_receive(Package &package,
     if (!c->m_connected)
     {
         c->client(c->m_host.c_str());
-        c->timeout(1);
+        c->timeout(1);  // so timeoutNotify gets called once per second
 
         while (!c->m_destroyed && c->m_waiting 
                && c->m_socket_manager->processEvent() > 0)
@@ -320,7 +392,7 @@ void yf::Z3950Client::Rep::send_and_receive(Package &package,
 void yf::Z3950Client::Rep::release_assoc(Package &package)
 {
     boost::mutex::scoped_lock lock(m_mutex);
-    std::map<yp2::Session,yf::Z3950Client::Assoc *>::iterator it;
+    std::map<mp::Session,yf::Z3950Client::Assoc *>::iterator it;
     
     it = m_clients.find(package.session());
     if (it != m_clients.end())
@@ -336,17 +408,13 @@ void yf::Z3950Client::Rep::release_assoc(Package &package)
         {
             // destroy hint (send_and_receive)
             it->second->m_destroyed = true;
-            
-            // wait until no one is waiting for it.
-            while (it->second->m_queue_len)
-                m_cond_session_ready.wait(lock);
-            
-            // the Z_Assoc and PDU_Assoc must be destroyed before
-            // the socket manager.. so pull that out.. first..
-            yazpp_1::SocketManager *s = it->second->m_socket_manager;
-            delete it->second;  // destroy Z_Assoc
-            delete s;    // then manager
-            m_clients.erase(it);
+            if (it->second->m_queue_len == 0)
+            {
+                yazpp_1::SocketManager *s = it->second->m_socket_manager;
+                delete it->second;  // destroy Z_Assoc
+                delete s;    // then manager
+                m_clients.erase(it);
+            }
         }
         m_cond_session_ready.notify_all();
     }
@@ -362,7 +430,7 @@ void yf::Z3950Client::process(Package &package) const
     m_p->release_assoc(package);
 }
 
-void yf::Z3950Client::configure(const xmlNode *ptr)
+void yf::Z3950Client::configure(const xmlNode *ptr, bool test_only)
 {
     for (ptr = ptr->children; ptr; ptr = ptr->next)
     {
@@ -370,29 +438,36 @@ void yf::Z3950Client::configure(const xmlNode *ptr)
             continue;
         if (!strcmp((const char *) ptr->name, "timeout"))
         {
-            std::string timeout_str = yp2::xml::get_text(ptr);
-            int timeout_sec = atoi(timeout_str.c_str());
-            if (timeout_sec < 2)
-                throw yp2::filter::FilterException("Bad timeout value " 
-                                                   + timeout_str);
-            m_p->m_timeout_sec = timeout_sec;
+            m_p->m_timeout_sec = mp::xml::get_int(ptr->children, 30);
+        }
+        else if (!strcmp((const char *) ptr->name, "default_target"))
+        {
+            m_p->m_default_target = mp::xml::get_text(ptr);
+        }
+        else if (!strcmp((const char *) ptr->name, "force_target"))
+        {
+            m_p->m_force_target = mp::xml::get_text(ptr);
+        }
+        else if (!strcmp((const char *) ptr->name, "max-sockets"))
+        {
+            m_p->m_max_sockets = mp::xml::get_int(ptr->children, 0);
         }
         else
         {
-            throw yp2::filter::FilterException("Bad element " 
+            throw mp::filter::FilterException("Bad element " 
                                                + std::string((const char *)
                                                              ptr->name));
         }
     }
 }
 
-static yp2::filter::Base* filter_creator()
+static mp::filter::Base* filter_creator()
 {
-    return new yp2::filter::Z3950Client;
+    return new mp::filter::Z3950Client;
 }
 
 extern "C" {
-    struct yp2_filter_struct yp2_filter_z3950_client = {
+    struct metaproxy_1_filter_struct metaproxy_1_filter_z3950_client = {
         0,
         "z3950_client",
         filter_creator
@@ -402,8 +477,9 @@ extern "C" {
 /*
  * Local variables:
  * c-basic-offset: 4
+ * c-file-style: "Stroustrup"
  * indent-tabs-mode: nil
- * c-file-style: "stroustrup"
  * End:
  * vim: shiftwidth=4 tabstop=8 expandtab
  */
+