kt-paperclip 6.2.0

data/lib/paperclip/io_adapters/abstract_adapter.rb

@@ -0,0 +1,75 @@
+require "active_support/core_ext/module/delegation"
+
+module Paperclip
+  class AbstractAdapter
+    OS_RESTRICTED_CHARACTERS = %r{[/:]}.freeze
+
+    attr_reader :content_type, :original_filename, :size, :tempfile
+    delegate :binmode, :binmode?, :close, :close!, :closed?, :eof?, :path, :readbyte, :rewind, :unlink, to: :@tempfile
+    alias :length :size
+
+    def initialize(target, options = {})
+      @target = target
+      @options = options
+    end
+
+    def fingerprint
+      @fingerprint ||= begin
+        digest = @options.fetch(:hash_digest).new
+        File.open(path, "rb") do |f|
+          buf = ""
+          digest.update(buf) while f.read(16384, buf)
+        end
+        digest.hexdigest
+      end
+    end
+
+    def read(length = nil, buffer = nil)
+      @tempfile.read(length, buffer)
+    end
+
+    def inspect
+      "#{self.class}: #{original_filename}"
+    end
+
+    def original_filename=(new_filename)
+      return unless new_filename
+
+      @original_filename = new_filename.gsub(OS_RESTRICTED_CHARACTERS, "_")
+    end
+
+    def nil?
+      false
+    end
+
+    def assignment?
+      true
+    end
+
+    private
+
+    def destination
+      @destination ||= TempfileFactory.new.generate(@original_filename.to_s)
+    end
+
+    def copy_to_tempfile(src)
+      link_or_copy_file(src.path, destination.path)
+      destination
+    end
+
+    def link_or_copy_file(src, dest)
+      begin
+        Paperclip.log("Trying to link #{src} to #{dest}")
+        FileUtils.ln(src, dest, force: true) # overwrite existing
+      rescue Errno::EXDEV, Errno::EPERM, Errno::ENOENT, Errno::EEXIST => e
+        Paperclip.log(
+          "Link failed with #{e.message}; copying link #{src} to #{dest}"
+        )
+        FileUtils.cp(src, dest)
+      end
+
+      @destination.close
+      @destination.open.binmode
+    end
+  end
+end

data/lib/paperclip/io_adapters/attachment_adapter.rb

@@ -0,0 +1,47 @@
+module Paperclip
+  class AttachmentAdapter < AbstractAdapter
+    def self.register
+      Paperclip.io_adapters.register self do |target|
+        Paperclip::Attachment === target || Paperclip::Style === target
+      end
+    end
+
+    def initialize(target, options = {})
+      super
+      @target, @style = case target
+                        when Paperclip::Attachment
+                          [target, :original]
+                        when Paperclip::Style
+                          [target.attachment, target.name]
+                        end
+
+      cache_current_values
+    end
+
+    private
+
+    def cache_current_values
+      self.original_filename = @target.original_filename
+      @content_type = @target.content_type
+      @tempfile = copy_to_tempfile(@target)
+      @size = @tempfile.size || @target.size
+    end
+
+    def copy_to_tempfile(source)
+      if source.staged?
+        link_or_copy_file(source.staged_path(@style), destination.path)
+      else
+        begin
+          source.copy_to_local_file(@style, destination.path)
+        rescue Errno::EACCES
+          # clean up lingering tempfile if we cannot access source file
+          destination.close(true)
+          raise
+        end
+      end
+      destination
+    end
+  end
+end
+
+Paperclip::AttachmentAdapter.register

data/lib/paperclip/io_adapters/data_uri_adapter.rb

@@ -0,0 +1,22 @@
+module Paperclip
+  class DataUriAdapter < StringioAdapter
+    def self.register
+      Paperclip.io_adapters.register self do |target|
+        String === target && target =~ REGEXP
+      end
+    end
+
+    REGEXP = /\Adata:([-\w]+\/[-\w\+\.]+)?;base64,(.*)/m.freeze
+
+    def initialize(target_uri, options = {})
+      super(extract_target(target_uri), options)
+    end
+
+    private
+
+    def extract_target(uri)
+      data_uri_parts = uri.match(REGEXP) || []
+      StringIO.new(Base64.decode64(data_uri_parts[2] || ""))
+    end
+  end
+end

