1 /* This file is part of Metaproxy.
2 Copyright (C) 2005-2012 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_filters1(xmlDocPtr doc, const xmlNode *node,
73 bool test_only, const char *file_include_path,
75 void parse_xml_routes(xmlDocPtr doc, const xmlNode *node,
76 bool test_only, const char *file_include_path);
77 void check_routes_in_filters(const xmlNode *n);
81 FactoryFilter *m_factory; // TODO shared_ptr
84 class RouterFleXML::Pos : public RoutePos {
86 virtual const filter::Base *move(const char *route);
87 virtual RoutePos *clone();
89 mp::RouterFleXML::Rep *m_p;
92 RouterFleXML::Route>::iterator m_route_it;
93 std::list<boost::shared_ptr <const mp::filter::Base> >::iterator m_filter_it;
97 void mp::RouterFleXML::Rep::parse_xml_filters(xmlDocPtr doc,
100 const char *file_include_path)
102 unsigned int filter_nr = 0;
103 while (node && mp::xml::check_element_mp(node, "filter"))
107 const struct _xmlAttr *attr;
108 std::string id_value;
109 std::string type_value;
110 for (attr = node->properties; attr; attr = attr->next)
112 std::string name = std::string((const char *) attr->name);
115 if (attr->children && attr->children->type == XML_TEXT_NODE)
116 value = std::string((const char *)attr->children->content);
120 else if (name == "type")
123 throw mp::XMLError("Only attribute id or type allowed"
124 " in filter element. Got " + name);
127 if (!m_factory->exist(type_value))
129 yaz_log(YLOG_LOG, "Loading %s (dlpath %s)",
130 type_value.c_str(), m_dl_path.c_str());
131 m_factory->add_creator_dl(type_value, m_dl_path);
133 mp::filter::Base* filter_base = m_factory->create(type_value);
135 filter_base->configure(node, test_only, file_include_path);
137 if (m_id_filter_map.find(id_value) != m_id_filter_map.end())
138 throw mp::XMLError("Filter " + id_value + " already defined");
140 m_id_filter_map[id_value] =
141 boost::shared_ptr<mp::filter::Base>(filter_base);
143 node = mp::xml::jump_to_next(node, XML_ELEMENT_NODE);
147 void mp::RouterFleXML::Rep::parse_xml_filters1(xmlDocPtr doc,
150 const char *file_include_path,
155 if (mp::xml::is_element_mp(node, "filters"))
157 const xmlNode* node1 =
158 mp::xml::jump_to_children(node, XML_ELEMENT_NODE);
160 parse_xml_filters1(doc, node1, test_only, file_include_path, route);
162 else if (mp::xml::check_element_mp(node, "filter"))
164 const struct _xmlAttr *attr;
165 std::string refid_value;
166 std::string type_value;
167 for (attr = node->properties; attr; attr = attr->next)
169 std::string name = std::string((const char *) attr->name);
172 if (attr->children && attr->children->type == XML_TEXT_NODE)
173 value = std::string((const char *)attr->children->content);
177 else if (name == "type")
180 throw mp::XMLError("Only attribute 'refid' or 'type'"
181 " allowed for element 'filter'."
184 if (refid_value.length())
186 std::map<std::string,
187 boost::shared_ptr<const mp::filter::Base > >::iterator it;
188 it = m_id_filter_map.find(refid_value);
189 if (it == m_id_filter_map.end())
190 throw mp::XMLError("Unknown filter refid "
193 route.m_list.push_back(it->second);
195 else if (type_value.length())
197 if (!m_factory->exist(type_value))
199 yaz_log(YLOG_LOG, "Loading %s (dlpath %s)",
200 type_value.c_str(), m_dl_path.c_str());
201 m_factory->add_creator_dl(type_value, m_dl_path);
203 mp::filter::Base* filter_base = m_factory->create(type_value);
205 filter_base->configure(node, test_only, file_include_path);
207 route.m_list.push_back(
208 boost::shared_ptr<mp::filter::Base>(filter_base));
212 node = mp::xml::jump_to_next(node, XML_ELEMENT_NODE);
217 void mp::RouterFleXML::Rep::parse_xml_routes(xmlDocPtr doc,
220 const char *file_include_path)
222 mp::xml::check_element_mp(node, "route");
224 unsigned int route_nr = 0;
225 while (mp::xml::is_element_mp(node, "route"))
229 const struct _xmlAttr *attr;
230 std::string id_value;
231 for (attr = node->properties; attr; attr = attr->next)
233 std::string name = std::string((const char *) attr->name);
236 if (attr->children && attr->children->type == XML_TEXT_NODE)
237 value = std::string((const char *)attr->children->content);
242 throw mp::XMLError("Only attribute 'id' allowed for"
249 // process <filter> / <filters> nodes in third level
250 const xmlNode* node3 = mp::xml::jump_to_children(node, XML_ELEMENT_NODE);
251 parse_xml_filters1(doc, node3, test_only, file_include_path, route);
253 std::map<std::string,RouterFleXML::Route>::iterator it;
254 it = m_routes.find(id_value);
255 if (it != m_routes.end())
256 throw mp::XMLError("Route id='" + id_value
257 + "' already exist");
259 m_routes[id_value] = route;
260 node = mp::xml::jump_to_next(node, XML_ELEMENT_NODE);
264 void mp::RouterFleXML::Rep::check_routes_in_filters(const xmlNode *node)
268 if (mp::xml::is_element_mp(node, "filters"))
271 mp::xml::jump_to_children(node, XML_ELEMENT_NODE);
272 check_routes_in_filters(n);
274 else if (mp::xml::is_element_mp(node, "filter"))
277 mp::xml::jump_to_children(node, XML_ELEMENT_NODE);
280 const struct _xmlAttr *attr;
281 // we assume thar that route attribute is only at one level
282 // below filter.. At least that works for multi and virt_db.
283 for (attr = n->properties; attr; attr = attr->next)
285 if (!strcmp((const char *) attr->name, "route"))
289 if (attr->children && attr->children->type == XML_TEXT_NODE)
290 value = std::string((const char *)attr->children->content);
292 std::map<std::string,RouterFleXML::Route>::iterator it;
293 it = m_routes.find(value);
294 if (it == m_routes.end())
296 throw mp::XMLError("Route '" + value + "' does not exist");
300 n = mp::xml::jump_to_next(n, XML_ELEMENT_NODE);
303 node = mp::xml::jump_to_next(node, XML_ELEMENT_NODE);
307 void mp::RouterFleXML::Rep::parse_xml_config_dom(xmlDocPtr doc,
309 const char *file_include_path)
312 throw mp::XMLError("Empty XML Document");
314 const xmlNode* root = xmlDocGetRootElement(doc);
316 if (file_include_path)
318 int r = yaz_xml_include_simple((xmlNode *) root, file_include_path);
320 throw mp::XMLError("YAZ XML Include failed");
323 mp::xml::check_element_mp(root, "metaproxy");
325 const xmlNode* node = mp::xml::jump_to_children(root, XML_ELEMENT_NODE);
327 if (mp::xml::is_element_mp(node, "dlpath"))
329 m_dl_path = mp::xml::get_text(node);
330 node = mp::xml::jump_to_next(node, XML_ELEMENT_NODE);
332 // process <start> node which is expected first element node
333 if (mp::xml::check_element_mp(node, "start"))
335 const struct _xmlAttr *attr;
336 for (attr = node->properties; attr; attr = attr->next)
338 std::string name = std::string((const char *) attr->name);
341 if (attr->children && attr->children->type == XML_TEXT_NODE)
342 value = std::string((const char *)attr->children->content);
345 m_start_route = value;
347 throw mp::XMLError("Only attribute route allowed"
348 " in element 'start'. Got " + name);
350 node = mp::xml::jump_to_next(node, XML_ELEMENT_NODE);
352 // process <filters> node if given
353 if (mp::xml::is_element_mp(node, "filters"))
355 parse_xml_filters(doc, mp::xml::jump_to_children(node,
357 test_only, file_include_path);
359 node = mp::xml::jump_to_next(node, XML_ELEMENT_NODE);
361 // process <routes> node which is expected third element node
362 mp::xml::check_element_mp(node, "routes");
364 parse_xml_routes(doc, mp::xml::jump_to_children(node, XML_ELEMENT_NODE),
365 test_only, file_include_path);
367 node = mp::xml::jump_to_next(node, XML_ELEMENT_NODE);
370 throw mp::XMLError("Unexpected element "
371 + std::string((const char *)node->name));
374 node = mp::xml::jump_to_children(root, XML_ELEMENT_NODE);
377 if (mp::xml::is_element_mp(node, "filters"))
378 check_routes_in_filters(
379 mp::xml::jump_to_children(node,
381 else if (mp::xml::is_element_mp(node, "routes"))
383 const xmlNode* n = mp::xml::jump_to_children(node,
387 if (mp::xml::is_element_mp(n, "route"))
389 check_routes_in_filters(
390 mp::xml::jump_to_children(n, XML_ELEMENT_NODE));
393 n = mp::xml::jump_to_next(n, XML_ELEMENT_NODE);
396 node = mp::xml::jump_to_next(node, XML_ELEMENT_NODE);
400 mp::RouterFleXML::Rep::Rep() : m_xinclude(false)
404 void mp::RouterFleXML::Rep::base(xmlDocPtr doc, mp::FactoryFilter &factory,
405 bool test_only, const char *file_include_path)
407 m_factory = &factory;
408 parse_xml_config_dom(doc, test_only, file_include_path);
409 m_start_route = "start";
412 mp::RouterFleXML::RouterFleXML(xmlDocPtr doc, mp::FactoryFilter &factory,
413 bool test_only, const char *file_include_path)
416 m_p->base(doc, factory, test_only, file_include_path);
419 mp::RouterFleXML::RouterFleXML(std::string xmlconf, mp::FactoryFilter &factory,
425 xmlDocPtr doc = xmlParseMemory(xmlconf.c_str(),
428 throw mp::XMLError("xmlParseMemory failed");
431 m_p->base(doc, factory, test_only, 0);
436 mp::RouterFleXML::~RouterFleXML()
440 const mp::filter::Base *mp::RouterFleXML::Pos::move(const char *route)
444 //std::cout << "move to " << route << "\n";
445 m_route_it = m_p->m_routes.find(route);
446 if (m_route_it == m_p->m_routes.end())
448 std::cout << "no such route " << route << "\n";
449 throw mp::XMLError("bad route " + std::string(route));
451 m_filter_it = m_route_it->second.m_list.begin();
453 if (m_filter_it == m_route_it->second.m_list.end())
455 const mp::filter::Base *f = (*m_filter_it).get();
460 mp::RoutePos *mp::RouterFleXML::createpos() const
462 mp::RouterFleXML::Pos *p = new mp::RouterFleXML::Pos;
464 p->m_route_it = m_p->m_routes.find(m_p->m_start_route);
465 if (p->m_route_it == m_p->m_routes.end())
470 p->m_filter_it = p->m_route_it->second.m_list.begin();
475 mp::RoutePos *mp::RouterFleXML::Pos::clone()
477 mp::RouterFleXML::Pos *p = new mp::RouterFleXML::Pos;
478 p->m_filter_it = m_filter_it;
479 p->m_route_it = m_route_it;
484 mp::RouterFleXML::Pos::~Pos()
489 void mp::RouterFleXML::start()
491 std::map<std::string,RouterFleXML::Route>::iterator route_it;
493 route_it = m_p->m_routes.begin();
494 while (route_it != m_p->m_routes.end())
496 RouterFleXML::Route route = route_it->second;
498 std::list<boost::shared_ptr<const mp::filter::Base> >::iterator it;
500 for (it = route.m_list.begin(); it != route.m_list.end(); it++)
506 void mp::RouterFleXML::stop()
508 std::map<std::string,RouterFleXML::Route>::iterator route_it;
510 route_it = m_p->m_routes.begin();
511 while (route_it != m_p->m_routes.end())
513 RouterFleXML::Route route = route_it->second;
515 std::list<boost::shared_ptr<const mp::filter::Base> >::iterator it;
517 for (it = route.m_list.begin(); it != route.m_list.end(); it++)
527 * c-file-style: "Stroustrup"
528 * indent-tabs-mode: nil
530 * vim: shiftwidth=4 tabstop=8 expandtab