mongo 1.10.0-java

data/lib/mongo/connection/sharding_pool_manager.rb

@@ -0,0 +1,67 @@
+# 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
+  class ShardingPoolManager < PoolManager
+    def inspect
+      "<Mongo::ShardingPoolManager:0x#{self.object_id.to_s(16)} @seeds=#{@seeds}>"
+    end
+
+    # "Best" should be the member with the fastest ping time
+    # but connect/connect_to_members reinitializes @members
+    def best(members)
+      Array(members.first)
+    end
+
+    def connect
+      @connect_mutex.synchronize do
+        begin
+          thread_local[:locks][:connecting_manager] = true
+          @refresh_required = false
+          disconnect_old_members
+          connect_to_members
+          initialize_pools best(@members)
+          update_max_sizes
+          @seeds = discovered_seeds
+        ensure
+          thread_local[:locks][:connecting_manager] = false
+        end
+      end
+    end
+
+    # Checks that each node is healthy (via check_is_master) and that each
+    # node is in fact a mongos. If either criteria are not true, a refresh is
+    # set to be triggered and close() is called on the node.
+    #
+    # @return [Boolean] indicating if a refresh is required.
+    def check_connection_health
+      @refresh_required = false
+      @members.each do |member|
+        begin
+          config = @client.check_is_master([member.host, member.port])
+          unless config && config.has_key?('msg')
+            @refresh_required = true
+            member.close
+          end
+        rescue OperationTimeout
+          @refresh_required = true
+          member.close
+        end
+        break if @refresh_required
+      end
+      @refresh_required
+    end
+
+  end
+end

data/lib/mongo/connection/socket.rb

@@ -0,0 +1,18 @@
+# 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/connection/socket/socket_util.rb'
+require 'mongo/connection/socket/ssl_socket.rb'
+require 'mongo/connection/socket/tcp_socket.rb'
+require 'mongo/connection/socket/unix_socket.rb'

data/lib/mongo/connection/socket/socket_util.rb

@@ -0,0 +1,37 @@
+# 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 'socket'
+require 'timeout'
+
+module SocketUtil
+
+  attr_accessor :pool, :pid, :auths
+
+  def checkout
+    @pool.checkout if @pool
+  end
+
+  def checkin
+    @pool.checkin(self) if @pool
+  end
+
+  def close
+    @socket.close unless closed?
+  end
+
+  def closed?
+    @socket.closed?
+  end
+end

data/lib/mongo/connection/socket/ssl_socket.rb

@@ -0,0 +1,95 @@
+# 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 'openssl'
+
+module Mongo
+
+  # A basic wrapper over Ruby's SSLSocket that initiates
+  # a TCP connection over SSL and then provides an basic interface
+  # mirroring Ruby's TCPSocket, vis., TCPSocket#send and TCPSocket#read.
+  class SSLSocket
+    include SocketUtil
+
+    def initialize(host, port, op_timeout=nil, connect_timeout=nil, opts={})
+      @op_timeout      = op_timeout
+      @connect_timeout = connect_timeout
+      @pid             = Process.pid
+      @auths           = Set.new
+
+      @tcp_socket = ::TCPSocket.new(host, port)
+      @tcp_socket.setsockopt(Socket::IPPROTO_TCP, Socket::TCP_NODELAY, 1)
+
+      @context = OpenSSL::SSL::SSLContext.new
+
+      if opts[:cert]
+        @context.cert = OpenSSL::X509::Certificate.new(File.open(opts[:cert]))
+      end
+
+      if opts[:key]
+        if opts[:key_pass_phrase]
+          @context.key = OpenSSL::PKey::RSA.new(File.open(opts[:key]), opts[:key_pass_phrase])
+        else
+          @context.key = OpenSSL::PKey::RSA.new(File.open(opts[:key]))
+        end
+      end
+
+      if opts[:verify]
+        @context.ca_file = opts[:ca_cert]
+        @context.verify_mode = OpenSSL::SSL::VERIFY_PEER
+      end
+
+      begin
+        @socket = OpenSSL::SSL::SSLSocket.new(@tcp_socket, @context)
+        @socket.sync_close = true
+        connect
+      rescue OpenSSL::SSL::SSLError
+        raise ConnectionFailure, "SSL handshake failed. MongoDB may " +
+                                 "not be configured with SSL support."
+      end
+
+      if opts[:verify]
+        unless OpenSSL::SSL.verify_certificate_identity(@socket.peer_cert, host)
+          raise ConnectionFailure, "SSL handshake failed. Hostname mismatch."
+        end
+      end
+
+      self
+    end
+
+    def connect
+      if @connect_timeout
+        Timeout::timeout(@connect_timeout, ConnectionTimeoutError) do
+          @socket.connect
+        end
+      else
+        @socket.connect
+      end
+    end
+
+    def send(data)
+      @socket.syswrite(data)
+    end
+
+    def read(length, buffer)
+      if @op_timeout
+        Timeout::timeout(@op_timeout, OperationTimeout) do
+          @socket.sysread(length, buffer)
+        end
+      else
+        @socket.sysread(length, buffer)
+      end
+    end
+  end
+end

