mongo 1.3.0 → 1.12.5

data/lib/mongo/gridfs/grid_file_system.rb

@@ -1,20 +1,16 @@
-# encoding: UTF-8
-
-# --
-# Copyright (C) 2008-2011 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.
 # You may obtain a copy of the License at
 #
-#     http://www.apache.org/licenses/LICENSE-2.0
+#   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
 
@@ -39,17 +35,18 @@ module Mongo
 
       @default_query_opts = {:sort => [['filename', 1], ['uploadDate', -1]], :limit => 1}
 
-      # Ensure indexes only if not connected to slave.
-      unless db.connection.slave_ok?
-        @files.create_index([['filename', 1], ['uploadDate', -1]])
-        @chunks.create_index([['files_id', Mongo::ASCENDING], ['n', Mongo::ASCENDING]], :unique => true)
+      # This will create indexes only if we're connected to a primary node.
+      begin
+        @files.ensure_index([['filename', 1], ['uploadDate', -1]])
+        @chunks.ensure_index([['files_id', Mongo::ASCENDING], ['n', Mongo::ASCENDING]], :unique => true)
+      rescue Mongo::ConnectionFailure
       end
     end
 
     # Open a file for reading or writing. Note that the options for this method only apply
     # when opening in 'w' mode.
     #
-    # Note that arbitary metadata attributes can be saved to the file by passing
+    # Note that arbitrary metadata attributes can be saved to the file by passing
     # them is as options.
     #
     # @param [String] filename the name of the file.
@@ -63,38 +60,59 @@ module Mongo
     # @option opts [String] :content_type ('binary/octet-stream') If no content type is specified,
     #   the content type will may be inferred from the filename extension if the mime-types gem can be
     #   loaded. Otherwise, the content type 'binary/octet-stream' will be used.
-    # @option opts [Integer] (262144) :chunk_size size of file chunks in bytes.
+    # @option opts [Integer] (261120) :chunk_size size of file chunks in bytes.
     # @option opts [Boolean] :delete_old (false) ensure that old versions of the file are deleted. This option
     #  only work in 'w' mode. Certain precautions must be taken when deleting GridFS files. See the notes under
     #  GridFileSystem#delete.
-    # @option opts [Boolean] :safe (false) When safe mode is enabled, the chunks sent to the server
-    #   will be validated using an md5 hash. If validation fails, an exception will be raised.
+    # @option opts [String, Integer, Symbol] :w (1) Set write concern
+    #
+    #   Notes on write concern:
+    #     When :w > 0, the chunks sent to the server
+    #     will be validated using an md5 hash. If validation fails, an exception will be raised.
+    # @option opts [Integer] :versions (false) deletes all versions which exceed the number specified to
+    #   retain ordered by uploadDate. This option only works in 'w' mode. Certain precautions must be taken when
+    #   deleting GridFS files. See the notes under GridFileSystem#delete.
     #
     # @example
     #
     #  # Store the text "Hello, world!" in the grid file system.
-    #  @grid = GridFileSystem.new(@db)
+    #  @grid = Mongo::GridFileSystem.new(@db)
     #  @grid.open('filename', 'w') do |f|
     #    f.write "Hello, world!"
     #  end
     #
     #  # Output "Hello, world!"
-    #  @grid = GridFileSystem.new(@db)
+    #  @grid = Mongo::GridFileSystem.new(@db)
     #  @grid.open('filename', 'r') do |f|
     #    puts f.read
     #  end
     #
     #  # Write a file on disk to the GridFileSystem
     #  @file = File.open('image.jpg')
-    #  @grid = GridFileSystem.new(@db)
+    #  @grid = Mongo::GridFileSystem.new(@db)
     #  @grid.open('image.jpg, 'w') do |f|
     #    f.write @file
     #  end
     #
     #  @return [Mongo::GridIO]
     def open(filename, mode, opts={})
+      opts = opts.dup
       opts.merge!(default_grid_io_opts(filename))
