Implemented CSHARP-428. Added IsDatabaseNameValid to MongoServer and IsCollectionNameValid to MongoDatabase.

Author: Robert Stam

Driver/Core/MongoCollection.cs

@@ -49,7 +49,20 @@ public abstract class MongoCollection
         /// <param name="settings">The settings to use to access this collection.</param>
         protected MongoCollection(MongoDatabase database, MongoCollectionSettings settings)
         {
-            ValidateCollectionName(settings.CollectionName);
+            if (database == null)
+            {
+                throw new ArgumentNullException("database");
+            }
+            if (settings == null)
+            {
+                throw new ArgumentNullException("settings");
+            }
+            string message;
+            if (!database.IsCollectionNameValid(settings.CollectionName, out message))
+            {
+                throw new ArgumentOutOfRangeException("settings", message);
+            }
+
             _server = database.Server;
             _database = database;
             _settings = settings.FrozenCopy();
@@ -1596,20 +1609,6 @@ private string GetIndexName(string[] keyNames)
             }
             return sb.ToString();
         }
-
-        internal static void ValidateCollectionName(string name)
-        {
-            if (name == null)
-            {
-                throw new ArgumentNullException("name");
-            }
-            if (name == "" ||
-                name.IndexOf('\0') != -1 ||
-                Encoding.UTF8.GetBytes(name).Length > 121)
-            {
-                throw new ArgumentException("Invalid collection name", "name");
-            }
-        }
     }
 
     // this subclass provides a default document type for Find methods

Driver/Core/MongoDatabase.cs

