validation_visitor.h 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474
  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. adapter::Type const type = document_.type();
  34. for (adapter::Type const accept : cons.types) {
  35. if (accept & type) {
  36. return Status::Accept;
  37. }
  38. }
  39. return Status::Reject;
  40. }
  41. Status visit(constraint::ExtensionConstraint const & cons) const {
  42. return cons.validate(document_, where_, result_);
  43. }
  44. Status visit(constraint::EnumConstraint const & cons) const {
  45. auto is_equal = [this](auto const & frozen) {
  46. return document_.equals(frozen, cfg_.strict_equality);
  47. };
  48. for (auto const & option : cons.enumeration) {
  49. if (option->apply(is_equal)) {
  50. return Status::Accept;
  51. }
  52. }
  53. return Status::Reject;
  54. }
  55. Status visit(constraint::AllOfConstraint const & cons) const {
  56. Status rval = Status::Accept;
  57. for (schema::Node const * subschema : cons.children) {
  58. rval &= validate_subschema(subschema);
  59. if (!rval && result_ == nullptr) {
  60. break;
  61. }
  62. }
  63. return rval;
  64. }
  65. Status visit(constraint::AnyOfConstraint const & cons) const {
  66. for (schema::Node const * subschema : cons.children) {
  67. if (validate_subschema(subschema)) {
  68. return Status::Accept;
  69. }
  70. }
  71. return Status::Reject;
  72. }
  73. Status visit(constraint::OneOfConstraint const & cons) const {
  74. size_t matches = 0;
  75. for (schema::Node const * subschema : cons.children) {
  76. if (validate_subschema(subschema)) {
  77. ++matches;
  78. }
  79. }
  80. return matches == 1 ? Status::Accept : Status::Reject;
  81. }
  82. Status visit(constraint::NotConstraint const & cons) const {
  83. return validate_subschema(cons.child) == Status::Reject;
  84. }
  85. Status visit(constraint::ConditionalConstraint const & cons) const {
  86. if (validate_subschema(cons.if_constraint)) {
  87. return validate_subschema(cons.then_constraint);
  88. }
  89. return validate_subschema(cons.else_constraint);
  90. }
  91. Status visit(constraint::MaximumConstraint const & cons) const {
  92. switch (document_.type()) {
  93. case adapter::Type::Integer:
  94. return cons(document_.as_integer());
  95. case adapter::Type::Number:
  96. return cons(document_.as_number());
  97. default:
  98. return Status::Noop;
  99. }
  100. }
  101. Status visit(constraint::MinimumConstraint const & cons) const {
  102. switch (document_.type()) {
  103. case adapter::Type::Integer:
  104. return cons(document_.as_integer());
  105. case adapter::Type::Number:
  106. return cons(document_.as_number());
  107. default:
  108. return Status::Noop;
  109. }
  110. }
  111. Status visit(constraint::MultipleOfConstraint const & cons) const {
  112. NOOP_UNLESS_TYPE(Integer);
  113. return cons(document_.as_integer());
  114. }
  115. Status visit(constraint::MaxLengthConstraint const & cons) const {
  116. NOOP_UNLESS_TYPE(String);
  117. return cons(document_.as_string());
  118. }
  119. Status visit(constraint::MinLengthConstraint const & cons) const {
  120. NOOP_UNLESS_TYPE(String);
  121. return cons(document_.as_string());
  122. }
  123. Status visit(constraint::PatternConstraint const & cons) const {
  124. NOOP_UNLESS_TYPE(String);
  125. RE const & regex = regex_cache_.try_emplace(cons.regex, cons.regex).first->second;
  126. return regex.search(document_.as_string());
  127. }
  128. Status visit(constraint::AdditionalItemsConstraint const & cons) const {
  129. NOOP_UNLESS_TYPE(Array);
  130. auto array = document_.as_array();
  131. Status rval = Status::Accept;
  132. for (size_t i = cons.applies_after_nth; i < array.size(); ++i) {
  133. rval &= validate_subschema_on(cons.subschema, array[i], i);
  134. if (rval == Status::Reject && result_ == nullptr) {
  135. break;
  136. }
  137. }
  138. return rval;
  139. }
  140. Status visit(constraint::ContainsConstraint const & cons) const {
  141. NOOP_UNLESS_TYPE(Array);
  142. auto array = document_.as_array();
  143. size_t const minimum = cons.minimum.value_or(1);
  144. size_t const maximum = cons.maximum.value_or(array.size());
  145. size_t matches = 0;
  146. for (size_t i = 0; i < array.size(); ++i) {
  147. if (validate_subschema_on(cons.subschema, array[i], i)) {
  148. ++matches;
  149. }
  150. }
  151. if (matches < minimum) {
  152. return Status::Reject;
  153. }
  154. if (matches > maximum) {
  155. return Status::Reject;
  156. }
  157. return Status::Accept;
  158. }
  159. Status visit(constraint::MaxItemsConstraint const & cons) const {
  160. NOOP_UNLESS_TYPE(Array);
  161. return cons(document_.as_array());
  162. }
  163. Status visit(constraint::MinItemsConstraint const & cons) const {
  164. NOOP_UNLESS_TYPE(Array);
  165. return cons(document_.as_array());
  166. }
  167. Status visit(constraint::TupleConstraint const & cons) const {
  168. NOOP_UNLESS_TYPE(Array);
  169. Status rval = Status::Accept;
  170. auto array = document_.as_array();
  171. size_t const n = std::min(cons.items.size(), array.size());
  172. for (size_t i = 0; i < n; ++i) {
  173. rval &= validate_subschema_on(cons.items[i], array[i], i);
  174. if (rval == Status::Reject && result_ == nullptr) {
  175. break;
  176. }
  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. if (rval == Status::Reject && result_ == nullptr) {
  218. break;
  219. }
  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. if (rval == Status::Reject && result_ == nullptr) {
  233. break;
  234. }
  235. }
  236. for (auto [key, required] : cons.required) {
  237. if (not object.contains(key)) {
  238. continue;
  239. }
  240. for (auto const & [key, _] : object) {
  241. required.erase(key);
  242. }
  243. rval &= required.empty();
  244. if (rval == Status::Reject && result_ == nullptr) {
  245. break;
  246. }
  247. }
  248. return rval;
  249. }
  250. Status visit(constraint::MaxPropertiesConstraint const & cons) const {
  251. NOOP_UNLESS_TYPE(Object);
  252. return cons(document_.as_object());
  253. }
  254. Status visit(constraint::MinPropertiesConstraint const & cons) const {
  255. NOOP_UNLESS_TYPE(Object);
  256. return cons(document_.as_object());
  257. }
  258. Status visit(constraint::PatternPropertiesConstraint const & cons) const {
  259. NOOP_UNLESS_TYPE(Object);
  260. Status rval = Status::Accept;
  261. for (auto const & [pattern, subschema] : cons.properties) {
  262. RE const & regex = regex_cache_.try_emplace(pattern, pattern).first->second;
  263. for (auto const & [key, elem] : document_.as_object()) {
  264. if (regex.search(key)) {
  265. rval &= validate_subschema_on(subschema, elem, key);
  266. }
  267. if (rval == Status::Reject && result_ == nullptr) {
  268. break;
  269. }
  270. }
  271. }
  272. return rval;
  273. }
  274. Status visit(constraint::PropertiesConstraint const & cons) const {
  275. NOOP_UNLESS_TYPE(Object);
  276. Status rval = Status::Accept;
  277. auto object = document_.as_object();
  278. if constexpr (MutableAdapter<A>) {
  279. for (auto const & [key, subschema] : cons.properties) {
  280. auto const * default_value = subschema->default_value();
  281. if (default_value && not object.contains(key)) {
  282. object.assign(key, *default_value);
  283. }
  284. }
  285. }
  286. for (auto const & [key, elem] : object) {
  287. if (auto it = cons.properties.find(key); it != cons.properties.end()) {
  288. rval &= validate_subschema_on(it->second, elem, key);
  289. }
  290. if (rval == Status::Reject && result_ == nullptr) {
  291. break;
  292. }
  293. }
  294. return rval;
  295. }
  296. Status visit(constraint::PropertyNamesConstraint const & cons) const {
  297. NOOP_UNLESS_TYPE(Object);
  298. Status rval = Status::Accept;
  299. for (auto const & [key, _] : document_.as_object()) {
  300. // TODO(samjaffe): Should we prefer a std::string adapter like valijson?
  301. typename A::value_type key_json{key};
  302. rval &= validate_subschema_on(cons.key_schema, A(key_json), "$$key");
  303. }
  304. return rval;
  305. }
  306. Status visit(constraint::RequiredConstraint const & cons) const {
  307. NOOP_UNLESS_TYPE(Object);
  308. auto required = cons.properties;
  309. for (auto const & [key, _] : document_.as_object()) {
  310. required.erase(key);
  311. }
  312. return required.empty();
  313. }
  314. Status visit(constraint::UnevaluatedItemsConstraint const & cons) const {
  315. EXPECT_M(local_result_, "Invalid State - no result object for post-constraint");
  316. NOOP_UNLESS_TYPE(Array);
  317. Status rval = Status::Accept;
  318. auto array = document_.as_array();
  319. for (size_t i = 0; i < array.size(); ++i) {
  320. if (not local_result_->visited_items.contains(i)) {
  321. rval &= validate_subschema_on(cons.subschema, array[i], i);
  322. }
  323. if (rval == Status::Reject && result_ == nullptr) {
  324. break;
  325. }
  326. }
  327. }
  328. Status visit(constraint::UnevaluatedPropertiesConstraint const & cons) const {
  329. EXPECT_M(local_result_, "Invalid State - no result object for post-constraint");
  330. NOOP_UNLESS_TYPE(Object);
  331. Status rval = Status::Accept;
  332. for (auto const & [key, elem] : document_.as_object()) {
  333. if (not local_result_->visited_properties.contains(key)) {
  334. rval &= validate_subschema_on(cons.subschema, elem, key);
  335. }
  336. if (rval == Status::Reject && result_ == nullptr) {
  337. break;
  338. }
  339. }
  340. }
  341. Status validate() {
  342. if (schema_.rejects_all()) {
  343. return Status::Reject;
  344. }
  345. ValidationResult local_result;
  346. if (schema_.requires_result_context() && not local_result_) {
  347. // Ensure that we store results even if there aren't any...
  348. local_result_ = &local_result;
  349. }
  350. Status rval = Status::Noop;
  351. if (auto ref = schema_.reference_schema()) {
  352. rval = validate_subschema(*ref);
  353. }
  354. for (auto const & [key, p_constraint] : schema_.constraints()) {
  355. if (rval != Status::Reject || result_) {
  356. rval &= p_constraint->accept(*this);
  357. }
  358. }
  359. for (auto const & [key, p_constraint] : schema_.post_constraints()) {
  360. if (rval != Status::Reject || result_) {
  361. rval &= p_constraint->accept(*this);
  362. }
  363. }
  364. return rval;
  365. }
  366. private:
  367. ValidationVisitor(A const & json, schema::Node const & schema, ValidationConfig const & cfg,
  368. std::unordered_map<std::string, RE> & regex_cache,
  369. detail::Pointer const & where, ValidationResult * result,
  370. ValidationResult * local_result = nullptr)
  371. : document_(json), where_(where), schema_(schema), cfg_(cfg), regex_cache_(regex_cache),
  372. result_(result), local_result_(local_result ?: result_) {}
  373. Status validate_subschema(schema::Node const * subschema) const {
  374. return ValidationVisitor(document_, *subschema, cfg_, regex_cache_, where_, result_,
  375. local_result_)
  376. .validate();
  377. }
  378. template <typename K>
  379. Status validate_subschema_on(schema::Node const * subschema, A const & document,
  380. K const & key) const {
  381. ValidationResult next;
  382. ValidationResult * pnext = result_ ? &next : nullptr;
  383. auto status =
  384. ValidationVisitor(document, *subschema, cfg_, regex_cache_, where_ / key, pnext).validate();
  385. if (status != Status::Noop and local_result_) {
  386. local_result_->record(key);
  387. }
  388. return status;
  389. }
  390. };
  391. }