Fix Metaproxy stops logging after check config failed MP-590
[metaproxy-moved-to-github.git] / src / router_flexml.cpp
index 027d2ae..54232de 100644 (file)
@@ -1,11 +1,24 @@
-/* $Id: router_flexml.cpp,v 1.15 2006-01-18 10:30:58 adam Exp $
-   Copyright (c) 2005, Index Data.
+/* This file is part of Metaproxy.
+   Copyright (C) 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 "xmlutil.hpp"
+#include <metaproxy/xmlutil.hpp>
+#include <string.h>
 #include "router_flexml.hpp"
 #include "factory_filter.hpp"
 #include "factory_static.hpp"
@@ -13,6 +26,8 @@
 #include <iostream>
 #include <map>
 #include <list>
+#include <yaz/log.h>
+#include <yaz/xml_include.h>
 
 #include <boost/shared_ptr.hpp>
 
 #include <libxml/parser.h>
 #include <libxml/tree.h>
 
+namespace mp = metaproxy_1;
 
-namespace yp2 {
+namespace metaproxy_1 {
     class RouterFleXML::Route {
         friend class RouterFleXML::Rep;
         friend class RouterFleXML::Pos;
         friend class RouterFleXML;
-        std::list<boost::shared_ptr<const yp2::filter::Base> > m_list;
+        std::list<boost::shared_ptr<const mp::filter::Base> > m_list;
     };
     class RouterFleXML::Rep {
         friend class RouterFleXML;
         friend class RouterFleXML::Pos;
         Rep();
 
-        void base(xmlDocPtr doc, yp2::FactoryFilter &factory);
+        void base(xmlDocPtr doc, mp::FactoryFilter &factory, bool test_only,
+                  const char *file_include_path);
 
         typedef std::map<std::string,
-                         boost::shared_ptr<const yp2::filter::Base > >
+                         boost::shared_ptr<const mp::filter::Base > >
                          IdFilterMap ;
 
         IdFilterMap m_id_filter_map;
@@ -45,10 +62,19 @@ namespace yp2 {
 
         std::string m_start_route;
 
-        void parse_xml_config_dom(xmlDocPtr doc);
+        std::string m_dl_path;
+
+        void parse_xml_config_dom(xmlDocPtr doc, bool test_only,
+                                  const char *file_include_path);
 
-        void parse_xml_filters(xmlDocPtr doc, const xmlNode *node);
-        void parse_xml_routes(xmlDocPtr doc, const xmlNode *node);
+        void parse_xml_filters(xmlDocPtr doc, const xmlNode *node,
+                               bool test_only, const char *file_include_path);
+        void parse_xml_filters1(xmlDocPtr doc, const xmlNode *node,
+                                bool test_only, const char *file_include_path,
+                                Route &route);
+        void parse_xml_routes(xmlDocPtr doc, const xmlNode *node,
+                              bool test_only, const char *file_include_path);
+        void check_routes_in_filters(const xmlNode *n);
 
         bool m_xinclude;
     private:
@@ -60,19 +86,21 @@ namespace yp2 {
         virtual const filter::Base *move(const char *route);
         virtual RoutePos *clone();
         virtual ~Pos();
-        yp2::RouterFleXML::Rep *m_p;
+        mp::RouterFleXML::Rep *m_p;
 
-        std::map<std::string, 
+        std::map<std::string,
                  RouterFleXML::Route>::iterator m_route_it;
-        std::list<boost::shared_ptr <const yp2::filter::Base> >::iterator m_filter_it;
+        std::list<boost::shared_ptr <const mp::filter::Base> >::iterator m_filter_it;
     };
 }
 
-void yp2::RouterFleXML::Rep::parse_xml_filters(xmlDocPtr doc,
-                                               const xmlNode *node)
+void mp::RouterFleXML::Rep::parse_xml_filters(xmlDocPtr doc,
+                                              const xmlNode *node,
+                                              bool test_only,
+                                              const char *file_include_path)
 {
     unsigned int filter_nr = 0;
-    while(node && yp2::xml::check_element_yp2(node, "filter"))
+    while (node && mp::xml::check_element_mp(node, "filter"))
     {
         filter_nr++;
 
@@ -91,132 +119,229 @@ void yp2::RouterFleXML::Rep::parse_xml_filters(xmlDocPtr doc,
                 id_value = value;
             else if (name == "type")
                 type_value = value;
+            else if (name == "base")
+                ;// Ignore XInclude base attribute.
             else
-                throw yp2::XMLError("Only attribute id or type allowed"
+                throw mp::XMLError("Only attribute id or type allowed"
                                     " in filter element. Got " + name);
         }
 
-        yp2::filter::Base* filter_base = m_factory->create(type_value);
+        if (!m_factory->exist(type_value))
+        {
+            yaz_log(YLOG_LOG, "Loading %s (dlpath %s)",
+                    type_value.c_str(), m_dl_path.c_str());
+            m_factory->add_creator_dl(type_value, m_dl_path);
+        }
+        boost::shared_ptr<mp::filter::Base> fb(m_factory->create(type_value));
 
-        filter_base->configure(node);
+        fb->configure(node, test_only, file_include_path);
 
         if (m_id_filter_map.find(id_value) != m_id_filter_map.end())
-            throw yp2::XMLError("Filter " + id_value + " already defined");
+            throw mp::XMLError("Filter " + id_value + " already defined");
 
-        m_id_filter_map[id_value] =
-            boost::shared_ptr<yp2::filter::Base>(filter_base);
+        m_id_filter_map[id_value] = fb;
 
-        node = yp2::xml::jump_to_next(node, XML_ELEMENT_NODE);
+        node = mp::xml::jump_to_next(node, XML_ELEMENT_NODE);
     }
 }
 
-void yp2::RouterFleXML::Rep::parse_xml_routes(xmlDocPtr doc,
-                                              const xmlNode *node)
+void mp::RouterFleXML::Rep::parse_xml_filters1(xmlDocPtr doc,
+                                              const xmlNode *node,
+                                              bool test_only,
+                                              const char *file_include_path,
+                                              Route &route)
 {
-    yp2::xml::check_element_yp2(node, "route");
-
-    unsigned int route_nr = 0;
-    while(yp2::xml::is_element_yp2(node, "route"))
+    while (node)
     {
-        route_nr++;
-
-        const struct _xmlAttr *attr;
-        std::string id_value;
-        for (attr = node->properties; attr; attr = attr->next)
+        if (mp::xml::is_element_mp(node, "filters"))
         {
-            std::string name = std::string((const char *) attr->name);
-            std::string value;
-            
-            if (attr->children && attr->children->type == XML_TEXT_NODE)
-                value = std::string((const char *)attr->children->content);
-            
-            if (name == "id")
-                id_value = value;
-            else
-                throw yp2::XMLError("Only attribute 'id' allowed for"
-                                         " element 'route'."
-                                         " Got " + name);
-        }
+            const xmlNode* node1 =
+                mp::xml::jump_to_children(node, XML_ELEMENT_NODE);
 
-        Route route;
-
-        // process <filter> nodes in third level
-        const xmlNode* node3 = yp2::xml::jump_to_children(node, XML_ELEMENT_NODE);
-
-        unsigned int filter3_nr = 0;
-        while(node3 && yp2::xml::check_element_yp2(node3, "filter"))
+            parse_xml_filters1(doc, node1, test_only, file_include_path, route);
+        }
+        else if (mp::xml::check_element_mp(node, "filter"))
         {
-            filter3_nr++;
-            
             const struct _xmlAttr *attr;
             std::string refid_value;
             std::string type_value;
-            for (attr = node3->properties; attr; attr = attr->next)
+            for (attr = node->properties; attr; attr = attr->next)
             {
                 std::string name = std::string((const char *) attr->name);
                 std::string value;
-                
+
                 if (attr->children && attr->children->type == XML_TEXT_NODE)
                     value = std::string((const char *)attr->children->content);
-                
+
                 if (name == "refid")
                     refid_value = value;
                 else if (name == "type")
                     type_value = value;
+                else if (name == "base")
+                    ;// Ignore XInclude base attribute.
                 else
-                    throw yp2::XMLError("Only attribute 'refid' or 'type'"
-                                        " allowed for element 'filter'."
-                                        " Got " + name);
+                    throw mp::XMLError("Only attribute 'refid' or 'type'"
+                                       " allowed for element 'filter'."
+                                       " Got " + name);
             }
             if (refid_value.length())
             {
                 std::map<std::string,
-                    boost::shared_ptr<const yp2::filter::Base > >::iterator it;
+                         boost::shared_ptr<const mp::filter::Base > >::iterator it;
                 it = m_id_filter_map.find(refid_value);
                 if (it == m_id_filter_map.end())
-                    throw yp2::XMLError("Unknown filter refid "
-                                        + refid_value);
+                    throw mp::XMLError("Unknown filter refid "
+                                       + refid_value);
                 else
                     route.m_list.push_back(it->second);
             }
             else if (type_value.length())
             {
-                yp2::filter::Base* filter_base = m_factory->create(type_value);
+                if (!m_factory->exist(type_value))
+                {
+                    yaz_log(YLOG_LOG, "Loading %s (dlpath %s)",
+                            type_value.c_str(), m_dl_path.c_str());
+                    m_factory->add_creator_dl(type_value, m_dl_path);
+                }
+                mp::filter::Base* filter_base = m_factory->create(type_value);
+
+                filter_base->configure(node, test_only, file_include_path);
 
-                filter_base->configure(node3);
-                
                 route.m_list.push_back(
-                    boost::shared_ptr<yp2::filter::Base>(filter_base));
+                    boost::shared_ptr<mp::filter::Base>(filter_base));
             }
-            node3 = yp2::xml::jump_to_next(node3, XML_ELEMENT_NODE);
-            
+
         }
+        node = mp::xml::jump_to_next(node, XML_ELEMENT_NODE);
+    }
+}
+
+
+void mp::RouterFleXML::Rep::parse_xml_routes(xmlDocPtr doc,
+                                             const xmlNode *node,
+                                             bool test_only,
+                                             const char *file_include_path)
+{
+    mp::xml::check_element_mp(node, "route");
+
+    unsigned int route_nr = 0;
+    while (mp::xml::is_element_mp(node, "route"))
+    {
+        route_nr++;
+
+        const struct _xmlAttr *attr;
+        std::string id_value;
+        for (attr = node->properties; attr; attr = attr->next)
+        {
+            std::string name = std::string((const char *) attr->name);
+            std::string value;
+
+            if (attr->children && attr->children->type == XML_TEXT_NODE)
+                value = std::string((const char *)attr->children->content);
+
+            if (name == "id")
+                id_value = value;
+            else if (name == "base")
+                ;// Ignore XInclude base attribute.
+            else
+                throw mp::XMLError("Only attribute 'id' allowed for"
+                                    " element 'route'."
+                                    " Got " + name);
+        }
+
+        Route route;
+
+        // process <filter> / <filters> nodes in third level
+        const xmlNode* node3 = mp::xml::jump_to_children(node, XML_ELEMENT_NODE);
+
+
+
+        parse_xml_filters1(doc, node3, test_only, file_include_path, route);
+
         std::map<std::string,RouterFleXML::Route>::iterator it;
         it = m_routes.find(id_value);
         if (it != m_routes.end())
-            throw yp2::XMLError("Route id='" + id_value
+            throw mp::XMLError("Route id='" + id_value
                                 + "' already exist");
         else
             m_routes[id_value] = route;
-        node = yp2::xml::jump_to_next(node, XML_ELEMENT_NODE);
+        node = mp::xml::jump_to_next(node, XML_ELEMENT_NODE);
+    }
+}
+
+void mp::RouterFleXML::Rep::check_routes_in_filters(const xmlNode *node)
+{
+    while (node)
+    {
+        if (mp::xml::is_element_mp(node, "filters"))
+        {
+            const xmlNode *n =
+                mp::xml::jump_to_children(node, XML_ELEMENT_NODE);
+            check_routes_in_filters(n);
+        }
+        else if (mp::xml::is_element_mp(node, "filter"))
+        {
+            const xmlNode *n =
+                mp::xml::jump_to_children(node, XML_ELEMENT_NODE);
+            while (n)
+            {
+                const struct _xmlAttr *attr;
+                // we assume thar that route attribute is only at one level
+                // below filter.. At least that works for multi and virt_db.
+                for (attr = n->properties; attr; attr = attr->next)
+                {
+                    if (!strcmp((const char *) attr->name, "route"))
+                    {
+                        std::string value;
+
+                        if (attr->children && attr->children->type == XML_TEXT_NODE)
+                            value = std::string((const char *)attr->children->content);
+
+                        std::map<std::string,RouterFleXML::Route>::iterator it;
+                        it = m_routes.find(value);
+                        if (it == m_routes.end())
+                        {
+                            throw mp::XMLError("Route '" + value + "' does not exist");
+                        }
+                    }
+                }
+                n = mp::xml::jump_to_next(n, XML_ELEMENT_NODE);
+            }
+        }
+        node = mp::xml::jump_to_next(node, XML_ELEMENT_NODE);
     }
 }
 
-void yp2::RouterFleXML::Rep::parse_xml_config_dom(xmlDocPtr doc)
+void mp::RouterFleXML::Rep::parse_xml_config_dom(xmlDocPtr doc,
+                                                 bool test_only,
+                                                 const char *file_include_path)
 {
     if (!doc)
-        throw yp2::XMLError("Empty XML Document");
-    
+        throw mp::XMLError("Empty XML Document");
+
     const xmlNode* root = xmlDocGetRootElement(doc);
-    
-    yp2::xml::check_element_yp2(root,  "yp2");
 
+    if (file_include_path)
+    {
+        int r = yaz_xml_include_glob((xmlNode *) root, file_include_path,
+            YAZ_FILE_GLOB_FAIL_NOTEXIST);
+        if (r)
+            throw mp::XMLError("YAZ XML Include failed");
+    }
+
+    mp::xml::check_element_mp(root,  "metaproxy");
+
+    const xmlNode* node = mp::xml::jump_to_children(root, XML_ELEMENT_NODE);
+
+    if (mp::xml::is_element_mp(node, "dlpath"))
+    {
+        m_dl_path = mp::xml::get_text(node);
+        node = mp::xml::jump_to_next(node, XML_ELEMENT_NODE);
+    }
     // process <start> node which is expected first element node
-    const xmlNode* node = yp2::xml::jump_to_children(root, XML_ELEMENT_NODE);
-    if (yp2::xml::check_element_yp2(node, "start"))
+    if (mp::xml::check_element_mp(node, "start"))
     {
         const struct _xmlAttr *attr;
-        std::string id_value;
         for (attr = node->properties; attr; attr = attr->next)
         {
             std::string name = std::string((const char *) attr->name);
@@ -227,93 +352,123 @@ void yp2::RouterFleXML::Rep::parse_xml_config_dom(xmlDocPtr doc)
 
             if (name == "route")
                 m_start_route = value;
+            else if (name == "base")
+                ;// Ignore XInclude base attribute.
             else
-                throw yp2::XMLError("Only attribute start allowed"
+                throw mp::XMLError("Only attribute route allowed"
                                     " in element 'start'. Got " + name);
         }
-        node = yp2::xml::jump_to_next(node, XML_ELEMENT_NODE);
+        node = mp::xml::jump_to_next(node, XML_ELEMENT_NODE);
     }
     // process <filters> node if given
-    if (yp2::xml::is_element_yp2(node, "filters"))
+    if (mp::xml::is_element_mp(node, "filters"))
     {
-        parse_xml_filters(doc, yp2::xml::jump_to_children(node,
-                                                          XML_ELEMENT_NODE));
-                      
-        node = yp2::xml::jump_to_next(node, XML_ELEMENT_NODE);
+        parse_xml_filters(doc, mp::xml::jump_to_children(node,
+                                                         XML_ELEMENT_NODE),
+                          test_only, file_include_path);
+
+        node = mp::xml::jump_to_next(node, XML_ELEMENT_NODE);
     }
     // process <routes> node which is expected third element node
-    yp2::xml::check_element_yp2(node, "routes");
-    
-    parse_xml_routes(doc, yp2::xml::jump_to_children(node, XML_ELEMENT_NODE));
+    mp::xml::check_element_mp(node, "routes");
+
+    parse_xml_routes(doc, mp::xml::jump_to_children(node, XML_ELEMENT_NODE),
+                     test_only, file_include_path);
 
-    node = yp2::xml::jump_to_next(node, XML_ELEMENT_NODE);
+    node = mp::xml::jump_to_next(node, XML_ELEMENT_NODE);
     if (node)
     {
-        throw yp2::XMLError("Unexpected element " 
+        throw mp::XMLError("Unexpected element "
                             + std::string((const char *)node->name));
     }
-}        
 
-yp2::RouterFleXML::Rep::Rep() : m_xinclude(false)
+    node = mp::xml::jump_to_children(root, XML_ELEMENT_NODE);
+    while (node)
+    {
+        if (mp::xml::is_element_mp(node, "filters"))
+            check_routes_in_filters(
+                mp::xml::jump_to_children(node,
+                                          XML_ELEMENT_NODE));
+        else if (mp::xml::is_element_mp(node, "routes"))
+        {
+            const xmlNode* n = mp::xml::jump_to_children(node,
+                                                         XML_ELEMENT_NODE);
+            while (n)
+            {
+                if (mp::xml::is_element_mp(n, "route"))
+                {
+                    check_routes_in_filters(
+                        mp::xml::jump_to_children(n, XML_ELEMENT_NODE));
+
+                }
+                n = mp::xml::jump_to_next(n, XML_ELEMENT_NODE);
+            }
+        }
+        node = mp::xml::jump_to_next(node, XML_ELEMENT_NODE);
+    }
+}
+
+mp::RouterFleXML::Rep::Rep() : m_xinclude(false)
 {
 }
 
-void yp2::RouterFleXML::Rep::base(xmlDocPtr doc, yp2::FactoryFilter &factory)
+void mp::RouterFleXML::Rep::base(xmlDocPtr doc, mp::FactoryFilter &factory,
+                                 bool test_only, const char *file_include_path)
 {
     m_factory = &factory;
-    parse_xml_config_dom(doc);
+    parse_xml_config_dom(doc, test_only, file_include_path);
     m_start_route = "start";
 }
 
-yp2::RouterFleXML::RouterFleXML(xmlDocPtr doc, yp2::FactoryFilter &factory)
+mp::RouterFleXML::RouterFleXML(xmlDocPtr doc, mp::FactoryFilter &factory,
+                               bool test_only, const char *file_include_path)
     : m_p(new Rep)
 {
-    m_p->base(doc, factory);
+    m_p->base(doc, factory, test_only, file_include_path);
 }
 
-yp2::RouterFleXML::RouterFleXML(std::string xmlconf, yp2::FactoryFilter &factory) 
+mp::RouterFleXML::RouterFleXML(std::string xmlconf, mp::FactoryFilter &factory,
+    bool test_only)
     : m_p(new Rep)
-{            
-    LIBXML_TEST_VERSION;
-    
+{
     xmlDocPtr doc = xmlParseMemory(xmlconf.c_str(),
                                    xmlconf.size());
     if (!doc)
-        throw yp2::XMLError("xmlParseMemory failed");
+        throw mp::XMLError("xmlParseMemory failed");
     else
     {
-        m_p->base(doc, factory);
+        m_p->base(doc, factory, test_only, 0);
         xmlFreeDoc(doc);
     }
 }
 
-yp2::RouterFleXML::~RouterFleXML()
+mp::RouterFleXML::~RouterFleXML()
 {
 }
 
-const yp2::filter::Base *yp2::RouterFleXML::Pos::move(const char *route)
+const mp::filter::Base *mp::RouterFleXML::Pos::move(const char *route)
 {
     if (route && *route)
     {
-        std::cout << "move to " << route << "\n";
+        //std::cout << "move to " << route << "\n";
         m_route_it = m_p->m_routes.find(route);
         if (m_route_it == m_p->m_routes.end())
         {
             std::cout << "no such route " << route << "\n";
-            throw yp2::XMLError("bad route " + std::string(route));
+            throw mp::XMLError("bad route " + std::string(route));
         }
         m_filter_it = m_route_it->second.m_list.begin();
     }
     if (m_filter_it == m_route_it->second.m_list.end())
         return 0;
-    const yp2::filter::Base *f = (*m_filter_it).get();
+    const mp::filter::Base *f = (*m_filter_it).get();
     m_filter_it++;
     return f;
 }
 
-yp2::RoutePos *yp2::RouterFleXML::createpos() const
+mp::RoutePos *mp::RouterFleXML::createpos() const
 {
-    yp2::RouterFleXML::Pos *p = new yp2::RouterFleXML::Pos;
+    mp::RouterFleXML::Pos *p = new mp::RouterFleXML::Pos;
 
     p->m_route_it = m_p->m_routes.find(m_p->m_start_route);
     if (p->m_route_it == m_p->m_routes.end())
@@ -326,25 +481,61 @@ yp2::RoutePos *yp2::RouterFleXML::createpos() const
     return p;
 }
 
-yp2::RoutePos *yp2::RouterFleXML::Pos::clone()
+mp::RoutePos *mp::RouterFleXML::Pos::clone()
 {
-    yp2::RouterFleXML::Pos *p = new yp2::RouterFleXML::Pos;
+    mp::RouterFleXML::Pos *p = new mp::RouterFleXML::Pos;
     p->m_filter_it = m_filter_it;
     p->m_route_it = m_route_it;
     p->m_p = m_p;
     return p;
 }
 
-yp2::RouterFleXML::Pos::~Pos()
+mp::RouterFleXML::Pos::~Pos()
 {
 }
 
 
+void mp::RouterFleXML::start()
+{
+    std::map<std::string,RouterFleXML::Route>::iterator route_it;
+
+    route_it = m_p->m_routes.begin();
+    while (route_it != m_p->m_routes.end())
+    {
+        RouterFleXML::Route route = route_it->second;
+
+        std::list<boost::shared_ptr<const mp::filter::Base> >::iterator it;
+
+        for (it = route.m_list.begin(); it != route.m_list.end(); it++)
+            (*it)->start();
+        route_it++;
+    }
+}
+
+void mp::RouterFleXML::stop(int signo)
+{
+    std::map<std::string,RouterFleXML::Route>::iterator route_it;
+
+    route_it = m_p->m_routes.begin();
+    while (route_it != m_p->m_routes.end())
+    {
+        RouterFleXML::Route route = route_it->second;
+
+        std::list<boost::shared_ptr<const mp::filter::Base> >::iterator it;
+
+        for (it = route.m_list.begin(); it != route.m_list.end(); it++)
+            (*it)->stop(signo);
+        route_it++;
+    }
+}
+
+
 /*
  * 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
  */
+