carrierwave 3.0.0.beta → 3.0.0.rc

data/lib/carrierwave/mounter.rb

@@ -2,18 +2,49 @@ module CarrierWave
 
   # this is an internal class, used by CarrierWave::Mount so that
   # we don't pollute the model with a lot of methods.
-  class Mounter #:nodoc:
-    attr_reader :column, :record, :remote_urls, :integrity_errors,
-      :processing_errors, :download_errors
-    attr_accessor :remove, :remote_request_headers
+  class Mounter # :nodoc:
+    class Single < Mounter # :nodoc
+      def identifier
+        uploaders.first&.identifier
+      end
+
+      def temporary_identifier
+        temporary_identifiers.first
+      end
+    end
+
+    class Multiple < Mounter # :nodoc
+      def identifier
+        uploaders.map(&:identifier).presence
+      end
+
+      def temporary_identifier
+        temporary_identifiers.presence
+      end
+    end
+
+    def self.build(record, column)
+      if record.class.uploader_options[column][:multiple]
+        Multiple.new(record, column)
+      else
+        Single.new(record, column)
+      end
+    end
+
+    attr_reader :column, :record, :remote_urls, :remove,
+                :integrity_errors, :processing_errors, :download_errors
+    attr_accessor :remote_request_headers, :uploader_options
 
-    def initialize(record, column, options={})
+    def initialize(record, column)
       @record = record
       @column = column
       @options = record.class.uploader_options[column]
       @download_errors = []
       @processing_errors = []
       @integrity_errors = []
+
+      @removed_uploaders = []
+      @added_uploaders = []
     end
 
     def uploader_class
@@ -35,7 +66,7 @@ module CarrierWave
     def uploaders
       @uploaders ||= read_identifiers.map do |identifier|
         uploader = blank_uploader
-        uploader.retrieve_from_store!(identifier) if identifier.present?
+        uploader.retrieve_from_store!(identifier)
         uploader
       end
     end
@@ -46,7 +77,7 @@ module CarrierWave
       @uploaders = new_files.map do |new_file|
         handle_error do
           if new_file.is_a?(String)
-            if (uploader = old_uploaders.detect { |uploader| uploader.identifier == new_file })
+            if (uploader = old_uploaders.detect { |old_uploader| old_uploader.identifier == new_file })
               uploader.staged = true
               uploader
             else
@@ -64,7 +95,9 @@ module CarrierWave
             uploader
           end
         end
-      end.compact
+      end.reject(&:blank?)
+      @removed_uploaders += (old_uploaders - @uploaders)
+      write_temporary_identifier
     end
 
     def cache_names
@@ -76,33 +109,51 @@ module CarrierWave
       return if cache_names.blank?
       clear_unstaged
       cache_names.each do |cache_name|
-        begin
-          uploader = blank_uploader
-          uploader.retrieve_from_cache!(cache_name)
-          @uploaders << uploader
-        rescue CarrierWave::InvalidParameter
-          # ignore
-        end
+        uploader = blank_uploader
+        uploader.retrieve_from_cache!(cache_name)
+        @uploaders << uploader
+      rescue CarrierWave::InvalidParameter
+        # ignore
       end
+      write_temporary_identifier
     end
 
     def remote_urls=(urls)
-      return if urls.blank? || urls.all?(&:blank?)
-
+      if urls.nil?
+        urls = []
+      else
+        urls = Array.wrap(urls).reject(&:blank?)
+        return if urls.blank?
+      end
       @remote_urls = urls
 
       clear_unstaged
-      urls.zip(remote_request_headers || []) do |url, header|
+      @remote_urls.zip(remote_request_headers || []) do |url, header|
         handle_error do
           uploader = blank_uploader
           uploader.download!(url, header || {})
           @uploaders << uploader
         end
       end
+      write_temporary_identifier
     end
 
     def store!
-      uploaders.reject(&:blank?).each(&:store!)
+      additions, remains = uploaders.partition(&:cached?)
+      existing_paths = (@removed_uploaders + remains).map(&:store_path)
+      additions.each do |uploader|
+        uploader.deduplicate(existing_paths)
+        uploader.store!
+        existing_paths << uploader.store_path
+      end
+      @added_uploaders += additions
+    end
+
+    def write_identifier
+      return if record.frozen?
+
+      clear! if remove?
+      record.write_uploader(serialization_column, identifier)
     end
 
     def urls(*args)
@@ -113,52 +164,50 @@ module CarrierWave
       uploaders.none?(&:present?)
     end
 
