validation_visitor.h 19 KB

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