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
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
|
/**
* Copyright (C) 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.
*/
#include "mongo/db/update/update_driver.h"
#include "mongo/base/error_codes.h"
#include "mongo/base/string_data.h"
#include "mongo/bson/mutable/algorithm.h"
#include "mongo/bson/mutable/document.h"
#include "mongo/db/bson/dotted_path_support.h"
#include "mongo/db/commands/feature_compatibility_version_command_parser.h"
#include "mongo/db/field_ref.h"
#include "mongo/db/matcher/expression_leaf.h"
#include "mongo/db/matcher/extensions_callback_noop.h"
#include "mongo/db/server_options.h"
#include "mongo/db/update/log_builder.h"
#include "mongo/db/update/modifier_table.h"
#include "mongo/db/update/object_replace_node.h"
#include "mongo/db/update/path_support.h"
#include "mongo/db/update/storage_validation.h"
#include "mongo/util/embedded_builder.h"
#include "mongo/util/mongoutils/str.h"
namespace mongo {
namespace str = mongoutils::str;
namespace mb = mongo::mutablebson;
using std::unique_ptr;
using std::vector;
using pathsupport::EqualityMatches;
namespace {
StatusWith<UpdateSemantics> updateSemanticsFromElement(BSONElement element) {
if (element.type() != BSONType::NumberInt && element.type() != BSONType::NumberLong) {
return {ErrorCodes::BadValue, "'$v' (UpdateSemantics) field must be an integer."};
}
auto updateSemantics = element.numberLong();
if (updateSemantics < 0 ||
updateSemantics >= static_cast<int>(UpdateSemantics::kNumUpdateSemantics)) {
return {ErrorCodes::BadValue,
str::stream() << "Unrecognized value for '$v' (UpdateSemantics) field: "
<< updateSemantics};
}
return static_cast<UpdateSemantics>(updateSemantics);
}
modifiertable::ModifierType validateMod(BSONElement mod) {
auto modType = modifiertable::getType(mod.fieldName());
uassert(ErrorCodes::FailedToParse,
str::stream() << "Unknown modifier: " << mod.fieldName(),
modType != modifiertable::MOD_UNKNOWN);
uassert(ErrorCodes::FailedToParse,
str::stream() << "Modifiers operate on fields but we found type "
<< typeName(mod.type())
<< " instead. For example: {$mod: {<field>: ...}}"
<< " not {"
<< mod
<< "}",
mod.type() == BSONType::Object);
uassert(ErrorCodes::FailedToParse,
str::stream() << "'" << mod.fieldName()
<< "' is empty. You must specify a field like so: "
"{"
<< mod.fieldName()
<< ": {<field>: ...}}",
!mod.embeddedObject().isEmpty());
return modType;
}
// Parses 'updateExpr' and merges it into 'root'. Returns whether 'updateExpr' is positional.
bool parseUpdateExpression(
BSONObj updateExpr,
UpdateObjectNode* root,
const boost::intrusive_ptr<ExpressionContext>& expCtx,
const std::map<StringData, std::unique_ptr<ExpressionWithPlaceholder>>& arrayFilters) {
bool positional = false;
std::set<std::string> foundIdentifiers;
bool foundUpdateSemanticsField = false;
for (auto&& mod : updateExpr) {
// If there is a "$v" field among the modifiers, it should have already been used by the
// caller to determine that this is the correct parsing function.
if (mod.fieldNameStringData() == LogBuilder::kUpdateSemanticsFieldName) {
uassert(ErrorCodes::BadValue,
"Duplicate $v in oplog update document",
!foundUpdateSemanticsField);
foundUpdateSemanticsField = true;
invariant(mod.numberLong() == static_cast<long long>(UpdateSemantics::kUpdateNode));
continue;
}
auto modType = validateMod(mod);
for (auto&& field : mod.Obj()) {
auto statusWithPositional = UpdateObjectNode::parseAndMerge(
root, modType, field, expCtx, arrayFilters, foundIdentifiers);
uassertStatusOK(statusWithPositional);
positional = positional || statusWithPositional.getValue();
}
}
for (const auto& arrayFilter : arrayFilters) {
uassert(ErrorCodes::FailedToParse,
str::stream() << "The array filter for identifier '" << arrayFilter.first
<< "' was not used in the update "
<< updateExpr,
foundIdentifiers.find(arrayFilter.first.toString()) != foundIdentifiers.end());
}
return positional;
}
} // namespace
UpdateDriver::UpdateDriver(const Options& opts)
: _replacementMode(false),
_indexedFields(NULL),
_logOp(opts.logOp),
_modOptions(opts.modOptions),
_affectIndices(false),
_positional(false) {}
UpdateDriver::~UpdateDriver() {
clear();
}
Status UpdateDriver::parse(
const BSONObj& updateExpr,
const std::map<StringData, std::unique_ptr<ExpressionWithPlaceholder>>& arrayFilters,
const bool multi) {
clear();
// Check if the update expression is a full object replacement.
if (*updateExpr.firstElementFieldName() != '$') {
if (multi) {
return Status(ErrorCodes::FailedToParse, "multi update only works with $ operators");
}
_root = stdx::make_unique<ObjectReplaceNode>(updateExpr);
// Register the fact that this driver will only do full object replacements.
_replacementMode = true;
return Status::OK();
}
// Register the fact that this driver is not doing a full object replacement.
_replacementMode = false;
// Decide which update semantics to used, using the criteria outlined in the comment above this
// function's declaration.
BSONElement updateSemanticsElement = updateExpr[LogBuilder::kUpdateSemanticsFieldName];
UpdateSemantics updateSemantics;
if (updateSemanticsElement) {
if (!_modOptions.fromOplogApplication) {
return {ErrorCodes::FailedToParse, "The $v update field is only recognized internally"};
}
auto statusWithUpdateSemantics = updateSemanticsFromElement(updateSemanticsElement);
if (!statusWithUpdateSemantics.isOK()) {
return statusWithUpdateSemantics.getStatus();
}
updateSemantics = statusWithUpdateSemantics.getValue();
} else if (_modOptions.fromOplogApplication) {
updateSemantics = UpdateSemantics::kModifierInterface;
} else {
updateSemantics = (serverGlobalParams.featureCompatibility.version.load() ==
ServerGlobalParams::FeatureCompatibility::Version::k34)
? UpdateSemantics::kModifierInterface
: UpdateSemantics::kUpdateNode;
}
switch (updateSemantics) {
case UpdateSemantics::kModifierInterface: {
uassert(ErrorCodes::InvalidOptions,
str::stream()
<< "The featureCompatibilityVersion must be 3.6 to use arrayFilters. See "
<< feature_compatibility_version::kDochubLink
<< ".",
arrayFilters.empty());
bool foundUpdateSemanticsField = false;
for (auto&& mod : updateExpr) {
// If there is a "$v" field among the modifiers, we have already used it to
// determine that this is the correct parsing code.
if (mod.fieldNameStringData() == LogBuilder::kUpdateSemanticsFieldName) {
uassert(ErrorCodes::BadValue,
"Duplicate $v in oplog update document",
!foundUpdateSemanticsField);
foundUpdateSemanticsField = true;
invariant(mod.numberLong() ==
static_cast<long long>(UpdateSemantics::kModifierInterface));
continue;
}
auto modType = validateMod(mod);
for (auto&& field : mod.Obj()) {
auto status = addAndParse(modType, field);
if (!status.isOK()) {
return status;
}
}
}
break;
}
case UpdateSemantics::kUpdateNode: {
auto root = stdx::make_unique<UpdateObjectNode>();
_positional =
parseUpdateExpression(updateExpr, root.get(), _modOptions.expCtx, arrayFilters);
_root = std::move(root);
break;
}
default:
MONGO_UNREACHABLE;
}
return Status::OK();
}
inline Status UpdateDriver::addAndParse(const modifiertable::ModifierType type,
const BSONElement& elem) {
if (elem.eoo()) {
return Status(ErrorCodes::FailedToParse,
str::stream() << "'" << elem.fieldName() << "' has no value in : " << elem
<< " which is not allowed for any $"
<< type
<< " mod.");
}
unique_ptr<ModifierInterface> mod(modifiertable::makeUpdateMod(type));
dassert(mod.get());
bool positional = false;
Status status = mod->init(elem, _modOptions, &positional);
if (!status.isOK()) {
return status;
}
// If any modifier indicates that it requires a positional match, toggle the
// _positional flag to true.
_positional = _positional || positional;
_mods.push_back(mod.release());
return Status::OK();
}
Status UpdateDriver::populateDocumentWithQueryFields(OperationContext* opCtx,
const BSONObj& query,
const FieldRefSet& immutablePaths,
mutablebson::Document& doc) const {
// We canonicalize the query to collapse $and/$or, and the namespace is not needed. Also,
// because this is for the upsert case, where we insert a new document if one was not found, the
// $where/$text clauses do not make sense, hence empty ExtensionsCallback.
auto qr = stdx::make_unique<QueryRequest>(NamespaceString(""));
qr->setFilter(query);
const boost::intrusive_ptr<ExpressionContext> expCtx;
// $expr is not allowed in the query for an upsert, since it is not clear what the equality
// extraction behavior for $expr should be.
auto statusWithCQ =
CanonicalQuery::canonicalize(opCtx,
std::move(qr),
expCtx,
ExtensionsCallbackNoop(),
MatchExpressionParser::kAllowAllSpecialFeatures &
~MatchExpressionParser::AllowedFeatures::kExpr);
if (!statusWithCQ.isOK()) {
return statusWithCQ.getStatus();
}
unique_ptr<CanonicalQuery> cq = std::move(statusWithCQ.getValue());
return populateDocumentWithQueryFields(*cq, immutablePaths, doc);
}
Status UpdateDriver::populateDocumentWithQueryFields(const CanonicalQuery& query,
const FieldRefSet& immutablePaths,
mutablebson::Document& doc) const {
EqualityMatches equalities;
Status status = Status::OK();
if (isDocReplacement()) {
// Extract only immutable fields from replacement-style
status =
pathsupport::extractFullEqualityMatches(*query.root(), immutablePaths, &equalities);
} else {
// Extract all fields from op-style
status = pathsupport::extractEqualityMatches(*query.root(), &equalities);
}
if (!status.isOK())
return status;
status = pathsupport::addEqualitiesToDoc(equalities, &doc);
return status;
}
Status UpdateDriver::update(StringData matchedField,
BSONObj original,
mutablebson::Document* doc,
bool validateForStorage,
const FieldRefSet& immutablePaths,
BSONObj* logOpRec,
bool* docWasModified) {
// TODO: assert that update() is called at most once in a !_multi case.
_affectIndices = (isDocReplacement() && (_indexedFields != NULL));
_logDoc.reset();
LogBuilder logBuilder(_logDoc.root());
if (_root) {
// We parsed using the new UpdateNode implementation.
UpdateNode::ApplyParams applyParams(doc->root(), immutablePaths);
applyParams.matchedField = matchedField;
applyParams.insert = _insert;
applyParams.fromOplogApplication = _modOptions.fromOplogApplication;
applyParams.validateForStorage = validateForStorage;
applyParams.indexData = _indexedFields;
if (_logOp && logOpRec) {
applyParams.logBuilder = &logBuilder;
}
auto applyResult = _root->apply(applyParams);
if (applyResult.indexesAffected) {
_affectIndices = true;
doc->disableInPlaceUpdates();
}
if (docWasModified) {
*docWasModified = !applyResult.noop;
}
if (!_replacementMode && _logOp && logOpRec) {
// When using kUpdateNode update semantics on the primary, we must include a "$v" field
// in the update document so that the secondary knows to apply the update with
// kUpdateNode semantics. If this is a full document replacement, we don't need to
// specify the semantics (and there would be no place to put a "$v" field in the update
// document).
invariantOK(logBuilder.setUpdateSemantics(UpdateSemantics::kUpdateNode));
}
} else {
// We parsed using the old ModifierInterface implementation.
// Ask each of the mods to type check whether they can operate over the current document
// and, if so, to change that document accordingly.
FieldRefSet updatedPaths;
for (vector<ModifierInterface*>::iterator it = _mods.begin(); it != _mods.end(); ++it) {
ModifierInterface::ExecInfo execInfo;
Status status = (*it)->prepare(doc->root(), matchedField, &execInfo);
if (!status.isOK()) {
return status;
}
if (execInfo.context == ModifierInterface::ExecInfo::INSERT_CONTEXT && !_insert) {
continue;
}
// Gather which fields this mod is interested on and whether these fields were
// "taken" by previous mods. Note that not all mods are multi-field mods. When we
// see an empty field, we may stop looking for others.
for (int i = 0; i < ModifierInterface::ExecInfo::MAX_NUM_FIELDS; i++) {
if (execInfo.fieldRef[i] == 0) {
break;
}
// Record each field being updated but check for conflicts first
const FieldRef* other;
if (!updatedPaths.insert(execInfo.fieldRef[i], &other)) {
return Status(ErrorCodes::ConflictingUpdateOperators,
str::stream() << "Cannot update '" << other->dottedField()
<< "' and '"
<< execInfo.fieldRef[i]->dottedField()
<< "' at the same time");
}
// We start with the expectation that a mod will be in-place. But if the mod
// touched an indexed field and the mod will indeed be executed -- that is, it
// is not a no-op and it is in a valid context -- then we switch back to a
// non-in-place mode.
//
// TODO: make mightBeIndexed and fieldRef like each other.
if (!_affectIndices && !execInfo.noOp && _indexedFields &&
_indexedFields->mightBeIndexed(execInfo.fieldRef[i]->dottedField())) {
_affectIndices = true;
doc->disableInPlaceUpdates();
}
}
if (!execInfo.noOp) {
status = (*it)->apply();
if (docWasModified)
*docWasModified = true;
if (!status.isOK()) {
return status;
}
}
// If we require a replication oplog entry for this update, go ahead and generate one.
if (!execInfo.noOp && _logOp && logOpRec) {
status = (*it)->log(&logBuilder);
if (!status.isOK()) {
return status;
}
}
}
// Check for BSON depth and DBRef constraint violations.
if (validateForStorage) {
for (auto path = updatedPaths.begin(); path != updatedPaths.end(); ++path) {
// Find the updated field in the updated document.
auto newElem = doc->root();
for (size_t i = 0; i < (*path)->numParts(); ++i) {
newElem = newElem[(*path)->getPart(i)];
if (!newElem.ok()) {
break;
}
}
// newElem might be missing if $unset/$renamed-away.
if (newElem.ok()) {
// Check parents.
const std::uint32_t recursionLevel = 0;
auto parentsDepth =
storage_validation::storageValidParents(newElem, recursionLevel);
// Check element and its children.
const bool doRecursiveCheck = true;
storage_validation::storageValid(newElem, doRecursiveCheck, parentsDepth);
}
}
}
for (auto path = immutablePaths.begin(); path != immutablePaths.end(); ++path) {
if (!updatedPaths.findConflicts(*path, nullptr)) {
continue;
}
// Find the updated field in the updated document.
auto newElem = doc->root();
for (size_t i = 0; i < (*path)->numParts(); ++i) {
newElem = newElem[(*path)->getPart(i)];
if (!newElem.ok()) {
break;
}
uassert(ErrorCodes::NotSingleValueField,
str::stream()
<< "After applying the update to the document, the (immutable) field '"
<< (*path)->dottedField()
<< "' was found to be an array or array descendant.",
newElem.getType() != BSONType::Array);
}
auto oldElem =
dotted_path_support::extractElementAtPath(original, (*path)->dottedField());
uassert(ErrorCodes::ImmutableField,
str::stream() << "After applying the update, the '" << (*path)->dottedField()
<< "' (required and immutable) field was "
"found to have been removed --"
<< original,
newElem.ok() || !oldElem.ok());
if (newElem.ok() && oldElem.ok()) {
uassert(ErrorCodes::ImmutableField,
str::stream() << "After applying the update, the (immutable) field '"
<< (*path)->dottedField()
<< "' was found to have been altered to "
<< newElem.toString(),
newElem.compareWithBSONElement(oldElem, nullptr, false) == 0);
}
}
}
if (_logOp && logOpRec)
*logOpRec = _logDoc.getObject();
return Status::OK();
}
size_t UpdateDriver::numMods() const {
return _mods.size();
}
bool UpdateDriver::isDocReplacement() const {
return _replacementMode;
}
bool UpdateDriver::modsAffectIndices() const {
return _affectIndices;
}
void UpdateDriver::refreshIndexKeys(const UpdateIndexData* indexedFields) {
_indexedFields = indexedFields;
}
bool UpdateDriver::logOp() const {
return _logOp;
}
void UpdateDriver::setLogOp(bool logOp) {
_logOp = logOp;
}
ModifierInterface::Options UpdateDriver::modOptions() const {
return _modOptions;
}
void UpdateDriver::setModOptions(ModifierInterface::Options modOpts) {
_modOptions = modOpts;
}
void UpdateDriver::setCollator(const CollatorInterface* collator) {
if (_root) {
_root->setCollator(collator);
}
for (auto&& mod : _mods) {
mod->setCollator(collator);
}
_modOptions.expCtx->setCollator(collator);
}
void UpdateDriver::clear() {
for (vector<ModifierInterface*>::iterator it = _mods.begin(); it != _mods.end(); ++it) {
delete *it;
}
_mods.clear();
_indexedFields = NULL;
_replacementMode = false;
_positional = false;
}
} // namespace mongo
|