summaryrefslogtreecommitdiff
path: root/src/mongo/db/update/pop_node.cpp
blob: c0a811321189692718a1a73a6106b52c02c5909a (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
118
119
120
121
/**
 * 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/pop_node.h"

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

namespace mongo {

Status PopNode::init(BSONElement modExpr, const CollatorInterface* collator) {
    _popFromFront = modExpr.isNumber() && modExpr.number() < 0;
    return Status::OK();
}

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

    if (pathTaken->empty()) {
        // No components of the path existed. The pop is treated as a no-op in this case.
        *noop = true;
        return;
    }

    if (!pathToCreate->empty()) {
        // There were path components which we could not traverse. If 'element' is a nested object
        // which does not contain 'pathToCreate', then this is a no-op (e.g. {$pop: {"a.b.c": 1}}
        // for document {a: {b: {}}}).
        //
        // If the element is an array, but the numeric path does not exist, then this is also a
        // no-op (e.g. {$pop: {"a.2.b": 1}} for document {a: [{b: 0}, {b: 1}]}).
        //
        // Otherwise, this the path contains a blocking leaf or array element, which is an error.
        if (element.getType() == BSONType::Object) {
            *noop = true;
            return;
        }

        size_t arrayIndex;
        if (element.getType() == BSONType::Array &&
            pathsupport::isNumericPathComponent(pathToCreate->getPart(0), &arrayIndex)) {
            *noop = true;
            return;
        }

        uasserted(ErrorCodes::PathNotViable,
                  str::stream() << "Cannot use the part (" << pathToCreate->getPart(0) << ") of ("
                                << pathTaken->dottedField()
                                << "."
                                << pathToCreate->dottedField()
                                << ") to traverse the element ({"
                                << element.toString()
                                << "})");
    }

    invariant(!pathTaken->empty());
    invariant(pathToCreate->empty());

    // The full path existed, but we must fail if the element at that path is not an array.
    invariant(element.ok());
    uassert(ErrorCodes::TypeMismatch,
            str::stream() << "Path '" << pathTaken->dottedField()
                          << "' contains an element of non-array type '"
                          << typeName(element.getType())
                          << "'",
            element.getType() == BSONType::Array);

    if (!element.hasChildren()) {
        // The path exists and contains an array, but the array is empty.
        *noop = true;
        return;
    }

    if (indexData && indexData->mightBeIndexed(pathTaken->dottedField())) {
        *indexesAffected = true;
    }

    auto elementToRemove = _popFromFront ? element.leftChild() : element.rightChild();
    invariantOK(elementToRemove.remove());

    if (logBuilder) {
        uassertStatusOK(logBuilder->addToSetsWithNewFieldName(pathTaken->dottedField(), element));
    }
}

}  // namespace mongo