data/lib/mongo/connection/socket/tcp_socket.rb

@@ -0,0 +1,86 @@
+# 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
+  # Wrapper class for Socket
+  #
+  # Emulates TCPSocket with operation and connection timeout
+  # sans Timeout::timeout
+  #
+  class TCPSocket
+    include SocketUtil
+
+    def initialize(host, port, op_timeout=nil, connect_timeout=nil, opts={})
+      @op_timeout      = op_timeout
+      @connect_timeout = connect_timeout
+      @pid             = Process.pid
+      @auths           = Set.new
+
+      @socket = handle_connect(host, port)
+    end
+
+    def handle_connect(host, port)
+      error = nil
+      # Following python's lead (see PYTHON-356)
+      family = host == 'localhost' ? Socket::AF_INET : Socket::AF_UNSPEC
+      addr_info = Socket.getaddrinfo(host, nil, family, Socket::SOCK_STREAM)
+      addr_info.each do |info|
+        begin
+          sock = Socket.new(info[4], Socket::SOCK_STREAM, 0)
+          sock.setsockopt(Socket::IPPROTO_TCP, Socket::TCP_NODELAY, 1)
+          socket_address = Socket.pack_sockaddr_in(port, info[3])
+          connect(sock, socket_address)
+          return sock
+        rescue IOError, SystemCallError => e
+          error = e
+          sock.close if sock
+        end
+      end
+      raise error
+    end
+
+    def connect(socket, socket_address)
+      if @connect_timeout
+        Timeout::timeout(@connect_timeout, ConnectionTimeoutError) do
+          socket.connect(socket_address)
+        end
+      else
+        socket.connect(socket_address)
+      end
+    end
+
+    def send(data)
+      @socket.write(data)
+    end
+
+    def read(maxlen, buffer)
+      # Block on data to read for @op_timeout seconds
+      begin
+        ready = IO.select([@socket], nil, [@socket], @op_timeout)
+        unless ready
+          raise OperationTimeout
+        end
+      rescue IOError
+        raise ConnectionFailure
+      end
+
+      # Read data from socket
+      begin
+        @socket.sysread(maxlen, buffer)
+      rescue SystemCallError, IOError => ex
+        raise ConnectionFailure, ex
+      end
+    end
+  end
+end

data/lib/mongo/connection/socket/unix_socket.rb

@@ -0,0 +1,39 @@
+# 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
+
+  attr_accessor :auths
+
+  # Wrapper class for Socket
+  #
+  # Emulates UNIXSocket with operation and connection timeout
+  # sans Timeout::timeout
+  #
+  class UNIXSocket < TCPSocket
+    def initialize(socket_path, port=:socket, op_timeout=nil, connect_timeout=nil, opts={})
+      @op_timeout      = op_timeout
+      @connect_timeout = connect_timeout
+      @pid             = Process.pid
+      @auths           = Set.new
+
+      @address         = socket_path
+      @port            = :socket # purposely override input
+
+      @socket_address  = Socket.pack_sockaddr_un(@address)
+      @socket          = Socket.new(Socket::AF_UNIX, Socket::SOCK_STREAM, 0)
+      connect
+    end
+  end
+end

