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.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(file) ⇒ SanitizedFile

Returns a new instance of SanitizedFile.



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

def initialize(file)
  self.file = file
end

Instance Attribute Details

#file ⇒ Object

Returns the value of attribute file.



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

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



60
61
62
 
# File 'lib/carrierwave/sanitized_file.rb', line 60

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



219
220
221
222
 
# File 'lib/carrierwave/sanitized_file.rb', line 219

def content_type
  return @content_type if @content_type
  @file.content_type.chomp if @file.respond_to?(:content_type) and @file.content_type
end

#copy_to(new_path, 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

Returns

Returns:



191
192
193
194
195
196
197
198
199
200
201
202
203
 
# File 'lib/carrierwave/sanitized_file.rb', line 191

def copy_to(new_path, permissions=nil)
  return if self.empty?
  new_path = File.expand_path(new_path)

  mkdir!(new_path)
  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(new_path)
end

#delete ⇒ Object

Removes the file from the filesystem.



208
209
210
 
# File 'lib/carrierwave/sanitized_file.rb', line 208

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

#empty? ⇒ Boolean Also known as: blank?

Returns

Boolean

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

Returns:

  • (Boolean) 


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

def empty?
  @file.nil? || self.size.nil? || self.size.zero?
end

#exists? ⇒ Boolean

Returns

Boolean

Whether the file exists

Returns:

  • (Boolean) 


136
137
138
139
 
# File 'lib/carrierwave/sanitized_file.rb', line 136

def exists?
  return File.exists?(self.path) if self.path
  return false
end

#extension ⇒ Object

Returns the file extension

Returns

String

the extension



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

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



46
47
48
 
# File 'lib/carrierwave/sanitized_file.rb', line 46

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) 


116
117
118
 
# File 'lib/carrierwave/sanitized_file.rb', line 116

def is_path?
  !!((@file.is_a?(String) || @file.is_a?(Pathname)) && !@file.blank?)
end

#move_to(new_path, permissions = nil) ⇒ 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.



165
166
167
168
169
170
171
172
173
174
175
176
177
 
# File 'lib/carrierwave/sanitized_file.rb', line 165

def move_to(new_path, permissions=nil)
  return if self.empty?
  new_path = File.expand_path(new_path)

  mkdir!(new_path)
  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)
  self.file = new_path
end

#original_filename ⇒ Object

Returns the filename as is, without sanizting it.

Returns

String

the unsanitized filename



30
31
32
33
34
35
36
37
 
# File 'lib/carrierwave/sanitized_file.rb', line 30

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.



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

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

#read ⇒ Object

Returns the contents of the file.

Returns

String

contents of the file



148
149
150
151
152
153
154
155
 
# File 'lib/carrierwave/sanitized_file.rb', line 148

def read
  if is_path?
    File.read(@file)
  else
    @file.rewind if @file.respond_to?(:rewind)
    @file.read
  end
end

#size ⇒ Object

Returns the file’s size.

Returns

Integer

the file’s size in bytes.



82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/carrierwave/sanitized_file.rb', line 82

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