-      del  = opts.delete(:delete_old) && mode == 'w'
+      if mode == 'w'
+        begin
+          # Ensure there are the appropriate indexes, as state may have changed since instantiation of self.
+          # Recall that index definitions are cached with ensure_index so this statement won't unneccesarily repeat index creation.
+          @files.ensure_index([['filename', 1], ['uploadDate', -1]])
+          @chunks.ensure_index([['files_id', Mongo::ASCENDING], ['n', Mongo::ASCENDING]], :unique => true)
+          versions = opts.delete(:versions)
+          if opts.delete(:delete_old) || (versions && versions < 1)
+            versions = 1
+          end
+        rescue Mongo::ConnectionFailure => e
+          raise e, "Failed to create necessary indexes and write data."
+          return
+        end
+      end
       file = GridIO.new(@files, @chunks, filename, mode, opts)
       return file unless block_given?
       result = nil
@@ -102,9 +120,9 @@ module Mongo
         result = yield file
       ensure
         id = file.close
-        if del
+        if versions
           self.delete do
-            @files.find({'filename' => filename, '_id' => {'$ne' => id}}, :fields => ['_id'])
+            @files.find({'filename' => filename, '_id' => {'$ne' => id}}, :fields => ['_id'], :sort => ['uploadDate', -1], :skip => (versions - 1))
           end
         end
       end

data/lib/mongo/gridfs/grid_io.rb

@@ -1,20 +1,16 @@
-# encoding: UTF-8
-
-# --
-# Copyright (C) 2008-2011 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.
 # You may obtain a copy of the License at
 #
-#     http://www.apache.org/licenses/LICENSE-2.0
+#   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 'digest/md5'
 
@@ -23,7 +19,9 @@ module Mongo
   # GridIO objects represent files in the GridFS specification. This class
   # manages the reading and writing of file chunks and metadata.
   class GridIO
-    DEFAULT_CHUNK_SIZE   = 256 * 1024
+    include Mongo::WriteConcern
+
+    DEFAULT_CHUNK_SIZE   = 255 * 1024
     DEFAULT_CONTENT_TYPE = 'binary/octet-stream'
     PROTECTED_ATTRS      = [:files_id, :file_length, :client_md5, :server_md5]
 
@@ -41,26 +39,30 @@ module Mongo
     # @option opts [Hash] :query a query selector used when opening the file in 'r' mode.
     # @option opts [Hash] :query_opts any query options to be used when opening the file in 'r' mode.
     # @option opts [String] :fs_name the file system prefix.
-    # @option opts [Integer] (262144) :chunk_size size of file chunks in bytes.
+    # @option opts [Integer] (261120) :chunk_size size of file chunks in bytes.
     # @option opts [Hash] :metadata ({}) any additional data to store with the file.
     # @option opts [ObjectId] :_id (ObjectId) a unique id for
     #   the file to be use in lieu of an automatically generated one.
     # @option opts [String] :content_type ('binary/octet-stream') If no content type is specified,
     #   the content type will may be inferred from the filename extension if the mime-types gem can be
     #   loaded. Otherwise, the content type 'binary/octet-stream' will be used.
-    # @option opts [Boolean] :safe (false) When safe mode is enabled, the chunks sent to the server
-    #   will be validated using an md5 hash. If validation fails, an exception will be raised.
+    # @option opts [String, Integer, Symbol] :w (1) Set the write concern
+    #
+    #   Notes on write concern:
+    #     When :w > 0, the chunks sent to the server
+    #     will be validated using an md5 hash. If validation fails, an exception will be raised.
     def initialize(files, chunks, filename, mode, opts={})
-      @files        = files
-      @chunks       = chunks
-      @filename     = filename
-      @mode         = mode
-      @query        = opts.delete(:query) || {}
-      @query_opts   = opts.delete(:query_opts) || {}
-      @fs_name      = opts.delete(:fs_name) || Grid::DEFAULT_FS_NAME
-      @safe         = opts.delete(:safe) || false
-      @local_md5    = Digest::MD5.new if @safe
-      @custom_attrs = {}
+      @files          = files
+      @chunks         = chunks
+      @filename       = filename
+      @mode           = mode
+      opts            = opts.dup
+      @query          = opts.delete(:query) || {}
+      @query_opts     = opts.delete(:query_opts) || {}
+      @fs_name        = opts.delete(:fs_name) || Grid::DEFAULT_FS_NAME
+      @write_concern  = get_write_concern(opts)
+      @local_md5      = Digest::MD5.new if Mongo::WriteConcern.gle?(@write_concern)
+      @custom_attrs   = {}
 
       case @mode
         when 'r' then init_read
