-/*\r
- * Copyright 2001-2006 Internet2\r
- * \r
- * Licensed under the Apache License, Version 2.0 (the "License");\r
- * you may not use this file except in compliance with the License.\r
- * You may obtain a copy of the License at\r
- *\r
- * http://www.apache.org/licenses/LICENSE-2.0\r
- *\r
- * Unless required by applicable law or agreed to in writing, software\r
- * distributed under the License is distributed on an "AS IS" BASIS,\r
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
- * See the License for the specific language governing permissions and\r
- * limitations under the License.\r
- */\r
-\r
-/**\r
- * @file ParserPool.h\r
- * \r
- * XML parsing\r
- */\r
-\r
-#if !defined(__xmltooling_pool_h__)\r
-#define __xmltooling_pool_h__\r
-\r
-#include <xmltooling/unicode.h>\r
-\r
-#include <map>\r
-#include <stack>\r
-#include <istream>\r
-#include <xercesc/dom/DOM.hpp>\r
-#include <xercesc/sax/InputSource.hpp>\r
-#include <xercesc/util/BinInputStream.hpp>\r
-\r
-using namespace xercesc;\r
-\r
-#if defined (_MSC_VER)\r
- #pragma warning( push )\r
- #pragma warning( disable : 4250 4251 )\r
-#endif\r
-\r
-namespace xmltooling {\r
-\r
- /**\r
- * A thread-safe pool of DOMBuilders that share characteristics\r
- */\r
- class XMLTOOL_API ParserPool : public DOMEntityResolver, DOMErrorHandler\r
- {\r
- MAKE_NONCOPYABLE(ParserPool);\r
- public:\r
- /**\r
- * Constructs a new pool\r
- * \r
- * @param namespaceAware indicates whether parsers should be namespace-aware or not\r
- * @param schemaAware indicates whether parsers should be schema-validating or not\r
- */\r
- ParserPool(bool namespaceAware=true, bool schemaAware=false);\r
- ~ParserPool();\r
-\r
- /**\r
- * Creates a new document using a parser from this pool.\r
- * \r
- * @return new XML document\r
- * \r
- */\r
- DOMDocument* newDocument();\r
-\r
- /**\r
- * Parses a document using a pooled parser with the proper settings\r
- * \r
- * @param domsrc A DOM source containing the content to be parsed\r
- * @return The DOM document resulting from the parse\r
- * @throws XMLParserException thrown if there was a problem reading, parsing, or validating the XML\r
- */\r
- DOMDocument* parse(DOMInputSource& domsrc);\r
-\r
- /**\r
- * Parses a document using a pooled parser with the proper settings\r
- * \r
- * @param is An input stream containing the content to be parsed\r
- * @return The DOM document resulting from the parse\r
- * @throws XMLParserException thrown if there was a problem reading, parsing, or validating the XML\r
- */\r
- DOMDocument* parse(std::istream& is);\r
-\r
- /**\r
- * Load an OASIS catalog file to map schema namespace URIs to filenames.\r
- * \r
- * This does not provide real catalog support; only the <uri> element\r
- * is supported to map from a namespace URI to a relative path or file:// URI.\r
- * \r
- * @param pathname path to a catalog file\r
- * @return true iff the catalog was successfully processed\r
- */\r
- bool loadCatalog(const XMLCh* pathname);\r
- \r
- /**\r
- * Load a schema explicitly from a local file.\r
- * \r
- * Note that "successful processing" does not imply that the schema is valid,\r
- * only that a reference to it was successfully registered with the pool.\r
- * \r
- * @param nsURI XML namespace to load\r
- * @param pathname path to schema file\r
- * @return true iff the schema was successfully processed\r
- */\r
- bool loadSchema(const XMLCh* nsURI, const XMLCh* pathname);\r
-\r
- /**\r
- * Supplies all external entities (primarily schemas) to the parser\r
- */\r
- DOMInputSource* resolveEntity(const XMLCh* const publicId, const XMLCh* const systemId, const XMLCh* const baseURI);\r
-\r
- /**\r
- * Handles parsing errors\r
- */\r
- bool handleError(const DOMError& e);\r
-\r
- private:\r
- DOMBuilder* createBuilder();\r
- DOMBuilder* checkoutBuilder();\r
- void checkinBuilder(DOMBuilder* builder);\r
-\r
-#ifdef HAVE_GOOD_STL\r
- xstring m_schemaLocations;\r
- std::map<xstring,xstring> m_schemaLocMap;\r
-#else\r
- std::string m_schemaLocations;\r
- std::map<std::string,std::string> m_schemaLocMap;\r
-#endif\r
- bool m_namespaceAware,m_schemaAware;\r
- std::stack<DOMBuilder*> m_pool;\r
- void* m_lock;\r
- };\r
-\r
- /**\r
- * A parser source that wraps a C++ input stream\r
- */\r
- class XMLTOOL_API StreamInputSource : public InputSource\r
- {\r
- MAKE_NONCOPYABLE(StreamInputSource);\r
- public:\r
- /**\r
- * Constructs an input source around an input stream reference.\r
- * \r
- * @param is reference to an input stream\r
- * @param systemId optional system identifier to attach to the stream\r
- */\r
- StreamInputSource(std::istream& is, const char* systemId=NULL) : InputSource(systemId), m_is(is) {}\r
- /// @cond off\r
- virtual BinInputStream* makeStream() const { return new StreamBinInputStream(m_is); }\r
- /// @endcond\r
-\r
- /**\r
- * A Xerces input stream that wraps a C++ input stream\r
- */\r
- class XMLTOOL_API StreamBinInputStream : public BinInputStream\r
- {\r
- public:\r
- /**\r
- * Constructs a Xerces input stream around a C++ input stream reference.\r
- * \r
- * @param is reference to an input stream\r
- */\r
- StreamBinInputStream(std::istream& is) : m_is(is), m_pos(0) {}\r
- /// @cond off\r
- virtual unsigned int curPos() const { return m_pos; }\r
- virtual unsigned int readBytes(XMLByte* const toFill, const unsigned int maxToRead);\r
- /// @endcond\r
- private:\r
- std::istream& m_is;\r
- unsigned int m_pos;\r
- };\r
-\r
- private:\r
- std::istream& m_is;\r
- };\r
-};\r
-\r
-#if defined (_MSC_VER)\r
- #pragma warning( pop )\r
-#endif\r
-\r
-#endif /* __xmltooling_pool_h__ */\r
+/**
+ * Licensed to the University Corporation for Advanced Internet
+ * Development, Inc. (UCAID) under one or more contributor license
+ * agreements. See the NOTICE file distributed with this work for
+ * additional information regarding copyright ownership.
+ *
+ * UCAID licenses this file to you under the Apache License,
+ * Version 2.0 (the "License"); you may not use this file except
+ * in compliance with the License. You may obtain a copy of the
+ * License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
+ * either express or implied. See the License for the specific
+ * language governing permissions and limitations under the License.
+ */
+
+/**
+ * @file xmltooling/util/ParserPool.h
+ *
+ * A thread-safe pool of parsers that share characteristics.
+ */
+
+#ifndef __xmltooling_pool_h__
+#define __xmltooling_pool_h__
+
+#include <xmltooling/unicode.h>
+
+#include <map>
+#include <stack>
+#include <string>
+#include <istream>
+#include <xercesc/dom/DOM.hpp>
+#include <xercesc/sax/InputSource.hpp>
+#include <xercesc/util/BinInputStream.hpp>
+#include <xercesc/util/SecurityManager.hpp>
+#include <xercesc/util/XMLURL.hpp>
+
+#ifndef XMLTOOLING_NO_XMLSEC
+# include <xsec/framework/XSECDefs.hpp>
+#endif
+
+#if defined (_MSC_VER)
+ #pragma warning( push )
+ #pragma warning( disable : 4250 4251 )
+#endif
+
+namespace xmltooling {
+
+ class XMLTOOL_API Mutex;
+
+ /**
+ * A thread-safe pool of DOMBuilders that share characteristics.
+ */
+ class XMLTOOL_API ParserPool :
+#ifdef XMLTOOLING_XERCESC_COMPLIANT_DOMLS
+ public xercesc::DOMLSResourceResolver
+#else
+ public xercesc::DOMEntityResolver
+#endif
+ {
+ MAKE_NONCOPYABLE(ParserPool);
+ public:
+ /**
+ * Constructs a new pool
+ *
+ * @param namespaceAware indicates whether parsers should be namespace-aware or not
+ * @param schemaAware indicates whether parsers should be schema-validating or not
+ */
+ ParserPool(bool namespaceAware=true, bool schemaAware=false);
+ ~ParserPool();
+
+ /**
+ * Creates a new document using a parser from this pool.
+ *
+ * @return new XML document
+ *
+ */
+ xercesc::DOMDocument* newDocument();
+
+ /**
+ * Parses a document using a pooled parser with the proper settings
+ *
+ * @param domsrc An input source containing the content to be parsed
+ * @return The DOM document resulting from the parse
+ * @throws XMLParserException thrown if there was a problem reading, parsing, or validating the XML
+ */
+ xercesc::DOMDocument* parse(
+#ifdef XMLTOOLING_XERCESC_COMPLIANT_DOMLS
+ xercesc::DOMLSInput& domsrc
+#else
+ xercesc::DOMInputSource& domsrc
+#endif
+ );
+
+ /**
+ * Parses a document using a pooled parser with the proper settings
+ *
+ * @param is An input stream containing the content to be parsed
+ * @return The DOM document resulting from the parse
+ * @throws XMLParserException thrown if there was a problem reading, parsing, or validating the XML
+ */
+ xercesc::DOMDocument* parse(std::istream& is);
+
+ /**
+ * Load an OASIS catalog file to map schema namespace URIs to filenames.
+ *
+ * This does not provide real catalog support; only the <uri> element
+ * is supported to map from a namespace URI to a relative path or file:// URI.
+ *
+ * @param pathname path to a catalog file
+ * @return true iff the catalog was successfully processed
+ */
+ bool loadCatalog(const XMLCh* pathname);
+
+ /**
+ * Load a schema explicitly from a local file.
+ *
+ * Note that "successful processing" does not imply that the schema is valid,
+ * only that a reference to it was successfully registered with the pool.
+ *
+ * @param nsURI XML namespace to load
+ * @param pathname path to schema file
+ * @return true iff the schema was successfully processed
+ */
+ bool loadSchema(const XMLCh* nsURI, const XMLCh* pathname);
+
+ /**
+ * Supplies all external entities (primarily schemas) to the parser
+ */
+#ifdef XMLTOOLING_XERCESC_COMPLIANT_DOMLS
+ xercesc::DOMLSInput* resolveResource(
+ const XMLCh *const resourceType,
+ const XMLCh *const namespaceUri,
+ const XMLCh *const publicId,
+ const XMLCh *const systemId,
+ const XMLCh *const baseURI
+ );
+#else
+ xercesc::DOMInputSource* resolveEntity(
+ const XMLCh* const publicId, const XMLCh* const systemId, const XMLCh* const baseURI
+ );
+#endif
+
+ private:
+#ifdef XMLTOOLING_XERCESC_COMPLIANT_DOMLS
+ xercesc::DOMLSParser* createBuilder();
+ xercesc::DOMLSParser* checkoutBuilder();
+ void checkinBuilder(xercesc::DOMLSParser* builder);
+#else
+ xercesc::DOMBuilder* createBuilder();
+ xercesc::DOMBuilder* checkoutBuilder();
+ void checkinBuilder(xercesc::DOMBuilder* builder);
+#endif
+
+ xstring m_schemaLocations;
+ std::map<xstring,xstring> m_schemaLocMap;
+
+ bool m_namespaceAware,m_schemaAware;
+#ifdef XMLTOOLING_XERCESC_COMPLIANT_DOMLS
+ std::stack<xercesc::DOMLSParser*> m_pool;
+#else
+ std::stack<xercesc::DOMBuilder*> m_pool;
+#endif
+ Mutex* m_lock;
+ xercesc::SecurityManager* m_security;
+ };
+
+ /**
+ * A parser source that wraps a C++ input stream
+ */
+ class XMLTOOL_API StreamInputSource : public xercesc::InputSource
+ {
+ MAKE_NONCOPYABLE(StreamInputSource);
+ public:
+ /**
+ * Constructs an input source around an input stream reference.
+ *
+ * @param is reference to an input stream
+ * @param systemId optional system identifier to attach to the stream
+ */
+ StreamInputSource(std::istream& is, const char* systemId=nullptr);
+ /// @cond off
+ xercesc::BinInputStream* makeStream() const;
+ /// @endcond
+
+ /**
+ * A Xerces input stream that wraps a C++ input stream
+ */
+ class XMLTOOL_API StreamBinInputStream : public xercesc::BinInputStream
+ {
+ public:
+ /**
+ * Constructs a Xerces input stream around a C++ input stream reference.
+ *
+ * @param is reference to an input stream
+ */
+ StreamBinInputStream(std::istream& is);
+ /// @cond off
+#ifdef XMLTOOLING_XERCESC_64BITSAFE
+ XMLFilePos curPos() const;
+ const XMLCh* getContentType() const;
+#else
+ unsigned int curPos() const;
+#endif
+ xsecsize_t readBytes(XMLByte* const toFill, const xsecsize_t maxToRead);
+ /// @endcond
+ private:
+ std::istream& m_is;
+ xsecsize_t m_pos;
+ };
+
+ private:
+ std::istream& m_is;
+ };
+
+ /**
+ * A URL-based parser source that supports a more advanced input stream.
+ */
+ class XMLTOOL_API URLInputSource : public xercesc::InputSource
+ {
+ MAKE_NONCOPYABLE(URLInputSource);
+ public:
+ /**
+ * Constructor.
+ *
+ * @param url source of input
+ * @param systemId optional system identifier to attach to the source
+ * @param cacheTag optional pointer to string used for cache management
+ */
+ URLInputSource(const XMLCh* url, const char* systemId=nullptr, std::string* cacheTag=nullptr);
+
+ /**
+ * Constructor taking a DOM element supporting the following content:
+ *
+ * <dl>
+ * <dt>uri | url</dt>
+ * <dd>identifies the remote resource</dd>
+ * <dt>verifyHost</dt>
+ * <dd>true iff name of host should be matched against TLS/SSL certificate</dd>
+ * <dt>TransportOption elements, like so:</dt>
+ * <dd><TransportOption provider="CURL" option="150">0</TransportOption></dd>
+ * </dl>
+ *
+ * @param e DOM to supply configuration
+ * @param systemId optional system identifier to attach to the source
+ * @param cacheTag optional pointer to string used for cache management
+ */
+ URLInputSource(const xercesc::DOMElement* e, const char* systemId=nullptr, std::string* cacheTag=nullptr);
+
+ /// @cond off
+ virtual xercesc::BinInputStream* makeStream() const;
+ /// @endcond
+
+ /** Element name used to signal a non-successful response when fetching a remote document. */
+ static const char asciiStatusCodeElementName[];
+
+ /** Element name used to signal a non-successful response when fetching a remote document. */
+ static const XMLCh utf16StatusCodeElementName[];
+ private:
+#ifdef XMLTOOLING_LITE
+ xercesc::XMLURL m_url;
+#else
+ std::string* m_cacheTag;
+ xmltooling::auto_ptr_char m_url;
+ const xercesc::DOMElement* m_root;
+#endif
+ };
+};
+
+#if defined (_MSC_VER)
+ #pragma warning( pop )
+#endif
+
+#endif /* __xmltooling_pool_h__ */
projects / shibboleth / cpp-xmltooling.git / blobdiff