pugixml.cpp

Go to the documentation of this file.

/*
 * The ManaPlus Client
 * Copyright (C) 2004-2009 The Mana World Development Team
 * Copyright (C) 2009-2010 The Mana Developers
 * Copyright (C) 2011-2019 The ManaPlus Developers
 * Copyright (C) 2019-2021 Andrei Karas
 *
 * This file is part of The ManaPlus Client.
 *
 * This program 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
 * any later version.
 *
 * This program 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 this program. If not, see <http://www.gnu.org/licenses/>.
 */
 
#ifdef ENABLE_PUGIXML
 
#include "utils/xml/pugixml.h"
 
#include "fs/virtfs/fs.h"
 
#include "utils/cast.h"
#include "utils/checkutils.h"
#include "utils/delete2.h"
#include "utils/fuzzer.h"
#include "utils/stringutils.h"
 
#include "utils/translation/podict.h"
 
#include <fstream>
 
#include "debug.h"
 
namespace
{
 bool valid = false;
} // namespace
 
namespace XML
{
 static void showErrorStatus(pugi::xml_parse_result &result)
 {
/*
 switch (result.status)
 {
 case pugi::status_ok:
 break;
 case pugi::status_file_not_found:
 logger->log("xml error: %s", result.description());
 break;
 }
*/
 logger->log("xml error: %s", result.description());
 }
 
 Document::Document(const std::string &filename,
 const UseVirtFs useResman,
 const SkipError skipError) :
 Resource(),
 mDoc(),
 mData(nullptr),
 mIsValid(false)
 {
#ifdef USE_FUZZER
 if (Fuzzer::conditionTerminate(filename.c_str()))
 return;
#endif // USE_FUZZER
 
 BLOCK_START("XML::Document::Document")
 int size = 0;
 char *data = nullptr;
 valid = true;
 if (useResman == UseVirtFs_true)
 {
 data = const_cast<char*>(VirtFs::loadFile(
 filename.c_str(),
 size));
 }
 else
 {
 std::ifstream file;
 file.open(filename.c_str(), std::ios::in);
 
 if (file.is_open())
 {
 // Get length of file
 file.seekg(0, std::ios::end);
 size = CAST_S32(file.tellg());
 if (size < 0)
 {
 reportAlways("Error loading XML file %s",
 filename.c_str())
 }
 else
 {
 file.seekg(0, std::ios::beg);
 data = new char[size];
 file.read(data, size);
 }
 file.close();
 }
 else if (skipError == SkipError_false)
 {
 reportAlways("Error loading XML file %s",
 filename.c_str())
 }
 }
 
 if (data)
 {
 // +++ use other pugi::parse_* flags
 pugi::xml_parse_result result = mDoc.load_buffer_inplace(data,
 size,
 pugi::parse_default,
 pugi::encoding_utf8);
 if (result.status != pugi::status_ok)
 {
 showErrorStatus(result);
 delete [] data;
 }
 else
 {
 mData = data;
 }
 
// if (!mDoc)
// logger->log("Error parsing XML file %s", filename.c_str());
 }
 else if (skipError == SkipError_false)
 {
 reportAlways("Error loading %s", filename.c_str())
 }
 mIsValid = valid;
 BLOCK_END("XML::Document::Document")
 }
 
 Document::Document(const char *const data, const int size) :
 mDoc(),
 mData(nullptr),
 mIsValid(true)
 {
 if (!data)
 return;
 
 char *buf = new char[size + 1];
 strncpy(buf, data, size);
 buf[size] = 0;
 pugi::xml_parse_result result = mDoc.load_buffer_inplace(buf,
 size,
 pugi::parse_default,
 pugi::encoding_utf8);
 if (result.status != pugi::status_ok)
 {
 showErrorStatus(result);
 delete [] buf;
 }
 else
 {
 mData = buf;
 }
 }
 
 Document::~Document()
 {
 delete [] mData;
 mData = nullptr;
 }
 
