salebot_uploader 1.0.0

data/lib/salebot_uploader/processing/vips.rb

@@ -0,0 +1,284 @@
+module SalebotUploader
+
+  ##
+  # This module simplifies manipulation with vips by providing a set
+  # of convenient helper methods. If you want to use them, you'll need to
+  # require this file:
+  #
+  #     require 'SalebotUploader/processing/vips'
+  #
+  # And then include it in your uploader:
+  #
+  #     class MyUploader < SalebotUploader::Uploader::Base
+  #       include SalebotUploader::Vips
+  #     end
+  #
+  # You can now use the provided helpers:
+  #
+  #     class MyUploader < SalebotUploader::Uploader::Base
+  #       include SalebotUploader::Vips
+  #
+  #       process :resize_to_fit => [200, 200]
+  #     end
+  #
+  # Or create your own helpers with the powerful vips! method, which
+  # yields an ImageProcessing::Builder object. Check out the ImageProcessing
+  # docs at http://github.com/janko-m/image_processing and the list of all
+  # available Vips options at
+  # https://libvips.github.io/libvips/API/current/using-cli.html for more info.
+  #
+  #     class MyUploader < SalebotUploader::Uploader::Base
+  #       include SalebotUploader::Vips
+  #
+  #       process :radial_blur => 10
+  #
+  #       def radial_blur(amount)
+  #         vips! do |builder|
+  #           builder.radial_blur(amount)
+  #           builder = yield(builder) if block_given?
+  #           builder
+  #         end
+  #       end
+  #     end
+  #
+  # === Note
+  #
+  # The ImageProcessing gem uses ruby-vips, a binding for the vips image
+  # library. You can find more information here:
+  #
+  # https://github.com/libvips/ruby-vips
+  #
+  #
+  module Vips
+    extend ActiveSupport::Concern
+
+    included do
+      require "image_processing/vips"
+      # We need to disable caching since we're editing images in place.
+      ::Vips.cache_set_max(0)
+    end
+
+    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='centre')
+        process :resize_to_fill => [width, height, gravity]
+      end
+
+      def resize_and_pad(width, height, background=nil, gravity='centre', alpha=nil)
+        process :resize_and_pad => [width, height, background, gravity, alpha]
+      end
+    end
+
+    ##
+    # Changes the image encoding format to the given format
+    #
+    # See https://libvips.github.io/libvips/API/current/using-cli.html#using-command-line-conversion
+    #
+    # === Parameters
+    #
+    # [format (#to_s)] an abbreviation of the format
+    #
+    # === Yields
+    #
+    # [Vips::Image] additional manipulations to perform
+    #
+    # === Examples
+    #
+    #     image.convert(:png)
+    #
+    def convert(format, page=nil)
+      vips! do |builder|
+        builder = builder.convert(format)
+        builder = builder.loader(page: page) if page
+        builder
+      end
+    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
+    # [combine_options (Hash)] additional Vips options to apply before resizing
+    #
+    # === Yields
+    #
+    # [Vips::Image] additional manipulations to perform
+    #
+    def resize_to_limit(width, height, combine_options: {})
+      width, height = resolve_dimensions(width, height)
+
+      vips! do |builder|
+        builder.resize_to_limit(width, height)
+          .apply(combine_options)
+      end
+    end
+
+    ##
+    # 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.
+    #
+    # === Parameters
+    #
+    # [width (Integer)] the width to scale the image to
+    # [height (Integer)] the height to scale the image to
+    # [combine_options (Hash)] additional Vips options to apply before resizing
+    #
+    # === Yields
+    #
+    # [Vips::Image] additional manipulations to perform
+    #
+    def resize_to_fit(width, height, combine_options: {})
+      width, height = resolve_dimensions(width, height)
+
+      vips! do |builder|
+        builder.resize_to_fit(width, height)
+          .apply(combine_options)
+      end
+    end
+
+    ##
+    # 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.
+    #
+    # === Parameters
+    #
+    # [width (Integer)] the width to scale the image to
+    # [height (Integer)] the height to scale the image to
+    # [combine_options (Hash)] additional vips options to apply before resizing
+    #
+    # === Yields
+    #
+    # [Vips::Image] additional manipulations to perform
+    #
+    def resize_to_fill(width, height, _gravity = nil, combine_options: {})
+      width, height = resolve_dimensions(width, height)
+
+      vips! do |builder|
+        builder.resize_to_fill(width, height).apply(combine_options)
+      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).
+    #
+    # See https://libvips.github.io/libvips/API/current/libvips-conversion.html#VipsCompassDirection
+    # for gravity options.
+    #
+    # === Parameters
+    #
+    # [width (Integer)] the width to scale the image to
+    # [height (Integer)] the height to scale the image to
+    # [background (List, nil)] the color of the background as a RGB, like [0, 255, 255], nil indicates transparent
+    # [gravity (String)] how to position the image
+    # [alpha (Boolean, nil)] pad the image with the alpha channel if supported
+    # [combine_options (Hash)] additional vips options to apply before resizing
+    #
+    # === Yields
+    #
+    # [Vips::Image] additional manipulations to perform
+    #
+    def resize_and_pad(width, height, background=nil, gravity='centre', alpha=nil, combine_options: {})
+      width, height = resolve_dimensions(width, height)
+
+      vips! do |builder|
+        builder.resize_and_pad(width, height, background: background, gravity: gravity, alpha: alpha)
+          .apply(combine_options)
+      end
+    end
+
+    ##
+    # Returns the width of the image in pixels.
+    #
+    # === Returns
+    #
+    # [Integer] the image's width in pixels
+    #
+    def width
+      vips_image.width
+    end
+
+    ##
+    # Returns the height of the image in pixels.
+    #
+    # === Returns
+    #
+    # [Integer] the image's height in pixels
+    #
+    def height
+      vips_image.height
+    end
+
+    # Process the image with vip, using the ImageProcessing gem. This
+    # method will build a "convert" vips command and execute it on the
+    # current image.
+    #
+    # === 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.
+    # SalebotUploader::Uploader does, so you won't need to worry about this in
+    # most cases.
+    #
+    # === Yields
+    #
+    # [ImageProcessing::Builder] use it to define processing to be performed
+    #
+    # === Raises
+    #
+    # [SalebotUploader::ProcessingError] if processing failed.
+    def vips!
+      builder = ImageProcessing::Vips.source(current_path)
+      builder = yield(builder)
+
+      result = builder.call
+      result.close
+
+      FileUtils.mv result.path, current_path
+
+      if File.extname(result.path) != File.extname(current_path)
+        move_to = current_path.chomp(File.extname(current_path)) + File.extname(result.path)
+        file.content_type = Marcel::Magic.by_path(move_to).try(:type)
+        file.move_to(move_to, permissions, directory_permissions)
+      end
+    rescue ::Vips::Error
+      message = I18n.translate(:"errors.messages.processing_error")
+      raise SalebotUploader::ProcessingError, message
+    end
+
+  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
+    end
+
+    def vips_image
+      ::Vips::Image.new_from_buffer(read, "")
+    end
+
+  end # Vips
+end # SalebotUploader

