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