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
|
/**
* Copyright (C) 2022-present MongoDB, Inc.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the Server Side Public License, version 1,
* as published by MongoDB, Inc.
*
* 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
* Server Side Public License for more details.
*
* You should have received a copy of the Server Side Public License
* along with this program. If not, see
* <http://www.mongodb.com/licensing/server-side-public-license>.
*
* 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 Server Side 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/db/pipeline/document_source_list_catalog.h"
#include <fmt/format.h>
#include "mongo/db/commands/feature_compatibility_version_documentation.h"
#include "mongo/db/namespace_string.h"
#include "mongo/db/pipeline/expression_context.h"
#include "mongo/db/pipeline/process_interface/mongo_process_interface.h"
#include "mongo/db/server_options.h"
#include "mongo/db/storage/storage_parameters_gen.h"
#include "mongo/util/version/releases.h"
namespace mongo {
using boost::intrusive_ptr;
REGISTER_DOCUMENT_SOURCE_WITH_MIN_VERSION(listCatalog,
DocumentSourceListCatalog::LiteParsed::parse,
DocumentSourceListCatalog::createFromBson,
AllowedWithApiStrict::kNeverInVersion1,
multiversion::FeatureCompatibilityVersion::kVersion_5_3);
const char* DocumentSourceListCatalog::getSourceName() const {
return kStageName.rawData();
}
PrivilegeVector DocumentSourceListCatalog::LiteParsed::requiredPrivileges(
bool isMongos, bool bypassDocumentValidation) const {
// Refer to privileges for the readAnyDatabase role in addReadOnlyAnyDbPrivileges().
// See builtin_roles.cpp.
// TODO(SERVER-63748): Change privileges to a combination of listDatabases, listCollections,
// and listIndexes.
return {Privilege(ResourcePattern::forDatabaseName("admin"), ActionType::find)};
}
DocumentSource::GetNextResult DocumentSourceListCatalog::doGetNext() {
if (!_catalogDocsInitialized) {
_catalogDocs = pExpCtx->mongoProcessInterface->listCatalog(pExpCtx->opCtx);
_catalogDocsInitialized = true;
}
if (!_catalogDocs.empty()) {
Document doc{_catalogDocs.front()};
_catalogDocs.pop_front();
return doc;
}
return GetNextResult::makeEOF();
}
DocumentSourceListCatalog::DocumentSourceListCatalog(
const intrusive_ptr<ExpressionContext>& pExpCtx)
: DocumentSource(kStageName, pExpCtx) {}
intrusive_ptr<DocumentSource> DocumentSourceListCatalog::createFromBson(
BSONElement elem, const intrusive_ptr<ExpressionContext>& pExpCtx) {
uassert(6200600,
"The $listCatalog stage specification must be an empty object",
elem.type() == Object && elem.Obj().isEmpty());
const NamespaceString& nss = pExpCtx->ns;
uassert(ErrorCodes::InvalidNamespace,
"$listCatalog must be run against the 'admin' database with {aggregate: 1}",
nss.db() == NamespaceString::kAdminDb && nss.isCollectionlessAggregateNS());
uassert(ErrorCodes::QueryFeatureNotAllowed,
fmt::format("The {} aggregation stage is not enabled", kStageName),
feature_flags::gDocumentSourceListCatalog.isEnabled(
serverGlobalParams.featureCompatibility));
// We declare this stage with a min version but the base class DocumentSource checks the
// minimum version only if pExpCtx->maxFeatureCompatibilityVersion is provided.
if (!pExpCtx->maxFeatureCompatibilityVersion) {
const auto& globalFcv = serverGlobalParams.featureCompatibility;
using FCV = multiversion::FeatureCompatibilityVersion;
uassert(ErrorCodes::QueryFeatureNotAllowed,
fmt::format("The {} aggregation stage is not allowed in the current feature "
"compatibility version. See {} for more information.",
kStageName,
feature_compatibility_version_documentation::kCompatibilityLink),
!globalFcv.isVersionInitialized() ||
globalFcv.isGreaterThanOrEqualTo(FCV::kVersion_5_3));
}
return new DocumentSourceListCatalog(pExpCtx);
}
Value DocumentSourceListCatalog::serialize(
boost::optional<ExplainOptions::Verbosity> explain) const {
return Value(DOC(getSourceName() << Document()));
}
} // namespace mongo
|
