@@ -1,495 +1,495 | |||
|
1 | 1 | # Redmine - project management software |
|
2 | 2 | # Copyright (C) 2006-2014 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 for notifying to_users and cc_users about a new issue |
|
31 | 31 | def issue_add(issue, to_users, cc_users) |
|
32 | 32 | redmine_headers 'Project' => issue.project.identifier, |
|
33 | 33 | 'Issue-Id' => issue.id, |
|
34 | 34 | 'Issue-Author' => issue.author.login |
|
35 | 35 | redmine_headers 'Issue-Assignee' => issue.assigned_to.login if issue.assigned_to |
|
36 | 36 | message_id issue |
|
37 | 37 | references issue |
|
38 | 38 | @author = issue.author |
|
39 | 39 | @issue = issue |
|
40 | 40 | @users = to_users + cc_users |
|
41 | 41 | @issue_url = url_for(:controller => 'issues', :action => 'show', :id => issue) |
|
42 | 42 | mail :to => to_users.map(&:mail), |
|
43 | 43 | :cc => cc_users.map(&:mail), |
|
44 | 44 | :subject => "[#{issue.project.name} - #{issue.tracker.name} ##{issue.id}] (#{issue.status.name}) #{issue.subject}" |
|
45 | 45 | end |
|
46 | 46 | |
|
47 | 47 | # Notifies users about a new issue |
|
48 | 48 | def self.deliver_issue_add(issue) |
|
49 | 49 | to = issue.notified_users |
|
50 | 50 | cc = issue.notified_watchers - to |
|
51 | 51 | issue.each_notification(to + cc) do |users| |
|
52 | 52 | Mailer.issue_add(issue, to & users, cc & users).deliver |
|
53 | 53 | end |
|
54 | 54 | end |
|
55 | 55 | |
|
56 | 56 | # Builds a mail for notifying to_users and cc_users about an issue update |
|
57 | 57 | def issue_edit(journal, to_users, cc_users) |
|
58 | 58 | issue = journal.journalized |
|
59 | 59 | redmine_headers 'Project' => issue.project.identifier, |
|
60 | 60 | 'Issue-Id' => issue.id, |
|
61 | 61 | 'Issue-Author' => issue.author.login |
|
62 | 62 | redmine_headers 'Issue-Assignee' => issue.assigned_to.login if issue.assigned_to |
|
63 | 63 | message_id journal |
|
64 | 64 | references issue |
|
65 | 65 | @author = journal.user |
|
66 | 66 | s = "[#{issue.project.name} - #{issue.tracker.name} ##{issue.id}] " |
|
67 | 67 | s << "(#{issue.status.name}) " if journal.new_value_for('status_id') |
|
68 | 68 | s << issue.subject |
|
69 | 69 | @issue = issue |
|
70 | 70 | @users = to_users + cc_users |
|
71 | 71 | @journal = journal |
|
72 | 72 | @journal_details = journal.visible_details(@users.first) |
|
73 | 73 | @issue_url = url_for(:controller => 'issues', :action => 'show', :id => issue, :anchor => "change-#{journal.id}") |
|
74 | 74 | mail :to => to_users.map(&:mail), |
|
75 | 75 | :cc => cc_users.map(&:mail), |
|
76 | 76 | :subject => s |
|
77 | 77 | end |
|
78 | 78 | |
|
79 | 79 | # Notifies users about an issue update |
|
80 | 80 | def self.deliver_issue_edit(journal) |
|
81 | 81 | issue = journal.journalized.reload |
|
82 | 82 | to = journal.notified_users |
|
83 | 83 | cc = journal.notified_watchers - to |
|
84 | 84 | journal.each_notification(to + cc) do |users| |
|
85 | 85 | issue.each_notification(users) do |users2| |
|
86 | 86 | Mailer.issue_edit(journal, to & users2, cc & users2).deliver |
|
87 | 87 | end |
|
88 | 88 | end |
|
89 | 89 | end |
|
90 | 90 | |
|
91 | 91 | def reminder(user, issues, days) |
|
92 | 92 | set_language_if_valid user.language |
|
93 | 93 | @issues = issues |
|
94 | 94 | @days = days |
|
95 | 95 | @issues_url = url_for(:controller => 'issues', :action => 'index', |
|
96 | 96 | :set_filter => 1, :assigned_to_id => user.id, |
|
97 | 97 | :sort => 'due_date:asc') |
|
98 | 98 | mail :to => user.mail, |
|
99 | 99 | :subject => l(:mail_subject_reminder, :count => issues.size, :days => days) |
|
100 | 100 | end |
|
101 | 101 | |
|
102 | 102 | # Builds a Mail::Message object used to email users belonging to the added document's project. |
|
103 | 103 | # |
|
104 | 104 | # Example: |
|
105 | 105 | # document_added(document) => Mail::Message object |
|
106 | 106 | # Mailer.document_added(document).deliver => sends an email to the document's project recipients |
|
107 | 107 | def document_added(document) |
|
108 | 108 | redmine_headers 'Project' => document.project.identifier |
|
109 | 109 | @author = User.current |
|
110 | 110 | @document = document |
|
111 | 111 | @document_url = url_for(:controller => 'documents', :action => 'show', :id => document) |
|
112 | 112 | mail :to => document.recipients, |
|
113 | 113 | :subject => "[#{document.project.name}] #{l(:label_document_new)}: #{document.title}" |
|
114 | 114 | end |
|
115 | 115 | |
|
116 | 116 | # Builds a Mail::Message object used to email recipients of a project when an attachements are added. |
|
117 | 117 | # |
|
118 | 118 | # Example: |
|
119 | 119 | # attachments_added(attachments) => Mail::Message object |
|
120 | 120 | # Mailer.attachments_added(attachments).deliver => sends an email to the project's recipients |
|
121 | 121 | def attachments_added(attachments) |
|
122 | 122 | container = attachments.first.container |
|
123 | 123 | added_to = '' |
|
124 | 124 | added_to_url = '' |
|
125 | 125 | @author = attachments.first.author |
|
126 | 126 | case container.class.name |
|
127 | 127 | when 'Project' |
|
128 | 128 | added_to_url = url_for(:controller => 'files', :action => 'index', :project_id => container) |
|
129 | 129 | added_to = "#{l(:label_project)}: #{container}" |
|
130 | 130 | recipients = container.project.notified_users.select {|user| user.allowed_to?(:view_files, container.project)}.collect {|u| u.mail} |
|
131 | 131 | when 'Version' |
|
132 | 132 | added_to_url = url_for(:controller => 'files', :action => 'index', :project_id => container.project) |
|
133 | 133 | added_to = "#{l(:label_version)}: #{container.name}" |
|
134 | 134 | recipients = container.project.notified_users.select {|user| user.allowed_to?(:view_files, container.project)}.collect {|u| u.mail} |
|
135 | 135 | when 'Document' |
|
136 | 136 | added_to_url = url_for(:controller => 'documents', :action => 'show', :id => container.id) |
|
137 | 137 | added_to = "#{l(:label_document)}: #{container.title}" |
|
138 | 138 | recipients = container.recipients |
|
139 | 139 | end |
|
140 | 140 | redmine_headers 'Project' => container.project.identifier |
|
141 | 141 | @attachments = attachments |
|
142 | 142 | @added_to = added_to |
|
143 | 143 | @added_to_url = added_to_url |
|
144 | 144 | mail :to => recipients, |
|
145 | 145 | :subject => "[#{container.project.name}] #{l(:label_attachment_new)}" |
|
146 | 146 | end |
|
147 | 147 | |
|
148 | 148 | # Builds a Mail::Message object used to email recipients of a news' project when a news item is added. |
|
149 | 149 | # |
|
150 | 150 | # Example: |
|
151 | 151 | # news_added(news) => Mail::Message object |
|
152 | 152 | # Mailer.news_added(news).deliver => sends an email to the news' project recipients |
|
153 | 153 | def news_added(news) |
|
154 | 154 | redmine_headers 'Project' => news.project.identifier |
|
155 | 155 | @author = news.author |
|
156 | 156 | message_id news |
|
157 | 157 | references news |
|
158 | 158 | @news = news |
|
159 | 159 | @news_url = url_for(:controller => 'news', :action => 'show', :id => news) |
|
160 | 160 | mail :to => news.recipients, |
|
161 | 161 | :cc => news.cc_for_added_news, |
|
162 | 162 | :subject => "[#{news.project.name}] #{l(:label_news)}: #{news.title}" |
|
163 | 163 | end |
|
164 | 164 | |
|
165 | 165 | # Builds a Mail::Message object used to email recipients of a news' project when a news comment is added. |
|
166 | 166 | # |
|
167 | 167 | # Example: |
|
168 | 168 | # news_comment_added(comment) => Mail::Message object |
|
169 | 169 | # Mailer.news_comment_added(comment) => sends an email to the news' project recipients |
|
170 | 170 | def news_comment_added(comment) |
|
171 | 171 | news = comment.commented |
|
172 | 172 | redmine_headers 'Project' => news.project.identifier |
|
173 | 173 | @author = comment.author |
|
174 | 174 | message_id comment |
|
175 | 175 | references news |
|
176 | 176 | @news = news |
|
177 | 177 | @comment = comment |
|
178 | 178 | @news_url = url_for(:controller => 'news', :action => 'show', :id => news) |
|
179 | 179 | mail :to => news.recipients, |
|
180 | 180 | :cc => news.watcher_recipients, |
|
181 | 181 | :subject => "Re: [#{news.project.name}] #{l(:label_news)}: #{news.title}" |
|
182 | 182 | end |
|
183 | 183 | |
|
184 | 184 | # Builds a Mail::Message object used to email the recipients of the specified message that was posted. |
|
185 | 185 | # |
|
186 | 186 | # Example: |
|
187 | 187 | # message_posted(message) => Mail::Message object |
|
188 | 188 | # Mailer.message_posted(message).deliver => sends an email to the recipients |
|
189 | 189 | def message_posted(message) |
|
190 | 190 | redmine_headers 'Project' => message.project.identifier, |
|
191 | 191 | 'Topic-Id' => (message.parent_id || message.id) |
|
192 | 192 | @author = message.author |
|
193 | 193 | message_id message |
|
194 | 194 | references message.root |
|
195 | 195 | recipients = message.recipients |
|
196 | 196 | cc = ((message.root.watcher_recipients + message.board.watcher_recipients).uniq - recipients) |
|
197 | 197 | @message = message |
|
198 | 198 | @message_url = url_for(message.event_url) |
|
199 | 199 | mail :to => recipients, |
|
200 | 200 | :cc => cc, |
|
201 | 201 | :subject => "[#{message.board.project.name} - #{message.board.name} - msg#{message.root.id}] #{message.subject}" |
|
202 | 202 | end |
|
203 | 203 | |
|
204 | 204 | # Builds a Mail::Message object used to email the recipients of a project of the specified wiki content was added. |
|
205 | 205 | # |
|
206 | 206 | # Example: |
|
207 | 207 | # wiki_content_added(wiki_content) => Mail::Message object |
|
208 | 208 | # Mailer.wiki_content_added(wiki_content).deliver => sends an email to the project's recipients |
|
209 | 209 | def wiki_content_added(wiki_content) |
|
210 | 210 | redmine_headers 'Project' => wiki_content.project.identifier, |
|
211 | 211 | 'Wiki-Page-Id' => wiki_content.page.id |
|
212 | 212 | @author = wiki_content.author |
|
213 | 213 | message_id wiki_content |
|
214 | 214 | recipients = wiki_content.recipients |
|
215 | 215 | cc = wiki_content.page.wiki.watcher_recipients - recipients |
|
216 | 216 | @wiki_content = wiki_content |
|
217 | 217 | @wiki_content_url = url_for(:controller => 'wiki', :action => 'show', |
|
218 | 218 | :project_id => wiki_content.project, |
|
219 | 219 | :id => wiki_content.page.title) |
|
220 | 220 | mail :to => recipients, |
|
221 | 221 | :cc => cc, |
|
222 | 222 | :subject => "[#{wiki_content.project.name}] #{l(:mail_subject_wiki_content_added, :id => wiki_content.page.pretty_title)}" |
|
223 | 223 | end |
|
224 | 224 | |
|
225 | 225 | # Builds a Mail::Message object used to email the recipients of a project of the specified wiki content was updated. |
|
226 | 226 | # |
|
227 | 227 | # Example: |
|
228 | 228 | # wiki_content_updated(wiki_content) => Mail::Message object |
|
229 | 229 | # Mailer.wiki_content_updated(wiki_content).deliver => sends an email to the project's recipients |
|
230 | 230 | def wiki_content_updated(wiki_content) |
|
231 | 231 | redmine_headers 'Project' => wiki_content.project.identifier, |
|
232 | 232 | 'Wiki-Page-Id' => wiki_content.page.id |
|
233 | 233 | @author = wiki_content.author |
|
234 | 234 | message_id wiki_content |
|
235 | 235 | recipients = wiki_content.recipients |
|
236 | 236 | cc = wiki_content.page.wiki.watcher_recipients + wiki_content.page.watcher_recipients - recipients |
|
237 | 237 | @wiki_content = wiki_content |
|
238 | 238 | @wiki_content_url = url_for(:controller => 'wiki', :action => 'show', |
|
239 | 239 | :project_id => wiki_content.project, |
|
240 | 240 | :id => wiki_content.page.title) |
|
241 | 241 | @wiki_diff_url = url_for(:controller => 'wiki', :action => 'diff', |
|
242 | 242 | :project_id => wiki_content.project, :id => wiki_content.page.title, |
|
243 | 243 | :version => wiki_content.version) |
|
244 | 244 | mail :to => recipients, |
|
245 | 245 | :cc => cc, |
|
246 | 246 | :subject => "[#{wiki_content.project.name}] #{l(:mail_subject_wiki_content_updated, :id => wiki_content.page.pretty_title)}" |
|
247 | 247 | end |
|
248 | 248 | |
|
249 | 249 | # Builds a Mail::Message object used to email the specified user their account information. |
|
250 | 250 | # |
|
251 | 251 | # Example: |
|
252 | 252 | # account_information(user, password) => Mail::Message object |
|
253 | 253 | # Mailer.account_information(user, password).deliver => sends account information to the user |
|
254 | 254 | def account_information(user, password) |
|
255 | 255 | set_language_if_valid user.language |
|
256 | 256 | @user = user |
|
257 | 257 | @password = password |
|
258 | 258 | @login_url = url_for(:controller => 'account', :action => 'login') |
|
259 | 259 | mail :to => user.mail, |
|
260 | 260 | :subject => l(:mail_subject_register, Setting.app_title) |
|
261 | 261 | end |
|
262 | 262 | |
|
263 | 263 | # Builds a Mail::Message object used to email all active administrators of an account activation request. |
|
264 | 264 | # |
|
265 | 265 | # Example: |
|
266 | 266 | # account_activation_request(user) => Mail::Message object |
|
267 | 267 | # Mailer.account_activation_request(user).deliver => sends an email to all active administrators |
|
268 | 268 | def account_activation_request(user) |
|
269 | 269 | # Send the email to all active administrators |
|
270 | 270 | recipients = User.active.where(:admin => true).collect { |u| u.mail }.compact |
|
271 | 271 | @user = user |
|
272 | 272 | @url = url_for(:controller => 'users', :action => 'index', |
|
273 | 273 | :status => User::STATUS_REGISTERED, |
|
274 | 274 | :sort_key => 'created_on', :sort_order => 'desc') |
|
275 | 275 | mail :to => recipients, |
|
276 | 276 | :subject => l(:mail_subject_account_activation_request, Setting.app_title) |
|
277 | 277 | end |
|
278 | 278 | |
|
279 | 279 | # Builds a Mail::Message object used to email the specified user that their account was activated by an administrator. |
|
280 | 280 | # |
|
281 | 281 | # Example: |
|
282 | 282 | # account_activated(user) => Mail::Message object |
|
283 | 283 | # Mailer.account_activated(user).deliver => sends an email to the registered user |
|
284 | 284 | def account_activated(user) |
|
285 | 285 | set_language_if_valid user.language |
|
286 | 286 | @user = user |
|
287 | 287 | @login_url = url_for(:controller => 'account', :action => 'login') |
|
288 | 288 | mail :to => user.mail, |
|
289 | 289 | :subject => l(:mail_subject_register, Setting.app_title) |
|
290 | 290 | end |
|
291 | 291 | |
|
292 | 292 | def lost_password(token) |
|
293 | 293 | set_language_if_valid(token.user.language) |
|
294 | 294 | @token = token |
|
295 | 295 | @url = url_for(:controller => 'account', :action => 'lost_password', :token => token.value) |
|
296 | 296 | mail :to => token.user.mail, |
|
297 | 297 | :subject => l(:mail_subject_lost_password, Setting.app_title) |
|
298 | 298 | end |
|
299 | 299 | |
|
300 | 300 | def register(token) |
|
301 | 301 | set_language_if_valid(token.user.language) |
|
302 | 302 | @token = token |
|
303 | 303 | @url = url_for(:controller => 'account', :action => 'activate', :token => token.value) |
|
304 | 304 | mail :to => token.user.mail, |
|
305 | 305 | :subject => l(:mail_subject_register, Setting.app_title) |
|
306 | 306 | end |
|
307 | 307 | |
|
308 | 308 | def test_email(user) |
|
309 | 309 | set_language_if_valid(user.language) |
|
310 | 310 | @url = url_for(:controller => 'welcome') |
|
311 | 311 | mail :to => user.mail, |
|
312 | 312 | :subject => 'Redmine test' |
|
313 | 313 | end |
|
314 | 314 | |
|
315 | 315 | # Sends reminders to issue assignees |
|
316 | 316 | # Available options: |
|
317 | 317 | # * :days => how many days in the future to remind about (defaults to 7) |
|
318 | 318 | # * :tracker => id of tracker for filtering issues (defaults to all trackers) |
|
319 | 319 | # * :project => id or identifier of project to process (defaults to all projects) |
|
320 | 320 | # * :users => array of user/group ids who should be reminded |
|
321 | 321 | def self.reminders(options={}) |
|
322 | 322 | days = options[:days] || 7 |
|
323 | 323 | project = options[:project] ? Project.find(options[:project]) : nil |
|
324 | 324 | tracker = options[:tracker] ? Tracker.find(options[:tracker]) : nil |
|
325 | 325 | user_ids = options[:users] |
|
326 | 326 | |
|
327 | 327 | scope = Issue.open.where("#{Issue.table_name}.assigned_to_id IS NOT NULL" + |
|
328 | 328 | " AND #{Project.table_name}.status = #{Project::STATUS_ACTIVE}" + |
|
329 | 329 | " AND #{Issue.table_name}.due_date <= ?", days.day.from_now.to_date |
|
330 | 330 | ) |
|
331 | 331 | scope = scope.where(:assigned_to_id => user_ids) if user_ids.present? |
|
332 | 332 | scope = scope.where(:project_id => project.id) if project |
|
333 | 333 | scope = scope.where(:tracker_id => tracker.id) if tracker |
|
334 | 334 | issues_by_assignee = scope.includes(:status, :assigned_to, :project, :tracker). |
|
335 | 335 | group_by(&:assigned_to) |
|
336 | 336 | issues_by_assignee.keys.each do |assignee| |
|
337 | 337 | if assignee.is_a?(Group) |
|
338 | 338 | assignee.users.each do |user| |
|
339 | 339 | issues_by_assignee[user] ||= [] |
|
340 | 340 | issues_by_assignee[user] += issues_by_assignee[assignee] |
|
341 | 341 | end |
|
342 | 342 | end |
|
343 | 343 | end |
|
344 | 344 | |
|
345 | 345 | issues_by_assignee.each do |assignee, issues| |
|
346 | 346 | reminder(assignee, issues, days).deliver if assignee.is_a?(User) && assignee.active? |
|
347 | 347 | end |
|
348 | 348 | end |
|
349 | 349 | |
|
350 | 350 | # Activates/desactivates email deliveries during +block+ |
|
351 | 351 | def self.with_deliveries(enabled = true, &block) |
|
352 | 352 | was_enabled = ActionMailer::Base.perform_deliveries |
|
353 | 353 | ActionMailer::Base.perform_deliveries = !!enabled |
|
354 | 354 | yield |
|
355 | 355 | ensure |
|
356 | 356 | ActionMailer::Base.perform_deliveries = was_enabled |
|
357 | 357 | end |
|
358 | 358 | |
|
359 | 359 | # Sends emails synchronously in the given block |
|
360 | 360 | def self.with_synched_deliveries(&block) |
|
361 | 361 | saved_method = ActionMailer::Base.delivery_method |
|
362 | 362 | if m = saved_method.to_s.match(%r{^async_(.+)$}) |
|
363 | 363 | synched_method = m[1] |
|
364 | 364 | ActionMailer::Base.delivery_method = synched_method.to_sym |
|
365 | 365 | ActionMailer::Base.send "#{synched_method}_settings=", ActionMailer::Base.send("async_#{synched_method}_settings") |
|
366 | 366 | end |
|
367 | 367 | yield |
|
368 | 368 | ensure |
|
369 | 369 | ActionMailer::Base.delivery_method = saved_method |
|
370 | 370 | end |
|
371 | 371 | |
|
372 | 372 | def mail(headers={}, &block) |
|
373 | 373 | headers.merge! 'X-Mailer' => 'Redmine', |
|
374 | 374 | 'X-Redmine-Host' => Setting.host_name, |
|
375 | 375 | 'X-Redmine-Site' => Setting.app_title, |
|
376 | 376 | 'X-Auto-Response-Suppress' => 'OOF', |
|
377 | 377 | 'Auto-Submitted' => 'auto-generated', |
|
378 | 378 | 'From' => Setting.mail_from, |
|
379 | 379 | 'List-Id' => "<#{Setting.mail_from.to_s.gsub('@', '.')}>" |
|
380 | 380 | |
|
381 | 381 | # Removes the author from the recipients and cc |
|
382 | 382 | # if the author does not want to receive notifications |
|
383 | 383 | # about what the author do |
|
384 | 384 | if @author && @author.logged? && @author.pref.no_self_notified |
|
385 | 385 | headers[:to].delete(@author.mail) if headers[:to].is_a?(Array) |
|
386 | 386 | headers[:cc].delete(@author.mail) if headers[:cc].is_a?(Array) |
|
387 | 387 | end |
|
388 | 388 | |
|
389 | 389 | if @author && @author.logged? |
|
390 | 390 | redmine_headers 'Sender' => @author.login |
|
391 | 391 | end |
|
392 | 392 | |
|
393 | 393 | # Blind carbon copy recipients |
|
394 | 394 | if Setting.bcc_recipients? |
|
395 | 395 | headers[:bcc] = [headers[:to], headers[:cc]].flatten.uniq.reject(&:blank?) |
|
396 | 396 | headers[:to] = nil |
|
397 | 397 | headers[:cc] = nil |
|
398 | 398 | end |
|
399 | 399 | |
|
400 | 400 | if @message_id_object |
|
401 | 401 | headers[:message_id] = "<#{self.class.message_id_for(@message_id_object)}>" |
|
402 | 402 | end |
|
403 | 403 | if @references_objects |
|
404 | 404 | headers[:references] = @references_objects.collect {|o| "<#{self.class.references_for(o)}>"}.join(' ') |
|
405 | 405 | end |
|
406 | 406 | |
|
407 | 407 | m = if block_given? |
|
408 | 408 | super headers, &block |
|
409 | 409 | else |
|
410 | 410 | super headers do |format| |
|
411 | 411 | format.text |
|
412 | 412 | format.html unless Setting.plain_text_mail? |
|
413 | 413 | end |
|
414 | 414 | end |
|
415 | 415 | set_language_if_valid @initial_language |
|
416 | 416 | |
|
417 | 417 | m |
|
418 | 418 | end |
|
419 | 419 | |
|
420 | 420 | def initialize(*args) |
|
421 | 421 | @initial_language = current_language |
|
422 | 422 | set_language_if_valid Setting.default_language |
|
423 | 423 | super |
|
424 | 424 | end |
|
425 | 425 | |
|
426 | 426 | def self.deliver_mail(mail) |
|
427 | 427 | return false if mail.to.blank? && mail.cc.blank? && mail.bcc.blank? |
|
428 | 428 | begin |
|
429 | 429 | # Log errors when raise_delivery_errors is set to false, Rails does not |
|
430 | 430 | mail.raise_delivery_errors = true |
|
431 | 431 | super |
|
432 | 432 | rescue Exception => e |
|
433 | 433 | if ActionMailer::Base.raise_delivery_errors |
|
434 | 434 | raise e |
|
435 | 435 | else |
|
436 | 436 | Rails.logger.error "Email delivery error: #{e.message}" |
|
437 | 437 | end |
|
438 | 438 | end |
|
439 | 439 | end |
|
440 | 440 | |
|
441 | 441 | def self.method_missing(method, *args, &block) |
|
442 | 442 | if m = method.to_s.match(%r{^deliver_(.+)$}) |
|
443 | 443 | ActiveSupport::Deprecation.warn "Mailer.deliver_#{m[1]}(*args) is deprecated. Use Mailer.#{m[1]}(*args).deliver instead." |
|
444 | 444 | send(m[1], *args).deliver |
|
445 | 445 | else |
|
446 | 446 | super |
|
447 | 447 | end |
|
448 | 448 | end |
|
449 | 449 | |
|
450 | 450 | private |
|
451 | 451 | |
|
452 | 452 | # Appends a Redmine header field (name is prepended with 'X-Redmine-') |
|
453 | 453 | def redmine_headers(h) |
|
454 | 454 | h.each { |k,v| headers["X-Redmine-#{k}"] = v.to_s } |
|
455 | 455 | end |
|
456 | 456 | |
|
457 | 457 | def self.token_for(object, rand=true) |
|
458 | 458 | timestamp = object.send(object.respond_to?(:created_on) ? :created_on : :updated_on) |
|
459 | 459 | hash = [ |
|
460 | 460 | "redmine", |
|
461 | 461 | "#{object.class.name.demodulize.underscore}-#{object.id}", |
|
462 | 462 | timestamp.strftime("%Y%m%d%H%M%S") |
|
463 | 463 | ] |
|
464 | 464 | if rand |
|
465 | 465 | hash << Redmine::Utils.random_hex(8) |
|
466 | 466 | end |
|
467 | host = Setting.mail_from.to_s.gsub(%r{^.*@}, '') | |
|
467 | host = Setting.mail_from.to_s.strip.gsub(%r{^.*@|>}, '') | |
|
468 | 468 | host = "#{::Socket.gethostname}.redmine" if host.empty? |
|
469 | 469 | "#{hash.join('.')}@#{host}" |
|
470 | 470 | end |
|
471 | 471 | |
|
472 | 472 | # Returns a Message-Id for the given object |
|
473 | 473 | def self.message_id_for(object) |
|
474 | 474 | token_for(object, true) |
|
475 | 475 | end |
|
476 | 476 | |
|
477 | 477 | # Returns a uniq token for a given object referenced by all notifications |
|
478 | 478 | # related to this object |
|
479 | 479 | def self.references_for(object) |
|
480 | 480 | token_for(object, false) |
|
481 | 481 | end |
|
482 | 482 | |
|
483 | 483 | def message_id(object) |
|
484 | 484 | @message_id_object = object |
|
485 | 485 | end |
|
486 | 486 | |
|
487 | 487 | def references(object) |
|
488 | 488 | @references_objects ||= [] |
|
489 | 489 | @references_objects << object |
|
490 | 490 | end |
|
491 | 491 | |
|
492 | 492 | def mylogger |
|
493 | 493 | Rails.logger |
|
494 | 494 | end |
|
495 | 495 | end |
@@ -1,768 +1,774 | |||
|
1 | 1 | # Redmine - project management software |
|
2 | 2 | # Copyright (C) 2006-2014 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 File.expand_path('../../test_helper', __FILE__) |
|
19 | 19 | |
|
20 | 20 | class MailerTest < ActiveSupport::TestCase |
|
21 | 21 | include Redmine::I18n |
|
22 | 22 | include ActionDispatch::Assertions::SelectorAssertions |
|
23 | 23 | fixtures :projects, :enabled_modules, :issues, :users, :members, |
|
24 | 24 | :member_roles, :roles, :documents, :attachments, :news, |
|
25 | 25 | :tokens, :journals, :journal_details, :changesets, |
|
26 | 26 | :trackers, :projects_trackers, |
|
27 | 27 | :issue_statuses, :enumerations, :messages, :boards, :repositories, |
|
28 | 28 | :wikis, :wiki_pages, :wiki_contents, :wiki_content_versions, |
|
29 | 29 | :versions, |
|
30 | 30 | :comments |
|
31 | 31 | |
|
32 | 32 | def setup |
|
33 | 33 | ActionMailer::Base.deliveries.clear |
|
34 | 34 | Setting.host_name = 'mydomain.foo' |
|
35 | 35 | Setting.protocol = 'http' |
|
36 | 36 | Setting.plain_text_mail = '0' |
|
37 | 37 | end |
|
38 | 38 | |
|
39 | 39 | def test_generated_links_in_emails |
|
40 | 40 | Setting.default_language = 'en' |
|
41 | 41 | Setting.host_name = 'mydomain.foo' |
|
42 | 42 | Setting.protocol = 'https' |
|
43 | 43 | |
|
44 | 44 | journal = Journal.find(3) |
|
45 | 45 | assert Mailer.deliver_issue_edit(journal) |
|
46 | 46 | |
|
47 | 47 | mail = last_email |
|
48 | 48 | assert_not_nil mail |
|
49 | 49 | |
|
50 | 50 | assert_select_email do |
|
51 | 51 | # link to the main ticket |
|
52 | 52 | assert_select 'a[href=?]', |
|
53 | 53 | 'https://mydomain.foo/issues/2#change-3', |
|
54 | 54 | :text => 'Feature request #2: Add ingredients categories' |
|
55 | 55 | # link to a referenced ticket |
|
56 | 56 | assert_select 'a[href=?][title=?]', |
|
57 | 57 | 'https://mydomain.foo/issues/1', |
|
58 | 58 | "#{ESCAPED_UCANT} print recipes (New)", |
|
59 | 59 | :text => '#1' |
|
60 | 60 | # link to a changeset |
|
61 | 61 | assert_select 'a[href=?][title=?]', |
|
62 | 62 | 'https://mydomain.foo/projects/ecookbook/repository/revisions/2', |
|
63 | 63 | 'This commit fixes #1, #2 and references #1 & #3', |
|
64 | 64 | :text => 'r2' |
|
65 | 65 | # link to a description diff |
|
66 | 66 | assert_select 'a[href=?][title=?]', |
|
67 | 67 | 'https://mydomain.foo/journals/diff/3?detail_id=4', |
|
68 | 68 | 'View differences', |
|
69 | 69 | :text => 'diff' |
|
70 | 70 | # link to an attachment |
|
71 | 71 | assert_select 'a[href=?]', |
|
72 | 72 | 'https://mydomain.foo/attachments/download/4/source.rb', |
|
73 | 73 | :text => 'source.rb' |
|
74 | 74 | end |
|
75 | 75 | end |
|
76 | 76 | |
|
77 | 77 | def test_generated_links_with_prefix |
|
78 | 78 | Setting.default_language = 'en' |
|
79 | 79 | relative_url_root = Redmine::Utils.relative_url_root |
|
80 | 80 | Setting.host_name = 'mydomain.foo/rdm' |
|
81 | 81 | Setting.protocol = 'http' |
|
82 | 82 | |
|
83 | 83 | journal = Journal.find(3) |
|
84 | 84 | assert Mailer.deliver_issue_edit(journal) |
|
85 | 85 | |
|
86 | 86 | mail = last_email |
|
87 | 87 | assert_not_nil mail |
|
88 | 88 | |
|
89 | 89 | assert_select_email do |
|
90 | 90 | # link to the main ticket |
|
91 | 91 | assert_select 'a[href=?]', |
|
92 | 92 | 'http://mydomain.foo/rdm/issues/2#change-3', |
|
93 | 93 | :text => 'Feature request #2: Add ingredients categories' |
|
94 | 94 | # link to a referenced ticket |
|
95 | 95 | assert_select 'a[href=?][title=?]', |
|
96 | 96 | 'http://mydomain.foo/rdm/issues/1', |
|
97 | 97 | "#{ESCAPED_UCANT} print recipes (New)", |
|
98 | 98 | :text => '#1' |
|
99 | 99 | # link to a changeset |
|
100 | 100 | assert_select 'a[href=?][title=?]', |
|
101 | 101 | 'http://mydomain.foo/rdm/projects/ecookbook/repository/revisions/2', |
|
102 | 102 | 'This commit fixes #1, #2 and references #1 & #3', |
|
103 | 103 | :text => 'r2' |
|
104 | 104 | # link to a description diff |
|
105 | 105 | assert_select 'a[href=?][title=?]', |
|
106 | 106 | 'http://mydomain.foo/rdm/journals/diff/3?detail_id=4', |
|
107 | 107 | 'View differences', |
|
108 | 108 | :text => 'diff' |
|
109 | 109 | # link to an attachment |
|
110 | 110 | assert_select 'a[href=?]', |
|
111 | 111 | 'http://mydomain.foo/rdm/attachments/download/4/source.rb', |
|
112 | 112 | :text => 'source.rb' |
|
113 | 113 | end |
|
114 | 114 | end |
|
115 | 115 | |
|
116 | 116 | def test_issue_edit_should_generate_url_with_hostname_for_relations |
|
117 | 117 | journal = Journal.new(:journalized => Issue.find(1), :user => User.find(1), :created_on => Time.now) |
|
118 | 118 | journal.details << JournalDetail.new(:property => 'relation', :prop_key => 'label_relates_to', :value => 2) |
|
119 | 119 | Mailer.deliver_issue_edit(journal) |
|
120 | 120 | assert_not_nil last_email |
|
121 | 121 | assert_select_email do |
|
122 | 122 | assert_select 'a[href=?]', 'http://mydomain.foo/issues/2', :text => 'Feature request #2' |
|
123 | 123 | end |
|
124 | 124 | end |
|
125 | 125 | |
|
126 | 126 | def test_generated_links_with_prefix_and_no_relative_url_root |
|
127 | 127 | Setting.default_language = 'en' |
|
128 | 128 | relative_url_root = Redmine::Utils.relative_url_root |
|
129 | 129 | Setting.host_name = 'mydomain.foo/rdm' |
|
130 | 130 | Setting.protocol = 'http' |
|
131 | 131 | Redmine::Utils.relative_url_root = nil |
|
132 | 132 | |
|
133 | 133 | journal = Journal.find(3) |
|
134 | 134 | assert Mailer.deliver_issue_edit(journal) |
|
135 | 135 | |
|
136 | 136 | mail = last_email |
|
137 | 137 | assert_not_nil mail |
|
138 | 138 | |
|
139 | 139 | assert_select_email do |
|
140 | 140 | # link to the main ticket |
|
141 | 141 | assert_select 'a[href=?]', |
|
142 | 142 | 'http://mydomain.foo/rdm/issues/2#change-3', |
|
143 | 143 | :text => 'Feature request #2: Add ingredients categories' |
|
144 | 144 | # link to a referenced ticket |
|
145 | 145 | assert_select 'a[href=?][title=?]', |
|
146 | 146 | 'http://mydomain.foo/rdm/issues/1', |
|
147 | 147 | "#{ESCAPED_UCANT} print recipes (New)", |
|
148 | 148 | :text => '#1' |
|
149 | 149 | # link to a changeset |
|
150 | 150 | assert_select 'a[href=?][title=?]', |
|
151 | 151 | 'http://mydomain.foo/rdm/projects/ecookbook/repository/revisions/2', |
|
152 | 152 | 'This commit fixes #1, #2 and references #1 & #3', |
|
153 | 153 | :text => 'r2' |
|
154 | 154 | # link to a description diff |
|
155 | 155 | assert_select 'a[href=?][title=?]', |
|
156 | 156 | 'http://mydomain.foo/rdm/journals/diff/3?detail_id=4', |
|
157 | 157 | 'View differences', |
|
158 | 158 | :text => 'diff' |
|
159 | 159 | # link to an attachment |
|
160 | 160 | assert_select 'a[href=?]', |
|
161 | 161 | 'http://mydomain.foo/rdm/attachments/download/4/source.rb', |
|
162 | 162 | :text => 'source.rb' |
|
163 | 163 | end |
|
164 | 164 | ensure |
|
165 | 165 | # restore it |
|
166 | 166 | Redmine::Utils.relative_url_root = relative_url_root |
|
167 | 167 | end |
|
168 | 168 | |
|
169 | 169 | def test_email_headers |
|
170 | 170 | issue = Issue.find(1) |
|
171 | 171 | Mailer.deliver_issue_add(issue) |
|
172 | 172 | mail = last_email |
|
173 | 173 | assert_not_nil mail |
|
174 | 174 | assert_equal 'OOF', mail.header['X-Auto-Response-Suppress'].to_s |
|
175 | 175 | assert_equal 'auto-generated', mail.header['Auto-Submitted'].to_s |
|
176 | 176 | assert_equal '<redmine.example.net>', mail.header['List-Id'].to_s |
|
177 | 177 | end |
|
178 | 178 | |
|
179 | 179 | def test_email_headers_should_include_sender |
|
180 | 180 | issue = Issue.find(1) |
|
181 | 181 | Mailer.deliver_issue_add(issue) |
|
182 | 182 | mail = last_email |
|
183 | 183 | assert_equal issue.author.login, mail.header['X-Redmine-Sender'].to_s |
|
184 | 184 | end |
|
185 | 185 | |
|
186 | 186 | def test_plain_text_mail |
|
187 | 187 | Setting.plain_text_mail = 1 |
|
188 | 188 | journal = Journal.find(2) |
|
189 | 189 | Mailer.deliver_issue_edit(journal) |
|
190 | 190 | mail = last_email |
|
191 | 191 | assert_equal "text/plain; charset=UTF-8", mail.content_type |
|
192 | 192 | assert_equal 0, mail.parts.size |
|
193 | 193 | assert !mail.encoded.include?('href') |
|
194 | 194 | end |
|
195 | 195 | |
|
196 | 196 | def test_html_mail |
|
197 | 197 | Setting.plain_text_mail = 0 |
|
198 | 198 | journal = Journal.find(2) |
|
199 | 199 | Mailer.deliver_issue_edit(journal) |
|
200 | 200 | mail = last_email |
|
201 | 201 | assert_equal 2, mail.parts.size |
|
202 | 202 | assert mail.encoded.include?('href') |
|
203 | 203 | end |
|
204 | 204 | |
|
205 | 205 | def test_from_header |
|
206 | 206 | with_settings :mail_from => 'redmine@example.net' do |
|
207 | 207 | Mailer.test_email(User.find(1)).deliver |
|
208 | 208 | end |
|
209 | 209 | mail = last_email |
|
210 | 210 | assert_equal 'redmine@example.net', mail.from_addrs.first |
|
211 | 211 | end |
|
212 | 212 | |
|
213 | 213 | def test_from_header_with_phrase |
|
214 | 214 | with_settings :mail_from => 'Redmine app <redmine@example.net>' do |
|
215 | 215 | Mailer.test_email(User.find(1)).deliver |
|
216 | 216 | end |
|
217 | 217 | mail = last_email |
|
218 | 218 | assert_equal 'redmine@example.net', mail.from_addrs.first |
|
219 | 219 | assert_equal 'Redmine app <redmine@example.net>', mail.header['From'].to_s |
|
220 | 220 | end |
|
221 | 221 | |
|
222 | 222 | def test_should_not_send_email_without_recipient |
|
223 | 223 | news = News.first |
|
224 | 224 | user = news.author |
|
225 | 225 | # Remove members except news author |
|
226 | 226 | news.project.memberships.each {|m| m.destroy unless m.user == user} |
|
227 | 227 | |
|
228 | 228 | user.pref.no_self_notified = false |
|
229 | 229 | user.pref.save |
|
230 | 230 | User.current = user |
|
231 | 231 | Mailer.news_added(news.reload).deliver |
|
232 | 232 | assert_equal 1, last_email.bcc.size |
|
233 | 233 | |
|
234 | 234 | # nobody to notify |
|
235 | 235 | user.pref.no_self_notified = true |
|
236 | 236 | user.pref.save |
|
237 | 237 | User.current = user |
|
238 | 238 | ActionMailer::Base.deliveries.clear |
|
239 | 239 | Mailer.news_added(news.reload).deliver |
|
240 | 240 | assert ActionMailer::Base.deliveries.empty? |
|
241 | 241 | end |
|
242 | 242 | |
|
243 | 243 | def test_issue_add_message_id |
|
244 | 244 | issue = Issue.find(2) |
|
245 | 245 | Mailer.deliver_issue_add(issue) |
|
246 | 246 | mail = last_email |
|
247 | 247 | assert_match /^redmine\.issue-2\.20060719190421\.[a-f0-9]+@example\.net/, mail.message_id |
|
248 | 248 | assert_include "redmine.issue-2.20060719190421@example.net", mail.references |
|
249 | 249 | end |
|
250 | 250 | |
|
251 | 251 | def test_issue_edit_message_id |
|
252 | 252 | journal = Journal.find(3) |
|
253 | 253 | journal.issue = Issue.find(2) |
|
254 | 254 | |
|
255 | 255 | Mailer.deliver_issue_edit(journal) |
|
256 | 256 | mail = last_email |
|
257 | 257 | assert_match /^redmine\.journal-3\.\d+\.[a-f0-9]+@example\.net/, mail.message_id |
|
258 | 258 | assert_include "redmine.issue-2.20060719190421@example.net", mail.references |
|
259 | 259 | assert_select_email do |
|
260 | 260 | # link to the update |
|
261 | 261 | assert_select "a[href=?]", |
|
262 | 262 | "http://mydomain.foo/issues/#{journal.journalized_id}#change-#{journal.id}" |
|
263 | 263 | end |
|
264 | 264 | end |
|
265 | 265 | |
|
266 | 266 | def test_message_posted_message_id |
|
267 | 267 | message = Message.find(1) |
|
268 | 268 | Mailer.message_posted(message).deliver |
|
269 | 269 | mail = last_email |
|
270 | 270 | assert_match /^redmine\.message-1\.\d+\.[a-f0-9]+@example\.net/, mail.message_id |
|
271 | 271 | assert_include "redmine.message-1.20070512151532@example.net", mail.references |
|
272 | 272 | assert_select_email do |
|
273 | 273 | # link to the message |
|
274 | 274 | assert_select "a[href=?]", |
|
275 | 275 | "http://mydomain.foo/boards/#{message.board.id}/topics/#{message.id}", |
|
276 | 276 | :text => message.subject |
|
277 | 277 | end |
|
278 | 278 | end |
|
279 | 279 | |
|
280 | 280 | def test_reply_posted_message_id |
|
281 | 281 | message = Message.find(3) |
|
282 | 282 | Mailer.message_posted(message).deliver |
|
283 | 283 | mail = last_email |
|
284 | 284 | assert_match /^redmine\.message-3\.\d+\.[a-f0-9]+@example\.net/, mail.message_id |
|
285 | 285 | assert_include "redmine.message-1.20070512151532@example.net", mail.references |
|
286 | 286 | assert_select_email do |
|
287 | 287 | # link to the reply |
|
288 | 288 | assert_select "a[href=?]", |
|
289 | 289 | "http://mydomain.foo/boards/#{message.board.id}/topics/#{message.root.id}?r=#{message.id}#message-#{message.id}", |
|
290 | 290 | :text => message.subject |
|
291 | 291 | end |
|
292 | 292 | end |
|
293 | 293 | |
|
294 | 294 | test "#issue_add should notify project members" do |
|
295 | 295 | issue = Issue.find(1) |
|
296 | 296 | assert Mailer.deliver_issue_add(issue) |
|
297 | 297 | assert last_email.bcc.include?('dlopper@somenet.foo') |
|
298 | 298 | end |
|
299 | 299 | |
|
300 | 300 | test "#issue_add should not notify project members that are not allow to view the issue" do |
|
301 | 301 | issue = Issue.find(1) |
|
302 | 302 | Role.find(2).remove_permission!(:view_issues) |
|
303 | 303 | assert Mailer.deliver_issue_add(issue) |
|
304 | 304 | assert !last_email.bcc.include?('dlopper@somenet.foo') |
|
305 | 305 | end |
|
306 | 306 | |
|
307 | 307 | test "#issue_add should notify issue watchers" do |
|
308 | 308 | issue = Issue.find(1) |
|
309 | 309 | user = User.find(9) |
|
310 | 310 | # minimal email notification options |
|
311 | 311 | user.pref.no_self_notified = '1' |
|
312 | 312 | user.pref.save |
|
313 | 313 | user.mail_notification = false |
|
314 | 314 | user.save |
|
315 | 315 | |
|
316 | 316 | Watcher.create!(:watchable => issue, :user => user) |
|
317 | 317 | assert Mailer.deliver_issue_add(issue) |
|
318 | 318 | assert last_email.bcc.include?(user.mail) |
|
319 | 319 | end |
|
320 | 320 | |
|
321 | 321 | test "#issue_add should not notify watchers not allowed to view the issue" do |
|
322 | 322 | issue = Issue.find(1) |
|
323 | 323 | user = User.find(9) |
|
324 | 324 | Watcher.create!(:watchable => issue, :user => user) |
|
325 | 325 | Role.non_member.remove_permission!(:view_issues) |
|
326 | 326 | assert Mailer.deliver_issue_add(issue) |
|
327 | 327 | assert !last_email.bcc.include?(user.mail) |
|
328 | 328 | end |
|
329 | 329 | |
|
330 | 330 | def test_issue_add_should_include_enabled_fields |
|
331 | 331 | Setting.default_language = 'en' |
|
332 | 332 | issue = Issue.find(2) |
|
333 | 333 | assert Mailer.deliver_issue_add(issue) |
|
334 | 334 | assert_mail_body_match '* Target version: 1.0', last_email |
|
335 | 335 | assert_select_email do |
|
336 | 336 | assert_select 'li', :text => 'Target version: 1.0' |
|
337 | 337 | end |
|
338 | 338 | end |
|
339 | 339 | |
|
340 | 340 | def test_issue_add_should_not_include_disabled_fields |
|
341 | 341 | Setting.default_language = 'en' |
|
342 | 342 | issue = Issue.find(2) |
|
343 | 343 | tracker = issue.tracker |
|
344 | 344 | tracker.core_fields -= ['fixed_version_id'] |
|
345 | 345 | tracker.save! |
|
346 | 346 | assert Mailer.deliver_issue_add(issue) |
|
347 | 347 | assert_mail_body_no_match 'Target version', last_email |
|
348 | 348 | assert_select_email do |
|
349 | 349 | assert_select 'li', :text => /Target version/, :count => 0 |
|
350 | 350 | end |
|
351 | 351 | end |
|
352 | 352 | |
|
353 | 353 | # test mailer methods for each language |
|
354 | 354 | def test_issue_add |
|
355 | 355 | issue = Issue.find(1) |
|
356 | 356 | valid_languages.each do |lang| |
|
357 | 357 | Setting.default_language = lang.to_s |
|
358 | 358 | assert Mailer.deliver_issue_add(issue) |
|
359 | 359 | end |
|
360 | 360 | end |
|
361 | 361 | |
|
362 | 362 | def test_issue_edit |
|
363 | 363 | journal = Journal.find(1) |
|
364 | 364 | valid_languages.each do |lang| |
|
365 | 365 | Setting.default_language = lang.to_s |
|
366 | 366 | assert Mailer.deliver_issue_edit(journal) |
|
367 | 367 | end |
|
368 | 368 | end |
|
369 | 369 | |
|
370 | 370 | def test_issue_edit_should_send_private_notes_to_users_with_permission_only |
|
371 | 371 | journal = Journal.find(1) |
|
372 | 372 | journal.private_notes = true |
|
373 | 373 | journal.save! |
|
374 | 374 | |
|
375 | 375 | Role.find(2).add_permission! :view_private_notes |
|
376 | 376 | Mailer.deliver_issue_edit(journal) |
|
377 | 377 | assert_equal %w(dlopper@somenet.foo jsmith@somenet.foo), ActionMailer::Base.deliveries.last.bcc.sort |
|
378 | 378 | |
|
379 | 379 | Role.find(2).remove_permission! :view_private_notes |
|
380 | 380 | Mailer.deliver_issue_edit(journal) |
|
381 | 381 | assert_equal %w(jsmith@somenet.foo), ActionMailer::Base.deliveries.last.bcc.sort |
|
382 | 382 | end |
|
383 | 383 | |
|
384 | 384 | def test_issue_edit_should_send_private_notes_to_watchers_with_permission_only |
|
385 | 385 | Issue.find(1).set_watcher(User.find_by_login('someone')) |
|
386 | 386 | journal = Journal.find(1) |
|
387 | 387 | journal.private_notes = true |
|
388 | 388 | journal.save! |
|
389 | 389 | |
|
390 | 390 | Role.non_member.add_permission! :view_private_notes |
|
391 | 391 | Mailer.deliver_issue_edit(journal) |
|
392 | 392 | assert_include 'someone@foo.bar', ActionMailer::Base.deliveries.last.bcc.sort |
|
393 | 393 | |
|
394 | 394 | Role.non_member.remove_permission! :view_private_notes |
|
395 | 395 | Mailer.deliver_issue_edit(journal) |
|
396 | 396 | assert_not_include 'someone@foo.bar', ActionMailer::Base.deliveries.last.bcc.sort |
|
397 | 397 | end |
|
398 | 398 | |
|
399 | 399 | def test_issue_edit_should_mark_private_notes |
|
400 | 400 | journal = Journal.find(2) |
|
401 | 401 | journal.private_notes = true |
|
402 | 402 | journal.save! |
|
403 | 403 | |
|
404 | 404 | with_settings :default_language => 'en' do |
|
405 | 405 | Mailer.deliver_issue_edit(journal) |
|
406 | 406 | end |
|
407 | 407 | assert_mail_body_match '(Private notes)', last_email |
|
408 | 408 | end |
|
409 | 409 | |
|
410 | 410 | def test_issue_edit_with_relation_should_notify_users_who_can_see_the_related_issue |
|
411 | 411 | issue = Issue.generate! |
|
412 | 412 | private_issue = Issue.generate!(:is_private => true) |
|
413 | 413 | IssueRelation.create!(:issue_from => issue, :issue_to => private_issue, :relation_type => 'relates') |
|
414 | 414 | issue.reload |
|
415 | 415 | assert_equal 1, issue.journals.size |
|
416 | 416 | journal = issue.journals.first |
|
417 | 417 | ActionMailer::Base.deliveries.clear |
|
418 | 418 | |
|
419 | 419 | Mailer.deliver_issue_edit(journal) |
|
420 | 420 | last_email.bcc.each do |email| |
|
421 | 421 | user = User.find_by_mail(email) |
|
422 | 422 | assert private_issue.visible?(user), "Issue was not visible to #{user}" |
|
423 | 423 | end |
|
424 | 424 | end |
|
425 | 425 | |
|
426 | 426 | def test_document_added |
|
427 | 427 | document = Document.find(1) |
|
428 | 428 | valid_languages.each do |lang| |
|
429 | 429 | Setting.default_language = lang.to_s |
|
430 | 430 | assert Mailer.document_added(document).deliver |
|
431 | 431 | end |
|
432 | 432 | end |
|
433 | 433 | |
|
434 | 434 | def test_attachments_added |
|
435 | 435 | attachements = [ Attachment.find_by_container_type('Document') ] |
|
436 | 436 | valid_languages.each do |lang| |
|
437 | 437 | Setting.default_language = lang.to_s |
|
438 | 438 | assert Mailer.attachments_added(attachements).deliver |
|
439 | 439 | end |
|
440 | 440 | end |
|
441 | 441 | |
|
442 | 442 | def test_version_file_added |
|
443 | 443 | attachements = [ Attachment.find_by_container_type('Version') ] |
|
444 | 444 | assert Mailer.attachments_added(attachements).deliver |
|
445 | 445 | assert_not_nil last_email.bcc |
|
446 | 446 | assert last_email.bcc.any? |
|
447 | 447 | assert_select_email do |
|
448 | 448 | assert_select "a[href=?]", "http://mydomain.foo/projects/ecookbook/files" |
|
449 | 449 | end |
|
450 | 450 | end |
|
451 | 451 | |
|
452 | 452 | def test_project_file_added |
|
453 | 453 | attachements = [ Attachment.find_by_container_type('Project') ] |
|
454 | 454 | assert Mailer.attachments_added(attachements).deliver |
|
455 | 455 | assert_not_nil last_email.bcc |
|
456 | 456 | assert last_email.bcc.any? |
|
457 | 457 | assert_select_email do |
|
458 | 458 | assert_select "a[href=?]", "http://mydomain.foo/projects/ecookbook/files" |
|
459 | 459 | end |
|
460 | 460 | end |
|
461 | 461 | |
|
462 | 462 | def test_news_added |
|
463 | 463 | news = News.first |
|
464 | 464 | valid_languages.each do |lang| |
|
465 | 465 | Setting.default_language = lang.to_s |
|
466 | 466 | assert Mailer.news_added(news).deliver |
|
467 | 467 | end |
|
468 | 468 | end |
|
469 | 469 | |
|
470 | 470 | def test_news_added_should_notify_project_news_watchers |
|
471 | 471 | user1 = User.generate! |
|
472 | 472 | user2 = User.generate! |
|
473 | 473 | news = News.find(1) |
|
474 | 474 | news.project.enabled_module('news').add_watcher(user1) |
|
475 | 475 | |
|
476 | 476 | Mailer.news_added(news).deliver |
|
477 | 477 | assert_include user1.mail, last_email.bcc |
|
478 | 478 | assert_not_include user2.mail, last_email.bcc |
|
479 | 479 | end |
|
480 | 480 | |
|
481 | 481 | def test_news_comment_added |
|
482 | 482 | comment = Comment.find(2) |
|
483 | 483 | valid_languages.each do |lang| |
|
484 | 484 | Setting.default_language = lang.to_s |
|
485 | 485 | assert Mailer.news_comment_added(comment).deliver |
|
486 | 486 | end |
|
487 | 487 | end |
|
488 | 488 | |
|
489 | 489 | def test_message_posted |
|
490 | 490 | message = Message.first |
|
491 | 491 | recipients = ([message.root] + message.root.children).collect {|m| m.author.mail if m.author} |
|
492 | 492 | recipients = recipients.compact.uniq |
|
493 | 493 | valid_languages.each do |lang| |
|
494 | 494 | Setting.default_language = lang.to_s |
|
495 | 495 | assert Mailer.message_posted(message).deliver |
|
496 | 496 | end |
|
497 | 497 | end |
|
498 | 498 | |
|
499 | 499 | def test_wiki_content_added |
|
500 | 500 | content = WikiContent.find(1) |
|
501 | 501 | valid_languages.each do |lang| |
|
502 | 502 | Setting.default_language = lang.to_s |
|
503 | 503 | assert_difference 'ActionMailer::Base.deliveries.size' do |
|
504 | 504 | assert Mailer.wiki_content_added(content).deliver |
|
505 | 505 | assert_select_email do |
|
506 | 506 | assert_select 'a[href=?]', |
|
507 | 507 | 'http://mydomain.foo/projects/ecookbook/wiki/CookBook_documentation', |
|
508 | 508 | :text => 'CookBook documentation' |
|
509 | 509 | end |
|
510 | 510 | end |
|
511 | 511 | end |
|
512 | 512 | end |
|
513 | 513 | |
|
514 | 514 | def test_wiki_content_updated |
|
515 | 515 | content = WikiContent.find(1) |
|
516 | 516 | valid_languages.each do |lang| |
|
517 | 517 | Setting.default_language = lang.to_s |
|
518 | 518 | assert_difference 'ActionMailer::Base.deliveries.size' do |
|
519 | 519 | assert Mailer.wiki_content_updated(content).deliver |
|
520 | 520 | assert_select_email do |
|
521 | 521 | assert_select 'a[href=?]', |
|
522 | 522 | 'http://mydomain.foo/projects/ecookbook/wiki/CookBook_documentation', |
|
523 | 523 | :text => 'CookBook documentation' |
|
524 | 524 | end |
|
525 | 525 | end |
|
526 | 526 | end |
|
527 | 527 | end |
|
528 | 528 | |
|
529 | 529 | def test_account_information |
|
530 | 530 | user = User.find(2) |
|
531 | 531 | valid_languages.each do |lang| |
|
532 | 532 | user.update_attribute :language, lang.to_s |
|
533 | 533 | user.reload |
|
534 | 534 | assert Mailer.account_information(user, 'pAsswORd').deliver |
|
535 | 535 | end |
|
536 | 536 | end |
|
537 | 537 | |
|
538 | 538 | def test_lost_password |
|
539 | 539 | token = Token.find(2) |
|
540 | 540 | valid_languages.each do |lang| |
|
541 | 541 | token.user.update_attribute :language, lang.to_s |
|
542 | 542 | token.reload |
|
543 | 543 | assert Mailer.lost_password(token).deliver |
|
544 | 544 | end |
|
545 | 545 | end |
|
546 | 546 | |
|
547 | 547 | def test_register |
|
548 | 548 | token = Token.find(1) |
|
549 | 549 | Setting.host_name = 'redmine.foo' |
|
550 | 550 | Setting.protocol = 'https' |
|
551 | 551 | |
|
552 | 552 | valid_languages.each do |lang| |
|
553 | 553 | token.user.update_attribute :language, lang.to_s |
|
554 | 554 | token.reload |
|
555 | 555 | ActionMailer::Base.deliveries.clear |
|
556 | 556 | assert Mailer.register(token).deliver |
|
557 | 557 | mail = last_email |
|
558 | 558 | assert_select_email do |
|
559 | 559 | assert_select "a[href=?]", |
|
560 | 560 | "https://redmine.foo/account/activate?token=#{token.value}", |
|
561 | 561 | :text => "https://redmine.foo/account/activate?token=#{token.value}" |
|
562 | 562 | end |
|
563 | 563 | end |
|
564 | 564 | end |
|
565 | 565 | |
|
566 | 566 | def test_test |
|
567 | 567 | user = User.find(1) |
|
568 | 568 | valid_languages.each do |lang| |
|
569 | 569 | user.update_attribute :language, lang.to_s |
|
570 | 570 | assert Mailer.test_email(user).deliver |
|
571 | 571 | end |
|
572 | 572 | end |
|
573 | 573 | |
|
574 | 574 | def test_reminders |
|
575 | 575 | Mailer.reminders(:days => 42) |
|
576 | 576 | assert_equal 1, ActionMailer::Base.deliveries.size |
|
577 | 577 | mail = last_email |
|
578 | 578 | assert mail.bcc.include?('dlopper@somenet.foo') |
|
579 | 579 | assert_mail_body_match 'Bug #3: Error 281 when updating a recipe', mail |
|
580 | 580 | assert_equal '1 issue(s) due in the next 42 days', mail.subject |
|
581 | 581 | end |
|
582 | 582 | |
|
583 | 583 | def test_reminders_should_not_include_closed_issues |
|
584 | 584 | with_settings :default_language => 'en' do |
|
585 | 585 | Issue.create!(:project_id => 1, :tracker_id => 1, :status_id => 5, |
|
586 | 586 | :subject => 'Closed issue', :assigned_to_id => 3, |
|
587 | 587 | :due_date => 5.days.from_now, |
|
588 | 588 | :author_id => 2) |
|
589 | 589 | ActionMailer::Base.deliveries.clear |
|
590 | 590 | |
|
591 | 591 | Mailer.reminders(:days => 42) |
|
592 | 592 | assert_equal 1, ActionMailer::Base.deliveries.size |
|
593 | 593 | mail = last_email |
|
594 | 594 | assert mail.bcc.include?('dlopper@somenet.foo') |
|
595 | 595 | assert_mail_body_no_match 'Closed issue', mail |
|
596 | 596 | end |
|
597 | 597 | end |
|
598 | 598 | |
|
599 | 599 | def test_reminders_for_users |
|
600 | 600 | Mailer.reminders(:days => 42, :users => ['5']) |
|
601 | 601 | assert_equal 0, ActionMailer::Base.deliveries.size # No mail for dlopper |
|
602 | 602 | Mailer.reminders(:days => 42, :users => ['3']) |
|
603 | 603 | assert_equal 1, ActionMailer::Base.deliveries.size # No mail for dlopper |
|
604 | 604 | mail = last_email |
|
605 | 605 | assert mail.bcc.include?('dlopper@somenet.foo') |
|
606 | 606 | assert_mail_body_match 'Bug #3: Error 281 when updating a recipe', mail |
|
607 | 607 | end |
|
608 | 608 | |
|
609 | 609 | def test_reminder_should_include_issues_assigned_to_groups |
|
610 | 610 | with_settings :default_language => 'en' do |
|
611 | 611 | group = Group.generate! |
|
612 | 612 | group.users << User.find(2) |
|
613 | 613 | group.users << User.find(3) |
|
614 | 614 | |
|
615 | 615 | Issue.create!(:project_id => 1, :tracker_id => 1, :status_id => 1, |
|
616 | 616 | :subject => 'Assigned to group', :assigned_to => group, |
|
617 | 617 | :due_date => 5.days.from_now, |
|
618 | 618 | :author_id => 2) |
|
619 | 619 | ActionMailer::Base.deliveries.clear |
|
620 | 620 | |
|
621 | 621 | Mailer.reminders(:days => 7) |
|
622 | 622 | assert_equal 2, ActionMailer::Base.deliveries.size |
|
623 | 623 | assert_equal %w(dlopper@somenet.foo jsmith@somenet.foo), ActionMailer::Base.deliveries.map(&:bcc).flatten.sort |
|
624 | 624 | ActionMailer::Base.deliveries.each do |mail| |
|
625 | 625 | assert_mail_body_match 'Assigned to group', mail |
|
626 | 626 | end |
|
627 | 627 | end |
|
628 | 628 | end |
|
629 | 629 | |
|
630 | 630 | def test_mailer_should_not_change_locale |
|
631 | 631 | Setting.default_language = 'en' |
|
632 | 632 | # Set current language to italian |
|
633 | 633 | set_language_if_valid 'it' |
|
634 | 634 | # Send an email to a french user |
|
635 | 635 | user = User.find(1) |
|
636 | 636 | user.language = 'fr' |
|
637 | 637 | Mailer.account_activated(user).deliver |
|
638 | 638 | mail = last_email |
|
639 | 639 | assert_mail_body_match 'Votre compte', mail |
|
640 | 640 | |
|
641 | 641 | assert_equal :it, current_language |
|
642 | 642 | end |
|
643 | 643 | |
|
644 | 644 | def test_with_deliveries_off |
|
645 | 645 | Mailer.with_deliveries false do |
|
646 | 646 | Mailer.test_email(User.find(1)).deliver |
|
647 | 647 | end |
|
648 | 648 | assert ActionMailer::Base.deliveries.empty? |
|
649 | 649 | # should restore perform_deliveries |
|
650 | 650 | assert ActionMailer::Base.perform_deliveries |
|
651 | 651 | end |
|
652 | 652 | |
|
653 | def test_token_for_should_strip_trailing_gt_from_address_with_full_name | |
|
654 | with_settings :mail_from => "Redmine Mailer<no-reply@redmine.org>" do | |
|
655 | assert_match /\Aredmine.issue-\d+\.\d+\.[0-9a-f]+@redmine.org\z/, Mailer.token_for(Issue.generate!) | |
|
656 | end | |
|
657 | end | |
|
658 | ||
|
653 | 659 | def test_layout_should_include_the_emails_header |
|
654 | 660 | with_settings :emails_header => "*Header content*" do |
|
655 | 661 | with_settings :plain_text_mail => 0 do |
|
656 | 662 | assert Mailer.test_email(User.find(1)).deliver |
|
657 | 663 | assert_select_email do |
|
658 | 664 | assert_select ".header" do |
|
659 | 665 | assert_select "strong", :text => "Header content" |
|
660 | 666 | end |
|
661 | 667 | end |
|
662 | 668 | end |
|
663 | 669 | with_settings :plain_text_mail => 1 do |
|
664 | 670 | assert Mailer.test_email(User.find(1)).deliver |
|
665 | 671 | mail = last_email |
|
666 | 672 | assert_not_nil mail |
|
667 | 673 | assert_include "*Header content*", mail.body.decoded |
|
668 | 674 | end |
|
669 | 675 | end |
|
670 | 676 | end |
|
671 | 677 | |
|
672 | 678 | def test_layout_should_not_include_empty_emails_header |
|
673 | 679 | with_settings :emails_header => "", :plain_text_mail => 0 do |
|
674 | 680 | assert Mailer.test_email(User.find(1)).deliver |
|
675 | 681 | assert_select_email do |
|
676 | 682 | assert_select ".header", false |
|
677 | 683 | end |
|
678 | 684 | end |
|
679 | 685 | end |
|
680 | 686 | |
|
681 | 687 | def test_layout_should_include_the_emails_footer |
|
682 | 688 | with_settings :emails_footer => "*Footer content*" do |
|
683 | 689 | with_settings :plain_text_mail => 0 do |
|
684 | 690 | assert Mailer.test_email(User.find(1)).deliver |
|
685 | 691 | assert_select_email do |
|
686 | 692 | assert_select ".footer" do |
|
687 | 693 | assert_select "strong", :text => "Footer content" |
|
688 | 694 | end |
|
689 | 695 | end |
|
690 | 696 | end |
|
691 | 697 | with_settings :plain_text_mail => 1 do |
|
692 | 698 | assert Mailer.test_email(User.find(1)).deliver |
|
693 | 699 | mail = last_email |
|
694 | 700 | assert_not_nil mail |
|
695 | 701 | assert_include "\n-- \n", mail.body.decoded |
|
696 | 702 | assert_include "*Footer content*", mail.body.decoded |
|
697 | 703 | end |
|
698 | 704 | end |
|
699 | 705 | end |
|
700 | 706 | |
|
701 | 707 | def test_layout_should_not_include_empty_emails_footer |
|
702 | 708 | with_settings :emails_footer => "" do |
|
703 | 709 | with_settings :plain_text_mail => 0 do |
|
704 | 710 | assert Mailer.test_email(User.find(1)).deliver |
|
705 | 711 | assert_select_email do |
|
706 | 712 | assert_select ".footer", false |
|
707 | 713 | end |
|
708 | 714 | end |
|
709 | 715 | with_settings :plain_text_mail => 1 do |
|
710 | 716 | assert Mailer.test_email(User.find(1)).deliver |
|
711 | 717 | mail = last_email |
|
712 | 718 | assert_not_nil mail |
|
713 | 719 | assert_not_include "\n-- \n", mail.body.decoded |
|
714 | 720 | end |
|
715 | 721 | end |
|
716 | 722 | end |
|
717 | 723 | |
|
718 | 724 | def test_should_escape_html_templates_only |
|
719 | 725 | Issue.generate!(:project_id => 1, :tracker_id => 1, :subject => 'Subject with a <tag>') |
|
720 | 726 | mail = last_email |
|
721 | 727 | assert_equal 2, mail.parts.size |
|
722 | 728 | assert_include '<tag>', text_part.body.encoded |
|
723 | 729 | assert_include '<tag>', html_part.body.encoded |
|
724 | 730 | end |
|
725 | 731 | |
|
726 | 732 | def test_should_raise_delivery_errors_when_raise_delivery_errors_is_true |
|
727 | 733 | mail = Mailer.test_email(User.find(1)) |
|
728 | 734 | mail.delivery_method.stubs(:deliver!).raises(Exception.new("delivery error")) |
|
729 | 735 | |
|
730 | 736 | ActionMailer::Base.raise_delivery_errors = true |
|
731 | 737 | assert_raise Exception, "delivery error" do |
|
732 | 738 | mail.deliver |
|
733 | 739 | end |
|
734 | 740 | ensure |
|
735 | 741 | ActionMailer::Base.raise_delivery_errors = false |
|
736 | 742 | end |
|
737 | 743 | |
|
738 | 744 | def test_should_log_delivery_errors_when_raise_delivery_errors_is_false |
|
739 | 745 | mail = Mailer.test_email(User.find(1)) |
|
740 | 746 | mail.delivery_method.stubs(:deliver!).raises(Exception.new("delivery error")) |
|
741 | 747 | |
|
742 | 748 | Rails.logger.expects(:error).with("Email delivery error: delivery error") |
|
743 | 749 | ActionMailer::Base.raise_delivery_errors = false |
|
744 | 750 | assert_nothing_raised do |
|
745 | 751 | mail.deliver |
|
746 | 752 | end |
|
747 | 753 | end |
|
748 | 754 | |
|
749 | 755 | def test_mail_should_return_a_mail_message |
|
750 | 756 | assert_kind_of ::Mail::Message, Mailer.test_email(User.find(1)) |
|
751 | 757 | end |
|
752 | 758 | |
|
753 | 759 | private |
|
754 | 760 | |
|
755 | 761 | def last_email |
|
756 | 762 | mail = ActionMailer::Base.deliveries.last |
|
757 | 763 | assert_not_nil mail |
|
758 | 764 | |
|
759 | 765 | end |
|
760 | 766 | |
|
761 | 767 | def text_part |
|
762 | 768 | last_email.parts.detect {|part| part.content_type.include?('text/plain')} |
|
763 | 769 | end |
|
764 | 770 | |
|
765 | 771 | def html_part |
|
766 | 772 | last_email.parts.detect {|part| part.content_type.include?('text/html')} |
|
767 | 773 | end |
|
768 | 774 | end |
General Comments 0
You need to be logged in to leave comments.
Login now