@@ -32,9 +32,6 @@ namespace MongoDB.Driver
     /// </summary>
     public class MongoDatabase
     {
-        // private static fields
-        private static HashSet<char> __invalidDatabaseNameChars;
-
         // private fields
         private object _databaseLock = new object();
         private MongoServer _server;
@@ -44,15 +41,6 @@ public class MongoDatabase
         private MongoCollection<BsonDocument> _commandCollection;
         private MongoGridFS _gridFS;
 
-        // static constructor
-        static MongoDatabase()
-        {
-            // MongoDB itself prohibits some characters and the rest are prohibited by the Windows restrictions on filenames
-            __invalidDatabaseNameChars = new HashSet<char>() { '\0', ' ', '.', '$', '/', '\\' };
-            foreach (var c in Path.GetInvalidPathChars()) { __invalidDatabaseNameChars.Add(c); }
-            foreach (var c in Path.GetInvalidFileNameChars()) { __invalidDatabaseNameChars.Add(c); }
-        }
-
         // constructors
         /// <summary>
         /// Creates a new instance of MongoDatabase. Normally you would call one of the indexers or GetDatabase methods
@@ -62,7 +50,20 @@ static MongoDatabase()
         /// <param name="settings">The settings to use to access this database.</param>
         public MongoDatabase(MongoServer server, MongoDatabaseSettings settings)
         {
-            ValidateDatabaseName(settings.DatabaseName);
+            if (server == null)
+            {
+                throw new ArgumentNullException("server");
+            }
+            if (settings == null)
+            {
+                throw new ArgumentNullException("settings");
+            }
+            string message;
+            if (!server.IsDatabaseNameValid(settings.DatabaseName, out message))
+            {
+                throw new ArgumentOutOfRangeException(message);
+            }
+
             _server = server;
             _settings = settings.FrozenCopy();
             _name = settings.DatabaseName;
@@ -735,6 +736,41 @@ public virtual DatabaseStatsResult GetStats()
             return RunCommandAs<DatabaseStatsResult>("dbstats");
         }
 
+        /// <summary>
+        /// Checks whether a given collection name is valid in this database.
+        /// </summary>
+        /// <param name="collectionName">The collection name.</param>
+        /// <param name="message">An error message if the collection name is not valid.</param>
+        /// <returns>True if the collection name is valid; otherwise, false.</returns>
+        public virtual bool IsCollectionNameValid(string collectionName, out string message)
+        {
+            if (collectionName == null)
+            {
+                throw new ArgumentNullException("collectionName");
+            }
+
+            if (collectionName == "")
+            {
+                message = "Collection name cannot be empty.";
+                return false;
+            }
+
+            if (collectionName.IndexOf('\0') != -1)
+            {
+                message = "Collection name cannot contain null characters.";
+                return false;
+            }
+
+            if (Encoding.UTF8.GetBytes(collectionName).Length > 121)
+            {
+                message = "Collection name cannot exceed 121 bytes (after encoding to UTF-8).";
+                return false;
+            }
+
+            message = null;
+            return true;
+        }
+
         // TODO: mongo shell has IsMaster at database level?
 
         /// <summary>
@@ -794,7 +830,20 @@ public virtual CommandResult RenameCollection(
             bool dropTarget,
             MongoCredentials adminCredentials)
         {
-            MongoCollection.ValidateCollectionName(newCollectionName);
+            if (oldCollectionName == null)
+            {
+                throw new ArgumentNullException("oldCollectionName");
+            }
+            if (newCollectionName == null)
+            {
+                throw new ArgumentNullException("newCollectionName");
+            }
+            string message;
+            if (!IsCollectionNameValid(newCollectionName, out message))
+            {
+                throw new ArgumentOutOfRangeException("newCollectionName", message);
+            }
+
             var command = new CommandDocument
             {
                 { "renameCollection", string.Format("{0}.{1}", _name, oldCollectionName) },
@@ -980,33 +1029,5 @@ public override string ToString()
         {
             return _name;
         }
-
-        // private methods
-        private void ValidateDatabaseName(string name)
-        {
-            if (name == null)
-            {
-                throw new ArgumentNullException("name");
-            }
-            if (name == "")
-            {
-                throw new ArgumentException("Database name is empty.");
-            }
-            foreach (var c in name)
-            {
-                if (__invalidDatabaseNameChars.Contains(c))
-                {
-                    var bytes = new byte[] { (byte)((int)c >> 8), (byte)((int)c & 255) };
-                    var hex = BsonUtils.ToHexString(bytes);
-                    var message = string.Format("Database name '{0}' is not valid. The character 0x{1} '{2}' is not allowed in database names.", name, hex, c);
-                    throw new ArgumentException(message);
-                }
-            }
-            if (Encoding.UTF8.GetBytes(name).Length > 64)
-            {
-                var message = string.Format("Database name '{0}' exceeds 64 bytes (after encoding to UTF8).", name);
-                throw new ArgumentException(message);
-            }
-        }
     }
 }

Driver/Core/MongoServer.cs

@@ -37,6 +37,7 @@ public class MongoServer
         private static Dictionary<MongoServerSettings, MongoServer> __servers = new Dictionary<MongoServerSettings, MongoServer>();
         private static int __nextSequentialId;
         private static int __maxServerCount = 100;
+        private static HashSet<char> __invalidDatabaseNameChars;
 
         // private fields
         private object _serverLock = new object();
@@ -56,6 +57,12 @@ public class MongoServer
         // static constructor
         static MongoServer()
         {
+            // MongoDB itself prohibits some characters and the rest are prohibited by the Windows restrictions on filenames
+            // the C# driver checks that the database name is valid on any of the supported platforms
+            __invalidDatabaseNameChars = new HashSet<char>() { '\0', ' ', '.', '$', '/', '\\' };
+            foreach (var c in Path.GetInvalidPathChars()) { __invalidDatabaseNameChars.Add(c); }
+            foreach (var c in Path.GetInvalidFileNameChars()) { __invalidDatabaseNameChars.Add(c); }
+
             BsonSerializer.RegisterSerializer(typeof(MongoDBRef), new MongoDBRefSerializer());
             BsonSerializer.RegisterSerializer(typeof(SystemProfileInfo), new SystemProfileInfoSerializer());
         }
@@ -915,6 +922,46 @@ public virtual GetLastErrorResult GetLastError(MongoCredentials adminCredentials
             return adminDatabase.GetLastError();
         }
 
+        /// <summary>
+        /// Checks whether a given database name is valid on this server.
+        /// </summary>
+        /// <param name="databaseName">The database name.</param>
+        /// <param name="message">An error message if the database name is not valid.</param>
+        /// <returns>True if the database name is valid; otherwise, false.</returns>
+        public virtual bool IsDatabaseNameValid(string databaseName, out string message)
+        {
+            if (databaseName == null)
+            {
+                throw new ArgumentNullException("databaseName");
+            }
+
+            if (databaseName == "")
+            {
+                message = "Database name is empty.";
+                return false;
+            }
+
+            foreach (var c in databaseName)
+            {
+                if (__invalidDatabaseNameChars.Contains(c))
+                {
+                    var bytes = new byte[] { (byte)((int)c >> 8), (byte)((int)c & 255) };
+                    var hex = BsonUtils.ToHexString(bytes);
+                    message = string.Format("Database name '{0}' is not valid. The character 0x{1} '{2}' is not allowed in database names.", databaseName, hex, c);
+                    return false;
+                }
+            }
+
+            if (Encoding.UTF8.GetBytes(databaseName).Length > 64)
+            {
+                message = string.Format("Database name '{0}' exceeds 64 bytes (after encoding to UTF8).", databaseName);
+                return false;
+            }
+
+            message = null;
+            return true;
+        }
+
         /// <summary>
         /// Checks whether the server is alive (throws an exception if not). If server is a replica set, pings all members one at a time.
         /// </summary>

DriverUnitTests/Core/MongoCollectionTests.cs

@@ -50,6 +50,15 @@ public void Setup()
 
         // TODO: more tests for MongoCollection
 
+        [Test]
+        public void TestConstructorArgumentChecking()
+        {
+            var settings = new MongoCollectionSettings<BsonDocument>(_database, "");
+            Assert.Throws<ArgumentNullException>(() => { new MongoCollection<BsonDocument>(null, settings); });
+            Assert.Throws<ArgumentNullException>(() => { new MongoCollection<BsonDocument>(_database, null); });
+            Assert.Throws<ArgumentOutOfRangeException>(() => { new MongoCollection<BsonDocument>(_database, settings); });
+        }
+
         [Test]
         public void TestCountZero()
         {

DriverUnitTests/Core/MongoDatabaseTests.cs

@@ -52,6 +52,15 @@ public void TestCollectionExists()
             Assert.IsTrue(_database.CollectionExists(collectionName));
         }
 
+        [Test]
+        public void TestConstructorArgumentChecking()
+        {
+            var settings = new MongoDatabaseSettings(_server, "");
+            Assert.Throws<ArgumentNullException>(() => { new MongoDatabase(null, settings); });
+            Assert.Throws<ArgumentNullException>(() => { new MongoDatabase(_server, null); });
+            Assert.Throws<ArgumentOutOfRangeException>(() => { new MongoDatabase(_server, settings); });
+        }
+
         [Test]
         public void TestCreateCollection()
         {
@@ -174,6 +183,16 @@ public void TestGetProfilingInfo()
             Assert.IsTrue(info.Duration >= TimeSpan.Zero);
         }
 
+        [Test]
+        public void TestIsCollectionNameValid()
+        {
+            string message;
+            Assert.Throws<ArgumentNullException>(() => { _database.IsCollectionNameValid(null, out message); });
+            Assert.IsFalse(_database.IsCollectionNameValid("", out message));
+            Assert.IsFalse(_database.IsCollectionNameValid("a\0b", out message));
+            Assert.IsFalse(_database.IsCollectionNameValid(new string('x', 128), out message));
+        }
+
         [Test]
         public void TestRenameCollection()
         {
@@ -191,6 +210,14 @@ public void TestRenameCollection()
             Assert.IsTrue(_database.CollectionExists(collectionName2));
         }
 
+        [Test]
+        public void TestRenameCollectionArgumentChecking()
+        {
+            Assert.Throws<ArgumentNullException>(() => { _database.RenameCollection(null, "new"); });
+            Assert.Throws<ArgumentNullException>(() => { _database.RenameCollection("old", null); });
+            Assert.Throws<ArgumentOutOfRangeException>(() => { _database.RenameCollection("old", ""); });
+        }
+
         [Test]
         public void TestRenameCollectionDropTarget()
         {

DriverUnitTests/Core/MongoServerTests.cs

@@ -100,6 +100,16 @@ public void TestGetDatabaseNames()
             var databaseNames = _server.GetDatabaseNames();
         }
 
+        [Test]
+        public void TestIsDatabaseNameValid()
+        {
+            string message;
+            Assert.Throws<ArgumentNullException>(() => { _server.IsDatabaseNameValid(null, out message); });
+            Assert.IsFalse(_server.IsDatabaseNameValid("", out message));
+            Assert.IsFalse(_server.IsDatabaseNameValid("/", out message));
+            Assert.IsFalse(_server.IsDatabaseNameValid(new string('x', 128), out message));
+        }
+
         [Test]
         public void TestReconnect()
         {

DriverUnitTests/Jira/CSharp325Tests.cs

@@ -47,7 +47,7 @@ public void TestValidateDatabaseName()
             foreach (var c in invalidChars)
             {
                 var databaseName = new string(new char[] { 'x', c });
-                Assert.Throws<ArgumentException>(() => { var database = _server[databaseName]; });
+                Assert.Throws<ArgumentOutOfRangeException>(() => { var database = _server[databaseName]; });
             }
         }
     }

DriverUnitTests/Jira/CSharp361Tests.cs

@@ -41,7 +41,7 @@ public void TestInsertUpdateAndSaveWithElementNameStartingWithDollarSign()
             collection.Drop();
 
             collection.Insert(new BsonDocument("_id", 1));
-            Assert.Throws<ArgumentException>(() => { database.RenameCollection("test", ""); });
+            Assert.Throws<ArgumentOutOfRangeException>(() => { database.RenameCollection("test", ""); });
         }
     }
 }