Line data Source code
1 : // EnergyPlus, Copyright (c) 1996-2025, The Board of Trustees of the University of Illinois,
2 : // The Regents of the University of California, through Lawrence Berkeley National Laboratory
3 : // (subject to receipt of any required approvals from the U.S. Dept. of Energy), Oak Ridge
4 : // National Laboratory, managed by UT-Battelle, Alliance for Sustainable Energy, LLC, and other
5 : // contributors. All rights reserved.
6 : //
7 : // NOTICE: This Software was developed under funding from the U.S. Department of Energy and the
8 : // U.S. Government consequently retains certain rights. As such, the U.S. Government has been
9 : // granted for itself and others acting on its behalf a paid-up, nonexclusive, irrevocable,
10 : // worldwide license in the Software to reproduce, distribute copies to the public, prepare
11 : // derivative works, and perform publicly and display publicly, and to permit others to do so.
12 : //
13 : // Redistribution and use in source and binary forms, with or without modification, are permitted
14 : // provided that the following conditions are met:
15 : //
16 : // (1) Redistributions of source code must retain the above copyright notice, this list of
17 : // conditions and the following disclaimer.
18 : //
19 : // (2) Redistributions in binary form must reproduce the above copyright notice, this list of
20 : // conditions and the following disclaimer in the documentation and/or other materials
21 : // provided with the distribution.
22 : //
23 : // (3) Neither the name of the University of California, Lawrence Berkeley National Laboratory,
24 : // the University of Illinois, U.S. Dept. of Energy nor the names of its contributors may be
25 : // used to endorse or promote products derived from this software without specific prior
26 : // written permission.
27 : //
28 : // (4) Use of EnergyPlus(TM) Name. If Licensee (i) distributes the software in stand-alone form
29 : // without changes from the version obtained under this License, or (ii) Licensee makes a
30 : // reference solely to the software portion of its product, Licensee must refer to the
31 : // software as "EnergyPlus version X" software, where "X" is the version number Licensee
32 : // obtained under this License and may not use a different name for the software. Except as
33 : // specifically required in this Section (4), Licensee shall not use in a company name, a
34 : // product name, in advertising, publicity, or other promotional activities any name, trade
35 : // name, trademark, logo, or other designation of "EnergyPlus", "E+", "e+" or confusingly
36 : // similar designation, without the U.S. Department of Energy's prior written consent.
37 : //
38 : // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR
39 : // IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
40 : // AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
41 : // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
42 : // CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
43 : // SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
44 : // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
45 : // OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
46 : // POSSIBILITY OF SUCH DAMAGE.
47 :
48 : // C++ Headers
49 :
50 : // ObjexxFCL Headers
51 :
52 : // EnergyPlus Headers
53 : #include <EnergyPlus/InputProcessing/InputValidation.hh>
54 : #include <valijson/adapters/nlohmann_json_adapter.hpp>
55 : #include <valijson/schema.hpp>
56 : #include <valijson/schema_parser.hpp>
57 : #include <valijson/utils/nlohmann_json_utils.hpp>
58 : #include <valijson/validator.hpp>
59 :
60 : using json = nlohmann::json;
61 :
62 4234 : Validation::Validation(json const *parsed_schema)
63 : {
64 4234 : schema = parsed_schema;
65 4234 : }
66 :
67 1359 : bool Validation::hasErrors()
68 : {
69 1359 : return !errors_.empty();
70 : }
71 :
72 1372 : std::vector<std::string> const &Validation::errors()
73 : {
74 1372 : return errors_;
75 : }
76 :
77 1370 : std::vector<std::string> const &Validation::warnings()
78 : {
79 1370 : return warnings_;
80 : }
81 :
82 : // this is a little bit risky, since it's theoretically
83 : // possible that the schema could change?
84 : // But we're trying it to see the impact on the code
85 1364 : const valijson::Schema &validation_schema(const json *schema)
86 : {
87 1364 : [[maybe_unused]] static const json *last_schema = schema;
88 :
89 1364 : assert(last_schema == schema);
90 :
91 1314 : static const std::unique_ptr<valijson::Schema> retval = [&]() {
92 1314 : auto vs = std::make_unique<valijson::Schema>(); // (THIS_AUTO_OK)
93 1314 : valijson::SchemaParser parser;
94 1314 : valijson::adapters::NlohmannJsonAdapter schema_doc(*schema);
95 1314 : parser.populateSchema(schema_doc, *vs);
96 2628 : return vs;
97 2678 : }();
98 :
99 1364 : return *retval;
100 : }
101 :
102 1364 : bool Validation::validate(json const &parsed_input)
103 : {
104 :
105 : static constexpr std::string_view nameError =
106 : "Object contains a property that could not be validated using 'properties' or 'additionalProperties' constraints: ''.";
107 : static constexpr std::string_view otherError =
108 : "Object contains a property that could not be validated using 'properties' or 'additionalProperties' constraints";
109 :
110 : // valijson::Validator = valijson::ValidatorT<DefaultRegexEngine>, which uses std::regex, and we want RE2 because std::regex is horribly slow
111 1364 : valijson::ValidatorT<RE2RegexpEngine> validator;
112 1364 : valijson::adapters::NlohmannJsonAdapter doc(parsed_input);
113 1364 : valijson::ValidationResults results;
114 1364 : if (!validator.validate(validation_schema(schema), doc, &results)) {
115 25 : valijson::ValidationResults::Error error;
116 25 : size_t max_context = 0;
117 162 : while (results.popError(error)) {
118 112 : if (error.context.size() >= max_context) {
119 35 : max_context = error.context.size();
120 35 : std::string context;
121 173 : for (auto it = error.context.begin(); it != error.context.end(); it++)
122 138 : context += *it;
123 :
124 35 : errors_.emplace_back(context + " - " + error.description);
125 35 : if (max_context == 2) {
126 6 : if (error.description == nameError) { // C++20: should mark this [[likely]]
127 1 : errors_.emplace_back(context + " - Object name is required and cannot be blank or whitespace");
128 5 : } else if (error.description.find(otherError) != std::string::npos) {
129 1 : errors_.emplace_back(context + " - Object name is required and cannot be blank or whitespace, and must be UTF-8 encoded");
130 : }
131 : }
132 35 : }
133 : }
134 25 : return false;
135 25 : }
136 1339 : return true;
137 1364 : }
|
