validation_visitor.h 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467
  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. Status rval = Status::Accept;
  164. auto array = document_.as_array();
  165. size_t const n = std::min(cons.items.size(), array.size());
  166. for (size_t i = 0; i < n; ++i) {
  167. rval &= validate_subschema_on(cons.items[i], array[i], i);
  168. if (!rval && result_ == nullptr) {
  169. break;
  170. }
  171. }
  172. return rval;
  173. }
  174. Status visit(constraint::UniqueItemsConstraint const & cons) const {
  175. NOOP_UNLESS_TYPE(Array);
  176. if constexpr (std::totally_ordered<A>) {
  177. std::set<A> cache;
  178. for (A const & elem : document_.as_array()) {
  179. if (not cache.insert(elem).second) {
  180. return Status::Reject;
  181. }
  182. }
  183. } else {
  184. auto array = document_.as_array();
  185. for (size_t i = 0; i < array.size(); ++i) {
  186. for (size_t j = i + 1; j < array.size(); ++j) {
  187. if (array[i].equals(array[j], true)) {
  188. return Status::Reject;
  189. }
  190. }
  191. }
  192. }
  193. return Status::Accept;
  194. }
  195. Status visit(constraint::AdditionalPropertiesConstraint const & cons) const {
  196. NOOP_UNLESS_TYPE(Object);
  197. auto matches_any_pattern = [this, &cons](std::string const & key) {
  198. for (auto & pattern : cons.patterns) {
  199. RE const & regex = regex_cache_.try_emplace(pattern, pattern).first->second;
  200. if (regex.search(key)) {
  201. return true;
  202. }
  203. }
  204. return false;
  205. };
  206. Status rval = Status::Accept;
  207. for (auto const & [key, elem] : document_.as_object()) {
  208. if (not cons.properties.contains(key) && not matches_any_pattern(key)) {
  209. rval &= validate_subschema_on(cons.subschema, elem, key);
  210. }
  211. if (!rval && result_ == nullptr) {
  212. break;
  213. }
  214. }
  215. return rval;
  216. }
  217. Status visit(constraint::DependenciesConstraint const & cons) const {
  218. NOOP_UNLESS_TYPE(Object);
  219. auto object = document_.as_object();
  220. Status rval = Status::Accept;
  221. for (auto const & [key, subschema] : cons.subschemas) {
  222. if (not object.contains(key)) {
  223. continue;
  224. }
  225. rval &= validate_subschema(subschema);
  226. if (!rval && result_ == nullptr) {
  227. break;
  228. }
  229. }
  230. for (auto [key, required] : cons.required) {
  231. if (not object.contains(key)) {
  232. continue;
  233. }
  234. for (auto const & [key, _] : object) {
  235. required.erase(key);
  236. }
  237. rval &= required.empty();
  238. if (!rval && result_ == nullptr) {
  239. break;
  240. }
  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. if (!rval && result_ == nullptr) {
  262. break;
  263. }
  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. if (!rval && result_ == nullptr) {
  285. break;
  286. }
  287. }
  288. return rval;
  289. }
  290. Status visit(constraint::PropertyNamesConstraint const & cons) const {
  291. NOOP_UNLESS_TYPE(Object);
  292. Status rval = Status::Accept;
  293. for (auto const & [key, _] : document_.as_object()) {
  294. // TODO(samjaffe): Should we prefer a std::string adapter like valijson?
  295. typename A::value_type key_json{key};
  296. rval &= validate_subschema_on(cons.key_schema, A(key_json), "$$key");
  297. }
  298. }
  299. Status visit(constraint::RequiredConstraint const & cons) const {
  300. NOOP_UNLESS_TYPE(Object);
  301. auto required = cons.properties;
  302. for (auto const & [key, _] : document_.as_object()) {
  303. required.erase(key);
  304. }
  305. return required.empty();
  306. }
  307. Status visit(constraint::UnevaluatedItemsConstraint const & cons) const {
  308. EXPECT_M(local_result_, "Invalid State - no result object for post-constraint");
  309. NOOP_UNLESS_TYPE(Array);
  310. Status rval = Status::Accept;
  311. auto array = document_.as_array();
  312. for (size_t i = 0; i < array.size(); ++i) {
  313. if (not local_result_->visited_items.contains(i)) {
  314. rval &= validate_subschema_on(cons.subschema, array[i], i);
  315. }
  316. if (!rval && result_ == nullptr) {
  317. break;
  318. }
  319. }
  320. }
  321. Status visit(constraint::UnevaluatedPropertiesConstraint const & cons) const {
  322. EXPECT_M(local_result_, "Invalid State - no result object for post-constraint");
  323. NOOP_UNLESS_TYPE(Object);
  324. Status rval = Status::Accept;
  325. for (auto const & [key, elem] : document_.as_object()) {
  326. if (not local_result_->visited_properties.contains(key)) {
  327. rval &= validate_subschema_on(cons.subschema, elem, key);
  328. }
  329. if (!rval && result_ == nullptr) {
  330. break;
  331. }
  332. }
  333. }
  334. Status validate() {
  335. if (schema_.rejects_all()) {
  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. if (rval || result_) {
  349. rval &= p_constraint->accept(*this);
  350. }
  351. }
  352. for (auto const & [key, p_constraint] : schema_.post_constraints()) {
  353. if (rval || result_) {
  354. rval &= p_constraint->accept(*this);
  355. }
  356. }
  357. return rval;
  358. }
  359. private:
  360. ValidationVisitor(A const & json, schema::Node const & schema, ValidationConfig const & cfg,
  361. std::unordered_map<std::string, RE> & regex_cache,
  362. detail::Pointer const & where, ValidationResult * result,
  363. ValidationResult * local_result = nullptr)
  364. : document_(json), where_(where), schema_(schema), cfg_(cfg), regex_cache_(regex_cache),
  365. result_(result), local_result_(local_result ?: result_) {}
  366. Status validate_subschema(schema::Node const * subschema) const {
  367. return ValidationVisitor(document_, *subschema, cfg_, regex_cache_, where_, result_,
  368. local_result_)
  369. .validate();
  370. }
  371. template <typename K>
  372. Status validate_subschema_on(schema::Node const * subschema, A const & document,
  373. K const & key) const {
  374. ValidationResult next;
  375. ValidationResult * pnext = result_ ? &next : nullptr;
  376. auto status =
  377. ValidationVisitor(document, *subschema, cfg_, regex_cache_, where_ / key, pnext).validate();
  378. if (status != Status::Noop and local_result_) {
  379. local_result_->record(key);
  380. }
  381. return status;
  382. }
  383. };
  384. }