mongo 1.9.2 → 1.10.0.rc0

data/lib/mongo/{util → functional}/write_concern.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2013 10gen Inc.
+# Copyright (C) 2009-2013 MongoDB, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -52,6 +52,7 @@ module Mongo
       }
       write_concern.merge!(parent.write_concern) if parent
       write_concern.merge!(opts.reject {|k,v| !write_concern.keys.include?(k)})
+      write_concern[:w] = write_concern[:w].to_s if write_concern[:w].is_a?(Symbol)
       write_concern
     end
 

data/{test/unit/pool_test.rb → lib/mongo/gridfs.rb}

@@ -1,4 +1,4 @@
-# Copyright (C) 2013 10gen Inc.
+# Copyright (C) 2009-2013 MongoDB, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -12,12 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require 'test_helper'
-include Mongo
-
-class PoolTest < Test::Unit::TestCase
-  context "Initialization: " do
-    should "do" do
-    end
-  end
-end
+require 'mongo/gridfs/grid_ext'
+require 'mongo/gridfs/grid'
+require 'mongo/gridfs/grid_file_system'
+require 'mongo/gridfs/grid_io'

data/lib/mongo/gridfs/grid.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2013 10gen Inc.
+# Copyright (C) 2009-2013 MongoDB, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -23,8 +23,6 @@ module Mongo
     # Initialize a new Grid instance, consisting of a MongoDB database
     # and a filesystem prefix if not using the default.
     #
-    # @core gridfs
-    #
     # @see GridFileSystem
     def initialize(db, fs_name=DEFAULT_FS_NAME)
       raise MongoArgumentError, "db must be a Mongo::DB." unless db.is_a?(Mongo::DB)

data/lib/mongo/gridfs/grid_ext.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2013 10gen Inc.
+# Copyright (C) 2009-2013 MongoDB, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/mongo/gridfs/grid_file_system.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2013 10gen Inc.
+# Copyright (C) 2009-2013 MongoDB, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/mongo/gridfs/grid_io.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2013 10gen Inc.
+# Copyright (C) 2009-2013 MongoDB, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/mongo/legacy.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2013 10gen Inc.
+# Copyright (C) 2009-2013 MongoDB, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -38,8 +38,8 @@ module Mongo
 end
 
 module Mongo
-  # @deprecated Use Mongo::MongoClient instead. Support will be removed after v2.0
-  # Please see old documentation for the Connection class
+  # @deprecated Use Mongo::MongoClient instead. Support will be removed after
+  #   v2.0. Please see old documentation for the Connection class.
   class Connection < MongoClient
     include Mongo::LegacyWriteConcern
 
@@ -53,8 +53,9 @@ module Mongo
     end
   end
 
-  # @deprecated Use Mongo::MongoReplicaSetClient instead. Support will be removed after v2.0
-  # Please see old documentation for the ReplSetConnection class
+  # @deprecated Use Mongo::MongoReplicaSetClient instead. Support will be
+  #   removed after v2.0. Please see old documentation for the
+  #   ReplSetConnection class.
   class ReplSetConnection < MongoReplicaSetClient
     include Mongo::LegacyWriteConcern
 
@@ -68,8 +69,8 @@ module Mongo
     end
   end
 
-  # @deprecated Use Mongo::MongoShardedClient instead. Support will be removed after v2.0
-  # Please see old documentation for the ShardedConnection class
+  # @deprecated Use Mongo::MongoShardedClient instead. Support will be removed
+  #   after v2.0. Please see old documentation for the ShardedConnection class.
   class ShardedConnection < MongoShardedClient
     include Mongo::LegacyWriteConcern
 
@@ -82,4 +83,58 @@ module Mongo
       super
     end
   end
