##// END OF EJS Templates
Fixed: URLs broken in wiki notifications (#6838)....
Jean-Philippe Lang -
r4259:338e407a9119
parent child
Show More
@@ -1,442 +1,442
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 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_key => 'due_date', :sort_order => '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 => 'projects', :action => 'list_files', :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 => 'projects', :action => 'list_files', :id => container.project_id)
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 the recipients of the specified message that was posted.
153 153 #
154 154 # Example:
155 155 # message_posted(message) => tmail object
156 156 # Mailer.deliver_message_posted(message) => sends an email to the recipients
157 157 def message_posted(message)
158 158 redmine_headers 'Project' => message.project.identifier,
159 159 'Topic-Id' => (message.parent_id || message.id)
160 160 message_id message
161 161 references message.parent unless message.parent.nil?
162 162 recipients(message.recipients)
163 163 cc((message.root.watcher_recipients + message.board.watcher_recipients).uniq - @recipients)
164 164 subject "[#{message.board.project.name} - #{message.board.name} - msg#{message.root.id}] #{message.subject}"
165 165 body :message => message,
166 166 :message_url => url_for(message.event_url)
167 167 render_multipart('message_posted', body)
168 168 end
169 169
170 170 # Builds a tmail object used to email the recipients of a project of the specified wiki content was added.
171 171 #
172 172 # Example:
173 173 # wiki_content_added(wiki_content) => tmail object
174 174 # Mailer.deliver_wiki_content_added(wiki_content) => sends an email to the project's recipients
175 175 def wiki_content_added(wiki_content)
176 176 redmine_headers 'Project' => wiki_content.project.identifier,
177 177 'Wiki-Page-Id' => wiki_content.page.id
178 178 message_id wiki_content
179 179 recipients wiki_content.recipients
180 180 cc(wiki_content.page.wiki.watcher_recipients - recipients)
181 181 subject "[#{wiki_content.project.name}] #{l(:mail_subject_wiki_content_added, :id => wiki_content.page.pretty_title)}"
182 182 body :wiki_content => wiki_content,
183 :wiki_content_url => url_for(:controller => 'wiki', :action => 'index', :id => wiki_content.project, :id => wiki_content.page.title)
183 :wiki_content_url => url_for(:controller => 'wiki', :action => 'show', :project_id => wiki_content.project, :id => wiki_content.page.title)
184 184 render_multipart('wiki_content_added', body)
185 185 end
186 186
187 187 # Builds a tmail object used to email the recipients of a project of the specified wiki content was updated.
188 188 #
189 189 # Example:
190 190 # wiki_content_updated(wiki_content) => tmail object
191 191 # Mailer.deliver_wiki_content_updated(wiki_content) => sends an email to the project's recipients
192 192 def wiki_content_updated(wiki_content)
193 193 redmine_headers 'Project' => wiki_content.project.identifier,
194 194 'Wiki-Page-Id' => wiki_content.page.id
195 195 message_id wiki_content
196 196 recipients wiki_content.recipients
197 197 cc(wiki_content.page.wiki.watcher_recipients + wiki_content.page.watcher_recipients - recipients)
198 198 subject "[#{wiki_content.project.name}] #{l(:mail_subject_wiki_content_updated, :id => wiki_content.page.pretty_title)}"
199 199 body :wiki_content => wiki_content,
200 :wiki_content_url => url_for(:controller => 'wiki', :action => 'index', :id => wiki_content.project, :id => wiki_content.page.title),
201 :wiki_diff_url => url_for(:controller => 'wiki', :action => 'diff', :id => wiki_content.project, :id => wiki_content.page.title, :version => wiki_content.version)
200 :wiki_content_url => url_for(:controller => 'wiki', :action => 'show', :project_id => wiki_content.project, :id => wiki_content.page.title),
201 :wiki_diff_url => url_for(:controller => 'wiki', :action => 'diff', :project_id => wiki_content.project, :id => wiki_content.page.title, :version => wiki_content.version)
202 202 render_multipart('wiki_content_updated', body)
203 203 end
204 204
205 205 # Builds a tmail object used to email the specified user their account information.
206 206 #
207 207 # Example:
208 208 # account_information(user, password) => tmail object
209 209 # Mailer.deliver_account_information(user, password) => sends account information to the user
210 210 def account_information(user, password)
211 211 set_language_if_valid user.language
212 212 recipients user.mail
213 213 subject l(:mail_subject_register, Setting.app_title)
214 214 body :user => user,
215 215 :password => password,
216 216 :login_url => url_for(:controller => 'account', :action => 'login')
217 217 render_multipart('account_information', body)
218 218 end
219 219
220 220 # Builds a tmail object used to email all active administrators of an account activation request.
221 221 #
222 222 # Example:
223 223 # account_activation_request(user) => tmail object
224 224 # Mailer.deliver_account_activation_request(user)=> sends an email to all active administrators
225 225 def account_activation_request(user)
226 226 # Send the email to all active administrators
227 227 recipients User.active.find(:all, :conditions => {:admin => true}).collect { |u| u.mail }.compact
228 228 subject l(:mail_subject_account_activation_request, Setting.app_title)
229 229 body :user => user,
230 230 :url => url_for(:controller => 'users', :action => 'index', :status => User::STATUS_REGISTERED, :sort_key => 'created_on', :sort_order => 'desc')
231 231 render_multipart('account_activation_request', body)
232 232 end
233 233
234 234 # Builds a tmail object used to email the specified user that their account was activated by an administrator.
235 235 #
236 236 # Example:
237 237 # account_activated(user) => tmail object
238 238 # Mailer.deliver_account_activated(user) => sends an email to the registered user
239 239 def account_activated(user)
240 240 set_language_if_valid user.language
241 241 recipients user.mail
242 242 subject l(:mail_subject_register, Setting.app_title)
243 243 body :user => user,
244 244 :login_url => url_for(:controller => 'account', :action => 'login')
245 245 render_multipart('account_activated', body)
246 246 end
247 247
248 248 def lost_password(token)
249 249 set_language_if_valid(token.user.language)
250 250 recipients token.user.mail
251 251 subject l(:mail_subject_lost_password, Setting.app_title)
252 252 body :token => token,
253 253 :url => url_for(:controller => 'account', :action => 'lost_password', :token => token.value)
254 254 render_multipart('lost_password', body)
255 255 end
256 256
257 257 def register(token)
258 258 set_language_if_valid(token.user.language)
259 259 recipients token.user.mail
260 260 subject l(:mail_subject_register, Setting.app_title)
261 261 body :token => token,
262 262 :url => url_for(:controller => 'account', :action => 'activate', :token => token.value)
263 263 render_multipart('register', body)
264 264 end
265 265
266 266 def test(user)
267 267 set_language_if_valid(user.language)
268 268 recipients user.mail
269 269 subject 'Redmine test'
270 270 body :url => url_for(:controller => 'welcome')
271 271 render_multipart('test', body)
272 272 end
273 273
274 274 # Overrides default deliver! method to prevent from sending an email
275 275 # with no recipient, cc or bcc
276 276 def deliver!(mail = @mail)
277 277 set_language_if_valid @initial_language
278 278 return false if (recipients.nil? || recipients.empty?) &&
279 279 (cc.nil? || cc.empty?) &&
280 280 (bcc.nil? || bcc.empty?)
281 281
282 282 # Set Message-Id and References
283 283 if @message_id_object
284 284 mail.message_id = self.class.message_id_for(@message_id_object)
285 285 end
286 286 if @references_objects
287 287 mail.references = @references_objects.collect {|o| self.class.message_id_for(o)}
288 288 end
289 289
290 290 # Log errors when raise_delivery_errors is set to false, Rails does not
291 291 raise_errors = self.class.raise_delivery_errors
292 292 self.class.raise_delivery_errors = true
293 293 begin
294 294 return super(mail)
295 295 rescue Exception => e
296 296 if raise_errors
297 297 raise e
298 298 elsif mylogger
299 299 mylogger.error "The following error occured while sending email notification: \"#{e.message}\". Check your configuration in config/email.yml."
300 300 end
301 301 ensure
302 302 self.class.raise_delivery_errors = raise_errors
303 303 end
304 304 end
305 305
306 306 # Sends reminders to issue assignees
307 307 # Available options:
308 308 # * :days => how many days in the future to remind about (defaults to 7)
309 309 # * :tracker => id of tracker for filtering issues (defaults to all trackers)
310 310 # * :project => id or identifier of project to process (defaults to all projects)
311 311 # * :users => array of user ids who should be reminded
312 312 def self.reminders(options={})
313 313 days = options[:days] || 7
314 314 project = options[:project] ? Project.find(options[:project]) : nil
315 315 tracker = options[:tracker] ? Tracker.find(options[:tracker]) : nil
316 316 user_ids = options[:users]
317 317
318 318 s = ARCondition.new ["#{IssueStatus.table_name}.is_closed = ? AND #{Issue.table_name}.due_date <= ?", false, days.day.from_now.to_date]
319 319 s << "#{Issue.table_name}.assigned_to_id IS NOT NULL"
320 320 s << ["#{Issue.table_name}.assigned_to_id IN (?)", user_ids] if user_ids.present?
321 321 s << "#{Project.table_name}.status = #{Project::STATUS_ACTIVE}"
322 322 s << "#{Issue.table_name}.project_id = #{project.id}" if project
323 323 s << "#{Issue.table_name}.tracker_id = #{tracker.id}" if tracker
324 324
325 325 issues_by_assignee = Issue.find(:all, :include => [:status, :assigned_to, :project, :tracker],
326 326 :conditions => s.conditions
327 327 ).group_by(&:assigned_to)
328 328 issues_by_assignee.each do |assignee, issues|
329 329 deliver_reminder(assignee, issues, days) unless assignee.nil?
330 330 end
331 331 end
332 332
333 333 # Activates/desactivates email deliveries during +block+
334 334 def self.with_deliveries(enabled = true, &block)
335 335 was_enabled = ActionMailer::Base.perform_deliveries
336 336 ActionMailer::Base.perform_deliveries = !!enabled
337 337 yield
338 338 ensure
339 339 ActionMailer::Base.perform_deliveries = was_enabled
340 340 end
341 341
342 342 private
343 343 def initialize_defaults(method_name)
344 344 super
345 345 @initial_language = current_language
346 346 set_language_if_valid Setting.default_language
347 347 from Setting.mail_from
348 348
349 349 # Common headers
350 350 headers 'X-Mailer' => 'Redmine',
351 351 'X-Redmine-Host' => Setting.host_name,
352 352 'X-Redmine-Site' => Setting.app_title,
353 353 'Precedence' => 'bulk',
354 354 'Auto-Submitted' => 'auto-generated'
355 355 end
356 356
357 357 # Appends a Redmine header field (name is prepended with 'X-Redmine-')
358 358 def redmine_headers(h)
359 359 h.each { |k,v| headers["X-Redmine-#{k}"] = v }
360 360 end
361 361
362 362 # Overrides the create_mail method
363 363 def create_mail
364 364 # Removes the current user from the recipients and cc
365 365 # if he doesn't want to receive notifications about what he does
366 366 @author ||= User.current
367 367 if @author.pref[:no_self_notified]
368 368 recipients.delete(@author.mail) if recipients
369 369 cc.delete(@author.mail) if cc
370 370 end
371 371
372 372 notified_users = [recipients, cc].flatten.compact.uniq
373 373 # Rails would log recipients only, not cc and bcc
374 374 mylogger.info "Sending email notification to: #{notified_users.join(', ')}" if mylogger
375 375
376 376 # Blind carbon copy recipients
377 377 if Setting.bcc_recipients?
378 378 bcc(notified_users)
379 379 recipients []
380 380 cc []
381 381 end
382 382 super
383 383 end
384 384
385 385 # Rails 2.3 has problems rendering implicit multipart messages with
386 386 # layouts so this method will wrap an multipart messages with
387 387 # explicit parts.
388 388 #
389 389 # https://rails.lighthouseapp.com/projects/8994/tickets/2338-actionmailer-mailer-views-and-content-type
390 390 # https://rails.lighthouseapp.com/projects/8994/tickets/1799-actionmailer-doesnt-set-template_format-when-rendering-layouts
391 391
392 392 def render_multipart(method_name, body)
393 393 if Setting.plain_text_mail?
394 394 content_type "text/plain"
395 395 body render(:file => "#{method_name}.text.plain.rhtml", :body => body, :layout => 'mailer.text.plain.erb')
396 396 else
397 397 content_type "multipart/alternative"
398 398 part :content_type => "text/plain", :body => render(:file => "#{method_name}.text.plain.rhtml", :body => body, :layout => 'mailer.text.plain.erb')
399 399 part :content_type => "text/html", :body => render_message("#{method_name}.text.html.rhtml", body)
400 400 end
401 401 end
402 402
403 403 # Makes partial rendering work with Rails 1.2 (retro-compatibility)
404 404 def self.controller_path
405 405 ''
406 406 end unless respond_to?('controller_path')
407 407
408 408 # Returns a predictable Message-Id for the given object
409 409 def self.message_id_for(object)
410 410 # id + timestamp should reduce the odds of a collision
411 411 # as far as we don't send multiple emails for the same object
412 412 timestamp = object.send(object.respond_to?(:created_on) ? :created_on : :updated_on)
413 413 hash = "redmine.#{object.class.name.demodulize.underscore}-#{object.id}.#{timestamp.strftime("%Y%m%d%H%M%S")}"
414 414 host = Setting.mail_from.to_s.gsub(%r{^.*@}, '')
415 415 host = "#{::Socket.gethostname}.redmine" if host.empty?
416 416 "<#{hash}@#{host}>"
417 417 end
418 418
419 419 private
420 420
421 421 def message_id(object)
422 422 @message_id_object = object
423 423 end
424 424
425 425 def references(object)
426 426 @references_objects ||= []
427 427 @references_objects << object
428 428 end
429 429
430 430 def mylogger
431 431 RAILS_DEFAULT_LOGGER
432 432 end
433 433 end
434 434
435 435 # Patch TMail so that message_id is not overwritten
436 436 module TMail
437 437 class Mail
438 438 def add_message_id( fqdn = nil )
439 439 self.message_id ||= ::TMail::new_message_id(fqdn)
440 440 end
441 441 end
442 442 end
General Comments 0
You need to be logged in to leave comments. Login now