1 /* This file is part of Metaproxy.
2 Copyright (C) 2005-2011 Index Data
4 Metaproxy is free software; you can redistribute it and/or modify it under
5 the terms of the GNU General Public License as published by the Free
6 Software Foundation; either version 2, or (at your option) any later
9 Metaproxy is distributed in the hope that it will be useful, but WITHOUT ANY
10 WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 You should have received a copy of the GNU General Public License
15 along with this program; if not, write to the Free Software
16 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
20 #include <metaproxy/xmlutil.hpp>
22 #include "router_flexml.hpp"
23 #include "factory_filter.hpp"
24 #include "factory_static.hpp"
30 #include <yaz/xml_include.h>
32 #include <boost/shared_ptr.hpp>
34 #include <libxml/xmlversion.h>
35 #include <libxml/parser.h>
36 #include <libxml/tree.h>
38 namespace mp = metaproxy_1;
40 namespace metaproxy_1 {
41 class RouterFleXML::Route {
42 friend class RouterFleXML::Rep;
43 friend class RouterFleXML::Pos;
44 friend class RouterFleXML;
45 std::list<boost::shared_ptr<const mp::filter::Base> > m_list;
47 class RouterFleXML::Rep {
48 friend class RouterFleXML;
49 friend class RouterFleXML::Pos;
52 void base(xmlDocPtr doc, mp::FactoryFilter &factory, bool test_only,
53 const char *file_include_path);
55 typedef std::map<std::string,
56 boost::shared_ptr<const mp::filter::Base > >
59 IdFilterMap m_id_filter_map;
61 std::map<std::string,RouterFleXML::Route> m_routes;
63 std::string m_start_route;
65 std::string m_dl_path;
67 void parse_xml_config_dom(xmlDocPtr doc, bool test_only,
68 const char *file_include_path);
70 void parse_xml_filters(xmlDocPtr doc, const xmlNode *node,
71 bool test_only, const char *file_include_path);
72 void parse_xml_routes(xmlDocPtr doc, const xmlNode *node,
73 bool test_only, const char *file_include_path);
74 void check_routes_in_filters(const xmlNode *n);
78 FactoryFilter *m_factory; // TODO shared_ptr
81 class RouterFleXML::Pos : public RoutePos {
83 virtual const filter::Base *move(const char *route);
84 virtual RoutePos *clone();
86 mp::RouterFleXML::Rep *m_p;
89 RouterFleXML::Route>::iterator m_route_it;
90 std::list<boost::shared_ptr <const mp::filter::Base> >::iterator m_filter_it;
94 void mp::RouterFleXML::Rep::parse_xml_filters(xmlDocPtr doc,
97 const char *file_include_path)
99 unsigned int filter_nr = 0;
100 while (node && mp::xml::check_element_mp(node, "filter"))
104 const struct _xmlAttr *attr;
105 std::string id_value;
106 std::string type_value;
107 for (attr = node->properties; attr; attr = attr->next)
109 std::string name = std::string((const char *) attr->name);
112 if (attr->children && attr->children->type == XML_TEXT_NODE)
113 value = std::string((const char *)attr->children->content);
117 else if (name == "type")
120 throw mp::XMLError("Only attribute id or type allowed"
121 " in filter element. Got " + name);
124 if (!m_factory->exist(type_value))
126 yaz_log(YLOG_LOG, "Loading %s (dlpath %s)",
127 type_value.c_str(), m_dl_path.c_str());
128 m_factory->add_creator_dl(type_value, m_dl_path);
130 mp::filter::Base* filter_base = m_factory->create(type_value);
132 filter_base->configure(node, test_only, file_include_path);
134 if (m_id_filter_map.find(id_value) != m_id_filter_map.end())
135 throw mp::XMLError("Filter " + id_value + " already defined");
137 m_id_filter_map[id_value] =
138 boost::shared_ptr<mp::filter::Base>(filter_base);
140 node = mp::xml::jump_to_next(node, XML_ELEMENT_NODE);
144 void mp::RouterFleXML::Rep::parse_xml_routes(xmlDocPtr doc,
147 const char *file_include_path)
149 mp::xml::check_element_mp(node, "route");
151 unsigned int route_nr = 0;
152 while (mp::xml::is_element_mp(node, "route"))
156 const struct _xmlAttr *attr;
157 std::string id_value;
158 for (attr = node->properties; attr; attr = attr->next)
160 std::string name = std::string((const char *) attr->name);
163 if (attr->children && attr->children->type == XML_TEXT_NODE)
164 value = std::string((const char *)attr->children->content);
169 throw mp::XMLError("Only attribute 'id' allowed for"
176 // process <filter> nodes in third level
177 const xmlNode* node3 = mp::xml::jump_to_children(node, XML_ELEMENT_NODE);
179 unsigned int filter3_nr = 0;
180 while (node3 && mp::xml::check_element_mp(node3, "filter"))
184 const struct _xmlAttr *attr;
185 std::string refid_value;
186 std::string type_value;
187 for (attr = node3->properties; attr; attr = attr->next)
189 std::string name = std::string((const char *) attr->name);
192 if (attr->children && attr->children->type == XML_TEXT_NODE)
193 value = std::string((const char *)attr->children->content);
197 else if (name == "type")
200 throw mp::XMLError("Only attribute 'refid' or 'type'"
201 " allowed for element 'filter'."
204 if (refid_value.length())
206 std::map<std::string,
207 boost::shared_ptr<const mp::filter::Base > >::iterator it;
208 it = m_id_filter_map.find(refid_value);
209 if (it == m_id_filter_map.end())
210 throw mp::XMLError("Unknown filter refid "
213 route.m_list.push_back(it->second);
215 else if (type_value.length())
217 if (!m_factory->exist(type_value))
219 yaz_log(YLOG_LOG, "Loading %s (dlpath %s)",
220 type_value.c_str(), m_dl_path.c_str());
221 m_factory->add_creator_dl(type_value, m_dl_path);
223 mp::filter::Base* filter_base = m_factory->create(type_value);
225 filter_base->configure(node3, test_only, file_include_path);
227 route.m_list.push_back(
228 boost::shared_ptr<mp::filter::Base>(filter_base));
230 node3 = mp::xml::jump_to_next(node3, XML_ELEMENT_NODE);
233 std::map<std::string,RouterFleXML::Route>::iterator it;
234 it = m_routes.find(id_value);
235 if (it != m_routes.end())
236 throw mp::XMLError("Route id='" + id_value
237 + "' already exist");
239 m_routes[id_value] = route;
240 node = mp::xml::jump_to_next(node, XML_ELEMENT_NODE);
244 void mp::RouterFleXML::Rep::check_routes_in_filters(const xmlNode *node)
248 if (mp::xml::is_element_mp(node, "filter"))
251 mp::xml::jump_to_children(node, XML_ELEMENT_NODE);
254 const struct _xmlAttr *attr;
255 // we assume thar that route attribute is only at one level
256 // below filter.. At least that works for multi and virt_db.
257 for (attr = n->properties; attr; attr = attr->next)
259 if (!strcmp((const char *) attr->name, "route"))
263 if (attr->children && attr->children->type == XML_TEXT_NODE)
264 value = std::string((const char *)attr->children->content);
266 std::map<std::string,RouterFleXML::Route>::iterator it;
267 it = m_routes.find(value);
268 if (it == m_routes.end())
270 throw mp::XMLError("Route '" + value + "' does not exist");
274 n = mp::xml::jump_to_next(n, XML_ELEMENT_NODE);
277 node = mp::xml::jump_to_next(node, XML_ELEMENT_NODE);
281 void mp::RouterFleXML::Rep::parse_xml_config_dom(xmlDocPtr doc,
283 const char *file_include_path)
286 throw mp::XMLError("Empty XML Document");
288 const xmlNode* root = xmlDocGetRootElement(doc);
290 if (file_include_path)
292 int r = yaz_xml_include_simple((xmlNode *) root, file_include_path);
294 throw mp::XMLError("YAZ XML Include failed");
297 mp::xml::check_element_mp(root, "metaproxy");
299 const xmlNode* node = mp::xml::jump_to_children(root, XML_ELEMENT_NODE);
301 if (mp::xml::is_element_mp(node, "dlpath"))
303 m_dl_path = mp::xml::get_text(node);
304 node = mp::xml::jump_to_next(node, XML_ELEMENT_NODE);
306 // process <start> node which is expected first element node
307 if (mp::xml::check_element_mp(node, "start"))
309 const struct _xmlAttr *attr;
310 for (attr = node->properties; attr; attr = attr->next)
312 std::string name = std::string((const char *) attr->name);
315 if (attr->children && attr->children->type == XML_TEXT_NODE)
316 value = std::string((const char *)attr->children->content);
319 m_start_route = value;
321 throw mp::XMLError("Only attribute route allowed"
322 " in element 'start'. Got " + name);
324 node = mp::xml::jump_to_next(node, XML_ELEMENT_NODE);
326 // process <filters> node if given
327 if (mp::xml::is_element_mp(node, "filters"))
329 parse_xml_filters(doc, mp::xml::jump_to_children(node,
331 test_only, file_include_path);
333 node = mp::xml::jump_to_next(node, XML_ELEMENT_NODE);
335 // process <routes> node which is expected third element node
336 mp::xml::check_element_mp(node, "routes");
338 parse_xml_routes(doc, mp::xml::jump_to_children(node, XML_ELEMENT_NODE),
339 test_only, file_include_path);
341 node = mp::xml::jump_to_next(node, XML_ELEMENT_NODE);
344 throw mp::XMLError("Unexpected element "
345 + std::string((const char *)node->name));
348 node = mp::xml::jump_to_children(root, XML_ELEMENT_NODE);
351 if (mp::xml::is_element_mp(node, "filters"))
352 check_routes_in_filters(
353 mp::xml::jump_to_children(node,
355 else if (mp::xml::is_element_mp(node, "routes"))
357 const xmlNode* n = mp::xml::jump_to_children(node,
361 if (mp::xml::is_element_mp(n, "route"))
363 check_routes_in_filters(
364 mp::xml::jump_to_children(n, XML_ELEMENT_NODE));
367 n = mp::xml::jump_to_next(n, XML_ELEMENT_NODE);
370 node = mp::xml::jump_to_next(node, XML_ELEMENT_NODE);
374 mp::RouterFleXML::Rep::Rep() : m_xinclude(false)
378 void mp::RouterFleXML::Rep::base(xmlDocPtr doc, mp::FactoryFilter &factory,
379 bool test_only, const char *file_include_path)
381 m_factory = &factory;
382 parse_xml_config_dom(doc, test_only, file_include_path);
383 m_start_route = "start";
386 mp::RouterFleXML::RouterFleXML(xmlDocPtr doc, mp::FactoryFilter &factory,
387 bool test_only, const char *file_include_path)
390 m_p->base(doc, factory, test_only, file_include_path);
393 mp::RouterFleXML::RouterFleXML(std::string xmlconf, mp::FactoryFilter &factory,
399 xmlDocPtr doc = xmlParseMemory(xmlconf.c_str(),
402 throw mp::XMLError("xmlParseMemory failed");
405 m_p->base(doc, factory, test_only, 0);
410 mp::RouterFleXML::~RouterFleXML()
414 const mp::filter::Base *mp::RouterFleXML::Pos::move(const char *route)
418 //std::cout << "move to " << route << "\n";
419 m_route_it = m_p->m_routes.find(route);
420 if (m_route_it == m_p->m_routes.end())
422 std::cout << "no such route " << route << "\n";
423 throw mp::XMLError("bad route " + std::string(route));
425 m_filter_it = m_route_it->second.m_list.begin();
427 if (m_filter_it == m_route_it->second.m_list.end())
429 const mp::filter::Base *f = (*m_filter_it).get();
434 mp::RoutePos *mp::RouterFleXML::createpos() const
436 mp::RouterFleXML::Pos *p = new mp::RouterFleXML::Pos;
438 p->m_route_it = m_p->m_routes.find(m_p->m_start_route);
439 if (p->m_route_it == m_p->m_routes.end())
444 p->m_filter_it = p->m_route_it->second.m_list.begin();
449 mp::RoutePos *mp::RouterFleXML::Pos::clone()
451 mp::RouterFleXML::Pos *p = new mp::RouterFleXML::Pos;
452 p->m_filter_it = m_filter_it;
453 p->m_route_it = m_route_it;
458 mp::RouterFleXML::Pos::~Pos()
463 void mp::RouterFleXML::start()
465 std::map<std::string,RouterFleXML::Route>::iterator route_it;
467 route_it = m_p->m_routes.begin();
468 while (route_it != m_p->m_routes.end())
470 RouterFleXML::Route route = route_it->second;
472 std::list<boost::shared_ptr<const mp::filter::Base> >::iterator it;
474 for (it = route.m_list.begin(); it != route.m_list.end(); it++)
483 * c-file-style: "Stroustrup"
484 * indent-tabs-mode: nil
486 * vim: shiftwidth=4 tabstop=8 expandtab