Add path to configure method of filter.
[metaproxy-moved-to-github.git] / src / filter_virt_db.cpp
index 55cb6df..808538d 100644 (file)
@@ -1,5 +1,5 @@
 /* This file is part of Metaproxy.
-   Copyright (C) 2005-2010 Index Data
+   Copyright (C) 2005-2011 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,20 +18,21 @@ Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 
 #include "config.hpp"
 
-#include "filter.hpp"
-#include "package.hpp"
+#include "filter_virt_db.hpp"
+#include <metaproxy/package.hpp>
 
 #include <boost/thread/mutex.hpp>
 #include <boost/thread/condition.hpp>
 #include <boost/shared_ptr.hpp>
 
-#include "util.hpp"
-#include "filter_virt_db.hpp"
+#include <metaproxy/util.hpp>
 
 #include <yaz/zgdu.h>
 #include <yaz/otherinfo.h>
 #include <yaz/diagbib1.h>
 #include <yaz/match_glob.h>
+#include <yaz/query-charset.h>
+#include <yaz/log.h>
 
 #include <map>
 #include <iostream>
@@ -52,17 +53,21 @@ namespace metaproxy_1 {
         };
         struct VirtualDB::Map {
             Map(std::string database, std::list<std::string> targets, std::string route);
+            Map(std::string database, std::string target, std::string route);
             Map();
             bool match(const std::string db) const;
             std::string m_dbpattern;
             std::list<std::string> m_targets;
             std::string m_route;
+        public:
+            std::string query_encoding;
         };
         struct VirtualDB::Backend {
             mp::Session m_backend_session;
             std::list<std::string> m_frontend_databases;
             std::list<std::string> m_targets;
             std::string m_route;
+            std::string query_encoding;
             bool m_named_result_sets;
             int m_number_of_sets;
         };
@@ -79,6 +84,7 @@ namespace metaproxy_1 {
             void search(Package &package, Z_APDU *apdu);
             void present(Package &package, Z_APDU *apdu);
             void scan(Package &package, Z_APDU *apdu);
+            int relay_apdu(Package &package, Z_APDU *apdu);
 
             void close(Package &package);
             typedef std::map<std::string,VirtualDB::Set>::iterator Sets_it;
@@ -107,6 +113,7 @@ namespace metaproxy_1 {
             
             FrontendPtr get_frontend(Package &package);
             void release_frontend(Package &package);
+            void refresh_torus();
         private:
             std::list<VirtualDB::Map>m_maps;
             typedef std::map<std::string,VirtualDB::Set>::iterator Sets_it;
@@ -174,12 +181,20 @@ yf::VirtualDB::BackendPtr yf::VirtualDB::Frontend::create_backend_from_databases
         // see if we have a route conflict.
         if (!first_route && b->m_route != map_it->m_route)
         {
-            // we have a conflict.. 
+            // we have a conflict.. routing must be same for all
             error_code =  YAZ_BIB1_COMBI_OF_SPECIFIED_DATABASES_UNSUPP;
             BackendPtr ptr;
             return ptr;
         }
         b->m_route = map_it->m_route;
+        if (!first_route && b->query_encoding != map_it->query_encoding)
+        {
+            // we have a conflict. query encoding must be same for all
+            error_code =  YAZ_BIB1_COMBI_OF_SPECIFIED_DATABASES_UNSUPP;
+            BackendPtr ptr;
+            return ptr;
+        }
+        b->query_encoding = map_it->query_encoding;
         first_route = false;
     }
     return b;
@@ -212,6 +227,8 @@ yf::VirtualDB::BackendPtr yf::VirtualDB::Frontend::init_backend(
     req->implementationId = org_init->implementationId;
     req->implementationName = org_init->implementationName;
     req->implementationVersion = org_init->implementationVersion;
+    *req->preferredMessageSize = *org_init->preferredMessageSize;
+    *req->maximumRecordSize = *org_init->maximumRecordSize;
 
     ODR_MASK_SET(req->options, Z_Options_search);
     ODR_MASK_SET(req->options, Z_Options_present);
@@ -228,21 +245,20 @@ yf::VirtualDB::BackendPtr yf::VirtualDB::Frontend::init_backend(
 
     Z_GDU *gdu = init_package.response().get();
     // we hope to get an init response
-    if (gdu && gdu->which == Z_GDU_Z3950 && gdu->u.z3950->which ==
-        Z_APDU_initResponse)
+    error_code = YAZ_BIB1_DATABASE_UNAVAILABLE;
+    if (gdu && gdu->which == Z_GDU_Z3950
+        && gdu->u.z3950->which == Z_APDU_initResponse)
     {
         Z_InitResponse *res = gdu->u.z3950->u.initResponse;
         if (ODR_MASK_GET(res->options, Z_Options_namedResultSets))
         {
             b->m_named_result_sets = true;
         }
-        if (*res->result)
+        if (*res->result && !init_package.session().is_closed())
         {
             m_backend_list.push_back(b);
             return b;
-
         }
-        error_code = YAZ_BIB1_DATABASE_UNAVAILABLE;
         mp::util::get_init_diagnostics(res, error_code, addinfo);
     }
     if (!init_package.session().is_closed())
@@ -268,7 +284,6 @@ void yf::VirtualDB::Frontend::search(mp::Package &package, Z_APDU *apdu_req)
     for (i = 0; i<req->num_databaseNames; i++)
         databases.push_back(req->databaseNames[i]);
 
-    BackendPtr b; // null for now
     Sets_it sets_it = m_sets.find(req->resultSetName);
     if (sets_it != m_sets.end())
     {
@@ -287,37 +302,22 @@ void yf::VirtualDB::Frontend::search(mp::Package &package, Z_APDU *apdu_req)
             return;
         } 
         sets_it->second.m_backend->m_number_of_sets--;
-
-        // pick up any existing backend with a database match
-        std::list<BackendPtr>::const_iterator map_it;
-        map_it = m_backend_list.begin();
-        for (; map_it != m_backend_list.end(); map_it++)
-        {
-            BackendPtr tmp = *map_it;
-            if (tmp->m_frontend_databases == databases)
-                break;
-        }
-        if (map_it != m_backend_list.end()) 
-            b = *map_it;
     }
-    else
+    // pick up any existing database with named result sets ..
+    // or one which has no result sets.. yet.
+    BackendPtr b; // null for now
+    std::list<BackendPtr>::const_iterator map_it;
+    map_it = m_backend_list.begin();
+    for (; map_it != m_backend_list.end(); map_it++)
     {
-        // new result set.
-
-        // pick up any existing database with named result sets ..
-        // or one which has no result sets.. yet.
-        std::list<BackendPtr>::const_iterator map_it;
-        map_it = m_backend_list.begin();
-        for (; map_it != m_backend_list.end(); map_it++)
+        BackendPtr tmp = *map_it;
+        if (tmp->m_frontend_databases == databases &&
+            (tmp->m_named_result_sets ||
+             tmp->m_number_of_sets == 0))
         {
-            BackendPtr tmp = *map_it;
-            if (tmp->m_frontend_databases == databases &&
-                (tmp->m_named_result_sets ||
-                 tmp->m_number_of_sets == 0))
-                break;
-        }
-        if (map_it != m_backend_list.end()) 
             b = *map_it;
+            break;
+        }
     }
     if (!b)  // no backend yet. Must create a new one
     {
@@ -361,6 +361,20 @@ void yf::VirtualDB::Frontend::search(mp::Package &package, Z_APDU *apdu_req)
                                                 &req->databaseNames);
     }
 
+    if (b->query_encoding.length() && 
+        (req->query->which == Z_Query_type_1 ||
+         req->query->which == Z_Query_type_101))
+    {
+        yaz_iconv_t cd = yaz_iconv_open(b->query_encoding.c_str(), "UTF-8");
+        if (cd)
+        {
+            int r = yaz_query_charset_convert_rpnquery_check(
+                req->query->u.type_1, odr, cd);
+            yaz_iconv_close(cd);
+            if (r)
+                yaz_log(YLOG_LOG, "query could not be converted");
+        }
+    }
     *req->replaceIndicator = 1;
 
     search_package.request() = yazpp_1::GDU(apdu_req);
@@ -450,6 +464,7 @@ void yf::VirtualDB::Rep::release_frontend(mp::Package &package)
     }
 }
 
+
 yf::VirtualDB::Set::Set(BackendPtr b, std::string setname)
     :  m_backend(b), m_setname(setname)
 {
@@ -471,6 +486,14 @@ yf::VirtualDB::Map::Map(std::string database,
 {
 }
 
+yf::VirtualDB::Map::Map(std::string database, 
+                        std::string target, std::string route)
+    : m_dbpattern(database), m_route(route) 
+{
+    m_targets.push_back(target);
+}
+
+
 yf::VirtualDB::Map::Map()
 {
 }
@@ -617,6 +640,27 @@ void yf::VirtualDB::Frontend::present(mp::Package &package, Z_APDU *apdu_req)
     delete id;
 }
 
+int yf::VirtualDB::Frontend::relay_apdu(mp::Package &package, Z_APDU *apdu_req)
+{
+    int no = 0;
+    std::list<BackendPtr>::const_iterator map_it;
+    map_it = m_backend_list.begin();
+    for (; map_it != m_backend_list.end(); map_it++)
+    {
+        BackendPtr b = *map_it;
+        
+        Package relay_package(b->m_backend_session, package.origin());
+        relay_package.copy_filter(package);
+
+        relay_package.request() = yazpp_1::GDU(apdu_req);
+
+        relay_package.move(b->m_route);
+        package.response() = relay_package.response();
+        no++;
+    }
+    return no;
+}
+
 void yf::VirtualDB::Frontend::scan(mp::Package &package, Z_APDU *apdu_req)
 {
     Z_ScanRequest *req = apdu_req->u.scanRequest;
@@ -669,6 +713,17 @@ void yf::VirtualDB::Frontend::scan(mp::Package &package, Z_APDU *apdu_req)
                                                 &req->num_databaseNames,
                                                 &req->databaseNames);
     }
+
+    if (b->query_encoding.length())
+    {
+        yaz_iconv_t cd = yaz_iconv_open(b->query_encoding.c_str(), "UTF-8");
+        if (cd)
+        {
+            yaz_query_charset_convert_apt(req->termListAndStartPoint, odr, cd);
+            yaz_iconv_close(cd);
+        }
+    }
+
     scan_package.request() = yazpp_1::GDU(apdu_req);
     
     scan_package.move(b->m_route);
@@ -684,8 +739,8 @@ void yf::VirtualDB::Frontend::scan(mp::Package &package, Z_APDU *apdu_req)
 
 
 void yf::VirtualDB::add_map_db2targets(std::string db, 
-                                     std::list<std::string> targets,
-                                     std::string route)
+                                       std::list<std::string> targets,
+                                       std::string route)
 {
     m_p->m_maps.push_back(
         VirtualDB::Map(mp::util::database_name_normalize(db), targets, route));
@@ -693,13 +748,12 @@ void yf::VirtualDB::add_map_db2targets(std::string db,
 
 
 void yf::VirtualDB::add_map_db2target(std::string db, 
-                                    std::string target,
-                                    std::string route)
-{
-    std::list<std::string> targets;
-    targets.push_back(target);
+                                      std::string target,
+                                      std::string route)
 
-    add_map_db2targets(db, targets, route);
+{
+    m_p->m_maps.push_back(
+        VirtualDB::Map(mp::util::database_name_normalize(db), target, route));
 }
 
 void yf::VirtualDB::process(mp::Package &package) const
@@ -752,6 +806,9 @@ void yf::VirtualDB::process(mp::Package &package) const
                 else
                     break;
             
+            *resp->preferredMessageSize = *req->preferredMessageSize;
+            *resp->maximumRecordSize = *req->maximumRecordSize;
+
             package.response() = apdu;
             f->m_is_virtual = true;
         }
@@ -786,7 +843,15 @@ void yf::VirtualDB::process(mp::Package &package) const
         }
         else if (apdu->which == Z_APDU_close)
         {
-            package.session().close();
+            if (f->relay_apdu(package, apdu) == 0)
+            {
+                mp::odr odr;
+                
+                package.response() = odr.create_close(
+                    apdu, Z_Close_finished, "virt_db");
+                
+                package.session().close();
+            }
         }
         else
         {
@@ -802,8 +867,8 @@ void yf::VirtualDB::process(mp::Package &package) const
     m_p->release_frontend(package);
 }
 
-
-void mp::filter::VirtualDB::configure(const xmlNode * ptr, bool test_only)
+void mp::filter::VirtualDB::configure(const xmlNode * ptr, bool test_only,
+                                      const char *path)
 {
     for (ptr = ptr->children; ptr; ptr = ptr->next)
     {
@@ -811,10 +876,11 @@ void mp::filter::VirtualDB::configure(const xmlNode * ptr, bool test_only)
             continue;
         if (!strcmp((const char *) ptr->name, "pass-vhosts"))
         {
-            m_p->pass_vhosts = mp::xml::get_bool(ptr->children, false);
+            m_p->pass_vhosts = mp::xml::get_bool(ptr, false);
         }
         else if (!strcmp((const char *) ptr->name, "virtual"))
         {
+            std::string query_encoding;
             std::string database;
             std::list<std::string> targets;
             xmlNode *v_node = ptr->children;
@@ -827,6 +893,8 @@ void mp::filter::VirtualDB::configure(const xmlNode * ptr, bool test_only)
                     database = mp::xml::get_text(v_node);
                 else if (mp::xml::is_element_mp(v_node, "target"))
                     targets.push_back(mp::xml::get_text(v_node));
+                else if (mp::xml::is_element_mp(v_node, "query-encoding"))
+                    targets.push_back(mp::xml::get_text(v_node));
                 else
                     throw mp::filter::FilterException
                         ("Bad element " 
@@ -835,7 +903,11 @@ void mp::filter::VirtualDB::configure(const xmlNode * ptr, bool test_only)
                             );
             }
             std::string route = mp::xml::get_route(ptr);
-            add_map_db2targets(database, targets, route);
+
+            VirtualDB::Map vmap(mp::util::database_name_normalize(database),
+                                targets, route);
+            vmap.query_encoding = query_encoding;
+            m_p->m_maps.push_back(vmap);
         }
         else
         {