data/lib/salebot_uploader/processing.rb

@@ -0,0 +1,3 @@
+require 'salebot_uploader/processing/rmagick'
+require 'salebot_uploader/processing/mini_magick'
+require 'salebot_uploader/processing/vips'

data/lib/salebot_uploader/sanitized_file.rb

@@ -0,0 +1,357 @@
+require 'pathname'
+require 'active_support/core_ext/string/multibyte'
+require 'marcel'
+
+module SalebotUploader
+
+  ##
+  # 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
+    include SalebotUploader::Utilities::FileName
+
+    attr_reader :file
+
+    class << self
+      attr_writer :sanitize_regexp
+
+      def sanitize_regexp
+        @sanitize_regexp ||= /[^[:word:]\.\-\+]/
+      end
+    end
+
+    def initialize(file)
+      self.file = file
+      @content = @content_type = nil
+    end
+
+    ##
+    # Returns the filename as is, without sanitizing it.
+    #
+    # === Returns
+    #
+    # [String] the unsanitized filename
+    #
+    def original_filename
+      return @original_filename if @original_filename
+
+      if @file && @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 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
+      return if @file.blank?
+
+      if is_path?
+        File.expand_path(@file)
+      elsif @file.respond_to?(:path) && !@file.path.blank?
+        File.expand_path(@file.path)
+      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? && !self.exists?)
+    end
+
+    ##
+    # === Returns
+    #
+    # [Boolean] Whether the file exists
+    #
+    def exists?
+      self.path.present? && File.exist?(self.path)
+    end
+
+    ##
+    # Returns the contents of the file.
+    #
+    # === Returns
+    #
+    # [String] contents of the file
+    #
+    def read(*args)
+      if @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(*args) }
+      else
+        @file.try(:rewind)
+        @content = @file.read(*args)
+        @file.try(:close) unless @file.class.ancestors.include?(::StringIO) || @file.try(:closed?)
+        @content
+      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.
+    # [directory_permissions (Integer)] permissions to set on created directories.
+    #
+    def move_to(new_path, permissions=nil, directory_permissions=nil, keep_filename=false)
+      return if self.empty?
+
+      new_path = File.expand_path(new_path)
+
+      mkdir!(new_path, directory_permissions)
+      move!(new_path)
+      chmod!(new_path, permissions)
+      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.
+    #
+    def move!(new_path)
+      if exists?
+        FileUtils.mv(path, new_path) unless File.identical?(new_path, path)
+      else
+        File.open(new_path, 'wb') { |f| f.write(read) }
+      end
+    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
+    # [directory_permissions (Integer)] permissions to set on created directories.
+    #
+    # === Returns
+    #
+    # @return [SalebotUploader::SanitizedFile] the location where the file will be stored.
+    #
+    def copy_to(new_path, permissions=nil, directory_permissions=nil)
+      return if self.empty?
+
+      new_path = File.expand_path(new_path)
+
+      mkdir!(new_path, directory_permissions)
+      copy!(new_path)
+      chmod!(new_path, permissions)
+      self.class.new({tempfile: new_path, content_type: declared_content_type})
+    end
+
+    ##
+    # Helper to create copy of file in new path.
+    #
+    def copy!(new_path)
+      if exists?
+        FileUtils.cp(path, new_path) unless new_path == path
+      else
+        File.open(new_path, 'wb') { |f| f.write(read) }
+      end
+    end
+
+    ##
+    # Removes the file from the filesystem.
+    #
+    def delete
+      FileUtils.rm(self.path) if exists?
+    end
+
+    ##
+    # Returns a File object, or nil if it does not exist.
+    #
+    # === Returns
+    #
+    # [File] a File object representing the SanitizedFile
+    #
+    def to_file
+      return @file if @file.is_a?(File)
+
+      File.open(path, 'rb') if exists?
+    end
+
+    ##
+    # Returns the content type of the file.
+    #
+    # === Returns
+    #
+    # [String] the content type of the file
+    #
+    def content_type
+      @content_type ||=
+        identified_content_type ||
+        declared_content_type ||
+        guessed_safe_content_type ||
+        Marcel::MimeType::BINARY
+    end
+
+    ##
+    # Sets the content type of the file.
+    #
+    # === Returns
+    #
+    # [String] the content type of the file
+    #
+    def content_type=(type)
+      @content_type = type
+    end
+
+    ##
+    # Used to sanitize the file name. Public to allow overriding for non-latin characters.
+    #
+    # === Returns
+    #
+    # [Regexp] the regexp for sanitizing the file name
+    #
+    def sanitize_regexp
+      SalebotUploader::SanitizedFile.sanitize_regexp
+    end
+
+  private
+
+    def file=(file)
+      if file.is_a?(Hash)
+        @file = file['tempfile'] || file[:tempfile]
+        @original_filename = file['filename'] || file[:filename]
+        @declared_content_type = file['content_type'] || file[:content_type] || file['type'] || file[:type]
+      else
+        @file = file
+        @original_filename = nil
+        @declared_content_type = nil
+      end
+    end
+
+    # create the directory if it doesn't exist
+    def mkdir!(path, directory_permissions)
+      options = {}
+      options[:mode] = directory_permissions if directory_permissions
+      FileUtils.mkdir_p(File.dirname(path), **options) unless File.exist?(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.scrub
+      name = name.tr('\\', '/') # work-around for IE
+      name = File.basename(name)
+      name = name.gsub(sanitize_regexp, '_')
+      name = "_#{name}" if name =~ /\A\.+\z/
+      name = 'unnamed' if name.size.zero?
+      name.mb_chars.to_s
+    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
+
+    # Guess content type from its file extension. Limit what to be returned to prevent spoofing.
+    def guessed_safe_content_type
+      return unless path
+
+      type = Marcel::Magic.by_path(original_filename).to_s
+      type if type.start_with?('text/') || type.start_with?('application/json')
+    end
+
+    def identified_content_type
+      with_io do |io|
+        mimetype_by_magic = Marcel::Magic.by_magic(io)
+        mimetype_by_path = Marcel::Magic.by_path(path)
+
+        return nil if mimetype_by_magic.nil?
+
+        if mimetype_by_path&.child_of?(mimetype_by_magic.type)
+          mimetype_by_path.type
+        else
+          mimetype_by_magic.type
+        end
+      end
+    rescue Errno::ENOENT
+      nil
+    end
+
+    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 # SalebotUploader

data/lib/salebot_uploader/storage/abstract.rb

@@ -0,0 +1,41 @@
+module SalebotUploader
+  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.deduplicated_filename
+      end
+
+      def store!(file); end
+
+      def retrieve!(identifier); end
+
+      def cache!(new_file)
+        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, "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, "Need to implement #delete_dir! if you want to use #{self.class.name} as a cache storage."
+      end
+
+      def clean_cache!(seconds)
+        raise NotImplementedError, "Need to implement #clean_cache! if you want to use #{self.class.name} as a cache storage."
+      end
+    end # Abstract
+  end # Storage
+end # SalebotUploader