##// END OF EJS Templates
Code cleanup....
Jean-Philippe Lang -
r10154:972a991a922e
parent child
Show More
@@ -1,474 +1,474
1 1 # Redmine - project management software
2 2 # Copyright (C) 2006-2012 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 Mailer < ActionMailer::Base
19 19 layout 'mailer'
20 20 helper :application
21 21 helper :issues
22 22 helper :custom_fields
23 23
24 24 include Redmine::I18n
25 25
26 26 def self.default_url_options
27 27 { :host => Setting.host_name, :protocol => Setting.protocol }
28 28 end
29 29
30 30 # Builds a Mail::Message object used to email recipients of the added issue.
31 31 #
32 32 # Example:
33 33 # issue_add(issue) => Mail::Message object
34 34 # Mailer.issue_add(issue).deliver => sends an email to issue recipients
35 35 def issue_add(issue)
36 36 redmine_headers 'Project' => issue.project.identifier,
37 37 'Issue-Id' => issue.id,
38 38 'Issue-Author' => issue.author.login
39 39 redmine_headers 'Issue-Assignee' => issue.assigned_to.login if issue.assigned_to
40 40 message_id issue
41 41 @author = issue.author
42 42 @issue = issue
43 43 @issue_url = url_for(:controller => 'issues', :action => 'show', :id => issue)
44 44 recipients = issue.recipients
45 45 cc = issue.watcher_recipients - recipients
46 46 mail :to => recipients,
47 47 :cc => cc,
48 48 :subject => "[#{issue.project.name} - #{issue.tracker.name} ##{issue.id}] (#{issue.status.name}) #{issue.subject}"
49 49 end
50 50
51 51 # Builds a Mail::Message object used to email recipients of the edited issue.
52 52 #
53 53 # Example:
54 54 # issue_edit(journal) => Mail::Message object
55 55 # Mailer.issue_edit(journal).deliver => sends an email to issue recipients
56 56 def issue_edit(journal)
57 57 issue = journal.journalized.reload
58 58 redmine_headers 'Project' => issue.project.identifier,
59 59 'Issue-Id' => issue.id,
60 60 'Issue-Author' => issue.author.login
61 61 redmine_headers 'Issue-Assignee' => issue.assigned_to.login if issue.assigned_to
62 62 message_id journal
63 63 references issue
64 64 @author = journal.user
65 65 recipients = issue.recipients
66 66 # Watchers in cc
67 67 cc = issue.watcher_recipients - recipients
68 68 s = "[#{issue.project.name} - #{issue.tracker.name} ##{issue.id}] "
69 69 s << "(#{issue.status.name}) " if journal.new_value_for('status_id')
70 70 s << issue.subject
71 71 @issue = issue
72 72 @journal = journal
73 73 @issue_url = url_for(:controller => 'issues', :action => 'show', :id => issue, :anchor => "change-#{journal.id}")
74 74 mail :to => recipients,
75 75 :cc => cc,
76 76 :subject => s
77 77 end
78 78
79 79 def reminder(user, issues, days)
80 80 set_language_if_valid user.language
81 81 @issues = issues
82 82 @days = days
83 83 @issues_url = url_for(:controller => 'issues', :action => 'index',
84 84 :set_filter => 1, :assigned_to_id => user.id,
85 85 :sort => 'due_date:asc')
86 86 mail :to => user.mail,
87 87 :subject => l(:mail_subject_reminder, :count => issues.size, :days => days)
88 88 end
89 89
90 90 # Builds a Mail::Message object used to email users belonging to the added document's project.
91 91 #
92 92 # Example:
93 93 # document_added(document) => Mail::Message object
94 94 # Mailer.document_added(document).deliver => sends an email to the document's project recipients
95 95 def document_added(document)
96 96 redmine_headers 'Project' => document.project.identifier
97 97 @author = User.current
98 98 @document = document
99 99 @document_url = url_for(:controller => 'documents', :action => 'show', :id => document)
100 100 mail :to => document.recipients,
101 101 :subject => "[#{document.project.name}] #{l(:label_document_new)}: #{document.title}"
102 102 end
103 103
104 104 # Builds a Mail::Message object used to email recipients of a project when an attachements are added.
105 105 #
106 106 # Example:
107 107 # attachments_added(attachments) => Mail::Message object
108 108 # Mailer.attachments_added(attachments).deliver => sends an email to the project's recipients
109 109 def attachments_added(attachments)
110 110 container = attachments.first.container
111 111 added_to = ''
112 112 added_to_url = ''
113 113 @author = attachments.first.author
114 114 case container.class.name
115 115 when 'Project'
116 116 added_to_url = url_for(:controller => 'files', :action => 'index', :project_id => container)
117 117 added_to = "#{l(:label_project)}: #{container}"
118 118 recipients = container.project.notified_users.select {|user| user.allowed_to?(:view_files, container.project)}.collect {|u| u.mail}
119 119 when 'Version'
120 120 added_to_url = url_for(:controller => 'files', :action => 'index', :project_id => container.project)
121 121 added_to = "#{l(:label_version)}: #{container.name}"
122 122 recipients = container.project.notified_users.select {|user| user.allowed_to?(:view_files, container.project)}.collect {|u| u.mail}
123 123 when 'Document'
124 124 added_to_url = url_for(:controller => 'documents', :action => 'show', :id => container.id)
125 125 added_to = "#{l(:label_document)}: #{container.title}"
126 126 recipients = container.recipients
127 127 end
128 128 redmine_headers 'Project' => container.project.identifier
129 129 @attachments = attachments
130 130 @added_to = added_to
131 131 @added_to_url = added_to_url
132 132 mail :to => recipients,
133 133 :subject => "[#{container.project.name}] #{l(:label_attachment_new)}"
134 134 end
135 135
136 136 # Builds a Mail::Message object used to email recipients of a news' project when a news item is added.
137 137 #
138 138 # Example:
139 139 # news_added(news) => Mail::Message object
140 140 # Mailer.news_added(news).deliver => sends an email to the news' project recipients
141 141 def news_added(news)
142 142 redmine_headers 'Project' => news.project.identifier
143 143 @author = news.author
144 144 message_id news
145 145 @news = news
146 146 @news_url = url_for(:controller => 'news', :action => 'show', :id => news)
147 147 mail :to => news.recipients,
148 148 :subject => "[#{news.project.name}] #{l(:label_news)}: #{news.title}"
149 149 end
150 150
151 151 # Builds a Mail::Message object used to email recipients of a news' project when a news comment is added.
152 152 #
153 153 # Example:
154 154 # news_comment_added(comment) => Mail::Message object
155 155 # Mailer.news_comment_added(comment) => sends an email to the news' project recipients
156 156 def news_comment_added(comment)
157 157 news = comment.commented
158 158 redmine_headers 'Project' => news.project.identifier
159 159 @author = comment.author
160 160 message_id comment
161 161 @news = news
162 162 @comment = comment
163 163 @news_url = url_for(:controller => 'news', :action => 'show', :id => news)
164 164 mail :to => news.recipients,
165 165 :cc => news.watcher_recipients,
166 166 :subject => "Re: [#{news.project.name}] #{l(:label_news)}: #{news.title}"
167 167 end
168 168
169 169 # Builds a Mail::Message object used to email the recipients of the specified message that was posted.
170 170 #
171 171 # Example:
172 172 # message_posted(message) => Mail::Message object
173 173 # Mailer.message_posted(message).deliver => sends an email to the recipients
174 174 def message_posted(message)
175 175 redmine_headers 'Project' => message.project.identifier,
176 176 'Topic-Id' => (message.parent_id || message.id)
177 177 @author = message.author
178 178 message_id message
179 179 references message.parent unless message.parent.nil?
180 180 recipients = message.recipients
181 181 cc = ((message.root.watcher_recipients + message.board.watcher_recipients).uniq - recipients)
182 182 @message = message
183 183 @message_url = url_for(message.event_url)
184 184 mail :to => recipients,
185 185 :cc => cc,
186 186 :subject => "[#{message.board.project.name} - #{message.board.name} - msg#{message.root.id}] #{message.subject}"
187 187 end
188 188
189 189 # Builds a Mail::Message object used to email the recipients of a project of the specified wiki content was added.
190 190 #
191 191 # Example:
192 192 # wiki_content_added(wiki_content) => Mail::Message object
193 193 # Mailer.wiki_content_added(wiki_content).deliver => sends an email to the project's recipients
194 194 def wiki_content_added(wiki_content)
195 195 redmine_headers 'Project' => wiki_content.project.identifier,
196 196 'Wiki-Page-Id' => wiki_content.page.id
197 197 @author = wiki_content.author
198 198 message_id wiki_content
199 199 recipients = wiki_content.recipients
200 200 cc = wiki_content.page.wiki.watcher_recipients - recipients
201 201 @wiki_content = wiki_content
202 202 @wiki_content_url = url_for(:controller => 'wiki', :action => 'show',
203 203 :project_id => wiki_content.project,
204 204 :id => wiki_content.page.title)
205 205 mail :to => recipients,
206 206 :cc => cc,
207 207 :subject => "[#{wiki_content.project.name}] #{l(:mail_subject_wiki_content_added, :id => wiki_content.page.pretty_title)}"
208 208 end
209 209
210 210 # Builds a Mail::Message object used to email the recipients of a project of the specified wiki content was updated.
211 211 #
212 212 # Example:
213 213 # wiki_content_updated(wiki_content) => Mail::Message object
214 214 # Mailer.wiki_content_updated(wiki_content).deliver => sends an email to the project's recipients
215 215 def wiki_content_updated(wiki_content)
216 216 redmine_headers 'Project' => wiki_content.project.identifier,
217 217 'Wiki-Page-Id' => wiki_content.page.id
218 218 @author = wiki_content.author
219 219 message_id wiki_content
220 220 recipients = wiki_content.recipients
221 221 cc = wiki_content.page.wiki.watcher_recipients + wiki_content.page.watcher_recipients - recipients
222 222 @wiki_content = wiki_content
223 223 @wiki_content_url = url_for(:controller => 'wiki', :action => 'show',
224 224 :project_id => wiki_content.project,
225 225 :id => wiki_content.page.title)
226 226 @wiki_diff_url = url_for(:controller => 'wiki', :action => 'diff',
227 227 :project_id => wiki_content.project, :id => wiki_content.page.title,
228 228 :version => wiki_content.version)
229 229 mail :to => recipients,
230 230 :cc => cc,
231 231 :subject => "[#{wiki_content.project.name}] #{l(:mail_subject_wiki_content_updated, :id => wiki_content.page.pretty_title)}"
232 232 end
233 233
234 234 # Builds a Mail::Message object used to email the specified user their account information.
235 235 #
236 236 # Example:
237 237 # account_information(user, password) => Mail::Message object
238 238 # Mailer.account_information(user, password).deliver => sends account information to the user
239 239 def account_information(user, password)
240 240 set_language_if_valid user.language
241 241 @user = user
242 242 @password = password
243 243 @login_url = url_for(:controller => 'account', :action => 'login')
244 244 mail :to => user.mail,
245 245 :subject => l(:mail_subject_register, Setting.app_title)
246 246 end
247 247
248 248 # Builds a Mail::Message object used to email all active administrators of an account activation request.
249 249 #
250 250 # Example:
251 251 # account_activation_request(user) => Mail::Message object
252 252 # Mailer.account_activation_request(user).deliver => sends an email to all active administrators
253 253 def account_activation_request(user)
254 254 # Send the email to all active administrators
255 255 recipients = User.active.find(:all, :conditions => {:admin => true}).collect { |u| u.mail }.compact
256 256 @user = user
257 257 @url = url_for(:controller => 'users', :action => 'index',
258 258 :status => User::STATUS_REGISTERED,
259 259 :sort_key => 'created_on', :sort_order => 'desc')
260 260 mail :to => recipients,
261 261 :subject => l(:mail_subject_account_activation_request, Setting.app_title)
262 262 end
263 263
264 264 # Builds a Mail::Message object used to email the specified user that their account was activated by an administrator.
265 265 #
266 266 # Example:
267 267 # account_activated(user) => Mail::Message object
268 268 # Mailer.account_activated(user).deliver => sends an email to the registered user
269 269 def account_activated(user)
270 270 set_language_if_valid user.language
271 271 @user = user
272 272 @login_url = url_for(:controller => 'account', :action => 'login')
273 273 mail :to => user.mail,
274 274 :subject => l(:mail_subject_register, Setting.app_title)
275 275 end
276 276
277 277 def lost_password(token)
278 278 set_language_if_valid(token.user.language)
279 279 @token = token
280 280 @url = url_for(:controller => 'account', :action => 'lost_password', :token => token.value)
281 281 mail :to => token.user.mail,
282 282 :subject => l(:mail_subject_lost_password, Setting.app_title)
283 283 end
284 284
285 285 def register(token)
286 286 set_language_if_valid(token.user.language)
287 287 @token = token
288 288 @url = url_for(:controller => 'account', :action => 'activate', :token => token.value)
289 289 mail :to => token.user.mail,
290 290 :subject => l(:mail_subject_register, Setting.app_title)
291 291 end
292 292
293 293 def test_email(user)
294 294 set_language_if_valid(user.language)
295 295 @url = url_for(:controller => 'welcome')
296 296 mail :to => user.mail,
297 297 :subject => 'Redmine test'
298 298 end
299 299
300 300 # Overrides default deliver! method to prevent from sending an email
301 301 # with no recipient, cc or bcc
302 302 def deliver!(mail = @mail)
303 303 set_language_if_valid @initial_language
304 304 return false if (recipients.nil? || recipients.empty?) &&
305 305 (cc.nil? || cc.empty?) &&
306 306 (bcc.nil? || bcc.empty?)
307 307
308 308
309 309 # Log errors when raise_delivery_errors is set to false, Rails does not
310 310 raise_errors = self.class.raise_delivery_errors
311 311 self.class.raise_delivery_errors = true
312 312 begin
313 313 return super(mail)
314 314 rescue Exception => e
315 315 if raise_errors
316 316 raise e
317 317 elsif mylogger
318 318 mylogger.error "The following error occured while sending email notification: \"#{e.message}\". Check your configuration in config/configuration.yml."
319 319 end
320 320 ensure
321 321 self.class.raise_delivery_errors = raise_errors
322 322 end
323 323 end
324 324
325 325 # Sends reminders to issue assignees
326 326 # Available options:
327 327 # * :days => how many days in the future to remind about (defaults to 7)
328 328 # * :tracker => id of tracker for filtering issues (defaults to all trackers)
329 329 # * :project => id or identifier of project to process (defaults to all projects)
330 330 # * :users => array of user/group ids who should be reminded
331 331 def self.reminders(options={})
332 332 days = options[:days] || 7
333 333 project = options[:project] ? Project.find(options[:project]) : nil
334 334 tracker = options[:tracker] ? Tracker.find(options[:tracker]) : nil
335 335 user_ids = options[:users]
336 336
337 scope = Issue.open.scoped(:conditions => ["#{Issue.table_name}.assigned_to_id IS NOT NULL" +
337 scope = Issue.open.where("#{Issue.table_name}.assigned_to_id IS NOT NULL" +
338 338 " AND #{Project.table_name}.status = #{Project::STATUS_ACTIVE}" +
339 " AND #{Issue.table_name}.due_date <= ?", days.day.from_now.to_date]
339 " AND #{Issue.table_name}.due_date <= ?", days.day.from_now.to_date
340 340 )
341 scope = scope.scoped(:conditions => {:assigned_to_id => user_ids}) if user_ids.present?
342 scope = scope.scoped(:conditions => {:project_id => project.id}) if project
343 scope = scope.scoped(:conditions => {:tracker_id => tracker.id}) if tracker
341 scope = scope.where(:assigned_to_id => user_ids) if user_ids.present?
342 scope = scope.where(:project_id => project.id) if project
343 scope = scope.where(:tracker_id => tracker.id) if tracker
344 344
345 issues_by_assignee = scope.all(:include => [:status, :assigned_to, :project, :tracker]).group_by(&:assigned_to)
345 issues_by_assignee = scope.includes(:status, :assigned_to, :project, :tracker).all.group_by(&:assigned_to)
346 346 issues_by_assignee.keys.each do |assignee|
347 347 if assignee.is_a?(Group)
348 348 assignee.users.each do |user|
349 349 issues_by_assignee[user] ||= []
350 350 issues_by_assignee[user] += issues_by_assignee[assignee]
351 351 end
352 352 end
353 353 end
354 354
355 355 issues_by_assignee.each do |assignee, issues|
356 356 reminder(assignee, issues, days).deliver if assignee.is_a?(User) && assignee.active?
357 357 end
358 358 end
359 359
360 360 # Activates/desactivates email deliveries during +block+
361 361 def self.with_deliveries(enabled = true, &block)
362 362 was_enabled = ActionMailer::Base.perform_deliveries
363 363 ActionMailer::Base.perform_deliveries = !!enabled
364 364 yield
365 365 ensure
366 366 ActionMailer::Base.perform_deliveries = was_enabled
367 367 end
368 368
369 369 # Sends emails synchronously in the given block
370 370 def self.with_synched_deliveries(&block)
371 371 saved_method = ActionMailer::Base.delivery_method
372 372 if m = saved_method.to_s.match(%r{^async_(.+)$})
373 373 synched_method = m[1]
374 374 ActionMailer::Base.delivery_method = synched_method.to_sym
375 375 ActionMailer::Base.send "#{synched_method}_settings=", ActionMailer::Base.send("async_#{synched_method}_settings")
376 376 end
377 377 yield
378 378 ensure
379 379 ActionMailer::Base.delivery_method = saved_method
380 380 end
381 381
382 382 def mail(headers={})
383 383 headers.merge! 'X-Mailer' => 'Redmine',
384 384 'X-Redmine-Host' => Setting.host_name,
385 385 'X-Redmine-Site' => Setting.app_title,
386 386 'X-Auto-Response-Suppress' => 'OOF',
387 387 'Auto-Submitted' => 'auto-generated',
388 388 'From' => Setting.mail_from,
389 389 'List-Id' => "<#{Setting.mail_from.to_s.gsub('@', '.')}>"
390 390
391 391 # Removes the author from the recipients and cc
392 392 # if he doesn't want to receive notifications about what he does
393 393 if @author && @author.logged? && @author.pref[:no_self_notified]
394 394 headers[:to].delete(@author.mail) if headers[:to].is_a?(Array)
395 395 headers[:cc].delete(@author.mail) if headers[:cc].is_a?(Array)
396 396 end
397 397
398 398 if @author && @author.logged?
399 399 redmine_headers 'Sender' => @author.login
400 400 end
401 401
402 402 # Blind carbon copy recipients
403 403 if Setting.bcc_recipients?
404 404 headers[:bcc] = [headers[:to], headers[:cc]].flatten.uniq.reject(&:blank?)
405 405 headers[:to] = nil
406 406 headers[:cc] = nil
407 407 end
408 408
409 409 if @message_id_object
410 410 headers[:message_id] = "<#{self.class.message_id_for(@message_id_object)}>"
411 411 end
412 412 if @references_objects
413 413 headers[:references] = @references_objects.collect {|o| "<#{self.class.message_id_for(o)}>"}.join(' ')
414 414 end
415 415
416 416 super headers do |format|
417 417 format.text
418 418 format.html unless Setting.plain_text_mail?
419 419 end
420 420
421 421 set_language_if_valid @initial_language
422 422 end
423 423
424 424 def initialize(*args)
425 425 @initial_language = current_language
426 426 set_language_if_valid Setting.default_language
427 427 super
428 428 end
429 429
430 430 def self.deliver_mail(mail)
431 431 return false if mail.to.blank? && mail.cc.blank? && mail.bcc.blank?
432 432 super
433 433 end
434 434
435 435 def self.method_missing(method, *args, &block)
436 436 if m = method.to_s.match(%r{^deliver_(.+)$})
437 437 ActiveSupport::Deprecation.warn "Mailer.deliver_#{m[1]}(*args) is deprecated. Use Mailer.#{m[1]}(*args).deliver instead."
438 438 send(m[1], *args).deliver
439 439 else
440 440 super
441 441 end
442 442 end
443 443
444 444 private
445 445
446 446 # Appends a Redmine header field (name is prepended with 'X-Redmine-')
447 447 def redmine_headers(h)
448 448 h.each { |k,v| headers["X-Redmine-#{k}"] = v.to_s }
449 449 end
450 450
451 451 # Returns a predictable Message-Id for the given object
452 452 def self.message_id_for(object)
453 453 # id + timestamp should reduce the odds of a collision
454 454 # as far as we don't send multiple emails for the same object
455 455 timestamp = object.send(object.respond_to?(:created_on) ? :created_on : :updated_on)
456 456 hash = "redmine.#{object.class.name.demodulize.underscore}-#{object.id}.#{timestamp.strftime("%Y%m%d%H%M%S")}"
457 457 host = Setting.mail_from.to_s.gsub(%r{^.*@}, '')
458 458 host = "#{::Socket.gethostname}.redmine" if host.empty?
459 459 "#{hash}@#{host}"
460 460 end
461 461
462 462 def message_id(object)
463 463 @message_id_object = object
464 464 end
465 465
466 466 def references(object)
467 467 @references_objects ||= []
468 468 @references_objects << object
469 469 end
470 470
471 471 def mylogger
472 472 Rails.logger
473 473 end
474 474 end
General Comments 0
You need to be logged in to leave comments. Login now