-
Notifications
You must be signed in to change notification settings - Fork 49
/
XercesValidator.cpp
299 lines (245 loc) · 11.6 KB
/
XercesValidator.cpp
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
296
297
298
299
/*
* This file is part of OpenModelica.
*
* Copyright (c) 1998-CurrentYear, Open Source Modelica Consortium (OSMC),
* c/o Linköpings universitet, Department of Computer and Information Science,
* SE-58183 Linköping, Sweden.
*
* All rights reserved.
*
* THIS PROGRAM IS PROVIDED UNDER THE TERMS OF GPL VERSION 3 LICENSE OR
* THIS OSMC PUBLIC LICENSE (OSMC-PL) VERSION 1.2.
* ANY USE, REPRODUCTION OR DISTRIBUTION OF THIS PROGRAM CONSTITUTES
* RECIPIENT'S ACCEPTANCE OF THE OSMC PUBLIC LICENSE OR THE GPL VERSION 3,
* ACCORDING TO RECIPIENTS CHOICE.
*
* The OpenModelica software and the Open Source Modelica
* Consortium (OSMC) Public License (OSMC-PL) are obtained
* from OSMC, either from the above address,
* from the URLs: http://www.ida.liu.se/projects/OpenModelica or
* http://www.openmodelica.org, and in the OpenModelica distribution.
* GNU version 3 is obtained from: http://www.gnu.org/copyleft/gpl.html.
*
* This program is distributed WITHOUT ANY WARRANTY; without
* even the implied warranty of MERCHANTABILITY or FITNESS
* FOR A PARTICULAR PURPOSE, EXCEPT AS EXPRESSLY SET FORTH
* IN THE BY RECIPIENT SELECTED SUBSIDIARY LICENSE CONDITIONS OF OSMC-PL.
*
* See the full OSMC Public License conditions for more details.
*
*/
#include "XercesValidator.h"
#include "whereami.h"
#include "Logging.h"
#include "OMSFileSystem.h"
#include "OMSString.h"
#include <iostream>
#include <xercesc/parsers/XercesDOMParser.hpp>
#include <xercesc/dom/DOM.hpp>
#include <xercesc/sax/HandlerBase.hpp>
#include <xercesc/framework/MemBufInputSource.hpp>
#include <xercesc/util/XMLString.hpp>
#include <xercesc/validators/common/Grammar.hpp>
#include <xercesc/util/PlatformUtils.hpp>
#include <xercesc/sax/ErrorHandler.hpp>
#include <xercesc/sax/SAXParseException.hpp>
using namespace xercesc_3_2;
class ParserErrorHandler : public ErrorHandler
{
public:
const char *fileName = "";
const char *filePath = "";
ParserErrorHandler(const char *fileName_, const char *filePath_)
{
fileName = fileName_;
filePath = filePath_;
}
private:
void reportParseException(const SAXParseException &ex)
{
char *msg = XMLString::transcode(ex.getMessage());
logWarning("invalid \"" + std::string(fileName) + "\"" + " detected in file " + "\"" + std::string(filePath) + "\"" + " at line: " + std::to_string(ex.getLineNumber()) + " column: " + std::to_string(ex.getColumnNumber()) + ", " + std::string(msg));
XMLString::release(&msg);
}
public:
void warning(const SAXParseException &ex)
{
reportParseException(ex);
}
void error(const SAXParseException &ex)
{
reportParseException(ex);
}
void fatalError(const SAXParseException &ex)
{
reportParseException(ex);
}
void resetErrors()
{
}
};
oms::XercesValidator::XercesValidator()
{
}
oms::XercesValidator::~XercesValidator()
{
XMLPlatformUtils::Terminate();
}
std::string oms::XercesValidator::getExecutablePath()
{
std::string executablePath = "";
int dirname_length;
int length = wai_getModulePath(NULL, 0, &dirname_length);
if (length == 0)
logError("executable directory name could not be detected");
char * path;
path = (char*)malloc(length + 1);
if (!path)
logError("Could not allocate memory to path");
wai_getModulePath(path, length, &dirname_length);
path[length] = '\0';
//std::cout << "executable path: " << path << "\n";
path[dirname_length] = '\0';
//std::cout << "dirname: "<< path << "\n";
//std::cout << "basename: "<< path + dirname_length + 1;
executablePath = oms::allocateAndCopyString(path);
free(path);
return executablePath;
}
oms_status_enu_t oms::XercesValidator::validateSSP(const char *ssd, const std::string& filePath)
{
std::string extension = filesystem::path(filePath).extension().generic_string();
if (extension != ".ssp" && extension != ".ssv" && extension != ".ssm")
return logWarning("filename extension must be \".ssp\" or \".ssv\" or \".ssm\" ; no other formats are supported for SSP validation");
try
{
XMLPlatformUtils::Initialize();
}
catch (const XMLException &toCatch)
{
char *message = XMLString::transcode(toCatch.getMessage());
logError("Xerces error during initialization: "+ std::string(message));
XMLString::release(&message);
return oms_status_error;
}
std::string path = getExecutablePath();
if (path.empty())
return logError("executable path could not be found");
filesystem::path schemaRootPath (path);
filesystem::path schemaSSDPath, schemaSSVPath, schemaSSMPath, schemaSSCPath;
schemaSSDPath = schemaRootPath / "../share/OMSimulator/schema/ssp/SystemStructureDescription.xsd";
schemaSSVPath = schemaRootPath / "../share/OMSimulator/schema/ssp/SystemStructureParameterValues.xsd";
schemaSSMPath = schemaRootPath / "../share/OMSimulator/schema/ssp/SystemStructureParameterMapping.xsd";
schemaSSCPath = schemaRootPath / "../share/OMSimulator/schema/ssp/SystemStructureCommon.xsd";
// std::cout << "schemaPath: " << schemaFilePath.generic_string() << "\n" << filesystem::absolute(schemaFilePath).generic_string() << "\n";
// this is done if we run the OMSimulator using python extension (e.g) python3 test.py and in this case the executable path is the dll path
// for windows and mingw "libOMSimulator.dll" is put in "install/bin" directory and for linux and other platforms
// the shared libraries are put in "install/lib/x86_64-linux-gnu/", so to find the schema location we have to move two directories back
if (!filesystem::exists(schemaSSDPath))
{
// schema path from OMSimulator standalone builds
schemaSSDPath = schemaRootPath / "../../share/OMSimulator/schema/ssp/SystemStructureDescription.xsd";
schemaSSVPath = schemaRootPath / "../../share/OMSimulator/schema/ssp/SystemStructureParameterValues.xsd";
schemaSSMPath = schemaRootPath / "../../share/OMSimulator/schema/ssp/SystemStructureParameterMapping.xsd";
schemaSSCPath = schemaRootPath / "../../share/OMSimulator/schema/ssp/SystemStructureCommon.xsd";
}
// search schema path from top superproject OpenModelica location, shared libs are put in "build/lib/x86_64-linux-gnu/omc/libOMSimulator.so"
if (!filesystem::exists(schemaSSDPath))
{
schemaSSDPath = schemaRootPath / "../../../share/OMSimulator/schema/ssp/SystemStructureDescription.xsd";
schemaSSVPath = schemaRootPath / "../../../share/OMSimulator/schema/ssp/SystemStructureParameterValues.xsd";
schemaSSMPath = schemaRootPath / "../../../share/OMSimulator/schema/ssp/SystemStructureParameterMapping.xsd";
schemaSSCPath = schemaRootPath / "../../../share/OMSimulator/schema/ssp/SystemStructureCommon.xsd";
}
XercesDOMParser domParser;
// load the schema
if (domParser.loadGrammar(schemaSSDPath.generic_string().c_str(), Grammar::SchemaGrammarType) == NULL)
return logError("could not load the ssd schema file: " + filesystem::absolute(schemaSSDPath).generic_string());
std::string sspVariant = "";
if (extension == ".ssp")
sspVariant = "SystemStructureDescription";
else if (extension == ".ssv")
sspVariant = "SystemStructureParameterValues";
else if (extension == ".ssm")
sspVariant = "SystemStructureParameterMapping";
ParserErrorHandler parserErrorHandler(sspVariant.c_str(), filePath.c_str());
domParser.setErrorHandler(&parserErrorHandler);
domParser.cacheGrammarFromParse(true);
domParser.setValidationScheme(XercesDOMParser::Val_Always);
domParser.setDoNamespaces(true);
domParser.setDoSchema(true);
domParser.setValidationSchemaFullChecking(true);
domParser.setValidationConstraintFatal(true);
// domParser.setExternalNoNamespaceSchemaLocation(schemaFilePath); // set this for noNameSpace
std::string ssdTargetNameSpacePath = "http://ssp-standard.org/SSP1/SystemStructureDescription " + schemaSSDPath.generic_string();
ssdTargetNameSpacePath = ssdTargetNameSpacePath + " http://ssp-standard.org/SSP1/SystemStructureParameterValues " + schemaSSVPath.generic_string();
ssdTargetNameSpacePath = ssdTargetNameSpacePath + " http://ssp-standard.org/SSP1/SystemStructureParameterMapping " + schemaSSMPath.generic_string();
ssdTargetNameSpacePath = ssdTargetNameSpacePath + " http://ssp-standard.org/SSP1/SystemStructureCommon " + schemaSSCPath.generic_string();
domParser.setExternalSchemaLocation(ssdTargetNameSpacePath.c_str());
if (strlen(ssd) > 0)
{
xercesc::MemBufInputSource pMemBufIS((const XMLByte *)ssd, std::string(ssd).size(), "ssdfile");
domParser.parse(pMemBufIS);
}
else
{
domParser.parse(filePath.c_str());
}
if (domParser.getErrorCount() > 0)
return logWarning( "\"" + sspVariant + "\"" + " does not conform to the SSP standard schema");
return oms_status_ok;
}
oms_status_enu_t oms::XercesValidator::validateFMU(const char *modeldescription, const std::string& filePath)
{
std::string extension = filesystem::path(filePath).extension().generic_string();
if (extension != ".fmu")
return logWarning("filename extension must be \".fmu\" ; no other formats are supported for fmu validation");
try
{
XMLPlatformUtils::Initialize();
}
catch (const XMLException &toCatch)
{
char *message = XMLString::transcode(toCatch.getMessage());
logError("Xerces error during initialization: "+ std::string(message));
XMLString::release(&message);
return oms_status_error;
}
std::string path = getExecutablePath();
if (path.empty())
return logError("executable path could not be found");
filesystem::path schemaRootPath (path);
filesystem::path schemaFmiModeldescriptionPath;
schemaFmiModeldescriptionPath = schemaRootPath / "../share/OMSimulator/schema/fmi2/fmi2ModelDescription.xsd";
// this is done if we run the OMSimulator using python extension (e.g) python3 test.py and in this case the executable path is the dll path
// for windows and mingw "libOMSimulator.dll" is put in "install/bin" directory and for linux and other platforms
// the shared libraries are put in "install/lib/x86_64-linux-gnu/", so to find the schema location we have to move two directories back
if (!filesystem::exists(schemaFmiModeldescriptionPath))
{
// schema path from standalone OMSimulator build
schemaFmiModeldescriptionPath = schemaRootPath / "../../share/OMSimulator/schema/fmi2/fmi2ModelDescription.xsd";
}
// schema path from top superproject OpenModelica location, shared libs are put in "build/lib/x86_64-linux-gnu/omc/libOMSimulator.so"
if (!filesystem::exists(schemaFmiModeldescriptionPath))
{
schemaFmiModeldescriptionPath = schemaRootPath / "../../../share/OMSimulator/schema/fmi2/fmi2ModelDescription.xsd";
}
XercesDOMParser domParser;
// load the schema
if (domParser.loadGrammar(schemaFmiModeldescriptionPath.generic_string().c_str(), Grammar::SchemaGrammarType) == NULL)
return logError("could not load the ssd schema file: " + filesystem::absolute(schemaFmiModeldescriptionPath).generic_string());
ParserErrorHandler parserErrorHandler("modeldescription.xml", filePath.c_str());
domParser.setErrorHandler(&parserErrorHandler);
domParser.cacheGrammarFromParse(true);
domParser.setValidationScheme(XercesDOMParser::Val_Always);
domParser.setDoNamespaces(true);
domParser.setDoSchema(true);
domParser.setValidationSchemaFullChecking(true);
domParser.setValidationConstraintFatal(true);
domParser.setExternalNoNamespaceSchemaLocation(schemaFmiModeldescriptionPath.generic_string().c_str()); // set this for noNameSpace
xercesc::MemBufInputSource pMemBufIS((const XMLByte *)modeldescription, std::string(modeldescription).size(), "modeldescriptionfile");
domParser.parse(pMemBufIS);
if (domParser.getErrorCount() > 0)
return logWarning("\"modeldescription.xml\" does not conform to the FMI-2.0 standard schema");
return oms_status_ok;
}