| @@ -1,361 +1,365 | |||
|
|
1 | 1 | # redMine - project management software |
|
|
2 | 2 | # Copyright (C) 2006-2007 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 | class MailHandler < ActionMailer::Base |
|
|
19 | 19 | include ActionView::Helpers::SanitizeHelper |
|
|
20 | 20 | include Redmine::I18n |
|
|
21 | 21 | |
|
|
22 | 22 | class UnauthorizedAction < StandardError; end |
|
|
23 | 23 | class MissingInformation < StandardError; end |
|
|
24 | 24 | |
|
|
25 | 25 | attr_reader :email, :user |
|
|
26 | 26 | |
|
|
27 | 27 | def self.receive(email, options={}) |
|
|
28 | 28 | @@handler_options = options.dup |
|
|
29 | 29 | |
|
|
30 | 30 | @@handler_options[:issue] ||= {} |
|
|
31 | 31 | |
|
|
32 | 32 | @@handler_options[:allow_override] = @@handler_options[:allow_override].split(',').collect(&:strip) if @@handler_options[:allow_override].is_a?(String) |
|
|
33 | 33 | @@handler_options[:allow_override] ||= [] |
|
|
34 | 34 | # Project needs to be overridable if not specified |
|
|
35 | 35 | @@handler_options[:allow_override] << 'project' unless @@handler_options[:issue].has_key?(:project) |
|
|
36 | 36 | # Status overridable by default |
|
|
37 | 37 | @@handler_options[:allow_override] << 'status' unless @@handler_options[:issue].has_key?(:status) |
|
|
38 | 38 | |
|
|
39 | 39 | @@handler_options[:no_permission_check] = (@@handler_options[:no_permission_check].to_s == '1' ? true : false) |
|
|
40 | 40 | super email |
|
|
41 | 41 | end |
|
|
42 | 42 | |
|
|
43 | 43 | # Processes incoming emails |
|
|
44 | 44 | # Returns the created object (eg. an issue, a message) or false |
|
|
45 | 45 | def receive(email) |
|
|
46 | 46 | @email = email |
|
|
47 | 47 | sender_email = email.from.to_a.first.to_s.strip |
|
|
48 | 48 | # Ignore emails received from the application emission address to avoid hell cycles |
|
|
49 | 49 | if sender_email.downcase == Setting.mail_from.to_s.strip.downcase |
|
|
50 | 50 | logger.info "MailHandler: ignoring email from Redmine emission address [#{sender_email}]" if logger && logger.info |
|
|
51 | 51 | return false |
|
|
52 | 52 | end |
|
|
53 | 53 | @user = User.find_by_mail(sender_email) if sender_email.present? |
|
|
54 | 54 | if @user && !@user.active? |
|
|
55 | 55 | logger.info "MailHandler: ignoring email from non-active user [#{@user.login}]" if logger && logger.info |
|
|
56 | 56 | return false |
|
|
57 | 57 | end |
|
|
58 | 58 | if @user.nil? |
|
|
59 | 59 | # Email was submitted by an unknown user |
|
|
60 | 60 | case @@handler_options[:unknown_user] |
|
|
61 | 61 | when 'accept' |
|
|
62 | 62 | @user = User.anonymous |
|
|
63 | 63 | when 'create' |
|
|
64 | 64 | @user = MailHandler.create_user_from_email(email) |
|
|
65 | 65 | if @user |
|
|
66 | 66 | logger.info "MailHandler: [#{@user.login}] account created" if logger && logger.info |
|
|
67 | 67 | Mailer.deliver_account_information(@user, @user.password) |
|
|
68 | 68 | else |
|
|
69 | 69 | logger.error "MailHandler: could not create account for [#{sender_email}]" if logger && logger.error |
|
|
70 | 70 | return false |
|
|
71 | 71 | end |
|
|
72 | 72 | else |
|
|
73 | 73 | # Default behaviour, emails from unknown users are ignored |
|
|
74 | 74 | logger.info "MailHandler: ignoring email from unknown user [#{sender_email}]" if logger && logger.info |
|
|
75 | 75 | return false |
|
|
76 | 76 | end |
|
|
77 | 77 | end |
|
|
78 | 78 | User.current = @user |
|
|
79 | 79 | dispatch |
|
|
80 | 80 | end |
|
|
81 | 81 | |
|
|
82 | 82 | private |
|
|
83 | 83 | |
|
|
84 | 84 | MESSAGE_ID_RE = %r{^<redmine\.([a-z0-9_]+)\-(\d+)\.\d+@} |
|
|
85 | 85 | ISSUE_REPLY_SUBJECT_RE = %r{\[[^\]]*#(\d+)\]} |
|
|
86 | 86 | MESSAGE_REPLY_SUBJECT_RE = %r{\[[^\]]*msg(\d+)\]} |
|
|
87 | 87 | |
|
|
88 | 88 | def dispatch |
|
|
89 | 89 | headers = [email.in_reply_to, email.references].flatten.compact |
|
|
90 | 90 | if headers.detect {|h| h.to_s =~ MESSAGE_ID_RE} |
|
|
91 | 91 | klass, object_id = $1, $2.to_i |
|
|
92 | 92 | method_name = "receive_#{klass}_reply" |
|
|
93 | 93 | if self.class.private_instance_methods.collect(&:to_s).include?(method_name) |
|
|
94 | 94 | send method_name, object_id |
|
|
95 | 95 | else |
|
|
96 | 96 | # ignoring it |
|
|
97 | 97 | end |
|
|
98 | 98 | elsif m = email.subject.match(ISSUE_REPLY_SUBJECT_RE) |
|
|
99 | 99 | receive_issue_reply(m[1].to_i) |
|
|
100 | 100 | elsif m = email.subject.match(MESSAGE_REPLY_SUBJECT_RE) |
|
|
101 | 101 | receive_message_reply(m[1].to_i) |
|
|
102 | 102 | else |
|
|
103 | receive_issue | |
|
|
103 | dispatch_to_default | |
|
|
104 | 104 | end |
|
|
105 | 105 | rescue ActiveRecord::RecordInvalid => e |
|
|
106 | 106 | # TODO: send a email to the user |
|
|
107 | 107 | logger.error e.message if logger |
|
|
108 | 108 | false |
|
|
109 | 109 | rescue MissingInformation => e |
|
|
110 | 110 | logger.error "MailHandler: missing information from #{user}: #{e.message}" if logger |
|
|
111 | 111 | false |
|
|
112 | 112 | rescue UnauthorizedAction => e |
|
|
113 | 113 | logger.error "MailHandler: unauthorized attempt from #{user}" if logger |
|
|
114 | 114 | false |
|
|
115 | 115 | end |
|
|
116 | ||
|
|
117 | def dispatch_to_default | |
|
|
118 | receive_issue | |
|
|
119 | end | |
|
|
116 | 120 | |
|
|
117 | 121 | # Creates a new issue |
|
|
118 | 122 | def receive_issue |
|
|
119 | 123 | project = target_project |
|
|
120 | 124 | # check permission |
|
|
121 | 125 | unless @@handler_options[:no_permission_check] |
|
|
122 | 126 | raise UnauthorizedAction unless user.allowed_to?(:add_issues, project) |
|
|
123 | 127 | end |
|
|
124 | 128 | |
|
|
125 | 129 | issue = Issue.new(:author => user, :project => project) |
|
|
126 | 130 | issue.safe_attributes = issue_attributes_from_keywords(issue) |
|
|
127 | 131 | issue.safe_attributes = {'custom_field_values' => custom_field_values_from_keywords(issue)} |
|
|
128 | 132 | issue.subject = email.subject.to_s.chomp[0,255] |
|
|
129 | 133 | if issue.subject.blank? |
|
|
130 | 134 | issue.subject = '(no subject)' |
|
|
131 | 135 | end |
|
|
132 | 136 | issue.description = cleaned_up_text_body |
|
|
133 | 137 | |
|
|
134 | 138 | # add To and Cc as watchers before saving so the watchers can reply to Redmine |
|
|
135 | 139 | add_watchers(issue) |
|
|
136 | 140 | issue.save! |
|
|
137 | 141 | add_attachments(issue) |
|
|
138 | 142 | logger.info "MailHandler: issue ##{issue.id} created by #{user}" if logger && logger.info |
|
|
139 | 143 | issue |
|
|
140 | 144 | end |
|
|
141 | 145 | |
|
|
142 | 146 | # Adds a note to an existing issue |
|
|
143 | 147 | def receive_issue_reply(issue_id) |
|
|
144 | 148 | issue = Issue.find_by_id(issue_id) |
|
|
145 | 149 | return unless issue |
|
|
146 | 150 | # check permission |
|
|
147 | 151 | unless @@handler_options[:no_permission_check] |
|
|
148 | 152 | raise UnauthorizedAction unless user.allowed_to?(:add_issue_notes, issue.project) || user.allowed_to?(:edit_issues, issue.project) |
|
|
149 | 153 | end |
|
|
150 | 154 | |
|
|
151 | 155 | # ignore CLI-supplied defaults for new issues |
|
|
152 | 156 | @@handler_options[:issue].clear |
|
|
153 | 157 | |
|
|
154 | 158 | journal = issue.init_journal(user, cleaned_up_text_body) |
|
|
155 | 159 | issue.safe_attributes = issue_attributes_from_keywords(issue) |
|
|
156 | 160 | issue.safe_attributes = {'custom_field_values' => custom_field_values_from_keywords(issue)} |
|
|
157 | 161 | add_attachments(issue) |
|
|
158 | 162 | issue.save! |
|
|
159 | 163 | logger.info "MailHandler: issue ##{issue.id} updated by #{user}" if logger && logger.info |
|
|
160 | 164 | journal |
|
|
161 | 165 | end |
|
|
162 | 166 | |
|
|
163 | 167 | # Reply will be added to the issue |
|
|
164 | 168 | def receive_journal_reply(journal_id) |
|
|
165 | 169 | journal = Journal.find_by_id(journal_id) |
|
|
166 | 170 | if journal && journal.journalized_type == 'Issue' |
|
|
167 | 171 | receive_issue_reply(journal.journalized_id) |
|
|
168 | 172 | end |
|
|
169 | 173 | end |
|
|
170 | 174 | |
|
|
171 | 175 | # Receives a reply to a forum message |
|
|
172 | 176 | def receive_message_reply(message_id) |
|
|
173 | 177 | message = Message.find_by_id(message_id) |
|
|
174 | 178 | if message |
|
|
175 | 179 | message = message.root |
|
|
176 | 180 | |
|
|
177 | 181 | unless @@handler_options[:no_permission_check] |
|
|
178 | 182 | raise UnauthorizedAction unless user.allowed_to?(:add_messages, message.project) |
|
|
179 | 183 | end |
|
|
180 | 184 | |
|
|
181 | 185 | if !message.locked? |
|
|
182 | 186 | reply = Message.new(:subject => email.subject.gsub(%r{^.*msg\d+\]}, '').strip, |
|
|
183 | 187 | :content => cleaned_up_text_body) |
|
|
184 | 188 | reply.author = user |
|
|
185 | 189 | reply.board = message.board |
|
|
186 | 190 | message.children << reply |
|
|
187 | 191 | add_attachments(reply) |
|
|
188 | 192 | reply |
|
|
189 | 193 | else |
|
|
190 | 194 | logger.info "MailHandler: ignoring reply from [#{sender_email}] to a locked topic" if logger && logger.info |
|
|
191 | 195 | end |
|
|
192 | 196 | end |
|
|
193 | 197 | end |
|
|
194 | 198 | |
|
|
195 | 199 | def add_attachments(obj) |
|
|
196 | 200 | if email.has_attachments? |
|
|
197 | 201 | email.attachments.each do |attachment| |
|
|
198 | 202 | Attachment.create(:container => obj, |
|
|
199 | 203 | :file => attachment, |
|
|
200 | 204 | :author => user, |
|
|
201 | 205 | :content_type => attachment.content_type) |
|
|
202 | 206 | end |
|
|
203 | 207 | end |
|
|
204 | 208 | end |
|
|
205 | 209 | |
|
|
206 | 210 | # Adds To and Cc as watchers of the given object if the sender has the |
|
|
207 | 211 | # appropriate permission |
|
|
208 | 212 | def add_watchers(obj) |
|
|
209 | 213 | if user.allowed_to?("add_#{obj.class.name.underscore}_watchers".to_sym, obj.project) |
|
|
210 | 214 | addresses = [email.to, email.cc].flatten.compact.uniq.collect {|a| a.strip.downcase} |
|
|
211 | 215 | unless addresses.empty? |
|
|
212 | 216 | watchers = User.active.find(:all, :conditions => ['LOWER(mail) IN (?)', addresses]) |
|
|
213 | 217 | watchers.each {|w| obj.add_watcher(w)} |
|
|
214 | 218 | end |
|
|
215 | 219 | end |
|
|
216 | 220 | end |
|
|
217 | 221 | |
|
|
218 | 222 | def get_keyword(attr, options={}) |
|
|
219 | 223 | @keywords ||= {} |
|
|
220 | 224 | if @keywords.has_key?(attr) |
|
|
221 | 225 | @keywords[attr] |
|
|
222 | 226 | else |
|
|
223 | 227 | @keywords[attr] = begin |
|
|
224 | 228 | if (options[:override] || @@handler_options[:allow_override].include?(attr.to_s)) && (v = extract_keyword!(plain_text_body, attr, options[:format])) |
|
|
225 | 229 | v |
|
|
226 | 230 | elsif !@@handler_options[:issue][attr].blank? |
|
|
227 | 231 | @@handler_options[:issue][attr] |
|
|
228 | 232 | end |
|
|
229 | 233 | end |
|
|
230 | 234 | end |
|
|
231 | 235 | end |
|
|
232 | 236 | |
|
|
233 | 237 | # Destructively extracts the value for +attr+ in +text+ |
|
|
234 | 238 | # Returns nil if no matching keyword found |
|
|
235 | 239 | def extract_keyword!(text, attr, format=nil) |
|
|
236 | 240 | keys = [attr.to_s.humanize] |
|
|
237 | 241 | if attr.is_a?(Symbol) |
|
|
238 | 242 | keys << l("field_#{attr}", :default => '', :locale => user.language) if user && user.language.present? |
|
|
239 | 243 | keys << l("field_#{attr}", :default => '', :locale => Setting.default_language) if Setting.default_language.present? |
|
|
240 | 244 | end |
|
|
241 | 245 | keys.reject! {|k| k.blank?} |
|
|
242 | 246 | keys.collect! {|k| Regexp.escape(k)} |
|
|
243 | 247 | format ||= '.+' |
|
|
244 | 248 | text.gsub!(/^(#{keys.join('|')})[ \t]*:[ \t]*(#{format})\s*$/i, '') |
|
|
245 | 249 | $2 && $2.strip |
|
|
246 | 250 | end |
|
|
247 | 251 | |
|
|
248 | 252 | def target_project |
|
|
249 | 253 | # TODO: other ways to specify project: |
|
|
250 | 254 | # * parse the email To field |
|
|
251 | 255 | # * specific project (eg. Setting.mail_handler_target_project) |
|
|
252 | 256 | target = Project.find_by_identifier(get_keyword(:project)) |
|
|
253 | 257 | raise MissingInformation.new('Unable to determine target project') if target.nil? |
|
|
254 | 258 | target |
|
|
255 | 259 | end |
|
|
256 | 260 | |
|
|
257 | 261 | # Returns a Hash of issue attributes extracted from keywords in the email body |
|
|
258 | 262 | def issue_attributes_from_keywords(issue) |
|
|
259 | 263 | assigned_to = (k = get_keyword(:assigned_to, :override => true)) && find_user_from_keyword(k) |
|
|
260 | 264 | assigned_to = nil if assigned_to && !issue.assignable_users.include?(assigned_to) |
|
|
261 | 265 | |
|
|
262 | 266 | attrs = { |
|
|
263 | 267 | 'tracker_id' => (k = get_keyword(:tracker)) && issue.project.trackers.find_by_name(k).try(:id), |
|
|
264 | 268 | 'status_id' => (k = get_keyword(:status)) && IssueStatus.find_by_name(k).try(:id), |
|
|
265 | 269 | 'priority_id' => (k = get_keyword(:priority)) && IssuePriority.find_by_name(k).try(:id), |
|
|
266 | 270 | 'category_id' => (k = get_keyword(:category)) && issue.project.issue_categories.find_by_name(k).try(:id), |
|
|
267 | 271 | 'assigned_to_id' => assigned_to.try(:id), |
|
|
268 | 272 | 'fixed_version_id' => (k = get_keyword(:fixed_version, :override => true)) && issue.project.shared_versions.find_by_name(k).try(:id), |
|
|
269 | 273 | 'start_date' => get_keyword(:start_date, :override => true, :format => '\d{4}-\d{2}-\d{2}'), |
|
|
270 | 274 | 'due_date' => get_keyword(:due_date, :override => true, :format => '\d{4}-\d{2}-\d{2}'), |
|
|
271 | 275 | 'estimated_hours' => get_keyword(:estimated_hours, :override => true), |
|
|
272 | 276 | 'done_ratio' => get_keyword(:done_ratio, :override => true, :format => '(\d|10)?0') |
|
|
273 | 277 | }.delete_if {|k, v| v.blank? } |
|
|
274 | 278 | |
|
|
275 | 279 | if issue.new_record? && attrs['tracker_id'].nil? |
|
|
276 | 280 | attrs['tracker_id'] = issue.project.trackers.find(:first).try(:id) |
|
|
277 | 281 | end |
|
|
278 | 282 | |
|
|
279 | 283 | attrs |
|
|
280 | 284 | end |
|
|
281 | 285 | |
|
|
282 | 286 | # Returns a Hash of issue custom field values extracted from keywords in the email body |
|
|
283 | 287 | def custom_field_values_from_keywords(customized) |
|
|
284 | 288 | customized.custom_field_values.inject({}) do |h, v| |
|
|
285 | 289 | if value = get_keyword(v.custom_field.name, :override => true) |
|
|
286 | 290 | h[v.custom_field.id.to_s] = value |
|
|
287 | 291 | end |
|
|
288 | 292 | h |
|
|
289 | 293 | end |
|
|
290 | 294 | end |
|
|
291 | 295 | |
|
|
292 | 296 | # Returns the text/plain part of the email |
|
|
293 | 297 | # If not found (eg. HTML-only email), returns the body with tags removed |
|
|
294 | 298 | def plain_text_body |
|
|
295 | 299 | return @plain_text_body unless @plain_text_body.nil? |
|
|
296 | 300 | parts = @email.parts.collect {|c| (c.respond_to?(:parts) && !c.parts.empty?) ? c.parts : c}.flatten |
|
|
297 | 301 | if parts.empty? |
|
|
298 | 302 | parts << @email |
|
|
299 | 303 | end |
|
|
300 | 304 | plain_text_part = parts.detect {|p| p.content_type == 'text/plain'} |
|
|
301 | 305 | if plain_text_part.nil? |
|
|
302 | 306 | # no text/plain part found, assuming html-only email |
|
|
303 | 307 | # strip html tags and remove doctype directive |
|
|
304 | 308 | @plain_text_body = strip_tags(@email.body.to_s) |
|
|
305 | 309 | @plain_text_body.gsub! %r{^<!DOCTYPE .*$}, '' |
|
|
306 | 310 | else |
|
|
307 | 311 | @plain_text_body = plain_text_part.body.to_s |
|
|
308 | 312 | end |
|
|
309 | 313 | @plain_text_body.strip! |
|
|
310 | 314 | @plain_text_body |
|
|
311 | 315 | end |
|
|
312 | 316 | |
|
|
313 | 317 | def cleaned_up_text_body |
|
|
314 | 318 | cleanup_body(plain_text_body) |
|
|
315 | 319 | end |
|
|
316 | 320 | |
|
|
317 | 321 | def self.full_sanitizer |
|
|
318 | 322 | @full_sanitizer ||= HTML::FullSanitizer.new |
|
|
319 | 323 | end |
|
|
320 | 324 | |
|
|
321 | 325 | # Creates a user account for the +email+ sender |
|
|
322 | 326 | def self.create_user_from_email(email) |
|
|
323 | 327 | addr = email.from_addrs.to_a.first |
|
|
324 | 328 | if addr && !addr.spec.blank? |
|
|
325 | 329 | user = User.new |
|
|
326 | 330 | user.mail = addr.spec |
|
|
327 | 331 | |
|
|
328 | 332 | names = addr.name.blank? ? addr.spec.gsub(/@.*$/, '').split('.') : addr.name.split |
|
|
329 | 333 | user.firstname = names.shift |
|
|
330 | 334 | user.lastname = names.join(' ') |
|
|
331 | 335 | user.lastname = '-' if user.lastname.blank? |
|
|
332 | 336 | |
|
|
333 | 337 | user.login = user.mail |
|
|
334 | 338 | user.password = ActiveSupport::SecureRandom.hex(5) |
|
|
335 | 339 | user.language = Setting.default_language |
|
|
336 | 340 | user.save ? user : nil |
|
|
337 | 341 | end |
|
|
338 | 342 | end |
|
|
339 | 343 | |
|
|
340 | 344 | private |
|
|
341 | 345 | |
|
|
342 | 346 | # Removes the email body of text after the truncation configurations. |
|
|
343 | 347 | def cleanup_body(body) |
|
|
344 | 348 | delimiters = Setting.mail_handler_body_delimiters.to_s.split(/[\r\n]+/).reject(&:blank?).map {|s| Regexp.escape(s)} |
|
|
345 | 349 | unless delimiters.empty? |
|
|
346 | 350 | regex = Regexp.new("^[> ]*(#{ delimiters.join('|') })\s*[\r\n].*", Regexp::MULTILINE) |
|
|
347 | 351 | body = body.gsub(regex, '') |
|
|
348 | 352 | end |
|
|
349 | 353 | body.strip |
|
|
350 | 354 | end |
|
|
351 | 355 | |
|
|
352 | 356 | def find_user_from_keyword(keyword) |
|
|
353 | 357 | user ||= User.find_by_mail(keyword) |
|
|
354 | 358 | user ||= User.find_by_login(keyword) |
|
|
355 | 359 | if user.nil? && keyword.match(/ /) |
|
|
356 | 360 | firstname, lastname = *(keyword.split) # "First Last Throwaway" |
|
|
357 | 361 | user ||= User.find_by_firstname_and_lastname(firstname, lastname) |
|
|
358 | 362 | end |
|
|
359 | 363 | user |
|
|
360 | 364 | end |
|
|
361 | 365 | end |
General Comments 0
You need to be logged in to leave comments.
Login now