summaryrefslogtreecommitdiff
path: root/src/mongo/db/pipeline/document_source_redact.cpp
blob: 9447a9e4fa24331b0fe3aea3b312d23ffab2ee09 (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
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
/**
 * Copyright 2011 (c) 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/platform/basic.h"

#include "mongo/db/pipeline/document_source.h"

#include <boost/optional.hpp>

#include "mongo/db/jsobj.h"
#include "mongo/db/pipeline/document.h"
#include "mongo/db/pipeline/expression.h"
#include "mongo/db/pipeline/value.h"

namespace mongo {

    using boost::intrusive_ptr;
    using std::vector;

    const char DocumentSourceRedact::redactName[] = "$redact";

    DocumentSourceRedact::DocumentSourceRedact(const intrusive_ptr<ExpressionContext>& expCtx,
                                               const intrusive_ptr<Expression>& expression)
        : DocumentSource(expCtx)
        , _expression(expression)
    { }

    const char *DocumentSourceRedact::getSourceName() const {
        return redactName;
    }

    static const Value descendVal = Value("descend");
    static const Value pruneVal = Value("prune");
    static const Value keepVal = Value("keep");

    boost::optional<Document> DocumentSourceRedact::getNext() {
        while (boost::optional<Document> in = pSource->getNext()) {
            _variables->setRoot(*in);
            _variables->setValue(_currentId, Value(*in));
            if (boost::optional<Document> result = redactObject()) {
                return result;
            }
        }

        return boost::none;
    }

    Value DocumentSourceRedact::redactValue(const Value& in) {
        const BSONType valueType = in.getType();
        if (valueType == Object) {
            _variables->setValue(_currentId, in);
            const boost::optional<Document> result = redactObject();
            if (result) {
                return Value(*result);
            }
            else {
                return Value();
            }
        }
        else if (valueType == Array) {
            // TODO dont copy if possible
            vector<Value> newArr;
            const vector<Value>& arr = in.getArray();
            for (size_t i = 0; i < arr.size(); i++) {
                if (arr[i].getType() == Object || arr[i].getType() == Array) {
                    const Value toAdd = redactValue(arr[i]) ;
                    if (!toAdd.missing()) {
                        newArr.push_back(toAdd);
                    }
                }
                else {
                    newArr.push_back(arr[i]);
                }
            }
            return Value::consume(newArr);
        }
        else {
            return in;
        }
    }

    boost::optional<Document> DocumentSourceRedact::redactObject() {
        const Value expressionResult = _expression->evaluate(_variables.get());

        if (expressionResult == keepVal) {
            return _variables->getDocument(_currentId);
        }
        else if (expressionResult == pruneVal) {
            return boost::optional<Document>();
        }
        else if (expressionResult == descendVal) {
            const Document in = _variables->getDocument(_currentId);
            MutableDocument out;
            out.copyMetaDataFrom(in);
            FieldIterator fields(in);
            while (fields.more()) {
                const Document::FieldPair field(fields.next());

                // This changes CURRENT so don't read from _variables after this
                const Value val = redactValue(field.second);
                if (!val.missing()) {
                    out.addField(field.first, val);
                }
            }
            return out.freeze();
        }
        else {
            uasserted(17053, str::stream() << "$redact's expression should not return anything "
                                           << "aside from the variables $$KEEP, $$DESCEND, and "
                                           << "$$PRUNE, but returned "
                                           << expressionResult.toString());
        }
    }

    void DocumentSourceRedact::optimize() {
        _expression = _expression->optimize();
    }

    Value DocumentSourceRedact::serialize(bool explain) const {
        return Value(DOC(getSourceName() << _expression.get()->serialize(explain)));
    }

    intrusive_ptr<DocumentSource> DocumentSourceRedact::createFromBson(
            BSONElement elem,
            const intrusive_ptr<ExpressionContext>& expCtx) {

        VariablesIdGenerator idGenerator;
        VariablesParseState vps(&idGenerator);
        Variables::Id currentId = vps.defineVariable("CURRENT"); // will differ from ROOT
        Variables::Id decendId = vps.defineVariable("DESCEND");
        Variables::Id pruneId = vps.defineVariable("PRUNE");
        Variables::Id keepId = vps.defineVariable("KEEP");
        intrusive_ptr<Expression> expression = Expression::parseOperand(elem, vps);
        intrusive_ptr<DocumentSourceRedact> source = new DocumentSourceRedact(expCtx, expression);

        // TODO figure out how much of this belongs in constructor and how much here.
        // Set up variables. Never need to reset DESCEND, PRUNE, or KEEP.
        source->_currentId = currentId;
        source->_variables.reset(new Variables(idGenerator.getIdCount()));
        source->_variables->setValue(decendId, descendVal);
        source->_variables->setValue(pruneId, pruneVal);
        source->_variables->setValue(keepId, keepVal);


        return source;
    }
}