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
|
/* Copyright 2013 10gen Inc.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License, version 3,
* as published by the Free Software Foundation.
*
* 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
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
* 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 GNU Affero General 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/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() {}
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) {}
virtual ~KeyConstraint() {}
protected:
Key _key;
};
/** Implementation of a Constraint on the range of a numeric Value. Fails if the Value is not a
* number, or if it is a number but outside the given range
*/
class NumericKeyConstraint : public KeyConstraint {
public:
NumericKeyConstraint(const Key& k, long min, long max)
: KeyConstraint(k), _min(min), _max(max) {}
virtual ~NumericKeyConstraint() {}
private:
virtual Status check(const Environment& env);
long _min;
long _max;
};
/** Implementation of a Constraint that makes a Value immutable. Fails if the Value has already
* been set and we are attempting to set it to a different Value. Note that setting it to the
* same value is allowed in this implementation
*/
class ImmutableKeyConstraint : public KeyConstraint {
public:
ImmutableKeyConstraint(const Key& k) : KeyConstraint(k) {}
virtual ~ImmutableKeyConstraint() {}
private:
virtual Status check(const Environment& env);
Value _value;
};
/** 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) {}
virtual ~MutuallyExclusiveKeyConstraint() {}
private:
virtual Status check(const Environment& env);
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) {}
virtual ~RequiresOtherKeyConstraint() {}
private:
virtual Status check(const Environment& env);
Key _otherKey;
};
/** Implementation of a Constraint that enforces a specific format on a std::string value. Fails if
* the value of the key is not a std::string or does not match the given regex.
*/
class StringFormatKeyConstraint : public KeyConstraint {
public:
StringFormatKeyConstraint(const Key& key,
const std::string& regexFormat,
const std::string& displayFormat)
: KeyConstraint(key), _regexFormat(regexFormat), _displayFormat(displayFormat) {}
virtual ~StringFormatKeyConstraint() {}
private:
virtual Status check(const Environment& env);
std::string _regexFormat;
std::string _displayFormat;
};
/** Implementation of a Constraint on the type of a Value. Fails if we cannot extract the given
* type from our Value, which means the implementation of the access functions of Value
* controls which types are "compatible"
*/
template <typename T>
class TypeKeyConstraint : public KeyConstraint {
public:
TypeKeyConstraint(const Key& k) : KeyConstraint(k) {}
virtual ~TypeKeyConstraint() {}
private:
virtual Status check(const Environment& env) {
Value val;
Status s = env.get(_key, &val);
if (!s.isOK()) {
// Key not set, skipping type constraint check
return Status::OK();
}
// The code that controls whether a type is "compatible" is contained in the Value
// class, so if that handles compatibility between numeric types then this will too.
T typedVal;
if (!val.get(&typedVal).isOK()) {
StringBuilder sb;
sb << "Error: value for key: " << _key << " was found as type: " << val.typeToString()
<< " but is required to be type: " << typeid(typedVal).name();
return Status(ErrorCodes::InternalError, sb.str());
}
return Status::OK();
}
};
} // namespace optionenvironment
} // namespace mongo
|