-end
+
+  class MongoClient
+    # @deprecated This method is no longer in use and never needs to be called
+    #   directly. Support will be removed after v2.0
+    def authenticate_pools
+      @primary_pool.authenticate_existing
+    end
+
+    # @deprecated This method is no longer in use and never needs to be called
+    #   directly. Support will be removed after v2.0
+    def logout_pools(database)
+      @primary_pool.logout_existing(database)
+    end
+
+    # @deprecated This method is no longer in use and never needs to be called
+    #   directly. Support will be removed after v2.0
+    def apply_saved_authentication
+      true
+    end
+  end
+
+  class MongoReplicaSetClient
+    # @deprecated This method is no longer in use and never needs to be called
+    #   directly. Support will be removed after v2.0
+    def authenticate_pools
+      @manager.pools.each { |pool| pool.authenticate_existing }
+    end
+
+    # @deprecated This method is no longer in use and never needs to be called
+    #   directly. Support will be removed after v2.0
+    def logout_pools(database)
+      @manager.pools.each { |pool| pool.logout_existing(database) }
+    end
+  end
+
+  class DB
+    # @deprecated Please use MongoClient#issue_authentication instead. Support
+    #   will be removed after v2.0
+    def issue_authentication(username, password, save_auth=true, opts={})
+      auth = Authentication.validate_credentials({
+        :db_name  => self.name,
+        :username => username,
+        :password => password
+      })
+      opts[:save_auth] = save_auth
+      @client.issue_authentication(auth, opts)
+    end
+
+    # @deprecated Please use MongoClient#issue_logout instead. Support will be
+    #   removed after v2.0
+    def issue_logout(opts={})
+      @client.issue_logout(self.name, opts)
+    end
+  end
+end

data/lib/mongo/mongo_client.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2013 10gen Inc.
+# Copyright (C) 2009-2013 MongoDB, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -12,10 +12,6 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require 'set'
-require 'socket'
-require 'thread'
-
 module Mongo
 
   # Instantiates and manages self.connections to MongoDB.
@@ -23,6 +19,19 @@ module Mongo
     include Mongo::Logging
     include Mongo::Networking
     include Mongo::WriteConcern
+    include Mongo::Authentication
+
+    # Wire version
+    RELEASE_2_4_AND_BEFORE = 0 # Everything before we started tracking.
+    AGG_RETURNS_CURSORS    = 1 # The aggregation command may now be requested to return cursors.
+    BATCH_COMMANDS         = 2 # insert, update, and delete batch command
+    MAX_WIRE_VERSION       = BATCH_COMMANDS # supported by this client implementation
+    MIN_WIRE_VERSION       = RELEASE_2_4_AND_BEFORE # supported by this client implementation
+
+    # Server command headroom
+    COMMAND_HEADROOM   = 16_384
+    APPEND_HEADROOM    = COMMAND_HEADROOM / 2
+    SERIALIZE_HEADROOM = APPEND_HEADROOM / 2
 
     Mutex              = ::Mutex
     ConditionVariable  = ::ConditionVariable
@@ -30,7 +39,7 @@ module Mongo
     DEFAULT_HOST         = 'localhost'
     DEFAULT_PORT         = 27017
     DEFAULT_DB_NAME      = 'test'
-    GENERIC_OPTS         = [:auths, :logger, :connect, :default_db]
+    GENERIC_OPTS         = [:auths, :logger, :connect, :db_name]
     TIMEOUT_OPTS         = [:timeout, :op_timeout, :connect_timeout]
     SSL_OPTS             = [:ssl, :ssl_key, :ssl_cert, :ssl_verify, :ssl_ca_cert]
     POOL_OPTS            = [:pool_size, :pool_timeout]
@@ -55,7 +64,9 @@ module Mongo
                 :op_timeout,
                 :tag_sets,
                 :acceptable_latency,
-                :read
+                :read,
+                :max_wire_version,
+                :min_wire_version
 
     # Create a connection to single MongoDB instance.
     #
@@ -130,10 +141,8 @@ module Mongo
     #   driver fails to connect to a replica set with that name.
     #
     # @raise [MongoArgumentError] If called with no arguments and <code>ENV["MONGODB_URI"]</code> implies a replica set.
-    #
-    # @core self.connections
     def initialize(*args)
-      opts = args.last.is_a?(Hash) ? args.pop : {}
+      opts         = args.last.is_a?(Hash) ? args.pop : {}
       @host, @port = parse_init(args[0], args[1], opts)
 
       # Lock for request ids.
@@ -145,11 +154,13 @@ module Mongo
       @mongos       = false
 
       # Not set for direct connection
-      @tag_sets = []
+      @tag_sets           = []
       @acceptable_latency = 15
 
+      @max_bson_size    = nil
       @max_message_size = nil
-      @max_bson_size = nil
+      @max_wire_version = nil
+      @min_wire_version = nil
 
       check_opts(opts)
       setup(opts.dup)
@@ -182,8 +193,7 @@ module Mongo
     #
     # @deprecated
     def self.multi(nodes, opts={})
-      warn "MongoClient.multi is now deprecated and will be removed in v2.0. Please use MongoReplicaSetClient.new instead."
-
+      warn 'MongoClient.multi is now deprecated and will be removed in v2.0. Please use MongoReplicaSetClient.new instead.'
       MongoReplicaSetClient.new(nodes, opts)
     end
 
