validation_visitor.h 18 KB

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