carrierwave-rails3 0.4.5

data/lib/carrierwave/processing/rmagick.rb

@@ -0,0 +1,278 @@
+# encoding: utf-8
+
+unless defined? Magick 
+  begin
+    require 'rmagick'
+  rescue LoadError
+    require 'RMagick'
+  rescue LoadError
+    puts "WARNING: Failed to require rmagick, image processing may fail!"
+  end
+end
+
+module CarrierWave
+
+  ##
+  # This module simplifies manipulation with RMagick by providing a set
+  # of convenient helper methods. If you want to use them, you'll need to
+  # require this file:
+  #
+  #     require 'carrierwave/processing/rmagick'
+  #
+  # And then include it in your uploader:
+  #
+  #     class MyUploader < CarrierWave::Uploader::Base
+  #       include CarrierWave::RMagick
+  #     end
+  #
+  # You can now use the provided helpers:
+  #
+  #     class MyUploader < CarrierWave::Uploader::Base
+  #       include CarrierWave::RMagick
+  #
+  #       process :resize_to_fit => [200, 200]
+  #     end
+  #
+  # Or create your own helpers with the powerful manipulate! method. Check
+  # out the RMagick docs at http://www.imagemagick.org/RMagick/doc/ for more
+  # info
+  #
+  #     class MyUploader < CarrierWave::Uploader::Base
+  #       include CarrierWave::RMagick
+  #
+  #       process :do_stuff => 10.0
+  #
+  #       def do_stuff(blur_factor)
+  #         manipulate! do |img|
+  #           img = img.sepiatone
+  #           img = img.auto_orient
+  #           img = img.radial_blur(blur_factor)
+  #         end
+  #       end
+  #     end
+  #
+  # === Note
+  #
+  # You should be aware how RMagick handles memory. manipulate! takes care
+  # of freeing up memory for you, but for optimum memory usage you should
+  # use destructive operations as much as possible:
+  #
+  # DON'T DO THIS:
+  #     img = img.resize_to_fit
+  #
+  # DO THIS INSTEAD:
+  #     img.resize_to_fit!
+  #
+  # Read this for more information why:
+  #
+  # http://rubyforge.org/forum/forum.php?thread_id=1374&forum_id=1618
+  #
+  module RMagick
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      def convert(format)
+        process :convert => format
+      end
+
+      def resize_to_limit(width, height)
+        process :resize_to_limit => [width, height]
+      end
+
+      def resize_to_fit(width, height)
+        process :resize_to_fit => [width, height]
+      end
+
+      def resize_to_fill(width, height, gravity=::Magick::CenterGravity)
+        process :resize_to_fill => [width, height, gravity]
+      end
+
+      def resize_and_pad(width, height, background=:transparent, gravity=::Magick::CenterGravity)
+        process :resize_and_pad => [width, height, background, gravity]
+      end
+    end
+
+    ##
+    # Changes the image encoding format to the given format
+    #
+    # See even http://www.imagemagick.org/RMagick/doc/magick.html#formats
+    #
+    # === Parameters
+    #
+    # [format (#to_s)] an abreviation of the format
+    #
+    # === Yields
+    #
+    # [Magick::Image] additional manipulations to perform
+    #
+    # === Examples
+    #
+    #     image.convert(:png)
+    #
+    def convert(format)
+      manipulate!(:format => format)
+    end
+
+    ##
+    # Resize the image to fit within the specified dimensions while retaining
+    # the original aspect ratio. Will only resize the image if it is larger than the
+    # specified dimensions. The resulting image may be shorter or narrower than specified
+    # in the smaller dimension but will not be larger than the specified values.
+    #
+    # === Parameters
+    #
+    # [width (Integer)] the width to scale the image to
+    # [height (Integer)] the height to scale the image to
+    #
+    # === Yields
+    #
+    # [Magick::Image] additional manipulations to perform
+    #
+    def resize_to_limit(width, height)
+      manipulate! do |img|
+        geometry = Magick::Geometry.new(width, height, 0, 0, Magick::GreaterGeometry)
+        new_img = img.change_geometry(geometry) do |new_width, new_height|
+          img.resize(new_width, new_height)
+        end
+        destroy_image(img)
+        new_img = yield(new_img) if block_given?
+        new_img
+      end
+    end
+
+    ##
+    # From the RMagick documentation: "Resize the image to fit within the
+    # specified dimensions while retaining the original aspect ratio. The
+    # image may be shorter or narrower than specified in the smaller dimension
+    # but will not be larger than the specified values."
+    #
+    # See even http://www.imagemagick.org/RMagick/doc/image3.html#resize_to_fit
+    #
+    # === Parameters
+    #
+    # [width (Integer)] the width to scale the image to
+    # [height (Integer)] the height to scale the image to
+    #
+    # === Yields
+    #
+    # [Magick::Image] additional manipulations to perform
+    #
+    def resize_to_fit(width, height)
+      manipulate! do |img|
+        img.resize_to_fit!(width, height)
+        img = yield(img) if block_given?
+        img
+      end
+    end
+
+    ##
+    # From the RMagick documentation: "Resize the image to fit within the
+    # specified dimensions while retaining the aspect ratio of the original
+    # image. If necessary, crop the image in the larger dimension."
+    #
+    # See even http://www.imagemagick.org/RMagick/doc/image3.html#resize_to_fill
+    #
+    # === Parameters
+    #
+    # [width (Integer)] the width to scale the image to
+    # [height (Integer)] the height to scale the image to
+    #
+    # === Yields
+    #
+    # [Magick::Image] additional manipulations to perform
+    #
+    def resize_to_fill(width, height, gravity=::Magick::CenterGravity)
+      manipulate! do |img|
+        img.crop_resized!(width, height, gravity)
+        img = yield(img) if block_given?
+        img
+      end
+    end
+
+    ##
+    # Resize the image to fit within the specified dimensions while retaining
+    # the original aspect ratio. If necessary, will pad the remaining area
+    # with the given color, which defaults to transparent (for gif and png,
+    # white for jpeg).
+    #
+    # === Parameters
+    #
+    # [width (Integer)] the width to scale the image to
+    # [height (Integer)] the height to scale the image to
+    # [background (String, :transparent)] the color of the background as a hexcode, like "#ff45de"
+    # [gravity (Magick::GravityType)] how to position the image
+    #
+    # === Yields
+    #
+    # [Magick::Image] additional manipulations to perform
+    #
+    def resize_and_pad(width, height, background=:transparent, gravity=::Magick::CenterGravity)
+      manipulate! do |img|
+        img.resize_to_fit!(width, height)
+        new_img = ::Magick::Image.new(width, height)
+        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.composite!(img, gravity, ::Magick::OverCompositeOp)
+        destroy_image(img)
+        filled = yield(filled) if block_given?
+        filled
+      end
+    end
+
+    ##
+    # Manipulate the image with RMagick. This method will load up an image
+    # and then pass each of its frames to the supplied block. It will then
+    # save the image to disk.
+    #
+    # === Gotcha
+    #
+    # This method assumes that the object responds to +current_path+.
+    # Any class that this module is mixed into must have a +current_path+ method.
+    # CarrierWave::Uploader does, so you won't need to worry about this in
+    # most cases.
+    #
+    # === Yields
+    #
+    # [Magick::Image] manipulations to perform
+    #
+    # === Raises
+    #
+    # [CarrierWave::ProcessingError] if manipulation failed.
+    #
+    def manipulate!(options={})
+      image = ::Magick::Image.read(current_path)
+
+      frames = if image.size > 1
+        list = ::Magick::ImageList.new
+        image.each do |frame|
+          list << yield( frame )
+        end
+        list
+      else
+        frame = image.first
+        frame = yield( frame ) if block_given?
+        frame
+      end
+
+      if options[:format]
+        frames.write("#{options[:format]}:#{current_path}")
+      else
+        frames.write(current_path)
+      end
+      destroy_image(frames)
+    rescue ::Magick::ImageMagickError => e
+      raise CarrierWave::ProcessingError.new("Failed to manipulate with rmagick, maybe it is not an image? Original Error: #{e}")
+    end
+
+  private
+  
+    def destroy_image(image)
+      image.destroy! if image.respond_to?(:destroy!)
+    end
+
+  end # RMagick
+end # CarrierWave

data/lib/carrierwave/sanitized_file.rb

@@ -0,0 +1,273 @@
+# 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.open(@file, "rb").read
+      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)
+      name = name.gsub("\\", "/") # work-around for IE
+      name = File.basename(name)
+      name = name.gsub(/[^a-zA-Z0-9\.\-\+_]/,"_")
+      name = "_#{name}" if name =~ /\A\.+\z/
+      name = "unnamed" if name.size == 0
+      return name.downcase
+    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