@@ -203,20 +213,6 @@ module Mongo
       parser.connection(extra_opts)
     end
 
-    def parse_init(host, port, opts)
-      if host.nil? && port.nil? && ENV.has_key?('MONGODB_URI')
-        parser = URIParser.new(ENV['MONGODB_URI'])
-        if parser.replicaset?
-          raise MongoArgumentError,
-            "ENV['MONGODB_URI'] implies a replica set."
-        end
-        opts.merge!(parser.connection_options)
-        [parser.host, parser.port]
-      else
-        [host || DEFAULT_HOST, port || DEFAULT_PORT]
-      end
-    end
-
     # The host name used for this connection.
     #
     # @return [String]
@@ -260,76 +256,6 @@ module Mongo
       self['admin']['$cmd.sys.unlock'].find_one
     end
 
-    # Apply each of the saved database authentications.
-    #
-    # @return [Boolean] returns true if authentications exist and succeeds, false
-    #   if none exists.
-    #
-    # @raise [AuthenticationError] raises an exception if any one
-    #   authentication fails.
-    def apply_saved_authentication(opts={})
-      return false if @auths.empty?
-      @auths.each do |auth|
-        self[auth[:db_name]].issue_authentication(auth[:username], auth[:password], false,
-          :source => auth[:source], :socket => opts[:socket])
-      end
-      true
-    end
-
-    # Save an authentication to this connection. When connecting,
-    # the connection will attempt to re-authenticate on every db
-    # specified in the list of auths. This method is called automatically
-    # by DB#authenticate.
-    #
-    # Note: this method will not actually issue an authentication command. To do that,
-    # either run MongoClient#apply_saved_authentication or DB#authenticate.
-    #
-    # @param [String] db_name
-    # @param [String] username
-    # @param [String] password
-    #
-    # @return [Hash] a hash representing the authentication just added.
-    def add_auth(db_name, username, password, source)
-      if @auths.any? {|a| a[:db_name] == db_name}
-        raise MongoArgumentError, "Cannot apply multiple authentications to database '#{db_name}'"
-      end
-
-      auth = {
-        :db_name  => db_name,
-        :username => username,
-        :password => password,
-        :source => source
-      }
-      @auths << auth
-      auth
-    end
-
-    # Remove a saved authentication for this connection.
-    #
-    # @param [String] db_name
-    #
-    # @return [Boolean]
-    def remove_auth(db_name)
-      return unless @auths
-      @auths.reject! { |a| a[:db_name] == db_name } ? true : false
-    end
-
-    # Remove all authentication information stored in this connection.
-    #
-    # @return [true] this operation return true because it always succeeds.
-    def clear_auths
-      @auths = []
-      true
-    end
-
-    def authenticate_pools
-      @primary_pool.authenticate_existing
-    end
-
-    def logout_pools(db)
-      @primary_pool.logout_existing(db)
-    end
-
     # Return a hash with all database names
     # and their respective sizes on disk.
     #
@@ -352,55 +278,50 @@ module Mongo
     # Return a database with the given name.
     # See DB#new for valid options hash parameters.
     #
-    # @param [String] db_name a valid database name.
-    # @param [Hash] opts options to be passed to the DB constructor.
+    # @param name [String] The name of the database.
+    # @param opts [Hash] A hash of options to be passed to the DB constructor.
     #
-    # @return [Mongo::DB]
-    #
-    # @core databases db-instance_method
-    def db(db_name = @default_db, opts = {})
-      DB.new(db_name, self, opts)
+    # @return [DB] The DB instance.
+    def db(name = nil, opts = {})
+      DB.new(name || @db_name || DEFAULT_DB_NAME, self, opts)
     end
 
-    # Shortcut for returning a database. Use DB#db to accept options.
-    #
-    # @param [String] db_name a valid database name.
+    # Shortcut for returning a database. Use MongoClient#db to accept options.
     #
-    # @return [Mongo::DB]
+    # @param name [String] The name of the database.
     #
-    # @core databases []-instance_method
-    def [](db_name)
-      DB.new(db_name, self)
+    # @return [DB] The DB instance.
+    def [](name)
+      DB.new(name, self)
     end
 
-    def refresh
-    end
+    def refresh; end
 
     def pinned_pool
       @primary_pool
     end
 
-    def pin_pool(pool, read_prefs)
-    end
+    def pin_pool(pool, read_prefs); end
 
-    def unpin_pool
-    end
+    def unpin_pool; end
 
     # Drop a database.
     #
