Class: Attachment

Inherits:
ActiveRecord::Base
  • Object
show all
Defined in:
app/models/attachment.rb

Overview

Since:

  • 0.4.0

Constant Summary collapse

@@storage_path = 
Redmine::Configuration['attachments_storage_path'] || File.join(Rails.root, "files")
@@thumbnails_storage_path = 
File.join(Rails.root, "tmp", "thumbnails")

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.attach_files(obj, attachments) ⇒ Object

Bulk attaches a set of files to an object

Returns a Hash of the results: :files => array of the attached files :unsaved => array of the files that could not be attached

Since:

  • 1.0.0



276
277
278
279
280
 
# File 'app/models/attachment.rb', line 276

def self.attach_files(obj, attachments)
  result = obj.save_attachments(attachments, User.current)
  obj.attach_saved_attachments
  result
end

.clear_thumbnails ⇒ Object

Deletes all thumbnails

Since:

  • 2.1.0



228
229
230
231
232
 
# File 'app/models/attachment.rb', line 228

def self.clear_thumbnails
  Dir.glob(File.join(thumbnails_storage_path, "*.thumb")).each do |file|
    File.delete file
  end
end

.find_by_token(token) ⇒ Object

Finds an attachment that matches the given token and that has no container

Since:

  • 1.4.0



261
262
263
264
265
266
267
268
269
 
# File 'app/models/attachment.rb', line 261

def self.find_by_token(token)
  if token.to_s =~ /^(\d+)\.([0-9a-f]+)$/
    attachment_id, attachment_digest = $1, $2
    attachment = Attachment.where(:id => attachment_id, :digest => attachment_digest).first
    if attachment && attachment.container.nil?
      attachment
    end
  end
end

.latest_attach(attachments, filename) ⇒ Object

Since:

  • 1.3.0



311
312
313
314
315
 
# File 'app/models/attachment.rb', line 311

def self.latest_attach(attachments, filename)
  attachments.sort_by(&:created_on).reverse.detect do |att|
    filename.casecmp(att.filename) == 0
  end
end

.move_from_root_to_target_directory ⇒ Object

Moves existing attachments that are stored at the root of the files directory (ie. created before Redmine 2.3) to their target subdirectories

Since:

  • 2.3.0



346
347
348
349
350
 
# File 'app/models/attachment.rb', line 346

def self.move_from_root_to_target_directory
  Attachment.where("disk_directory IS NULL OR disk_directory = ''").find_each do |attachment|
    attachment.move_to_target_directory!
  end
end

.prune(age = 1.day) ⇒ Object

Since:

  • 1.4.0



317
318
319
 
# File 'app/models/attachment.rb', line 317

def self.prune(age=1.day)
  Attachment.where("created_on < ? AND (container_type IS NULL OR container_type = '')", Time.now - age).destroy_all
end

.update_attachments(attachments, params) ⇒ Object

Updates the filename and description of a set of attachments with the given hash of attributes. Returns true if all attachments were updated.

Example:

Attachment.update_attachments(attachments, {
  4 => {:filename => 'foo'},
  7 => {:filename => 'bar', :description => 'file description'}
})

Since:

  • 3.0.0



292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
 
# File 'app/models/attachment.rb', line 292

def self.update_attachments(attachments, params)
  params = params.transform_keys {|key| key.to_i}

  saved = true
  transaction do
    attachments.each do |attachment|
      if p = params[attachment.id]
        attachment.filename = p[:filename] if p.key?(:filename)
        attachment.description = p[:description] if p.key?(:description)
        saved &&= attachment.save
      end
    end
    unless saved
      raise ActiveRecord::Rollback
    end
  end
  saved
end

.valid_extension?(extension) ⇒ Boolean

Returns true if the extension is allowed, otherwise false

Returns:

  • (Boolean)

Since:

  • 3.2.0



353
354
355
356
357
358
359
360
361
362
363
364
365
366
 
# File 'app/models/attachment.rb', line 353

def self.valid_extension?(extension)
  extension = extension.downcase.sub(/\A\.+/, '')

  denied, allowed = [:attachment_extensions_denied, :attachment_extensions_allowed].map do |setting|
    Setting.send(setting).to_s.split(",").map {|s| s.strip.downcase.sub(/\A\.+/, '')}.reject(&:blank?)
  end
  if denied.present? && denied.include?(extension)
    return false
  end
  unless allowed.blank? || allowed.include?(extension)
    return false
  end
  true
end

Instance Method Details

