mongo 1.0 → 1.1.5

data/lib/mongo/cursor.rb

@@ -1,3 +1,5 @@
+# encoding: UTF-8
+
 # Copyright (C) 2008-2010 10gen Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -19,7 +21,7 @@ module Mongo
     include Mongo::Conversions
     include Enumerable
 
-    attr_reader :collection, :selector, :admin, :fields,
+    attr_reader :collection, :selector, :fields,
       :order, :hint, :snapshot, :timeout,
       :full_collection_name
 
@@ -35,32 +37,39 @@ module Mongo
       @db         = collection.db
       @collection = collection
       @connection = @db.connection
+      @logger     = @connection.logger
 
-      @selector   = convert_selector_for_query(options[:selector])
+      @selector   = options[:selector] || {}
       @fields     = convert_fields_for_query(options[:fields])
-      @admin      = options[:admin]    || false
       @skip       = options[:skip]     || 0
       @limit      = options[:limit]    || 0
       @order      = options[:order]
       @hint       = options[:hint]
       @snapshot   = options[:snapshot]
-      @timeout    = options[:timeout]  || false
+      @timeout    = options.has_key?(:timeout) ? options[:timeout] : true
       @explain    = options[:explain]
       @socket     = options[:socket]
       @tailable   = options[:tailable] || false
-      @batch_size = options[:batch_size] || Mongo::Constants::DEFAULT_BATCH_SIZE
+      @closed       = false
+      @query_run    = false
+      batch_size(options[:batch_size] || 0)
 
       @full_collection_name = "#{@collection.db.name}.#{@collection.name}"
-      @cache = []
-      @closed = false
-      @query_run = false
+      @cache        = []
+      @returned     = 0
+
+      if @collection.name =~ /^\$cmd/ || @collection.name =~ /^system/
+        @command = true
+      else
+        @command = false
+      end
     end
 
     # Get the next document specified the cursor options.
     #
     # @return [Hash, Nil] the next document or Nil if no documents remain.
     def next_document
-      refill_via_get_more if num_remaining == 0
+      refresh if @cache.length == 0
       doc = @cache.shift
 
       if doc && doc['$err']
@@ -70,8 +79,8 @@ module Mongo
         # 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 == "not master"
-          raise ConnectionFailure, err
           @connection.close
+          raise ConnectionFailure, err
         end
 
         raise OperationFailure, err
@@ -80,6 +89,18 @@ module Mongo
       doc
     end
 
+    # Reset this cursor on the server. Cursor options, such as the
+    # query string and the values for skip and limit, are preserved.
+    def rewind!
+      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]
@@ -89,16 +110,23 @@ module Mongo
 
     # Get the size of the result set for this query.
     #
-    # @return [Integer] the number of objects in the result set for this query. Does
-    #   not take limit and skip into account. 
+    # @param [Boolean] whether of not to take notice of skip and limit
+    #
+    # @return [Integer] the number of objects in the result set for this query.
     #
     # @raise [OperationFailure] on a database error.
-    def count
-      command = OrderedHash["count",  @collection.name,
-                            "query",  @selector,
-                            "fields", @fields]
+    def count(skip_and_limit = false)
+      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)
-      return response['n'].to_i if response['ok'] == 1
+      return response['n'].to_i if Mongo::Support.ok?(response)
       return 0 if response['errmsg'] == "ns missing"
       raise OperationFailure, "Count failed: #{response['errmsg']}"
     end
@@ -141,7 +169,6 @@ module Mongo
     def limit(number_to_return=nil)
       return @limit unless number_to_return
       check_modifiable
-      raise ArgumentError, "limit requires an integer" unless number_to_return.is_a? Integer
 
       @limit = number_to_return
       self
@@ -159,12 +186,31 @@ module Mongo
     def skip(number_to_skip=nil)
       return @skip unless number_to_skip
       check_modifiable
-      raise ArgumentError, "skip requires an integer" unless number_to_skip.is_a? Integer
 
       @skip = number_to_skip
       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.
