elexis
93fed19c6a
Don't write XMB files for XML files that failed the validation,
otherwise the XML validation error will not be reported on consecutive
program starts anymore (as the XMB is loaded, skipping validation).
This had resulted in invalid XML going unnoticed and committed in
credentials.xml in 80dbd1f2a3.
Differential Revision: https://code.wildfiregames.com/D1574
Reported by: gameboy
Comments By: bb
Tested on: clang 8.0.1, Jenkins
This was SVN commit r22921.
105 lines
3.2 KiB
C++
105 lines
3.2 KiB
C++
/* Copyright (C) 2015 Wildfire Games.
|
|
* This file is part of 0 A.D.
|
|
*
|
|
* 0 A.D. is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation, either version 2 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* 0 A.D. is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with 0 A.D. If not, see <http://www.gnu.org/licenses/>.
|
|
*/
|
|
|
|
/*
|
|
Xeromyces file-loading interface.
|
|
Automatically creates and caches relatively
|
|
efficient binary representations of XML files.
|
|
*/
|
|
|
|
#ifndef INCLUDED_XEROMYCES
|
|
#define INCLUDED_XEROMYCES
|
|
|
|
#include "ps/Errors.h"
|
|
ERROR_GROUP(Xeromyces);
|
|
ERROR_TYPE(Xeromyces, XMLOpenFailed);
|
|
ERROR_TYPE(Xeromyces, XMLParseError);
|
|
ERROR_TYPE(Xeromyces, XMLValidationFailed);
|
|
|
|
#include "XeroXMB.h"
|
|
|
|
#include "lib/file/vfs/vfs.h"
|
|
|
|
class RelaxNGValidator;
|
|
class WriteBuffer;
|
|
|
|
typedef struct _xmlDoc xmlDoc;
|
|
typedef xmlDoc* xmlDocPtr;
|
|
|
|
class CXeromyces : public XMBFile
|
|
{
|
|
friend class TestXeroXMB;
|
|
public:
|
|
/**
|
|
* Load from an XML file (with invisible XMB caching).
|
|
*/
|
|
PSRETURN Load(const PIVFS& vfs, const VfsPath& filename, const std::string& validatorName = "");
|
|
|
|
/**
|
|
* Load from an in-memory XML string (with no caching).
|
|
*/
|
|
PSRETURN LoadString(const char* xml, const std::string& validatorName = "");
|
|
|
|
/**
|
|
* Convert the given XML file into an XMB in the archive cache.
|
|
* Returns the XMB path in @p archiveCachePath.
|
|
* Returns false on error.
|
|
*/
|
|
bool GenerateCachedXMB(const PIVFS& vfs, const VfsPath& sourcePath, VfsPath& archiveCachePath, const std::string& validatorName = "");
|
|
|
|
/**
|
|
* Call once when initialising the program, to load libxml2.
|
|
* This should be run in the main thread, before any thread uses libxml2.
|
|
*/
|
|
static void Startup();
|
|
|
|
/**
|
|
* Call once when shutting down the program, to unload libxml2.
|
|
*/
|
|
static void Terminate();
|
|
|
|
static bool AddValidator(const PIVFS& vfs, const std::string& name, const VfsPath& grammarPath);
|
|
|
|
static bool ValidateEncoded(const std::string& name, const std::wstring& filename, const std::string& document);
|
|
|
|
private:
|
|
static RelaxNGValidator& GetValidator(const std::string& name);
|
|
|
|
PSRETURN ConvertFile(const PIVFS& vfs, const VfsPath& filename, const VfsPath& xmbPath, const std::string& validatorName);
|
|
|
|
bool ReadXMBFile(const PIVFS& vfs, const VfsPath& filename);
|
|
|
|
static PSRETURN CreateXMB(const xmlDocPtr doc, WriteBuffer& writeBuffer);
|
|
|
|
shared_ptr<u8> m_XMBBuffer;
|
|
};
|
|
|
|
|
|
#define _XERO_MAKE_UID2__(p,l) p ## l
|
|
#define _XERO_MAKE_UID1__(p,l) _XERO_MAKE_UID2__(p,l)
|
|
|
|
#define _XERO_CHILDREN _XERO_MAKE_UID1__(_children_, __LINE__)
|
|
#define _XERO_I _XERO_MAKE_UID1__(_i_, __LINE__)
|
|
|
|
#define XERO_ITER_EL(parent_element, child_element) \
|
|
for (XMBElement child_element : parent_element.GetChildNodes())
|
|
|
|
#define XERO_ITER_ATTR(parent_element, attribute) \
|
|
for (XMBAttribute attribute : parent_element.GetAttributes())
|
|
|
|
#endif // INCLUDED_XEROMYCES
|