mongo 1.8.6 → 1.12.5

data/lib/mongo/mongo_replica_set_client.rb

@@ -1,3 +1,17 @@
+# 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.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
 module Mongo
 
   # Instantiates and manages connections to a MongoDB replica set.
@@ -33,10 +47,16 @@ module Mongo
     #   @param [Array<String>, Array<Array(String, Integer)>] seeds
     #
     #   @option opts [String, Integer, Symbol] :w (1) Set default number of nodes to which a write
-    #     should be acknowledged
-    #   @option opts [Boolean] :j (false) Set journal acknowledgement
-    #   @option opts [Integer] :wtimeout (nil) Set acknowledgement timeout
-    #   @option opts [Boolean] :fsync (false) Set fsync acknowledgement.
+    #     should be acknowledged.
+    #   @option opts [Integer] :wtimeout (nil) Set replica set acknowledgement timeout.
+    #   @option opts [Boolean] :j (false) If true, block until write operations have been committed
+    #     to the journal. Cannot be used in combination with 'fsync'. Prior to MongoDB 2.6 this option was
+    #     ignored if the server was running without journaling. Starting with MongoDB 2.6, write operations will
+    #     fail with an exception if this option is used when the server is running without journaling.
+    #   @option opts [Boolean] :fsync (false) If true, and the server is running without journaling, blocks until
+    #     the server has synced all data files to disk. If the server is running with journaling, this acts the same as
+    #     the 'j' option, blocking until write operations have been committed to the journal.
+    #     Cannot be used in combination with 'j'.
     #
     #     Notes about write concern options:
     #       Write concern options are propagated to objects instantiated from this MongoReplicaSetClient.
@@ -65,10 +85,19 @@ module Mongo
     #   @option opts [Float] :pool_timeout (5.0) When all of the connections a pool are checked out,
     #     this is the number of seconds to wait for a new connection to be released before throwing an exception.
     #     Note: this setting is relevant only for multi-threaded applications.
-    #   @option opts [Float] :op_timeout (nil) The number of seconds to wait for a read operation to time out.
+    #   @option opts [Float] :op_timeout (DEFAULT_OP_TIMEOUT) The number of seconds to wait for a read operation to time out.
+    #    Set to DEFAULT_OP_TIMEOUT (20) by default. A value of nil may be specified explicitly.
     #   @option opts [Float] :connect_timeout (30) The number of seconds to wait before timing out a
     #     connection attempt.
     #   @option opts [Boolean] :ssl (false) If true, create the connection to the server using SSL.
+    #   @option opts [String] :ssl_cert (nil) The certificate file used to identify the local connection against MongoDB.
+    #   @option opts [String] :ssl_key (nil) The private keyfile used to identify the local connection against MongoDB.
+    #     Note that even if the key is stored in the same file as the certificate, both need to be explicitly specified.
+    #   @option opts [String] :ssl_key_pass_phrase (nil) A passphrase for the private key.
+    #   @option opts [Boolean] :ssl_verify (nil) Specifies whether or not peer certification validation should occur.
+    #   @option opts [String] :ssl_ca_cert (nil) The ca_certs file contains a set of concatenated "certification authority"
+    #     certificates, which are used to validate certificates passed from the other end of the connection.
+    #     Required for :ssl_verify.
     #   @option opts [Boolean] :refresh_mode (false) Set this to :sync to periodically update the
     #     state of the connection every :refresh_interval seconds. Replica set connection failures
     #     will always trigger a complete refresh. This option is useful when you want to add new nodes
@@ -188,12 +217,22 @@ module Mongo
         if @manager.pools.empty?
           close
           raise ConnectionFailure, "Failed to connect to any node."
-        else
-          @connected = true
         end
+        check_wire_version_in_range
+        @connected = true
       end
     end
 
+    # Reconnect the replica set client.
+    #
+    # @return [Boolean] +true+ unless the refresh lock can't be acquired.
+    #
+    # @since 1.12.4
+    def reconnect
+      close
+      refresh
+    end
+
     # Determine whether a replica set refresh is
     # required. If so, run a hard refresh. You can
     # force a hard refresh by running