+    #
+    # @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=0)
+      check_modifiable
+      if size < 0 || size == 1
+        raise ArgumentError, "Invalid value for batch_size #{size}; must be 0 or > 1."
+      else
+        @batch_size = size > @limit ? @limit : size
+      end
+
+      self
+    end
+
     # Iterate over each document in this cursor, yielding it to the given
     # block.
     #
@@ -177,31 +223,28 @@ module Mongo
     #     puts doc['user']
     #   end
     def each
-      num_returned = 0
-      while has_next? && (@limit <= 0 || num_returned < @limit)
-        yield next_document
-        num_returned += 1
+      #num_returned = 0
+      #while has_next? && (@limit <= 0 || num_returned < @limit)
+      while doc = next_document
+        yield doc #next_document
+        #num_returned += 1
       end
     end
 
     # Receive all the documents from this cursor as an array of hashes.
     #
-    # Note: use of this method is discouraged - in most cases, it's much more
+    # 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.
-    #
-    # @raise [InvalidOperation] if this cursor has already been used or if
-    #   this method has already been called on the cursor.
     def to_a
-      raise InvalidOperation, "can't call Cursor#to_a on a used cursor" if @query_run
-      rows = []
-      num_returned = 0
-      while has_next? && (@limit <= 0 || num_returned < @limit)
-        rows << next_document
-        num_returned += 1
-      end
-      rows
+      super
     end
 
     # Get the explain plan for this cursor.
@@ -228,11 +271,12 @@ module Mongo
     #
     # @return [True]
     def close
-      if @cursor_id
+      if @cursor_id && @cursor_id != 0
         message = BSON::ByteBuffer.new([0, 0, 0, 0])
         message.put_int(1)
         message.put_long(@cursor_id)
-        @connection.send_message(Mongo::Constants::OP_KILL_CURSORS, message, "cursor.close")
+        @logger.debug("MONGODB cursor.close #{@cursor_id}") if @logger
+        @connection.send_message(Mongo::Constants::OP_KILL_CURSORS, message, nil)
       end
       @cursor_id = 0
       @closed    = true
@@ -250,10 +294,11 @@ module Mongo
     # @see http://www.mongodb.org/display/DOCS/Mongo+Wire+Protocol#MongoWireProtocol-Mongo::Constants::OPQUERY
     # The MongoDB wire protocol.
     def query_opts
-      timeout  = @timeout ? 0 : Mongo::Constants::OP_QUERY_NO_CURSOR_TIMEOUT
-      slave_ok = @connection.slave_ok? ? Mongo::Constants::OP_QUERY_SLAVE_OK : 0
-      tailable = @tailable ? Mongo::Constants::OP_QUERY_TAILABLE : 0
-      slave_ok + timeout + tailable
+      opts     = 0
+      opts    |= Mongo::Constants::OP_QUERY_NO_CURSOR_TIMEOUT unless @timeout
+      opts    |= Mongo::Constants::OP_QUERY_SLAVE_OK if @connection.slave_ok?
+      opts    |= Mongo::Constants::OP_QUERY_TAILABLE if @tailable
+      opts
     end
 
     # Get the query options for this Cursor.
@@ -262,7 +307,6 @@ module Mongo
     def query_options_hash
       { :selector => @selector,
         :fields   => @fields,
-        :admin    => @admin,
         :skip     => @skip_num,
         :limit    => @limit_num,
         :order    => @order,
@@ -271,6 +315,12 @@ module Mongo
         :timeout  => @timeout }
     end
 
+    # Clean output for inspect.
+    def inspect
+      "<Mongo::Cursor:0x#{object_id.to_s(16)} namespace='#{@db.name}.#{@collection.name}' " +
+        "@selector=#{@selector.inspect}>"
+    end
+
     private
 
     # Convert the +:fields+ parameter from a single field name or an array
@@ -282,50 +332,42 @@ module Mongo
           {fields => 1}
         when Array
           return nil if fields.length.zero?
-          returning({}) do |hash|
-            fields.each { |field| hash[field] = 1 }
-          end
+          fields.each_with_object({}) { |field, hash| hash[field] = 1 }
         when Hash
           return fields
       end
     end
 
