summaryrefslogtreecommitdiff
path: root/src/mongo/db/pipeline/document_source_redact.cpp
blob: 910fbb535de04b67a1e889ad870d81016a280ce6 (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
/**
 * 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/>.
 */

#include "mongo/pch.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 {

    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 vars = Variables(*in,
                                       Value(*in),
                                       DOC("DESCEND" << descendVal
                                        << "PRUNE" << pruneVal
                                        << "KEEP" << keepVal));

            if (boost::optional<Document> result = redactObject(vars)) {
                return result;
            }
        }

        return boost::none;
    }

    Value DocumentSourceRedact::redactValue(const Variables& vars, const Value& in) {
        const BSONType valueType = in.getType();
        if (valueType == Object) {
            Variables recurse = vars;
            recurse.current = in;
            const boost::optional<Document> result = redactObject(recurse);
            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(vars, 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 Variables& in) {
        const Value expressionResult = _expression->evaluate(in);

        if (expressionResult == keepVal) {
            return in.current.getDocument();
        }
        else if (expressionResult == pruneVal) {
            return boost::optional<Document>();
        }
        else if (expressionResult == descendVal) {
            MutableDocument out;
            FieldIterator fields(in.current.getDocument());
            while (fields.more()) {
                const Document::FieldPair field(fields.next());
                const Value val = redactValue(in, 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()));
    }

    intrusive_ptr<DocumentSource> DocumentSourceRedact::createFromBson(
            BSONElement* bsonElement,
            const intrusive_ptr<ExpressionContext>& expCtx) {
        uassert(17054, str::stream() << redactName << " specification must be an object",
                bsonElement->type() == Object);

        Expression::ObjectCtx oCtx(0);

        intrusive_ptr<Expression> expression = Expression::parseObject(bsonElement, &oCtx);

        return new DocumentSourceRedact(expCtx, expression);
    }
}