@@ -304,14 +343,6 @@ module Mongo
       @read != :primary
     end
 
-    def authenticate_pools
-      @manager.pools.each { |pool| pool.authenticate_existing }
-    end
-
-    def logout_pools(db)
-      @manager.pools.each { |pool| pool.logout_existing(db) }
-    end
-
     # Generic socket checkout
     # Takes a block that returns a socket from pool
     def checkout
@@ -436,6 +467,25 @@ module Mongo
       max_bson_size * MESSAGE_SIZE_FACTOR
     end
 
+    def max_wire_version
+      return local_manager.max_wire_version if local_manager
+      0
+    end
+
+    def min_wire_version
+      return local_manager.min_wire_version if local_manager
+      0
+    end
+
+    def primary_wire_version_feature?(feature)
+      local_manager && local_manager.primary_pool && local_manager.primary_pool.node.wire_version_feature?(feature)
+    end
+
+    def max_write_batch_size
+      local_manager && local_manager.primary_pool && local_manager.primary_pool.node.max_write_batch_size ||
+        DEFAULT_MAX_WRITE_BATCH_SIZE
+    end
+
     private
 
     # Parse option hash

data/lib/mongo/mongo_sharded_client.rb

@@ -1,3 +1,17 @@
+# 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.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
 module Mongo
 
   # Instantiates and manages connections to a MongoDB sharded cluster for high availability.
@@ -52,7 +66,7 @@ module Mongo
     end
 
     def valid_opts
-      GENERIC_OPTS + SHARDED_CLUSTER_OPTS + READ_PREFERENCE_OPTS + WRITE_CONCERN_OPTS
+      super + SHARDED_CLUSTER_OPTS
     end
 
     def inspect
@@ -80,6 +94,7 @@ module Mongo
             @manager = ShardingPoolManager.new(self, @seeds)
             ensure_manager
             @manager.connect
+            check_wire_version_in_range
           end
         ensure
           thread_local[:locks][:connecting] = false
@@ -133,10 +148,10 @@ module Mongo
     # @param uri [ String ]  string of the format:
     #   mongodb://[username:password@]host1[:port1][,host2[:port2],...[,hostN[:portN]]][/database]
     #
-    # @param opts [ Hash ] Any of the options available for MongoShardedClient.new
+    # @param options [ Hash ] Any of the options available for MongoShardedClient.new
     #
     # @return [ Mongo::MongoShardedClient ] The sharded client.
-    def self.from_uri(uri, options = {})
+    def self.from_uri(uri, options={})
       uri ||= ENV['MONGODB_URI']
       URIParser.new(uri).connection(options, false, true)
     end

data/lib/mongo/networking.rb

@@ -1,3 +1,17 @@
+# 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.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
 module Mongo
   module Networking
 
@@ -44,6 +58,7 @@ module Mongo
           sock.checkin
         end
       end
+      true
     end
 
     # Sends a message to the database, waits for a response, and raises
@@ -52,8 +67,8 @@ module Mongo
     # @param [Integer] operation a MongoDB opcode.
     # @param [BSON::ByteBuffer] message a message to send to the database.
     # @param [String] db_name the name of the database. used on call to get_last_error.
-    # @param [Hash] last_error_params parameters to be sent to getLastError. See DB#error for
-    #   available options.
+    # @param [String] log_message this is currently a no-op and will be removed.
+    # @param [Hash] write_concern write concern.
     #
     # @see DB#get_last_error for valid last error params.
     #
@@ -71,22 +86,30 @@ module Mongo
         sock = checkout_writer
         send_message_on_socket(packed_message, sock)
         docs, num_received, cursor_id = receive(sock, last_error_id)
-        checkin(sock)
       rescue ConnectionFailure, OperationFailure, OperationTimeout => ex
-        checkin(sock)
         raise ex
       rescue SystemStackError, NoMemoryError, SystemCallError => ex
         close
