@@ -1,196 +1,197 | |||
|
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 | 27 | validate :validate_max_file_size |
|
28 | 28 | |
|
29 | 29 | acts_as_event :title => :filename, |
|
30 | 30 | :url => Proc.new {|o| {:controller => 'attachments', :action => 'download', :id => o.id, :filename => o.filename}} |
|
31 | 31 | |
|
32 | 32 | acts_as_activity_provider :type => 'files', |
|
33 | 33 | :permission => :view_files, |
|
34 | 34 | :author_key => :author_id, |
|
35 | 35 | :find_options => {:select => "#{Attachment.table_name}.*", |
|
36 | 36 | :joins => "LEFT JOIN #{Version.table_name} ON #{Attachment.table_name}.container_type='Version' AND #{Version.table_name}.id = #{Attachment.table_name}.container_id " + |
|
37 | 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 )"} |
|
38 | 38 | |
|
39 | 39 | acts_as_activity_provider :type => 'documents', |
|
40 | 40 | :permission => :view_documents, |
|
41 | 41 | :author_key => :author_id, |
|
42 | 42 | :find_options => {:select => "#{Attachment.table_name}.*", |
|
43 | 43 | :joins => "LEFT JOIN #{Document.table_name} ON #{Attachment.table_name}.container_type='Document' AND #{Document.table_name}.id = #{Attachment.table_name}.container_id " + |
|
44 | 44 | "LEFT JOIN #{Project.table_name} ON #{Document.table_name}.project_id = #{Project.table_name}.id"} |
|
45 | 45 | |
|
46 | 46 | cattr_accessor :storage_path |
|
47 | 47 | @@storage_path = Redmine::Configuration['attachments_storage_path'] || "#{Rails.root}/files" |
|
48 | 48 | |
|
49 | 49 | before_save :files_to_final_location |
|
50 | after_destroy :delete_from_disk | |
|
50 | 51 | |
|
51 | 52 | def validate_max_file_size |
|
52 | 53 | if self.filesize > Setting.attachment_max_size.to_i.kilobytes |
|
53 | 54 | errors.add(:base, :too_long, :count => Setting.attachment_max_size.to_i.kilobytes) |
|
54 | 55 | end |
|
55 | 56 | end |
|
56 | 57 | |
|
57 | 58 | def file=(incoming_file) |
|
58 | 59 | unless incoming_file.nil? |
|
59 | 60 | @temp_file = incoming_file |
|
60 | 61 | if @temp_file.size > 0 |
|
61 | 62 | self.filename = sanitize_filename(@temp_file.original_filename) |
|
62 | 63 | self.disk_filename = Attachment.disk_filename(filename) |
|
63 | 64 | self.content_type = @temp_file.content_type.to_s.chomp |
|
64 | 65 | if content_type.blank? |
|
65 | 66 | self.content_type = Redmine::MimeType.of(filename) |
|
66 | 67 | end |
|
67 | 68 | self.filesize = @temp_file.size |
|
68 | 69 | end |
|
69 | 70 | end |
|
70 | 71 | end |
|
71 | 72 | |
|
72 | 73 | def file |
|
73 | 74 | nil |
|
74 | 75 | end |
|
75 | 76 | |
|
76 | 77 | # Copies the temporary file to its final location |
|
77 | 78 | # and computes its MD5 hash |
|
78 | 79 | def files_to_final_location |
|
79 | 80 | if @temp_file && (@temp_file.size > 0) |
|
80 | 81 | logger.info("Saving attachment '#{self.diskfile}' (#{@temp_file.size} bytes)") |
|
81 | 82 | md5 = Digest::MD5.new |
|
82 | 83 | File.open(diskfile, "wb") do |f| |
|
83 | 84 | buffer = "" |
|
84 | 85 | while (buffer = @temp_file.read(8192)) |
|
85 | 86 | f.write(buffer) |
|
86 | 87 | md5.update(buffer) |
|
87 | 88 | end |
|
88 | 89 | end |
|
89 | 90 | self.digest = md5.hexdigest |
|
90 | 91 | end |
|
91 | 92 | @temp_file = nil |
|
92 | 93 | # Don't save the content type if it's longer than the authorized length |
|
93 | 94 | if self.content_type && self.content_type.length > 255 |
|
94 | 95 | self.content_type = nil |
|
95 | 96 | end |
|
96 | 97 | end |
|
97 | 98 | |
|
98 | 99 | # Deletes file on the disk |
|
99 | def after_destroy | |
|
100 | def delete_from_disk | |
|
100 | 101 | File.delete(diskfile) if !filename.blank? && File.exist?(diskfile) |
|
101 | 102 | end |
|
102 | 103 | |
|
103 | 104 | # Returns file's location on disk |
|
104 | 105 | def diskfile |
|
105 | 106 | "#{@@storage_path}/#{self.disk_filename}" |
|
106 | 107 | end |
|
107 | 108 | |
|
108 | 109 | def increment_download |
|
109 | 110 | increment!(:downloads) |
|
110 | 111 | end |
|
111 | 112 | |
|
112 | 113 | def project |
|
113 | 114 | container.project |
|
114 | 115 | end |
|
115 | 116 | |
|
116 | 117 | def visible?(user=User.current) |
|
117 | 118 | container.attachments_visible?(user) |
|
118 | 119 | end |
|
119 | 120 | |
|
120 | 121 | def deletable?(user=User.current) |
|
121 | 122 | container.attachments_deletable?(user) |
|
122 | 123 | end |
|
123 | 124 | |
|
124 | 125 | def image? |
|
125 | 126 | self.filename =~ /\.(jpe?g|gif|png)$/i |
|
126 | 127 | end |
|
127 | 128 | |
|
128 | 129 | def is_text? |
|
129 | 130 | Redmine::MimeType.is_type?('text', filename) |
|
130 | 131 | end |
|
131 | 132 | |
|
132 | 133 | def is_diff? |
|
133 | 134 | self.filename =~ /\.(patch|diff)$/i |
|
134 | 135 | end |
|
135 | 136 | |
|
136 | 137 | # Returns true if the file is readable |
|
137 | 138 | def readable? |
|
138 | 139 | File.readable?(diskfile) |
|
139 | 140 | end |
|
140 | 141 | |
|
141 | 142 | # Bulk attaches a set of files to an object |
|
142 | 143 | # |
|
143 | 144 | # Returns a Hash of the results: |
|
144 | 145 | # :files => array of the attached files |
|
145 | 146 | # :unsaved => array of the files that could not be attached |
|
146 | 147 | def self.attach_files(obj, attachments) |
|
147 | 148 | attached = [] |
|
148 | 149 | if attachments && attachments.is_a?(Hash) |
|
149 | 150 | attachments.each_value do |attachment| |
|
150 | 151 | file = attachment['file'] |
|
151 | 152 | next unless file && file.size > 0 |
|
152 | 153 | a = Attachment.create(:container => obj, |
|
153 | 154 | :file => file, |
|
154 | 155 | :description => attachment['description'].to_s.strip, |
|
155 | 156 | :author => User.current) |
|
156 | 157 | obj.attachments << a |
|
157 | 158 | |
|
158 | 159 | if a.new_record? |
|
159 | 160 | obj.unsaved_attachments ||= [] |
|
160 | 161 | obj.unsaved_attachments << a |
|
161 | 162 | else |
|
162 | 163 | attached << a |
|
163 | 164 | end |
|
164 | 165 | end |
|
165 | 166 | end |
|
166 | 167 | {:files => attached, :unsaved => obj.unsaved_attachments} |
|
167 | 168 | end |
|
168 | 169 | |
|
169 | 170 | private |
|
170 | 171 | def sanitize_filename(value) |
|
171 | 172 | # get only the filename, not the whole path |
|
172 | 173 | just_filename = value.gsub(/^.*(\\|\/)/, '') |
|
173 | 174 | # NOTE: File.basename doesn't work right with Windows paths on Unix |
|
174 | 175 | # INCORRECT: just_filename = File.basename(value.gsub('\\\\', '/')) |
|
175 | 176 | |
|
176 | 177 | # Finally, replace all non alphanumeric, hyphens or periods with underscore |
|
177 | 178 | @filename = just_filename.gsub(/[^\w\.\-]/,'_') |
|
178 | 179 | end |
|
179 | 180 | |
|
180 | 181 | # Returns an ASCII or hashed filename |
|
181 | 182 | def self.disk_filename(filename) |
|
182 | 183 | timestamp = DateTime.now.strftime("%y%m%d%H%M%S") |
|
183 | 184 | ascii = '' |
|
184 | 185 | if filename =~ %r{^[a-zA-Z0-9_\.\-]*$} |
|
185 | 186 | ascii = filename |
|
186 | 187 | else |
|
187 | 188 | ascii = Digest::MD5.hexdigest(filename) |
|
188 | 189 | # keep the extension if any |
|
189 | 190 | ascii << $1 if filename =~ %r{(\.[a-zA-Z0-9]+)$} |
|
190 | 191 | end |
|
191 | 192 | while File.exist?(File.join(@@storage_path, "#{timestamp}_#{ascii}")) |
|
192 | 193 | timestamp.succ! |
|
193 | 194 | end |
|
194 | 195 | "#{timestamp}_#{ascii}" |
|
195 | 196 | end |
|
196 | 197 | end |
General Comments 0
You need to be logged in to leave comments.
Login now