data/lib/paperclip/io_adapters/empty_string_adapter.rb

@@ -0,0 +1,19 @@
+module Paperclip
+  class EmptyStringAdapter < AbstractAdapter
+    def self.register
+      Paperclip.io_adapters.register self do |target|
+        target.is_a?(String) && target.empty?
+      end
+    end
+
+    def nil?
+      false
+    end
+
+    def assignment?
+      false
+    end
+  end
+end
+
+Paperclip::EmptyStringAdapter.register

data/lib/paperclip/io_adapters/file_adapter.rb

@@ -0,0 +1,26 @@
+module Paperclip
+  class FileAdapter < AbstractAdapter
+    def self.register
+      Paperclip.io_adapters.register self do |target|
+        File === target || ::Tempfile === target
+      end
+    end
+
+    def initialize(target, options = {})
+      super
+      cache_current_values
+    end
+
+    private
+
+    def cache_current_values
+      self.original_filename = @target.original_filename if @target.respond_to?(:original_filename)
+      self.original_filename ||= File.basename(@target.path)
+      @tempfile = copy_to_tempfile(@target)
+      @content_type = ContentTypeDetector.new(@target.path).detect
+      @size = File.size(@target)
+    end
+  end
+end
+
+Paperclip::FileAdapter.register

data/lib/paperclip/io_adapters/http_url_proxy_adapter.rb

@@ -0,0 +1,16 @@
+module Paperclip
+  class HttpUrlProxyAdapter < UriAdapter
+    def self.register
+      Paperclip.io_adapters.register self do |target|
+        String === target && target =~ REGEXP
+      end
+    end
+
+    REGEXP = /\Ahttps?:\/\//.freeze
+
+    def initialize(target, options = {})
+      escaped = URI.escape(target)
+      super(URI(target == URI.unescape(target) ? escaped : target), options)
+    end
+  end
+end

data/lib/paperclip/io_adapters/identity_adapter.rb

@@ -0,0 +1,17 @@
+module Paperclip
+  class IdentityAdapter < AbstractAdapter
+    def self.register
+      Paperclip.io_adapters.register Paperclip::IdentityAdapter.new do |target|
+        Paperclip.io_adapters.registered?(target)
+      end
+    end
+
+    def initialize; end
+
+    def new(target, _)
+      target
+    end
+  end
+end
+
+Paperclip::IdentityAdapter.register

data/lib/paperclip/io_adapters/nil_adapter.rb

@@ -0,0 +1,37 @@
+module Paperclip
+  class NilAdapter < AbstractAdapter
+    def self.register
+      Paperclip.io_adapters.register self do |target|
+        target.nil? || ((Paperclip::Attachment === target) && !target.present?)
+      end
+    end
+
+    def initialize(_target, _options = {}); end
+
+    def original_filename
+      ""
+    end
+
+    def content_type
+      ""
+    end
+
+    def size
+      0
+    end
+
+    def nil?
+      true
+    end
+
+    def read(*_args)
+      nil
+    end
+
+    def eof?
+      true
+    end
+  end
+end
+
+Paperclip::NilAdapter.register

data/lib/paperclip/io_adapters/registry.rb

@@ -0,0 +1,36 @@
+module Paperclip
+  class AdapterRegistry
+    class NoHandlerError < Paperclip::Error; end
+
+    attr_reader :registered_handlers
+
+    def initialize
+      @registered_handlers = []
+    end
+
+    def register(handler_class, &block)
+      @registered_handlers << [block, handler_class]
+    end
+
+    def unregister(handler_class)
+      @registered_handlers.reject! { |_, klass| klass == handler_class }
+    end
+
+    def handler_for(target)
+      @registered_handlers.each do |tester, handler|
+        return handler if tester.call(target)
+      end
+      raise NoHandlerError.new("No handler found for #{target.inspect}")
+    end
+
+    def registered?(target)
+      @registered_handlers.any? do |_tester, handler|
+        handler === target
+      end
+    end
+
+    def for(target, options = {})
+      handler_for(target).new(target, options)
+    end
+  end
+end