+        sock = nil
         raise ex
+      ensure
+        checkin(sock) if sock
+        sock = nil
       end
 
-      if num_received == 1 && (error = docs[0]['err'] || docs[0]['errmsg'])
-        if error.include?("not master")
+      if num_received == 1
+        error = docs[0]['err'] || docs[0]['errmsg']
+        if error && error.include?("not master")
           close
           raise ConnectionFailure.new(docs[0]['code'].to_s + ': ' + error, docs[0]['code'], docs[0])
-        else
+        elsif (!error.nil? && note = docs[0]['jnote'] || docs[0]['wnote']) # assignment
+          code = docs[0]['code'] || Mongo::ErrorCode::BAD_VALUE # as of server version 2.5.5
+          raise WriteConcernError.new(code.to_s + ': ' + note, code, docs[0])
+        elsif error
+          code = docs[0]['code'] || Mongo::ErrorCode::UNKNOWN_ERROR
           error = "wtimeout" if error == "timeout"
-          raise OperationFailure.new(docs[0]['code'].to_s + ': ' + error, docs[0]['code'], docs[0])
+          raise WriteConcernError.new(code.to_s + ': ' + error, code, docs[0]) if error == "wtimeout"
+          raise OperationFailure.new(code.to_s + ': ' + error, code, docs[0])
         end
       end
 
@@ -101,22 +124,26 @@ module Mongo
     # @param [Socket] socket a socket to use in lieu of checking out a new one.
     # @param [Boolean] command (false) indicate whether this is a command. If this is a command,
     #   the message will be sent to the primary node.
-    # @param [Boolean] command (false) indicate whether the cursor should be exhausted. Set
+    # @param [Symbol] read the read preference.
+    # @param [Boolean] exhaust (false) indicate whether the cursor should be exhausted. Set
     #   this to true only when the OP_QUERY_EXHAUST flag is set.
+    # @param [Boolean] compile_regex whether BSON regex objects should be compiled into Ruby regexes.
     #
     # @return [Array]
     #   An array whose indexes include [0] documents returned, [1] number of document received,
     #   and [3] a cursor_id.
     def receive_message(operation, message, log_message=nil, socket=nil, command=false,
-                        read=:primary, exhaust=false)
-      request_id = add_message_headers(message, operation)
+                        read=:primary, exhaust=false, compile_regex=true)
+      request_id     = add_message_headers(message, operation)
       packed_message = message.to_s
+      opts = { :exhaust => exhaust,
+               :compile_regex => compile_regex }
 
       result = ''
 
       begin
         send_message_on_socket(packed_message, socket)
-        result = receive(socket, request_id, exhaust)
+        result = receive(socket, request_id, opts)
       rescue ConnectionFailure => ex
         socket.close
         checkin(socket)
@@ -135,7 +162,9 @@ module Mongo
 
     private
 
-    def receive(sock, cursor_id, exhaust=false)
+    def receive(sock, cursor_id, opts={})
+      exhaust    = !!opts.delete(:exhaust)
+
       if exhaust
         docs = []
         num_received = 0
@@ -143,7 +172,7 @@ module Mongo
         while(cursor_id != 0) do
           receive_header(sock, cursor_id, exhaust)
           number_received, cursor_id = receive_response_header(sock)
-          new_docs, n = read_documents(number_received, sock)
+          new_docs, n = read_documents(number_received, sock, opts)
           docs += new_docs
           num_received += n
         end
@@ -152,7 +181,7 @@ module Mongo
       else
         receive_header(sock, cursor_id, exhaust)
         number_received, cursor_id = receive_response_header(sock)
-        docs, num_received = read_documents(number_received, sock)
+        docs, num_received = read_documents(number_received, sock, opts)
 
         return [docs, num_received, cursor_id]
       end
@@ -194,11 +223,11 @@ module Mongo
         raise Mongo::OperationFailure, "Query response returned CURSOR_NOT_FOUND. " +
           "Either an invalid cursor was specified, or the cursor may have timed out on the server."
       elsif flags & Mongo::Constants::REPLY_QUERY_FAILURE != 0