@@ -104,21 +106,19 @@ module Mongo
 
     # Write the given string (binary) data to the file.
     #
-    # @param [String] string
-    #   the data to write
+    # @param [String] io the data to write.
     #
-    # @return [Integer]
-    #   the number of bytes written.
+    # @return [Integer] the number of bytes written.
     def write(io)
       raise GridError, "file not opened for write" unless @mode[0] == ?w
       if io.is_a? String
-        if @safe
+        if Mongo::WriteConcern.gle?(@write_concern)
           @local_md5.update(io)
         end
         write_string(io)
       else
         length = 0
-        if @safe
+        if Mongo::WriteConcern.gle?(@write_concern)
           while(string = io.read(@chunk_size))
             @local_md5.update(string)
             length += write_string(string)
@@ -207,43 +207,9 @@ module Mongo
       elsif separator.is_a?(Integer)
         read_length(separator)
       elsif separator.length > 1
-        result = ''
-        len = 0
-        match_idx = 0
-        match_num = separator.length - 1
-        to_match = separator[match_idx].chr
-        if length
-          matcher = lambda {|idx, num| idx < num && len < length }
-        else
-          matcher = lambda {|idx, num| idx < num}
-        end
-        while matcher.call(match_idx, match_num) && char = getc
-          result << char
-          len += 1
-          if char == to_match
-            while match_idx < match_num do
-              match_idx += 1
-              to_match = separator[match_idx].chr
-              char = getc
-              result << char
-              if char != to_match
-                match_idx = 0
-                to_match = separator[match_idx].chr
-                break
-              end
-            end
-          end
-        end
-        result
+        read_to_string(separator, length)
       else
-        result = ''
-        len = 0
-        while char = getc
-          result << char
-          len += 1
-          break if char == separator || (length ? len >= length : false)
-        end
-        result
+        read_to_character(separator, length)
       end
     end
 
@@ -286,6 +252,7 @@ module Mongo
       return read_all unless block_given?
       while chunk = read(chunk_size)
         yield chunk
+        break if chunk.empty?
       end
       self
     end
@@ -307,7 +274,7 @@ module Mongo
     end
 
     def save_chunk(chunk)
-      @chunks.insert(chunk)
+      @chunks.save(chunk)
     end
 
     def get_chunk(n)
@@ -316,21 +283,18 @@ module Mongo
       chunk
     end
 
-    def last_chunk_number
-      (@file_length / @chunk_size).to_i
-    end
-
     # Read a file in its entirety.
     def read_all
       buf = ''
       if @current_chunk
         buf << @current_chunk['data'].to_s
-        while chunk = get_chunk(@current_chunk['n'] + 1)
-          buf << chunk['data'].to_s
-          @current_chunk = chunk
+        while buf.size < @file_length
+          @current_chunk = get_chunk(@current_chunk['n'] + 1)
+          break if @current_chunk.nil?
+          buf << @current_chunk['data'].to_s
         end
+        @file_position = @file_length
       end
-      @file_position = @file_length
       buf
     end
 
@@ -361,6 +325,48 @@ module Mongo
       buf
     end
 
+    def read_to_character(character="\n", length=nil)
+      result = ''
+      len = 0
+      while char = getc
+        result << char
+        len += 1
+        break if char == character || (length ? len >= length : false)
+      end
+      result.length > 0 ? result : nil
+    end
+
+    def read_to_string(string="\n", length=nil)
+      result = ''
+      len = 0
+      match_idx = 0
+      match_num = string.length - 1
+      to_match = string[match_idx].chr
+      if length
+        matcher = lambda {|idx, num| idx < num && len < length }
+      else
+        matcher = lambda {|idx, num| idx < num}
+      end
+      while matcher.call(match_idx, match_num) && char = getc
+        result << char
+        len += 1
+        if char == to_match
+          while match_idx < match_num do
+            match_idx += 1
+            to_match = string[match_idx].chr
+            char = getc
+            result << char
+            if char != to_match
+              match_idx = 0
+              to_match = string[match_idx].chr
+              break
+            end
+          end
+        end
+      end
+      result.length > 0 ? result : nil
+    end
+
     def cache_chunk_data
       @current_chunk_data = @current_chunk['data'].to_s
       if @current_chunk_data.respond_to?(:force_encoding)
