Added support for configurable default/force target/vhost for module Z39.50
authorAdam Dickmeiss <adam@indexdata.dk>
Fri, 26 Jan 2007 14:49:21 +0000 (14:49 +0000)
committerAdam Dickmeiss <adam@indexdata.dk>
Fri, 26 Jan 2007 14:49:21 +0000 (14:49 +0000)
client module.

NEWS
doc/z3950_client.xml
etc/config1.xml
src/filter_z3950_client.cpp
xml/schema/metaproxy.rnc

diff --git a/NEWS b/NEWS
index ff28c75..b7ec1cc 100644 (file)
--- a/NEWS
+++ b/NEWS
@@ -1,3 +1,6 @@
+Added support for configurable default/force target/vhost for module Z39.50
+client module.
+
 --- 1.0.8 2007/01/25
 
 Implemented filter, session_shared, which optimizes usage of Z39.50
index 79d8bd0..2ad8f0a 100644 (file)
@@ -4,7 +4,7 @@
  <!ENTITY % common SYSTEM "common/common.ent">
      %common;
 ]>
-<!-- $Id: z3950_client.xml,v 1.5 2007-01-18 11:32:42 marc Exp $ -->
+<!-- $Id: z3950_client.xml,v 1.6 2007-01-26 14:49:21 adam Exp $ -->
 <refentry>
  <refmeta>
   <refentrytitle>z3950_client</refentrytitle>
  
  <refsect1><title>DESCRIPTION</title>
   <para>
-   This backend filter is a Z39.50 client.
+   This backend filter is a Z39.50 client. This modules
+   proxies all Z39.50 packages to a target. HTTP packages are ignored.
+   The address of the backend target (host) can be given as part of the
+   Initialize Request (Virtual host) or the default target may be specified
+   in the configuration.
+  </para>
+  <para>
+   <variablelist>
+    <varlistentry><term>timeout</term>
+     <listitem>
+      <para>
+       Specifies how long the client will wait for any request
+       before giving up. Default value is 30 seconds.
+      </para>
+     </listitem>
+    </varlistentry>
+    <varlistentry><term>default_target</term>
+     <listitem>
+      <para>
+       Specifies the target (host) for the Z39.50 server to be used
+       if the Init Request does not indicate otherwise.
+      </para>
+     </listitem>
+    </varlistentry>
+    <varlistentry><term>force_target</term>
+     <listitem>
+      <para>
+       Specifies the target (host) for the Z39.50 server to be used
+       always (regardless of Init Request vhost).
+      </para>
+     </listitem>
+    </varlistentry>
+   </variablelist>
   </para>
  </refsect1>
  
@@ -29,6 +61,7 @@
    <screen><![CDATA[
     <filter type="z3950_client">
      <timeout>30</timeout>
+     <default_target>z3950.indexdata.dk</default_target>
     </filter>
 ]]>
    </screen>
index 8746325..cdbf32f 100644 (file)
@@ -1,5 +1,5 @@
 <?xml version="1.0"?>
-<!-- $Id: config1.xml,v 1.12 2006-11-29 13:00:54 marc Exp $ -->
+<!-- $Id: config1.xml,v 1.13 2007-01-26 14:49:22 adam Exp $ -->
 <metaproxy xmlns="http://indexdata.com/metaproxy" version="1.0">
   <start route="start"/>
   <filters>
@@ -9,6 +9,7 @@
     </filter>
     <filter id="backend" type="z3950_client">
      <timeout>30</timeout>
+     <default_target>z3950.indexdata.dk</default_target>
     </filter>
   </filters>
   <routes>  
index 7711952..b93ecb2 100644 (file)
@@ -1,4 +1,4 @@
-/* $Id: filter_z3950_client.cpp,v 1.29 2007-01-25 14:05:54 adam Exp $
+/* $Id: filter_z3950_client.cpp,v 1.30 2007-01-26 14:49:22 adam Exp $
    Copyright (c) 2005-2007, Index Data.
 
    See the LICENSE file for details
@@ -64,6 +64,8 @@ namespace metaproxy_1 {
         public:
             // number of seconds to wait before we give up request
             int m_timeout_sec;
+            std::string m_default_target;
+            std::string m_force_target;
             boost::mutex m_mutex;
             boost::condition m_cond_session_ready;
             std::map<mp::Session,Z3950Client::Assoc *> m_clients;
@@ -226,34 +228,48 @@ yf::Z3950Client::Assoc *yf::Z3950Client::Rep::get_assoc(Package &package)
         package.session().close();
         return 0;
     }
-    std::list<std::string> vhosts;
-    mp::util::remove_vhost_otherinfo(&apdu->u.initRequest->otherInfo, vhosts);
-    size_t no_vhosts = vhosts.size();
-    if (no_vhosts == 0)
+    std::string target = m_force_target;
+    if (!target.length())
     {
-        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;
-    }
-    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;
+        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;
-    mp::util::split_zurl(*v_it, host, dblist);
+    mp::util::split_zurl(target, host, dblist);
     
     if (dblist.size())
     {
@@ -374,6 +390,14 @@ void yf::Z3950Client::configure(const xmlNode *ptr)
         {
             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
         {
             throw mp::filter::FilterException("Bad element " 
index 7759cf5..d7c14fa 100644 (file)
@@ -1,7 +1,7 @@
 # Metaproxy XML config file schemas
-#  $Id: metaproxy.rnc,v 1.17 2007-01-25 11:21:56 adam Exp $
+#  $Id: metaproxy.rnc,v 1.18 2007-01-26 14:49:23 adam Exp $
 # 
-#   Copyright (c) 2005-2006, Index Data.
+#   Copyright (c) 2005-2007, Index Data.
 # 
 #   See the LICENSE file for details
 # 
@@ -190,7 +190,9 @@ filter_z3950_client =
   attribute type { "z3950_client" },
   attribute id { xsd:NCName }?,
   attribute name { xsd:NCName }?,
-  element mp:timeout { xsd:integer }?
+  element mp:timeout { xsd:integer }?,
+  element mp:default_target { xsd:string }?,
+  element mp:force_target { xsd:string }?
 
 #filter_zeerex_explain =
 #  attribute type { "zeerex_explain" },