Module: Paperclip::Storage::Filesystem

Defined in:
lib/paperclip/storage/filesystem.rb

Overview

The default place to store attachments is in the filesystem. Files on the local filesystem can be very easily served by Apache without requiring a hit to your app. They also can be processed more easily after they’ve been saved, as they’re just normal files. There is one Filesystem-specific option for has_attached_file.

  • path: The location of the repository of attachments on disk. This can (and, in almost all cases, should) be coordinated with the value of the url option to allow files to be saved into a place where Apache can serve them without hitting your app. Defaults to “:rails_root/public/:attachment/:id/:style/:basename.:extension” By default this places the files in the app’s public directory which can be served directly. If you are using capistrano for deployment, a good idea would be to make a symlink to the capistrano-created system directory from inside your app’s public directory. See Paperclip::Attachment#interpolate for more information on variable interpolaton.

    :path => "/var/app/attachments/:class/:id/:style/:basename.:extension"

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.extended(base) ⇒ Object 



19
20
 
# File 'lib/paperclip/storage/filesystem.rb', line 19

def self.extended base
end

Instance Method Details

#exists?(style_name = default_style) ⇒ Boolean

Returns:

  • (Boolean) 


22
23
24
25
26
27
28
 
# File 'lib/paperclip/storage/filesystem.rb', line 22

def exists?(style_name = default_style)
  if original_filename
    File.exist?(path(style_name))
  else
    false
  end
end

#flush_deletes ⇒ Object

:nodoc:



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/paperclip/storage/filesystem.rb', line 55

def flush_deletes #:nodoc:
  @queued_for_delete.each do |path|
    begin
      log("deleting #{path}")
      FileUtils.rm(path) if File.exist?(path)
    rescue Errno::ENOENT => e
      # ignore file-not-found, let everything else pass
    end
    begin
      while(true)
        path = File.dirname(path)
        FileUtils.rmdir(path)
        break if File.exists?(path) # Ruby 1.9.2 does not raise if the removal failed.
      end
    rescue Errno::EEXIST, Errno::ENOTEMPTY, Errno::ENOENT, Errno::EINVAL, Errno::ENOTDIR, Errno::EACCES
      # Stop trying to remove parent directories
    rescue SystemCallError => e
      log("There was an unexpected error while deleting directories: #{e.class}")
      # Ignore it
    end
  end
  @queued_for_delete = []
end

#flush_writes ⇒ Object

:nodoc:



36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
 
# File 'lib/paperclip/storage/filesystem.rb', line 36

def flush_writes #:nodoc:
  @queued_for_write.each do |style_name, file|
    file.close
    FileUtils.mkdir_p(File.dirname(path(style_name)))
    log("saving #{path(style_name)}")
    begin
      FileUtils.mv(file.path, path(style_name))
    rescue SystemCallError
      FileUtils.cp(file.path, path(style_name))
      FileUtils.rm(file.path)
    end
    FileUtils.chmod(0666&~File.umask, path(style_name))
  end

  after_flush_writes # allows attachment to clean up temp files

  @queued_for_write = {}
end

#to_file(style_name = default_style) ⇒ Object

Returns representation of the data of the file assigned to the given style, in the format most representative of the current storage.



32
33
34
 
# File 'lib/paperclip/storage/filesystem.rb', line 32

def to_file style_name = default_style
  @queued_for_write[style_name] || (File.new(path(style_name), 'rb') if exists?(style_name))
end