+    def remove=(value)
+      @remove = value
+      write_temporary_identifier
+    end
+
     def remove?
-      remove.present? && (remove == true || remove !~ /\A0|false$\z/)
+      remove.present? && (remove.to_s !~ /\A0|false$\z/)
     end
 
     def remove!
-      uploaders.reject(&:blank?).each(&:remove!)
-      @uploaders = []
+      uploaders.each(&:remove!)
+      clear!
     end
 
     def clear!
+      @removed_uploaders += uploaders
+      @remove = nil
       @uploaders = []
     end
 
+    def reset_changes!
+      @removed_uploaders = []
+      @added_uploaders = []
+    end
+
     def serialization_column
       option(:mount_on) || column
     end
 
-    def remove_previous(before=nil, after=nil)
-      after ||= []
-      return unless before
-
-      # both 'before' and 'after' can be string when 'mount_on' option is set
-      before = before.reject(&:blank?).map do |value|
-        if value.is_a?(String)
-          uploader = blank_uploader
-          uploader.retrieve_from_store!(value)
-          uploader
-        else
-          value
-        end
-      end
-      after_paths = after.reject(&:blank?).map do |value|
-        if value.is_a?(String)
-          uploader = blank_uploader
-          uploader.retrieve_from_store!(value)
-          uploader
-        else
-          value
-        end.path
-      end
-      before.each do |uploader|
-        uploader.remove! if uploader.remove_previously_stored_files_after_update && !after_paths.include?(uploader.path)
-      end
+    def remove_previous
+      current_paths = uploaders.map(&:path)
+      @removed_uploaders
+        .reject {|uploader| current_paths.include?(uploader.path) }
+        .each { |uploader| uploader.remove! if uploader.remove_previously_stored_files_after_update }
+      reset_changes!
     end
 
-    attr_accessor :uploader_options
+    def remove_added
+      current_paths = (@removed_uploaders + @uploaders.select(&:staged)).map(&:path)
+      @added_uploaders
+        .reject {|uploader| current_paths.include?(uploader.path) }
+        .each { |uploader| uploader.remove! }
+      reset_changes!
+    end
 
   private
 
@@ -169,7 +218,9 @@ module CarrierWave
 
     def clear_unstaged
       @uploaders ||= []
-      @uploaders.keep_if(&:staged)
+      staged, unstaged = @uploaders.partition(&:staged)
+      @uploaders = staged
+      @removed_uploaders += unstaged
     end
 
     def handle_error
@@ -184,5 +235,19 @@ module CarrierWave
       @integrity_errors << e
       raise e unless option(:ignore_integrity_errors)
     end
+
+    def write_temporary_identifier
+      return if record.frozen?
+
+      record.write_uploader(serialization_column, temporary_identifier)
+    end
+
+    def temporary_identifiers
+      if remove?
+        []
+      else
+        uploaders.map { |uploader| uploader.temporary_identifier }
+      end
+    end
   end # Mounter
 end # CarrierWave

data/lib/carrierwave/orm/activerecord.rb

@@ -6,40 +6,6 @@ module CarrierWave
 
     include CarrierWave::Mount
 
