1 /* This file is part of Metaproxy.
2 Copyright (C) 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")
122 else if (name == "base")
123 ;// Ignore XInclude base attribute.
125 throw mp::XMLError("Only attribute id or type allowed"
126 " in filter element. Got " + name);
129 if (!m_factory->exist(type_value))
131 yaz_log(YLOG_LOG, "Loading %s (dlpath %s)",
132 type_value.c_str(), m_dl_path.c_str());
133 m_factory->add_creator_dl(type_value, m_dl_path);
135 boost::shared_ptr<mp::filter::Base> fb(m_factory->create(type_value));
137 fb->configure(node, test_only, file_include_path);
139 if (m_id_filter_map.find(id_value) != m_id_filter_map.end())
140 throw mp::XMLError("Filter " + id_value + " already defined");
142 m_id_filter_map[id_value] = fb;
144 node = mp::xml::jump_to_next(node, XML_ELEMENT_NODE);
148 void mp::RouterFleXML::Rep::parse_xml_filters1(xmlDocPtr doc,
151 const char *file_include_path,
156 if (mp::xml::is_element_mp(node, "filters"))
158 const xmlNode* node1 =
159 mp::xml::jump_to_children(node, XML_ELEMENT_NODE);
161 parse_xml_filters1(doc, node1, test_only, file_include_path, route);
163 else if (mp::xml::check_element_mp(node, "filter"))
165 const struct _xmlAttr *attr;
166 std::string refid_value;
167 std::string type_value;
168 for (attr = node->properties; attr; attr = attr->next)
170 std::string name = std::string((const char *) attr->name);
173 if (attr->children && attr->children->type == XML_TEXT_NODE)
174 value = std::string((const char *)attr->children->content);
178 else if (name == "type")
180 else if (name == "base")
181 ;// Ignore XInclude base attribute.
183 throw mp::XMLError("Only attribute 'refid' or 'type'"
184 " allowed for element 'filter'."
187 if (refid_value.length())
189 std::map<std::string,
190 boost::shared_ptr<const mp::filter::Base > >::iterator it;
191 it = m_id_filter_map.find(refid_value);
192 if (it == m_id_filter_map.end())
193 throw mp::XMLError("Unknown filter refid "
196 route.m_list.push_back(it->second);
198 else if (type_value.length())
200 if (!m_factory->exist(type_value))
202 yaz_log(YLOG_LOG, "Loading %s (dlpath %s)",
203 type_value.c_str(), m_dl_path.c_str());
204 m_factory->add_creator_dl(type_value, m_dl_path);
206 boost::shared_ptr<mp::filter::Base>
207 filter_base(m_factory->create(type_value));
209 filter_base->configure(node, test_only, file_include_path);
211 route.m_list.push_back(filter_base);
215 node = mp::xml::jump_to_next(node, XML_ELEMENT_NODE);
220 void mp::RouterFleXML::Rep::parse_xml_routes(xmlDocPtr doc,
223 const char *file_include_path)
225 mp::xml::check_element_mp(node, "route");
227 unsigned int route_nr = 0;
228 while (mp::xml::is_element_mp(node, "route"))
232 const struct _xmlAttr *attr;
233 std::string id_value;
234 for (attr = node->properties; attr; attr = attr->next)
236 std::string name = std::string((const char *) attr->name);
239 if (attr->children && attr->children->type == XML_TEXT_NODE)
240 value = std::string((const char *)attr->children->content);
244 else if (name == "base")
245 ;// Ignore XInclude base attribute.
247 throw mp::XMLError("Only attribute 'id' allowed for"
254 // process <filter> / <filters> nodes in third level
255 const xmlNode* node3 = mp::xml::jump_to_children(node, XML_ELEMENT_NODE);
259 parse_xml_filters1(doc, node3, test_only, file_include_path, route);
261 std::map<std::string,RouterFleXML::Route>::iterator it;
262 it = m_routes.find(id_value);
263 if (it != m_routes.end())
264 throw mp::XMLError("Route id='" + id_value
265 + "' already exist");
267 m_routes[id_value] = route;
268 node = mp::xml::jump_to_next(node, XML_ELEMENT_NODE);
272 void mp::RouterFleXML::Rep::check_routes_in_filters(const xmlNode *node)
276 if (mp::xml::is_element_mp(node, "filters"))
279 mp::xml::jump_to_children(node, XML_ELEMENT_NODE);
280 check_routes_in_filters(n);
282 else if (mp::xml::is_element_mp(node, "filter"))
285 mp::xml::jump_to_children(node, XML_ELEMENT_NODE);
288 const struct _xmlAttr *attr;
289 // we assume thar that route attribute is only at one level
290 // below filter.. At least that works for multi and virt_db.
291 for (attr = n->properties; attr; attr = attr->next)
293 if (!strcmp((const char *) attr->name, "route"))
297 if (attr->children && attr->children->type == XML_TEXT_NODE)
298 value = std::string((const char *)attr->children->content);
300 std::map<std::string,RouterFleXML::Route>::iterator it;
301 it = m_routes.find(value);
302 if (it == m_routes.end())
304 throw mp::XMLError("Route '" + value + "' does not exist");
308 n = mp::xml::jump_to_next(n, XML_ELEMENT_NODE);
311 node = mp::xml::jump_to_next(node, XML_ELEMENT_NODE);
315 void mp::RouterFleXML::Rep::parse_xml_config_dom(xmlDocPtr doc,
317 const char *file_include_path)
320 throw mp::XMLError("Empty XML Document");
322 const xmlNode* root = xmlDocGetRootElement(doc);
324 if (file_include_path)
326 int r = yaz_xml_include_glob((xmlNode *) root, file_include_path,
327 YAZ_FILE_GLOB_FAIL_NOTEXIST);
329 throw mp::XMLError("YAZ XML Include failed");
332 mp::xml::check_element_mp(root, "metaproxy");
334 const xmlNode* node = mp::xml::jump_to_children(root, XML_ELEMENT_NODE);
336 if (mp::xml::is_element_mp(node, "dlpath"))
338 m_dl_path = mp::xml::get_text(node);
339 node = mp::xml::jump_to_next(node, XML_ELEMENT_NODE);
341 // process <start> node which is expected first element node
342 if (mp::xml::check_element_mp(node, "start"))
344 const struct _xmlAttr *attr;
345 for (attr = node->properties; attr; attr = attr->next)
347 std::string name = std::string((const char *) attr->name);
350 if (attr->children && attr->children->type == XML_TEXT_NODE)
351 value = std::string((const char *)attr->children->content);
354 m_start_route = value;
355 else if (name == "base")
356 ;// Ignore XInclude base attribute.
358 throw mp::XMLError("Only attribute route allowed"
359 " in element 'start'. Got " + name);
361 node = mp::xml::jump_to_next(node, XML_ELEMENT_NODE);
363 // process <filters> node if given
364 if (mp::xml::is_element_mp(node, "filters"))
366 parse_xml_filters(doc, mp::xml::jump_to_children(node,
368 test_only, file_include_path);
370 node = mp::xml::jump_to_next(node, XML_ELEMENT_NODE);
372 // process <routes> node which is expected third element node
373 mp::xml::check_element_mp(node, "routes");
375 parse_xml_routes(doc, mp::xml::jump_to_children(node, XML_ELEMENT_NODE),
376 test_only, file_include_path);
378 node = mp::xml::jump_to_next(node, XML_ELEMENT_NODE);
381 throw mp::XMLError("Unexpected element "
382 + std::string((const char *)node->name));
385 node = mp::xml::jump_to_children(root, XML_ELEMENT_NODE);
388 if (mp::xml::is_element_mp(node, "filters"))
389 check_routes_in_filters(
390 mp::xml::jump_to_children(node,
392 else if (mp::xml::is_element_mp(node, "routes"))
394 const xmlNode* n = mp::xml::jump_to_children(node,
398 if (mp::xml::is_element_mp(n, "route"))
400 check_routes_in_filters(
401 mp::xml::jump_to_children(n, XML_ELEMENT_NODE));
404 n = mp::xml::jump_to_next(n, XML_ELEMENT_NODE);
407 node = mp::xml::jump_to_next(node, XML_ELEMENT_NODE);
411 mp::RouterFleXML::Rep::Rep() : m_xinclude(false)
415 void mp::RouterFleXML::Rep::base(xmlDocPtr doc, mp::FactoryFilter &factory,
416 bool test_only, const char *file_include_path)
418 m_factory = &factory;
419 parse_xml_config_dom(doc, test_only, file_include_path);
420 m_start_route = "start";
423 mp::RouterFleXML::RouterFleXML(xmlDocPtr doc, mp::FactoryFilter &factory,
424 bool test_only, const char *file_include_path)
427 m_p->base(doc, factory, test_only, file_include_path);
430 mp::RouterFleXML::RouterFleXML(std::string xmlconf, mp::FactoryFilter &factory,
434 xmlDocPtr doc = xmlParseMemory(xmlconf.c_str(),
437 throw mp::XMLError("xmlParseMemory failed");
440 m_p->base(doc, factory, test_only, 0);
445 mp::RouterFleXML::~RouterFleXML()
449 const mp::filter::Base *mp::RouterFleXML::Pos::move(const char *route)
453 //std::cout << "move to " << route << "\n";
454 m_route_it = m_p->m_routes.find(route);
455 if (m_route_it == m_p->m_routes.end())
457 std::cout << "no such route " << route << "\n";
458 throw mp::XMLError("bad route " + std::string(route));
460 m_filter_it = m_route_it->second.m_list.begin();
462 if (m_filter_it == m_route_it->second.m_list.end())
464 const mp::filter::Base *f = (*m_filter_it).get();
469 mp::RoutePos *mp::RouterFleXML::createpos() const
471 mp::RouterFleXML::Pos *p = new mp::RouterFleXML::Pos;
473 p->m_route_it = m_p->m_routes.find(m_p->m_start_route);
474 if (p->m_route_it == m_p->m_routes.end())
479 p->m_filter_it = p->m_route_it->second.m_list.begin();
484 mp::RoutePos *mp::RouterFleXML::Pos::clone()
486 mp::RouterFleXML::Pos *p = new mp::RouterFleXML::Pos;
487 p->m_filter_it = m_filter_it;
488 p->m_route_it = m_route_it;
493 mp::RouterFleXML::Pos::~Pos()
498 void mp::RouterFleXML::start()
500 std::map<std::string,RouterFleXML::Route>::iterator route_it;
502 route_it = m_p->m_routes.begin();
503 while (route_it != m_p->m_routes.end())
505 RouterFleXML::Route route = route_it->second;
507 std::list<boost::shared_ptr<const mp::filter::Base> >::iterator it;
509 for (it = route.m_list.begin(); it != route.m_list.end(); it++)
515 void mp::RouterFleXML::stop(int signo)
517 std::map<std::string,RouterFleXML::Route>::iterator route_it;
519 route_it = m_p->m_routes.begin();
520 while (route_it != m_p->m_routes.end())
522 RouterFleXML::Route route = route_it->second;
524 std::list<boost::shared_ptr<const mp::filter::Base> >::iterator it;
526 for (it = route.m_list.begin(); it != route.m_list.end(); it++)
536 * c-file-style: "Stroustrup"
537 * indent-tabs-mode: nil
539 * vim: shiftwidth=4 tabstop=8 expandtab