 XmlNodePtr Document::rootNode()
 {
 return mDoc.first_child();
 }
 
 int getProperty(XmlNodeConstPtr node,
 const char *const name,
 int def)
 {
 int &ret = def;
 
 if (!node)
 return ret;
 const pugi::xml_attribute &attr = node.attribute(name);
 if (!attr.empty())
 ret = atoi(attr.value());
 
 return ret;
 }
 
 int getIntProperty(XmlNodeConstPtr node,
 const char *const name,
 int def,
 const int min,
 const int max)
 {
 int &ret = def;
 
 if (!node)
 return ret;
 const pugi::xml_attribute &attr = node.attribute(name);
 if (!attr.empty())
 ret = atoi(attr.value());
 
 if (ret < min)
 ret = min;
 else if (ret > max)
 ret = max;
 return ret;
 }
 
 float getFloatProperty(XmlNodeConstPtr node,
 const char *const name,
 float def)
 {
 float &ret = def;
 
 if (!node)
 return ret;
 const pugi::xml_attribute &attr = node.attribute(name);
 if (!attr.empty())
 ret = atof(attr.value());
 
 return ret;
 }
 
 double getDoubleProperty(XmlNodeConstPtr node,
 const char *const name,
 double def)
 {
 double &ret = def;
 
 if (!node)
 return ret;
 const pugi::xml_attribute &attr = node.attribute(name);
 if (!attr.empty())
 ret = atof(attr.value());
 
 return ret;
 }
 
 std::string getProperty(XmlNodeConstPtr node,
 const char *const name,
 const std::string &def)
 {
 if (!node)
 return def;
 const pugi::xml_attribute &attr = node.attribute(name);
 if (!attr.empty())
 return attr.value();
 
 return def;
 }
 
 std::string langProperty(XmlNodeConstPtr node,
 const char *const name,
 const std::string &def)
 {
 std::string str = getProperty(node, name, def);
 if (!translator)
 return str;
 
 return translator->getStr(str);
 }
 
 bool getBoolProperty(XmlNodeConstPtr node,
 const char *const name,
 const bool def)
 {
 if (!node)
 return def;
 const pugi::xml_attribute &attr = node.attribute(name);
 if (!attr.empty())
 {
 std::string val = attr.value();
 if (val == "true")
 return true;
 if (val == "false")
 return false;
 }
 
 return def;
 }
 
 XmlNodePtr findFirstChildByName(XmlNodeConstPtrConst parent,
 const char *const name)
 {
 if (!parent || !name)
 return pugi::xml_node();
 for_each_xml_child_node(child, parent)
 {
 if (!strcmp(child.name(), name))
 return child;
 }
 
 return pugi::xml_node();
 }
 
 // Initialize libxml2 and check for potential ABI mismatches between
 // compiled version and the shared library actually used.
 void initXML()
 {
// xmlInitParser();
// LIBXML_TEST_VERSION;
 
 // Suppress libxml2 error messages
// xmlSetGenericErrorFunc(nullptr, &xmlErrorLogger);
 }
 
 // Shutdown libxml
 void cleanupXML()
 {
// xmlCleanupParser();
 }
 
 bool Document::validateXml(const std::string &fileName)
 {
 pugi::xml_document doc;
 pugi::xml_parse_result result = doc.load_file(fileName.c_str(),
 pugi::parse_default,
 pugi::encoding_utf8);
 
 if (result.status != pugi::status_ok)
 {
 showErrorStatus(result);
 return false;
 }
 
 std::ifstream file;
 file.open(fileName.c_str(), std::ios::in);
 if (!file.is_open())
 {
 file.close();
 return false;
 }
 char line[101];
 if (!file.getline(line, 100))
 return false;
 file.close();
 
 const std::string str = line;
 if (!strStartWith(str, "<?xml "))
 return false;
 
 return true;
 }
} // namespace XML
 
#endif // ENABLE_PUGIXML