constraint.h 18 KB

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