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
|
/**
* Copyright (C) 2012 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.
*/
#pragma once
#include <string>
#include "mongo/db/jsobj.h"
#include "mongo/util/time_support.h"
namespace mongo {
class FieldParser {
public:
/**
* Returns true and fills in 'out' with the contents of the field described by 'field'
* or with the value in 'def', depending on whether the field is present and has the
* correct type in 'doc' or not, respectively. Otherwise, if the field exists but has
* the wrong type, returns false.
*
* NOTE ON BSON OWNERSHIP:
*
* The caller must assume that this class will point to data inside 'doc' without
* copying it. In practice this means that 'doc' MUST EXIST for as long as 'out'
* stays in scope.
*/
enum FieldState {
// The field is present but has the wrong type
FIELD_INVALID = 0,
// The field is present and has the correct type
FIELD_SET,
// The field is absent in the BSON object but set from default
FIELD_DEFAULT,
// The field is absent and no default was specified
FIELD_NONE
};
static FieldState extract(BSONObj doc,
const BSONField<bool>& field,
bool* out,
std::string* errMsg = NULL);
static FieldState extract(BSONElement elem,
const BSONField<bool>& field,
bool* out,
std::string* errMsg = NULL);
static FieldState extract(BSONObj doc,
const BSONField<BSONArray>& field,
BSONArray* out,
std::string* errMsg = NULL);
static FieldState extract(BSONElement elem,
const BSONField<BSONArray>& field,
BSONArray* out,
std::string* errMsg = NULL);
static FieldState extract(BSONObj doc,
const BSONField<BSONObj>& field,
BSONObj* out,
std::string* errMsg = NULL);
static FieldState extract(BSONElement elem,
const BSONField<BSONObj>& field,
BSONObj* out,
std::string* errMsg = NULL);
static FieldState extract(BSONObj doc,
const BSONField<Date_t>& field,
Date_t* out,
std::string* errMsg = NULL);
static FieldState extract(BSONElement elem,
const BSONField<Date_t>& field,
Date_t* out,
std::string* errMsg = NULL);
static FieldState extract(BSONObj doc,
const BSONField<Timestamp>& field,
Timestamp* out,
std::string* errMsg = NULL);
static FieldState extract(BSONElement elem,
const BSONField<Timestamp>& field,
Timestamp* out,
std::string* errMsg = NULL);
static FieldState extract(BSONObj doc,
const BSONField<std::string>& field,
std::string* out,
std::string* errMsg = NULL);
static FieldState extract(BSONElement elem,
const BSONField<std::string>& field,
std::string* out,
std::string* errMsg = NULL);
static FieldState extract(BSONObj doc,
const BSONField<OID>& field,
OID* out,
std::string* errMsg = NULL);
static FieldState extract(BSONElement elem,
const BSONField<OID>& field,
OID* out,
std::string* errMsg = NULL);
static FieldState extract(BSONObj doc,
const BSONField<int>& field,
int* out,
std::string* errMsg = NULL);
static FieldState extract(BSONElement elem,
const BSONField<int>& field,
int* out,
std::string* errMsg = NULL);
static FieldState extract(BSONObj doc,
const BSONField<long long>& field,
long long* out,
std::string* errMsg = NULL);
static FieldState extract(BSONElement elem,
const BSONField<long long>& field,
long long* out,
std::string* errMsg = NULL);
static FieldState extract(BSONElement elem,
const BSONField<double>& field,
double* out,
std::string* errMsg = NULL);
static FieldState extract(BSONObj doc,
const BSONField<double>& field,
double* out,
std::string* errMsg = NULL);
/**
* The following extractNumber methods do implicit conversion between any numeric type and
* the BSONField type. This can be useful when an exact numeric type is not needed, for
* example if the field is sometimes modified from the shell which can change the type.
*/
static FieldState extractNumber(BSONObj doc,
const BSONField<int>& field,
int* out,
std::string* errMsg = NULL);
static FieldState extractNumber(BSONElement elem,
const BSONField<int>& field,
int* out,
std::string* errMsg = NULL);
static FieldState extractNumber(BSONObj doc,
const BSONField<long long>& field,
long long* out,
std::string* errMsg = NULL);
static FieldState extractNumber(BSONElement elem,
const BSONField<long long>& field,
long long* out,
std::string* errMsg = NULL);
static FieldState extractNumber(BSONObj doc,
const BSONField<double>& field,
double* out,
std::string* errMsg = NULL);
static FieldState extractNumber(BSONElement elem,
const BSONField<double>& field,
double* out,
std::string* errMsg = NULL);
/**
* Extracts a document id from a particular field name, which may be of any type but Array.
* Wraps the extracted id value in a BSONObj with one element and empty field name.
*/
static FieldState extractID(BSONObj doc,
const BSONField<BSONObj>& field,
BSONObj* out,
std::string* errMsg = NULL);
static FieldState extractID(BSONElement elem,
const BSONField<BSONObj>& field,
BSONObj* out,
std::string* errMsg = NULL);
// TODO: BSONElement extraction of types below
/**
* Extracts a mandatory 'field' from the object 'doc'. Writes the extracted contents to '*out'
* if successful or fills '*errMsg', if exising, otherwise. This variant relies on T having a
* parseBSON method.
*/
template <typename T>
static FieldState extract(BSONObj doc,
const BSONField<T>& field,
T* out,
std::string* errMsg = NULL);
/**
* Similar to the mandatory 'extract' but on a optional field. The '*out' value would only be
* allocated if the field is present. The ownership of '*out' would be transferred to the
* caller, in that case.
*/
template <typename T>
static FieldState extract(BSONObj doc,
const BSONField<T*>& field,
T** out,
std::string* errMsg = NULL);
template <typename T>
static FieldState extract(BSONObj doc,
const BSONField<T>& field,
T** out, // alloc variation
std::string* errMsg = NULL);
/**
* Extracts a mandatory repetition of 'field', from the object 'doc'. Writes the extracted
* contents to '*out' if successful or fills '*errMsg', if exising, otherwise. This variant
* relies on T having a parseBSON method.
*
* The vector owns the instances of T.
*/
template <typename T>
static FieldState extract(BSONObj doc,
const BSONField<std::vector<T*>>& field,
std::vector<T*>* out,
std::string* errMsg = NULL);
/**
* Extracts a mandatory repetition of 'field', from the field 'elem'. Writes the extracted
* contents to '*out' if successful or fills '*errMsg', if exising, otherwise. This variant
* relies on T having a parseBSON method.
*
* The vector owns the instances of T.
*/
template <typename T>
static FieldState extract(BSONElement elem,
const BSONField<std::vector<T*>>& field,
std::vector<T*>* out,
std::string* errMsg = NULL);
/**
* Similar to the mandatory repetition' extract but on an optional field. The '*out' value would
* only be allocated if the field is present. The ownership of '*out' would be transferred to
* the caller, in that case.
*
* The vector owns the instances of T.
*/
template <typename T>
static FieldState extract(BSONObj doc,
const BSONField<std::vector<T*>>& field,
std::vector<T*>** out,
std::string* errMsg = NULL);
//
// ==================== Below DEPRECATED; use types instead ====================
//
/**
* The following extract methods are templatized to handle extraction of vectors and
* maps of sub-objects. Keys in the map should be StringData compatible.
*
* It's possible to nest extraction of vectors and maps to any depth, i.e:
*
* std::vector<map<std::string,vector<std::string> > > val;
* FieldParser::extract(doc, field, val, &val);
*/
template <typename T>
static FieldState extract(BSONObj doc,
const BSONField<std::vector<T>>& field,
std::vector<T>* out,
std::string* errMsg = NULL);
template <typename T>
static FieldState extract(BSONElement elem,
const BSONField<std::vector<T>>& field,
std::vector<T>* out,
std::string* errMsg = NULL);
template <typename K, typename T>
static FieldState extract(BSONObj doc,
const BSONField<std::map<K, T>>& field,
std::map<K, T>* out,
std::string* errMsg = NULL);
template <typename K, typename T>
static FieldState extract(BSONElement elem,
const BSONField<std::map<K, T>>& field,
std::map<K, T>* out,
std::string* errMsg = NULL);
};
} // namespace mongo
// Inline functions for templating
#include "field_parser-inl.h"
|
