##// END OF EJS Templates
Rails3: replace deprecate 'validate' instance method to declared validation method at Attachment model....
Toshi MARUYAMA -
r6594:af7ec57f1500
parent child
Show More
@@ -1,193 +1,194
1 1 # Redmine - project management software
2 2 # Copyright (C) 2006-2011 Jean-Philippe Lang
3 3 #
4 4 # This program is free software; you can redistribute it and/or
5 5 # modify it under the terms of the GNU General Public License
6 6 # as published by the Free Software Foundation; either version 2
7 7 # of the License, or (at your option) any later version.
8 8 #
9 9 # This program is distributed in the hope that it will be useful,
10 10 # but WITHOUT ANY WARRANTY; without even the implied warranty of
11 11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 12 # GNU General Public License for more details.
13 13 #
14 14 # You should have received a copy of the GNU General Public License
15 15 # along with this program; if not, write to the Free Software
16 16 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17 17
18 18 require "digest/md5"
19 19
20 20 class Attachment < ActiveRecord::Base
21 21 belongs_to :container, :polymorphic => true
22 22 belongs_to :author, :class_name => "User", :foreign_key => "author_id"
23 23
24 24 validates_presence_of :container, :filename, :author
25 25 validates_length_of :filename, :maximum => 255
26 26 validates_length_of :disk_filename, :maximum => 255
27 validate :validate_max_file_size
27 28
28 29 acts_as_event :title => :filename,
29 30 :url => Proc.new {|o| {:controller => 'attachments', :action => 'download', :id => o.id, :filename => o.filename}}
30 31
31 32 acts_as_activity_provider :type => 'files',
32 33 :permission => :view_files,
33 34 :author_key => :author_id,
34 35 :find_options => {:select => "#{Attachment.table_name}.*",
35 36 :joins => "LEFT JOIN #{Version.table_name} ON #{Attachment.table_name}.container_type='Version' AND #{Version.table_name}.id = #{Attachment.table_name}.container_id " +
36 37 "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 )"}
37 38
38 39 acts_as_activity_provider :type => 'documents',
39 40 :permission => :view_documents,
40 41 :author_key => :author_id,
41 42 :find_options => {:select => "#{Attachment.table_name}.*",
42 43 :joins => "LEFT JOIN #{Document.table_name} ON #{Attachment.table_name}.container_type='Document' AND #{Document.table_name}.id = #{Attachment.table_name}.container_id " +
43 44 "LEFT JOIN #{Project.table_name} ON #{Document.table_name}.project_id = #{Project.table_name}.id"}
44 45
45 46 cattr_accessor :storage_path
46 47 @@storage_path = Redmine::Configuration['attachments_storage_path'] || "#{Rails.root}/files"
47 48
48 def validate
49 def validate_max_file_size
49 50 if self.filesize > Setting.attachment_max_size.to_i.kilobytes
50 51 errors.add(:base, :too_long, :count => Setting.attachment_max_size.to_i.kilobytes)
51 52 end
52 53 end
53 54
54 55 def file=(incoming_file)
55 56 unless incoming_file.nil?
56 57 @temp_file = incoming_file
57 58 if @temp_file.size > 0
58 59 self.filename = sanitize_filename(@temp_file.original_filename)
59 60 self.disk_filename = Attachment.disk_filename(filename)
60 61 self.content_type = @temp_file.content_type.to_s.chomp
61 62 if content_type.blank?
62 63 self.content_type = Redmine::MimeType.of(filename)
63 64 end
64 65 self.filesize = @temp_file.size
65 66 end
66 67 end
67 68 end
68 69
69 70 def file
70 71 nil
71 72 end
72 73
73 74 # Copies the temporary file to its final location
74 75 # and computes its MD5 hash
75 76 def before_save
76 77 if @temp_file && (@temp_file.size > 0)
77 78 logger.info("Saving attachment '#{self.diskfile}' (#{@temp_file.size} bytes)")
78 79 md5 = Digest::MD5.new
79 80 File.open(diskfile, "wb") do |f|
80 81 buffer = ""
81 82 while (buffer = @temp_file.read(8192))
82 83 f.write(buffer)
83 84 md5.update(buffer)
84 85 end
85 86 end
86 87 self.digest = md5.hexdigest
87 88 end
88 89 @temp_file = nil
89 90 # Don't save the content type if it's longer than the authorized length
90 91 if self.content_type && self.content_type.length > 255
91 92 self.content_type = nil
92 93 end
93 94 end
94 95
95 96 # Deletes file on the disk
96 97 def after_destroy
97 98 File.delete(diskfile) if !filename.blank? && File.exist?(diskfile)
98 99 end
99 100
100 101 # Returns file's location on disk
101 102 def diskfile
102 103 "#{@@storage_path}/#{self.disk_filename}"
103 104 end
104 105
105 106 def increment_download
106 107 increment!(:downloads)
107 108 end
108 109
109 110 def project
110 111 container.project
111 112 end
112 113
113 114 def visible?(user=User.current)
114 115 container.attachments_visible?(user)
115 116 end
116 117
117 118 def deletable?(user=User.current)
118 119 container.attachments_deletable?(user)
119 120 end
120 121
121 122 def image?
122 123 self.filename =~ /\.(jpe?g|gif|png)$/i
123 124 end
124 125
125 126 def is_text?
126 127 Redmine::MimeType.is_type?('text', filename)
127 128 end
128 129
129 130 def is_diff?
130 131 self.filename =~ /\.(patch|diff)$/i
131 132 end
132 133
133 134 # Returns true if the file is readable
134 135 def readable?
135 136 File.readable?(diskfile)
136 137 end
137 138
138 139 # Bulk attaches a set of files to an object
139 140 #
140 141 # Returns a Hash of the results:
141 142 # :files => array of the attached files
142 143 # :unsaved => array of the files that could not be attached
143 144 def self.attach_files(obj, attachments)
144 145 attached = []
145 146 if attachments && attachments.is_a?(Hash)
146 147 attachments.each_value do |attachment|
147 148 file = attachment['file']
148 149 next unless file && file.size > 0
149 150 a = Attachment.create(:container => obj,
150 151 :file => file,
151 152 :description => attachment['description'].to_s.strip,
152 153 :author => User.current)
153 154 obj.attachments << a
154 155
155 156 if a.new_record?
156 157 obj.unsaved_attachments ||= []
157 158 obj.unsaved_attachments << a
158 159 else
159 160 attached << a
160 161 end
161 162 end
162 163 end
163 164 {:files => attached, :unsaved => obj.unsaved_attachments}
164 165 end
165 166
166 167 private
167 168 def sanitize_filename(value)
168 169 # get only the filename, not the whole path
169 170 just_filename = value.gsub(/^.*(\\|\/)/, '')
170 171 # NOTE: File.basename doesn't work right with Windows paths on Unix
171 172 # INCORRECT: just_filename = File.basename(value.gsub('\\\\', '/'))
172 173
173 174 # Finally, replace all non alphanumeric, hyphens or periods with underscore
174 175 @filename = just_filename.gsub(/[^\w\.\-]/,'_')
175 176 end
176 177
177 178 # Returns an ASCII or hashed filename
178 179 def self.disk_filename(filename)
179 180 timestamp = DateTime.now.strftime("%y%m%d%H%M%S")
180 181 ascii = ''
181 182 if filename =~ %r{^[a-zA-Z0-9_\.\-]*$}
182 183 ascii = filename
183 184 else
184 185 ascii = Digest::MD5.hexdigest(filename)
185 186 # keep the extension if any
186 187 ascii << $1 if filename =~ %r{(\.[a-zA-Z0-9]+)$}
187 188 end
188 189 while File.exist?(File.join(@@storage_path, "#{timestamp}_#{ascii}"))
189 190 timestamp.succ!
190 191 end
191 192 "#{timestamp}_#{ascii}"
192 193 end
193 194 end
General Comments 0
You need to be logged in to leave comments. Login now