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
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
|
/**
* Copyright (C) 2018-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 <boost/optional.hpp>
#include "mongo/base/status.h"
#include "mongo/bson/util/builder.h"
#include "mongo/util/options_parser/environment.h"
namespace mongo {
namespace optionenvironment {
/** A Constraint validates an Environment. It has one function, which takes an Environment as
* an argument and returns either a success or failure Status depending on whether the
* Environment was valid according to this constraint
*
* These are meant to be registered with an Environment to define what it means for that
* Environment to be "valid" and run as part of its validation process
*/
class Constraint {
public:
// Interface
Status operator()(const Environment& env) {
return check(env);
}
virtual ~Constraint() = default;
private:
// Implementation
virtual Status check(const Environment&) = 0;
};
/** A KeyConstraint is a Constraint on a specific Key. Currently this is not handled any
* differently than a Constraint, and is only here as a way to help document whether a
* Constraint applies to a single Key or an Environment as a whole
*/
class KeyConstraint : public Constraint {
public:
KeyConstraint(const Key& key) : _key(key) {}
protected:
Key _key;
};
/** Implementation of a Constraint that makes two keys mutually exclusive. Fails if both keys
* are set.
*/
class MutuallyExclusiveKeyConstraint : public KeyConstraint {
public:
MutuallyExclusiveKeyConstraint(const Key& key, const Key& otherKey)
: KeyConstraint(key), _otherKey(otherKey) {}
private:
Status check(const Environment& env) override;
Key _otherKey;
};
/** Implementation of a Constraint that makes one key require another. Fails if the first key
* is set but the other is not.
*/
class RequiresOtherKeyConstraint : public KeyConstraint {
public:
RequiresOtherKeyConstraint(const Key& key, const Key& otherKey)
: KeyConstraint(key), _otherKey(otherKey) {}
private:
Status check(const Environment& env) final;
Key _otherKey;
};
/**
* Proxy constraint for callbacks used by IDL based config options with a key.
* Callback may take either the entire environment, or just the value being validated.
*/
template <typename T>
class CallbackKeyConstraint : public KeyConstraint {
public:
using Callback = std::function<Status(const Environment&, const Key&)>;
using ValueCallback = std::function<Status(const T&)>;
CallbackKeyConstraint(const Key& k, ValueCallback callback)
: KeyConstraint(k), _valueCallback(std::move(callback)) {}
CallbackKeyConstraint(const Key& k, Callback callback)
: KeyConstraint(k), _callback(std::move(callback)) {}
private:
Status check(const Environment& env) override {
if (_callback) {
return _callback(env, _key);
}
if (!_valueCallback) {
return Status::OK();
}
Value val;
auto status = env.get(_key, &val);
if (!status.isOK()) {
// Key not set, skipping callback constraint check.
return Status::OK();
}
T typedVal;
if (!val.get(&typedVal).isOK()) {
return {ErrorCodes::InternalError,
str::stream() << "Error: value for key: " << _key << " was found as type: "
<< val.typeToString()
<< " but is required to be type: "
<< typeid(typedVal).name()};
}
return _valueCallback(typedVal);
}
Callback _callback;
ValueCallback _valueCallback;
};
/**
* General boundary constraint for numeric type values.
*/
template <typename T>
class BoundaryKeyConstraint : public CallbackKeyConstraint<T> {
public:
BoundaryKeyConstraint(const Key& k,
const boost::optional<T>& gt,
const boost::optional<T>& lt,
const boost::optional<T>& gte,
const boost::optional<T>& lte)
: CallbackKeyConstraint<T>(k, [=](const T& val) -> Status {
if (gt && !(val > *gt)) {
return {ErrorCodes::BadValue,
str::stream() << k << " must be greater than " << *gt};
}
if (lt && !(val < *lt)) {
return {ErrorCodes::BadValue, str::stream() << k << " must be less than " << *lt};
}
if (gte && !(val >= *gte)) {
return {ErrorCodes::BadValue,
str::stream() << k << " must be greater than or equal to " << *gte};
}
if (lte && !(val <= *lte)) {
return {ErrorCodes::BadValue,
str::stream() << k << " must be less than or equal to " << *lte};
}
return Status::OK();
}) {}
};
} // namespace optionenvironment
} // namespace mongo
|
