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
|
// @file namespacestring.h
/**
* Copyright (C) 2008 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/>.
*/
#pragma once
#include <string>
#include "mongo/base/string_data.h"
#include "mongo/util/assert_util.h"
namespace mongo {
using std::string;
/* in the mongo source code, "client" means "database". */
const size_t MaxDatabaseNameLen = 128; // max str len for the db name, including null char
/* e.g.
NamespaceString ns("acme.orders");
cout << ns.coll; // "orders"
*/
class NamespaceString {
public:
NamespaceString( const StringData& ns );
StringData db() const;
StringData coll() const;
const string& ns() const { return _ns; }
operator string() const { return _ns; }
string toString() const { return _ns; }
size_t size() const { return _ns.size(); }
bool isSystem() const { return coll().startsWith( "system." ); }
bool isConfigDB() const { return db() == "config"; }
bool isCommand() const { return coll() == "$cmd"; }
bool isSpecialCommand() const { return coll().startsWith("$cmd.sys"); }
/**
* @return true if the namespace is valid. Special namespaces for internal use are considered as valid.
*/
bool isValid() const { return validDBName( db() ) && !coll().empty(); }
bool operator==( const string& nsIn ) const { return nsIn == _ns; }
bool operator==( const NamespaceString& nsIn ) const { return nsIn._ns == _ns; }
bool operator!=( const string& nsIn ) const { return nsIn != _ns; }
bool operator!=( const NamespaceString& nsIn ) const { return nsIn._ns != _ns; }
/** ( foo.bar ).getSisterNS( "blah" ) == foo.blah
*/
string getSisterNS( const StringData& local ) const;
// @return db() + ".system.indexes"
string getSystemIndexesCollection() const;
/**
* @return true if ns is 'normal'. A "$" is used for namespaces holding index data,
* which do not contain BSON objects in their records. ("oplog.$main" is the exception)
*/
static bool normal(const StringData& ns);
/**
* @return true if the ns is an oplog one, otherwise false.
*/
static bool oplog(const StringData& ns);
static bool special(const StringData& ns);
/**
* samples:
* good
* foo
* bar
* foo-bar
* bad:
* foo bar
* foo.bar
* foo"bar
*
* @param db - a possible database name
* @return if db is an allowed database name
*/
static bool validDBName( const StringData& dbin );
/**
* samples:
* good:
* foo.bar
* bad:
* foo.
*
* @param ns - a full namesapce (a.b)
* @return if db.coll is an allowed collection name
*/
static bool validCollectionName(const StringData& ns);
private:
string _ns;
size_t _dotIndex;
};
// "database.a.b.c" -> "database"
inline StringData nsToDatabaseSubstring( const StringData& ns ) {
size_t i = ns.find( '.' );
if ( i == string::npos ) {
massert(10078, "nsToDatabase: ns too long", ns.size() < MaxDatabaseNameLen );
return ns;
}
massert(10088, "nsToDatabase: ns too long", i < static_cast<size_t>(MaxDatabaseNameLen));
return ns.substr( 0, i );
}
// "database.a.b.c" -> "database"
inline void nsToDatabase(const StringData& ns, char *database) {
StringData db = nsToDatabaseSubstring( ns );
db.copyTo( database, true );
}
// TODO: make this return a StringData
inline string nsToDatabase(const StringData& ns) {
return nsToDatabaseSubstring( ns ).toString();
}
// "database.a.b.c" -> "a.b.c"
inline StringData nsToCollectionSubstring( const StringData& ns ) {
size_t i = ns.find( '.' );
massert(16886, "nsToCollectionSubstring: no .", i != string::npos );
return ns.substr( i + 1 );
}
/**
* NamespaceDBHash and NamespaceDBEquals allow you to do something like
* unordered_map<string,int,NamespaceDBHash,NamespaceDBEquals>
* and use the full namespace for the string
* but comparisons are done only on the db piece
*/
/**
* this can change, do not store on disk
*/
int nsDBHash( const string& ns );
bool nsDBEquals( const string& a, const string& b );
struct NamespaceDBHash {
int operator()( const string& ns ) const {
return nsDBHash( ns );
}
};
struct NamespaceDBEquals {
bool operator()( const string& a, const string& b ) const {
return nsDBEquals( a, b );
}
};
}
#include "mongo/db/namespace_string-inl.h"
|
