carrierwave 0.10.0 → 1.2.0

data/lib/carrierwave/uploader/configuration.rb

@@ -5,7 +5,7 @@ module CarrierWave
       extend ActiveSupport::Concern
 
       included do
-        class_attribute :_storage, :instance_writer => false
+        class_attribute :_storage, :_cache_storage, :instance_writer => false
 
         add_config :root
         add_config :base_path
@@ -23,12 +23,14 @@ module CarrierWave
         add_config :remove_previously_stored_files_after_update
 
         # fog
+        add_config :fog_provider
         add_config :fog_attributes
         add_config :fog_credentials
         add_config :fog_directory
         add_config :fog_public
         add_config :fog_authenticated_url_expiration
         add_config :fog_use_ssl_for_aws
+        add_config :fog_aws_accelerate
 
         # Mounting
         add_config :ignore_integrity_errors
@@ -38,6 +40,7 @@ module CarrierWave
         add_config :validate_processing
         add_config :validate_download
         add_config :mount_on
+        add_config :cache_only
 
         # set default values
         reset_config
@@ -69,17 +72,55 @@ module CarrierWave
         #     storage MyCustomStorageEngine
         #
         def storage(storage = nil)
-          if storage
-            self._storage = storage.is_a?(Symbol) ? eval(storage_engines[storage]) : storage
+          case storage
+          when Symbol
+            if storage_engine = storage_engines[storage]
+              self._storage = eval storage_engine
+            else
+              raise CarrierWave::UnknownStorageError, "Unknown storage: #{storage}"
+            end
+          when nil
+            storage
+          else
+            self._storage = storage
           end
           _storage
         end
         alias_method :storage=, :storage
 
+        ##
+        # Sets the cache storage engine to be used when storing cache files with this uploader.
+        # Same as .storage except for required methods being #cache!(CarrierWave::SanitizedFile),
+        # #retrieve_from_cache! and #delete_dir!.
+        #
+        # === Parameters
+        #
+        # [storage (Symbol, Class)] The cache storage engine to use for this uploader
+        #
+        # === Returns
+        #
+        # [Class] the cache storage engine to be used with this uploader
+        #
+        # === Examples
+        #
+        #     cache_storage :file
+        #     cache_storage CarrierWave::Storage::File
+        #     cache_storage MyCustomStorageEngine
+        #
+        def cache_storage(storage = nil)
+          if storage
+            self._cache_storage = storage.is_a?(Symbol) ? eval(storage_engines[storage]) : storage
+          end
+          _cache_storage
+        end
+        alias_method :cache_storage=, :cache_storage
+
         def add_config(name)
           class_eval <<-RUBY, __FILE__, __LINE__ + 1
             def self.eager_load_fog(fog_credentials)
               # see #1198. This will hopefully no longer be necessary after fog 2.0
+              require self.fog_provider
+              require 'carrierwave/storage/fog'
               Fog::Storage.new(fog_credentials) if fog_credentials.present?
             end
 
@@ -88,17 +129,17 @@ module CarrierWave
               eager_load_fog(value) if value && '#{name}' == 'fog_credentials'
               return @#{name} if self.object_id == #{self.object_id} || defined?(@#{name})
               name = superclass.#{name}
-              return nil if name.nil? && !instance_variable_defined?("@#{name}")
+              return nil if name.nil? && !instance_variable_defined?(:@#{name})
               @#{name} = name && !name.is_a?(Module) && !name.is_a?(Symbol) && !name.is_a?(Numeric) && !name.is_a?(TrueClass) && !name.is_a?(FalseClass) ? name.dup : name
             end
 
             def self.#{name}=(value)
-              eager_load_fog(value) if '#{name}' == 'fog_credentials'
+              eager_load_fog(value) if '#{name}' == 'fog_credentials' && value.present?
               @#{name} = value
             end
 
             def #{name}=(value)
-              self.class.eager_load_fog(value) if '#{name}' == 'fog_credentials'
+              self.class.eager_load_fog(value) if '#{name}' == 'fog_credentials' && value.present?
               @#{name} = value
             end
 
@@ -107,7 +148,7 @@ module CarrierWave
               value = self.class.#{name} unless instance_variable_defined?(:@#{name})
               if value.instance_of?(Proc)
                 value.arity >= 1 ? value.call(self) : value.call
-              else 
+              else
                 value
               end
             end
@@ -130,11 +171,14 @@ module CarrierWave
               :fog  => "CarrierWave::Storage::Fog"
             }
             config.storage = :file
