Year 2007.
[metaproxy-moved-to-github.git] / src / filter_multi.cpp
index a339959..081ce4a 100644 (file)
@@ -1,7 +1,7 @@
-/* $Id: filter_multi.cpp,v 1.9 2006-01-18 14:10:47 adam Exp $
-   Copyright (c) 2005, Index Data.
+/* $Id: filter_multi.cpp,v 1.25 2007-01-25 14:05:54 adam Exp $
+   Copyright (c) 2005-2007, Index Data.
 
-%LICENSE%
+   See the LICENSE file for details
  */
 
 #include "config.hpp"
 #include <map>
 #include <iostream>
 
-namespace yf = yp2::filter;
+namespace mp = metaproxy_1;
+namespace yf = mp::filter;
 
-namespace yp2 {
+namespace metaproxy_1 {
     namespace filter {
 
         struct Multi::BackendSet {
@@ -92,22 +93,25 @@ namespace yp2 {
         };
         class Multi::Rep {
             friend class Multi;
-            friend class Frontend;
+            friend struct Frontend;
             
+            Rep();
             FrontendPtr get_frontend(Package &package);
             void release_frontend(Package &package);
         private:
-            boost::mutex m_sessions_mutex;
-            std::map<std::string, Multi::Map>m_maps;
             std::map<std::string,std::string> m_target_route;
             boost::mutex m_mutex;
             boost::condition m_cond_session_ready;
-            std::map<yp2::Session, FrontendPtr> m_clients;
+            std::map<mp::Session, FrontendPtr> m_clients;
+            bool m_hide_unavailable;
         };
     }
 }
 
-using namespace yp2;
+yf::Multi::Rep::Rep()
+{
+    m_hide_unavailable = false;
+}
 
 bool yf::Multi::BackendSet::operator < (const BackendSet &k) const
 {
@@ -124,11 +128,11 @@ yf::Multi::Frontend::~Frontend()
 {
 }
 
-yf::Multi::FrontendPtr yf::Multi::Rep::get_frontend(Package &package)
+yf::Multi::FrontendPtr yf::Multi::Rep::get_frontend(mp::Package &package)
 {
     boost::mutex::scoped_lock lock(m_mutex);
 
-    std::map<yp2::Session,yf::Multi::FrontendPtr>::iterator it;
+    std::map<mp::Session,yf::Multi::FrontendPtr>::iterator it;
     
     while(true)
     {
@@ -149,10 +153,10 @@ yf::Multi::FrontendPtr yf::Multi::Rep::get_frontend(Package &package)
     return f;
 }
 
-void yf::Multi::Rep::release_frontend(Package &package)
+void yf::Multi::Rep::release_frontend(mp::Package &package)
 {
     boost::mutex::scoped_lock lock(m_mutex);
-    std::map<yp2::Session,yf::Multi::FrontendPtr>::iterator it;
+    std::map<mp::Session,yf::Multi::FrontendPtr>::iterator it;
     
     it = m_clients.find(package.session());
     if (it != m_clients.end())
@@ -202,20 +206,13 @@ yf::Multi::~Multi() {
 }
 
 
-void yf::Multi::add_map_host2hosts(std::string host,
-                                   std::list<std::string> hosts,
-                                   std::string route)
-{
-    m_p->m_maps[host] = Multi::Map(hosts, route);
-}
-
 void yf::Multi::Backend::operator() (void) 
 {
     m_package->move(m_route);
 }
 
 
-void yf::Multi::Frontend::close(Package &package)
+void yf::Multi::Frontend::close(mp::Package &package)
 {
     std::list<BackendPtr>::const_iterator bit;
     for (bit = m_backend_list.begin(); bit != m_backend_list.end(); bit++)
@@ -240,14 +237,9 @@ void yf::Multi::Frontend::multi_move(std::list<BackendPtr> &blist)
     g.join_all();
 }
 
-
 void yf::Multi::FrontendSet::round_robin(int start, int number,
                                          std::list<PresentJob> &jobs)
 {
-    int fetched = 0;
-    int p = 1;
-    bool eof = true;
-
     std::list<int> pos;
     std::list<int> inside_pos;
     std::list<BackendSet>::const_iterator bsit;
@@ -257,49 +249,94 @@ void yf::Multi::FrontendSet::round_robin(int start, int number,
         inside_pos.push_back(0);
     }
 
-    std::list<int>::iterator psit = pos.begin();
-    std::list<int>::iterator esit = inside_pos.begin();
-    bsit = m_backend_sets.begin();
-    while (fetched < number)
+    int p = 1;
+#if 1
+    // optimization step!
+    int omin = 0;
+    while(true)
     {
-        if (bsit == m_backend_sets.end())
+        int min = 0;
+        int no_left = 0;
+        // find min count for each set which is > omin
+        for (bsit = m_backend_sets.begin(); bsit != m_backend_sets.end(); bsit++)
         {
-            psit = pos.begin();
-            esit = inside_pos.begin();
-            bsit = m_backend_sets.begin();
-            if (eof)
-                break;
-            eof = true;
+            if (bsit->m_count > omin)
+            {
+                if (no_left == 0 || bsit->m_count < min)
+                    min = bsit->m_count;
+                no_left++;
+            }
+        }
+        if (no_left == 0) // if nothing greater than omin, bail out.
+            break;
+        int skip = no_left * min;
+        if (p + skip > start)  // step gets us "into" present range?
+        {
+            // Yes. skip until start.. Rounding off is deliberate!
+            min = (start-p) / no_left;
+            p += no_left * min;
+            
+            // update positions in each set..
+            std::list<int>::iterator psit = pos.begin();
+            for (psit = pos.begin(); psit != pos.end(); psit++)
+                *psit += min;
+            break;
         }
-        if (*psit <= bsit->m_count)
+        // skip on each set.. before "present range"..
+        p = p + skip;
+        
+        std::cout << "\nSKIP min=" << min << " no_left=" << no_left << "\n\n";
+        
+        std::list<int>::iterator psit = pos.begin();
+        for (psit = pos.begin(); psit != pos.end(); psit++)
+            *psit += min;
+        
+        omin = min; // update so we consider next class (with higher count)
+    }
+#endif
+    int fetched = 0;
+    bool more = true;
+    while (more)
+    {
+        more = false;
+        std::list<int>::iterator psit = pos.begin();
+        std::list<int>::iterator esit = inside_pos.begin();
+        bsit = m_backend_sets.begin();
+
+        for (; bsit != m_backend_sets.end(); psit++,esit++,bsit++)
         {
-            if (p >= start)
+            if (fetched >= number)
             {
-                PresentJob job;
-                job.m_backend = bsit->m_backend;
-                job.m_pos = *psit;
-                job.m_inside_pos = *esit;
-                jobs.push_back(job);
-                (*esit)++;
-                fetched++;
+                more = false;
+                break;
+            }
+            if (*psit <= bsit->m_count)
+            {
+                if (p >= start)
+                {
+                    PresentJob job;
+                    job.m_backend = bsit->m_backend;
+                    job.m_pos = *psit;
+                    job.m_inside_pos = *esit;
+                    jobs.push_back(job);
+                    (*esit)++;
+                    fetched++;
+                }
+                (*psit)++;
+                p++;
+                more = true;
             }
-            (*psit)++;
-            p++;
-            eof = false;
         }
-        psit++;
-        esit++;
-        bsit++;
     }
 }
 
-void yf::Multi::Frontend::init(Package &package, Z_GDU *gdu)
+void yf::Multi::Frontend::init(mp::Package &package, Z_GDU *gdu)
 {
     Z_InitRequest *req = gdu->u.z3950->u.initRequest;
 
     std::list<std::string> targets;
 
-    yp2::util::get_vhost_otherinfo(&req->otherInfo, false, targets);
+    mp::util::get_vhost_otherinfo(req->otherInfo, targets);
 
     if (targets.size() < 1)
     {
@@ -323,16 +360,16 @@ void yf::Multi::Frontend::init(Package &package, Z_GDU *gdu)
     m_is_multi = true;
 
     // create init request 
-    std::list<BackendPtr>::const_iterator bit;
+    std::list<BackendPtr>::iterator bit;
     for (bit = m_backend_list.begin(); bit != m_backend_list.end(); bit++)
     {
-        yp2::odr odr;
+        mp::odr odr;
         BackendPtr b = *bit;
         Z_APDU *init_apdu = zget_APDU(odr, Z_APDU_initRequest);
         
         std::list<std::string>vhost_one;
         vhost_one.push_back(b->m_vhost);
-        yp2::util::set_vhost_otherinfo(&init_apdu->u.initRequest->otherInfo,
+        mp::util::set_vhost_otherinfo(&init_apdu->u.initRequest->otherInfo,
                                        odr, vhost_one);
 
         Z_InitRequest *req = init_apdu->u.initRequest;
@@ -353,7 +390,7 @@ void yf::Multi::Frontend::init(Package &package, Z_GDU *gdu)
     multi_move(m_backend_list);
 
     // create the frontend init response based on each backend init response
-    yp2::odr odr;
+    mp::odr odr;
 
     Z_APDU *f_apdu = odr.create_initResponse(gdu->u.z3950, 0, 0);
     Z_InitResponse *f_resp = f_apdu->u.initResponse;
@@ -366,12 +403,21 @@ void yf::Multi::Frontend::init(Package &package, Z_GDU *gdu)
     ODR_MASK_SET(f_resp->protocolVersion, Z_ProtocolVersion_2);
     ODR_MASK_SET(f_resp->protocolVersion, Z_ProtocolVersion_3);
 
-    for (bit = m_backend_list.begin(); bit != m_backend_list.end(); bit++)
+    int no_failed = 0;
+    int no_succeeded = 0;
+    for (bit = m_backend_list.begin(); bit != m_backend_list.end(); )
     {
         PackagePtr p = (*bit)->m_package;
         
-        if (p->session().is_closed()) // if any backend closes, close frontend
-            package.session().close();
+        if (p->session().is_closed())
+        {
+            // failed. Remove from list and increment number of failed
+            no_failed++;
+            bit = m_backend_list.erase(bit);
+            continue;
+        }
+        no_succeeded++;
+
         Z_GDU *gdu = p->response().get();
         if (gdu && gdu->which == Z_GDU_Z3950 && gdu->u.z3950->which ==
             Z_APDU_initResponse)
@@ -401,11 +447,22 @@ void yf::Multi::Frontend::init(Package &package, Z_GDU *gdu)
             package.response() = p->response();
             return;
         }
+        bit++;
+    }
+    if (m_p->m_hide_unavailable)
+    {
+        if (no_succeeded == 0)
+            package.session().close();
+    }
+    else
+    {
+        if (no_failed)
+            package.session().close();
     }
     package.response() = f_apdu;
 }
 
-void yf::Multi::Frontend::search(Package &package, Z_APDU *apdu_req)
+void yf::Multi::Frontend::search(mp::Package &package, Z_APDU *apdu_req)
 {
     // create search request 
     Z_SearchRequest *req = apdu_req->u.searchRequest;
@@ -427,9 +484,9 @@ void yf::Multi::Frontend::search(Package &package, Z_APDU *apdu_req)
     for (bit = m_backend_list.begin(); bit != m_backend_list.end(); bit++)
     {
         PackagePtr p = (*bit)->m_package;
-        yp2::odr odr;
+        mp::odr odr;
     
-        if (!yp2::util::set_databases_from_zurl(odr, (*bit)->m_vhost,
+        if (!mp::util::set_databases_from_zurl(odr, (*bit)->m_vhost,
                                                 &req->num_databaseNames,
                                                 &req->databaseNames))
         {
@@ -482,7 +539,7 @@ void yf::Multi::Frontend::search(Package &package, Z_APDU *apdu_req)
         }
     }
 
-    yp2::odr odr;
+    mp::odr odr;
     Z_APDU *f_apdu = odr.create_searchResponse(apdu_req, 0, 0);
     Z_SearchResponse *f_resp = f_apdu->u.searchResponse;
 
@@ -498,7 +555,7 @@ void yf::Multi::Frontend::search(Package &package, Z_APDU *apdu_req)
     m_sets[resultSet.m_setname] = resultSet;
 
     int number;
-    yp2::util::piggyback(smallSetUpperBound,
+    mp::util::piggyback(smallSetUpperBound,
                          largeSetLowerBound,
                          mediumSetPresentNumber,
                          result_set_size,
@@ -539,7 +596,7 @@ void yf::Multi::Frontend::search(Package &package, Z_APDU *apdu_req)
     package.response() = f_apdu; // in this scope because of p
 }
 
-void yf::Multi::Frontend::present(Package &package, Z_APDU *apdu_req)
+void yf::Multi::Frontend::present(mp::Package &package, Z_APDU *apdu_req)
 {
     // create present request 
     Z_PresentRequest *req = apdu_req->u.presentRequest;
@@ -548,7 +605,7 @@ void yf::Multi::Frontend::present(Package &package, Z_APDU *apdu_req)
     it = m_sets.find(std::string(req->resultSetId));
     if (it == m_sets.end())
     {
-        yp2::odr odr;
+        mp::odr odr;
         Z_APDU *apdu = 
             odr.create_presentResponse(
                 apdu_req,
@@ -631,7 +688,7 @@ void yf::Multi::Frontend::present(Package &package, Z_APDU *apdu_req)
         }
     }
 
-    yp2::odr odr;
+    mp::odr odr;
     Z_APDU *f_apdu = odr.create_presentResponse(apdu_req, 0, 0);
     Z_PresentResponse *f_resp = f_apdu->u.presentResponse;
 
@@ -654,7 +711,7 @@ void yf::Multi::Frontend::present(Package &package, Z_APDU *apdu_req)
             odr_malloc(odr, sizeof(Z_NamePlusRecord *) * nprl->num_records);
         int i = 0;
         std::list<Multi::FrontendSet::PresentJob>::const_iterator jit;
-        for (jit = jobs.begin(); jit != jobs.end(); jit++)
+        for (jit = jobs.begin(); jit != jobs.end(); jit++, i++)
         {
             PackagePtr p = jit->m_backend->m_package;
             
@@ -662,9 +719,12 @@ void yf::Multi::Frontend::present(Package &package, Z_APDU *apdu_req)
             Z_APDU *b_apdu = gdu->u.z3950;
             Z_PresentResponse *b_resp = b_apdu->u.presentResponse;
 
-            nprl->records[i++] =
-                b_resp->records->u.databaseOrSurDiagnostics->
-                records[jit->m_inside_pos];
+            nprl->records[i] = (Z_NamePlusRecord*)
+                odr_malloc(odr, sizeof(Z_NamePlusRecord));
+           *nprl->records[i] = *b_resp->records->
+                u.databaseOrSurDiagnostics->records[jit->m_inside_pos];
+            nprl->records[i]->databaseName =
+                    odr_strdup(odr, jit->m_backend->m_vhost.c_str());
         }
         *f_resp->nextResultSetPosition = start + i;
         *f_resp->numberOfRecordsReturned = i;
@@ -672,11 +732,11 @@ void yf::Multi::Frontend::present(Package &package, Z_APDU *apdu_req)
     package.response() = f_apdu;
 }
 
-void yf::Multi::Frontend::scan1(Package &package, Z_APDU *apdu_req)
+void yf::Multi::Frontend::scan1(mp::Package &package, Z_APDU *apdu_req)
 {
     if (m_backend_list.size() > 1)
     {
-        yp2::odr odr;
+        mp::odr odr;
         Z_APDU *f_apdu = 
             odr.create_scanResponse(
                 apdu_req, YAZ_BIB1_COMBI_OF_SPECIFIED_DATABASES_UNSUPP, 0);
@@ -692,9 +752,9 @@ void yf::Multi::Frontend::scan1(Package &package, Z_APDU *apdu_req)
     for (bit = m_backend_list.begin(); bit != m_backend_list.end(); bit++)
     {
         PackagePtr p = (*bit)->m_package;
-        yp2::odr odr;
+        mp::odr odr;
     
-        if (!yp2::util::set_databases_from_zurl(odr, (*bit)->m_vhost,
+        if (!mp::util::set_databases_from_zurl(odr, (*bit)->m_vhost,
                                                 &req->num_databaseNames,
                                                 &req->databaseNames))
         {
@@ -763,10 +823,9 @@ Z_Entry *yf::Multi::ScanTermInfo::get_entry(ODR odr)
     return e;
 }
 
-void yf::Multi::Frontend::scan2(Package &package, Z_APDU *apdu_req)
+void yf::Multi::Frontend::scan2(mp::Package &package, Z_APDU *apdu_req)
 {
     Z_ScanRequest *req = apdu_req->u.scanRequest;
-    int no_targets = 0;
 
     int default_num_db = req->num_databaseNames;
     char **default_db = req->databaseNames;
@@ -775,9 +834,9 @@ void yf::Multi::Frontend::scan2(Package &package, Z_APDU *apdu_req)
     for (bit = m_backend_list.begin(); bit != m_backend_list.end(); bit++)
     {
         PackagePtr p = (*bit)->m_package;
-        yp2::odr odr;
+        mp::odr odr;
     
-        if (!yp2::util::set_databases_from_zurl(odr, (*bit)->m_vhost,
+        if (!mp::util::set_databases_from_zurl(odr, (*bit)->m_vhost,
                                                 &req->num_databaseNames,
                                                 &req->databaseNames))
         {
@@ -786,7 +845,6 @@ void yf::Multi::Frontend::scan2(Package &package, Z_APDU *apdu_req)
         }
         p->request() = apdu_req;
         p->copy_filter(package);
-        no_targets++;
     }
     multi_move(m_backend_list);
 
@@ -807,6 +865,23 @@ void yf::Multi::Frontend::scan2(Package &package, Z_APDU *apdu_req)
             Z_APDU_scanResponse)
         {
             Z_ScanResponse *res = gdu->u.z3950->u.scanResponse;
+
+            if (res->entries && res->entries->nonsurrogateDiagnostics)
+            {
+                // failure
+                mp::odr odr;
+                Z_APDU *f_apdu = odr.create_scanResponse(apdu_req, 1, 0);
+                Z_ScanResponse *f_res = f_apdu->u.scanResponse;
+
+                f_res->entries->nonsurrogateDiagnostics = 
+                    res->entries->nonsurrogateDiagnostics;
+                f_res->entries->num_nonsurrogateDiagnostics = 
+                    res->entries->num_nonsurrogateDiagnostics;
+
+                package.response() = f_apdu;
+                return;
+            }
+
             if (res->entries && res->entries->entries)
             {
                 Z_Entry **entries = res->entries->entries;
@@ -856,7 +931,11 @@ void yf::Multi::Frontend::scan2(Package &package, Z_APDU *apdu_req)
                     }
                 }
                 // after
-                for (i = position-1; i<num_entries; i++)
+                if (position <= 0)
+                    i = 0;
+                else
+                    i = position-1;
+                for ( ; i<num_entries; i++)
                 {
                     Z_Entry *ent = entries[i];
 
@@ -903,8 +982,7 @@ void yf::Multi::Frontend::scan2(Package &package, Z_APDU *apdu_req)
         }
     }
 
-
-    if (false)
+    if (true)
     {
         std::cout << "BEFORE\n";
         ScanTermInfoList::iterator it = entries_before.begin();
@@ -923,43 +1001,57 @@ void yf::Multi::Frontend::scan2(Package &package, Z_APDU *apdu_req)
 
     if (false)
     {
-        yp2::odr odr;
+        mp::odr odr;
         Z_APDU *f_apdu = odr.create_scanResponse(apdu_req, 1, "not implemented");
         package.response() = f_apdu;
     }
     else
     {
-        yp2::odr odr;
+        mp::odr odr;
         Z_APDU *f_apdu = odr.create_scanResponse(apdu_req, 0, 0);
         Z_ScanResponse *resp = f_apdu->u.scanResponse;
         
         int number_returned = *req->numberOfTermsRequested;
         int position_returned = *req->preferredPositionInResponse;
         
-        resp->positionOfTerm = odr_intdup(odr, position_returned);
-        resp->numberOfEntriesReturned = odr_intdup(odr, number_returned);
-        
         resp->entries->num_entries = number_returned;
         resp->entries->entries = (Z_Entry**)
             odr_malloc(odr, sizeof(Z_Entry*) * number_returned);
         int i;
-        
+
+        int lbefore = entries_before.size();
+        if (lbefore < position_returned-1)
+            position_returned = lbefore+1;
+
         ScanTermInfoList::iterator it = entries_before.begin();
-        for (i = 0; i<position_returned-1; i++, it++)
+        for (i = 0; i<position_returned-1 && it != entries_before.end(); i++, it++)
         {
-            resp->entries->entries[i] = it->get_entry(odr);
+            resp->entries->entries[position_returned-2-i] = it->get_entry(odr);
         }
+
         it = entries_after.begin();
-        for (i = position_returned-1; i<number_returned; i++, it++)
+
+        if (position_returned <= 0)
+            i = 0;
+        else
+            i = position_returned-1;
+        for (; i<number_returned && it != entries_after.end(); i++, it++)
         {
             resp->entries->entries[i] = it->get_entry(odr);
         }
+
+        number_returned = i;
+
+        resp->positionOfTerm = odr_intdup(odr, position_returned);
+        resp->numberOfEntriesReturned = odr_intdup(odr, number_returned);
+        resp->entries->num_entries = number_returned;
+
         package.response() = f_apdu;
     }
 }
 
 
-void yf::Multi::process(Package &package) const
+void yf::Multi::process(mp::Package &package) const
 {
     FrontendPtr f = m_p->get_frontend(package);
 
@@ -977,7 +1069,7 @@ void yf::Multi::process(Package &package) const
         Z_APDU *apdu = gdu->u.z3950;
         if (apdu->which == Z_APDU_initRequest)
         {
-            yp2::odr odr;
+            mp::odr odr;
             
             package.response() = odr.create_close(
                 apdu,
@@ -1000,7 +1092,7 @@ void yf::Multi::process(Package &package) const
         }
         else
         {
-            yp2::odr odr;
+            mp::odr odr;
             
             package.response() = odr.create_close(
                 apdu, Z_Close_protocolError,
@@ -1012,7 +1104,7 @@ void yf::Multi::process(Package &package) const
     m_p->release_frontend(package);
 }
 
-void yp2::filter::Multi::configure(const xmlNode * ptr)
+void mp::filter::Multi::configure(const xmlNode * ptr)
 {
     for (ptr = ptr->children; ptr; ptr = ptr->next)
     {
@@ -1020,44 +1112,18 @@ void yp2::filter::Multi::configure(const xmlNode * ptr)
             continue;
         if (!strcmp((const char *) ptr->name, "target"))
         {
-            std::string route = yp2::xml::get_route(ptr);
-            std::string target = yp2::xml::get_text(ptr);
+            std::string route = mp::xml::get_route(ptr);
+            std::string target = mp::xml::get_text(ptr);
             std::cout << "route=" << route << " target=" << target << "\n";
             m_p->m_target_route[target] = route;
         }
-        else if (!strcmp((const char *) ptr->name, "virtual"))
+        else if (!strcmp((const char *) ptr->name, "hideunavailable"))
         {
-            std::list<std::string> targets;
-            std::string vhost;
-            xmlNode *v_node = ptr->children;
-            for (; v_node; v_node = v_node->next)
-            {
-                if (v_node->type != XML_ELEMENT_NODE)
-                    continue;
-                
-                if (yp2::xml::is_element_yp2(v_node, "vhost"))
-                    vhost = yp2::xml::get_text(v_node);
-                else if (yp2::xml::is_element_yp2(v_node, "target"))
-                    targets.push_back(yp2::xml::get_text(v_node));
-                else
-                    throw yp2::filter::FilterException
-                        ("Bad element " 
-                         + std::string((const char *) v_node->name)
-                         + " in virtual section"
-                            );
-            }
-            std::string route = yp2::xml::get_route(ptr);
-            add_map_host2hosts(vhost, targets, route);
-            std::list<std::string>::const_iterator it;
-            for (it = targets.begin(); it != targets.end(); it++)
-            {
-                std::cout << "Add " << vhost << "->" << *it
-                          << "," << route << "\n";
-            }
+            m_p->m_hide_unavailable = true;
         }
         else
         {
-            throw yp2::filter::FilterException
+            throw mp::filter::FilterException
                 ("Bad element " 
                  + std::string((const char *) ptr->name)
                  + " in virt_db filter");
@@ -1065,13 +1131,13 @@ void yp2::filter::Multi::configure(const xmlNode * ptr)
     }
 }
 
-static yp2::filter::Base* filter_creator()
+static mp::filter::Base* filter_creator()
 {
-    return new yp2::filter::Multi;
+    return new mp::filter::Multi;
 }
 
 extern "C" {
-    struct yp2_filter_struct yp2_filter_multi = {
+    struct metaproxy_1_filter_struct metaproxy_1_filter_multi = {
         0,
         "multi",
         filter_creator