constraint.h 17 KB

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