dragonfly 0.8.6 → 0.9.0

data/lib/dragonfly/middleware.rb

@@ -1,34 +1,20 @@
 module Dragonfly
   class Middleware
 
-    def initialize(app, dragonfly_app_name, path_prefix)
+    def initialize(app, dragonfly_app_name, deprecated_arg=nil)
+      raise ArgumentError, "mounting Dragonfly::Middleware with a mount point is deprecated - just use Dragonfly::Middleware, #{dragonfly_app_name.inspect}" if deprecated_arg
       @app = app
-      @endpoint = Rack::Builder.new {
-        map path_prefix do
-          run Dragonfly[dragonfly_app_name]
-        end
-      }.to_app
+      @dragonfly_app_name = dragonfly_app_name
     end
 
     def call(env)
-      response = @endpoint.call(env)
-      if route_not_found?(response)
+      response = Dragonfly[@dragonfly_app_name].call(env)
+      if response[1]['X-Cascade'] == 'pass'
         @app.call(env)
       else
         response
       end
     end
 
-    private
-
-    def route_not_found?(response)
-      response[1]['X-Cascade'] == 'pass' ||
-        (rack_version_doesnt_support_x_cascade? && response[0] == 404)
-    end
-
-    def rack_version_doesnt_support_x_cascade?
-      Rack.version < '1.1'
-    end
-
   end
 end

data/lib/dragonfly/processing/image_magick_processor.rb

@@ -1,99 +1,6 @@
 module Dragonfly
   module Processing
