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
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
|
/**
* Copyright (C) 2014-2016 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 <vector>
#include "mongo/base/checked_cast.h"
#include "mongo/bson/bsonmisc.h"
#include "mongo/bson/bsonobj.h"
#include "mongo/bson/simple_bsonobj_comparator.h"
#include "mongo/db/auth/authorization_session.h"
#include "mongo/db/catalog/collection.h"
#include "mongo/db/catalog/collection_catalog_entry.h"
#include "mongo/db/catalog/cursor_manager.h"
#include "mongo/db/catalog/database.h"
#include "mongo/db/catalog/database_catalog_entry.h"
#include "mongo/db/clientcursor.h"
#include "mongo/db/commands.h"
#include "mongo/db/commands/list_collections_filter.h"
#include "mongo/db/db_raii.h"
#include "mongo/db/exec/queued_data_stage.h"
#include "mongo/db/exec/working_set.h"
#include "mongo/db/index/index_descriptor.h"
#include "mongo/db/matcher/extensions_callback_disallow_extensions.h"
#include "mongo/db/query/cursor_request.h"
#include "mongo/db/query/cursor_response.h"
#include "mongo/db/query/find_common.h"
#include "mongo/db/service_context.h"
#include "mongo/db/storage/storage_engine.h"
#include "mongo/db/storage/storage_options.h"
#include "mongo/db/views/view_catalog.h"
#include "mongo/stdx/memory.h"
namespace mongo {
using std::string;
using std::stringstream;
using std::unique_ptr;
using std::vector;
using stdx::make_unique;
namespace {
/**
* Determines if 'matcher' is an exact match on the "name" field. If so, returns a vector of all the
* collection names it is matching against. Returns {} if there is no obvious exact match on name.
*
* Note the collection names returned are not guaranteed to exist, nor are they guaranteed to match
* 'matcher'.
*/
boost::optional<vector<StringData>> _getExactNameMatches(const MatchExpression* matcher) {
if (!matcher) {
return {};
}
MatchExpression::MatchType matchType(matcher->matchType());
if (matchType == MatchExpression::EQ) {
auto eqMatch = checked_cast<const EqualityMatchExpression*>(matcher);
if (eqMatch->path() == "name") {
auto& elem = eqMatch->getData();
if (elem.type() == String) {
return {vector<StringData>{elem.valueStringData()}};
} else {
return vector<StringData>();
}
}
} else if (matchType == MatchExpression::MATCH_IN) {
auto matchIn = checked_cast<const InMatchExpression*>(matcher);
if (matchIn->path() == "name" && matchIn->getRegexes().empty()) {
vector<StringData> exactMatches;
for (auto&& elem : matchIn->getEqualities()) {
if (elem.type() == String) {
exactMatches.push_back(elem.valueStringData());
}
}
return {std::move(exactMatches)};
}
}
return {};
}
/**
* Uses 'matcher' to determine if the collection's information should be added to 'root'. If so,
* allocates a WorkingSetMember containing information about 'collection', and adds it to 'root'.
*
* Does not add any information about the system.namespaces collection, or non-existent collections.
*/
void _addWorkingSetMember(OperationContext* opCtx,
const BSONObj& maybe,
const MatchExpression* matcher,
WorkingSet* ws,
QueuedDataStage* root) {
if (matcher && !matcher->matchesBSON(maybe)) {
return;
}
WorkingSetID id = ws->allocate();
WorkingSetMember* member = ws->get(id);
member->keyData.clear();
member->recordId = RecordId();
member->obj = Snapshotted<BSONObj>(SnapshotId(), maybe);
member->transitionToOwnedObj();
root->pushBack(id);
}
BSONObj buildViewBson(const ViewDefinition& view) {
BSONObjBuilder b;
b.append("name", view.name().coll());
b.append("type", "view");
BSONObjBuilder optionsBuilder(b.subobjStart("options"));
optionsBuilder.append("viewOn", view.viewOn().coll());
optionsBuilder.append("pipeline", view.pipeline());
if (view.defaultCollator()) {
optionsBuilder.append("collation", view.defaultCollator()->getSpec().toBSON());
}
optionsBuilder.doneFast();
BSONObj info = BSON("readOnly" << true);
b.append("info", info);
return b.obj();
}
BSONObj buildCollectionBson(OperationContext* opCtx, const Collection* collection) {
if (!collection) {
return {};
}
StringData collectionName = collection->ns().coll();
if (collectionName == "system.namespaces") {
return {};
}
BSONObjBuilder b;
b.append("name", collectionName);
b.append("type", "collection");
CollectionOptions options = collection->getCatalogEntry()->getCollectionOptions(opCtx);
// While the UUID is stored as a collection option, from the user's perspective it is an
// unsettable read-only property, so put it in the 'info' section.
auto uuid = options.uuid;
options.uuid.reset();
b.append("options", options.toBSON());
BSONObjBuilder infoBuilder;
infoBuilder.append("readOnly", storageGlobalParams.readOnly);
if (uuid)
infoBuilder.appendElements(uuid->toBSON());
b.append("info", infoBuilder.obj());
auto idIndex = collection->getIndexCatalog()->findIdIndex(opCtx);
if (idIndex) {
b.append("idIndex", idIndex->infoObj());
}
return b.obj();
}
class CmdListCollections : public Command {
public:
virtual bool slaveOk() const {
return false;
}
virtual bool slaveOverrideOk() const {
return true;
}
virtual bool adminOnly() const {
return false;
}
virtual bool supportsWriteConcern(const BSONObj& cmd) const override {
return false;
}
virtual void help(stringstream& help) const {
help << "list collections for this db";
}
virtual Status checkAuthForCommand(Client* client,
const std::string& dbname,
const BSONObj& cmdObj) {
AuthorizationSession* authzSession = AuthorizationSession::get(client);
// Check for the listCollections ActionType on the database
// or find on system.namespaces for pre 3.0 systems.
if (authzSession->isAuthorizedForActionsOnResource(ResourcePattern::forDatabaseName(dbname),
ActionType::listCollections) ||
authzSession->isAuthorizedForActionsOnResource(
ResourcePattern::forExactNamespace(NamespaceString(dbname, "system.namespaces")),
ActionType::find)) {
return Status::OK();
}
return Status(ErrorCodes::Unauthorized,
str::stream() << "Not authorized to list collections on db: " << dbname);
}
CmdListCollections() : Command("listCollections") {}
bool run(OperationContext* opCtx,
const string& dbname,
BSONObj& jsobj,
int,
string& errmsg,
BSONObjBuilder& result) {
unique_ptr<MatchExpression> matcher;
BSONElement filterElt = jsobj["filter"];
if (!filterElt.eoo()) {
if (filterElt.type() != mongo::Object) {
return appendCommandStatus(
result, Status(ErrorCodes::BadValue, "\"filter\" must be an object"));
}
// The collator is null because collection objects are compared using binary comparison.
const CollatorInterface* collator = nullptr;
StatusWithMatchExpression statusWithMatcher = MatchExpressionParser::parse(
filterElt.Obj(), ExtensionsCallbackDisallowExtensions(), collator);
if (!statusWithMatcher.isOK()) {
return appendCommandStatus(result, statusWithMatcher.getStatus());
}
matcher = std::move(statusWithMatcher.getValue());
}
const long long defaultBatchSize = std::numeric_limits<long long>::max();
long long batchSize;
Status parseCursorStatus =
CursorRequest::parseCommandCursorOptions(jsobj, defaultBatchSize, &batchSize);
if (!parseCursorStatus.isOK()) {
return appendCommandStatus(result, parseCursorStatus);
}
AutoGetDb autoDb(opCtx, dbname, MODE_S);
Database* db = autoDb.getDb();
auto ws = make_unique<WorkingSet>();
auto root = make_unique<QueuedDataStage>(opCtx, ws.get());
if (db) {
if (auto collNames = _getExactNameMatches(matcher.get())) {
for (auto&& collName : *collNames) {
auto nss = NamespaceString(db->name(), collName);
Collection* collection = db->getCollection(nss);
BSONObj collBson = buildCollectionBson(opCtx, collection);
if (!collBson.isEmpty()) {
_addWorkingSetMember(opCtx, collBson, matcher.get(), ws.get(), root.get());
}
}
} else {
for (auto&& collection : *db) {
BSONObj collBson = buildCollectionBson(opCtx, collection);
if (!collBson.isEmpty()) {
_addWorkingSetMember(opCtx, collBson, matcher.get(), ws.get(), root.get());
}
}
}
// Skipping views is only necessary for internal cloning operations.
bool skipViews = filterElt.type() == mongo::Object &&
SimpleBSONObjComparator::kInstance.evaluate(
filterElt.Obj() == ListCollectionsFilter::makeTypeCollectionFilter());
if (!skipViews) {
db->getViewCatalog()->iterate(opCtx, [&](const ViewDefinition& view) {
BSONObj viewBson = buildViewBson(view);
if (!viewBson.isEmpty()) {
_addWorkingSetMember(opCtx, viewBson, matcher.get(), ws.get(), root.get());
}
});
}
}
const NamespaceString cursorNss = NamespaceString::makeListCollectionsNSS(dbname);
auto statusWithPlanExecutor = PlanExecutor::make(
opCtx, std::move(ws), std::move(root), cursorNss, PlanExecutor::YIELD_MANUAL);
if (!statusWithPlanExecutor.isOK()) {
return appendCommandStatus(result, statusWithPlanExecutor.getStatus());
}
unique_ptr<PlanExecutor> exec = std::move(statusWithPlanExecutor.getValue());
BSONArrayBuilder firstBatch;
for (long long objCount = 0; objCount < batchSize; objCount++) {
BSONObj next;
PlanExecutor::ExecState state = exec->getNext(&next, NULL);
if (state == PlanExecutor::IS_EOF) {
break;
}
invariant(state == PlanExecutor::ADVANCED);
// If we can't fit this result inside the current batch, then we stash it for later.
if (!FindCommon::haveSpaceForNext(next, objCount, firstBatch.len())) {
exec->enqueue(next);
break;
}
firstBatch.append(next);
}
CursorId cursorId = 0LL;
if (!exec->isEOF()) {
exec->saveState();
exec->detachFromOperationContext();
auto pinnedCursor = CursorManager::getGlobalCursorManager()->registerCursor(
{std::move(exec),
cursorNss,
opCtx->recoveryUnit()->isReadingFromMajorityCommittedSnapshot(),
jsobj});
cursorId = pinnedCursor.getCursor()->cursorid();
}
appendCursorResponseObject(cursorId, cursorNss.ns(), firstBatch.arr(), &result);
return true;
}
} cmdListCollections;
} // namespace
} // namespace mongo
|