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

Returns a new instance of SanitizedFile


35
36
37
# File 'lib/carrierwave/sanitized_file.rb', line 35

def initialize(file)
  self.file = file
end

Class Attribute Details

.sanitize_regexpObject


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

def sanitize_regexp
  @sanitize_regexp ||= /[^a-zA-Z0-9\.\-\+_]/
end

Instance Attribute Details

#fileObject

Returns the value of attribute file


25
26
27
# File 'lib/carrierwave/sanitized_file.rb', line 25

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


76
77
78
# File 'lib/carrierwave/sanitized_file.rb', line 76

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


255
256
257
258
259
260
261
262
# File 'lib/carrierwave/sanitized_file.rb', line 255

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


271
272
273
# File 'lib/carrierwave/sanitized_file.rb', line 271

def content_type=(type)
  @content_type = type
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

Returns:


215
216
217
218
219
220
221
222
223
224
225
226
227
# File 'lib/carrierwave/sanitized_file.rb', line 215

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)
  if exists?
    FileUtils.cp(path, new_path) unless new_path == path
  else
    File.open(new_path, "wb") { |f| f.write(read) }
  end
  chmod!(new_path, permissions)
  self.class.new({:tempfile => new_path, :content_type => content_type})
end

#deleteObject

Removes the file from the filesystem.


232
233
234
# File 'lib/carrierwave/sanitized_file.rb', line 232

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

#empty?Boolean

Returns

Boolean

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

Returns:

  • (Boolean)

141
142
143
# File 'lib/carrierwave/sanitized_file.rb', line 141

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

#exists?Boolean

Returns

Boolean

Whether the file exists

Returns:

  • (Boolean)

150
151
152
# File 'lib/carrierwave/sanitized_file.rb', line 150

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

#extensionObject

Returns the file extension

Returns

String

the extension


87
88
89
# File 'lib/carrierwave/sanitized_file.rb', line 87

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


62
63
64
# File 'lib/carrierwave/sanitized_file.rb', line 62

def filename
  sanitize(original_filename) if original_filename
end

#is_path?Boolean

Returns

Boolean

whether the file is supplied as a pathname or string.

Returns:

  • (Boolean)

132
133
134
# File 'lib/carrierwave/sanitized_file.rb', line 132

def is_path?
  !!((@file.is_a?(String) || @file.is_a?(Pathname)) && !@file.blank?)
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.


183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
# File 'lib/carrierwave/sanitized_file.rb', line 183

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)
  if exists?
    FileUtils.mv(path, new_path) unless new_path == path
  else
    File.open(new_path, "wb") { |f| f.write(read) }
  end
  chmod!(new_path, permissions)
  if keep_filename
    self.file = {:tempfile => new_path, :filename => original_filename}
  else
    self.file = new_path
  end
  self
end

#original_filenameObject

Returns the filename as is, without sanitizing it.

Returns

String

the unsanitized filename


46
47
48
49
50
51
52
53
# File 'lib/carrierwave/sanitized_file.rb', line 46

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.


117
118
119
120
121
122
123
124
125
# File 'lib/carrierwave/sanitized_file.rb', line 117

def path
  unless @file.blank?
    if is_path?
      File.expand_path(@file)
    elsif @file.respond_to?(:path) and not @file.path.blank?
      File.expand_path(@file.path)
    end
  end
end

#readObject

Returns the contents of the file.

Returns

String

contents of the file


161
162
163
164
165
166
167
168
169
170
171
172
# File 'lib/carrierwave/sanitized_file.rb', line 161

def read
  if @content
    @content
  elsif is_path?
    File.open(@file, "rb") {|file| file.read}
  else
    @file.rewind if @file.respond_to?(:rewind)
    @content = @file.read
    @file.close if @file.respond_to?(:close) && @file.respond_to?(:closed?) && !@file.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


282
283
284
# File 'lib/carrierwave/sanitized_file.rb', line 282

def sanitize_regexp
  CarrierWave::SanitizedFile.sanitize_regexp
end

#sizeObject

Returns the file's size.

Returns

Integer

the file's size in bytes.


98
99
100
101
102
103
104
105
106
107
108
# File 'lib/carrierwave/sanitized_file.rb', line 98

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


243
244
245
246
# File 'lib/carrierwave/sanitized_file.rb', line 243

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