validation_visitor.h 14 KB

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