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
|
/**
* Copyright (C) 2018-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.
*/
#pragma once
#include <map>
#include <sstream>
#include <string>
#include <vector>
#include "mongo/base/status_with.h"
#include "mongo/base/string_data.h"
#include "mongo/bson/bsonobj.h"
#include "mongo/bson/util/builder.h"
#include "mongo/client/connection_string.h"
#include "mongo/stdx/mutex.h"
#include "mongo/util/assert_util.h"
#include "mongo/util/net/hostandport.h"
namespace mongo {
/**
* Encode a string for embedding in a URI.
* Replaces reserved bytes with %xx sequences.
*
* Optionally allows passthrough characters to remain unescaped.
*/
void uriEncode(std::ostream& ss, StringData str, StringData passthrough = ""_sd);
inline std::string uriEncode(StringData str, StringData passthrough = ""_sd) {
std::ostringstream ss;
uriEncode(ss, str, passthrough);
return ss.str();
}
/**
* Decode a URI encoded string.
* Replaces + and %xx sequences with their original byte.
*/
StatusWith<std::string> uriDecode(StringData str);
/**
* MongoURI handles parsing of URIs for mongodb, and falls back to old-style
* ConnectionString parsing. It's used primarily by the shell.
* It parses URIs with the following formats:
*
* mongodb://[usr:pwd@]host1[:port1]...[,hostN[:portN]]][/[db][?options]]
* mongodb+srv://[usr:pwd@]host[/[db][?options]]
*
* `mongodb+srv://` URIs will perform DNS SRV and TXT lookups and expand per the DNS Seedlist
* specification.
*
* While this format is generally RFC 3986 compliant, some exceptions do exist:
* 1. The 'host' field, as defined by section 3.2.2 is expanded in the following ways:
* a. Multiple hosts may be specified as a comma separated list.
* b. Hosts may take the form of absolute paths for unix domain sockets.
* i. Sockets must end in the suffix '.sock'
* 2. The 'fragment' field, as defined by section 3.5 is not permitted.
*
* For a complete list of URI string options, see
* https://docs.mongodb.com/manual/reference/connection-string/#connection-string-options
*
* Examples:
*
* A replica set with three members (one running on default port 27017):
* string uri = mongodb://localhost,localhost:27018,localhost:27019
*
* Authenticated connection to db 'bedrock' with user 'barney' and pwd 'rubble':
* string url = mongodb://barney:rubble@localhost/bedrock
*
* Use parse() to parse the url, then validate and connect:
* string errmsg;
* ConnectionString cs = ConnectionString::parse( url, errmsg );
* if ( ! cs.isValid() ) throw "bad connection string: " + errmsg;
* DBClientBase * conn = cs.connect( errmsg );
*/
class MongoURI {
public:
// Note that, because this map is used for DNS TXT record injection on options, there is a
// requirement on its behavior for `insert`: insert must not replace or update existing values
// -- this gives the desired behavior that user-specified values override TXT record specified
// values. `std::map` and `std::unordered_map` satisfy this requirement. Make sure that
// whichever map type is used provides that guarantee.
using OptionsMap = std::map<std::string, std::string>;
static StatusWith<MongoURI> parse(const std::string& url);
/*
* Returns true if str starts with one of the uri schemes (e.g. mongodb:// or mongodb+srv://)
*/
static bool isMongoURI(StringData str);
/*
* Returns a copy of the input url as a string with the password and connection options
* removed. This may uassert or return a mal-formed string if the input is not a valid URI
*/
static std::string redact(StringData url);
DBClientBase* connect(StringData applicationName,
std::string& errmsg,
boost::optional<double> socketTimeoutSecs = boost::none) const;
const std::string& getUser() const {
return _user;
}
const std::string& getPassword() const {
return _password;
}
const OptionsMap& getOptions() const {
return _options;
}
const std::string& getDatabase() const {
return _database;
}
bool isValid() const {
return _connectString.isValid();
}
const std::string& toString() const {
return _connectString.toString();
}
const std::string& getSetName() const {
return _connectString.getSetName();
}
const std::vector<HostAndPort>& getServers() const {
return _connectString.getServers();
}
const boost::optional<std::string> getAppName() const;
boost::optional<bool> getRetryWrites() const {
return _retryWrites;
}
// If you are trying to clone a URI (including its options/auth information) for a single
// server (say a member of a replica-set), you can pass in its HostAndPort information to
// get a new URI with the same info, except type() will be MASTER and getServers() will
// be the single host you pass in.
MongoURI cloneURIForServer(HostAndPort hostAndPort) const {
return MongoURI(ConnectionString(std::move(hostAndPort)),
_user,
_password,
_database,
_retryWrites,
_options);
}
ConnectionString::ConnectionType type() const {
return _connectString.type();
}
explicit MongoURI(const ConnectionString& connectString) : _connectString(connectString){};
MongoURI() = default;
friend std::ostream& operator<<(std::ostream&, const MongoURI&);
friend StringBuilder& operator<<(StringBuilder&, const MongoURI&);
private:
MongoURI(ConnectionString connectString,
const std::string& user,
const std::string& password,
const std::string& database,
boost::optional<bool> retryWrites,
OptionsMap options)
: _connectString(std::move(connectString)),
_user(user),
_password(password),
_database(database),
_retryWrites(std::move(retryWrites)),
_options(std::move(options)) {}
BSONObj _makeAuthObjFromOptions(int maxWireVersion) const;
static MongoURI parseImpl(const std::string& url);
ConnectionString _connectString;
std::string _user;
std::string _password;
std::string _database;
boost::optional<bool> _retryWrites;
OptionsMap _options;
};
inline std::ostream& operator<<(std::ostream& ss, const MongoURI& uri) {
return ss << uri._connectString;
}
inline StringBuilder& operator<<(StringBuilder& sb, const MongoURI& uri) {
return sb << uri._connectString;
}
} // namespace mongo
|
