Class: CarrierWave::SanitizedFile
- Inherits:
-
Object
- Object
- CarrierWave::SanitizedFile
- Defined in:
- lib/carrierwave/sanitized_file.rb
Overview
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 Attribute Summary collapse
Instance Attribute Summary collapse
-
#file ⇒ Object
readonly
Returns the value of attribute file.
Instance Method Summary collapse
-
#basename ⇒ Object
Returns the part of the filename before the extension.
-
#content_type ⇒ Object
Returns the content type of the file.
-
#content_type=(type) ⇒ Object
Sets the content type of the file.
-
#copy!(new_path) ⇒ Object
Helper to create copy of file in new path.
-
#copy_to(new_path, permissions = nil, directory_permissions = nil) ⇒ CarrierWave::SanitizedFile
Creates a copy of this file and moves it to the given path.
-
#delete ⇒ Object
Removes the file from the filesystem.
-
#empty? ⇒ Boolean
Returns.
-
#exists? ⇒ Boolean
Returns.
-
#extension ⇒ Object
Returns the file extension.
-
#filename ⇒ Object
(also: #identifier)
Returns the filename, sanitized to strip out any evil characters.
-
#initialize(file) ⇒ SanitizedFile
constructor
A new instance of SanitizedFile.
-
#is_path? ⇒ Boolean
Returns.
-
#move!(new_path) ⇒ Object
Helper to move file to new path.
-
#move_to(new_path, permissions = nil, directory_permissions = nil, keep_filename = false) ⇒ Object
Moves the file to the given path.
-
#original_filename ⇒ Object
Returns the filename as is, without sanitizing it.
-
#path ⇒ Object
Returns the full path to the file.
-
#read ⇒ Object
Returns the contents of the file.
-
#sanitize_regexp ⇒ Object
Used to sanitize the file name.
-
#size ⇒ Object
Returns the file’s size.
-
#to_file ⇒ Object
Returns a File object, or nil if it does not exist.
Constructor Details
#initialize(file) ⇒ SanitizedFile
Returns a new instance of SanitizedFile.
33 34 35 36 |
# File 'lib/carrierwave/sanitized_file.rb', line 33 def initialize(file) self.file = file @content = nil end |
Class Attribute Details
.sanitize_regexp ⇒ Object
28 29 30 |
# File 'lib/carrierwave/sanitized_file.rb', line 28 def sanitize_regexp @sanitize_regexp ||= /[^[:word:]\.\-\+]/ end |
Instance Attribute Details
#file ⇒ Object
Returns the value of attribute file.
23 24 25 |
# File 'lib/carrierwave/sanitized_file.rb', line 23 def file @file end |
Instance Method Details
#basename ⇒ Object
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
75 76 77 |
# File 'lib/carrierwave/sanitized_file.rb', line 75 def basename split_extension(filename)[0] if filename end |
#content_type ⇒ Object
Returns the content type of the file.
Returns
- String
-
the content type of the file
267 268 269 270 271 272 273 274 |
# File 'lib/carrierwave/sanitized_file.rb', line 267 def content_type return @content_type if @content_type if @file.respond_to?(:content_type) and @file.content_type @content_type = @file.content_type.to_s.chomp elsif path @content_type = ::MIME::Types.type_for(path).first.to_s end end |
#content_type=(type) ⇒ Object
Sets the content type of the file.
Returns
- String
-
the content type of the file
283 284 285 |
# File 'lib/carrierwave/sanitized_file.rb', line 283 def content_type=(type) @content_type = type end |
#copy!(new_path) ⇒ Object
Helper to create copy of file in new path.
233 234 235 236 237 238 239 |
# File 'lib/carrierwave/sanitized_file.rb', line 233 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 |
#copy_to(new_path, permissions = nil, directory_permissions = nil) ⇒ CarrierWave::SanitizedFile
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
220 221 222 223 224 225 226 227 228 |
# File 'lib/carrierwave/sanitized_file.rb', line 220 def copy_to(new_path, =nil, =nil) return if self.empty? new_path = File.(new_path) mkdir!(new_path, ) copy!(new_path) chmod!(new_path, ) self.class.new({:tempfile => new_path, :content_type => content_type}) end |
#delete ⇒ Object
Removes the file from the filesystem.
244 245 246 |
# File 'lib/carrierwave/sanitized_file.rb', line 244 def delete FileUtils.rm(self.path) if exists? end |
#empty? ⇒ Boolean
Returns
- Boolean
-
whether the file is valid and has a non-zero size
140 141 142 |
# File 'lib/carrierwave/sanitized_file.rb', line 140 def empty? @file.nil? || self.size.nil? || (self.size.zero? && ! self.exists?) end |
#exists? ⇒ Boolean
Returns
- Boolean
-
Whether the file exists
149 150 151 |
# File 'lib/carrierwave/sanitized_file.rb', line 149 def exists? self.path.present? && File.exist?(self.path) end |
#extension ⇒ Object
Returns the file extension
Returns
- String
-
the extension
86 87 88 |
# File 'lib/carrierwave/sanitized_file.rb', line 86 def extension split_extension(filename)[1] if filename end |
#filename ⇒ Object Also known as: identifier
Returns the filename, sanitized to strip out any evil characters.
Returns
- String
-
the sanitized filename
61 62 63 |
# File 'lib/carrierwave/sanitized_file.rb', line 61 def filename sanitize(original_filename) if original_filename end |
#is_path? ⇒ Boolean
Returns
- Boolean
-
whether the file is supplied as a pathname or string.
131 132 133 |
# File 'lib/carrierwave/sanitized_file.rb', line 131 def is_path? !!((@file.is_a?(String) || @file.is_a?(Pathname)) && !@file.blank?) end |
#move!(new_path) ⇒ Object
Helper to move file to new path.
199 200 201 202 203 204 205 |
# File 'lib/carrierwave/sanitized_file.rb', line 199 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 |
#move_to(new_path, permissions = nil, directory_permissions = nil, keep_filename = false) ⇒ Object
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.
182 183 184 185 186 187 188 189 190 191 192 193 194 195 |
# File 'lib/carrierwave/sanitized_file.rb', line 182 def move_to(new_path, =nil, =nil, keep_filename=false) return if self.empty? new_path = File.(new_path) mkdir!(new_path, ) move!(new_path) chmod!(new_path, ) if keep_filename self.file = {:tempfile => new_path, :filename => original_filename, :content_type => content_type} else self.file = {:tempfile => new_path, :content_type => content_type} end self end |
#original_filename ⇒ Object
Returns the filename as is, without sanitizing it.
Returns
- String
-
the unsanitized filename
45 46 47 48 49 50 51 52 |
# File 'lib/carrierwave/sanitized_file.rb', line 45 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 |
#path ⇒ Object
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.
116 117 118 119 120 121 122 123 124 |
# File 'lib/carrierwave/sanitized_file.rb', line 116 def path unless @file.blank? if is_path? File.(@file) elsif @file.respond_to?(:path) and not @file.path.blank? File.(@file.path) end end end |
#read ⇒ Object
Returns the contents of the file.
Returns
- String
-
contents of the file
160 161 162 163 164 165 166 167 168 169 170 171 |
# File 'lib/carrierwave/sanitized_file.rb', line 160 def read if @content @content elsif is_path? File.open(@file, "rb") {|file| file.read} else @file.try(:rewind) @content = @file.read @file.try(:close) unless @file.try(:closed?) @content end end |
#sanitize_regexp ⇒ Object
Used to sanitize the file name. Public to allow overriding for non-latin characters.
Returns
- Regexp
-
the regexp for sanitizing the file name
294 295 296 |
# File 'lib/carrierwave/sanitized_file.rb', line 294 def sanitize_regexp CarrierWave::SanitizedFile.sanitize_regexp end |
#size ⇒ Object
Returns the file’s size.
Returns
- Integer
-
the file’s size in bytes.
97 98 99 100 101 102 103 104 105 106 107 |
# File 'lib/carrierwave/sanitized_file.rb', line 97 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 |
#to_file ⇒ Object
Returns a File object, or nil if it does not exist.
Returns
- File
-
a File object representing the SanitizedFile
255 256 257 258 |
# File 'lib/carrierwave/sanitized_file.rb', line 255 def to_file return @file if @file.is_a?(File) File.open(path, "rb") if exists? end |