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
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
|
/**
* Copyright (C) 2023-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.
*/
#include "mongo/db/index/wildcard_validation.h"
#include "mongo/db/field_ref.h"
#include "mongo/db/index_names.h"
namespace mongo {
namespace {
static const StringData idFieldName = "_id";
/*
* Validate that wildcatdProject fields have no overlapping. It takes a sorted list of the
* projection fields.
*/
Status validateOverlappingFieldsInWildcardProjectionOnly(
const std::vector<FieldRef>& projectionFields) {
for (size_t i = 1; i < projectionFields.size(); ++i) {
if (projectionFields[i - 1].isPrefixOfOrEqualTo(projectionFields[i]) ||
projectionFields[i].isPrefixOfOrEqualTo(projectionFields[i - 1])) {
return {ErrorCodes::Error{7246200},
str::stream() << "Fields in Wildcard Projection cannot overlap, however '"
<< projectionFields[i - 1].dottedField()
<< "' is overlapped with '" << projectionFields[i].dottedField()};
}
}
return Status::OK();
}
/*
* Parse wildcard index's keyPattern.
* It performs basic validation and returns error if the validation fails.
*/
Status getWildcardIndexKeyFields(const BSONObj& keyPattern,
FieldRef& wildcardField,
std::vector<FieldRef>& indexFields) {
for (const auto& keyElement : keyPattern) {
auto keyElemFieldName = keyElement.fieldNameStringData();
if (WildcardNames::isWildcardFieldName(keyElemFieldName)) {
if (!wildcardField.empty()) {
return {ErrorCodes::Error{7246201},
"Index Key can contain only one wildcard index field"};
}
wildcardField = FieldRef{std::move(keyElemFieldName)};
} else {
indexFields.emplace_back(std::move(keyElemFieldName));
}
}
if (wildcardField.empty()) {
return {ErrorCodes::Error{7246202},
"No wildcard index field is specified for the wildcard index"};
}
return Status::OK();
}
} // namespace
Status validateWildcardIndex(const BSONObj& keyPattern) {
FieldRef wildcardRef{};
std::vector<FieldRef> indexFields;
auto status = getWildcardIndexKeyFields(keyPattern, wildcardRef, indexFields);
if (!status.isOK()) {
return status;
}
wildcardRef.removeLastPart(); // remove wildcard part
// wildcard should not overlap with index key fields if wildcard projection is empty.
for (const auto& field : indexFields) {
if (wildcardRef.isPrefixOfOrEqualTo(field)) {
return Status(
ErrorCodes::Error{7246204},
str::stream()
<< "A wildcard index field should not overlap with and index key fields if "
"wildcard projection is empty, however '"
<< field.dottedField() << "' is overlapping with the wildcard index field.");
}
}
return Status::OK();
}
Status validateWildcardProjection(const BSONObj& keyPattern, const BSONObj& pathProjection) {
if (pathProjection.isEmpty()) {
return {ErrorCodes::Error{7246205}, "WildcardProjection must be non-empty if specified."};
}
// Prepare data for validation.
FieldRef wildcardField{};
std::vector<FieldRef> indexFields;
auto status = getWildcardIndexKeyFields(keyPattern, wildcardField, indexFields);
if (!status.isOK()) {
return status;
}
if (wildcardField.numParts() != 1) {
return {
ErrorCodes::Error{7246206},
str::stream()
<< "Wildcard index field must be always '$**' if wildcardProjection is specified"};
}
std::vector<FieldRef> projectionIncludedFields;
std::vector<FieldRef> projectionExcludedFields;
for (const auto& projectionElement : pathProjection) {
if (projectionElement.trueValue()) {
projectionIncludedFields.emplace_back(projectionElement.fieldNameStringData());
} else {
projectionExcludedFields.emplace_back(projectionElement.fieldNameStringData());
}
}
std::sort(indexFields.begin(), indexFields.end());
std::sort(projectionIncludedFields.begin(), projectionIncludedFields.end());
std::sort(projectionExcludedFields.begin(), projectionExcludedFields.end());
status = validateOverlappingFieldsInWildcardProjectionOnly(projectionIncludedFields);
if (!status.isOK()) {
return status;
}
status = validateOverlappingFieldsInWildcardProjectionOnly(projectionExcludedFields);
if (!status.isOK()) {
return status;
}
// test overlappings between index keys and wildcard projection
{
auto indexPos = indexFields.begin();
auto projectionPos = projectionIncludedFields.begin();
while (indexPos != indexFields.end() && projectionPos != projectionIncludedFields.end()) {
if (projectionPos->isPrefixOfOrEqualTo(*indexPos)) {
return {ErrorCodes::Error{7246208},
str::stream()
<< "Index Key and Wildcard Projection cannot contain "
"overlapping fields, however '"
<< indexPos->dottedField() << "' index field is ovverlapping with '"
<< projectionPos->dottedField() << "' wildcardProjection path."};
}
int cmp = projectionPos->compare(*indexPos);
if (cmp < 0) {
++projectionPos;
} else {
++indexPos;
}
}
}
const FieldRef idFieldRef{idFieldName};
const bool idOnlyExclusion =
projectionExcludedFields.size() == 1 && projectionExcludedFields.front() == idFieldRef;
// test test wildcard projects exclude all regular index fields
if (!projectionExcludedFields.empty() && !idOnlyExclusion) {
auto indexPos = indexFields.begin();
auto projectionPos = projectionExcludedFields.begin();
while (indexPos != indexFields.end() && projectionPos != projectionExcludedFields.end()) {
if (projectionPos->isPrefixOfOrEqualTo(*indexPos)) {
// fine we can move indexPos to test next index field
++indexPos;
} else {
int cmp = projectionPos->compare(*indexPos);
if (cmp < 0) {
++projectionPos;
} else {
return {ErrorCodes::Error{7246209},
str::stream() << "wildcardProjection paths must exclude all regular "
"index fields, however '"
<< indexPos->dottedField() << "'is not excluded."};
}
}
}
if (indexPos != indexFields.end()) {
return {ErrorCodes::Error{7246210},
str::stream() << "wildcardProjection paths must exclude all regular "
"index fields, however '"
<< indexPos->dottedField() << "'is not excluded."};
}
}
// With the exception of explicitly including _id field, you cannot combine inclusion and
// exclusion statements in the wildcardProjection document.
if (!projectionIncludedFields.empty() && !projectionExcludedFields.empty()) {
const bool idOnlyInclusion =
projectionIncludedFields.size() == 1 && projectionIncludedFields.front() == idFieldRef;
const bool idIsSingleField = idOnlyExclusion || idOnlyInclusion;
if (!idIsSingleField) {
return {
ErrorCodes::Error{7246211},
str::stream()
<< "Inclusion and exclusion statements cannot combine in the "
"wildcardProjection with an exception of explicitly including _id field"};
}
}
return Status::OK();
}
} // namespace mongo
|
