attachment.rb
410 lines
| 12.5 KiB
| text/x-ruby
|
RubyLexer
Toshi MARUYAMA
|
r5673 | # Redmine - project management software | ||
Jean-Philippe Lang
|
r14856 | # Copyright (C) 2006-2016 Jean-Philippe Lang | ||
|
Jean-Philippe Lang
|
r330 | # | ||
| # This program is free software; you can redistribute it and/or | ||||
| # modify it under the terms of the GNU General Public License | ||||
| # as published by the Free Software Foundation; either version 2 | ||||
| # of the License, or (at your option) any later version. | ||||
|
Toshi MARUYAMA
|
r5673 | # | ||
|
Jean-Philippe Lang
|
r330 | # This program is distributed in the hope that it will be useful, | ||
| # but WITHOUT ANY WARRANTY; without even the implied warranty of | ||||
| # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||||
| # GNU General Public License for more details. | ||||
|
Toshi MARUYAMA
|
r5673 | # | ||
|
Jean-Philippe Lang
|
r330 | # You should have received a copy of the GNU General Public License | ||
| # along with this program; if not, write to the Free Software | ||||
| # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. | ||||
| require "digest/md5" | ||||
|
Jean-Philippe Lang
|
r10761 | require "fileutils" | ||
|
Jean-Philippe Lang
|
r330 | |||
| class Attachment < ActiveRecord::Base | ||||
| belongs_to :container, :polymorphic => true | ||||
|
Jean-Philippe Lang
|
r13102 | belongs_to :author, :class_name => "User" | ||
|
Toshi MARUYAMA
|
r5673 | |||
|
Jean-Philippe Lang
|
r8771 | validates_presence_of :filename, :author | ||
|
Jean-Philippe Lang
|
r590 | validates_length_of :filename, :maximum => 255 | ||
| validates_length_of :disk_filename, :maximum => 255 | ||||
|
Jean-Philippe Lang
|
r9801 | validates_length_of :description, :maximum => 255 | ||
|
Jean-Philippe Lang
|
r14410 | validate :validate_max_file_size, :validate_file_extension | ||
|
Jean-Philippe Lang
|
r13100 | attr_protected :id | ||
|
Jean-Philippe Lang
|
r663 | |||
| acts_as_event :title => :filename, | ||||
|
Jean-Philippe Lang
|
r1669 | :url => Proc.new {|o| {:controller => 'attachments', :action => 'download', :id => o.id, :filename => o.filename}} | ||
|
Jean-Philippe Lang
|
r663 | |||
|
Jean-Philippe Lang
|
r1692 | acts_as_activity_provider :type => 'files', | ||
| :permission => :view_files, | ||||
|
Jean-Philippe Lang
|
r2064 | :author_key => :author_id, | ||
|
Jean-Philippe Lang
|
r13100 | :scope => select("#{Attachment.table_name}.*"). | ||
| joins("LEFT JOIN #{Version.table_name} ON #{Attachment.table_name}.container_type='Version' AND #{Version.table_name}.id = #{Attachment.table_name}.container_id " + | ||||
| "LEFT JOIN #{Project.table_name} ON #{Version.table_name}.project_id = #{Project.table_name}.id OR ( #{Attachment.table_name}.container_type='Project' AND #{Attachment.table_name}.container_id = #{Project.table_name}.id )") | ||||
|
Toshi MARUYAMA
|
r5673 | |||
|
Jean-Philippe Lang
|
r1692 | acts_as_activity_provider :type => 'documents', | ||
| :permission => :view_documents, | ||||
|
Jean-Philippe Lang
|
r2064 | :author_key => :author_id, | ||
|
Jean-Philippe Lang
|
r13100 | :scope => select("#{Attachment.table_name}.*"). | ||
| joins("LEFT JOIN #{Document.table_name} ON #{Attachment.table_name}.container_type='Document' AND #{Document.table_name}.id = #{Attachment.table_name}.container_id " + | ||||
| "LEFT JOIN #{Project.table_name} ON #{Document.table_name}.project_id = #{Project.table_name}.id") | ||||
|
Jean-Philippe Lang
|
r1692 | |||
|
Jean-Philippe Lang
|
r330 | cattr_accessor :storage_path | ||
|
Jean-Philippe Lang
|
r9381 | @@storage_path = Redmine::Configuration['attachments_storage_path'] || File.join(Rails.root, "files") | ||
|
Toshi MARUYAMA
|
r5673 | |||
|
Jean-Philippe Lang
|
r9750 | cattr_accessor :thumbnails_storage_path | ||
| @@thumbnails_storage_path = File.join(Rails.root, "tmp", "thumbnails") | ||||
|
Jean-Philippe Lang
|
r13405 | before_create :files_to_final_location | ||
|
Jean-Philippe Lang
|
r14703 | after_rollback :delete_from_disk, :on => :create | ||
|
Jean-Philippe Lang
|
r14248 | after_commit :delete_from_disk, :on => :destroy | ||
|
Toshi MARUYAMA
|
r6636 | |||
|
Jean-Philippe Lang
|
r8556 | # Returns an unsaved copy of the attachment | ||
| def copy(attributes=nil) | ||||
| copy = self.class.new | ||||
| copy.attributes = self.attributes.dup.except("id", "downloads") | ||||
| copy.attributes = attributes if attributes | ||||
| copy | ||||
| end | ||||
|
Toshi MARUYAMA
|
r6594 | def validate_max_file_size | ||
|
Jean-Philippe Lang
|
r8556 | if @temp_file && self.filesize > Setting.attachment_max_size.to_i.kilobytes | ||
|
Jean-Philippe Lang
|
r8817 | errors.add(:base, l(:error_attachment_too_big, :max_size => Setting.attachment_max_size.to_i.kilobytes)) | ||
|
Jean-Philippe Lang
|
r2575 | end | ||
|
Jean-Philippe Lang
|
r330 | end | ||
|
Jean-Philippe Lang
|
r14410 | 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 | ||||
|
Jean-Philippe Lang
|
r1306 | def file=(incoming_file) | ||
| unless incoming_file.nil? | ||||
| @temp_file = incoming_file | ||||
| if @temp_file.size > 0 | ||||
|
Jean-Philippe Lang
|
r8808 | if @temp_file.respond_to?(:original_filename) | ||
| self.filename = @temp_file.original_filename | ||||
|
Jean-Philippe Lang
|
r13100 | self.filename.force_encoding("UTF-8") | ||
|
Jean-Philippe Lang
|
r8808 | end | ||
| if @temp_file.respond_to?(:content_type) | ||||
| self.content_type = @temp_file.content_type.to_s.chomp | ||||
| end | ||||
|
Jean-Philippe Lang
|
r1306 | self.filesize = @temp_file.size | ||
| end | ||||
| end | ||||
| end | ||||
|
Toshi MARUYAMA
|
r8892 | |||
|
Jean-Philippe Lang
|
r1306 | def file | ||
| nil | ||||
| end | ||||
|
Jean-Philippe Lang
|
r8808 | def filename=(arg) | ||
| write_attribute :filename, sanitize_filename(arg.to_s) | ||||
| filename | ||||
| end | ||||
|
Jean-Philippe Lang
|
r2578 | # Copies the temporary file to its final location | ||
| # and computes its MD5 hash | ||||
|
Toshi MARUYAMA
|
r6636 | def files_to_final_location | ||
|
Jean-Philippe Lang
|
r1306 | if @temp_file && (@temp_file.size > 0) | ||
|
Jean-Philippe Lang
|
r10761 | self.disk_directory = target_directory | ||
| self.disk_filename = Attachment.disk_filename(filename, disk_directory) | ||||
|
Jean-Philippe Lang
|
r11972 | logger.info("Saving attachment '#{self.diskfile}' (#{@temp_file.size} bytes)") if logger | ||
|
Jean-Philippe Lang
|
r10761 | path = File.dirname(diskfile) | ||
| unless File.directory?(path) | ||||
| FileUtils.mkdir_p(path) | ||||
| end | ||||
|
Jean-Philippe Lang
|
r2578 | md5 = Digest::MD5.new | ||
|
Toshi MARUYAMA
|
r5673 | File.open(diskfile, "wb") do |f| | ||
|
Jean-Philippe Lang
|
r9447 | 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) | ||||
|
Jean-Philippe Lang
|
r2578 | end | ||
|
Jean-Philippe Lang
|
r1306 | end | ||
|
Jean-Philippe Lang
|
r2578 | self.digest = md5.hexdigest | ||
|
Jean-Philippe Lang
|
r1306 | end | ||
|
Jean-Philippe Lang
|
r6200 | @temp_file = nil | ||
|
Jean-Philippe Lang
|
r13405 | |||
| if content_type.blank? && filename.present? | ||||
| self.content_type = Redmine::MimeType.of(filename) | ||||
| end | ||||
|
Jean-Philippe Lang
|
r1306 | # 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 | ||||
|
Jean-Philippe Lang
|
r8556 | # Deletes the file from the file system if it's not referenced by other attachments | ||
|
Toshi MARUYAMA
|
r6643 | def delete_from_disk | ||
|
Jean-Philippe Lang
|
r9534 | if Attachment.where("disk_filename = ? AND id <> ?", disk_filename, id).empty? | ||
|
Jean-Philippe Lang
|
r8556 | delete_from_disk! | ||
| end | ||||
|
Jean-Philippe Lang
|
r1306 | end | ||
| # Returns file's location on disk | ||||
| def diskfile | ||||
|
Jean-Philippe Lang
|
r10761 | File.join(self.class.storage_path, disk_directory.to_s, disk_filename.to_s) | ||
|
Jean-Philippe Lang
|
r1306 | end | ||
|
Toshi MARUYAMA
|
r5673 | |||
|
Jean-Philippe Lang
|
r9829 | def title | ||
| title = filename.to_s | ||||
| if description.present? | ||||
| title << " (#{description})" | ||||
| end | ||||
| title | ||||
| end | ||||
|
Jean-Philippe Lang
|
r330 | def increment_download | ||
| increment!(:downloads) | ||||
| end | ||||
|
Jean-Philippe Lang
|
r538 | |||
| def project | ||||
|
Jean-Philippe Lang
|
r8771 | container.try(:project) | ||
|
Jean-Philippe Lang
|
r538 | end | ||
|
Toshi MARUYAMA
|
r5673 | |||
|
Jean-Philippe Lang
|
r2114 | def visible?(user=User.current) | ||
|
Jean-Philippe Lang
|
r10748 | if container_id | ||
| container && container.attachments_visible?(user) | ||||
| else | ||||
| author == user | ||||
| end | ||||
|
Jean-Philippe Lang
|
r2114 | end | ||
|
Toshi MARUYAMA
|
r5673 | |||
|
Jean-Philippe Lang
|
r13283 | def editable?(user=User.current) | ||
| if container_id | ||||
| container && container.attachments_editable?(user) | ||||
| else | ||||
| author == user | ||||
| end | ||||
| end | ||||
|
Jean-Philippe Lang
|
r2114 | def deletable?(user=User.current) | ||
|
Jean-Philippe Lang
|
r10748 | if container_id | ||
| container && container.attachments_deletable?(user) | ||||
| else | ||||
| author == user | ||||
| end | ||||
|
Jean-Philippe Lang
|
r2114 | end | ||
|
Toshi MARUYAMA
|
r5673 | |||
|
Jean-Philippe Lang
|
r636 | def image? | ||
|
Jean-Philippe Lang
|
r9750 | !!(self.filename =~ /\.(bmp|gif|jpg|jpe|jpeg|png)$/i) | ||
| end | ||||
| def thumbnailable? | ||||
| image? | ||||
| end | ||||
| # Returns the full path the attachment thumbnail, or nil | ||||
| # if the thumbnail cannot be generated. | ||||
|
Jean-Philippe Lang
|
r9830 | def thumbnail(options={}) | ||
|
Jean-Philippe Lang
|
r9750 | if thumbnailable? && readable? | ||
|
Jean-Philippe Lang
|
r9830 | 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 | ||||
|
Jean-Philippe Lang
|
r9750 | 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 | ||||
| # Deletes all thumbnails | ||||
| def self.clear_thumbnails | ||||
| Dir.glob(File.join(thumbnails_storage_path, "*.thumb")).each do |file| | ||||
| File.delete file | ||||
| end | ||||
|
Jean-Philippe Lang
|
r636 | end | ||
|
Toshi MARUYAMA
|
r5673 | |||
|
Jean-Philippe Lang
|
r1506 | def is_text? | ||
| Redmine::MimeType.is_type?('text', filename) | ||||
| end | ||||
|
Toshi MARUYAMA
|
r5673 | |||
|
Jean-Philippe Lang
|
r14942 | def is_image? | ||
| Redmine::MimeType.is_type?('image', filename) | ||||
| end | ||||
|
Jean-Philippe Lang
|
r1502 | def is_diff? | ||
| self.filename =~ /\.(patch|diff)$/i | ||||
| end | ||||
|
Toshi MARUYAMA
|
r5673 | |||
|
Jean-Philippe Lang
|
r15027 | def is_pdf? | ||
| Redmine::MimeType.of(filename) == "application/pdf" | ||||
| end | ||||
|
Jean-Philippe Lang
|
r2600 | # Returns true if the file is readable | ||
| def readable? | ||||
| File.readable?(diskfile) | ||||
| end | ||||
Eric Davis
|
r3409 | |||
|
Jean-Philippe Lang
|
r8771 | # Returns the attachment token | ||
| def token | ||||
| "#{id}.#{digest}" | ||||
| end | ||||
| # Finds an attachment that matches the given token and that has no container | ||||
| def self.find_by_token(token) | ||||
| if token.to_s =~ /^(\d+)\.([0-9a-f]+)$/ | ||||
| attachment_id, attachment_digest = $1, $2 | ||||
|
Jean-Philippe Lang
|
r9533 | attachment = Attachment.where(:id => attachment_id, :digest => attachment_digest).first | ||
|
Jean-Philippe Lang
|
r8771 | if attachment && attachment.container.nil? | ||
| attachment | ||||
| end | ||||
| end | ||||
| end | ||||
|
Eric Davis
|
r3409 | # 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 | ||||
| def self.attach_files(obj, attachments) | ||||
|
Jean-Philippe Lang
|
r8771 | result = obj.save_attachments(attachments, User.current) | ||
| obj.attach_saved_attachments | ||||
| result | ||||
|
Eric Davis
|
r3409 | end | ||
|
Toshi MARUYAMA
|
r5673 | |||
|
Jean-Philippe Lang
|
r13283 | # 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'} | ||||
| # }) | ||||
| # | ||||
| 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 | ||||
|
Toshi MARUYAMA
|
r7788 | def self.latest_attach(attachments, filename) | ||
|
Jean-Philippe Lang
|
r13141 | attachments.sort_by(&:created_on).reverse.detect do |att| | ||
|
Jean-Philippe Lang
|
r14091 | filename.casecmp(att.filename) == 0 | ||
|
Jean-Philippe Lang
|
r13141 | end | ||
|
Toshi MARUYAMA
|
r7788 | end | ||
|
Jean-Philippe Lang
|
r8771 | def self.prune(age=1.day) | ||
|
Jean-Philippe Lang
|
r9533 | Attachment.where("created_on < ? AND (container_type IS NULL OR container_type = '')", Time.now - age).destroy_all | ||
|
Jean-Philippe Lang
|
r8771 | end | ||
|
Toshi MARUYAMA
|
r11037 | # Moves an existing attachment to its target directory | ||
|
Jean-Philippe Lang
|
r10761 | def move_to_target_directory! | ||
|
Jean-Philippe Lang
|
r12019 | 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 | ||||
|
Jean-Philippe Lang
|
r10761 | end | ||
|
Jean-Philippe Lang
|
r12019 | |||
| update_column :disk_directory, disk_directory | ||||
|
Jean-Philippe Lang
|
r10761 | end | ||
| # Moves existing attachments that are stored at the root of the files | ||||
| # directory (ie. created before Redmine 2.3) to their target subdirectories | ||||
| 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 | ||||
|
Jean-Philippe Lang
|
r14410 | # Returns true if the extension is allowed, otherwise false | ||
| 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 | ||||
|
Jean-Philippe Lang
|
r8556 | private | ||
| # Physically deletes the file from the file system | ||||
| def delete_from_disk! | ||||
| if disk_filename.present? && File.exist?(diskfile) | ||||
| File.delete(diskfile) | ||||
| end | ||||
| end | ||||
|
Jean-Philippe Lang
|
r330 | def sanitize_filename(value) | ||
|
Jean-Philippe Lang
|
r1306 | # get only the filename, not the whole path | ||
|
Jean-Philippe Lang
|
r11898 | just_filename = value.gsub(/\A.*(\\|\/)/m, '') | ||
|
Jean-Philippe Lang
|
r330 | |||
|
Jean-Philippe Lang
|
r7797 | # Finally, replace invalid characters with underscore | ||
|
Jean-Philippe Lang
|
r13142 | just_filename.gsub(/[\/\?\%\*\:\|\"\'<>\n\r]+/, '_') | ||
|
Jean-Philippe Lang
|
r330 | end | ||
|
Toshi MARUYAMA
|
r5673 | |||
|
Jean-Philippe Lang
|
r10761 | # Returns the subdirectory in which the attachment will be saved | ||
| def target_directory | ||||
| time = created_on || DateTime.now | ||||
| time.strftime("%Y/%m") | ||||
| end | ||||
| # Returns an ASCII or hashed filename that do not | ||||
| # exists yet in the given subdirectory | ||||
| def self.disk_filename(filename, directory=nil) | ||||
|
Jean-Philippe Lang
|
r3397 | timestamp = DateTime.now.strftime("%y%m%d%H%M%S") | ||
| ascii = '' | ||||
|
Jean-Philippe Lang
|
r1418 | if filename =~ %r{^[a-zA-Z0-9_\.\-]*$} | ||
|
Jean-Philippe Lang
|
r3397 | ascii = filename | ||
|
Jean-Philippe Lang
|
r1418 | else | ||
|
Jean-Philippe Lang
|
r3397 | ascii = Digest::MD5.hexdigest(filename) | ||
|
Jean-Philippe Lang
|
r1418 | # keep the extension if any | ||
|
Jean-Philippe Lang
|
r3397 | ascii << $1 if filename =~ %r{(\.[a-zA-Z0-9]+)$} | ||
|
Jean-Philippe Lang
|
r1418 | end | ||
|
Jean-Philippe Lang
|
r10761 | while File.exist?(File.join(storage_path, directory.to_s, "#{timestamp}_#{ascii}")) | ||
|
Jean-Philippe Lang
|
r3397 | timestamp.succ! | ||
| end | ||||
| "#{timestamp}_#{ascii}" | ||||
|
Jean-Philippe Lang
|
r1418 | end | ||
|
Jean-Philippe Lang
|
r2 | end | ||