dsturnbull-carrierwave 0.4.5

data/lib/carrierwave/sanitized_file.rb

@@ -0,0 +1,268 @@
+# encoding: utf-8
+
+require 'pathname'
+
+module CarrierWave
+
+  ##
+  # SanitizedFile is a base class which provides a common API around all
+  # the different quirky Ruby File libraries. It has support for Tempfile,
+  # File, StringIO, Merb-style upload Hashes, as well as paths given as
+  # Strings and Pathnames.
+  #
+  # It's probably needlessly comprehensive and complex. Help is appreciated.
+  #
+  class SanitizedFile
+
+    attr_accessor :file
+
+    def initialize(file)
+      self.file = file
+    end
+
+    ##
+    # Returns the filename as is, without sanizting it.
+    #
+    # === Returns
+    #
+    # [String] the unsanitized filename
+    #
+    def original_filename
+      return @original_filename if @original_filename
+      if @file and @file.respond_to?(:original_filename)
+        @file.original_filename
+      elsif path
+        File.basename(path)
+      end
+    end
+
+    ##
+    # Returns the filename, sanitized to strip out any evil characters.
+    #
+    # === Returns
+    #
+    # [String] the sanitized filename
+    #
+    def filename
+      sanitize(original_filename) if original_filename
+    end
+
+    alias_method :identifier, :filename
+
+    ##
+    # Returns the part of the filename before the extension. So if a file is called 'test.jpeg'
+    # this would return 'test'
+    #
+    # === Returns
+    #
+    # [String] the first part of the filename
+    #
+    def basename
+      split_extension(filename)[0] if filename
+    end
+
+    ##
+    # Returns the file extension
+    #
+    # === Returns
+    #
+    # [String] the extension
+    #
+    def extension
+      split_extension(filename)[1] if filename
+    end
+
+    ##
+    # Returns the file's size.
+    #
+    # === Returns
+    #
+    # [Integer] the file's size in bytes.
+    #
+    def size
+      if is_path?
+        exists? ? File.size(path) : 0
+      elsif @file.respond_to?(:size)
+        @file.size
+      elsif path
+        exists? ? File.size(path) : 0
+      else
+        0
+      end
+    end
+
+    ##
+    # Returns the full path to the file. If the file has no path, it will return nil.
+    #
+    # === Returns
+    #
+    # [String, nil] the path where the file is located.
+    #
+    def path
+      unless @file.blank?
+        if is_path?
+          File.expand_path(@file)
+        elsif @file.respond_to?(:path) and not @file.path.blank?
+          File.expand_path(@file.path)
+        end
+      end
+    end
+
+    ##
+    # === Returns
+    #
+    # [Boolean] whether the file is supplied as a pathname or string.
+    #
+    def is_path?
+      !!((@file.is_a?(String) || @file.is_a?(Pathname)) && !@file.blank?)
+    end
+
+    ##
+    # === Returns
+    #
+    # [Boolean] whether the file is valid and has a non-zero size
+    #
+    def empty?
+      @file.nil? || self.size.nil? || self.size.zero?
+    end
+
+    alias_method :blank?, :empty?
+
+    ##
+    # === Returns
+    #
+    # [Boolean] Whether the file exists
+    #
+    def exists?
+      return File.exists?(self.path) if self.path
+      return false
+    end
+
+    ##
+    # Returns the contents of the file.
+    #
+    # === Returns
+    #
+    # [String] contents of the file
+    #
+    def read
+      if is_path?
+        File.read(@file)
+      else
+        @file.rewind if @file.respond_to?(:rewind)
+        @file.read
+      end
+    end
+
+    ##
+    # Moves the file to the given path
+    #
+    # === Parameters
+    #
+    # [new_path (String)] The path where the file should be moved.
+    # [permissions (Integer)] permissions to set on the file in its new location.
+    #
+    def move_to(new_path, permissions=nil)
+      return if self.empty?
+      new_path = File.expand_path(new_path)
+
+      mkdir!(new_path)
+      if exists?
+        FileUtils.mv(path, new_path) unless new_path == path
+      else
+        File.open(new_path, "wb") { |f| f.write(read) }
+      end
+      chmod!(new_path, permissions)
+      self.file = new_path
+    end
+
+    ##
+    # Creates a copy of this file and moves it to the given path. Returns the copy.
+    #
+    # === Parameters
+    #
+    # [new_path (String)] The path where the file should be copied to.
+    # [permissions (Integer)] permissions to set on the copy
+    #
+    # === Returns
+    #
+    # @return [CarrierWave::SanitizedFile] the location where the file will be stored.
+    #
+    def copy_to(new_path, permissions=nil)
+      return if self.empty?
+      new_path = File.expand_path(new_path)
+
+      mkdir!(new_path)
+      if exists?
+        FileUtils.cp(path, new_path) unless new_path == path
+      else
+        File.open(new_path, "wb") { |f| f.write(read) }
+      end
+      chmod!(new_path, permissions)
+      self.class.new(new_path)
+    end
+
+    ##
+    # Removes the file from the filesystem.
+    #
+    def delete
+      FileUtils.rm(self.path) if exists?
+    end
+
+    ##
+    # Returns the content type of the file.
+    #
+    # === Returns
+    #
+    # [String] the content type of the file
+    #
+    def content_type
+      return @content_type if @content_type
+      @file.content_type.chomp if @file.respond_to?(:content_type) and @file.content_type
+    end
+
+  private
+
+    def file=(file)
+      if file.is_a?(Hash)
+        @file = file["tempfile"] || file[:tempfile]
+        @original_filename = file["filename"] || file[:filename]
+        @content_type = file["content_type"] || file[:content_type]
+      else
+        @file = file
+        @original_filename = nil
+        @content_type = nil
+      end
+    end
+
+    # create the directory if it doesn't exist
+    def mkdir!(path)
+      FileUtils.mkdir_p(File.dirname(path)) unless File.exists?(File.dirname(path))
+    end
+
+    def chmod!(path, permissions)
+      File.chmod(permissions, path) if permissions
+    end
+
+    # Sanitize the filename, to prevent hacking
+    def sanitize(name)
+      File.basename(name.gsub(/\000/, '').gsub(/\//, '_').gsub("\\", "/"))
+    end
+
+    def split_extension(filename)
+      # regular expressions to try for identifying extensions
+      extension_matchers = [
+        /\A(.+)\.(tar\.gz)\z/, # matches "something.tar.gz"
+        /\A(.+)\.([^\.]+)\z/ # matches "something.jpg"
+      ]
+
+      extension_matchers.each do |regexp|
+        if filename =~ regexp
+          return $1, $2
+        end
+      end
+      return filename, "" # In case we weren't able to split the extension
+    end
+
+  end # SanitizedFile
+end # CarrierWave

data/lib/carrierwave/storage/abstract.rb

@@ -0,0 +1,30 @@
+# encoding: utf-8
+
+module CarrierWave
+  module Storage
+
+    ##
+    # This file serves mostly as a specification for Storage engines. There is no requirement
+    # that storage engines must be a subclass of this class.
+    #
+    class Abstract
+
+      attr_reader :uploader
+
+      def initialize(uploader)
+        @uploader = uploader
+      end
+
+      def identifier
+        uploader.filename
+      end
+
+      def store!(file)
+      end
+
+      def retrieve!(identifier)
+      end
+
+    end # Abstract
+  end # Storage
+end # CarrierWave

data/lib/carrierwave/storage/file.rb

@@ -0,0 +1,48 @@
+# encoding: utf-8
+
+module CarrierWave
+  module Storage
+
+    ##
+    # File storage stores file to the Filesystem (surprising, no?). There's really not much
+    # to it, it uses the store_dir defined on the uploader as the storage location. That's
+    # pretty much it.
+    #
+    class File < Abstract
+
+      ##
+      # Move the file to the uploader's store path.
+      #
+      # === Parameters
+      #
+      # [file (CarrierWave::SanitizedFile)] the file to store
+      #
+      # === Returns
+      #
+      # [CarrierWave::SanitizedFile] a sanitized file
+      #
+      def store!(file)
+        path = ::File.expand_path(uploader.store_path, uploader.root)
+        file.move_to(path, uploader.permissions)
+        file
+      end
+
+      ##
+      # Retrieve the file from its store path
+      #
+      # === Parameters
+      #
+      # [identifier (String)] the filename of the file
+      #
+      # === Returns
+      #
+      # [CarrierWave::SanitizedFile] a sanitized file
+      #
+      def retrieve!(identifier)
+        path = ::File.expand_path(uploader.store_path(identifier), uploader.root)
+        CarrierWave::SanitizedFile.new(path)
+      end
+
+    end # File
+  end # Storage
+end # CarrierWave

data/lib/carrierwave/storage/grid_fs.rb

@@ -0,0 +1,96 @@
+# encoding: utf-8
+require 'mongo'
+require 'mongo/gridfs'
+
+module CarrierWave
+  module Storage
+
+    ##
+    # The GridFS store uses MongoDB's GridStore file storage system to store files
+    #
+    class GridFS < Abstract
+
+      class File
+
+        def initialize(uploader, database, path)
+          @database = database
+          @path = path
+          @uploader = uploader
+        end
+
+        def path
+          nil
+        end
+
+        def url
+          unless @uploader.grid_fs_access_url
+            nil
+          else
+            [@uploader.grid_fs_access_url, @path].join("/")
+          end
+        end
+
+        def read
+          ::GridFS::GridStore.read(@database, @path)
+        end
+
+        def delete
+          ::GridFS::GridStore.unlink(@database, @path)
+        end
+
+        def content_type
+          ::GridFS::GridStore.open(@database, @path, 'r') { |f| return f.content_type }
+        end
+
+      end
+
+      ##
+      # Store the file in MongoDB's GridFS GridStore
+      #
+      # === Parameters
+      #
+      # [file (CarrierWave::SanitizedFile)] the file to store
+      #
+      # === Returns
+      #
+      # [CarrierWave::SanitizedFile] a sanitized file
+      #
+      def store!(file)
+        ::GridFS::GridStore.open(database, uploader.store_path, 'w', :content_type => file.content_type) do |f|
+          f.write file.read
+        end
+        CarrierWave::Storage::GridFS::File.new(uploader, database, uploader.store_path)
+      end
+
+      ##
+      # Retrieve the file from MongoDB's GridFS GridStore
+      #
+      # === Parameters
+      #
+      # [identifier (String)] the filename of the file
+      #
+      # === Returns
+      #
+      # [CarrierWave::Storage::GridFS::File] a sanitized file
+      #
+      def retrieve!(identifier)
+        CarrierWave::Storage::GridFS::File.new(uploader, database, uploader.store_path(identifier))
+      end
+
+    private
+
+      def database
+        @connection ||= begin
+          host = uploader.grid_fs_host
+          database = uploader.grid_fs_database
+          username = uploader.grid_fs_username
+          password = uploader.grid_fs_password
+          db = Mongo::Connection.new(host).db(database)
+          db.authenticate(username, password) if username && password
+          db
+        end
+      end
+
+    end # File
+  end # Storage
+end # CarrierWave

data/lib/carrierwave/storage/right_s3.rb

@@ -0,0 +1,170 @@
+# encoding: utf-8
+require 'right_aws'
+
+module CarrierWave
+  module Storage
+
+    ##
+    # Uploads things to Amazon S3 webservices using the RightAWS libraries (right_aws gem). 
+    # In order for CarrierWave to connect to Amazon S3, you'll need to specify an access key id, secret key
+    # and bucket
+    #
+    #     CarrierWave.configure do |config|
+    #       config.s3_access_key_id = "xxxxxx"
+    #       config.s3_secret_access_key = "xxxxxx"
+    #       config.s3_bucket = "my_bucket_name"
+    #     end
+    #
+    # The RightAWS::S3Interface is used directly as opposed to the normal RightAWS::S3::Bucket et.al. classes.
+    # This gives much improved performance and avoids unnecessary requests.
+    #
+    # You can set the access policy for the uploaded files:
+    #
+    #     CarrierWave.configure do |config|
+    #       config.s3_access_policy = 'public-read'
+    #     end
+    #
+    # The default is 'public-read'. For more options see:
+    #
+    # http://docs.amazonwebservices.com/AmazonS3/latest/RESTAccessPolicy.html#RESTCannedAccessPolicies
+    #
+    # You can change the generated url to a cnamed domain by setting the cnamed config:
+    #
+    #     CarrierWave.configure do |config|
+    #       config.s3_cnamed = true
+    #       config.s3_bucket = 'bucketname.domain.tld'
+    #     end
+    #
+    # Now the resulting url will be
+    #     
+    #     http://bucketname.domain.tld/path/to/file
+    #
+    # instead of
+    #
+    #     http://bucketname.domain.tld.s3.amazonaws.com/path/to/file
+    #
+    class RightS3 < Abstract
+
+      class File
+
+        def initialize(uploader, base, path)
+          @uploader = uploader
+          @path = path
+          @base = base
+        end
+
+        ##
+        # Returns the current path of the file on S3
+        #
+        # === Returns
+        #
+        # [String] A path
+        #
+        def path
+          @path
+        end
+
+        ##
+        # Reads the contents of the file from S3
+        #
+        # === Returns
+        #
+        # [String] contents of the file
+        #
+        def read
+          result = connection.get(bucket, @path)
+          @headers = result[:headers]
+          result[:object]
+        end
+
+        ##
+        # Remove the file from Amazon S3
+        #
+        def delete
+          connection.delete(bucket, @path)
+        end
+
+        ##
+        # Returns the url on Amazon's S3 service
+        #
+        # === Returns
+        #
+        # [String] file's url
+        #
+        def url
+          if @uploader.s3_cnamed
+            ["http://", @uploader.s3_bucket, @path].compact.join('/')
+          else
+            ["http://#{@uploader.s3_bucket}.s3.amazonaws.com", @path].compact.join('/')
+          end
+        end
+
+        def content_type
+          headers["content-type"]
+        end
+
+        #def content_disposition
+        #  s3_object.content_disposition
+        #end
+
+        def store(file)
+          connection.put(bucket, @path, file.read,
+            'x-amz-acl' => @uploader.s3_access_policy,
+            'content-type' => file.content_type
+          )
+        end
+
+      private
+      
+        def headers
+          @headers ||= {}
+        end
+
+        def bucket
+          @uploader.s3_bucket
+        end
+
+        def connection
+          @base.connection
+        end
+
+      end
+
+      ##
+      # Store the file on S3
+      #
+      # === Parameters
+      #
+      # [file (CarrierWave::SanitizedFile)] the file to store
+      #
+      # === Returns
+      #
+      # [CarrierWave::Storage::RightS3::File] the stored file
+      #
+      def store!(file)
+        f = CarrierWave::Storage::RightS3::File.new(uploader, self, uploader.store_path)
+        f.store(file)
+        f
+      end
+
+      # Do something to retrieve the file
+      #
+      # @param [String] identifier uniquely identifies the file
+      #
+      # [identifier (String)] uniquely identifies the file
+      #
+      # === Returns
+      #
+      # [CarrierWave::Storage::RightS3::File] the stored file
+      #
+      def retrieve!(identifier)
+        CarrierWave::Storage::RightS3::File.new(uploader, self, uploader.store_path(identifier))
+      end
+
+      def connection
+        @connection ||= RightAws::S3Interface.new(uploader.s3_access_key_id, uploader.s3_secret_access_key)
+      end
+
+    end # RightS3
+  end # Storage
+end # CarrierWave