-    # Set the query selector hash. If the selector is a Code or String object,
-    # the selector will be used in a $where clause.
-    # See http://www.mongodb.org/display/DOCS/Server-side+Code+Execution
-    def convert_selector_for_query(selector)
-      case selector
-        when Hash
-         selector
-        when nil
-          {}
-        when String
-          {"$where" => Code.new(selector)}
-        when Code
-          {"$where" => selector}
-      end
-    end
-
-    # Return a number of documents remaining for this cursor.
+    # Return the number of documents remaining for this cursor.
     def num_remaining
-      refill_via_get_more if @cache.length == 0
+      refresh if @cache.length == 0
       @cache.length
     end
 
-    def refill_via_get_more
+    def refresh
       return if send_initial_query || @cursor_id.zero?
       message = BSON::ByteBuffer.new([0, 0, 0, 0])
 
       # DB name.
-      db_name = @admin ? 'admin' : @db.name
-      BSON::BSON_RUBY.serialize_cstr(message, "#{db_name}.#{@collection.name}")
+      BSON::BSON_RUBY.serialize_cstr(message, "#{@db.name}.#{@collection.name}")
 
       # Number of results to return.
-      message.put_int(@batch_size)
+      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)
-      results, @n_received, @cursor_id = @connection.receive_message(Mongo::Constants::OP_GET_MORE, message, "cursor.get_more()", @socket)
+      @logger.debug("MONGODB cursor.refresh() for cursor #{@cursor_id}") if @logger
+      results, @n_received, @cursor_id = @connection.receive_message(
+          Mongo::Constants::OP_GET_MORE, message, nil, @socket, @command)
+      @returned += @n_received
       @cache += results
       close_cursor_if_query_complete
     end
@@ -336,8 +378,10 @@ module Mongo
         false
       else
         message = construct_query_message
-        results, @n_received, @cursor_id = @connection.receive_message(Mongo::Constants::OP_QUERY, message,
-            (query_log_message if @connection.logger), @socket)
+        @logger.debug query_log_message if @logger
+        results, @n_received, @cursor_id = @connection.receive_message(
+          Mongo::Constants::OP_QUERY, message, nil, @socket, @command)
+        @returned += @n_received
         @cache += results
         @query_run = true
         close_cursor_if_query_complete
@@ -348,25 +392,24 @@ module Mongo
     def construct_query_message
       message = BSON::ByteBuffer.new
       message.put_int(query_opts)
-      db_name = @admin ? 'admin' : @db.name
-      BSON::BSON_RUBY.serialize_cstr(message, "#{db_name}.#{@collection.name}")
+      BSON::BSON_RUBY.serialize_cstr(message, "#{@db.name}.#{@collection.name}")
       message.put_int(@skip)
       message.put_int(@limit)
       spec = query_contains_special_fields? ? construct_query_spec : @selector
-      message.put_array(BSON::BSON_CODER.serialize(spec, false).to_a)
-      message.put_array(BSON::BSON_CODER.serialize(@fields, false).to_a) if @fields
+      message.put_binary(BSON::BSON_CODER.serialize(spec, false).to_s)
+      message.put_binary(BSON::BSON_CODER.serialize(@fields, false).to_s) if @fields
       message
     end
 
     def query_log_message
-      "#{@admin ? 'admin' : @db.name}['#{@collection.name}'].find(#{@selector.inspect}, #{@fields ? @fields.inspect : '{}'})" +
+      "#{@db.name}['#{@collection.name}'].find(#{@selector.inspect}, #{@fields ? @fields.inspect : '{}'})" +
       "#{@skip != 0 ? ('.skip(' + @skip.to_s + ')') : ''}#{@limit != 0 ? ('.limit(' + @limit.to_s + ')') : ''}" +
       "#{@order ? ('.sort(' + @order.inspect + ')') : ''}"
     end
 
     def construct_query_spec
       return @selector if @selector.has_key?('$query')
-      spec = OrderedHash.new
+      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
@@ -385,7 +428,9 @@ module Mongo
     end
 
     def close_cursor_if_query_complete
-      close if @limit > 0 && @n_received >= @limit
+      if @limit > 0 && @returned >= @limit
+        close
+      end
     end
 
     def check_modifiable