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