validation_visitor.h 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458
  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. namespace jvalidate {
  18. template <Adapter A, RegexEngine RE>
  19. class ValidationVisitor : public constraint::ConstraintVisitor {
  20. private:
  21. A document_;
  22. detail::Pointer where_;
  23. schema::Node const & schema_;
  24. ValidationResult * result_;
  25. ValidationResult * local_result_;
  26. ValidationConfig const & cfg_;
  27. std::unordered_map<std::string, RE> & regex_cache_;
  28. public:
  29. ValidationVisitor(A const & json, schema::Node const & schema, ValidationConfig const & cfg,
  30. std::unordered_map<std::string, RE> & regex_cache, ValidationResult * result)
  31. : ValidationVisitor(json, schema, cfg, regex_cache, {}, result) {}
  32. Status visit(constraint::TypeConstraint const & cons) const {
  33. return cons.types.contains(document_.type());
  34. }
  35. Status visit(constraint::ExtensionConstraint const & cons) const {
  36. return cons.validate(document_, where_, result_);
  37. }
  38. Status visit(constraint::EnumConstraint const & cons) const {
  39. auto is_equal = [this](auto const & frozen) {
  40. return document_.equals(frozen, cfg_.strict_equality);
  41. };
  42. for (auto const & option : cons.enumeration) {
  43. if (option->apply(is_equal)) {
  44. return Status::Accept;
  45. }
  46. }
  47. return Status::Reject;
  48. }
  49. Status visit(constraint::AllOfConstraint const & cons) const {
  50. Status rval = Status::Accept;
  51. for (schema::Node const * subschema : cons.children) {
  52. rval &= validate_subschema(subschema);
  53. if (!rval && result_ == nullptr) {
  54. break;
  55. }
  56. }
  57. return rval;
  58. }
  59. Status visit(constraint::AnyOfConstraint const & cons) const {
  60. for (schema::Node const * subschema : cons.children) {
  61. if (validate_subschema(subschema)) {
  62. return Status::Accept;
  63. }
  64. }
  65. return Status::Reject;
  66. }
  67. Status visit(constraint::OneOfConstraint const & cons) const {
  68. size_t matches = 0;
  69. for (schema::Node const * subschema : cons.children) {
  70. if (validate_subschema(subschema)) {
  71. ++matches;
  72. }
  73. }
  74. return matches == 1 ? Status::Accept : Status::Reject;
  75. }
  76. Status visit(constraint::NotConstraint const & cons) const {
  77. return !validate_subschema(cons.child);
  78. }
  79. Status visit(constraint::ConditionalConstraint const & cons) const {
  80. if (validate_subschema(cons.if_constraint)) {
  81. return validate_subschema(cons.then_constraint);
  82. }
  83. return validate_subschema(cons.else_constraint);
  84. }
  85. Status visit(constraint::MaximumConstraint const & cons) const {
  86. switch (document_.type()) {
  87. case adapter::Type::Integer:
  88. return cons(document_.as_integer());
  89. case adapter::Type::Number:
  90. return cons(document_.as_number());
  91. default:
  92. return Status::Noop;
  93. }
  94. }
  95. Status visit(constraint::MinimumConstraint 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::MultipleOfConstraint const & cons) const {
  106. NOOP_UNLESS_TYPE(Integer);
  107. return cons(document_.as_integer());
  108. }
  109. Status visit(constraint::MaxLengthConstraint const & cons) const {
  110. NOOP_UNLESS_TYPE(String);
  111. return cons(document_.as_string());
  112. }
  113. Status visit(constraint::MinLengthConstraint const & cons) const {
  114. NOOP_UNLESS_TYPE(String);
  115. return cons(document_.as_string());
  116. }
  117. Status visit(constraint::PatternConstraint const & cons) const {
  118. NOOP_UNLESS_TYPE(String);
  119. RE const & regex = regex_cache_.try_emplace(cons.regex, cons.regex).first->second;
  120. return regex.search(document_.as_string());
  121. }
  122. Status visit(constraint::AdditionalItemsConstraint const & cons) const {
  123. NOOP_UNLESS_TYPE(Array);
  124. auto array = document_.as_array();
  125. Status rval = Status::Accept;
  126. for (size_t i = cons.applies_after_nth; i < array.size(); ++i) {
  127. rval &= validate_subschema_on(cons.subschema, array[i], i);
  128. if (!rval && result_ == nullptr) {
  129. break;
  130. }
  131. }
  132. return rval;
  133. }
  134. Status visit(constraint::ContainsConstraint const & cons) const {
  135. NOOP_UNLESS_TYPE(Array);
  136. auto array = document_.as_array();
  137. size_t const minimum = cons.minimum.value_or(1);
  138. size_t const maximum = cons.maximum.value_or(array.size());
  139. size_t matches = 0;
  140. for (size_t i = 0; i < array.size(); ++i) {
  141. if (validate_subschema_on(cons.subschema, array[i], i)) {
  142. ++matches;
  143. }
  144. }
  145. if (matches < minimum) {
  146. return Status::Reject;
  147. }
  148. if (matches > maximum) {
  149. return Status::Reject;
  150. }
  151. return Status::Accept;
  152. }
  153. Status visit(constraint::MaxItemsConstraint const & cons) const {
  154. NOOP_UNLESS_TYPE(Array);
  155. return cons(document_.as_array());
  156. }
  157. Status visit(constraint::MinItemsConstraint const & cons) const {
  158. NOOP_UNLESS_TYPE(Array);
  159. return cons(document_.as_array());
  160. }
  161. Status visit(constraint::TupleConstraint const & cons) const {
  162. NOOP_UNLESS_TYPE(Array);
  163. auto array = document_.as_array();
  164. if (array.size() < cons.items.size()) {
  165. return Status::Reject;
  166. }
  167. Status rval = Status::Accept;
  168. for (size_t i = 0; i < cons.items.size(); ++i) {
  169. rval &= validate_subschema_on(cons.items[i], array[i], i);
  170. if (!rval && result_ == nullptr) {
  171. break;
  172. }
  173. }
  174. return rval;
  175. }
  176. Status visit(constraint::UniqueItemsConstraint const & cons) const {
  177. NOOP_UNLESS_TYPE(Array);
  178. if constexpr (std::totally_ordered<A>) {
  179. std::set<A> cache;
  180. for (A const & elem : document_.as_array()) {
  181. if (not cache.insert(elem).second) {
  182. return Status::Reject;
  183. }
  184. }
  185. } else {
  186. auto array = document_.as_array();
  187. for (size_t i = 0; i < array.size(); ++i) {
  188. for (size_t j = i + 1; j < array.size(); ++j) {
  189. if (array[i].equals(array[j], true)) {
  190. return Status::Reject;
  191. }
  192. }
  193. }
  194. }
  195. return Status::Accept;
  196. }
  197. Status visit(constraint::AdditionalPropertiesConstraint const & cons) const {
  198. NOOP_UNLESS_TYPE(Object);
  199. auto matches_any_pattern = [this, &cons](std::string const & key) {
  200. for (auto & pattern : cons.patterns) {
  201. RE const & regex = regex_cache_.try_emplace(pattern, pattern).first->second;
  202. if (regex.search(key)) {
  203. return true;
  204. }
  205. }
  206. return false;
  207. };
  208. Status rval = Status::Accept;
  209. for (auto const & [key, elem] : document_.as_object()) {
  210. if (not cons.properties.contains(key) && not matches_any_pattern(key)) {
  211. rval &= validate_subschema_on(cons.subschema, elem, key);
  212. }
  213. if (!rval && result_ == nullptr) {
  214. break;
  215. }
  216. }
  217. return rval;
  218. }
  219. Status visit(constraint::DependenciesConstraint const & cons) const {
  220. NOOP_UNLESS_TYPE(Object);
  221. auto object = document_.as_object();
  222. Status rval = Status::Accept;
  223. for (auto const & [key, subschema] : cons.subschemas) {
  224. if (not object.contains(key)) {
  225. continue;
  226. }
  227. rval &= validate_subschema(subschema);
  228. if (!rval && result_ == nullptr) {
  229. break;
  230. }
  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. if (!rval && result_ == nullptr) {
  241. break;
  242. }
  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. if (!rval && result_ == nullptr) {
  264. break;
  265. }
  266. }
  267. }
  268. return rval;
  269. }
  270. Status visit(constraint::PropertiesConstraint const & cons) const {
  271. NOOP_UNLESS_TYPE(Object);
  272. Status rval = Status::Accept;
  273. for (auto const & [key, elem] : document_.as_object()) {
  274. if (auto it = cons.properties.find(key); it != cons.properties.end()) {
  275. rval &= validate_subschema_on(it->second, elem, key);
  276. }
  277. if (!rval && result_ == nullptr) {
  278. break;
  279. }
  280. }
  281. return rval;
  282. }
  283. Status visit(constraint::PropertyNamesConstraint const & cons) const {
  284. NOOP_UNLESS_TYPE(Object);
  285. Status rval = Status::Accept;
  286. for (auto const & [key, _] : document_.as_object()) {
  287. // TODO(samjaffe): Should we prefer a std::string adapter like valijson?
  288. typename A::value_type key_json{key};
  289. rval &= validate_subschema_on(cons.key_schema, A(key_json), "$$key");
  290. }
  291. }
  292. Status visit(constraint::RequiredConstraint const & cons) const {
  293. NOOP_UNLESS_TYPE(Object);
  294. auto required = cons.properties;
  295. for (auto const & [key, _] : document_.as_object()) {
  296. required.erase(key);
  297. }
  298. return required.empty();
  299. }
  300. Status visit(constraint::UnevaluatedItemsConstraint const & cons) const {
  301. EXPECT_M(local_result_, "Invalid State - no result object for post-constraint");
  302. NOOP_UNLESS_TYPE(Array);
  303. Status rval = Status::Accept;
  304. auto array = document_.as_array();
  305. for (size_t i = 0; i < array.size(); ++i) {
  306. if (not local_result_->visited_items.contains(i)) {
  307. rval &= validate_subschema_on(cons.subschema, array[i], i);
  308. }
  309. if (!rval && result_ == nullptr) {
  310. break;
  311. }
  312. }
  313. }
  314. Status visit(constraint::UnevaluatedPropertiesConstraint const & cons) const {
  315. EXPECT_M(local_result_, "Invalid State - no result object for post-constraint");
  316. NOOP_UNLESS_TYPE(Object);
  317. Status rval = Status::Accept;
  318. for (auto const & [key, elem] : document_.as_object()) {
  319. if (not local_result_->visited_properties.contains(key)) {
  320. rval &= validate_subschema_on(cons.subschema, elem, key);
  321. }
  322. if (!rval && result_ == nullptr) {
  323. break;
  324. }
  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. if (rval || result_) {
  342. rval &= p_constraint->accept(*this);
  343. }
  344. }
  345. for (auto const & [key, p_constraint] : schema_.post_constraints()) {
  346. if (rval || result_) {
  347. rval &= p_constraint->accept(*this);
  348. }
  349. }
  350. return rval;
  351. }
  352. private:
  353. ValidationVisitor(A const & json, schema::Node const & schema, ValidationConfig const & cfg,
  354. std::unordered_map<std::string, RE> & regex_cache,
  355. detail::Pointer const & where, ValidationResult * result,
  356. ValidationResult * local_result = nullptr)
  357. : document_(json), where_(where), schema_(schema), cfg_(cfg), regex_cache_(regex_cache),
  358. result_(result), local_result_(local_result ?: result_) {}
  359. Status validate_subschema(schema::Node const * subschema) const {
  360. return ValidationVisitor(document_, *subschema, cfg_, regex_cache_, where_, result_,
  361. local_result_)
  362. .validate();
  363. }
  364. template <typename K>
  365. Status validate_subschema_on(schema::Node const * subschema, A const & document,
  366. K const & key) const {
  367. ValidationResult next;
  368. ValidationResult * pnext = result_ ? &next : nullptr;
  369. auto status =
  370. ValidationVisitor(document, *subschema, cfg_, regex_cache_, where_ / key, pnext).validate();
  371. if (status != Status::Noop and local_result_) {
  372. local_result_->record(key);
  373. }
  374. return status;
  375. }
  376. };
  377. }