-    ##
-    # See +CarrierWave::Mount#mount_uploader+ for documentation
-    #
-    def mount_uploader(column, uploader=nil, options={}, &block)
-      super
-
-      mod = Module.new
-      prepend mod
-      mod.class_eval <<-RUBY, __FILE__, __LINE__+1
-        def remote_#{column}_url=(url)
-          column = _mounter(:#{column}).serialization_column
-          __send__(:"\#{column}_will_change!")
-          super
-        end
-      RUBY
-    end
-
-    ##
-    # See +CarrierWave::Mount#mount_uploaders+ for documentation
-    #
-    def mount_uploaders(column, uploader=nil, options={}, &block)
-      super
-
-      mod = Module.new
-      prepend mod
-      mod.class_eval <<-RUBY, __FILE__, __LINE__+1
-        def remote_#{column}_urls=(url)
-          column = _mounter(:#{column}).serialization_column
-          __send__(:"\#{column}_will_change!")
-          super
-        end
-      RUBY
-    end
-
   private
 
     def mount_base(column, uploader=nil, options={}, &block)
@@ -61,7 +27,6 @@ module CarrierWave
       after_commit :"remove_#{column}!", :on => :destroy
       after_commit :"mark_remove_#{column}_false", :on => :update
 
-      after_save :"store_previous_changes_for_#{column}"
       after_commit :"reset_previous_changes_for_#{column}"
       after_commit :"remove_previously_stored_#{column}", :on => :update
       after_rollback :"remove_rolled_back_#{column}"
@@ -69,29 +34,6 @@ module CarrierWave
       mod = Module.new
       prepend mod
       mod.class_eval <<-RUBY, __FILE__, __LINE__+1
-        def #{column}=(new_file)
-          column = _mounter(:#{column}).serialization_column
-          if !(new_file.blank? && __send__(:#{column}).blank?)
-            __send__(:"\#{column}_will_change!")
-          end
-
-          super
-        end
-
-        def remove_#{column}=(value)
-          column = _mounter(:#{column}).serialization_column
-          result = super
-          __send__(:"\#{column}_will_change!") if _mounter(:#{column}).remove?
-          result
-        end
-
-        def remove_#{column}!
-          self.remove_#{column} = true
-          write_#{column}_identifier
-          self.remove_#{column} = false
-          super
-        end
-
         # Reset cached mounter on record reload
         def reload(*)
           @_mounters = nil
@@ -100,7 +42,14 @@ module CarrierWave
 
         # Reset cached mounter on record dup
         def initialize_dup(other)
-          @_mounters = nil
+          old_uploaders = _mounter(:"#{column}").uploaders
+          @_mounters[:"#{column}"] = nil
+          super
+          _mounter(:"#{column}").cache(old_uploaders)
+        end
+
+        def write_#{column}_identifier
+          return unless has_attribute?(_mounter(:#{column}).serialization_column)
           super
         end
       RUBY

data/lib/carrierwave/processing/mini_magick.rb

@@ -263,7 +263,8 @@ module CarrierWave
       FileUtils.mv image.path, current_path
 
       image.run_command("identify", current_path)
-    rescue ::MiniMagick::Error, ::MiniMagick::Invalid
+    rescue ::MiniMagick::Error, ::MiniMagick::Invalid => e
+      raise e if e.message =~ /(You must have .+ installed|is not installed|executable not found)/
       message = I18n.translate(:"errors.messages.processing_error")
       raise CarrierWave::ProcessingError, message
     ensure
@@ -309,23 +310,24 @@ module CarrierWave
         file.content_type = Marcel::Magic.by_path(move_to).try(:type)
         file.move_to(move_to, permissions, directory_permissions)
       end
-    rescue ::MiniMagick::Error, ::MiniMagick::Invalid
+    rescue ::MiniMagick::Error, ::MiniMagick::Invalid => e
+      raise e if e.message =~ /(You must have .+ installed|is not installed|executable not found)/
       message = I18n.translate(:"errors.messages.processing_error")
       raise CarrierWave::ProcessingError, message
     end
 
-    private
+  private
 
-      def resolve_dimensions(*dimensions)
-        dimensions.map do |value|
-          next value unless value.instance_of?(Proc)
-          value.arity >= 1 ? value.call(self) : value.call
-        end
+    def resolve_dimensions(*dimensions)
+      dimensions.map do |value|
+        next value unless value.instance_of?(Proc)
+        value.arity >= 1 ? value.call(self) : value.call
       end
+    end
 
-      def mini_magick_image
-        ::MiniMagick::Image.read(read)
-      end
+    def mini_magick_image
+      ::MiniMagick::Image.read(read)
+    end
 
   end # MiniMagick
 end # CarrierWave

data/lib/carrierwave/processing/rmagick.rb

@@ -62,10 +62,12 @@ module CarrierWave
       begin
         require "rmagick"
       rescue LoadError
-        require "RMagick"
-      rescue LoadError => e
-        e.message << " (You may need to install the rmagick gem)"
-        raise e
+        begin
+          require "RMagick"
+        rescue LoadError => e
+          e.message << " (You may need to install the rmagick gem)"
+          raise e
+        end
       end
 
       prepend Module.new {
@@ -228,13 +230,7 @@ module CarrierWave
       height = dimension_from height
       manipulate! do |img|
         img.resize_to_fit!(width, height)
-        new_img = ::Magick::Image.new(width, height) { |img| img.background_color = background == :transparent ? 'rgba(255,255,255,0)' : background.to_s }
-        if background == :transparent
-          filled = new_img.matte_floodfill(1, 1)
-        else
-          filled = new_img.color_floodfill(1, 1, ::Magick::Pixel.from_color(background))
-        end
-        destroy_image(new_img)
+        filled = ::Magick::Image.new(width, height) { |image| image.background_color = background == :transparent ? 'rgba(255,255,255,0)' : background.to_s }
         filled.composite!(img, gravity, ::Magick::OverCompositeOp)
         destroy_image(img)
         filled = yield(filled) if block_given?

data/lib/carrierwave/processing/vips.rb

@@ -267,18 +267,18 @@ module CarrierWave
       raise CarrierWave::ProcessingError, message
     end
 
-    private
+  private
 
-      def resolve_dimensions(*dimensions)
-        dimensions.map do |value|
-          next value unless value.instance_of?(Proc)
-          value.arity >= 1 ? value.call(self) : value.call
-        end
+    def resolve_dimensions(*dimensions)
+      dimensions.map do |value|
+        next value unless value.instance_of?(Proc)
+        value.arity >= 1 ? value.call(self) : value.call
       end
+    end
 
-      def vips_image
-        ::Vips::Image.new_from_buffer(read, "")
-      end
+    def vips_image
+      ::Vips::Image.new_from_buffer(read, "")
+    end
 
   end # Vips
 end # CarrierWave

data/lib/carrierwave/sanitized_file.rb

@@ -27,7 +27,7 @@ module CarrierWave
 
     def initialize(file)
       self.file = file
-      @content = nil
+      @content = @content_type = nil
     end
 
     ##
@@ -39,7 +39,7 @@ module CarrierWave
     #
     def original_filename
       return @original_filename if @original_filename
-      if @file and @file.respond_to?(:original_filename)
+      if @file && @file.respond_to?(:original_filename)
         @file.original_filename
       elsif path
         File.basename(path)
@@ -109,7 +109,7 @@ module CarrierWave
     # [Boolean] whether the file is valid and has a non-zero size
     #
     def empty?
-      @file.nil? || self.size.nil? || (self.size.zero? && ! self.exists?)
+      @file.nil? || self.size.nil? || (self.size.zero? && !self.exists?)
     end
 
     ##
@@ -128,14 +128,20 @@ module CarrierWave
     #
     # [String] contents of the file
     #
-    def read
+    def read(*args)
       if @content
-        @content
+        if args.empty?
+          @content
+        else
+          length, outbuf = args
+          raise ArgumentError, "outbuf argument not supported since the content is already loaded" if outbuf
+          @content[0, length]
+        end
       elsif is_path?
-        File.open(@file, "rb") {|file| file.read}
+        File.open(@file, "rb") {|file| file.read(*args)}
       else
         @file.try(:rewind)
-        @content = @file.read
+        @content = @file.read(*args)
         @file.try(:close) unless @file.class.ancestors.include?(::StringIO) || @file.try(:closed?)
         @content
       end
@@ -157,13 +163,10 @@ module CarrierWave
       mkdir!(new_path, directory_permissions)
       move!(new_path)
       chmod!(new_path, permissions)
-      if keep_filename
-        self.file = {:tempfile => new_path, :filename => original_filename, :content_type => @content_type}
-      else
-        self.file = {:tempfile => new_path, :content_type => @content_type}
-      end
+      self.file = {tempfile: new_path, filename: keep_filename ? original_filename : nil, content_type: declared_content_type}
       self
     end
+
     ##
     # Helper to move file to new path.
     #
@@ -195,7 +198,7 @@ module CarrierWave
       mkdir!(new_path, directory_permissions)
       copy!(new_path)
       chmod!(new_path, permissions)
-      self.class.new({:tempfile => new_path, :content_type => content_type})
+      self.class.new({tempfile: new_path, content_type: declared_content_type})
     end
 
     ##
@@ -237,9 +240,10 @@ module CarrierWave
     #
     def content_type
       @content_type ||=
-        existing_content_type ||
-        marcel_magic_by_mime_type ||
-        marcel_magic_by_path
+        identified_content_type ||
+        declared_content_type ||
+        guessed_safe_content_type ||
+        Marcel::MimeType::BINARY
     end
 
     ##
@@ -270,11 +274,11 @@ module CarrierWave
       if file.is_a?(Hash)
         @file = file["tempfile"] || file[:tempfile]
         @original_filename = file["filename"] || file[:filename]
-        @content_type = file["content_type"] || file[:content_type] || file["type"] || file[:type]
+        @declared_content_type = file["content_type"] || file[:content_type] || file["type"] || file[:type]
       else
         @file = file
         @original_filename = nil
-        @content_type = nil
+        @declared_content_type = nil
       end
     end
 
@@ -294,39 +298,45 @@ module CarrierWave
       name = name.scrub
       name = name.tr("\\", "/") # work-around for IE
       name = File.basename(name)
-      name = name.gsub(sanitize_regexp,"_")
+      name = name.gsub(sanitize_regexp, "_")
       name = "_#{name}" if name =~ /\A\.+\z/
       name = "unnamed" if name.size.zero?
-      return name.mb_chars.to_s
+      name.mb_chars.to_s
     end
 
-    def existing_content_type
-      if @file.respond_to?(:content_type) && @file.content_type
-        @file.content_type.to_s.chomp
-      end
+    def declared_content_type
+      @declared_content_type ||
+        if @file.respond_to?(:content_type) && @file.content_type
+          @file.content_type.to_s.chomp
+        end
     end
 
-    def marcel_magic_by_mime_type
+    # Guess content type from its file extension. Limit what to be returned to prevent spoofing.
+    def guessed_safe_content_type
       return unless path
 
-      type = File.open(path) do |file|
-        Marcel::Magic.by_magic(file).try(:type)
-      end
+      type = Marcel::Magic.by_path(original_filename).to_s
+      type if type.start_with?('text/') || type.start_with?('application/json')
+    end
 
-      if type.nil?
-        type = Marcel::Magic.by_path(path).try(:type)
-        type = 'invalid/invalid' unless type.nil? || type.start_with?('text/') || type.start_with?('application/json')
+    def identified_content_type
+      with_io do |io|
+        Marcel::Magic.by_magic(io).try(:type)
       end
-
-      type
     rescue Errno::ENOENT
       nil
     end
 
-    def marcel_magic_by_path
-      return unless path
-
-      Marcel::Magic.by_path(path).to_s
+    def with_io(&block)
+      if file.is_a?(IO)
+        begin
+          yield file
+        ensure
+          file.try(:rewind)
+        end
+      elsif path
+        File.open(path, &block)
+      end
     end
   end # SanitizedFile
 end # CarrierWave

data/lib/carrierwave/storage/abstract.rb

@@ -14,7 +14,7 @@ module CarrierWave
       end
 
       def identifier
-        uploader.filename
+        uploader.deduplicated_filename
       end
 
       def store!(file)
@@ -24,19 +24,19 @@ module CarrierWave
       end
 
       def cache!(new_file)
-        raise NotImplementedError.new("Need to implement #cache! if you want to use #{self.class.name} as a cache storage.")
+        raise NotImplementedError, "Need to implement #cache! if you want to use #{self.class.name} as a cache storage."
       end
 
       def retrieve_from_cache!(identifier)
-        raise NotImplementedError.new("Need to implement #retrieve_from_cache! if you want to use #{self.class.name} as a cache storage.")
+        raise NotImplementedError, "Need to implement #retrieve_from_cache! if you want to use #{self.class.name} as a cache storage."
       end
 
       def delete_dir!(path)
-        raise NotImplementedError.new("Need to implement #delete_dir! if you want to use #{self.class.name} as a cache storage.")
+        raise NotImplementedError, "Need to implement #delete_dir! if you want to use #{self.class.name} as a cache storage."
       end
 
       def clean_cache!(seconds)
-        raise NotImplementedError.new("Need to implement #clean_cache! if you want to use #{self.class.name} as a cache storage.")
+        raise NotImplementedError, "Need to implement #clean_cache! if you want to use #{self.class.name} as a cache storage."
       end
     end # Abstract
   end # Storage

data/lib/carrierwave/storage/file.rb

@@ -109,10 +109,11 @@ module CarrierWave
       end
 
       def clean_cache!(seconds)
-        Dir.glob(::File.expand_path(::File.join(uploader.cache_dir, '*'), CarrierWave.root)).each do |dir|
+        Dir.glob(::File.expand_path(::File.join(uploader.cache_dir, '*'), uploader.root)).each do |dir|
           # generate_cache_id returns key formatted TIMEINT-PID(-COUNTER)-RND
-          time = dir.scan(/(\d+)-\d+-\d+(?:-\d+)?/).first.map(&:to_i)
-          time = Time.at(*time)
+          matched = dir.scan(/(\d+)-\d+-\d+(?:-\d+)?/).first
+          next unless matched
+          time = Time.at(matched[0].to_i)
           if time < (Time.now.utc - seconds)
             FileUtils.rm_rf(dir)
           end