+            config.cache_storage = :file
+            config.fog_provider = 'fog'
             config.fog_attributes = {}
             config.fog_credentials = {}
             config.fog_public = true
             config.fog_authenticated_url_expiration = 600
             config.fog_use_ssl_for_aws = true
+            config.fog_aws_accelerate = false
             config.store_dir = 'uploads'
             config.cache_dir = 'uploads/tmp'
             config.delete_tmp_file_after_storage = true
@@ -158,4 +202,3 @@ module CarrierWave
     end
   end
 end
-

data/lib/carrierwave/uploader/content_type_blacklist.rb

@@ -0,0 +1,48 @@
+module CarrierWave
+  module Uploader
+    module ContentTypeBlacklist
+      extend ActiveSupport::Concern
+
+      included do
+        before :cache, :check_content_type_blacklist!
+      end
+
+      ##
+      # Override this method in your uploader to provide a blacklist of files content types
+      # which are not allowed to be uploaded.
+      # Not only strings but Regexp are allowed as well.
+      #
+      # === Returns
+      #
+      # [NilClass, String, Regexp, Array[String, Regexp]] a blacklist of content types which are not allowed to be uploaded
+      #
+      # === Examples
+      #
+      #     def content_type_blacklist
+      #       %w(text/json application/json)
+      #     end
+      #
+      # Basically the same, but using a Regexp:
+      #
+      #     def content_type_blacklist
+      #       [/(text|application)\/json/]
+      #     end
+      #
+      def content_type_blacklist; end
+
+    private
+
+      def check_content_type_blacklist!(new_file)
+        content_type = new_file.content_type
+        if content_type_blacklist && blacklisted_content_type?(content_type)
+          raise CarrierWave::IntegrityError, I18n.translate(:"errors.messages.content_type_blacklist_error", content_type: content_type)
+        end
+      end
+
+      def blacklisted_content_type?(content_type)
+        Array(content_type_blacklist).any? { |item| content_type =~ /#{item}/ }
+      end
+
+    end # ContentTypeBlacklist
+  end # Uploader
+end # CarrierWave

data/lib/carrierwave/uploader/content_type_whitelist.rb

@@ -0,0 +1,48 @@
+module CarrierWave
+  module Uploader
+    module ContentTypeWhitelist
+      extend ActiveSupport::Concern
+
+      included do
+        before :cache, :check_content_type_whitelist!
+      end
+
+      ##
+      # Override this method in your uploader to provide a whitelist of files content types
+      # which are allowed to be uploaded.
+      # Not only strings but Regexp are allowed as well.
+      #
+      # === Returns
+      #
+      # [NilClass, String, Regexp, Array[String, Regexp]] a whitelist of content types which are allowed to be uploaded
+      #
+      # === Examples
+      #
+      #     def content_type_whitelist
+      #       %w(text/json application/json)
+      #     end
+      #
+      # Basically the same, but using a Regexp:
+      #
+      #     def content_type_whitelist
+      #       [/(text|application)\/json/]
+      #     end
+      #
+      def content_type_whitelist; end
+
+    private
+
+      def check_content_type_whitelist!(new_file)
+        content_type = new_file.content_type
+        if content_type_whitelist && !whitelisted_content_type?(content_type)
+          raise CarrierWave::IntegrityError, I18n.translate(:"errors.messages.content_type_whitelist_error", content_type: content_type)
+        end
+      end
+
+      def whitelisted_content_type?(content_type)
+        Array(content_type_whitelist).any? { |item| content_type =~ /#{item}/ }
+      end
+
+    end # ContentTypeWhitelist
+  end # Uploader
+end # CarrierWave

data/lib/carrierwave/uploader/default_url.rb

@@ -1,19 +1,17 @@
-# encoding: utf-8
-
 module CarrierWave
   module Uploader
     module DefaultUrl
 
       def url(*args)
-        super || default_url
+        super || default_url(*args)
       end
 
       ##
       # Override this method in your uploader to provide a default url
       # in case no file has been cached/stored yet.
       #
-      def default_url; end
+      def default_url(*args); end
 
     end # DefaultPath
   end # Uploader
-end # CarrierWave
+end # CarrierWave

data/lib/carrierwave/uploader/download.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 require 'open-uri'
 
 module CarrierWave
@@ -12,12 +10,13 @@ module CarrierWave
       include CarrierWave::Uploader::Cache
 
       class RemoteFile
-        def initialize(uri)
+        def initialize(uri, remote_headers = {})
           @uri = uri
+          @remote_headers = remote_headers
         end
 
         def original_filename
-          filename = filename_from_header || File.basename(file.base_uri.path)
+          filename = filename_from_header || filename_from_uri
           mime_type = MIME::Types[file.content_type].first
           unless File.extname(filename).present? || mime_type.blank?
             filename = "#{filename}.#{mime_type.extensions.first}"
@@ -37,12 +36,15 @@ module CarrierWave
 
         def file
           if @file.blank?
-            @file = Kernel.open(@uri.to_s)
+            headers = @remote_headers.
+              reverse_merge('User-Agent' => "CarrierWave/#{CarrierWave::VERSION}")
+
+            @file = Kernel.open(@uri.to_s, headers)
             @file = @file.is_a?(String) ? StringIO.new(@file) : @file
           end
           @file
 
-        rescue Exception => e
+        rescue StandardError => e
           raise CarrierWave::DownloadError, "could not download file: #{e.message}"
         end
 
@@ -53,6 +55,10 @@ module CarrierWave
           end
         end
 
+        def filename_from_uri
+          URI.decode(File.basename(file.base_uri.path))
+        end
+
         def method_missing(*args, &block)
           file.send(*args, &block)
         end
@@ -64,10 +70,11 @@ module CarrierWave
       # === Parameters
       #
       # [url (String)] The URL where the remote file is stored
+      # [remote_headers (Hash)] Request headers
       #
-      def download!(uri)
+      def download!(uri, remote_headers = {})
         processed_uri = process_uri(uri)
-        file = RemoteFile.new(processed_uri)
+        file = RemoteFile.new(processed_uri, remote_headers)
         raise CarrierWave::DownloadError, "trying to download a file which is not served over HTTP" unless file.http?
         cache!(file)
       end

data/lib/carrierwave/uploader/extension_blacklist.rb

@@ -4,7 +4,7 @@ module CarrierWave
       extend ActiveSupport::Concern
 
       included do
-        before :cache, :check_blacklist!
+        before :cache, :check_extension_blacklist!
       end
 
       ##
@@ -16,32 +16,36 @@ module CarrierWave
       # the Regexp expression, also case insensitive.
       #
       # === Returns
-      
-      # [NilClass, Array[String,Regexp]] a black list of extensions which are prohibited to be uploaded
+
+      # [NilClass, String, Regexp, Array[String, Regexp]] a black list of extensions which are prohibited to be uploaded
       #
       # === Examples
       #
-      #     def extension_black_list
+      #     def extension_blacklist
       #       %w(swf tiff)
       #     end
       #
       # Basically the same, but using a Regexp:
       #
-      #     def extension_black_list
+      #     def extension_blacklist
       #       [/swf/, 'tiff']
       #     end
       #
- 
-      def extension_black_list; end
+
+      def extension_blacklist; end
 
     private
 
-      def check_blacklist!(new_file)
+      def check_extension_blacklist!(new_file)
         extension = new_file.extension.to_s
-        if extension_black_list and extension_black_list.detect { |item| extension =~ /\A#{item}\z/i }
-          raise CarrierWave::IntegrityError, I18n.translate(:"errors.messages.extension_black_list_error", :extension => new_file.extension.inspect, :prohibited_types => extension_black_list.join(", "))
+        if extension_blacklist && blacklisted_extension?(extension)
+          raise CarrierWave::IntegrityError, I18n.translate(:"errors.messages.extension_blacklist_error", extension: new_file.extension.inspect, prohibited_types: Array(extension_blacklist).join(", "))
         end
       end
+
+      def blacklisted_extension?(extension)
+        Array(extension_blacklist).any? { |item| extension =~ /\A#{item}\z/i }
+      end
     end
   end
 end

data/lib/carrierwave/uploader/extension_whitelist.rb

@@ -1,12 +1,10 @@
-# encoding: utf-8
-
 module CarrierWave
   module Uploader
     module ExtensionWhitelist
       extend ActiveSupport::Concern
 
       included do
-        before :cache, :check_whitelist!
+        before :cache, :check_extension_whitelist!
       end
 
       ##
@@ -19,31 +17,36 @@ module CarrierWave
       #
       # === Returns
       #
-      # [NilClass, Array[String,Regexp]] a white list of extensions which are allowed to be uploaded
+      # [NilClass, String, Regexp, Array[String, Regexp]] a white list of extensions which are allowed to be uploaded
       #
       # === Examples
       #
-      #     def extension_white_list
+      #     def extension_whitelist
       #       %w(jpg jpeg gif png)
       #     end
       #
       # Basically the same, but using a Regexp:
       #
-      #     def extension_white_list
+      #     def extension_whitelist
       #       [/jpe?g/, 'gif', 'png']
       #     end
       #
-      def extension_white_list; end
+      def extension_whitelist; end
 
     private
 
-      def check_whitelist!(new_file)
+      def check_extension_whitelist!(new_file)
         extension = new_file.extension.to_s
-        if extension_white_list and not extension_white_list.detect { |item| extension =~ /\A#{item}\z/i }
-          raise CarrierWave::IntegrityError, I18n.translate(:"errors.messages.extension_white_list_error", :extension => new_file.extension.inspect, :allowed_types => extension_white_list.join(", "))
+        if extension_whitelist && !whitelisted_extension?(extension)
+          raise CarrierWave::IntegrityError, I18n.translate(:"errors.messages.extension_whitelist_error", extension: new_file.extension.inspect, allowed_types: Array(extension_whitelist).join(", "))
         end
       end
 
+      def whitelisted_extension?(extension)
+        downcase_extension = extension.downcase
+        Array(extension_whitelist).any? { |item| downcase_extension =~ /\A#{item}\z/i }
+      end
+
     end # ExtensionWhitelist
   end # Uploader
 end # CarrierWave

data/lib/carrierwave/uploader/file_size.rb

@@ -0,0 +1,43 @@
+require 'active_support'
+
+module CarrierWave
+  module Uploader
+    module FileSize
+      extend ActiveSupport::Concern
+
+      included do
+        before :cache, :check_size!
+      end
+
+      ##
+      # Override this method in your uploader to provide a Range of Size which
+      # are allowed to be uploaded.
+      # === Returns
+      #
+      # [NilClass, Range] a size range which are permitted to be uploaded
+      #
+      # === Examples
+      #
+      #     def size_range
+      #       3256...5748
+      #     end
+      #
+      def size_range; end
+
+      private
+
+      def check_size!(new_file)
+        size = new_file.size
+        expected_size_range = size_range
+        if expected_size_range.is_a?(::Range)
+          if size < expected_size_range.min
+            raise CarrierWave::IntegrityError, I18n.translate(:"errors.messages.min_size_error", :min_size => ActiveSupport::NumberHelper.number_to_human_size(expected_size_range.min))
+          elsif size > expected_size_range.max
+            raise CarrierWave::IntegrityError, I18n.translate(:"errors.messages.max_size_error", :max_size => ActiveSupport::NumberHelper.number_to_human_size(expected_size_range.max))
+          end
+        end
+      end
+
+    end # FileSize
+  end # Uploader
+end # CarrierWave

data/lib/carrierwave/uploader/magic_mime_blacklist.rb

@@ -0,0 +1,94 @@
+module CarrierWave
+  module Uploader
+
+    ##
+    # This modules validates the content type of a file with the use of
+    # ruby-filemagic gem and a blacklist regular expression. If you want
+    # to use this, you'll need to require this file:
+    #
+    #   require 'carrierwave/uploader/magic_mime_blacklist'
+    #
+    # And then include it in your uploader:
+    #
+    #   class MyUploader < CarrierWave::Uploader::Base
+    #     include CarrierWave::Uploader::MagicMimeBlacklist
+    #
+    #     def blacklist_mime_type_pattern
+    #       /image\//
+    #     end
+    #   end
+    #
+    module MagicMimeBlacklist
+      extend ActiveSupport::Concern
+
+      included do
+        begin
+          require "filemagic"
+        rescue LoadError => e
+          e.message << " (You may need to install the ruby-filemagic gem)"
+          raise e
+        end
+
+        before :cache, :check_blacklist_pattern!
+      end
+
+      ##
+      # Override this method in your uploader to provide a black list pattern (regexp)
+      # of content-types which are prohibited to be uploaded.
+      # Compares the file's content-type.
+      #
+      # === Returns
+      #
+      # [Regexp] a black list regexp to match the content_type
+      #
+      # === Examples
+      #
+      #     def blacklist_mime_type_pattern
+      #       /(text|application)\/json/
+      #     end
+      #
+      def blacklist_mime_type_pattern; end
+
+    private
+
+      def check_blacklist_pattern!(new_file)
+        return if blacklist_mime_type_pattern.nil?
+
+        content_type = extract_content_type(new_file)
+
+        if content_type.match(blacklist_mime_type_pattern)
+          raise CarrierWave::IntegrityError,
+            I18n.translate(:"errors.messages.mime_type_pattern_black_list_error",
+                           :content_type => content_type)
+        end
+      end
+
+      ##
+      # Extracts the content type of the given file
+      #
+      # === Returns
+      #
+      # [String] the extracted content type
+      #
+      def extract_content_type(new_file)
+        content_type = nil
+
+        File.open(new_file.path) do |fd|
+          data = fd.read(1024) || ""
+          content_type = filemagic.buffer(data)
+        end
+
+        content_type
+      end
+
+    ##
+    # FileMagic object with the MAGIC_MIME_TYPE flag set
+    #
+    # @return [FileMagic] a filemagic object
+      def filemagic
+        @filemagic ||= FileMagic.new(FileMagic::MAGIC_MIME_TYPE)
+      end
+
+    end # MagicMimeblackList
+  end # Uploader
+end # CarrierWave

data/lib/carrierwave/uploader/magic_mime_whitelist.rb

@@ -0,0 +1,94 @@
+module CarrierWave
+  module Uploader
+
+    ##
+    # This modules validates the content type of a file with the use of
+    # ruby-filemagic gem and a whitelist regular expression. If you want
+    # to use this, you'll need to require this file:
+    #
+    #   require 'carrierwave/uploader/magic_mime_whitelist'
+    #
+    # And then include it in your uploader:
+    #
+    #   class MyUploader < CarrierWave::Uploader::Base
+    #     include CarrierWave::Uploader::MagicMimeWhitelist
+    #
+    #     def whitelist_mime_type_pattern
+    #       /image\//
+    #     end
+    #   end
+    #
+    module MagicMimeWhitelist
+      extend ActiveSupport::Concern
+
+      included do
+        begin
+          require "filemagic"
+        rescue LoadError => e
+          e.message << " (You may need to install the ruby-filemagic gem)"
+          raise e
+        end
+
+        before :cache, :check_whitelist_pattern!
+      end
+
+      ##
+      # Override this method in your uploader to provide a white list pattern (regexp)
+      # of content-types which are allowed to be uploaded.
+      # Compares the file's content-type.
+      #
+      # === Returns
+      #
+      # [Regexp] a white list regexp to match the content_type
+      #
+      # === Examples
+      #
+      #     def whitelist_mime_type_pattern
+      #       /(text|application)\/json/
+      #     end
+      #
+      def whitelist_mime_type_pattern; end
+
+    private
+
+      def check_whitelist_pattern!(new_file)
+        return if whitelist_mime_type_pattern.nil?
+
+        content_type = extract_content_type(new_file)
+
+        if !content_type.match(whitelist_mime_type_pattern)
+          raise CarrierWave::IntegrityError,
+            I18n.translate(:"errors.messages.mime_type_pattern_white_list_error",
+                           :content_type => content_type)
+        end
+      end
+
+      ##
+      # Extracts the content type of the given file
+      #
+      # === Returns
+      #
+      # [String] the extracted content type
+      #
+      def extract_content_type(new_file)
+        content_type = nil
+
+        File.open(new_file.path) do |fd|
+          data = fd.read(1024) || ""
+          content_type = filemagic.buffer(data)
+        end
+
+        content_type
+      end
+
+    ##
+    # FileMagic object with the MAGIC_MIME_TYPE flag set
+    #
+    # @return [FileMagic] a filemagic object
+      def filemagic
+        @filemagic ||= FileMagic.new(FileMagic::MAGIC_MIME_TYPE)
+      end
+
+    end # MagicMimeWhiteList
+  end # Uploader
+end # CarrierWave