#copy(attributes = nil) ⇒ Object

Returns an unsaved copy of the attachment

Since:

  • 1.4.0



60
61
62
63
64
65
 
# File 'app/models/attachment.rb', line 60

def copy(attributes=nil)
  copy = self.class.new
  copy.attributes = self.attributes.dup.except("id", "downloads")
  copy.attributes = attributes if attributes
  copy
end

#deletable?(user = User.current) ⇒ Boolean

Returns:

  • (Boolean)

Since:

  • 0.8.1



186
187
188
189
190
191
192
 
# File 'app/models/attachment.rb', line 186

def deletable?(user=User.current)
  if container_id
    container && container.attachments_deletable?(user)
  else
    author == user
  end
end

#delete_from_disk ⇒ Object

Deletes the file from the file system if it's not referenced by other attachments

Since:

  • 1.3.0



143
144
145
146
147
 
# File 'app/models/attachment.rb', line 143

def delete_from_disk
  if Attachment.where("disk_filename = ? AND id <> ?", disk_filename, id).empty?
    delete_from_disk!
  end
end

#diskfile ⇒ Object

Returns file's location on disk



150
151
152
 
# File 'app/models/attachment.rb', line 150

def diskfile
  File.join(self.class.storage_path, disk_directory.to_s, disk_filename.to_s)
end

#editable?(user = User.current) ⇒ Boolean

Returns:

  • (Boolean)

Since:

  • 3.0.0



178
179
180
181
182
183
184
 
# File 'app/models/attachment.rb', line 178

def editable?(user=User.current)
  if container_id
    container && container.attachments_editable?(user)
  else
    author == user
  end
end

#file ⇒ Object 



96
97
98
 
# File 'app/models/attachment.rb', line 96

def file
  nil
end

#file=(incoming_file) ⇒ Object 



82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'app/models/attachment.rb', line 82

def file=(incoming_file)
  unless incoming_file.nil?
    @temp_file = incoming_file
      if @temp_file.respond_to?(:original_filename)
        self.filename = @temp_file.original_filename
        self.filename.force_encoding("UTF-8")
      end
      if @temp_file.respond_to?(:content_type)
        self.content_type = @temp_file.content_type.to_s.chomp
      end
      self.filesize = @temp_file.size
  end
end

#filename=(arg) ⇒ Object

Since:

  • 1.4.0



100
101
102
103
 
# File 'app/models/attachment.rb', line 100

def filename=(arg)
  write_attribute :filename, sanitize_filename(arg.to_s)
  filename
end

#files_to_final_location ⇒ Object

Copies the temporary file to its final location and computes its MD5 hash

Since:

  • 1.3.0



107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'app/models/attachment.rb', line 107

def files_to_final_location
  if @temp_file
    self.disk_directory = target_directory
    self.disk_filename = Attachment.disk_filename(filename, disk_directory)
    logger.info("Saving attachment '#{self.diskfile}' (#{@temp_file.size} bytes)") if logger
    path = File.dirname(diskfile)
    unless File.directory?(path)
      FileUtils.mkdir_p(path)
    end
    md5 = Digest::MD5.new
    File.open(diskfile, "wb") do |f|
      if @temp_file.respond_to?(:read)
        buffer = ""
        while (buffer = @temp_file.read(8192))
          f.write(buffer)
          md5.update(buffer)
        end
      else
        f.write(@temp_file)
        md5.update(@temp_file)
      end
    end
    self.digest = md5.hexdigest
  end
  @temp_file = nil

  if content_type.blank? && filename.present?
    self.content_type = Redmine::MimeType.of(filename)
  end
  # Don't save the content type if it's longer than the authorized length
  if self.content_type && self.content_type.length > 255
    self.content_type = nil
  end
end

#image? ⇒ Boolean

Returns:

  • (Boolean)

Since:

  • 0.6.0



194
195
196
 
# File 'app/models/attachment.rb', line 194

def image?
  !!(self.filename =~ /\.(bmp|gif|jpg|jpe|jpeg|png)$/i)
end

#increment_download ⇒ Object 



162
163
164
 
# File 'app/models/attachment.rb', line 162

def increment_download
  increment!(:downloads)
end

#is_diff? ⇒ Boolean

Returns:

  • (Boolean)

Since:

  • 0.8.0



242
243
244
 
# File 'app/models/attachment.rb', line 242

def is_diff?
  self.filename =~ /\.(patch|diff)$/i
end

#is_image? ⇒ Boolean

Returns:

  • (Boolean)