-    class ImageMagickProcessor
-
-      GRAVITIES = {
-        'nw' => 'NorthWest',
-        'n'  => 'North',
-        'ne' => 'NorthEast',
-        'w'  => 'West',
-        'c'  => 'Center',
-        'e'  => 'East',
-        'sw' => 'SouthWest',
-        's'  => 'South',
-        'se' => 'SouthEast'
-      }
-      
-      # Geometry string patterns
-      RESIZE_GEOMETRY         = /^\d*x\d*[><%^!]?$|^\d+@$/ # e.g. '300x200!'
-      CROPPED_RESIZE_GEOMETRY = /^(\d+)x(\d+)#(\w{1,2})?$/ # e.g. '20x50#ne'
-      CROP_GEOMETRY           = /^(\d+)x(\d+)([+-]\d+)?([+-]\d+)?(\w{1,2})?$/ # e.g. '30x30+10+10'
-      THUMB_GEOMETRY = Regexp.union RESIZE_GEOMETRY, CROPPED_RESIZE_GEOMETRY, CROP_GEOMETRY
-      
-      include ImageMagickUtils
-      
-      def resize(temp_object, geometry)
-        convert(temp_object, "-resize '#{geometry}'")
-      end
-      
-      def crop(temp_object, opts={})
-        width   = opts[:width]
-        height  = opts[:height]
-        gravity = GRAVITIES[opts[:gravity]]
-        x       = "#{opts[:x] || 0}"
-        x = '+' + x unless x[/^[+-]/]
-        y       = "#{opts[:y] || 0}"
-        y = '+' + y unless y[/^[+-]/]
-      
-        convert(temp_object, "-crop #{width}x#{height}#{x}#{y}#{" -gravity #{gravity}" if gravity}")
-      end
-      
-      def flip(temp_object)
-        convert(temp_object, "-flip")
-      end
-      
-      def flop(temp_object)
-        convert(temp_object, "-flop")
-      end
-      
-      def greyscale(temp_object)
-        convert(temp_object, "-colorspace Gray")
-      end
-      alias grayscale greyscale
-      
-      def resize_and_crop(temp_object, opts={})
-        attrs          = identify(temp_object)
-        current_width  = attrs[:width].to_i
-        current_height = attrs[:height].to_i
-        
-        width   = opts[:width]  ? opts[:width].to_i  : current_width
-        height  = opts[:height] ? opts[:height].to_i : current_height
-        gravity = opts[:gravity] || 'c'
-
-        if width != current_width || height != current_height
-          scale = [width.to_f / current_width, height.to_f / current_height].max
-          temp_object = TempObject.new(resize(temp_object, "#{(scale * current_width).ceil}x#{(scale * current_height).ceil}"))
-        end
-
-        crop(temp_object, :width => width, :height => height, :gravity => gravity)
-      end
-      
-      def rotate(temp_object, amount, opts={})
-        convert(temp_object, "-rotate '#{amount}#{opts[:qualifier]}'")
-      end
-      
-      def thumb(temp_object, geometry)
-        case geometry
-        when RESIZE_GEOMETRY
-          resize(temp_object, geometry)
-        when CROPPED_RESIZE_GEOMETRY
-          resize_and_crop(temp_object, :width => $1, :height => $2, :gravity => $3)
-        when CROP_GEOMETRY
-          crop(temp_object,
-            :width => $1,
-            :height => $2,
-            :x => $3,
-            :y => $4,
-            :gravity => $5
-          )
-        else raise ArgumentError, "Didn't recognise the geometry string #{geometry}"
-        end
-      end
-      
-      def convert(temp_object, args='', format=nil)
-        format ? [super, {:format => format.to_sym}] : super
-      end
-      
-    end
+    puts "WARNING: Dragonfly::Processing::ImageMagickProcessor is DEPRECATED and will soon be removed. Please use Dragonfly::ImageMagick::Processor instead."
+    ImageMagickProcessor = ImageMagick::Processor
   end
 end

data/lib/dragonfly/rails/images.rb

@@ -1,5 +1,4 @@
 require 'dragonfly'
-require 'rack/cache'
 require 'uri'
 
 ### The dragonfly app ###
@@ -8,15 +7,21 @@ app.configure_with(:rails)
 app.configure_with(:imagemagick)
 
 ### Extend active record ###
-app.define_macro(ActiveRecord::Base, :image_accessor)
+if defined?(ActiveRecord::Base)
+  app.define_macro(ActiveRecord::Base, :image_accessor)
+  app.define_macro(ActiveRecord::Base, :file_accessor)
+end
 
 ### Insert the middleware ###
-# Where the middleware is depends on the version of Rails
-middleware = Rails.respond_to?(:application) ? Rails.application.middleware : ActionController::Dispatcher.middleware
+Rails.application.middleware.insert 0, 'Dragonfly::Middleware', :images
 
-middleware.insert_after 'Rack::Lock', 'Dragonfly::Middleware', :images, app.url_path_prefix
-middleware.insert_before 'Dragonfly::Middleware', 'Rack::Cache', {
-  :verbose     => true,
-  :metastore   => URI.encode("file:#{Rails.root}/tmp/dragonfly/cache/meta"), # URI encoded because Windows
-  :entitystore => URI.encode("file:#{Rails.root}/tmp/dragonfly/cache/body")  # has problems with spaces
-}
+begin
+  require 'rack/cache'
+  Rails.application.middleware.insert_before 'Dragonfly::Middleware', 'Rack::Cache', {
+    :verbose     => true,
+    :metastore   => URI.encode("file:#{Rails.root}/tmp/dragonfly/cache/meta"), # URI encoded because Windows
+    :entitystore => URI.encode("file:#{Rails.root}/tmp/dragonfly/cache/body")  # has problems with spaces
+  }
+rescue LoadError => e  
+  app.log.warn("Warning: couldn't find rack-cache for caching dragonfly content")
+end

data/lib/dragonfly/response.rb

@@ -3,12 +3,9 @@ require 'uri'
 module Dragonfly
   class Response
 
-    DEFAULT_FILENAME = proc{|job, request|
-      if job.basename
-        extname = job.encoded_extname || (".#{job.ext}" if job.ext)
-        "#{job.basename}#{extname}"
-      end
-    }
+    DEFAULT_FILENAME = proc do |job, request|
+      [job.basename, job.format].compact.join('.') if job.basename
+    end
 
     def initialize(job, env)
       @job, @env = job, env
@@ -21,12 +18,19 @@ module Dragonfly
       elsif etag_matches?
         [304, cache_headers, []]
       elsif request.head?
-        [200, success_headers.merge(cache_headers), []]
+        job.apply
+        [200, success_headers, []]
       elsif request.get?
-        [200, success_headers.merge(cache_headers), job.result]
+        job.apply
+        [200, success_headers, job.result]
       end
     rescue DataStorage::DataNotFound => e
-      [404, {"Content-Type" => 'text/plain'}, [e.message]]
+      app.log.warn(e.message)
+      [404, {"Content-Type" => 'text/plain'}, ['Not found']]
+    end
+
+    def will_be_served?
+      request.get? && !etag_matches?
     end
 
     private
@@ -45,8 +49,9 @@ module Dragonfly
     end
 
     def etag_matches?
+      return @etag_matches unless @etag_matches.nil?
       if_none_match = env['HTTP_IF_NONE_MATCH']
-      if if_none_match
+      @etag_matches = if if_none_match
         if_none_match.tr!('"','')
         if_none_match.split(',').include?(job.unique_signature) || if_none_match == '*'
       else
@@ -56,9 +61,11 @@ module Dragonfly
 
     def success_headers
       {
-        "Content-Type" => job.resolve_mime_type,
+        "Content-Type" => job.mime_type,
         "Content-Length" => job.size.to_s
-      }.merge(content_disposition_header)
+      }.merge(content_disposition_header).
+        merge(cache_headers).
+        merge(custom_headers)
     end
 
     def content_disposition_header
