mongo 2.0.6 → 2.1.0

data/lib/mongo/grid/fs_bucket.rb

@@ -0,0 +1,448 @@
+# Copyright (C) 2014-2015 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 Grid
+
+    # Represents a view of the GridFS in the database.
+    #
+    # @since 2.0.0
+    class FSBucket
+      extend Forwardable
+
+      # The default root prefix.
+      #
+      # @since 2.0.0
+      DEFAULT_ROOT = 'fs'.freeze
+
+      # The specification for the chunks collection index.
+      #
+      # @since 2.0.0
+      CHUNKS_INDEX = { :files_id => 1, :n => 1 }.freeze
+
+      # The specification for the files collection index.
+      #
+      # @since 2.1.0
+      FILES_INDEX = { filename: 1, uploadDate: 1 }.freeze
+
+      # @return [ Collection ] chunks_collection The chunks collection.
+      #
+      # @since 2.0.0
+      attr_reader :chunks_collection
+
+      # @return [ Database ] database The database.
+      #
+      # @since 2.0.0
+      attr_reader :database
+
+      # @return [ Collection ] files_collection The files collection.
+      #
+      # @since 2.0.0
+      attr_reader :files_collection
+
+      # @return [ Hash ] options The FSBucket options.
+      #
+      # @since 2.1.0
+      attr_reader :options
+
+      # Get client from the database.
+      #
+      # @since 2.1.0
+      def_delegators :database,
+                     :client
+
+      # Find files collection documents matching a given selector.
+      #
+      # @example Find files collection documents by a filename.
+      #   fs.find(filename: 'file.txt')
+      #
+      # @param [ Hash ] selector The selector to use in the find.
+      # @param [ Hash ] options The options for the find.
+      #
+      # @option options [ Integer ] :batch_size The number of documents returned in each batch
+      #   of results from MongoDB.
+      # @option options [ Integer ] :limit The max number of docs to return from the query.
+      # @option options [ true, false ] :no_cursor_timeout The server normally times out idle
+      #   cursors after an inactivity period (10 minutes) to prevent excess memory use.
+      #   Set this option to prevent that.
+      # @option options [ Integer ] :skip The number of docs to skip before returning results.
+      # @option options [ Hash ] :sort The key and direction pairs by which the result set
+      #   will be sorted.
+      #
+      # @return [ CollectionView ] The collection view.
+      #
+      # @since 2.1.0
+      def find(selector = nil, options = {})
+        files_collection.find(selector, options.merge(read: read_preference))
+      end
+
+      # Find a file in the GridFS.
+      #
+      # @example Find a file by its id.
+      #   fs.find_one(_id: id)
+      #
+      # @example Find a file by its filename.
+      #   fs.find_one(filename: 'test.txt')
+      #
+      # @param [ Hash ] selector The selector.
+      #
+      # @return [ Grid::File ] The file.
+      #
+      # @since 2.0.0
+      def find_one(selector = nil)
+        file_info = files_collection.find(selector).first
+        return nil unless file_info
+        chunks = chunks_collection.find(:files_id => file_info[:_id]).sort(:n => 1)
+        Grid::File.new(chunks.to_a, file_info)
+      end
+
+      # Insert a single file into the GridFS.
+      #
+      # @example Insert a single file.
+      #   fs.insert_one(file)
+      #
+      # @param [ Grid::File ] file The file to insert.
+      #
+      # @return [ BSON::ObjectId ] The file id.
+      #
+      # @since 2.0.0
+      def insert_one(file)
+        @indexes ||= ensure_indexes!
+        chunks_collection.insert_many(file.chunks)
+        files_collection.insert_one(file.info)
+        file.id
+      end
+
+      # Create the GridFS.
+      #
+      # @example Create the GridFS.
+      #   Grid::FSBucket.new(database)
+      #
+      # @param [ Database ] database The database the files reside in.
+      # @param [ Hash ] options The GridFS options.
+      #
+      # @option options [ String ] :fs_name The prefix for the files and chunks
+      #   collections.
+      # @option options [ String ] :bucket_name The prefix for the files and chunks
+      #   collections.
+      # @option options [ Integer ] :chunk_size Override the default chunk
+      #   size.
+      # @option options [ String ] :write The write concern.
+      # @option options [ String ] :read The read preference.
+      #
+      # @since 2.0.0
+      def initialize(database, options = {})
+        @database = database
+        @options = options
+        @chunks_collection = database[chunks_name]
+        @files_collection = database[files_name]
+      end
+
+      # Get the prefix for the GridFS
+      #
+      # @example Get the prefix.
+      #   fs.prefix
+      #
+      # @return [ String ] The GridFS prefix.
+      #
+      # @since 2.0.0
+      def prefix
+        @options[:fs_name] || @options[:bucket_name]|| DEFAULT_ROOT
+      end
+
+      # Remove a single file from the GridFS.
+      #
+      # @example Remove a file from the GridFS.
+      #   fs.delete_one(file)
+      #
+      # @param [ Grid::File ] file The file to remove.
+      #
+      # @return [ Result ] The result of the remove.
+      #
+      # @since 2.0.0
+      def delete_one(file)
+        delete(file.id)
+      end
+
+      # Remove a single file, identified by its id from the GridFS.
+      #
+      # @example Remove a file from the GridFS.
+      #   fs.delete(id)
+      #
+      # @param [ BSON::ObjectId, Object ] id The id of the file to remove.
+      #
+      # @return [ Result ] The result of the remove.
+      #
+      # @raise [ Error::FileNotFound ] If the file is not found.
+      #
+      # @since 2.1.0
+      def delete(id)
+        result = files_collection.find(:_id => id).delete_one
+        chunks_collection.find(:files_id => id).delete_many
+        raise Error::FileNotFound.new(id, :id) if result.n == 0
+        result
+      end
+
+      # Opens a stream from which a file can be downloaded, specified by id.
+      #
+      # @example Open a stream from which a file can be downloaded.
+      #   fs.open_download_stream(id)
+      #
+      # @param [ BSON::ObjectId, Object ] id The id of the file to read.
+      #
+      # @return [ Stream::Read ] The stream to read from.
+      #
+      # @yieldparam [ Hash ] The read stream.
+      #
+      # @since 2.1.0
+      def open_download_stream(id)
+        read_stream(id).tap do |stream|
+          if block_given?
+            yield stream
+            stream.close
+          end
+        end
+      end
+
+      # Downloads the contents of the file specified by id and writes them to
+      # the destination io object.
+      #
+      # @example Download the file and write it to the io object.
+      #   fs.download_to_stream(id, io)
+      #
+      # @param [ BSON::ObjectId, Object ] id The id of the file to read.
+      # @param [ IO ] io The io object to write to.
+      #
+      # @since 2.1.0
+      def download_to_stream(id, io)
+        open_download_stream(id) do |stream|
+          stream.each do |chunk|
+            io << chunk
+          end
+        end
+      end
+
+      # Opens a stream from which the application can read the contents of the stored file
+      # specified by filename and the revision in options.
+      #
+      # Revision numbers are defined as follows:
+      # 0 = the original stored file
+      # 1 = the first revision
+      # 2 = the second revision
+      # etc…
+      # -2 = the second most recent revision
+      # -1 = the most recent revision
+      #
+      # @example Open a stream to download the most recent revision.
+      #   fs.open_download_stream_by_name('some-file.txt')
+      #
+      # # @example Open a stream to download the original file.
+      #   fs.open_download_stream_by_name('some-file.txt', revision: 0)
+      #
+      # @example Open a stream to download the second revision of the stored file.
+      #   fs.open_download_stream_by_name('some-file.txt', revision: 2)
+      #
+      # @param [ String ] filename The file's name.
+      # @param [ Hash ] opts Options for the download.
+      #
+      # @option opts [ Integer ] :revision The revision number of the file to download.
+      #   Defaults to -1, the most recent version.
+      #
+      # @return [ Stream::Read ] The stream to read from.
+      #
+      # @raise [ Error::FileNotFound ] If the file is not found.
+      # @raise [ Error::InvalidFileRevision ] If the requested revision is not found for the file.
+      #
+      # @yieldparam [ Hash ] The read stream.
+      #
+      # @since 2.1.0
+      def open_download_stream_by_name(filename, opts = {}, &block)
+        revision = opts.fetch(:revision, -1)
+        if revision < 0
+          skip = revision.abs - 1
+          sort = { 'uploadDate' => Mongo::Index::DESCENDING }
+        else
+          skip = revision
+          sort = { 'uploadDate' => Mongo::Index::ASCENDING }
+        end
+        file_doc = files_collection.find({ filename: filename} ,
+                                           projection: { _id: 1 },
+                                           sort: sort,
+                                           skip: skip,
+                                           limit: -1).first
+        unless file_doc
+          raise Error::FileNotFound.new(filename, :filename) unless opts[:revision]
+          raise Error::InvalidFileRevision.new(filename, opts[:revision])
+        end
+        open_download_stream(file_doc[:_id], &block)
+      end
+
+      # Downloads the contents of the stored file specified by filename and by the
+      # revision in options and writes the contents to the destination io object.
+      #
+      # Revision numbers are defined as follows:
+      # 0 = the original stored file
+      # 1 = the first revision
+      # 2 = the second revision
+      # etc…
+      # -2 = the second most recent revision
+      # -1 = the most recent revision
+      #
+      # @example Download the most recent revision.
+      #   fs.download_to_stream_by_name('some-file.txt', io)
+      #
+      # # @example Download the original file.
+      #   fs.download_to_stream_by_name('some-file.txt', io, revision: 0)
+      #
+      # @example Download the second revision of the stored file.
+      #   fs.download_to_stream_by_name('some-file.txt', io, revision: 2)
+      #
+      # @param [ String ] filename The file's name.
+      # @param [ IO ] io The io object to write to.
+      # @param [ Hash ] opts Options for the download.
+      #
+      # @option opts [ Integer ] :revision The revision number of the file to download.
+      #   Defaults to -1, the most recent version.
+      #
+      # @raise [ Error::FileNotFound ] If the file is not found.
+      # @raise [ Error::InvalidFileRevision ] If the requested revision is not found for the file.
+      #
+      # @since 2.1.0
+      def download_to_stream_by_name(filename, io, opts = {})
+        download_to_stream(open_download_stream_by_name(filename, opts).file_id, io)
+      end
+
+      # Opens an upload stream to GridFS to which the contents of a user file came be written.
+      #
+      # @example Open a stream to which the contents of a file came be written.
+      #   fs.open_upload_stream('a-file.txt')
+      #
+      # @param [ String ] filename The filename of the file to upload.
+      # @param [ Hash ] opts The options for the write stream.
+      #
+      # @option opts [ Integer ] :chunk_size Override the default chunk size.
+      # @option opts [ Hash ] :write The write concern.
+      # @option opts [ Hash ] :metadata User data for the 'metadata' field of the files
+      #   collection document.
+      # @option opts [ String ] :content_type The content type of the file.
+      #   Deprecated, please use the metadata document instead.
+      # @option opts [ Array<String> ] :aliases A list of aliases.
+      #   Deprecated, please use the metadata document instead.
+      #
+      # @return [ Stream::Write ] The write stream.
+      #
+      # @yieldparam [ Hash ] The write stream.
+      #
+      # @since 2.1.0
+      def open_upload_stream(filename, opts = {})
+        write_stream(filename, opts).tap do |stream|
+          if block_given?
+            yield stream
+            stream.close
+          end
+        end
+      end
+
+      # Uploads a user file to a GridFS bucket.
+      # Reads the contents of the user file from the source stream and uploads it as chunks in the
+      # chunks collection. After all the chunks have been uploaded, it creates a files collection
+      # document for the filename in the files collection.
+      #
+      # @example Open a stream to which the contents of a file came be written.
+      #   fs.open_upload_stream('a-file.txt')
+      #
+      # @param [ String ] filename The filename of the file to upload.
+      # @param [ IO ] io The source io stream to upload from.
+      # @param [ Hash ] opts The options for the write stream.
+      #
+      # @option opts [ Integer ] :chunk_size Override the default chunk size.
+      # @option opts [ Hash ] :write The write concern.
+      # @option opts [ Hash ] :metadata User data for the 'metadata' field of the files
+      #   collection document.
+      # @option opts [ String ] :content_type The content type of the file. Deprecated, please
+      #   use the metadata document instead.
+      # @option opts [ Array<String> ] :aliases A list of aliases. Deprecated, please use the
+      #   metadata document instead.
+      #
+      # @return [ BSON::ObjectId ] The ObjectId file id.
+      #
+      # @since 2.1.0
+      def upload_from_stream(filename, io, opts = {})
+        open_upload_stream(filename, opts) do |stream|
+          begin
+            stream.write(io)
+          rescue IOError
+            begin
+              stream.abort
+            rescue Error::OperationFailure
+            end
+            raise
+          end
+        end.file_id
+      end
+
+      # Get the read preference.
+      #
+      # @example Get the read preference.
+      #   fs.read_preference
+      #
+      # @return [ Mongo::ServerSelector ] The read preference.
+      #
+      # @since 2.1.0
+      def read_preference
+        @read_preference ||= @options[:read] ?
+            ServerSelector.get(Options::Redacted.new((@options[:read] || {}).merge(client.options))) :
+            database.read_preference
+      end
+
+      # Get the write concern.
+      #
+      # @example Get the write concern.
+      #   stream.write_concern
+      #
+      # @return [ Mongo::WriteConcern ] The write concern.
+      #
+      # @since 2.1.0
+      def write_concern
+        @write_concern ||= @options[:write] ? WriteConcern.get(@options[:write]) :
+            database.write_concern
+      end
+
+      private
+
+      def read_stream(id)
+        Stream.get(self, Stream::READ_MODE, { file_id: id }.merge!(options))
+      end
+
+      def write_stream(filename, opts)
+        Stream.get(self, Stream::WRITE_MODE, { filename: filename }.merge!(options).merge!(opts))
+      end
+
+      def chunks_name
+        "#{prefix}.#{Grid::File::Chunk::COLLECTION}"
+      end
+
+      def files_name
+        "#{prefix}.#{Grid::File::Info::COLLECTION}"
+      end
+
+      def ensure_indexes!
+        if files_collection.find({}, projection: { _id: 1 }).to_a.empty?
+          chunks_collection.indexes.create_one(FSBucket::CHUNKS_INDEX, :unique => true)
+          files_collection.indexes.create_one(FSBucket::FILES_INDEX)
+        end
+      end
+    end
+  end
+end