-    # @param [String] name name of an existing database.
-    def drop_database(name)
-      self[name].command(:dropDatabase => 1)
+    # @param database [String] name of an existing database.
+    def drop_database(database)
+      self[database].command(:dropDatabase => 1)
     end
 
     # Copy the database +from+ to +to+ on localhost. The +from+ database is
     # assumed to be on localhost, but an alternate host can be specified.
     #
-    # @param [String] from name of the database to copy from.
-    # @param [String] to name of the database to copy to.
-    # @param [String] from_host host of the 'from' database.
-    # @param [String] username username for authentication against from_db (>=1.3.x).
-    # @param [String] password password for authentication against from_db (>=1.3.x).
+    # @param from [String] name of the database to copy from.
+    # @param to [String] name of the database to copy to.
+    # @param from_host [String] host of the 'from' database.
+    # @param username [String] username (applies to 'from' db)
+    # @param password [String] password (applies to 'from' db)
+    #
+    # @note This command only supports the MONGODB-CR authentication mechanism.
     def copy_database(from, to, from_host=DEFAULT_HOST, username=nil, password=nil)
       oh = BSON::OrderedHash.new
       oh[:copydb]   = 1
@@ -409,17 +330,18 @@ module Mongo
       oh[:todb]     = to
       if username || password
         unless username && password
-          raise MongoArgumentError, "Both username and password must be supplied for authentication."
+          raise MongoArgumentError,
+            'Both username and password must be supplied for authentication.'
         end
         nonce_cmd = BSON::OrderedHash.new
         nonce_cmd[:copydbgetnonce] = 1
         nonce_cmd[:fromhost] = from_host
-        result = self["admin"].command(nonce_cmd)
-        oh[:nonce] = result["nonce"]
+        result = self['admin'].command(nonce_cmd)
+        oh[:nonce] = result['nonce']
         oh[:username] = username
-        oh[:key] = Mongo::Support.auth_key(username, password, oh[:nonce])
+        oh[:key] = Mongo::Authentication.auth_key(username, password, oh[:nonce])
       end
-      self["admin"].command(oh)
+      self['admin'].command(oh)
     end
 
     # Checks if a server is alive. This command will return immediately
@@ -427,14 +349,14 @@ module Mongo
     #
     # @return [Hash]
     def ping
-      self["admin"].command({:ping => 1})
+      self['admin'].command({:ping => 1})
     end
 
     # Get the build information for the current connection.
     #
     # @return [Hash]
     def server_info
-      self["admin"].command({:buildinfo => 1})
+      self['admin'].command({:buildinfo => 1})
     end
 
     # Get the build version of the current server.
@@ -442,7 +364,7 @@ module Mongo
     # @return [Mongo::ServerVersion]
     #   object allowing easy comparability of version.
     def server_version
-      ServerVersion.new(server_info["version"])
+      ServerVersion.new(server_info['version'])
     end
 
     # Is it okay to connect to a slave?
@@ -477,14 +399,19 @@ module Mongo
           @mongos = true
         end
 
-        @max_bson_size = config['maxBsonObjectSize']
+        @max_bson_size    = config['maxBsonObjectSize']
         @max_message_size = config['maxMessageSizeBytes']
+        @max_wire_version = config['maxWireVersion']
+        @min_wire_version = config['minWireVersion']
+        check_wire_version_in_range
         set_primary(host_port)
       end
 
-      if !connected?
-        raise ConnectionFailure, "Failed to connect to a master node at #{host_port.join(":")}"
+      unless connected?
+        raise ConnectionFailure,
+          "Failed to connect to a master node at #{host_port.join(":")}"
       end
+
       true
     end
     alias :reconnect :connect
@@ -532,7 +459,7 @@ module Mongo
     def close
       @primary_pool.close if @primary_pool
       @primary_pool = nil
-      @primary = nil
+      @primary      = nil
     end
 
     # Returns the maximum BSON object size as returned by the core server.
@@ -547,6 +474,26 @@ module Mongo
       @max_message_size || max_bson_size * MESSAGE_SIZE_FACTOR
     end
 
+    def max_wire_version
+      @max_wire_version || 0
+    end
+
+    def min_wire_version
+      @min_wire_version || 0
+    end
+
+    def wire_version_feature?(feature)
+      min_wire_version <= feature && feature <= max_wire_version
+    end
+
+    def primary_wire_version_feature?(feature)
+      min_wire_version <= feature && feature <= max_wire_version
+    end
+
+    def use_write_command?(write_concern)
+      write_concern[:w] != 0 && primary_wire_version_feature?(Mongo::MongoClient::BATCH_COMMANDS)
+    end
+
     # Checkout a socket for reading (i.e., a secondary node).
     # Note: this is overridden in MongoReplicaSetClient.
     def checkout_reader(read_preference)