data/lib/mongo/cursor.rb

@@ -0,0 +1,719 @@
+# 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
+
+  # A cursor over query results. Returned objects are hashes.
+  class Cursor
+    include Enumerable
+    include Mongo::Constants
+    include Mongo::Conversions
+    include Mongo::Logging
+    include Mongo::ReadPreference
+
+    attr_reader :collection, :selector, :fields,
+      :order, :hint, :snapshot, :timeout,
+      :full_collection_name, :transformer,
+      :options, :cursor_id, :show_disk_loc,
+      :comment, :compile_regex, :read, :tag_sets,
+      :acceptable_latency
+
+    # Create a new cursor.
+    #
+    # Note: cursors are created when executing queries using [Collection#find] and other
+    # similar methods. Application developers shouldn't have to create cursors manually.
+    #
+    # @return [Cursor]
+    def initialize(collection, opts={})
+      opts = opts.dup
+      @cursor_id  = opts.delete(:cursor_id)
+      @db         = collection.db
+      @collection = collection
+      @connection = @db.connection
+      @logger     = @connection.logger
+
+      # Query selector
+      @selector   = opts.delete(:selector) || {}
+
+      # Query pre-serialized bson to append
+      @bson    = @selector.delete(:bson)
+
+      # Special operators that form part of $query
+      @order         = opts.delete(:order)
+      @explain       = opts.delete(:explain)
+      @hint          = opts.delete(:hint)
+      @snapshot      = opts.delete(:snapshot)
+      @max_scan      = opts.delete(:max_scan)
+      @return_key    = opts.delete(:return_key)
+      @show_disk_loc = opts.delete(:show_disk_loc)
+      @comment       = opts.delete(:comment)
+      @compile_regex = opts.key?(:compile_regex) ? opts.delete(:compile_regex) : true
+
+      # Wire-protocol settings
+      @fields   = convert_fields_for_query(opts.delete(:fields))
+      @skip     = opts.delete(:skip)     || 0
+      @limit    = opts.delete(:limit)    || 0
+      @tailable = opts.delete(:tailable)
+      @timeout  = opts.key?(:timeout) ? opts.delete(:timeout) : true
+      @options  = 0
+
+      # Use this socket for the query
+      @socket = opts.delete(:socket)
+      @pool   = opts.delete(:pool)
+
+      @closed    = false
+      @query_run = false
+
+      @transformer        = opts.delete(:transformer)
+      @read               = opts.delete(:read)               || @collection.read
+      Mongo::ReadPreference::validate(@read)
+      @tag_sets           = opts.delete(:tag_sets)           || @collection.tag_sets
+      @acceptable_latency = opts.delete(:acceptable_latency) || @collection.acceptable_latency
+
+      batch_size(opts.delete(:batch_size) || 0)
+
+      @full_collection_name = "#{@collection.db.name}.#{@collection.name}"
+      @cache                = opts.delete(:first_batch) || []
+      @returned             = 0
+
+      if(!@timeout)
+        add_option(OP_QUERY_NO_CURSOR_TIMEOUT)
+      end
+      if(@read != :primary)
+        add_option(OP_QUERY_SLAVE_OK)
+      end
+      if(@tailable)
+        add_option(OP_QUERY_TAILABLE)
+      end
+
+      # If a cursor_id is provided, this is a cursor for a command
+      if @cursor_id
+        @command_cursor = true
+        @query_run      = true
+      end
+
+      if @collection.name =~ /^\$cmd/ || @collection.name =~ /^system/
+        @command = true
+      else
+        @command = false
+      end
+
+      @opts = opts
+    end
+
+    # Guess whether the cursor is alive on the server.
+    #
+    # Note that this method only checks whether we have
+    # a cursor id. The cursor may still have timed out
+    # on the server. This will be indicated in the next
+    # call to Cursor#next.
+    #
+    # @return [Boolean]
+    def alive?
+      @cursor_id && @cursor_id != 0
+    end
+
+    # Get the next document specified the cursor options.
+    #
+    # @return [Hash, Nil] the next document or Nil if no documents remain.
+    def next
+      if @cache.length == 0
+        if @query_run && exhaust?
+          close
+          return nil
+        else
+          refresh
+        end
+      end
+      doc = @cache.shift
+
+      if doc && (err = doc['errmsg'] || doc['$err']) # assignment
+        code = doc['code']
+
+        # If the server has stopped being the master (e.g., it's one of a
+        # pair but it has died or something like that) then we close that
+        # connection. The next request will re-open on master server.
+        if err.include?("not master")
+          @connection.close
+          raise ConnectionFailure.new(err, code, doc)
+        end
+
+        # Handle server side operation execution timeout
+        if code == 50
+          raise ExecutionTimeout.new(err, code, doc)
+        end
+
+        raise OperationFailure.new(err, code, doc)
+      elsif doc && (write_concern_error = doc['writeConcernError']) # assignment
+        raise WriteConcernError.new(write_concern_error['errmsg'], write_concern_error['code'], doc)
+      end
+
+      if @transformer.nil?
+        doc
+      else
+        @transformer.call(doc) if doc
+      end
+    end
+    alias :next_document :next
+
+    # Reset this cursor on the server. Cursor options, such as the
+    # query string and the values for skip and limit, are preserved.
+    def rewind!
+      check_command_cursor
+      close
+      @cache.clear
+      @cursor_id  = nil
+      @closed     = false
+      @query_run  = false
+      @n_received = nil
+      true
+    end
+
+    # Determine whether this cursor has any remaining results.
+    #
+    # @return [Boolean]
+    def has_next?
+      num_remaining > 0
+    end
+
+    # Get the size of the result set for this query.
+    #
+    # @param [Boolean] skip_and_limit whether or not to take skip or limit into account.
+    #
+    # @return [Integer] the number of objects in the result set for this query.
+    #
+    # @raise [OperationFailure] on a database error.
+    def count(skip_and_limit = false)
+      check_command_cursor
+      command = BSON::OrderedHash["count",  @collection.name, "query",  @selector]
+
+      if skip_and_limit
+        command.merge!(BSON::OrderedHash["limit", @limit]) if @limit != 0
+        command.merge!(BSON::OrderedHash["skip", @skip]) if @skip != 0
+      end
+
+      command.merge!(BSON::OrderedHash["fields", @fields])
+
+      response = @db.command(command, :read => @read, :comment => @comment)
+      return response['n'].to_i if Mongo::Support.ok?(response)
+      return 0 if response['errmsg'] == "ns missing"
+      raise OperationFailure.new("Count failed: #{response['errmsg']}", response['code'], response)
+    end
+
+    # Sort this cursor's results.
+    #
+    # This method overrides any sort order specified in the Collection#find
+    # method, and only the last sort applied has an effect.
+    #
+    # @param [Symbol, Array, Hash, OrderedHash] order either 1) a key to sort by 2)
+    #   an array of [key, direction] pairs to sort by or 3) a hash of
+    #   field => direction pairs to sort by. Direction should be specified as
+    #   Mongo::ASCENDING (or :ascending / :asc) or Mongo::DESCENDING
+    #   (or :descending / :desc)
+    #
+    # @raise [InvalidOperation] if this cursor has already been used.
+    #
+    # @raise [InvalidSortValueError] if the specified order is invalid.
+    def sort(order, direction=nil)
+      check_modifiable
+      order = [[order, direction]] unless direction.nil?
+      @order = order
+      self
+    end
+
+    # Limit the number of results to be returned by this cursor.
+    #
+    # This method overrides any limit specified in the Collection#find method,
+    # and only the last limit applied has an effect.
+    #
+    # @return [Integer] the current number_to_return if no parameter is given.
+    #
+    # @raise [InvalidOperation] if this cursor has already been used.
+    def limit(number_to_return=nil)
+      return @limit unless number_to_return
+      check_modifiable
+
+      if (number_to_return != 0) && exhaust?
+        raise MongoArgumentError, "Limit is incompatible with exhaust option."
+      end
+
+      @limit = number_to_return
+      self
+    end
+
+    # Skips the first +number_to_skip+ results of this cursor.
+    # Returns the current number_to_skip if no parameter is given.
+    #
+    # This method overrides any skip specified in the Collection#find method,
+    # and only the last skip applied has an effect.
+    #
+    # @return [Integer]
+    #
+    # @raise [InvalidOperation] if this cursor has already been used.
+    def skip(number_to_skip=nil)
+      return @skip unless number_to_skip
+      check_modifiable
+
+      @skip = number_to_skip
+      self
+    end
+
+    # Instruct the server to abort queries after they exceed the specified
+    # wall-clock execution time.
+    #
+    # A query that completes in under its time limit will "roll over"
+    # remaining time to the first getmore op (which will then "roll over"
+    # its remaining time to the second getmore op and so on, until the
+    # time limit is hit).
+    #
+    # Cursors returned by successful time-limited queries will still obey
+    # the default cursor idle timeout (unless the "no cursor idle timeout"
+    # flag has been set).
+    #
+    # @note This will only have an effect in MongoDB 2.5+
+    #
+    # @param max_time_ms [Fixnum] max execution time (in milliseconds)
+    #
+    # @return [Fixnum, Cursor] either the current max_time_ms or cursor
+    def max_time_ms(max_time_ms=nil)
+      return @max_time_ms unless max_time_ms
+      check_modifiable
+
+      @max_time_ms = max_time_ms
+      self
+    end
+
+    # Set the batch size for server responses.
+    #
+    # Note that the batch size will take effect only on queries
+    # where the number to be returned is greater than 100.
+    #
+    # This can not override MongoDB's limit on the amount of data it will
+    # return to the client. Depending on server version this can be 4-16mb.
+    #
+    # @param [Integer] size either 0 or some integer greater than 1. If 0,
+    #   the server will determine the batch size.
+    #
+    # @return [Cursor]
+    def batch_size(size=nil)
+      return @batch_size unless size
+      check_modifiable
+      if size < 0 || size == 1
+        raise ArgumentError, "Invalid value for batch_size #{size}; must be 0 or > 1."
+      else
+        @batch_size = @limit != 0 && size > @limit ? @limit : size
+      end
+
+      self
+    end
+
+    # Iterate over each document in this cursor, yielding it to the given
+    # block, if provided. An Enumerator is returned if no block is given.
+    #
+    # Iterating over an entire cursor will close it.
+    #
+    # @yield passes each document to a block for processing.
+    #
+    # @example if 'comments' represents a collection of comments:
+    #   comments.find.each do |doc|
+    #     puts doc['user']
+    #   end
+    def each
+      if block_given? || !defined?(Enumerator)
+        while doc = self.next
+          yield doc
+        end
+      else
+        Enumerator.new do |yielder|
+          while doc = self.next
+            yielder.yield doc
+          end
+        end
+      end
+    end
+    # Receive all the documents from this cursor as an array of hashes.
+    #
+    # Notes:
+    #
+    # If you've already started iterating over the cursor, the array returned
+    # by this method contains only the remaining documents. See Cursor#rewind! if you
+    # need to reset the cursor.
+    #
+    # Use of this method is discouraged - in most cases, it's much more
+    # efficient to retrieve documents as you need them by iterating over the cursor.
+    #
+    # @return [Array] an array of documents.
+    def to_a
+      super
+    end
+
+    # Get the explain plan for this cursor.
+    #
+    # @return [Hash] a document containing the explain plan for this cursor.
+    def explain
+      check_command_cursor
+      c = Cursor.new(@collection,
+        query_options_hash.merge(:limit => -@limit.abs, :explain => true))
+      explanation = c.next_document
+      c.close
+
+      explanation
+    end
+
+    # Close the cursor.
+    #
+    # Note: if a cursor is read until exhausted (read until Mongo::Constants::OP_QUERY or
+    # Mongo::Constants::OP_GETMORE returns zero for the cursor id), there is no need to
+    # close it manually.
+    #
+    # Note also: Collection#find takes an optional block argument which can be used to
+    # ensure that your cursors get closed.
+    #
+    # @return [True]
+    def close
+      if @cursor_id && @cursor_id != 0
+        message = BSON::ByteBuffer.new([0, 0, 0, 0])
+        message.put_int(1)
+        message.put_long(@cursor_id)
+        log(:debug, "Cursor#close #{@cursor_id}")
+        @connection.send_message(
+          Mongo::Constants::OP_KILL_CURSORS,
+          message,
+          :pool => @pool
+        )
+      end
+      @cursor_id = 0
+      @closed    = true
+    end
+
+    # Is this cursor closed?
+    #
+    # @return [Boolean]
+    def closed?
+      @closed
+    end
+
+    # Returns an integer indicating which query options have been selected.
+    #
+    # @return [Integer]
+    #
+    # @see http://www.mongodb.org/display/DOCS/Mongo+Wire+Protocol#MongoWireProtocol-Mongo::Constants::OPQUERY
+    # The MongoDB wire protocol.
+    def query_opts
+      warn "The method Cursor#query_opts has been deprecated " +
+        "and will removed in v2.0. Use Cursor#options instead."
+      @options
+    end
+
+    # Add an option to the query options bitfield.
+    #
+    # @param opt a valid query option
+    #
+    # @raise InvalidOperation if this method is run after the cursor has bee
+    #   iterated for the first time.
+    #
+    # @return [Integer] the current value of the options bitfield for this cursor.
+    #
+    # @see http://www.mongodb.org/display/DOCS/Mongo+Wire+Protocol#MongoWireProtocol-Mongo::Constants::OPQUERY
+    def add_option(opt)
+      check_modifiable
+
+      if exhaust?(opt)
+        if @limit != 0
+          raise MongoArgumentError, "Exhaust is incompatible with limit."
+        elsif @connection.mongos?
+          raise MongoArgumentError, "Exhaust is incompatible with mongos."
+        end
+      end
+
+      @options |= opt
+      @options
+    end
+
+    # Remove an option from the query options bitfield.
+    #
+    # @param opt a valid query option
+    #
+    # @raise InvalidOperation if this method is run after the cursor has bee
+    #   iterated for the first time.
+    #
+    # @return [Integer] the current value of the options bitfield for this cursor.
+    #
+    # @see http://www.mongodb.org/display/DOCS/Mongo+Wire+Protocol#MongoWireProtocol-Mongo::Constants::OPQUERY
+    def remove_option(opt)
+      check_modifiable
+
+      @options &= ~opt
+      @options
+    end
+
+    # Get the query options for this Cursor.
+    #
+    # @return [Hash]
+    def query_options_hash
+      BSON::OrderedHash[
+        :selector => @selector,
+        :fields   => @fields,
+        :skip     => @skip,
+        :limit    => @limit,
+        :order    => @order,
+        :hint     => @hint,
+        :snapshot => @snapshot,
+        :timeout  => @timeout,
+        :max_scan => @max_scan,
+        :return_key => @return_key,
+        :show_disk_loc => @show_disk_loc,
+        :comment  => @comment ]
+    end
+
+    # Clean output for inspect.
+    def inspect
+      "<Mongo::Cursor:0x#{object_id.to_s(16)} namespace='#{@db.name}.#{@collection.name}' " +
+        "@selector=#{@selector.inspect} @cursor_id=#{@cursor_id}>"
+    end
+
+    private
+
+    # Convert the +:fields+ parameter from a single field name or an array
+    # of fields names to a hash, with the field names for keys and '1' for each
+    # value.
+    def convert_fields_for_query(fields)
+      case fields
+        when String, Symbol
+          {fields => 1}
+        when Array
+          return nil if fields.length.zero?
+          fields.inject({}) do |hash, field|
+            field.is_a?(Hash) ? hash.merge!(field) : hash[field] = 1
+            hash
+          end
+        when Hash
+          return fields
+      end
+    end
+
+    # Return the number of documents remaining for this cursor.
+    def num_remaining
+      if @cache.length == 0
+        if @query_run && exhaust?
+          close
+          return 0
+        else
+          refresh
+        end
+      end
+
+      @cache.length
+    end
+
+    # Refresh the documents in @cache. This means either
+    # sending the initial query or sending a GET_MORE operation.
+    def refresh
+      if !@query_run
+        send_initial_query
+      elsif !@cursor_id.zero?
+        send_get_more
+      end
+    end
+
+    # Sends initial query -- which is always a read unless it is a command
+    #
+    # Upon ConnectionFailure, tries query 3 times if socket was not provided
+    # and the query is either not a command or is a secondary_ok command.
+    #
+    # Pins pools upon successful read and unpins pool upon ConnectionFailure
+    #
+    def send_initial_query
+      tries = 0
+      instrument(:find, instrument_payload) do
+        begin
+          message = construct_query_message
+          socket = @socket || checkout_socket_from_connection
+          results, @n_received, @cursor_id = @connection.receive_message(
+            Mongo::Constants::OP_QUERY, message, nil, socket, @command,
+            nil, exhaust?, compile_regex?)
+        rescue ConnectionFailure => ex
+          socket.close if socket
+          @pool = nil
+          @connection.unpin_pool
+          @connection.refresh
+          if tries < 3 && !@socket && (!@command || Mongo::ReadPreference::secondary_ok?(@selector))
+            tries += 1
+            retry
+          else
+            raise ex
+          end
+        rescue OperationFailure, OperationTimeout => ex
+          raise ex
+        ensure
+          socket.checkin unless @socket || socket.nil?
+        end
+        if !@socket && !@command
+          @connection.pin_pool(socket.pool, read_preference)
+        end
+        @returned += @n_received
+        @cache += results
+        @query_run = true
+        close_cursor_if_query_complete
+      end
+    end
+
+    def send_get_more
+      message = BSON::ByteBuffer.new([0, 0, 0, 0])
+
+      # DB name.
+      BSON::BSON_RUBY.serialize_cstr(message, "#{@db.name}.#{@collection.name}")
+
+      # Number of results to return.
+      if @limit > 0
+        limit = @limit - @returned
+        if @batch_size > 0
+          limit = limit < @batch_size ? limit : @batch_size
+        end
+        message.put_int(limit)
+      else
+        message.put_int(@batch_size)
+      end
+
+      # Cursor id.
+      message.put_long(@cursor_id)
+      log(:debug, "cursor.refresh() for cursor #{@cursor_id}") if @logger
+
+      socket = @pool.checkout
+
+      begin
+        results, @n_received, @cursor_id = @connection.receive_message(
+          Mongo::Constants::OP_GET_MORE, message, nil, socket, @command,
+          nil, exhaust?, compile_regex?)
+      ensure
+        socket.checkin
+      end
+
+      @returned += @n_received
+      @cache += results
+      close_cursor_if_query_complete
+    end
+
+    def checkout_socket_from_connection
+      begin
+        if @pool
+          socket = @pool.checkout
+        elsif @command && !Mongo::ReadPreference::secondary_ok?(@selector)
+          socket = @connection.checkout_reader({:mode => :primary})
+        else
+          socket = @connection.checkout_reader(read_preference)
+        end
+      rescue SystemStackError, NoMemoryError, SystemCallError => ex
+        @connection.close
+        raise ex
+      end
+      @pool = socket.pool
+      socket
+    end
+
+    def checkin_socket(sock)
+      @connection.checkin(sock)
+    end
+
+    def construct_query_message
+      message = BSON::ByteBuffer.new("", @connection.max_bson_size + MongoClient::COMMAND_HEADROOM)
+      message.put_int(@options)
+      BSON::BSON_RUBY.serialize_cstr(message, "#{@db.name}.#{@collection.name}")
+      message.put_int(@skip)
+      @batch_size > 1 ? message.put_int(@batch_size) : message.put_int(@limit)
+      if query_contains_special_fields? && @bson # costs two serialize calls
+        query_message = BSON::BSON_CODER.serialize(@selector, false, false, @connection.max_bson_size + MongoClient::APPEND_HEADROOM)
+        query_message.grow(@bson)
+        query_spec = construct_query_spec
+        query_spec.delete('$query')
+        query_message.grow(BSON::BSON_CODER.serialize(query_spec, false, false, @connection.max_bson_size))
+      else # costs only one serialize call
+        spec = query_contains_special_fields? ? construct_query_spec : @selector
+        spec.merge!(@opts)
+        query_message = BSON::BSON_CODER.serialize(spec, false, false, @connection.max_bson_size + MongoClient::APPEND_HEADROOM)
+        query_message.grow(@bson) if @bson
+      end
+      message.put_binary(query_message.to_s)
+      message.put_binary(BSON::BSON_CODER.serialize(@fields, false, false, @connection.max_bson_size).to_s) if @fields
+      message
+    end
+
+    def instrument_payload
+      log = { :database => @db.name, :collection => @collection.name, :selector => selector }
+      log[:fields] = @fields if @fields
+      log[:skip]   = @skip   if @skip && (@skip != 0)
+      log[:limit]  = @limit  if @limit && (@limit != 0)
+      log[:order]  = @order  if @order
+      log
+    end
+
+    def construct_query_spec
+      return @selector if @selector.has_key?('$query')
+      spec = BSON::OrderedHash.new
+      spec['$query']    = @selector
+      spec['$orderby']  = Mongo::Support.format_order_clause(@order) if @order
+      spec['$hint']     = @hint if @hint && @hint.length > 0
+      spec['$explain']  = true if @explain
+      spec['$snapshot'] = true if @snapshot
+      spec['$maxScan']  = @max_scan if @max_scan
+      spec['$returnKey']   = true if @return_key
+      spec['$showDiskLoc'] = true if @show_disk_loc
+      spec['$comment']  = @comment if @comment
+      spec['$maxTimeMS'] = @max_time_ms if @max_time_ms
+      if needs_read_pref?
+        read_pref = Mongo::ReadPreference::mongos(@read, @tag_sets)
+        spec['$readPreference'] = read_pref if read_pref
+      end
+      spec
+    end
+
+    def needs_read_pref?
+      @connection.mongos? && @read != :primary
+    end
+
+    def query_contains_special_fields?
+      @order || @explain || @hint || @snapshot || @show_disk_loc ||
+        @max_scan || @return_key || @comment || @max_time_ms || needs_read_pref?
+    end
+
+    def close_cursor_if_query_complete
+      if @limit > 0 && @returned >= @limit
+        close
+      end
+    end
+
+    # Check whether the exhaust option is set
+    #
+    # @return [true, false] The state of the exhaust flag.
+    def exhaust?(opts = options)
+      !(opts & OP_QUERY_EXHAUST).zero?
+    end
+
+    def check_modifiable
+      if @query_run || @closed
+        raise InvalidOperation, "Cannot modify the query once it has been run or closed."
+      end
+    end
+
+    def check_command_cursor
+      if @command_cursor
+        raise InvalidOperation, "Cannot call #{caller.first} on command cursors"
+      end
+    end
+
+    def compile_regex?
+      @compile_regex
+    end
+  end
+end