@@ -413,6 +419,7 @@ module Mongo
 
     # Initialize the class for writing a file.
     def init_write(opts)
+      opts           = opts.dup
       @files_id      = opts.delete(:_id) || BSON::ObjectId.new
       @content_type  = opts.delete(:content_type) || (defined? MIME) && get_content_type || DEFAULT_CONTENT_TYPE
       @chunk_size    = opts.delete(:chunk_size) || DEFAULT_CHUNK_SIZE
@@ -420,7 +427,7 @@ module Mongo
       @aliases       = opts.delete(:aliases)
       @file_length   = 0
       opts.each {|k, v| self[k] = v}
-      check_existing_file if @safe
+      check_existing_file if Mongo::WriteConcern.gle?(@write_concern)
 
       @current_chunk = create_chunk(0)
       @file_position = 0
@@ -447,15 +454,17 @@ module Mongo
       h
     end
 
-    # Get a server-side md5 and validate against the client if running in safe mode.
+    # Get a server-side md5 and validate against the client if running with acknowledged writes
     def get_md5
       md5_command            = BSON::OrderedHash.new
       md5_command['filemd5'] = @files_id
       md5_command['root']    = @fs_name
       @server_md5 = @files.db.command(md5_command)['md5']
-      if @safe
+      if Mongo::WriteConcern.gle?(@write_concern)
         @client_md5 = @local_md5.hexdigest
-        if @local_md5 != @server_md5
+        if @local_md5 == @server_md5
+          @server_md5
+        else
           raise GridMD5Failure, "File on server failed MD5 check"
         end
       else

data/lib/mongo/gridfs.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/gridfs/grid_ext'
+require 'mongo/gridfs/grid'
+require 'mongo/gridfs/grid_file_system'
+require 'mongo/gridfs/grid_io'

data/lib/mongo/legacy.rb

@@ -0,0 +1,140 @@
+# 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 LegacyWriteConcern
+    @legacy_write_concern = true
+
+    def safe=(value)
+      @write_concern = value
+    end
+
+    def safe
+      if @write_concern[:w] == 0
+        return false
+      elsif @write_concern[:w] == 1
+        return true
+      else
+        return @write_concern
+      end
+    end
+
+    def self.from_uri(uri = ENV['MONGODB_URI'], extra_opts={})
+      parser = URIParser.new uri
+      parser.connection(extra_opts, true)
+    end
+  end
+end
+
+module Mongo
+  # @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
+
+    def initialize(*args)
+      if args.last.is_a?(Hash)
+        opts = args.pop
+        write_concern_from_legacy(opts)
+        args.push(opts)
+      end
+      super
+    end
+  end
+
+  # @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
+
+    def initialize(*args)
+      if args.last.is_a?(Hash)
+        opts = args.pop
+        write_concern_from_legacy(opts)
+        args.push(opts)
+      end
+      super
+    end
+  end
+
+  # @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
+
+    def initialize(*args)
+      if args.last.is_a?(Hash)
+        opts = args.pop
+        write_concern_from_legacy(opts)
+        args.push(opts)
+      end
+      super
+    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
+    # Authentication of sockets is handled upon checkout and checkin.
+    def authenticate_pools
+    end
+
+    # @deprecated This method is no longer in use and never needs to be called
+    #   directly. Support will be removed after v2.0
+    # Authentication of sockets is handled upon checkout and checkin.
+    def logout_pools(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
+    # Authentication of sockets is handled upon checkout and checkin.
+    def authenticate_pools
+    end
+
+    # @deprecated This method is no longer in use and never needs to be called
+    #   directly. Support will be removed after v2.0
+    # Authentication of sockets is handled upon checkout and checkin.
+    def logout_pools(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