validation_visitor.h 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500
  1. #pragma once
  2. #include <unordered_map>
  3. #include <jvalidate/constraint/array_constraint.h>
  4. #include <jvalidate/constraint/general_constraint.h>
  5. #include <jvalidate/constraint/number_constraint.h>
  6. #include <jvalidate/constraint/object_constraint.h>
  7. #include <jvalidate/constraint/string_constraint.h>
  8. #include <jvalidate/constraint/visitor.h>
  9. #include <jvalidate/detail/expect.h>
  10. #include <jvalidate/detail/iostream.h>
  11. #include <jvalidate/detail/pointer.h>
  12. #include <jvalidate/forward.h>
  13. #include <jvalidate/schema.h>
  14. #include <jvalidate/status.h>
  15. #include <jvalidate/validation_config.h>
  16. #include <jvalidate/validation_result.h>
  17. #define VISITED(type) std::get<std::unordered_set<type>>(visited_)
  18. #define NOOP_UNLESS_TYPE(etype) RETURN_UNLESS(adapter::Type::etype & document_.type(), Status::Noop)
  19. #define BREAK_EARLY_IF_NO_RESULT_TREE() \
  20. do { \
  21. if (rval == Status::Reject and not result_) { \
  22. break; \
  23. } \
  24. } while (false)
  25. namespace jvalidate {
  26. template <Adapter A, RegexEngine RE>
  27. class ValidationVisitor : public constraint::ConstraintVisitor {
  28. private:
  29. A document_;
  30. detail::Pointer where_;
  31. detail::Pointer schema_path_;
  32. schema::Node const & schema_;
  33. ValidationResult * result_;
  34. ValidationConfig const & cfg_;
  35. std::unordered_map<std::string, RE> & regex_cache_;
  36. mutable std::tuple<std::unordered_set<size_t>, std::unordered_set<std::string>> visited_;
  37. public:
  38. ValidationVisitor(A const & json, schema::Node const & schema, ValidationConfig const & cfg,
  39. std::unordered_map<std::string, RE> & regex_cache, ValidationResult * result)
  40. : ValidationVisitor(json, schema, cfg, regex_cache, {}, {}, result) {}
  41. Status visit(constraint::TypeConstraint const & cons) const {
  42. adapter::Type const type = document_.type();
  43. for (adapter::Type const accept : cons.types) {
  44. if (accept & type) {
  45. return Status::Accept;
  46. }
  47. }
  48. add_error("type ", type, " is not one of {", cons.types, '}');
  49. return Status::Reject;
  50. }
  51. Status visit(constraint::ExtensionConstraint const & cons) const {
  52. return cons.validate(document_, where_, result_);
  53. }
  54. Status visit(constraint::EnumConstraint const & cons) const {
  55. auto is_equal = [this](auto const & frozen) {
  56. return document_.equals(frozen, cfg_.strict_equality);
  57. };
  58. for (auto const & option : cons.enumeration) {
  59. if (option->apply(is_equal)) {
  60. return Status::Accept;
  61. }
  62. }
  63. add_error("equals none of the values");
  64. return Status::Reject;
  65. }
  66. Status visit(constraint::AllOfConstraint const & cons) const {
  67. Status rval = Status::Accept;
  68. size_t i = 0;
  69. for (schema::Node const * subschema : cons.children) {
  70. rval &= validate_subschema(subschema, i);
  71. ++i;
  72. BREAK_EARLY_IF_NO_RESULT_TREE();
  73. }
  74. return rval;
  75. }
  76. Status visit(constraint::AnyOfConstraint const & cons) const {
  77. size_t i = 0;
  78. for (schema::Node const * subschema : cons.children) {
  79. if (validate_subschema(subschema, i)) {
  80. return Status::Accept;
  81. }
  82. ++i;
  83. }
  84. return Status::Reject;
  85. }
  86. Status visit(constraint::OneOfConstraint const & cons) const {
  87. size_t matches = 0;
  88. size_t i = 0;
  89. for (schema::Node const * subschema : cons.children) {
  90. if (validate_subschema(subschema, i)) {
  91. ++matches;
  92. }
  93. ++i;
  94. }
  95. return matches == 1 ? Status::Accept : Status::Reject;
  96. }
  97. Status visit(constraint::NotConstraint const & cons) const {
  98. return validate_subschema(cons.child, "not") == Status::Reject;
  99. }
  100. Status visit(constraint::ConditionalConstraint const & cons) const {
  101. if (validate_subschema(cons.if_constraint, "if")) {
  102. return validate_subschema(cons.then_constraint, "then");
  103. }
  104. return validate_subschema(cons.else_constraint, "else");
  105. }
  106. Status visit(constraint::MaximumConstraint const & cons) const {
  107. switch (document_.type()) {
  108. case adapter::Type::Integer:
  109. return cons(document_.as_integer());
  110. case adapter::Type::Number:
  111. return cons(document_.as_number());
  112. default:
  113. return Status::Noop;
  114. }
  115. }
  116. Status visit(constraint::MinimumConstraint const & cons) const {
  117. switch (document_.type()) {
  118. case adapter::Type::Integer:
  119. return cons(document_.as_integer());
  120. case adapter::Type::Number:
  121. return cons(document_.as_number());
  122. default:
  123. return Status::Noop;
  124. }
  125. }
  126. Status visit(constraint::MultipleOfConstraint const & cons) const {
  127. NOOP_UNLESS_TYPE(Number);
  128. return cons(document_.as_number());
  129. }
  130. Status visit(constraint::MaxLengthConstraint const & cons) const {
  131. NOOP_UNLESS_TYPE(String);
  132. return cons(document_.as_string());
  133. }
  134. Status visit(constraint::MinLengthConstraint const & cons) const {
  135. NOOP_UNLESS_TYPE(String);
  136. return cons(document_.as_string());
  137. }
  138. Status visit(constraint::PatternConstraint const & cons) const {
  139. NOOP_UNLESS_TYPE(String);
  140. RE const & regex = regex_cache_.try_emplace(cons.regex, cons.regex).first->second;
  141. return regex.search(document_.as_string());
  142. }
  143. Status visit(constraint::AdditionalItemsConstraint const & cons) const {
  144. NOOP_UNLESS_TYPE(Array);
  145. auto array = document_.as_array();
  146. Status rval = Status::Accept;
  147. for (size_t i = cons.applies_after_nth; i < array.size(); ++i) {
  148. rval &= validate_subschema_on(cons.subschema, array[i], i);
  149. BREAK_EARLY_IF_NO_RESULT_TREE();
  150. }
  151. return rval;
  152. }
  153. Status visit(constraint::ContainsConstraint const & cons) const {
  154. NOOP_UNLESS_TYPE(Array);
  155. auto array = document_.as_array();
  156. size_t const minimum = cons.minimum.value_or(1);
  157. size_t const maximum = cons.maximum.value_or(array.size());
  158. size_t matches = 0;
  159. for (size_t i = 0; i < array.size(); ++i) {
  160. if (validate_subschema_on(cons.subschema, array[i], i)) {
  161. ++matches;
  162. }
  163. }
  164. if (matches < minimum) {
  165. return Status::Reject;
  166. }
  167. if (matches > maximum) {
  168. return Status::Reject;
  169. }
  170. return Status::Accept;
  171. }
  172. Status visit(constraint::MaxItemsConstraint const & cons) const {
  173. NOOP_UNLESS_TYPE(Array);
  174. return cons(document_.as_array());
  175. }
  176. Status visit(constraint::MinItemsConstraint const & cons) const {
  177. NOOP_UNLESS_TYPE(Array);
  178. return cons(document_.as_array());
  179. }
  180. Status visit(constraint::TupleConstraint const & cons) const {
  181. NOOP_UNLESS_TYPE(Array);
  182. Status rval = Status::Accept;
  183. auto array = document_.as_array();
  184. size_t const n = std::min(cons.items.size(), array.size());
  185. for (size_t i = 0; i < n; ++i) {
  186. rval &= validate_subschema_on(cons.items[i], array[i], i);
  187. BREAK_EARLY_IF_NO_RESULT_TREE();
  188. }
  189. return rval;
  190. }
  191. Status visit(constraint::UniqueItemsConstraint const & cons) const {
  192. NOOP_UNLESS_TYPE(Array);
  193. if constexpr (std::totally_ordered<A>) {
  194. std::set<A> cache;
  195. for (A const & elem : document_.as_array()) {
  196. if (not cache.insert(elem).second) {
  197. return Status::Reject;
  198. }
  199. }
  200. } else {
  201. auto array = document_.as_array();
  202. for (size_t i = 0; i < array.size(); ++i) {
  203. for (size_t j = i + 1; j < array.size(); ++j) {
  204. if (array[i].equals(array[j], true)) {
  205. return Status::Reject;
  206. }
  207. }
  208. }
  209. }
  210. return Status::Accept;
  211. }
  212. Status visit(constraint::AdditionalPropertiesConstraint const & cons) const {
  213. NOOP_UNLESS_TYPE(Object);
  214. auto matches_any_pattern = [this, &cons](std::string const & key) {
  215. for (auto & pattern : cons.patterns) {
  216. RE const & regex = regex_cache_.try_emplace(pattern, pattern).first->second;
  217. if (regex.search(key)) {
  218. return true;
  219. }
  220. }
  221. return false;
  222. };
  223. Status rval = Status::Accept;
  224. for (auto const & [key, elem] : document_.as_object()) {
  225. if (not cons.properties.contains(key) && not matches_any_pattern(key)) {
  226. rval &= validate_subschema_on(cons.subschema, elem, key);
  227. }
  228. BREAK_EARLY_IF_NO_RESULT_TREE();
  229. }
  230. return rval;
  231. }
  232. Status visit(constraint::DependenciesConstraint const & cons) const {
  233. NOOP_UNLESS_TYPE(Object);
  234. auto object = document_.as_object();
  235. Status rval = Status::Accept;
  236. for (auto const & [key, subschema] : cons.subschemas) {
  237. if (not object.contains(key)) {
  238. continue;
  239. }
  240. rval &= validate_subschema(subschema, key);
  241. BREAK_EARLY_IF_NO_RESULT_TREE();
  242. }
  243. for (auto [key, required] : cons.required) {
  244. if (not object.contains(key)) {
  245. continue;
  246. }
  247. for (auto const & [key, _] : object) {
  248. required.erase(key);
  249. }
  250. rval &= required.empty();
  251. BREAK_EARLY_IF_NO_RESULT_TREE();
  252. }
  253. return rval;
  254. }
  255. Status visit(constraint::MaxPropertiesConstraint const & cons) const {
  256. NOOP_UNLESS_TYPE(Object);
  257. return cons(document_.as_object());
  258. }
  259. Status visit(constraint::MinPropertiesConstraint const & cons) const {
  260. NOOP_UNLESS_TYPE(Object);
  261. return cons(document_.as_object());
  262. }
  263. Status visit(constraint::PatternPropertiesConstraint const & cons) const {
  264. NOOP_UNLESS_TYPE(Object);
  265. Status rval = Status::Accept;
  266. for (auto const & [pattern, subschema] : cons.properties) {
  267. RE const & regex = regex_cache_.try_emplace(pattern, pattern).first->second;
  268. for (auto const & [key, elem] : document_.as_object()) {
  269. if (regex.search(key)) {
  270. rval &= validate_subschema_on(subschema, elem, key);
  271. }
  272. BREAK_EARLY_IF_NO_RESULT_TREE();
  273. }
  274. }
  275. return rval;
  276. }
  277. Status visit(constraint::PropertiesConstraint const & cons) const {
  278. NOOP_UNLESS_TYPE(Object);
  279. Status rval = Status::Accept;
  280. auto object = document_.as_object();
  281. if constexpr (MutableAdapter<A>) {
  282. for (auto const & [key, subschema] : cons.properties) {
  283. auto const * default_value = subschema->default_value();
  284. if (default_value && not object.contains(key)) {
  285. object.assign(key, *default_value);
  286. }
  287. }
  288. }
  289. for (auto const & [key, elem] : object) {
  290. if (auto it = cons.properties.find(key); it != cons.properties.end()) {
  291. rval &= validate_subschema_on(it->second, elem, key);
  292. }
  293. BREAK_EARLY_IF_NO_RESULT_TREE();
  294. }
  295. return rval;
  296. }
  297. Status visit(constraint::PropertyNamesConstraint const & cons) const {
  298. NOOP_UNLESS_TYPE(Object);
  299. Status rval = Status::Accept;
  300. for (auto const & [key, _] : document_.as_object()) {
  301. // TODO(samjaffe): Should we prefer a std::string adapter like valijson?
  302. typename A::value_type key_json{key};
  303. rval &= validate_subschema_on(cons.key_schema, A(key_json), std::string("$$key"));
  304. }
  305. return rval;
  306. }
  307. Status visit(constraint::RequiredConstraint const & cons) const {
  308. NOOP_UNLESS_TYPE(Object);
  309. auto required = cons.properties;
  310. for (auto const & [key, _] : document_.as_object()) {
  311. required.erase(key);
  312. }
  313. if (required.empty()) {
  314. return Status::Accept;
  315. }
  316. add_error("missing required properties ", required);
  317. return Status::Reject;
  318. }
  319. Status visit(constraint::UnevaluatedItemsConstraint const & cons) const {
  320. NOOP_UNLESS_TYPE(Array);
  321. Status rval = Status::Accept;
  322. auto array = document_.as_array();
  323. for (size_t i = 0; i < array.size(); ++i) {
  324. if (not VISITED(size_t).contains(i)) {
  325. rval &= validate_subschema_on(cons.subschema, array[i], i);
  326. }
  327. BREAK_EARLY_IF_NO_RESULT_TREE();
  328. }
  329. return rval;
  330. }
  331. Status visit(constraint::UnevaluatedPropertiesConstraint const & cons) const {
  332. NOOP_UNLESS_TYPE(Object);
  333. Status rval = Status::Accept;
  334. for (auto const & [key, elem] : document_.as_object()) {
  335. if (not VISITED(std::string).contains(key)) {
  336. rval &= validate_subschema_on(cons.subschema, elem, key);
  337. }
  338. BREAK_EARLY_IF_NO_RESULT_TREE();
  339. }
  340. return rval;
  341. }
  342. Status validate() {
  343. if (auto const & reject = schema_.rejects_all()) {
  344. add_error(*reject);
  345. return Status::Reject;
  346. }
  347. Status rval = Status::Noop;
  348. if (auto ref = schema_.reference_schema()) {
  349. rval = validate_subschema(*ref, "$ref");
  350. }
  351. detail::Pointer const current_schema = schema_path_;
  352. for (auto const & [key, p_constraint] : schema_.constraints()) {
  353. BREAK_EARLY_IF_NO_RESULT_TREE();
  354. schema_path_ = current_schema / key;
  355. rval &= p_constraint->accept(*this);
  356. }
  357. for (auto const & [key, p_constraint] : schema_.post_constraints()) {
  358. BREAK_EARLY_IF_NO_RESULT_TREE();
  359. schema_path_ = current_schema / key;
  360. rval &= p_constraint->accept(*this);
  361. }
  362. return rval;
  363. }
  364. private:
  365. template <typename... Args> void add_error(Args &&... args) const {
  366. if (not result_) {
  367. return;
  368. }
  369. std::stringstream ss;
  370. using ::jvalidate::operator<<;
  371. [[maybe_unused]] int _[] = {(ss << std::forward<Args>(args), 0)...};
  372. result_->add_error(where_, schema_path_, ss.str());
  373. }
  374. template <typename C> static void merge_visited(C & to, C const & from) {
  375. to.insert(from.begin(), from.end());
  376. }
  377. ValidationVisitor(A const & json, schema::Node const & schema, ValidationConfig const & cfg,
  378. std::unordered_map<std::string, RE> & regex_cache,
  379. detail::Pointer const & where, detail::Pointer const & schema_path,
  380. ValidationResult * result)
  381. : document_(json), where_(where), schema_path_(schema_path), schema_(schema), cfg_(cfg),
  382. regex_cache_(regex_cache), result_(result) {}
  383. template <typename K>
  384. Status validate_subschema(schema::Node const * subschema, K const & key) const {
  385. EXPECT(subschema != &schema_); // TODO(samjaffe) - Figure out what's causing this infinite loop
  386. ValidationVisitor next(document_, *subschema, cfg_, regex_cache_, where_, schema_path_ / key,
  387. result_);
  388. Status rval = next.validate();
  389. merge_visited(std::get<0>(visited_), std::get<0>(next.visited_));
  390. merge_visited(std::get<1>(visited_), std::get<1>(next.visited_));
  391. return rval;
  392. }
  393. template <typename K>
  394. Status validate_subschema_on(schema::Node const * subschema, A const & document,
  395. K const & key) const {
  396. ValidationResult next;
  397. ValidationResult * pnext = result_ ? &next : nullptr;
  398. auto status = ValidationVisitor(document, *subschema, cfg_, regex_cache_, where_ / key,
  399. schema_path_, pnext)
  400. .validate();
  401. if (status != Status::Noop) {
  402. VISITED(K).insert(key);
  403. }
  404. if (status == Status::Reject and result_) {
  405. result_->add_error(std::move(next));
  406. }
  407. return status;
  408. }
  409. };
  410. }