Since:

  • 3.3.0



238
239
240
 
# File 'app/models/attachment.rb', line 238

def is_image?
  Redmine::MimeType.is_type?('image', filename)
end

#is_pdf? ⇒ Boolean

Returns:

  • (Boolean)

Since:

  • 3.3.0



246
247
248
 
# File 'app/models/attachment.rb', line 246

def is_pdf?
  Redmine::MimeType.of(filename) == "application/pdf"
end

#is_text? ⇒ Boolean

Returns:

  • (Boolean)

Since:

  • 0.8.0



234
235
236
 
# File 'app/models/attachment.rb', line 234

def is_text?
  Redmine::MimeType.is_type?('text', filename)
end

#move_to_target_directory! ⇒ Object

Moves an existing attachment to its target directory

Since:

  • 2.3.0



322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
 
# File 'app/models/attachment.rb', line 322

def move_to_target_directory!
  return unless !new_record? & readable?

  src = diskfile
  self.disk_directory = target_directory
  dest = diskfile

  return if src == dest

  if !FileUtils.mkdir_p(File.dirname(dest))
    logger.error "Could not create directory #{File.dirname(dest)}" if logger
    return
  end

  if !FileUtils.mv(src, dest)
    logger.error "Could not move attachment from #{src} to #{dest}" if logger
    return
  end

  update_column :disk_directory, disk_directory
end

#project ⇒ Object

Since:

  • 0.5.1



166
167
168
 
# File 'app/models/attachment.rb', line 166

def project
  container.try(:project)
end

#readable? ⇒ Boolean

Returns true if the file is readable

Returns:

  • (Boolean)

Since:

  • 0.9.0



251
252
253
 
# File 'app/models/attachment.rb', line 251

def readable?
  File.readable?(diskfile)
end

#thumbnail(options = {}) ⇒ Object

Returns the full path the attachment thumbnail, or nil if the thumbnail cannot be generated.

Since:

  • 2.1.0



204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
 
# File 'app/models/attachment.rb', line 204

def thumbnail(options={})
  if thumbnailable? && readable?
    size = options[:size].to_i
    if size > 0
      # Limit the number of thumbnails per image
      size = (size / 50) * 50
      # Maximum thumbnail size
      size = 800 if size > 800
    else
      size = Setting.thumbnails_size.to_i
    end
    size = 100 unless size > 0
    target = File.join(self.class.thumbnails_storage_path, "#{id}_#{digest}_#{size}.thumb")

    begin
      Redmine::Thumbnail.generate(self.diskfile, target, size)
    rescue => e
      logger.error "An error occured while generating thumbnail for #{disk_filename} to #{target}\nException was: #{e.message}" if logger
      return nil
    end
  end
end

#thumbnailable? ⇒ Boolean

Returns:

  • (Boolean)

Since:

  • 2.1.0



198
199
200
 
# File 'app/models/attachment.rb', line 198

def thumbnailable?
  image?
end

#title ⇒ Object

Since:

  • 2.1.0



154
155
156
157
158
159
160
 
# File 'app/models/attachment.rb', line 154

def title
  title = filename.dup
  if description.present?
    title << " (#{description})"
  end
  title
end

#token ⇒ Object

Returns the attachment token

Since:

  • 1.4.0



256
257
258
 
# File 'app/models/attachment.rb', line 256

def token
  "#{id}.#{digest}"
end

#validate_file_extension ⇒ Object

Since:

  • 3.2.0



73
74
75
76
77
78
79
80
 
# File 'app/models/attachment.rb', line 73

def validate_file_extension
  if @temp_file
    extension = File.extname(filename)
    unless self.class.valid_extension?(extension)
      errors.add(:base, l(:error_attachment_extension_not_allowed, :extension => extension))
    end
  end
end

#validate_max_file_size ⇒ Object

Since:

  • 1.3.0



67
68
69
70
71
 
# File 'app/models/attachment.rb', line 67

def validate_max_file_size
  if @temp_file && self.filesize > Setting.attachment_max_size.to_i.kilobytes
    errors.add(:base, l(:error_attachment_too_big, :max_size => Setting.attachment_max_size.to_i.kilobytes))
  end
end

#visible?(user = User.current) ⇒ Boolean

Returns:

  • (Boolean)

Since:

  • 0.8.1



170
171
172
173
174
175
176
 
# File 'app/models/attachment.rb', line 170

def visible?(user=User.current)
  if container_id
    container && container.attachments_visible?(user)
  else
    author == user
  end
end