constraint.h 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466
  1. #pragma once
  2. #include <functional>
  3. #include <map>
  4. #include <memory>
  5. #include <set>
  6. #include <string_view>
  7. #include <unordered_map>
  8. #include <unordered_set>
  9. #include <jvalidate/constraint/array_constraint.h>
  10. #include <jvalidate/constraint/general_constraint.h>
  11. #include <jvalidate/constraint/number_constraint.h>
  12. #include <jvalidate/constraint/object_constraint.h>
  13. #include <jvalidate/constraint/string_constraint.h>
  14. #include <jvalidate/detail/expect.h>
  15. #include <jvalidate/detail/reference.h>
  16. #include <jvalidate/enum.h>
  17. #include <jvalidate/forward.h>
  18. #include <jvalidate/parser_context.h>
  19. namespace jvalidate {
  20. template <Adapter A> class ConstraintFactory {
  21. public:
  22. using pConstraint = std::unique_ptr<constraint::Constraint>;
  23. using Object = decltype(std::declval<A>().as_object());
  24. using MakeConstraint = std::function<pConstraint(ParserContext<A> const &)>;
  25. using VersionedMakeConstraint = std::map<schema::Version, MakeConstraint, std::greater<>>;
  26. private:
  27. using Self = ConstraintFactory<A>;
  28. private:
  29. std::unordered_map<std::string_view, MakeConstraint> constraints_{
  30. {"additionalProperties", &Self::additionalProperties},
  31. {"enum", &Self::isInEnumuration},
  32. {"maxItems", &Self::maxItems},
  33. {"maxLength", &Self::maxLength},
  34. {"maximum", &Self::maximum},
  35. {"minItems", &Self::minItems},
  36. {"minLength", &Self::minLength},
  37. {"minimum", &Self::minimum},
  38. {"pattern", &Self::pattern},
  39. {"patternProperties", &Self::patternProperties},
  40. {"properties", &Self::properties},
  41. {"type", &Self::type},
  42. {"uniqueItems", &Self::uniqueItems},
  43. };
  44. std::unordered_map<std::string_view, VersionedMakeConstraint> versioned_constraints_{
  45. {"additionalItems",
  46. {{schema::Version::Draft04, &Self::additionalItems},
  47. {schema::Version::Draft2020_12, nullptr}}},
  48. {"allOf", {{schema::Version::Draft04, &Self::allOf}}},
  49. {"anyOf", {{schema::Version::Draft04, &Self::anyOf}}},
  50. {"const", {{schema::Version::Draft06, &Self::isConstant}}},
  51. {"contains", {{schema::Version::Draft06, &Self::contains}}},
  52. {"dependencies",
  53. {{schema::Version::Draft04, &Self::dependencies}, {schema::Version::Draft2019_09, nullptr}}},
  54. {"dependentRequired", {{schema::Version::Draft2019_09, &Self::dependentRequired}}},
  55. {"dependentSchemas", {{schema::Version::Draft2019_09, &Self::dependentSchemas}}},
  56. {"divisibleBy",
  57. {{schema::Version::Draft04, &Self::multipleOf}, {schema::Version::Draft04, nullptr}}},
  58. {"exclusiveMaximum", {{schema::Version::Draft06, &Self::exclusiveMaximum}}},
  59. {"exclusiveMinimum", {{schema::Version::Draft06, &Self::exclusiveMinimum}}},
  60. {"format",
  61. {{schema::Version::Draft04, &Self::warnUnimplemented},
  62. {schema::Version::Draft2020_12, nullptr}}},
  63. {"format-assertion", {{schema::Version::Draft2020_12, &Self::fatalUnimplemented}}},
  64. {"if", {{schema::Version::Draft07, &Self::ifThenElse}}},
  65. {"items",
  66. {{schema::Version::Draft04, &Self::itemsTupleOrVector},
  67. {schema::Version::Draft2020_12, &Self::additionalItems}}},
  68. {"maxProperties", {{schema::Version::Draft04, &Self::maxProperties}}},
  69. {"minProperties", {{schema::Version::Draft04, &Self::minProperties}}},
  70. {"multipleOf", {{schema::Version::Draft04, &Self::multipleOf}}},
  71. {"not", {{schema::Version::Draft04, &Self::isNot}}},
  72. {"oneOf", {{schema::Version::Draft04, &Self::oneOf}}},
  73. {"prefixItems", {{schema::Version::Draft2020_12, &Self::prefixItems}}},
  74. {"propertyNames", {{schema::Version::Draft06, &Self::propertyNames}}},
  75. {"required", {{schema::Version::Draft04, &Self::required}}},
  76. {"unevaluatedItems", {{schema::Version::Draft2019_09, &Self::unevaluatedItems}}},
  77. {"unevaluatedProperties", {{schema::Version::Draft2019_09, &Self::unevaluatedProperties}}},
  78. };
  79. public:
  80. bool is_post_constraint(std::string_view key) const {
  81. return key == "unevaluatedItems" || key == "unevaluatedProperties";
  82. }
  83. MakeConstraint operator()(std::string_view key, schema::Version version) const {
  84. if (auto it = constraints_.find(key); it != constraints_.end()) {
  85. return it->second;
  86. }
  87. if (auto it = versioned_constraints_.find(key); it != versioned_constraints_.end()) {
  88. if (auto vit = it->second.lower_bound(version); vit != it->second.end()) {
  89. return vit->second;
  90. }
  91. }
  92. return nullptr;
  93. }
  94. // SECTION: Untyped Constraints
  95. static pConstraint warnUnimplemented(ParserContext<A> const & context) {
  96. std::cerr << "Unimplemented constraint " << context.where << "\n";
  97. return nullptr;
  98. }
  99. static pConstraint fatalUnimplemented(ParserContext<A> const & context) {
  100. JVALIDATE_THROW(std::runtime_error, "Unimplemented constraint " << context.where);
  101. }
  102. static auto type(ParserContext<A> const & context) {
  103. static std::unordered_map<std::string_view, adapter::Type> const s_type_names{
  104. {"null", adapter::Type::Null}, {"boolean", adapter::Type::Boolean},
  105. {"integer", adapter::Type::Integer}, {"number", adapter::Type::Number},
  106. {"string", adapter::Type::String}, {"array", adapter::Type::Array},
  107. {"object", adapter::Type::Object},
  108. };
  109. auto to_type = [](std::string_view type) {
  110. EXPECT_M(s_type_names.contains(type), "Unknown type " << type);
  111. return s_type_names.at(type);
  112. };
  113. adapter::Type const type = context.schema.type();
  114. if (type == adapter::Type::String) {
  115. return std::make_unique<constraint::TypeConstraint>(to_type(context.schema.as_string()));
  116. }
  117. EXPECT(type == adapter::Type::Array);
  118. std::set<adapter::Type> types;
  119. for (auto subschema : context.schema.as_array()) {
  120. types.insert(to_type(subschema.as_string()));
  121. }
  122. return std::make_unique<constraint::TypeConstraint>(types);
  123. }
  124. static auto ifThenElse(ParserContext<A> const & context) {
  125. return std::make_unique<constraint::ConditionalConstraint>(
  126. context.node(), context.neighbor("then").node(), context.neighbor("else").node());
  127. }
  128. static auto isInEnumuration(ParserContext<A> const & context) {
  129. EXPECT(context.schema.type() == adapter::Type::Array);
  130. std::vector<std::unique_ptr<adapter::Const const>> rval;
  131. for (auto subschema : context.schema.as_array()) {
  132. rval.push_back(subschema.freeze());
  133. }
  134. return std::make_unique<constraint::EnumConstraint>(std::move(rval));
  135. }
  136. static auto isConstant(ParserContext<A> const & context) {
  137. return std::make_unique<constraint::EnumConstraint>(context.schema.freeze());
  138. }
  139. static auto allOf(ParserContext<A> const & context) {
  140. EXPECT(context.schema.type() == adapter::Type::Array);
  141. std::vector<schema::Node const *> rval;
  142. size_t index = 0;
  143. for (auto subschema : context.schema.as_array()) {
  144. rval.push_back(context.child(subschema, index).node());
  145. ++index;
  146. }
  147. return std::make_unique<constraint::AllOfConstraint>(rval);
  148. }
  149. static auto anyOf(ParserContext<A> const & context) {
  150. EXPECT(context.schema.type() == adapter::Type::Array);
  151. std::vector<schema::Node const *> rval;
  152. size_t index = 0;
  153. for (auto subschema : context.schema.as_array()) {
  154. rval.push_back(context.child(subschema, index).node());
  155. ++index;
  156. }
  157. return std::make_unique<constraint::AnyOfConstraint>(rval);
  158. }
  159. static auto oneOf(ParserContext<A> const & context) {
  160. EXPECT(context.schema.type() == adapter::Type::Array);
  161. std::vector<schema::Node const *> rval;
  162. size_t index = 0;
  163. for (auto subschema : context.schema.as_array()) {
  164. rval.push_back(context.child(subschema, index).node());
  165. ++index;
  166. }
  167. return std::make_unique<constraint::OneOfConstraint>(rval);
  168. }
  169. static auto isNot(ParserContext<A> const & context) {
  170. return std::make_unique<constraint::NotConstraint>(context.node());
  171. }
  172. // SECTION: Numeric Constraints
  173. static auto minimum(ParserContext<A> const & context) {
  174. double value = context.schema.as_number();
  175. if (context.version < schema::Version::Draft06 &&
  176. context.parent->contains("exclusiveMinimum")) {
  177. auto exclusive = (*context.parent)["exclusiveMinimum"];
  178. EXPECT(exclusive.type() == adapter::Type::Boolean);
  179. return std::make_unique<constraint::MinimumConstraint>(value, exclusive.as_boolean());
  180. }
  181. return std::make_unique<constraint::MinimumConstraint>(value, false);
  182. }
  183. static pConstraint exclusiveMinimum(ParserContext<A> const & context) {
  184. double value = context.schema.as_number();
  185. return std::make_unique<constraint::MinimumConstraint>(value, true);
  186. }
  187. static auto maximum(ParserContext<A> const & context) {
  188. double value = context.schema.as_number();
  189. if (context.version < schema::Version::Draft06 &&
  190. context.parent->contains("exclusiveMaximum")) {
  191. auto exclusive = (*context.parent)["exclusiveMaximum"];
  192. EXPECT(exclusive.type() == adapter::Type::Boolean);
  193. return std::make_unique<constraint::MaximumConstraint>(value, exclusive.as_boolean());
  194. }
  195. return std::make_unique<constraint::MaximumConstraint>(value, false);
  196. }
  197. static pConstraint exclusiveMaximum(ParserContext<A> const & context) {
  198. double value = context.schema.as_number();
  199. return std::make_unique<constraint::MaximumConstraint>(value, true);
  200. }
  201. static auto multipleOf(ParserContext<A> const & context) {
  202. int64_t value = context.schema.as_integer();
  203. return std::make_unique<constraint::MultipleOfConstraint>(value);
  204. }
  205. // SECTION: String Constraints
  206. static auto minLength(ParserContext<A> const & context) {
  207. EXPECT(context.schema.type() == adapter::Type::Integer);
  208. return std::make_unique<constraint::MinLengthConstraint>(context.schema.as_integer());
  209. }
  210. static auto maxLength(ParserContext<A> const & context) {
  211. EXPECT(context.schema.type() == adapter::Type::Integer);
  212. return std::make_unique<constraint::MaxLengthConstraint>(context.schema.as_integer());
  213. }
  214. static auto pattern(ParserContext<A> const & context) {
  215. return std::make_unique<constraint::PatternConstraint>(context.schema.as_string());
  216. }
  217. // SECTION: Array Constraints
  218. static auto contains(ParserContext<A> const & context) {
  219. if (context.version < schema::Version::Draft2019_09) {
  220. return std::make_unique<constraint::ContainsConstraint>(context.node());
  221. }
  222. std::optional<size_t> maximum;
  223. std::optional<size_t> minimum;
  224. if (context.parent->contains("maxContains")) {
  225. maximum = (*context.parent)["maxContains"].as_integer();
  226. }
  227. if (context.parent->contains("minContains")) {
  228. minimum = (*context.parent)["minContains"].as_integer();
  229. }
  230. return std::make_unique<constraint::ContainsConstraint>(context.node(), minimum, maximum);
  231. }
  232. static auto minItems(ParserContext<A> const & context) {
  233. EXPECT(context.schema.type() == adapter::Type::Integer);
  234. return std::make_unique<constraint::MinItemsConstraint>(context.schema.as_integer());
  235. }
  236. static auto maxItems(ParserContext<A> const & context) {
  237. EXPECT(context.schema.type() == adapter::Type::Integer);
  238. return std::make_unique<constraint::MaxItemsConstraint>(context.schema.as_integer());
  239. }
  240. static auto prefixItems(ParserContext<A> const & context) {
  241. EXPECT(context.schema.type() == adapter::Type::Array);
  242. std::vector<schema::Node const *> rval;
  243. size_t index = 0;
  244. for (auto subschema : context.schema.as_array()) {
  245. rval.push_back(context.child(subschema, index).node());
  246. ++index;
  247. }
  248. return std::make_unique<constraint::TupleConstraint>(rval);
  249. }
  250. static pConstraint additionalItems(ParserContext<A> const & context) {
  251. std::string const prefix =
  252. context.version >= schema::Version::Draft2020_12 ? "prefixItems" : "items";
  253. Object const & parent = *context.parent;
  254. size_t start_after = 0;
  255. if (not prefix.empty() && parent.contains(prefix)) {
  256. start_after = parent[prefix].as_integer();
  257. }
  258. using C = constraint::AdditionalItemsConstraint;
  259. if (context.version < schema::Version::Draft06 &&
  260. context.schema.type() == adapter::Type::Boolean) {
  261. return std::make_unique<C>(context.always(), start_after);
  262. }
  263. return std::make_unique<C>(context.node(), start_after);
  264. }
  265. static pConstraint itemsTupleOrVector(ParserContext<A> const & context) {
  266. if (context.schema.type() == adapter::Type::Array) {
  267. return prefixItems(context);
  268. }
  269. return additionalItems(context);
  270. }
  271. static auto unevaluatedItems(ParserContext<A> const & context) {
  272. return std::make_unique<constraint::UnevaluatedItemsConstraint>(context.node());
  273. }
  274. static pConstraint uniqueItems(ParserContext<A> const & context) {
  275. EXPECT(context.schema.type() == adapter::Type::Boolean);
  276. if (not context.schema.as_boolean()) {
  277. return nullptr;
  278. }
  279. return std::make_unique<constraint::UniqueItemsConstraint>();
  280. }
  281. // SECTION: Object Constraints
  282. static auto required(ParserContext<A> const & context) {
  283. EXPECT(context.schema.type() == adapter::Type::Array);
  284. std::unordered_set<std::string> rval;
  285. for (auto subschema : context.schema.as_array()) {
  286. EXPECT(subschema.type() == adapter::Type::String);
  287. rval.insert(subschema.as_string());
  288. }
  289. return std::make_unique<constraint::RequiredConstraint>(rval);
  290. }
  291. static auto minProperties(ParserContext<A> const & context) {
  292. EXPECT(context.schema.type() == adapter::Type::Integer);
  293. return std::make_unique<constraint::MinPropertiesConstraint>(context.schema.as_integer());
  294. }
  295. static auto maxProperties(ParserContext<A> const & context) {
  296. EXPECT(context.schema.type() == adapter::Type::Integer);
  297. return std::make_unique<constraint::MaxPropertiesConstraint>(context.schema.as_integer());
  298. }
  299. static auto patternProperties(ParserContext<A> const & context) {
  300. EXPECT(context.schema.type() == adapter::Type::Object);
  301. std::vector<std::pair<std::string, schema::Node const *>> rval;
  302. for (auto [prop, subschema] : context.schema.as_object()) {
  303. rval.emplace_back(prop, context.child(subschema, prop).node());
  304. }
  305. return std::make_unique<constraint::PatternPropertiesConstraint>(rval);
  306. }
  307. static auto properties(ParserContext<A> const & context) {
  308. EXPECT(context.schema.type() == adapter::Type::Object);
  309. std::map<std::string, schema::Node const *> rval;
  310. for (auto [prop, subschema] : context.schema.as_object()) {
  311. rval.emplace(prop, context.child(subschema, prop).node());
  312. }
  313. return std::make_unique<constraint::PropertiesConstraint>(rval);
  314. }
  315. static auto propertyNames(ParserContext<A> const & context) {
  316. return std::make_unique<constraint::PropertyNamesConstraint>(context.node());
  317. }
  318. static auto unevaluatedProperties(ParserContext<A> const & context) {
  319. return std::make_unique<constraint::UnevaluatedPropertiesConstraint>(context.node());
  320. }
  321. static auto additionalProperties(ParserContext<A> const & context) {
  322. std::unordered_set<std::string> properties;
  323. std::vector<std::string> patterns;
  324. Object const & parent = *context.parent;
  325. if (parent.contains("properties")) {
  326. for (auto [key, _] : parent["properties"].as_object()) {
  327. properties.insert(key);
  328. }
  329. }
  330. if (parent.contains("patternProperties")) {
  331. for (auto [key, _] : parent["patternProperties"].as_object()) {
  332. patterns.push_back(key);
  333. }
  334. }
  335. using C = constraint::AdditionalPropertiesConstraint;
  336. if (context.version < schema::Version::Draft06 &&
  337. context.schema.type() == adapter::Type::Boolean) {
  338. return std::make_unique<C>(context.always(), properties, patterns);
  339. }
  340. return std::make_unique<C>(context.node(), properties, patterns);
  341. }
  342. static auto dependencies(ParserContext<A> const & context) {
  343. EXPECT(context.schema.type() == adapter::Type::Object);
  344. std::map<std::string, schema::Node const *> schemas;
  345. std::map<std::string, std::unordered_set<std::string>> required;
  346. for (auto [prop, subschema] : context.schema.as_object()) {
  347. if (subschema.type() == adapter::Type::Object) {
  348. schemas.emplace(prop, context.child(subschema, prop).node());
  349. } else {
  350. for (auto key : subschema.as_array()) {
  351. EXPECT(key.type() == adapter::Type::String);
  352. required[prop].insert(key.as_string());
  353. }
  354. }
  355. }
  356. return std::make_unique<constraint::DependenciesConstraint>(schemas, required);
  357. }
  358. static auto dependentSchemas(ParserContext<A> const & context) {
  359. EXPECT(context.schema.type() == adapter::Type::Object);
  360. std::map<std::string, schema::Node const *> rval;
  361. for (auto [prop, subschema] : context.schema.as_object()) {
  362. rval.emplace(prop, context.child(subschema, prop).node());
  363. }
  364. return std::make_unique<constraint::DependenciesConstraint>(rval);
  365. }
  366. static auto dependentRequired(ParserContext<A> const & context) {
  367. EXPECT(context.schema.type() == adapter::Type::Object);
  368. std::map<std::string, std::unordered_set<std::string>> rval;
  369. for (auto [prop, subschema] : context.schema.as_object()) {
  370. EXPECT(subschema.type() == adapter::Type::Array);
  371. for (auto key : subschema.as_array()) {
  372. EXPECT(key.type() == adapter::Type::String);
  373. rval[prop].insert(key.as_string());
  374. }
  375. }
  376. return std::make_unique<constraint::DependenciesConstraint>(rval);
  377. }
  378. };
  379. }