constraint.h 21 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535
  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/parser_context.h>
  16. #include <jvalidate/enum.h>
  17. #include <jvalidate/forward.h>
  18. namespace jvalidate {
  19. template <Adapter A> class ConstraintFactory {
  20. public:
  21. using pConstraint = std::unique_ptr<constraint::Constraint>;
  22. using Object = decltype(std::declval<A>().as_object());
  23. using MakeConstraint = std::function<pConstraint(detail::ParserContext<A> const &)>;
  24. template <typename V> using Versioned = std::map<schema::Version, V, std::greater<>>;
  25. template <typename V> using Keywords = std::unordered_map<std::string_view, V>;
  26. private:
  27. using Self = ConstraintFactory<A>;
  28. private:
  29. Keywords<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. Keywords<Versioned<MakeConstraint>> 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", {{schema::Version::Draft04, &Self::dependencies}}},
  53. {"dependentRequired", {{schema::Version::Draft2019_09, &Self::dependentRequired}}},
  54. {"dependentSchemas", {{schema::Version::Draft2019_09, &Self::dependentSchemas}}},
  55. {"divisibleBy",
  56. {{schema::Version::Draft04, &Self::multipleOf}, {schema::Version::Draft04, nullptr}}},
  57. {"exclusiveMaximum", {{schema::Version::Draft06, &Self::exclusiveMaximum}}},
  58. {"exclusiveMinimum", {{schema::Version::Draft06, &Self::exclusiveMinimum}}},
  59. {"format",
  60. {{schema::Version::Draft04, &Self::warnUnimplemented},
  61. {schema::Version::Draft2020_12, nullptr}}},
  62. {"format-assertion", {{schema::Version::Draft2020_12, &Self::fatalUnimplemented}}},
  63. {"if", {{schema::Version::Draft07, &Self::ifThenElse}}},
  64. {"items",
  65. {{schema::Version::Draft04, &Self::itemsTupleOrVector},
  66. {schema::Version::Draft2020_12, &Self::additionalItems}}},
  67. {"maxProperties", {{schema::Version::Draft04, &Self::maxProperties}}},
  68. {"minProperties", {{schema::Version::Draft04, &Self::minProperties}}},
  69. {"multipleOf", {{schema::Version::Draft04, &Self::multipleOf}}},
  70. {"not", {{schema::Version::Draft04, &Self::isNot}}},
  71. {"oneOf", {{schema::Version::Draft04, &Self::oneOf}}},
  72. {"prefixItems", {{schema::Version::Draft2020_12, &Self::prefixItems}}},
  73. {"propertyNames", {{schema::Version::Draft06, &Self::propertyNames}}},
  74. {"required", {{schema::Version::Draft04, &Self::required}}},
  75. {"unevaluatedItems", {{schema::Version::Draft2019_09, &Self::unevaluatedItems}}},
  76. {"unevaluatedProperties", {{schema::Version::Draft2019_09, &Self::unevaluatedProperties}}},
  77. };
  78. Keywords<Versioned<std::set<schema::Wraps>>> keywords_{
  79. {"$defs", {{schema::Version::Draft2019_09, {schema::Wraps::Object}}}},
  80. {"additionalItems",
  81. {{schema::Version::Draft04, {schema::Wraps::Schema}}, {schema::Version::Draft2020_12, {}}}},
  82. {"additionalProperties", {{schema::Version::Draft04, {schema::Wraps::Schema}}}},
  83. {"allOf", {{schema::Version::Draft04, {schema::Wraps::Array}}}},
  84. {"anyOf", {{schema::Version::Draft04, {schema::Wraps::Array}}}},
  85. {"definitions",
  86. {{schema::Version::Draft04, {schema::Wraps::Object}}, {schema::Version::Draft2019_09, {}}}},
  87. {"dependencies",
  88. {{schema::Version::Draft04, {schema::Wraps::Object}}, {schema::Version::Draft2019_09, {}}}},
  89. {"dependentSchemas", {{schema::Version::Draft2019_09, {schema::Wraps::Object}}}},
  90. {"else", {{schema::Version::Draft04, {schema::Wraps::Schema}}}},
  91. {"if", {{schema::Version::Draft04, {schema::Wraps::Schema}}}},
  92. {"items",
  93. {{schema::Version::Draft04, {schema::Wraps::Array, schema::Wraps::Schema}},
  94. {schema::Version::Draft2020_12, {schema::Wraps::Schema}}}},
  95. {"not", {{schema::Version::Draft04, {schema::Wraps::Schema}}}},
  96. {"oneOf", {{schema::Version::Draft04, {schema::Wraps::Array}}}},
  97. {"patternProperties", {{schema::Version::Draft04, {schema::Wraps::Object}}}},
  98. {"prefixItems", {{schema::Version::Draft2020_12, {schema::Wraps::Array}}}},
  99. {"properties", {{schema::Version::Draft04, {schema::Wraps::Object}}}},
  100. {"then", {{schema::Version::Draft04, {schema::Wraps::Schema}}}},
  101. {"unevaluatedItems", {{schema::Version::Draft2020_12, {schema::Wraps::Schema}}}},
  102. {"unevaluatedProperties", {{schema::Version::Draft2020_12, {schema::Wraps::Schema}}}},
  103. };
  104. public:
  105. ConstraintFactory() = default;
  106. explicit ConstraintFactory(
  107. Keywords<MakeConstraint> const & user_keywords,
  108. Keywords<Versioned<MakeConstraint>> const & user_versioned_keywords = {}) {
  109. constraints_.insert(constraints_.end(), user_keywords.begin(), user_keywords.end());
  110. versioned_constraints_.insert(versioned_constraints_.end(), user_versioned_keywords.begin(),
  111. user_versioned_keywords.end());
  112. }
  113. bool is_post_constraint(std::string_view key) const {
  114. return key == "unevaluatedItems" || key == "unevaluatedProperties";
  115. }
  116. Keywords<std::set<schema::Wraps>> keywords(schema::Version version) const {
  117. Keywords<std::set<schema::Wraps>> rval;
  118. for (auto const & [key, versions] : keywords_) {
  119. if (auto it = versions.lower_bound(version); it != versions.end()) {
  120. rval.emplace(key, it->second);
  121. }
  122. }
  123. return rval;
  124. }
  125. MakeConstraint operator()(std::string_view key, schema::Version version) const {
  126. if (auto it = constraints_.find(key); it != constraints_.end()) {
  127. return it->second;
  128. }
  129. if (auto it = versioned_constraints_.find(key); it != versioned_constraints_.end()) {
  130. if (auto vit = it->second.lower_bound(version); vit != it->second.end()) {
  131. return vit->second;
  132. }
  133. }
  134. return nullptr;
  135. }
  136. // SECTION: Untyped Constraints
  137. static pConstraint warnUnimplemented(detail::ParserContext<A> const & context) {
  138. std::cerr << "Unimplemented constraint " << context.where << "\n";
  139. return nullptr;
  140. }
  141. static pConstraint fatalUnimplemented(detail::ParserContext<A> const & context) {
  142. JVALIDATE_THROW(std::runtime_error, "Unimplemented constraint " << context.where);
  143. }
  144. static auto type(detail::ParserContext<A> const & context) {
  145. static std::unordered_map<std::string_view, adapter::Type> const s_type_names{
  146. {"null", adapter::Type::Null}, {"boolean", adapter::Type::Boolean},
  147. {"integer", adapter::Type::Integer}, {"number", adapter::Type::Number},
  148. {"string", adapter::Type::String}, {"array", adapter::Type::Array},
  149. {"object", adapter::Type::Object},
  150. };
  151. auto to_type = [](std::string_view type) {
  152. EXPECT_M(s_type_names.contains(type), "Unknown type " << type);
  153. return s_type_names.at(type);
  154. };
  155. adapter::Type const type = context.schema.type();
  156. if (type == adapter::Type::String) {
  157. return std::make_unique<constraint::TypeConstraint>(to_type(context.schema.as_string()));
  158. }
  159. EXPECT(type == adapter::Type::Array);
  160. std::set<adapter::Type> types;
  161. for (auto subschema : context.schema.as_array()) {
  162. types.insert(to_type(subschema.as_string()));
  163. }
  164. return std::make_unique<constraint::TypeConstraint>(types);
  165. }
  166. static pConstraint ifThenElse(detail::ParserContext<A> const & context) {
  167. schema::Node const * then_ = context.fixed_schema(true);
  168. if (context.parent->contains("then")) {
  169. then_ = context.neighbor("then").node();
  170. }
  171. schema::Node const * else_ = context.fixed_schema(true);
  172. if (context.parent->contains("else")) {
  173. else_ = context.neighbor("else").node();
  174. }
  175. return std::make_unique<constraint::ConditionalConstraint>(context.node(), then_, else_);
  176. }
  177. static auto isInEnumuration(detail::ParserContext<A> const & context) {
  178. EXPECT(context.schema.type() == adapter::Type::Array);
  179. std::vector<std::unique_ptr<adapter::Const const>> rval;
  180. for (auto subschema : context.schema.as_array()) {
  181. rval.push_back(subschema.freeze());
  182. }
  183. return std::make_unique<constraint::EnumConstraint>(std::move(rval));
  184. }
  185. static auto isConstant(detail::ParserContext<A> const & context) {
  186. return std::make_unique<constraint::EnumConstraint>(context.schema.freeze());
  187. }
  188. static auto allOf(detail::ParserContext<A> const & context) {
  189. EXPECT(context.schema.type() == adapter::Type::Array);
  190. std::vector<schema::Node const *> rval;
  191. size_t index = 0;
  192. for (auto subschema : context.schema.as_array()) {
  193. rval.push_back(context.child(subschema, index).node());
  194. ++index;
  195. }
  196. return std::make_unique<constraint::AllOfConstraint>(rval);
  197. }
  198. static auto anyOf(detail::ParserContext<A> const & context) {
  199. EXPECT(context.schema.type() == adapter::Type::Array);
  200. std::vector<schema::Node const *> rval;
  201. size_t index = 0;
  202. for (auto subschema : context.schema.as_array()) {
  203. rval.push_back(context.child(subschema, index).node());
  204. ++index;
  205. }
  206. return std::make_unique<constraint::AnyOfConstraint>(rval);
  207. }
  208. static auto oneOf(detail::ParserContext<A> const & context) {
  209. EXPECT(context.schema.type() == adapter::Type::Array);
  210. std::vector<schema::Node const *> rval;
  211. size_t index = 0;
  212. for (auto subschema : context.schema.as_array()) {
  213. rval.push_back(context.child(subschema, index).node());
  214. ++index;
  215. }
  216. return std::make_unique<constraint::OneOfConstraint>(rval);
  217. }
  218. static auto isNot(detail::ParserContext<A> const & context) {
  219. return std::make_unique<constraint::NotConstraint>(context.node());
  220. }
  221. // SECTION: Numeric Constraints
  222. static auto minimum(detail::ParserContext<A> const & context) {
  223. double value = context.schema.as_number();
  224. if (context.version < schema::Version::Draft06 &&
  225. context.parent->contains("exclusiveMinimum")) {
  226. auto exclusive = (*context.parent)["exclusiveMinimum"];
  227. EXPECT(exclusive.type() == adapter::Type::Boolean);
  228. return std::make_unique<constraint::MinimumConstraint>(value, exclusive.as_boolean());
  229. }
  230. return std::make_unique<constraint::MinimumConstraint>(value, false);
  231. }
  232. static pConstraint exclusiveMinimum(detail::ParserContext<A> const & context) {
  233. double value = context.schema.as_number();
  234. return std::make_unique<constraint::MinimumConstraint>(value, true);
  235. }
  236. static auto maximum(detail::ParserContext<A> const & context) {
  237. double value = context.schema.as_number();
  238. if (context.version < schema::Version::Draft06 &&
  239. context.parent->contains("exclusiveMaximum")) {
  240. auto exclusive = (*context.parent)["exclusiveMaximum"];
  241. EXPECT(exclusive.type() == adapter::Type::Boolean);
  242. return std::make_unique<constraint::MaximumConstraint>(value, exclusive.as_boolean());
  243. }
  244. return std::make_unique<constraint::MaximumConstraint>(value, false);
  245. }
  246. static pConstraint exclusiveMaximum(detail::ParserContext<A> const & context) {
  247. double value = context.schema.as_number();
  248. return std::make_unique<constraint::MaximumConstraint>(value, true);
  249. }
  250. static auto multipleOf(detail::ParserContext<A> const & context) {
  251. double value = context.schema.as_number();
  252. return std::make_unique<constraint::MultipleOfConstraint>(value);
  253. }
  254. // SECTION: String Constraints
  255. static auto minLength(detail::ParserContext<A> const & context) {
  256. EXPECT(context.schema.type() == adapter::Type::Integer ||
  257. context.schema.type() == adapter::Type::Number);
  258. return std::make_unique<constraint::MinLengthConstraint>(context.schema.as_integer());
  259. }
  260. static auto maxLength(detail::ParserContext<A> const & context) {
  261. EXPECT(context.schema.type() == adapter::Type::Integer ||
  262. context.schema.type() == adapter::Type::Number);
  263. return std::make_unique<constraint::MaxLengthConstraint>(context.schema.as_integer());
  264. }
  265. static auto pattern(detail::ParserContext<A> const & context) {
  266. return std::make_unique<constraint::PatternConstraint>(context.schema.as_string());
  267. }
  268. // SECTION: Array Constraints
  269. static auto contains(detail::ParserContext<A> const & context) {
  270. if (context.version < schema::Version::Draft2019_09) {
  271. return std::make_unique<constraint::ContainsConstraint>(context.node());
  272. }
  273. std::optional<size_t> maximum;
  274. std::optional<size_t> minimum;
  275. if (context.parent->contains("maxContains")) {
  276. maximum = (*context.parent)["maxContains"].as_integer();
  277. }
  278. if (context.parent->contains("minContains")) {
  279. minimum = (*context.parent)["minContains"].as_integer();
  280. }
  281. return std::make_unique<constraint::ContainsConstraint>(context.node(), minimum, maximum);
  282. }
  283. static auto minItems(detail::ParserContext<A> const & context) {
  284. EXPECT(context.schema.type() == adapter::Type::Integer ||
  285. context.schema.type() == adapter::Type::Number);
  286. return std::make_unique<constraint::MinItemsConstraint>(context.schema.as_integer());
  287. }
  288. static auto maxItems(detail::ParserContext<A> const & context) {
  289. EXPECT(context.schema.type() == adapter::Type::Integer ||
  290. context.schema.type() == adapter::Type::Number);
  291. return std::make_unique<constraint::MaxItemsConstraint>(context.schema.as_integer());
  292. }
  293. static auto prefixItems(detail::ParserContext<A> const & context) {
  294. EXPECT(context.schema.type() == adapter::Type::Array);
  295. std::vector<schema::Node const *> rval;
  296. size_t index = 0;
  297. for (auto subschema : context.schema.as_array()) {
  298. rval.push_back(context.child(subschema, index).node());
  299. ++index;
  300. }
  301. return std::make_unique<constraint::TupleConstraint>(rval);
  302. }
  303. static auto additionalItemsAfter(detail::ParserContext<A> const & context, size_t n) {
  304. using C = constraint::AdditionalItemsConstraint;
  305. if (context.version < schema::Version::Draft06 &&
  306. context.schema.type() == adapter::Type::Boolean) {
  307. return std::make_unique<C>(context.always(), n);
  308. }
  309. return std::make_unique<C>(context.node(), n);
  310. }
  311. static pConstraint additionalItems(detail::ParserContext<A> const & context) {
  312. std::string const prefix =
  313. context.version >= schema::Version::Draft2020_12 ? "prefixItems" : "items";
  314. Object const & parent = *context.parent;
  315. // Before Draft 2020-12, the "items" could be either a subschema or a tuple.
  316. // When not provided, we therefore treat it as an "accept-all" schema, and
  317. // thus will never have additionalItems to process. Similarly - if it is an
  318. // Object, then it must act on all items.
  319. if (context.version < schema::Version::Draft2020_12 &&
  320. (not parent.contains(prefix) || parent[prefix].type() == adapter::Type::Object)) {
  321. return nullptr;
  322. }
  323. return additionalItemsAfter(context, parent[prefix].array_size());
  324. }
  325. static pConstraint itemsTupleOrVector(detail::ParserContext<A> const & context) {
  326. if (context.schema.type() == adapter::Type::Array) {
  327. return prefixItems(context);
  328. }
  329. return additionalItemsAfter(context, 0);
  330. }
  331. static auto unevaluatedItems(detail::ParserContext<A> const & context) {
  332. return std::make_unique<constraint::UnevaluatedItemsConstraint>(context.node());
  333. }
  334. static pConstraint uniqueItems(detail::ParserContext<A> const & context) {
  335. EXPECT(context.schema.type() == adapter::Type::Boolean);
  336. if (not context.schema.as_boolean()) {
  337. return nullptr;
  338. }
  339. return std::make_unique<constraint::UniqueItemsConstraint>();
  340. }
  341. // SECTION: Object Constraints
  342. static auto required(detail::ParserContext<A> const & context) {
  343. EXPECT(context.schema.type() == adapter::Type::Array);
  344. std::unordered_set<std::string> rval;
  345. for (auto subschema : context.schema.as_array()) {
  346. EXPECT(subschema.type() == adapter::Type::String);
  347. rval.insert(subschema.as_string());
  348. }
  349. return std::make_unique<constraint::RequiredConstraint>(rval);
  350. }
  351. static auto minProperties(detail::ParserContext<A> const & context) {
  352. EXPECT(context.schema.type() == adapter::Type::Integer ||
  353. context.schema.type() == adapter::Type::Number);
  354. return std::make_unique<constraint::MinPropertiesConstraint>(context.schema.as_integer());
  355. }
  356. static auto maxProperties(detail::ParserContext<A> const & context) {
  357. EXPECT(context.schema.type() == adapter::Type::Integer ||
  358. context.schema.type() == adapter::Type::Number);
  359. return std::make_unique<constraint::MaxPropertiesConstraint>(context.schema.as_integer());
  360. }
  361. static auto patternProperties(detail::ParserContext<A> const & context) {
  362. EXPECT(context.schema.type() == adapter::Type::Object);
  363. std::vector<std::pair<std::string, schema::Node const *>> rval;
  364. for (auto [prop, subschema] : context.schema.as_object()) {
  365. rval.emplace_back(prop, context.child(subschema, prop).node());
  366. }
  367. return std::make_unique<constraint::PatternPropertiesConstraint>(rval);
  368. }
  369. static auto properties(detail::ParserContext<A> const & context) {
  370. EXPECT(context.schema.type() == adapter::Type::Object);
  371. std::map<std::string, schema::Node const *> rval;
  372. for (auto [prop, subschema] : context.schema.as_object()) {
  373. rval.emplace(prop, context.child(subschema, prop).node());
  374. }
  375. return std::make_unique<constraint::PropertiesConstraint>(rval);
  376. }
  377. static auto propertyNames(detail::ParserContext<A> const & context) {
  378. return std::make_unique<constraint::PropertyNamesConstraint>(context.node());
  379. }
  380. static auto unevaluatedProperties(detail::ParserContext<A> const & context) {
  381. return std::make_unique<constraint::UnevaluatedPropertiesConstraint>(context.node());
  382. }
  383. static auto additionalProperties(detail::ParserContext<A> const & context) {
  384. std::unordered_set<std::string> properties;
  385. std::vector<std::string> patterns;
  386. Object const & parent = *context.parent;
  387. if (parent.contains("properties")) {
  388. for (auto [key, _] : parent["properties"].as_object()) {
  389. properties.insert(key);
  390. }
  391. }
  392. if (parent.contains("patternProperties")) {
  393. for (auto [key, _] : parent["patternProperties"].as_object()) {
  394. patterns.push_back(key);
  395. }
  396. }
  397. using C = constraint::AdditionalPropertiesConstraint;
  398. if (context.version < schema::Version::Draft06 &&
  399. context.schema.type() == adapter::Type::Boolean) {
  400. return std::make_unique<C>(context.always(), properties, patterns);
  401. }
  402. return std::make_unique<C>(context.node(), properties, patterns);
  403. }
  404. static auto dependencies(detail::ParserContext<A> const & context) {
  405. EXPECT(context.schema.type() == adapter::Type::Object);
  406. std::map<std::string, schema::Node const *> schemas;
  407. std::map<std::string, std::unordered_set<std::string>> required;
  408. for (auto [prop, subschema] : context.schema.as_object()) {
  409. if (subschema.type() == adapter::Type::Array) {
  410. for (auto key : subschema.as_array()) {
  411. EXPECT(key.type() == adapter::Type::String);
  412. required[prop].insert(key.as_string());
  413. }
  414. } else {
  415. schemas.emplace(prop, context.child(subschema, prop).node());
  416. }
  417. }
  418. return std::make_unique<constraint::DependenciesConstraint>(schemas, required);
  419. }
  420. static auto dependentSchemas(detail::ParserContext<A> const & context) {
  421. EXPECT(context.schema.type() == adapter::Type::Object);
  422. std::map<std::string, schema::Node const *> rval;
  423. for (auto [prop, subschema] : context.schema.as_object()) {
  424. rval.emplace(prop, context.child(subschema, prop).node());
  425. }
  426. return std::make_unique<constraint::DependenciesConstraint>(rval);
  427. }
  428. static auto dependentRequired(detail::ParserContext<A> const & context) {
  429. EXPECT(context.schema.type() == adapter::Type::Object);
  430. std::map<std::string, std::unordered_set<std::string>> rval;
  431. for (auto [prop, subschema] : context.schema.as_object()) {
  432. EXPECT(subschema.type() == adapter::Type::Array);
  433. for (auto key : subschema.as_array()) {
  434. EXPECT(key.type() == adapter::Type::String);
  435. rval[prop].insert(key.as_string());
  436. }
  437. }
  438. return std::make_unique<constraint::DependenciesConstraint>(rval);
  439. }
  440. };
  441. }