-        # Getting odd failures when a exception is raised here.
+        # Mongo query reply failures are handled in Cursor#next.
       end
     end
 
-    def read_documents(number_received, sock)
+    def read_documents(number_received, sock, opts)
       docs = []
       number_remaining = number_received
       while number_remaining > 0 do
@@ -206,7 +235,7 @@ module Mongo
         size = buf.unpack('V')[0]
         buf << receive_message_on_socket(size - 4, sock)
         number_remaining -= 1
-        docs << BSON::BSON_CODER.deserialize(buf)
+        docs << BSON::BSON_CODER.deserialize(buf, opts)
       end
       [docs, number_received]
     end

data/lib/mongo/{util → utils}/conversions.rb

@@ -1,3 +1,17 @@
+# 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.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
 module Mongo #:nodoc:
 
   # Utility module to include when needing to convert certain types of
@@ -23,7 +37,7 @@ module Mongo #:nodoc:
         )
       else
         order_by = value.inject({}) do |memo, (key, direction)|
-          memo[key.to_s] = sort_value(direction.to_s.downcase)
+          memo[key.to_s] = sort_value(direction)
           memo
         end
       end
@@ -31,7 +45,7 @@ module Mongo #:nodoc:
     end
 
     # Converts the supplied +Array+ to a +Hash+ to pass to mongo as
-    # sorting parameters. The returned +Hash+ will vary depending 
+    # sorting parameters. The returned +Hash+ will vary depending
     # on whether the passed +Array+ is one or two dimensional.
     #
     # Example:
@@ -73,7 +87,7 @@ module Mongo #:nodoc:
       { str => 1 }
     end
 
-    # Converts the +String+, +Symbol+, or +Integer+ to the 
+    # Converts the +String+, +Symbol+, or +Integer+ to the
     # corresponding sort value in MongoDB.
     #
     # Valid conversions (case-insensitive):
@@ -83,6 +97,7 @@ module Mongo #:nodoc:
     #
     # If the value is invalid then an error will be raised.
     def sort_value(value)
+      return value if value.is_a?(Hash)
       val = value.to_s.downcase
       return 1 if ASCENDING_CONVERSION.include?(val)
       return -1 if DESCENDING_CONVERSION.include?(val)

data/lib/mongo/{util → utils}/core_ext.rb

@@ -1,3 +1,17 @@
+# 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.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
 #:nodoc:
 class Object
 
@@ -9,17 +23,6 @@ class Object
 
 end
 
-#:nodoc:
-module Enumerable
-
-  #:nodoc:
-  def each_with_object(memo)
-    each { |element| yield(element, memo) }
-    memo
-  end unless [].respond_to?(:each_with_object)
-
-end
-
 #:nodoc:
 class Hash
 
@@ -27,7 +30,7 @@ class Hash
   def assert_valid_keys(*valid_keys)
     unknown_keys = keys - [valid_keys].flatten
     raise(ArgumentError, "Unknown key(s): #{unknown_keys.join(", ")}") unless unknown_keys.empty?
-  end
+  end unless instance_methods.include?(:assert_valid_keys)
 
 end
 
@@ -65,23 +68,3 @@ class Class
     end
   end
 end
-
-# Fix a bug in the interaction of
-# mutexes and timeouts in Ruby 1.9.
-# See https://jira.mongodb.org/browse/RUBY-364 for details.
-if RUBY_VERSION > '1.9'
-  class Mutex
-    def lock_with_hack
-      lock_without_hack
-      rescue ThreadError => e
-      if e.message != "deadlock; recursive locking"
-        raise
-      else
-        unlock
-        lock_without_hack
-      end
-    end
-      alias_method :lock_without_hack, :lock
-      alias_method :lock, :lock_with_hack
-  end
-end

data/lib/mongo/{util → utils}/server_version.rb

@@ -1,4 +1,19 @@
+# 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.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
 module Mongo
