1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295
|
/*++
Copyright (C) 2018 3MF Consortium
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
1. Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Abstract:
NMR_ModelReaderNode_Model.cpp implements the Model Reader Node Class.
A model reader node is an abstract base class for all XML nodes of a 3MF Model Stream.
--*/
#include "Model/Reader/NMR_ModelReaderNode_Model.h"
#include "Model/Reader/v100/NMR_ModelReaderNode100_Resources.h"
#include "Model/Reader/v100/NMR_ModelReaderNode100_Build.h"
#include "Model/Reader/v100/NMR_ModelReaderNode100_MetaData.h"
#include "Model/Reader/v093/NMR_ModelReaderNode093_Resources.h"
#include "Model/Reader/v093/NMR_ModelReaderNode093_Build.h"
#include "Model/Classes/NMR_ModelConstants.h"
#include "Common/3MF_ProgressMonitor.h"
#include "Common/NMR_Exception.h"
#include "Common/NMR_StringUtils.h"
#include <iostream>
#include <sstream>
#include <algorithm>
#include <iterator>
namespace NMR {
CModelReaderNode_Model::CModelReaderNode_Model(_In_ CModel * pModel, _In_ PModelReaderWarnings pWarnings, const std::string sPath,
_In_ CProgressMonitor* pProgressMonitor)
: CModelReaderNode(pWarnings, pProgressMonitor), m_bIgnoreBuild(false), m_bIgnoreMetaData(false)
{
__NMRASSERT(pModel);
m_pModel = pModel;
m_sRequiredExtensions = "";
m_pModel->setLanguage("und");
m_bHasResources = false;
m_bHasBuild = false;
m_bWithinIgnoredElement = false;
m_sPath = sPath;
}
void CModelReaderNode_Model::CheckRequiredExtensions() {
// check, whether all required extensions are available in this implementation before actually parsing the file
std::istringstream iss(m_sRequiredExtensions);
std::vector<std::string> tokens{ std::istream_iterator<std::string, char>{iss},
std::istream_iterator<std::string, char>{} };
for (auto token : tokens) {
// is the extension listed?
if (m_ListedExtensions.count(token) < 1) {
throw CNMRException(NMR_ERROR_INVALIDREQUIREDEXTENSIONPREFIX);
}
// is the extension supported?
std::string sExtensionURI = m_ListedExtensions[token];
if (strcmp(sExtensionURI.c_str(), PACKAGE_XMLNS_100) != 0 &&
strcmp(sExtensionURI.c_str(), XML_3MF_NAMESPACE_MATERIALSPEC) != 0 &&
strcmp(sExtensionURI.c_str(), XML_3MF_NAMESPACE_PRODUCTIONSPEC) != 0 &&
strcmp(sExtensionURI.c_str(), XML_3MF_NAMESPACE_SLICESPEC) != 0 &&
strcmp(sExtensionURI.c_str(), XML_3MF_NAMESPACE_BEAMLATTICESPEC) != 0 )
{
m_pWarnings->addWarning(MODELREADERWARNING_REQUIREDEXTENSIONNOTSUPPORTED, NMR_ERROR_REQUIREDEXTENSIONNOTSUPPORTED, mrwInvalidMandatoryValue);
}
}
}
void CModelReaderNode_Model::parseXML(_In_ CXmlReader * pXMLReader)
{
// Parse name
parseName(pXMLReader);
// Parse attribute
parseAttributes(pXMLReader);
// Check required extensions
CheckRequiredExtensions();
// Parse Content
parseContent(pXMLReader);
}
void CModelReaderNode_Model::OnAttribute(_In_z_ const nfChar * pAttributeName, _In_z_ const nfChar * pAttributeValue)
{
__NMRASSERT(pAttributeName);
__NMRASSERT(pAttributeValue);
if (strcmp(pAttributeName, XML_3MF_ATTRIBUTE_MODEL_UNIT) == 0) {
// set unit string and set validity
try {
m_pModel->setUnitString(pAttributeValue);
}
catch (CNMRException & e) {
m_pWarnings->addWarning(MODELREADERWARNING_INVALIDMODELUNIT, e.getErrorCode(), mrwInvalidMandatoryValue);
}
}
else if (strcmp(pAttributeName, XML_3MF_ATTRIBUTE_REQUIREDEXTENSIONS) == 0) {
m_sRequiredExtensions = std::string(pAttributeValue);
}
}
void CModelReaderNode_Model::OnNSAttribute(_In_z_ const nfChar * pAttributeName, _In_z_ const nfChar * pAttributeValue, _In_z_ const nfChar * pNameSpace)
{
if (strcmp(pNameSpace, XML_3MF_NAMESPACE_XML) == 0) {
if (strcmp(pAttributeName, XML_3MF_ATTRIBUTE_MODEL_LANG) == 0) {
m_pModel->setLanguage(std::string(pAttributeValue));
}
else if (strcmp(pAttributeName, XML_3MF_ATTRIBUTE_MODEL_SPACE) == 0)
{
throw CNMRException(NMR_ERROR_FORBIDDENXMLATTRITIBUTE);
}
// lax handling here for other XML_3MF_NAMESPACE_XML-attributes
}
else if (strcmp(pNameSpace, XML_3MF_NAMESPACE_XMLNS) == 0) {
m_ListedExtensions.insert(std::pair<std::string, std::string>(std::string(pAttributeName), std::string(pAttributeValue)));
}
}
bool decomposeIntoNamespaceAndName(const std::string &sIn, std::string &sNameSpace, std::string &sName) {
size_t cInd = sIn.find(":");
if (cInd != std::string::npos) {
sNameSpace = sIn.substr(0, cInd);
sName = sIn.substr(cInd+1, sIn.length() - cInd);
return true;
}
return false;
}
void CModelReaderNode_Model::OnNSChildElement(_In_z_ const nfChar * pChildName, _In_z_ const nfChar * pNameSpace, _In_ CXmlReader * pXMLReader)
{
if (strcmp(pNameSpace, XML_3MF_NAMESPACE_CORESPEC100) == 0) {
if (strcmp(pChildName, XML_3MF_ELEMENT_RESOURCES) == 0) {
m_bWithinIgnoredElement = false;
if (m_pProgressMonitor && !m_pProgressMonitor->Progress(0.2, ProgressIdentifier::PROGRESS_READRESOURCES))
throw CNMRException(NMR_USERABORTED);
if (m_pProgressMonitor) m_pProgressMonitor->PushLevel(0.2, 0.9);
PModelReaderNode pXMLNode = std::make_shared<CModelReaderNode100_Resources>(m_pModel, m_pWarnings, m_sPath.c_str(), m_pProgressMonitor);
if (m_bHasResources)
throw CNMRException(NMR_ERROR_DUPLICATERESOURCES);
pXMLNode->parseXML(pXMLReader);
if (m_pProgressMonitor) m_pProgressMonitor->PopLevel();
m_bHasResources = true;
}
else if (strcmp(pChildName, XML_3MF_ELEMENT_BUILD) == 0) {
if (m_bHasBuild)
throw CNMRException(NMR_ERROR_DUPLICATEBUILDSECTION);
if (m_bIgnoreBuild) {
m_bWithinIgnoredElement = true;
}
else {
m_bWithinIgnoredElement = false;
if (m_pProgressMonitor && !m_pProgressMonitor->Progress(0.9, ProgressIdentifier::PROGRESS_READBUILD))
throw CNMRException(NMR_USERABORTED);
PModelReaderNode pXMLNode = std::make_shared<CModelReaderNode100_Build>(m_pModel, m_pWarnings);
pXMLNode->parseXML(pXMLReader);
}
m_bHasBuild = true;
}
else if (strcmp(pChildName, XML_3MF_ELEMENT_METADATA) == 0) {
if (m_bIgnoreMetaData) {
m_bWithinIgnoredElement = true;
} else {
m_bWithinIgnoredElement = false;
PModelReaderNode100_MetaData pXMLNode = std::make_shared<CModelReaderNode100_MetaData>(m_pWarnings);
pXMLNode->parseXML(pXMLReader);
std::string sName = pXMLNode->getName();
std::string sValue = pXMLNode->getValue();
if (!sName.empty()) {
if (m_pModel->hasMetaData(sName)) {
m_pWarnings->addWarning(MODELREADERWARNING_DUPLICATEMETADATA, NMR_ERROR_DUPLICATEMETADATA, mrwInvalidOptionalValue);
}
std::string sNameSpace, sNameOnly;
if (decomposeIntoNamespaceAndName(sName, sNameSpace, sNameOnly)) {
std::string sNameSpaceURI;
if (pXMLReader->GetNamespaceURI(sNameSpace, sNameSpaceURI))
m_pModel->addMetaData(sNameSpaceURI + ":" + sNameOnly, sValue);
else
throw CNMRException(NMR_ERROR_METADATA_COULDNOTGETNAMESPACE);
}
else {
// default namespace
if ((strcmp(sName.c_str(), XML_3MF_METADATA_VALUE_1) == 0) ||
(strcmp(sName.c_str(), XML_3MF_METADATA_VALUE_2) == 0) ||
(strcmp(sName.c_str(), XML_3MF_METADATA_VALUE_3) == 0) ||
(strcmp(sName.c_str(), XML_3MF_METADATA_VALUE_4) == 0) ||
(strcmp(sName.c_str(), XML_3MF_METADATA_VALUE_5) == 0) ||
(strcmp(sName.c_str(), XML_3MF_METADATA_VALUE_6) == 0) ||
(strcmp(sName.c_str(), XML_3MF_METADATA_VALUE_7) == 0) ||
(strcmp(sName.c_str(), XML_3MF_METADATA_VALUE_8) == 0) ||
(strcmp(sName.c_str(), XML_3MF_METADATA_VALUE_9) == 0)
)
{
m_pModel->addMetaData(sName, sValue);
}
else
m_pWarnings->addException(CNMRException(NMR_ERROR_UNKNOWNMETADATA), mrwInvalidOptionalValue);
}
}
else {
m_pWarnings->addWarning(MODELREADERWARNING_INVALIDMETADATA, NMR_ERROR_INVALIDMETADATA, mrwInvalidOptionalValue);
}
}
}
else {
if (!m_bWithinIgnoredElement)
m_pWarnings->addException(CNMRException(NMR_ERROR_NAMESPACE_INVALID_ELEMENT), mrwInvalidOptionalValue);
}
}
if ((strcmp(pNameSpace, XML_3MF_NAMESPACE_CORESPEC093) == 0) || (strcmp(pNameSpace, "") == 0)) {
if (strcmp(pChildName, XML_3MF_ELEMENT_RESOURCES) == 0) {
PModelReaderNode pXMLNode = std::make_shared<CModelReaderNode093_Resources>(m_pModel, m_pWarnings);
if (m_bHasResources)
throw CNMRException(NMR_ERROR_DUPLICATERESOURCES);
pXMLNode->parseXML(pXMLReader);
m_bHasResources = true;
}
else if (strcmp(pChildName, XML_3MF_ELEMENT_BUILD) == 0) {
PModelReaderNode pXMLNode = std::make_shared<CModelReaderNode093_Build>(m_pModel, m_pWarnings);
if (m_bHasBuild)
throw CNMRException(NMR_ERROR_DUPLICATEBUILDSECTION);
pXMLNode->parseXML(pXMLReader);
m_bHasBuild = true;
}
else if ( (strcmp(pChildName, XML_3MF_ELEMENT_METADATA) == 0) || (strcmp(pChildName, XML_3MF_ELEMENT_METADATA_ENRTY) == 0)) {
// nothing
}
else
m_pWarnings->addException(CNMRException(NMR_ERROR_NAMESPACE_INVALID_ELEMENT), mrwInvalidOptionalValue);
}
}
nfBool CModelReaderNode_Model::getHasResources()
{
return m_bHasResources;
}
nfBool CModelReaderNode_Model::getHasBuild()
{
return m_bHasBuild;
}
nfBool CModelReaderNode_Model::ignoreBuild()
{
return m_bIgnoreBuild;
}
void CModelReaderNode_Model::setIgnoreBuild(bool bIgnoreBuild)
{
m_bIgnoreBuild = bIgnoreBuild;
}
nfBool CModelReaderNode_Model::ignoreMetaData()
{
return m_bIgnoreMetaData;
}
void CModelReaderNode_Model::setIgnoreMetaData(bool bIgnoreMetaData)
{
m_bIgnoreMetaData = bIgnoreMetaData;
}
}
|