1 /****************************************************************************
2 **
3 ** Copyright (C) 2015 The Qt Company Ltd.
4 ** Contact: http://www.qt.io/licensing/
5 **
6 ** This file is part of the QtXmlPatterns module of the Qt Toolkit.
7 **
8 ** $QT_BEGIN_LICENSE:LGPL$
9 ** Commercial License Usage
10 ** Licensees holding valid commercial Qt licenses may use this file in
11 ** accordance with the commercial license agreement provided with the
12 ** Software or, alternatively, in accordance with the terms contained in
13 ** a written agreement between you and The Qt Company. For licensing terms
14 ** and conditions see http://www.qt.io/terms-conditions. For further
15 ** information use the contact form at http://www.qt.io/contact-us.
16 **
17 ** GNU Lesser General Public License Usage
18 ** Alternatively, this file may be used under the terms of the GNU Lesser
19 ** General Public License version 2.1 or version 3 as published by the Free
20 ** Software Foundation and appearing in the file LICENSE.LGPLv21 and
21 ** LICENSE.LGPLv3 included in the packaging of this file. Please review the
22 ** following information to ensure the GNU Lesser General Public License
23 ** requirements will be met: https://www.gnu.org/licenses/lgpl.html and
24 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
25 **
26 ** As a special exception, The Qt Company gives you certain additional
27 ** rights. These rights are described in The Qt Company LGPL Exception
28 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
29 **
30 ** GNU General Public License Usage
31 ** Alternatively, this file may be used under the terms of the GNU
32 ** General Public License version 3.0 as published by the Free Software
33 ** Foundation and appearing in the file LICENSE.GPL included in the
34 ** packaging of this file. Please review the following information to
35 ** ensure the GNU General Public License version 3.0 requirements will be
36 ** met: http://www.gnu.org/copyleft/gpl.html.
37 **
38 ** $QT_END_LICENSE$
39 **
40 ****************************************************************************/
41
42 #include "qxmlschemavalidator.h"
43 #include "qxmlschemavalidator_p.h"
44
45 #include "qacceltreeresourceloader_p.h"
46 #include "qxmlschema.h"
47 #include "qxmlschema_p.h"
48 #include "qxsdvalidatinginstancereader_p.h"
49
50 #include <QtCore/QBuffer>
51 #include <QtCore/QIODevice>
52 #include <QtCore/QUrl>
53
54 QT_BEGIN_NAMESPACE
55
56 /*!
57 \class QXmlSchemaValidator
58
59 \brief The QXmlSchemaValidator class validates XML instance documents against a W3C XML Schema.
60
61 \reentrant
62 \since 4.6
63 \ingroup xml-tools
64
65 The QXmlSchemaValidator class loads, parses an XML instance document and validates it
66 against a W3C XML Schema that has been compiled with \l{QXmlSchema}.
67
68 The following example shows how to load a XML Schema from a local
69 file, check whether it is a valid schema document and use it for validation
70 of an XML instance document:
71
72 \snippet doc/src/snippets/qxmlschemavalidator/main.cpp 3
73
74 \section1 XML Schema Version
75
76 This class implements schema validation according to the \l{XML Schema} 1.0
77 specification.
78
79 \sa QXmlSchema, {xmlpatterns/schema}{XML Schema Validation Example}
80 */
81
82 /*!
83 Constructs a schema validator.
84 The schema used for validation must be referenced in the XML instance document
85 via the \c xsi:schemaLocation or \c xsi:noNamespaceSchemaLocation attribute.
86 */
QXmlSchemaValidator()87 QXmlSchemaValidator::QXmlSchemaValidator()
88 : d(new QXmlSchemaValidatorPrivate(QXmlSchema()))
89 {
90 }
91
92 /*!
93 Constructs a schema validator that will use \a schema for validation.
94 If an empty \l {QXmlSchema} schema is passed to the validator, the schema used
95 for validation must be referenced in the XML instance document
96 via the \c xsi:schemaLocation or \c xsi:noNamespaceSchemaLocation attribute.
97 */
QXmlSchemaValidator(const QXmlSchema & schema)98 QXmlSchemaValidator::QXmlSchemaValidator(const QXmlSchema &schema)
99 : d(new QXmlSchemaValidatorPrivate(schema))
100 {
101 }
102
103 /*!
104 Destroys this QXmlSchemaValidator.
105 */
~QXmlSchemaValidator()106 QXmlSchemaValidator::~QXmlSchemaValidator()
107 {
108 delete d;
109 }
110
111 /*!
112 Sets the \a schema that shall be used for further validation.
113 If the schema is empty, the schema used for validation must be referenced
114 in the XML instance document via the \c xsi:schemaLocation or
115 \c xsi:noNamespaceSchemaLocation attribute.
116 */
setSchema(const QXmlSchema & schema)117 void QXmlSchemaValidator::setSchema(const QXmlSchema &schema)
118 {
119 d->setSchema(schema);
120 }
121
122 /*!
123 Validates the XML instance document read from \a data with the
124 given \a documentUri against the schema.
125
126 Returns \c true if the XML instance document is valid according to the
127 schema, \c false otherwise.
128
129 Example:
130
131 \snippet doc/src/snippets/qxmlschemavalidator/main.cpp 2
132 */
validate(const QByteArray & data,const QUrl & documentUri) const133 bool QXmlSchemaValidator::validate(const QByteArray &data, const QUrl &documentUri) const
134 {
135 QByteArray localData(data);
136
137 QBuffer buffer(&localData);
138 buffer.open(QIODevice::ReadOnly);
139
140 return validate(&buffer, documentUri);
141 }
142
143 /*!
144 Validates the XML instance document read from \a source against the schema.
145
146 Returns \c true if the XML instance document is valid according to the
147 schema, \c false otherwise.
148
149 Example:
150
151 \snippet doc/src/snippets/qxmlschemavalidator/main.cpp 0
152 */
validate(const QUrl & source) const153 bool QXmlSchemaValidator::validate(const QUrl &source) const
154 {
155 d->m_context->setMessageHandler(messageHandler());
156 d->m_context->setUriResolver(uriResolver());
157 d->m_context->setNetworkAccessManager(networkAccessManager());
158
159 const QPatternist::AutoPtr<QNetworkReply> reply(QPatternist::AccelTreeResourceLoader::load(source, d->m_context->networkAccessManager(),
160 d->m_context, QPatternist::AccelTreeResourceLoader::ContinueOnError));
161 if (reply)
162 return validate(reply.data(), source);
163 else
164 return false;
165 }
166
167 /*!
168 Validates the XML instance document read from \a source with the
169 given \a documentUri against the schema.
170
171 Returns \c true if the XML instance document is valid according to the
172 schema, \c false otherwise.
173
174 Example:
175
176 \snippet doc/src/snippets/qxmlschemavalidator/main.cpp 1
177 */
validate(QIODevice * source,const QUrl & documentUri) const178 bool QXmlSchemaValidator::validate(QIODevice *source, const QUrl &documentUri) const
179 {
180 if (!source) {
181 qWarning("A null QIODevice pointer cannot be passed.");
182 return false;
183 }
184
185 if (!source->isReadable()) {
186 qWarning("The device must be readable.");
187 return false;
188 }
189
190 const QUrl normalizedUri = QPatternist::XPathHelper::normalizeQueryURI(documentUri);
191
192 d->m_context->setMessageHandler(messageHandler());
193 d->m_context->setUriResolver(uriResolver());
194 d->m_context->setNetworkAccessManager(networkAccessManager());
195
196 QPatternist::NetworkAccessDelegator::Ptr delegator(new QPatternist::NetworkAccessDelegator(d->m_context->networkAccessManager(),
197 d->m_context->networkAccessManager()));
198
199 QPatternist::AccelTreeResourceLoader loader(d->m_context->namePool(), delegator, QPatternist::AccelTreeBuilder<true>::SourceLocationsFeature);
200
201 QPatternist::Item item;
202 try {
203 item = loader.openDocument(source, normalizedUri, d->m_context);
204 } catch (QPatternist::Exception exception) {
205 Q_UNUSED(exception);
206 return false;
207 }
208
209 const QAbstractXmlNodeModel *model = item.asNode().model();
210
211 QPatternist::XsdValidatedXmlNodeModel *validatedModel = new QPatternist::XsdValidatedXmlNodeModel(model);
212
213 QPatternist::XsdValidatingInstanceReader reader(validatedModel, normalizedUri, d->m_context);
214 if (d->m_schema)
215 reader.addSchema(d->m_schema, d->m_schemaDocumentUri);
216 try {
217 reader.read();
218 } catch (QPatternist::Exception exception) {
219 Q_UNUSED(exception);
220 return false;
221 }
222
223 return true;
224 }
225
226 /*!
227 Returns the name pool used by this QXmlSchemaValidator for constructing \l
228 {QXmlName} {names}. There is no setter for the name pool, because
229 mixing name pools causes errors due to name confusion.
230 */
namePool() const231 QXmlNamePool QXmlSchemaValidator::namePool() const
232 {
233 return d->m_namePool;
234 }
235
236 /*!
237 Returns the schema that is used for validation.
238 */
schema() const239 QXmlSchema QXmlSchemaValidator::schema() const
240 {
241 return d->m_originalSchema;
242 }
243
244 /*!
245 Changes the \l {QAbstractMessageHandler}{message handler} for this
246 QXmlSchemaValidator to \a handler. The schema validator sends all parsing and
247 validation messages to this message handler. QXmlSchemaValidator does not take
248 ownership of \a handler.
249
250 Normally, the default message handler is sufficient. It writes
251 compile and validation messages to \e stderr. The default message
252 handler includes color codes if \e stderr can render colors.
253
254 When QXmlSchemaValidator calls QAbstractMessageHandler::message(),
255 the arguments are as follows:
256
257 \table
258 \header
259 \o message() argument
260 \o Semantics
261 \row
262 \o QtMsgType type
263 \o Only QtWarningMsg and QtFatalMsg are used. The former
264 identifies a warning, while the latter identifies an error.
265 \row
266 \o const QString & description
267 \o An XHTML document which is the actual message. It is translated
268 into the current language.
269 \row
270 \o const QUrl &identifier
271 \o Identifies the error with a URI, where the fragment is
272 the error code, and the rest of the URI is the error namespace.
273 \row
274 \o const QSourceLocation & sourceLocation
275 \o Identifies where the error occurred.
276 \endtable
277
278 */
setMessageHandler(QAbstractMessageHandler * handler)279 void QXmlSchemaValidator::setMessageHandler(QAbstractMessageHandler *handler)
280 {
281 d->m_userMessageHandler = handler;
282 }
283
284 /*!
285 Returns the message handler that handles parsing and validation
286 messages for this QXmlSchemaValidator.
287 */
messageHandler() const288 QAbstractMessageHandler *QXmlSchemaValidator::messageHandler() const
289 {
290 if (d->m_userMessageHandler)
291 return d->m_userMessageHandler;
292
293 return d->m_messageHandler.data()->value;
294 }
295
296 /*!
297 Sets the URI resolver to \a resolver. QXmlSchemaValidator does not take
298 ownership of \a resolver.
299
300 \sa uriResolver()
301 */
setUriResolver(const QAbstractUriResolver * resolver)302 void QXmlSchemaValidator::setUriResolver(const QAbstractUriResolver *resolver)
303 {
304 d->m_uriResolver = resolver;
305 }
306
307 /*!
308 Returns the schema's URI resolver. If no URI resolver has been set,
309 QtXmlPatterns will use the URIs in instance documents as they are.
310
311 The URI resolver provides a level of abstraction, or \e{polymorphic
312 URIs}. A resolver can rewrite \e{logical} URIs to physical ones, or
313 it can translate obsolete or invalid URIs to valid ones.
314
315 When QtXmlPatterns calls QAbstractUriResolver::resolve() the
316 absolute URI is the URI mandated by the schema specification, and the
317 relative URI is the URI specified by the user.
318
319 \sa setUriResolver()
320 */
uriResolver() const321 const QAbstractUriResolver *QXmlSchemaValidator::uriResolver() const
322 {
323 return d->m_uriResolver;
324 }
325
326 /*!
327 Sets the network manager to \a manager.
328 QXmlSchemaValidator does not take ownership of \a manager.
329
330 \sa networkAccessManager()
331 */
setNetworkAccessManager(QNetworkAccessManager * manager)332 void QXmlSchemaValidator::setNetworkAccessManager(QNetworkAccessManager *manager)
333 {
334 d->m_userNetworkAccessManager = manager;
335 }
336
337 /*!
338 Returns the network manager, or 0 if it has not been set.
339
340 \sa setNetworkAccessManager()
341 */
networkAccessManager() const342 QNetworkAccessManager *QXmlSchemaValidator::networkAccessManager() const
343 {
344 if (d->m_userNetworkAccessManager)
345 return d->m_userNetworkAccessManager;
346
347 return d->m_networkAccessManager.data()->value;
348 }
349
350 QT_END_NAMESPACE
351