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
|
/**
* 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 "mongo/base/status.h"
#include "mongo/db/command_generic_argument.h"
#include "mongo/db/commands.h"
#include "mongo/db/jsobj.h"
#include "mongo/util/mongoutils/str.h"
#include "mongo/util/string_map.h"
namespace mongo {
/**
* Confirms that obj only contains field names where allowed(name) returns true,
* and that no field name occurs multiple times.
*
* On failure, returns BadValue and a message naming the unexpected field or error code 51000 with
* a message naming a repeated field. "objectName" is included in the message, for reporting
* purposes.
*/
template <typename Condition>
Status bsonCheckOnlyHasFieldsImpl(StringData objectName,
const BSONObj& obj,
const Condition& allowed) {
StringMap<bool> seenFields;
for (auto&& e : obj) {
const auto name = e.fieldNameStringData();
if (!allowed(name)) {
return Status(ErrorCodes::BadValue,
str::stream() << "Unexpected field " << e.fieldName() << " in "
<< objectName);
}
bool& seenBefore = seenFields[name];
if (!seenBefore) {
seenBefore = true;
} else {
return Status(ErrorCodes::Error(51000),
str::stream() << "Field " << name << " appears multiple times in "
<< objectName);
}
}
return Status::OK();
}
/**
* Like above but only allows fields from the passed-in container.
*/
template <typename Container>
Status bsonCheckOnlyHasFields(StringData objectName,
const BSONObj& obj,
const Container& allowedFields) {
return bsonCheckOnlyHasFieldsImpl(objectName, obj, [&](StringData name) {
return std::find(std::begin(allowedFields), std::end(allowedFields), name) !=
std::end(allowedFields);
});
}
/**
* Like above but only allows fields from the passed-in container or are generic command arguments.
*/
template <typename Container>
Status bsonCheckOnlyHasFieldsForCommand(StringData objectName,
const BSONObj& obj,
const Container& allowedFields) {
return bsonCheckOnlyHasFieldsImpl(objectName, obj, [&](StringData name) {
return isGenericArgument(name) ||
(std::find(std::begin(allowedFields), std::end(allowedFields), name) !=
std::end(allowedFields));
});
}
/**
* Throws a uassert if the type of the elem does not match that provided in expectedType
*/
inline void checkBSONType(BSONType expectedType, const BSONElement& elem) {
uassert(elem.type() == BSONType::EOO ? ErrorCodes::NoSuchKey : ErrorCodes::TypeMismatch,
str::stream() << "Wrong type for '" << elem.fieldNameStringData() << "'. Expected a "
<< typeName(expectedType)
<< ", got a "
<< typeName(elem.type())
<< '.',
elem.type() == expectedType);
}
} // namespace mongo
|