data/lib/mongo/grid/stream/read.rb

@@ -0,0 +1,208 @@
+# Copyright (C) 2014-2015 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 Grid
+    class FSBucket
+
+      module Stream
+        # A stream that reads files from the FSBucket.
+        #
+        # @since 2.1.0
+        class Read
+          include Enumerable
+
+          # @return [ FSBucket ] fs The fs bucket from which this stream reads.
+          #
+          # @since 2.1.0
+          attr_reader :fs
+
+          # @return [ Hash ] options The stream options.
+          #
+          # @since 2.1.0
+          attr_reader :options
+
+          # @return [ BSON::ObjectId, Object ] file_id The id of the file being read.
+          #
+          # @since 2.1.0
+          attr_reader :file_id
+
+          # Create a stream for reading files from the FSBucket.
+          #
+          # @example Create the stream.
+          #   Stream::Read.new(fs, options)
+          #
+          # @param [ FSBucket ] fs The GridFS bucket object.
+          # @param [ Hash ] options The read stream options.
+          #
+          # @since 2.1.0
+          def initialize(fs, options)
+            @fs = fs
+            @options = options.dup
+            @file_id = @options.delete(:file_id)
+            @open = true
+          end
+
+          # Iterate through chunk data streamed from the FSBucket.
+          #
+          # @example Iterate through the chunk data.
+          #   stream.each do |data|
+          #     buffer << data
+          #   end
+          #
+          # @return [ Enumerator ] The enumerator.
+          #
+          # @raise [ Error::MissingFileChunk ] If a chunk is found out of sequence.
+          #
+          # @yieldparam [ Hash ] Each chunk of file data.
+          #
+          # @since 2.1.0
+          def each
+            ensure_readable!
+            num_chunks = (file_info.length + file_info.chunk_size - 1) / file_info.chunk_size
+            view.each_with_index.reduce(0) do |length_read, (doc, index)|
+              chunk = Grid::File::Chunk.new(doc)
+              validate!(index, num_chunks, chunk, length_read)
+              data = Grid::File::Chunk.assemble([ chunk ])
+              yield data
+              length_read += data.size
+            end if block_given?
+            view.to_enum
+          end
+
+          # Read all file data.
+          #
+          # @example Read the file data.
+          #   stream.read
+          #
+          # @return [ String ] The file data.
+          #
+          # @raise [ Error::MissingFileChunk ] If a chunk is found out of sequence.
+          #
+          # @since 2.1.0
+          def read
+            to_a.join
+          end
+
+          # Close the read stream.
+          #
+          # @example Close the stream.
+          #   stream.close
+          #
+          # @return [ BSON::ObjectId, Object ] The file id.
+          #
+          # @raise [ Error::ClosedStream ] If the stream is already closed.
+          #
+          # @since 2.1.0
+          def close
+            ensure_open!
+            view.close_query
+            @open = false
+            file_id
+          end
+
+          # Is the stream closed.
+          #
+          # @example Is the stream closd.
+          #   stream.closed?
+          #
+          # @return [ true, false ] Whether the stream is closed.
+          #
+          # @since 2.1.0
+          def closed?
+            !@open
+          end
+
+          # Get the read preference used when streaming.
+          #
+          # @example Get the read preference.
+          #   stream.read_preference
+          #
+          # @return [ Mongo::ServerSelector ] The read preference.
+          #
+          # @since 2.1.0
+          def read_preference
+            @read_preference ||= @options[:read] ?
+                ServerSelector.get(Options::Redacted.new((@options[:read] || {}).merge(fs.options))) :
+                fs.read_preference
+          end
+
+          # Get the files collection file information document for the file being read.
+          #
+          # @example Get the file info document.
+          #   stream.file_info
+          #
+          # @return [ Hash ] The file info document.
+          #
+          # @since 2.1.0
+          def file_info
+            doc = fs.files_collection.find(_id: file_id).first
+            if doc
+              @file_info ||= File::Info.new(Options::Mapper.transform(doc, File::Info::MAPPINGS.invert))
+            end
+          end
+
+          private
+
+          def ensure_open!
+            raise Error::ClosedStream.new if closed?
+          end
+
+          def ensure_file_info!
+            raise Error::FileNotFound.new(file_id, :id) unless file_info
+          end
+
+          def ensure_readable!
+            ensure_open!
+            ensure_file_info!
+          end
+
+          def view
+            @view ||= fs.chunks_collection.find({ :files_id => file_id }, options).read(read_preference).sort(:n => 1)
+          end
+
+          def validate!(index, num_chunks, chunk, length_read)
+            validate_n!(index, chunk)
+            validate_length!(index, num_chunks, chunk, length_read)
+          end
+
+          def raise_unexpected_chunk_length!(chunk)
+            close
+            raise Error::UnexpectedChunkLength.new(file_info.chunk_size, chunk)
+          end
+
+          def validate_length!(index, num_chunks, chunk, length_read)
+            if num_chunks > 0 && chunk.data.data.size > 0
+              raise Error::ExtraFileChunk.new unless index < num_chunks
+              if index == num_chunks - 1
+                unless chunk.data.data.size + length_read == file_info.length
+                  raise_unexpected_chunk_length!(chunk)
+                end
+              elsif chunk.data.data.size != file_info.chunk_size
+                raise_unexpected_chunk_length!(chunk)
+              end
+            end
+          end
+
+          def validate_n!(index, chunk)
+            unless index == chunk.n
+              close
+              raise Error::MissingFileChunk.new(index, chunk)
+            end
+          end
+        end
+      end
+    end
+  end
+end