@@ -83,6 +90,13 @@ module Dragonfly
       @filename ||= evaluate(app.content_filename)
     end
 
+    def custom_headers
+      @custom_headers ||= app.response_headers.inject({}) do |headers, (k, v)|
+        headers[k] = evaluate(v)
+        headers
+      end
+    end
+
     def evaluate(attribute)
       attribute.respond_to?(:call) ? attribute.call(job, request) : attribute
     end

data/lib/dragonfly/serializer.rb

@@ -6,7 +6,6 @@ module Dragonfly
     
     # Exceptions
     class BadString < RuntimeError; end
-    class MaliciousString < RuntimeError; end
     
     extend self # So we can do Serializer.b64_encode, etc.
     
@@ -24,9 +23,7 @@ module Dragonfly
     end
     
     def marshal_decode(string)
-      marshal_string = b64_decode(string)
-      raise MaliciousString, "potentially malicious marshal string #{marshal_string.inspect}" if marshal_string[/@[a-z_]/i]
-      Marshal.load(marshal_string)
+      Marshal.load(b64_decode(string))
     rescue TypeError, ArgumentError => e
       raise BadString, "couldn't decode #{string} - got #{e}"
     end

data/lib/dragonfly/server.rb

@@ -0,0 +1,103 @@
+module Dragonfly
+  class Server
+
+    include Loggable
+    include Configurable
+    
+    configurable_attr :dragonfly_url, '/dragonfly'
+    configurable_attr :protect_from_dos_attacks, false
+    configurable_attr :url_format, '/:job/:basename.:format'
+    configurable_attr :url_host
+
+    extend Forwardable
+    def_delegator :url_mapper, :params_in_url
+    
+    def initialize(app)
+      @app = app
+      use_same_log_as(app)
+      use_as_fallback_config(app)
+    end
+    
+    def before_serve(&block)
+      self.before_serve_callback = block
+    end
+    configuration_method :before_serve
+    
+    def call(env)
+      if dragonfly_url == env["PATH_INFO"]
+        dragonfly_response
+      elsif (params = url_mapper.params_for(env["PATH_INFO"], env["QUERY_STRING"])) && params['job']
+        job = Job.deserialize(params['job'], app)
+        job.validate_sha!(params['sha']) if protect_from_dos_attacks
+        response = Response.new(job, env)
+        catch(:halt) do
+          if before_serve_callback && response.will_be_served?
+            before_serve_callback.call(job, env)
+          end
+          response.to_response
+        end
+      else
+        [404, {'Content-Type' => 'text/plain', 'X-Cascade' => 'pass'}, ['Not found']]
+      end
+    rescue Serializer::BadString, Job::InvalidArray => e
+      log.warn(e.message)
+      [404, {'Content-Type' => 'text/plain'}, ['Not found']]
+    rescue Job::NoSHAGiven => e
+      [400, {"Content-Type" => 'text/plain'}, ["You need to give a SHA parameter"]]
+    rescue Job::IncorrectSHA => e
+      [400, {"Content-Type" => 'text/plain'}, ["The SHA parameter you gave (#{e}) is incorrect"]]
+    end
+
+    def url_for(job, opts={})
+      opts = opts.dup
+      host = opts.delete(:host) || url_host
+      params = stringify_keys(opts)
+      params['job'] = job.serialize
+      params['sha'] = job.sha if protect_from_dos_attacks
+      url = url_mapper.url_for(params)
+      "#{host}#{url}"
+    end
+
+    private
+    
+    attr_reader :app
+    attr_accessor :before_serve_callback
+
+    def url_mapper
+      @url_mapper ||= UrlMapper.new(url_format,
+        :job => '[\w+]',
+        :basename => '[^\/]',
+        :format => '[^\.]'
+      )
+    end
+
+    def stringify_keys(params)
+      params.inject({}) do |hash, (k, v)|
+        hash[k.to_s] = v
+        hash
+      end
+    end
+
+    def dragonfly_response
+      body = <<-DRAGONFLY
+          _o|o_
+  _~~---._(   )_.---~~_
+ (       . \\ / .       )
+  `-.~--'  |=|  '--~.-'
+  _~-.~'" /|=|\\ "'~.-~_
+ (      ./ |=| \\.      )
+  `~~`"`   |=|   `"'ME"
+           |-|
+           <->
+            V
+      DRAGONFLY
+      [200, {
+        'Content-Type' => 'text/plain',
+        'Content-Size' => body.bytesize.to_s
+        },
+        [body]
+      ]
+    end
+
+  end
+end

data/lib/dragonfly/temp_object.rb

@@ -1,5 +1,6 @@
 require 'stringio'
 require 'tempfile'
+require 'pathname'
 
 module Dragonfly
 
@@ -10,6 +11,7 @@ module Dragonfly
   # You can initialize it various ways:
   #
   #   temp_object = Dragonfly::TempObject.new('this is the content')           # with a String
+  #   temp_object = Dragonfly::TempObject.new(Pathname.new('path/to/content')) # with a Pathname
   #   temp_object = Dragonfly::TempObject.new(File.new('path/to/content'))     # with a File
   #   temp_object = Dragonfly::TempObject.new(some_tempfile)                   # with a Tempfile
   #   temp_object = Dragonfly::TempObject.new(some_other_temp_object)          # with another TempObject
@@ -40,27 +42,43 @@ module Dragonfly
 
     # Instance Methods
 
-    def initialize(obj, opts={})
-      opts ||= {} # in case it's nil
-      initialize_from_object!(obj)
-      validate_options!(opts)
-      extract_attributes_from(opts)
+    def initialize(obj)
+      if obj.is_a? TempObject
+        @data = obj.get_data
+        @tempfile = obj.get_tempfile
+        @pathname = obj.get_pathname
+      elsif obj.is_a? String
+        @data = obj
+      elsif obj.is_a? Tempfile
+        @tempfile = obj
+      elsif obj.is_a? File
+        @pathname = Pathname.new(obj.path)
+        @original_filename = @pathname.basename.to_s
+      elsif obj.is_a? Pathname
+        @pathname = obj
+        @original_filename = @pathname.basename.to_s
+      elsif obj.respond_to?(:tempfile)
+        @tempfile = obj.tempfile
+      else
+        raise ArgumentError, "#{self.class.name} must be initialized with a String, a Pathname, a File, a Tempfile, another TempObject, or something that responds to .tempfile"
+      end
+      @tempfile.close if @tempfile
+      @original_filename = obj.original_filename if obj.respond_to?(:original_filename)
     end
+    
+    attr_reader :original_filename
 
     def data
-      @data ||= initialized_data || file{|f| f.read }
+      @data ||= file{|f| f.read }
     end
 
     def tempfile
       @tempfile ||= begin
-        case initialized_with
-        when :tempfile
-          @tempfile = initialized_tempfile
-          @tempfile.close
-        when :data
-          @tempfile = new_tempfile(initialized_data)
-        when :file
-          @tempfile = copy_to_tempfile(initialized_file.path)
+        case
+        when @data
+          @tempfile = new_tempfile(@data)
+        when @pathname
+          @tempfile = copy_to_tempfile(@pathname.expand_path)
         end
         @tempfile
       end
@@ -79,31 +97,11 @@ module Dragonfly
     end
 
     def path
-      tempfile.path
+      @pathname ? @pathname.expand_path.to_s : tempfile.path
     end
 
     def size
-      if initialized_data
-        initialized_data.bytesize
-      else
-        File.size(path)
-      end
-    end
-
-    attr_accessor :name, :format
-    alias _format format
-    attr_writer :meta
-
-    def meta
-      @meta ||= {}
-    end
-
-    def basename
-      File.basename(name, '.*') if name
-    end
-
-    def ext
-      File.extname(name)[/\.(.*)/, 1] if name
+      @data ? @data.bytesize : File.size(path)
     end
 
     def each(&block)
@@ -115,8 +113,8 @@ module Dragonfly
     end
 
     def to_file(path)
-      if initialized_data
-        File.open(path, 'wb'){|f| f.write(initialized_data) }
+      if @data
+        File.open(path, 'wb'){|f| f.write(@data) }
       else
         FileUtils.cp(self.path, path)
       end
@@ -124,90 +122,47 @@ module Dragonfly
     end
 
     def to_io(&block)
-      if initialized_data
-        StringIO.open(initialized_data, 'rb', &block)
-      else
-        file(&block)
-      end
-    end
-
-    def attributes
-      {
-        :name => name,
-        :meta => meta,
-        :format => format
-      }
-    end
-
-    def extract_attributes_from(hash)
-      self.name   = hash.delete(:name)     unless hash[:name].blank?
-      self.format = hash.delete(:format)   unless hash[:format].blank?
-      self.meta.merge!(hash.delete(:meta)) unless hash[:meta].blank?
+      @data ? StringIO.open(@data, 'rb', &block) : file(&block)
     end
 
     def inspect
-      content_string = case initialized_with
-      when :data
-        data_string = size > 20 ? "#{initialized_data[0..20]}..." : initialized_data
+      content_string = case
+      when @data
+        data_string = size > 20 ? "#{@data[0..20]}..." : @data
         "data=#{data_string.inspect}"
-      when :file then "file=#{initialized_file.inspect}"
-      when :tempfile then "tempfile=#{initialized_tempfile.inspect}"
+      when @pathname then "pathname=#{@pathname.inspect}"
+      when @tempfile then "tempfile=#{@tempfile.inspect}"
       end
-      to_s.sub(/>$/, " #{content_string}, @meta=#{@meta.inspect}, @name=#{@name.inspect} >")
+      to_s.sub(/>$/, " #{content_string} >")
     end
 
     protected
 
-    attr_accessor :initialized_data, :initialized_tempfile, :initialized_file
-
-    private
-
-    def initialize_from_object!(obj)
-      if obj.is_a? TempObject
-        @initialized_data = obj.initialized_data
-        @initialized_tempfile = copy_to_tempfile(obj.initialized_tempfile.path) if obj.initialized_tempfile
-        @initialized_file = obj.initialized_file
-      elsif obj.is_a? String
-        @initialized_data = obj
-      elsif obj.is_a? Tempfile
-        @initialized_tempfile = obj
-      elsif obj.is_a? File
-        @initialized_file = obj
-        self.name = File.basename(obj.path)
-      elsif obj.respond_to?(:tempfile)
-        @initialized_tempfile = obj.tempfile
-      else
-        raise ArgumentError, "#{self.class.name} must be initialized with a String, a File, a Tempfile, another TempObject, or something that responds to .tempfile"
-      end
-      self.name = obj.original_filename if obj.respond_to?(:original_filename)
+    # We don't use normal accessors here because #data etc. do more than just return the instance var
+    def get_data
+      @data
     end
-
-    def initialized_with
-      if initialized_tempfile
-        :tempfile
-      elsif initialized_data
-        :data
-      elsif initialized_file
-        :file
-      end
+    
+    def get_pathname
+      @pathname
+    end
+    
+    def get_tempfile
+      @tempfile
     end
 
+    private
+
     def block_size
       self.class.block_size
     end
 
     def copy_to_tempfile(path)
       tempfile = new_tempfile
-      FileUtils.cp File.expand_path(path), tempfile.path
+      FileUtils.cp path, tempfile.path
       tempfile
     end
 
-    def validate_options!(opts)
-      valid_keys = [:name, :meta, :format]
-      invalid_keys = opts.keys - valid_keys
-      raise ArgumentError, "Unrecognised options #{invalid_keys.inspect}" if invalid_keys.any?
-    end
-
     def new_tempfile(content=nil)
       tempfile = Tempfile.new('dragonfly')
       tempfile.binmode