validation_visitor.h 14 KB

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