@@ -582,10 +529,10 @@ module Mongo
         socket = @socket_class.new(host, port, @op_timeout, @connect_timeout, @socket_opts)
         if @connect_timeout
           Timeout::timeout(@connect_timeout, OperationTimeout) do
-            config = self['admin'].command({:ismaster => 1}, :socket => socket)
+            config = self['admin'].command({:isMaster => 1}, :socket => socket)
           end
         else
-          config = self['admin'].command({:ismaster => 1}, :socket => socket)
+          config = self['admin'].command({:isMaster => 1}, :socket => socket)
         end
       rescue OperationFailure, SocketError, SystemCallError, IOError
         close
@@ -640,8 +587,8 @@ module Mongo
         # verify peer requires ca_cert, raise if only one is present
         if @socket_opts[:verify] && !@socket_opts[:ca_cert]
           raise MongoArgumentError,
-            "If :ssl_verify_mode has been specified, then you must include " +
-            ":ssl_ca_cert in order to perform server validation."
+            'If :ssl_verify_mode has been specified, then you must include ' +
+            ':ssl_ca_cert in order to perform server validation.'
         end
 
         @socket_class = Mongo::SSLSocket
@@ -651,26 +598,25 @@ module Mongo
         @socket_class = Mongo::TCPSocket
       end
 
-      # Authentication objects
-      @auths = opts.delete(:auths) || []
+      @db_name = opts.delete(:db_name)
+      @auths   = opts.delete(:auths) || Set.new
 
       # Pool size and timeout.
       @pool_size = opts.delete(:pool_size) || 1
       if opts[:timeout]
-        warn "The :timeout option has been deprecated " +
-             "and will be removed in the 2.0 release. " +
-             "Use :pool_timeout instead."
+        warn 'The :timeout option has been deprecated ' +
+             'and will be removed in the 2.0 release. ' +
+             'Use :pool_timeout instead.'
       end
       @pool_timeout = opts.delete(:pool_timeout) || opts.delete(:timeout) || 5.0
 
       # Timeout on socket read operation.
-      @op_timeout = opts.delete(:op_timeout) || nil
+      @op_timeout = opts.delete(:op_timeout)
 
       # Timeout on socket connect.
       @connect_timeout = opts.delete(:connect_timeout) || 30
 
-      @logger = opts.delete(:logger) || nil
-
+      @logger = opts.delete(:logger)
       if @logger
         write_logging_startup_message
       end
@@ -683,7 +629,6 @@ module Mongo
       end
       Mongo::ReadPreference::validate(@read)
 
-      @default_db = opts.delete(:default_db) || DEFAULT_DB_NAME
       @tag_sets = opts.delete(:tag_sets) || []
       @acceptable_latency = opts.delete(:secondary_acceptable_latency_ms) || 15
 
@@ -695,11 +640,40 @@ module Mongo
 
     private
 
-    # Set the specified node as primary.
+    # Parses client initialization info from MONGODB_URI env variable
+    def parse_init(host, port, opts)
+      if host.nil? && port.nil? && ENV.has_key?('MONGODB_URI')
+        parser = URIParser.new(ENV['MONGODB_URI'])
+        if parser.replicaset?
+          raise MongoArgumentError,
+            'ENV[\'MONGODB_URI\'] implies a replica set.'
+        end
+        opts.merge!(parser.connection_options)
+        [parser.host, parser.port]
+      else
+        host = host[1...-1] if host && host[0,1] == '[' # ipv6 support
+        [host || DEFAULT_HOST, port || DEFAULT_PORT]
+      end
+    end
+
+    # Set the specified node as primary
     def set_primary(node)
-      host, port = *node
-      @primary = [host, port]
+      host, port    = *node
+      @primary      = [host, port]
       @primary_pool = Pool.new(self, host, port, :size => @pool_size, :timeout => @pool_timeout)
     end
+
+    # calculate wire version in range
+    def check_wire_version_in_range
+      unless MIN_WIRE_VERSION <= max_wire_version &&
+             MAX_WIRE_VERSION >= min_wire_version
+        close
+        raise ConnectionFailure,
+            "Client wire-version range #{MIN_WIRE_VERSION} to " +
+            "#{MAX_WIRE_VERSION} does not support server range " +
+            "#{min_wire_version} to #{max_wire_version}, please update " +
+            "clients or servers"
+      end
+    end
   end
 end