Windows: use Boost 1.59, msvc 14.0
[metaproxy-moved-to-github.git] / src / filter_z3950_client.cpp
index c8f4b55..ac4b541 100644 (file)
@@ -1,5 +1,5 @@
 /* This file is part of Metaproxy.
-   Copyright (C) 2005-2008 Index Data
+   Copyright (C) Index Data
 
 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
@@ -18,10 +18,9 @@ Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 
 #include "config.hpp"
 
-#include "filter.hpp"
-#include "package.hpp"
-#include "util.hpp"
 #include "filter_z3950_client.hpp"
+#include <metaproxy/package.hpp>
+#include <metaproxy/util.hpp>
 
 #include <map>
 #include <stdexcept>
@@ -36,6 +35,8 @@ Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 #include <yaz/log.h>
 #include <yaz/otherinfo.h>
 #include <yaz/diagbib1.h>
+#include <yaz/oid_db.h>
+#include <yaz/charneg.h>
 
 #include <yazpp/socket-manager.h>
 #include <yazpp/pdu-assoc.h>
@@ -50,12 +51,16 @@ namespace metaproxy_1 {
             friend class Rep;
             Assoc(yazpp_1::SocketManager *socket_manager,
                   yazpp_1::IPDU_Observable *PDU_Observable,
-                  std::string host, int timeout);
+                  std::string host, int connect_timeout,
+                  int init_timeout, int general_timeout);
             ~Assoc();
             void connectNotify();
             void failNotify();
             void timeoutNotify();
             void recv_GDU(Z_GDU *gdu, int len);
+            void fixup_nsd(ODR odr, Z_Records *records);
+            void fixup_nsd(ODR odr, Z_DefaultDiagFormat *nsd);
+            void fixup_init(ODR odr, Z_InitResponse *initrs);
             yazpp_1::IPDU_Observer* sessionNotify(
                 yazpp_1::IPDU_Observable *the_PDU_Observable,
                 int fd);
@@ -66,19 +71,27 @@ namespace metaproxy_1 {
             bool m_in_use;
             bool m_waiting;
             bool m_destroyed;
-            bool m_connected;
+            int m_connected; // 0=not connected, 1=init phase, 2=rest
+            bool m_has_closed;
             int m_queue_len;
             int m_time_elapsed;
-            int m_time_max;
-            int m_time_connect_max;
+            int m_connect_time_max;
+            int m_init_time_max;
+            int m_general_time_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_general_timeout_sec;
+            int m_connect_timeout_sec;
+            int m_init_timeout_sec;
             int m_max_sockets;
+            bool m_force_close;
+            bool m_client_ip;
+            bool m_bind_host;
+            std::string m_charset;
             std::string m_default_target;
             std::string m_force_target;
             boost::mutex m_mutex;
@@ -96,12 +109,18 @@ using namespace mp;
 
 yf::Z3950Client::Assoc::Assoc(yazpp_1::SocketManager *socket_manager,
                               yazpp_1::IPDU_Observable *PDU_Observable,
-                              std::string host, int timeout_sec)
+                              std::string host,
+                              int connect_timeout,
+                              int init_timeout, int general_timeout)
     :  Z_Assoc(PDU_Observable),
        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_connect_max(10),
+       m_package(0), m_in_use(true), m_waiting(false),
+       m_destroyed(false), m_connected(0), m_has_closed(false),
+       m_queue_len(1),
+       m_time_elapsed(0),
+       m_connect_time_max(connect_timeout),
+       m_init_time_max(init_timeout),
+       m_general_time_max(general_timeout),
        m_host(host)
 {
     // std::cout << "create assoc " << this << "\n";
@@ -116,7 +135,7 @@ void yf::Z3950Client::Assoc::connectNotify()
 {
     m_waiting = false;
 
-    m_connected = true;
+    m_connected = 1;
 }
 
 void yf::Z3950Client::Assoc::failNotify()
@@ -131,7 +150,7 @@ void yf::Z3950Client::Assoc::failNotify()
         Z_APDU *apdu = 0;
         if (gdu && gdu->which == Z_GDU_Z3950)
             apdu = gdu->u.z3950;
-        
+
         m_package->response() = odr.create_close(apdu, Z_Close_peerAbort, 0);
         m_package->session().close();
     }
@@ -140,38 +159,144 @@ void yf::Z3950Client::Assoc::failNotify()
 void yf::Z3950Client::Assoc::timeoutNotify()
 {
     m_time_elapsed++;
-    if ((m_connected && m_time_elapsed >= m_time_max)
-        || (!m_connected && m_time_elapsed >= m_time_connect_max))
+    if ((m_connected == 0 && m_time_elapsed >= m_connect_time_max)
+        || (m_connected == 1 && m_time_elapsed >= m_init_time_max)
+        || (m_connected >= 2 && m_time_elapsed >= m_general_time_max))
     {
         m_waiting = false;
 
         mp::odr odr;
-        
+
         if (m_package)
         {
             Z_GDU *gdu = m_package->request().get();
             Z_APDU *apdu = 0;
             if (gdu && gdu->which == Z_GDU_Z3950)
                 apdu = gdu->u.z3950;
-        
-            if (m_connected)
+
+            if (m_connected == 2)
                 m_package->response() =
                     odr.create_close(apdu, Z_Close_lackOfActivity, 0);
             else
-                m_package->response() = 
+                m_package->response() =
                     odr.create_close(apdu, Z_Close_peerAbort, 0);
-                
+
             m_package->session().close();
         }
     }
 }
 
+void yf::Z3950Client::Assoc::fixup_nsd(ODR odr, Z_DefaultDiagFormat *nsd)
+{
+    std::string addinfo;
+
+    // should really check for nsd->which.. But union has two members
+    // containing almost same data
+    const char *v2Addinfo = nsd->u.v2Addinfo;
+    //  Z_InternationalString *v3Addinfo;
+    if (v2Addinfo && *v2Addinfo)
+    {
+        addinfo.assign(nsd->u.v2Addinfo);
+        addinfo += " ";
+    }
+    addinfo += "(backend=" + m_host + ")";
+    nsd->u.v2Addinfo = odr_strdup(odr, addinfo.c_str());
+}
+
+void yf::Z3950Client::Assoc::fixup_nsd(ODR odr, Z_Records *records)
+{
+    if (records && records->which == Z_Records_NSD)
+    {
+        fixup_nsd(odr, records->u.nonSurrogateDiagnostic);
+    }
+    if (records && records->which == Z_Records_multipleNSD)
+    {
+        Z_DiagRecs *drecs = records->u.multipleNonSurDiagnostics;
+        int i;
+        for (i = 0; i < drecs->num_diagRecs; i++)
+        {
+            Z_DiagRec *dr = drecs->diagRecs[i];
+
+            if (dr->which == Z_DiagRec_defaultFormat)
+                fixup_nsd(odr, dr->u.defaultFormat);
+        }
+    }
+}
+
+void yf::Z3950Client::Assoc::fixup_init(ODR odr, Z_InitResponse *initrs)
+{
+    Z_External *uif = initrs->userInformationField;
+
+    if (uif && uif->which == Z_External_userInfo1)
+    {
+        Z_OtherInformation *ui = uif->u.userInfo1;
+        int i;
+        for (i = 0; i < ui->num_elements; i++)
+        {
+            Z_OtherInformationUnit *unit = ui->list[i];
+            if (unit->which == Z_OtherInfo_externallyDefinedInfo &&
+                unit->information.externallyDefinedInfo &&
+                unit->information.externallyDefinedInfo->which ==
+                Z_External_diag1)
+            {
+                Z_DiagnosticFormat *diag =
+                    unit->information.externallyDefinedInfo->u.diag1;
+                int j;
+                for (j = 0; j < diag->num; j++)
+                {
+                    Z_DiagnosticFormat_s *ds = diag->elements[j];
+                    if (ds->which == Z_DiagnosticFormat_s_defaultDiagRec)
+                    {
+                        Z_DefaultDiagFormat *r = ds->u.defaultDiagRec;
+                        char *oaddinfo = r->u.v2Addinfo;
+                        char *naddinfo = (char *) odr_malloc(
+                            odr,
+                            (oaddinfo ? strlen(oaddinfo) : 0) + 20 +
+                            m_host.length());
+                        *naddinfo = '\0';
+                        if (oaddinfo && *oaddinfo)
+                        {
+                            strcat(naddinfo, oaddinfo);
+                            strcat(naddinfo, " ");
+                        }
+                        strcat(naddinfo, "(backend=");
+                        strcat(naddinfo, m_host.c_str());
+                        strcat(naddinfo, ")");
+
+                        r->u.v2Addinfo = naddinfo;
+                    }
+                }
+            }
+        }
+    }
+}
+
 void yf::Z3950Client::Assoc::recv_GDU(Z_GDU *gdu, int len)
 {
     m_waiting = false;
 
     if (m_package)
+    {
+        mp::odr odr; // must be in scope for response() = assignment
+        if (gdu && gdu->which == Z_GDU_Z3950)
+        {
+            Z_APDU *apdu = gdu->u.z3950;
+            switch (apdu->which)
+            {
+            case Z_APDU_searchResponse:
+                fixup_nsd(odr, apdu->u.searchResponse->records);
+                break;
+            case Z_APDU_presentResponse:
+                fixup_nsd(odr, apdu->u.presentResponse->records);
+                break;
+            case Z_APDU_initResponse:
+                fixup_init(odr, apdu->u.initResponse);
+                m_connected = 2;
+                break;
+            }
+        }
         m_package->response() = gdu;
+    }
 }
 
 yazpp_1::IPDU_Observer *yf::Z3950Client::Assoc::sessionNotify(
@@ -184,33 +309,30 @@ 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_connect_timeout_sec = 10;
+    m_p->m_init_timeout_sec = 10;
+    m_p->m_general_timeout_sec = 30;
     m_p->m_max_sockets = 0;
+    m_p->m_force_close = false;
+    m_p->m_client_ip = false;
+    m_p->m_bind_host = false;
 }
 
 yf::Z3950Client::~Z3950Client() {
 }
 
-yf::Z3950Client::Assoc *yf::Z3950Client::Rep::get_assoc(Package &package) 
+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<mp::Session,yf::Z3950Client::Assoc *>::iterator it;
-    
+
     Z_GDU *gdu = package.request().get();
-    // only deal with Z39.50
-    if (!gdu || gdu->which != Z_GDU_Z3950)
-    {
-        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())
@@ -238,13 +360,18 @@ yf::Z3950Client::Assoc *yf::Z3950Client::Rep::get_assoc(Package &package)
             m_cond_session_ready.wait(lock);
         }
     }
+    if (!gdu || gdu->which != Z_GDU_Z3950)
+    {
+        package.move();
+        return 0;
+    }
     // new Z39.50 session ..
     Z_APDU *apdu = gdu->u.z3950;
     // check that it is init. If not, close
     if (apdu->which != Z_APDU_initRequest)
     {
         mp::odr odr;
-        
+
         package.response() = odr.create_close(apdu,
                                               Z_Close_protocolError,
                                               "First PDU was not an "
@@ -275,7 +402,7 @@ yf::Z3950Client::Assoc *yf::Z3950Client::Rep::get_assoc(Package &package)
                     apdu,
                     YAZ_BIB1_INIT_NEGOTIATION_OPTION_REQUIRED,
                     "z3950_client: No vhost given");
-                
+
                 package.session().close();
                 return 0;
             }
@@ -291,15 +418,7 @@ yf::Z3950Client::Assoc *yf::Z3950Client::Rep::get_assoc(Package &package)
             return 0;
         }
     }
-    
-    std::list<std::string> dblist;
-    mp::util::split_zurl(target, host, dblist);
-    
-    if (dblist.size())
-    {
-        ; // z3950_client: Databases in vhost ignored
-    }
-    
+
     // see if we have reached max number of clients (max-sockets)
 
     while (max_sockets)
@@ -310,7 +429,7 @@ yf::Z3950Client::Assoc *yf::Z3950Client::Rep::get_assoc(Package &package)
         for (; it != m_clients.end(); it++)
         {
             yf::Z3950Client::Assoc *as = it->second;
-            if (!strcmp(as->get_hostname(), host.c_str()))
+            if (!strcmp(as->m_host.c_str(), target.c_str()))
             {
                 number++;
                 if (!as->m_in_use)
@@ -318,28 +437,36 @@ yf::Z3950Client::Assoc *yf::Z3950Client::Rep::get_assoc(Package &package)
             }
         }
         yaz_log(YLOG_LOG, "Found %d/%d connections for %s", number, max_sockets,
-                host.c_str());
+                target.c_str());
         if (number < max_sockets)
             break;
         if (no_not_in_use == 0) // all in use..
         {
             mp::odr odr;
-            
+
             package.response() = odr.create_initResponse(
-                apdu, YAZ_BIB1_TEMPORARY_SYSTEM_ERROR, "max sessions");
+                apdu, YAZ_BIB1_TEMPORARY_SYSTEM_ERROR,
+                "z3950_client: max sessions");
             package.session().close();
             return 0;
         }
         boost::xtime xt;
-        xtime_get(&xt, boost::TIME_UTC);
-        
+        xtime_get(&xt,
+#if BOOST_VERSION >= 105000 
+                boost::TIME_UTC_
+#else
+                boost::TIME_UTC
+#endif 
+                );
+
         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");
+                apdu, YAZ_BIB1_TEMPORARY_SYSTEM_ERROR,
+                "z3950_client: max sessions");
             package.session().close();
             return 0;
         }
@@ -347,33 +474,99 @@ yf::Z3950Client::Assoc *yf::Z3950Client::Rep::get_assoc(Package &package)
 
     yazpp_1::SocketManager *sm = new yazpp_1::SocketManager;
     yazpp_1::PDU_Assoc *pdu_as = new yazpp_1::PDU_Assoc(sm);
-    yf::Z3950Client::Assoc *as = new yf::Z3950Client::Assoc(sm, pdu_as,
-                                                            host.c_str(),
-                                                            m_timeout_sec);
+    yf::Z3950Client::Assoc *as =
+        new yf::Z3950Client::Assoc(sm, pdu_as, target.c_str(),
+                                   m_connect_timeout_sec,
+                                   m_init_timeout_sec,
+                                   m_general_timeout_sec);
     m_clients[package.session()] = as;
     return as;
 }
 
+static void set_charset_proposal(ODR odr, Z_InitRequest *req, const char *charset)
+{
+    Z_OtherInformation **p = &req->otherInfo;
+    Z_OtherInformationUnit *oi;
+
+    if (*p)
+    {
+        int i;
+        for (i = 0; i < (*p)->num_elements; i++)
+        {
+            Z_External *ext = (*p)->list[i]->information.externallyDefinedInfo;
+            if ((*p)->list[i]->which == Z_OtherInfo_externallyDefinedInfo
+                && ext &&
+                ext->which == Z_External_charSetandLanguageNegotiation)
+                return;
+        }
+    }
+    if ((oi = yaz_oi_update(p, odr, 0, 0, 0)))
+    {
+        ODR_MASK_SET(req->options, Z_Options_negotiationModel);
+        oi->which = Z_OtherInfo_externallyDefinedInfo;
+        oi->information.externallyDefinedInfo =
+            yaz_set_proposal_charneg_list(odr, ",",
+                                          charset,
+                                          0 /* lang */,
+                                          1 /* records included */);
+    }
+}
+
 void yf::Z3950Client::Rep::send_and_receive(Package &package,
                                             yf::Z3950Client::Assoc *c)
 {
-    Z_GDU *gdu = package.request().get();
-
     if (c->m_destroyed)
         return;
 
+    c->m_package = &package;
+
+    if (package.session().is_closed() && c->m_connected && !c->m_has_closed
+        && m_force_close)
+    {
+        mp::odr odr;
+
+        package.request() = odr.create_close(
+            0, Z_Close_finished, "z3950_client");
+        c->m_package = 0; // don't inspect response
+    }
+    Z_GDU *gdu = package.request().get();
+
     if (!gdu || gdu->which != Z_GDU_Z3950)
         return;
 
+    if (gdu->u.z3950->which == Z_APDU_close)
+        c->m_has_closed = true;
+
+    Z_APDU *apdu = gdu->u.z3950;
+
+    // prepare connect
     c->m_time_elapsed = 0;
-    c->m_package = &package;
     c->m_waiting = true;
     if (!c->m_connected)
     {
-        c->client(c->m_host.c_str());
+        std::string host(c->m_host);
+
+        if (m_bind_host)
+        {
+            std::string bind_host = package.origin().get_bind_address();
+            if (bind_host.length())
+            {
+                host.append(" ");
+                host.append(bind_host);
+            }
+        }
+        if (c->client(host.c_str()))
+        {
+            mp::odr odr;
+            package.response() =
+                odr.create_close(gdu->u.z3950, Z_Close_peerAbort, 0);
+            package.session().close();
+            return;
+        }
         c->timeout(1);  // so timeoutNotify gets called once per second
 
-        while (!c->m_destroyed && c->m_waiting 
+
+        while (!c->m_destroyed && c->m_waiting
                && c->m_socket_manager->processEvent() > 0)
             ;
     }
@@ -381,16 +574,39 @@ void yf::Z3950Client::Rep::send_and_receive(Package &package,
     {
         return;
     }
+    mp::odr odr;
+    if (m_client_ip)
+    {
+        std::string peer_name2 = package.origin().get_address();
+        if (apdu->which == Z_APDU_initRequest && peer_name2.length())
+        {
+            Z_OtherInformation **oi = &apdu->u.initRequest->otherInfo;
+            char *peer_name1 =
+                yaz_oi_get_string_oid(oi, yaz_oid_userinfo_client_ip, 1, 1);
+            std::string pcomb;
+            if (peer_name1)
+            {
+                pcomb.append(peer_name1);
+                pcomb.append(", ");
+            }
+            pcomb.append(peer_name2);
+            yaz_oi_set_string_oid(&apdu->u.initRequest->otherInfo,
+                                  odr, yaz_oid_userinfo_client_ip,
+                                  1, pcomb.c_str());
+        }
+    }
+    if (apdu->which == Z_APDU_initRequest && m_charset.length() > 0)
+        set_charset_proposal(odr, apdu->u.initRequest, m_charset.c_str());
 
     // prepare response
     c->m_time_elapsed = 0;
     c->m_waiting = true;
-    
+
     // relay the package  ..
     int len;
     c->send_GDU(gdu, &len);
 
-    switch(gdu->u.z3950->which)
+    switch (gdu->u.z3950->which)
     {
     case Z_APDU_triggerResourceControlRequest:
         // request only..
@@ -408,16 +624,12 @@ void yf::Z3950Client::Rep::release_assoc(Package &package)
 {
     boost::mutex::scoped_lock lock(m_mutex);
     std::map<mp::Session,yf::Z3950Client::Assoc *>::iterator it;
-    
+
     it = m_clients.find(package.session());
     if (it != m_clients.end())
     {
-        Z_GDU *gdu = package.request().get();
-        if (gdu && gdu->which == Z_GDU_Z3950)
-        {   // only Z39.50 packages lock in get_assoc.. release it
-            it->second->m_in_use = false;
-            it->second->m_queue_len--;
-        }
+        it->second->m_in_use = false;
+        it->second->m_queue_len--;
 
         if (package.session().is_closed())
         {
@@ -441,11 +653,12 @@ void yf::Z3950Client::process(Package &package) const
     if (c)
     {
         m_p->send_and_receive(package, c);
+        m_p->release_assoc(package);
     }
-    m_p->release_assoc(package);
 }
 
-void yf::Z3950Client::configure(const xmlNode *ptr, bool test_only)
+void yf::Z3950Client::configure(const xmlNode *ptr, bool test_only,
+                                const char *path)
 {
     for (ptr = ptr->children; ptr; ptr = ptr->next)
     {
@@ -453,7 +666,15 @@ void yf::Z3950Client::configure(const xmlNode *ptr, bool test_only)
             continue;
         if (!strcmp((const char *) ptr->name, "timeout"))
         {
-            m_p->m_timeout_sec = mp::xml::get_int(ptr->children, 30);
+            m_p->m_general_timeout_sec = mp::xml::get_int(ptr, 30);
+        }
+        else if (!strcmp((const char *) ptr->name, "connect-timeout"))
+        {
+            m_p->m_connect_timeout_sec = mp::xml::get_int(ptr, 10);
+        }
+        else if (!strcmp((const char *) ptr->name, "init-timeout"))
+        {
+            m_p->m_init_timeout_sec = mp::xml::get_int(ptr, 10);
         }
         else if (!strcmp((const char *) ptr->name, "default_target"))
         {
@@ -465,11 +686,27 @@ void yf::Z3950Client::configure(const xmlNode *ptr, bool test_only)
         }
         else if (!strcmp((const char *) ptr->name, "max-sockets"))
         {
-            m_p->m_max_sockets = mp::xml::get_int(ptr->children, 0);
+            m_p->m_max_sockets = mp::xml::get_int(ptr, 0);
+        }
+        else if (!strcmp((const char *) ptr->name, "force_close"))
+        {
+            m_p->m_force_close = mp::xml::get_bool(ptr, 0);
+        }
+        else if (!strcmp((const char *) ptr->name, "client_ip"))
+        {
+            m_p->m_client_ip = mp::xml::get_bool(ptr, 0);
+        }
+        else if (!strcmp((const char *) ptr->name, "charset"))
+        {
+            m_p->m_charset = mp::xml::get_text(ptr);
+        }
+        else if (!strcmp((const char *) ptr->name, "bind_host"))
+        {
+            m_p->m_bind_host = mp::xml::get_bool(ptr, 0);
         }
         else
         {
-            throw mp::filter::FilterException("Bad element " 
+            throw mp::filter::FilterException("Bad element "
                                                + std::string((const char *)
                                                              ptr->name));
         }