validation_visitor.h 18 KB

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