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