1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
|
/**
* Copyright (C) 2020-present MongoDB, Inc.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the Server Side Public License, version 1,
* as published by MongoDB, Inc.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* Server Side Public License for more details.
*
* You should have received a copy of the Server Side Public License
* along with this program. If not, see
* <http://www.mongodb.com/licensing/server-side-public-license>.
*
* As a special exception, the copyright holders give permission to link the
* code of portions of this program with the OpenSSL library under certain
* conditions as described in each individual source file and distribute
* linked combinations including the program with the OpenSSL library. You
* must comply with the Server Side Public License in all respects for
* all of the code used other than as permitted herein. If you modify file(s)
* with this exception, you may extend this exception to your version of the
* file(s), but you are not obligated to do so. If you do not wish to do so,
* delete this exception statement from your version. If you delete this
* exception statement from all source files in the program, then also delete
* it in the license file.
*/
#pragma once
#include "mongo/bson/bsonobj.h"
#include "mongo/db/matcher/expression.h"
#include "mongo/db/pipeline/expression_context.h"
namespace mongo::doc_validation_error {
/**
* Set of functions which create an ErrorAnnotation provided that a validator expression is being
* parsed.
*/
std::unique_ptr<MatchExpression::ErrorAnnotation> createAnnotation(
const boost::intrusive_ptr<ExpressionContext>& expCtx,
const std::string& tag,
BSONObj annotation);
std::unique_ptr<MatchExpression::ErrorAnnotation> createAnnotation(
const boost::intrusive_ptr<ExpressionContext>& expCtx,
MatchExpression::ErrorAnnotation::Mode mode);
/**
* Utility which tags an entire tree with 'AnnotationMode::kIgnore'.
*/
void annotateTreeToIgnoreForErrorDetails(const boost::intrusive_ptr<ExpressionContext>& expCtx,
MatchExpression* expr);
/**
* Compute the maximum allowed depth for a validation error. Since the generated error will be
* included in a command response BSONObj, the maximum depth for validation errors has to be
* slightly less deep than the maximum allowed depth for BSONObjs.
*/
unsigned int computeMaxAllowedValidationErrorDepth();
} // namespace mongo::doc_validation_error
|