data/lib/paperclip/io_adapters/stringio_adapter.rb

@@ -0,0 +1,36 @@
+module Paperclip
+  class StringioAdapter < AbstractAdapter
+    def self.register
+      Paperclip.io_adapters.register self do |target|
+        StringIO === target
+      end
+    end
+
+    def initialize(target, options = {})
+      super
+      cache_current_values
+    end
+
+    attr_writer :content_type
+
+    private
+
+    def cache_current_values
+      self.original_filename = @target.original_filename if @target.respond_to?(:original_filename)
+      self.original_filename ||= "data"
+      @tempfile = copy_to_tempfile(@target)
+      @content_type = ContentTypeDetector.new(@tempfile.path).detect
+      @size = @target.size
+    end
+
+    def copy_to_tempfile(source)
+      while data = source.read(16 * 1024)
+        destination.write(data)
+      end
+      destination.rewind
+      destination
+    end
+  end
+end
+
+Paperclip::StringioAdapter.register

data/lib/paperclip/io_adapters/uploaded_file_adapter.rb

@@ -0,0 +1,44 @@
+module Paperclip
+  class UploadedFileAdapter < AbstractAdapter
+    def self.register
+      Paperclip.io_adapters.register self do |target|
+        target.class.name.include?("UploadedFile")
+      end
+    end
+
+    def initialize(target, options = {})
+      super
+      cache_current_values
+
+      @tempfile = if @target.respond_to?(:tempfile)
+                    copy_to_tempfile(@target.tempfile)
+                  else
+                    copy_to_tempfile(@target)
+                  end
+    end
+
+    class << self
+      attr_accessor :content_type_detector
+    end
+
+    private
+
+    def cache_current_values
+      self.original_filename = @target.original_filename
+      @content_type = determine_content_type
+      @size = File.size(@target.path)
+    end
+
+    def content_type_detector
+      self.class.content_type_detector || Paperclip::ContentTypeDetector
+    end
+
+    def determine_content_type
+      content_type = @target.content_type.to_s.strip
+      content_type = content_type_detector.new(@target.path).detect if content_type_detector
+      content_type
+    end
+  end
+end
+
+Paperclip::UploadedFileAdapter.register

data/lib/paperclip/io_adapters/uri_adapter.rb

@@ -0,0 +1,68 @@
+require "open-uri"
+
+module Paperclip
+  class UriAdapter < AbstractAdapter
+    attr_writer :content_type
+
+    def self.register
+      Paperclip.io_adapters.register self do |target|
+        target.is_a?(URI)
+      end
+    end
+
+    def initialize(target, options = {})
+      super
+      @content = download_content
+      cache_current_values
+      @tempfile = copy_to_tempfile(@content)
+    end
+
+    private
+
+    def cache_current_values
+      self.content_type = content_type_from_content || "text/html"
+
+      self.original_filename = filename_from_content_disposition ||
+                               filename_from_path || default_filename
+      @size = @content.size
+    end
+
+    def content_type_from_content
+      @content.meta["content-type"].presence
+    end
+
+    def filename_from_content_disposition
+      if @content.meta.key?("content-disposition") && @content.meta["content-disposition"].match(/filename/i)
+        # can include both filename and filename* values according to RCF6266. filename should come first
+        _, filename = @content.meta["content-disposition"].split(/filename\*?\s*=\s*/i)
+
+        # filename can be enclosed in quotes or not
+        matches = filename.match(/"(.*)"/)
+        matches ? matches[1] : filename.split(";")[0]
+      end
+    end
+
+    def filename_from_path
+      @target.path.split("/").last
+    end
+
+    def default_filename
+      "index.html"
+    end
+
+    def download_content
+      options = { read_timeout: Paperclip.options[:read_timeout] }.compact
+
+      open(@target, **options)
+    end
+
+    def copy_to_tempfile(src)
+      while data = src.read(16 * 1024)
+        destination.write(data)
+      end
+      src.close
+      destination.rewind
+      destination
+    end
+  end
+end