Class: CarrierWave::SanitizedFile

Inherits:
Object
  • Object
show all
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

Instance Method Summary collapse

Constructor Details

#initialize(file) ⇒ SanitizedFile


28
29
30
31
# File 'lib/carrierwave/sanitized_file.rb', line 28

def initialize(file)
  self.file = file
  @content = nil
end

Class Attribute Details

.sanitize_regexpObject


23
24
25
# File 'lib/carrierwave/sanitized_file.rb', line 23

def sanitize_regexp
  @sanitize_regexp ||= /[^[:word:]\.\-\+]/
end

Instance Attribute Details

#fileObject

Returns the value of attribute file


18
19
20
# File 'lib/carrierwave/sanitized_file.rb', line 18

def file
  @file
end

Instance Method Details

#basenameObject

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


70
71
72
# File 'lib/carrierwave/sanitized_file.rb', line 70

def basename
  split_extension(filename)[0] if filename
end

#content_typeObject

Returns the content type of the file.

Returns

String

the content type of the file


261
262
263
264
265
266
# File 'lib/carrierwave/sanitized_file.rb', line 261

def content_type
  @content_type ||=
    existing_content_type ||
    mime_magic_content_type ||
    mini_mime_content_type
end

#content_type=(type) ⇒ Object

Sets the content type of the file.

Returns

String

the content type of the file


275
276
277
# File 'lib/carrierwave/sanitized_file.rb', line 275

def content_type=(type)
  @content_type = type
end

#copy!(new_path) ⇒ Object

Helper to create copy of file in new path.


227
228
229
230
231
232
233
# File 'lib/carrierwave/sanitized_file.rb', line 227

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


214
215
216
217
218
219
220
221
222
# File 'lib/carrierwave/sanitized_file.rb', line 214

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 => content_type})
end

#deleteObject

Removes the file from the filesystem.


238
239
240
# File 'lib/carrierwave/sanitized_file.rb', line 238

def delete
  FileUtils.rm(self.path) if exists?
end

#empty?Boolean

Returns

Boolean

whether the file is valid and has a non-zero size


134
135
136
# File 'lib/carrierwave/sanitized_file.rb', line 134

def empty?
  @file.nil? || self.size.nil? || (self.size.zero? && ! self.exists?)
end

#exists?Boolean

Returns

Boolean

Whether the file exists


143
144
145
# File 'lib/carrierwave/sanitized_file.rb', line 143

def exists?
  self.path.present? && File.exist?(self.path)
end

#extensionObject

Returns the file extension

Returns

String

the extension


81
82
83
# File 'lib/carrierwave/sanitized_file.rb', line 81

def extension
  split_extension(filename)[1] if filename
end

#filenameObject Also known as: identifier

Returns the filename, sanitized to strip out any evil characters.

Returns

String

the sanitized filename


56
57
58
# File 'lib/carrierwave/sanitized_file.rb', line 56

def filename
  sanitize(original_filename) if original_filename
end

#is_path?Boolean

Returns

Boolean

whether the file is supplied as a pathname or string.


125
126
127
# File 'lib/carrierwave/sanitized_file.rb', line 125

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.


193
194
195
196
197
198
199
# File 'lib/carrierwave/sanitized_file.rb', line 193

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.


176
177
178
179
180
181
182
183
184
185
186
187
188
189
# File 'lib/carrierwave/sanitized_file.rb', line 176

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)
  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_filenameObject

Returns the filename as is, without sanitizing it.

Returns

String

the unsanitized filename


40
41
42
43
44
45
46
47
# File 'lib/carrierwave/sanitized_file.rb', line 40

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

#pathObject

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.


111
112
113
114
115
116
117
118
# File 'lib/carrierwave/sanitized_file.rb', line 111

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

#readObject

Returns the contents of the file.

Returns

String

contents of the file


154
155
156
157
158
159
160
161
162
163
164
165
# File 'lib/carrierwave/sanitized_file.rb', line 154

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_regexpObject

Used to sanitize the file name. Public to allow overriding for non-latin characters.

Returns

Regexp

the regexp for sanitizing the file name


286
287
288
# File 'lib/carrierwave/sanitized_file.rb', line 286

def sanitize_regexp
  CarrierWave::SanitizedFile.sanitize_regexp
end

#sizeObject

Returns the file's size.

Returns

Integer

the file's size in bytes.


92
93
94
95
96
97
98
99
100
101
102
# File 'lib/carrierwave/sanitized_file.rb', line 92

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_fileObject

Returns a File object, or nil if it does not exist.

Returns

File

a File object representing the SanitizedFile


249
250
251
252
# File 'lib/carrierwave/sanitized_file.rb', line 249

def to_file
  return @file if @file.is_a?(File)
  File.open(path, "rb") if exists?
end