+
   # Simple class for comparing server versions.
   class ServerVersion
     include Comparable

data/lib/mongo/{util → utils}/support.rb

@@ -1,4 +1,16 @@
-require 'digest/md5'
+# 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.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
 
 module Mongo
   module Support
@@ -6,44 +18,6 @@ module Mongo
     include Mongo::Conversions
     extend self
 
-    # Commands that may be sent to replica-set secondaries, depending on
-    # read preference and tags. All other commands are always run on the primary.
-    SECONDARY_OK_COMMANDS = [
-      'group',
-      'aggregate',
-      'collstats',
-      'dbstats',
-      'count',
-      'distinct',
-      'geonear',
-      'geosearch',
-      'geowalk',
-      'mapreduce',
-      'replsetgetstatus',
-      'ismaster',
-    ]
-
-    # Generate an MD5 for authentication.
-    #
-    # @param [String] username
-    # @param [String] password
-    # @param [String] nonce
-    #
-    # @return [String] a key for db authentication.
-    def auth_key(username, password, nonce)
-      Digest::MD5.hexdigest("#{nonce}#{username}#{hash_password(username, password)}")
-    end
-
-    # Return a hashed password for auth.
-    #
-    # @param [String] username
-    # @param [String] plaintext
-    #
-    # @return [String]
-    def hash_password(username, plaintext)
-      Digest::MD5.hexdigest("#{username}:mongo:#{plaintext}")
-    end
-
     def validate_db_name(db_name)
       unless [String, Symbol].include?(db_name.class)
         raise TypeError, "db_name must be a string or symbol"
@@ -58,19 +32,6 @@ module Mongo
       db_name
     end
 
-    def secondary_ok?(selector)
-      command = selector.keys.first.to_s.downcase
-
-      if command == 'mapreduce'
-        out = selector.select { |k, v| k.to_s.downcase == 'out' }.first.last
-        # mongo looks at the first key in the out object, and doesn't
-        # look at the value
-        out.is_a?(Hash) && out.keys.first.to_s.downcase == 'inline' ? true : false
-      else
-        SECONDARY_OK_COMMANDS.member?(command)
-      end
-    end
-
     def format_order_clause(order)
       case order
         when Hash, BSON::OrderedHash then hash_as_sort_parameters(order)
@@ -87,8 +48,13 @@ module Mongo
       pairs = [ seeds ] if pairs.last.is_a?(Fixnum)
       pairs = pairs.collect do |hostport|
         if hostport.is_a?(String)
-          host, port = hostport.split(':')
-          [ host, port && port.to_i || MongoClient::DEFAULT_PORT ]
+          if hostport[0,1] == '['
+            host, port = hostport.split(']:') << MongoClient::DEFAULT_PORT
+            host = host.end_with?(']') ? host[1...-1] : host[1..-1]
+          else
+            host, port = hostport.split(':') << MongoClient::DEFAULT_PORT
+          end
+          [ host, port.to_i ]
         else
           hostport
         end
@@ -107,7 +73,8 @@ module Mongo
     #
     # @return [Boolean] true if the 'ok' key is either 1 or *true*.
     def ok?(doc)
-      doc['ok'] == 1.0 || doc['ok'] == true
+      ok = doc['ok']
+      ok == 1 || ok == 1.0 || ok == true
     end
   end
 end

data/lib/mongo/utils/thread_local_variable_manager.rb

@@ -0,0 +1,25 @@
+# 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.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+#:nodoc:
+module Mongo
+  module ThreadLocalVariableManager
+    def thread_local
+      Thread.current[:mongo_thread_locals] ||= Hash.new do |hash, key|
+        hash[key] = Hash.new unless hash.key? key
+        hash[key]
+      end
+    end
+  end
+end

data/lib/mongo/utils.rb

@@ -0,0 +1,19 @@
+# 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.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'mongo/utils/conversions'
+require 'mongo/utils/core_ext'
+require 'mongo/utils/server_version'
+require 'mongo/utils/support'
+require 'mongo/utils/thread_local_variable_manager'