summaryrefslogtreecommitdiff
path: root/src/mongo/db/update/array_culling_node.cpp
blob: 90943c0e288b92d0cf3963549ae52b9a035d6c97 (plain)
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
/**
 * Copyright (C) 2017 MongoDB 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/platform/basic.h"

#include "mongo/db/update/array_culling_node.h"

namespace mongo {

void ArrayCullingNode::apply(mutablebson::Element element,
                             FieldRef* pathToCreate,
                             FieldRef* pathTaken,
                             StringData matchedField,
                             bool fromReplication,
                             bool validateForStorage,
                             const FieldRefSet& immutablePaths,
                             const UpdateIndexData* indexData,
                             LogBuilder* logBuilder,
                             bool* indexesAffected,
                             bool* noop) const {
    *indexesAffected = false;
    *noop = false;

    if (!pathToCreate->empty()) {
        // There were path components we could not traverse. We treat this as a no-op, unless it
        // would have been impossible to create those elements, which we check with
        // checkViability().
        UpdateLeafNode::checkViability(element, *pathToCreate, *pathTaken);

        *noop = true;
        return;
    }

    // This operation only applies to arrays
    uassert(ErrorCodes::BadValue,
            "Cannot apply $pull to a non-array value",
            element.getType() == mongo::Array);

    size_t numRemoved = 0;
    auto cursor = element.leftChild();
    while (cursor.ok()) {
        // Make sure to get the next array element now, because if we remove the 'cursor' element,
        // the rightSibling pointer will be invalidated.
        auto nextElement = cursor.rightSibling();
        if (_matcher->match(cursor)) {
            invariantOK(cursor.remove());
            numRemoved++;
        }
        cursor = nextElement;
    }

    if (numRemoved == 0) {
        *noop = true;
        return;  // Skip the index check, immutable path check, and logging steps.
    }

    // Determine if indexes are affected.
    if (indexData && indexData->mightBeIndexed(pathTaken->dottedField())) {
        *indexesAffected = true;
    }

    // No need to validate for storage, since we cannot have increased the BSON depth or interfered
    // with a DBRef.

    // Ensure we are not changing any immutable paths.
    for (const auto& immutablePath : immutablePaths) {
        uassert(ErrorCodes::ImmutableField,
                str::stream() << "Performing an update on the path '" << pathTaken->dottedField()
                              << "' would modify the immutable field '"
                              << immutablePath->dottedField()
                              << "'",
                pathTaken->commonPrefixSize(*immutablePath) <
                    std::min(pathTaken->numParts(), immutablePath->numParts()));
    }

    if (logBuilder) {
        auto& doc = logBuilder->getDocument();
        auto logElement = doc.makeElementArray(pathTaken->dottedField());

        for (auto cursor = element.leftChild(); cursor.ok(); cursor = cursor.rightSibling()) {
            dassert(cursor.hasValue());

            auto copy = doc.makeElementWithNewFieldName(StringData(), cursor.getValue());
            uassert(ErrorCodes::InternalError, "could not create copy element", copy.ok());
            uassertStatusOK(logElement.pushBack(copy));
        }

        uassertStatusOK(logBuilder->addToSets(logElement));
    }
}

}  // namespace mongo