mailer.rb
474 lines
| 18.8 KiB
| text/x-ruby
|
RubyLexer
|
r4883 | # Redmine - project management software | ||
|
r9453 | # Copyright (C) 2006-2012 Jean-Philippe Lang | ||
|
r330 | # | ||
# This program is free software; you can redistribute it and/or | ||||
# modify it under the terms of the GNU General Public License | ||||
# as published by the Free Software Foundation; either version 2 | ||||
# of the License, or (at your option) any later version. | ||||
|
r1987 | # | ||
|
r330 | # This program is distributed in the hope that it will be useful, | ||
# but WITHOUT ANY WARRANTY; without even the implied warranty of | ||||
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||||
# GNU General Public License for more details. | ||||
|
r1987 | # | ||
|
r330 | # You should have received a copy of the GNU General Public License | ||
# along with this program; if not, write to the Free Software | ||||
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. | ||||
class Mailer < ActionMailer::Base | ||||
|
r2773 | layout 'mailer' | ||
|
r1153 | helper :application | ||
helper :issues | ||||
helper :custom_fields | ||||
|
r1987 | |||
|
r2430 | include Redmine::I18n | ||
|
r1987 | |||
|
r2458 | def self.default_url_options | ||
|
r9346 | { :host => Setting.host_name, :protocol => Setting.protocol } | ||
|
r2458 | end | ||
|
r5696 | |||
|
r9480 | # Builds a Mail::Message object used to email recipients of the added issue. | ||
|
r2536 | # | ||
# Example: | ||||
|
r9480 | # issue_add(issue) => Mail::Message object | ||
# Mailer.issue_add(issue).deliver => sends an email to issue recipients | ||||
|
r1987 | def issue_add(issue) | ||
|
r1250 | redmine_headers 'Project' => issue.project.identifier, | ||
'Issue-Id' => issue.id, | ||||
'Issue-Author' => issue.author.login | ||||
redmine_headers 'Issue-Assignee' => issue.assigned_to.login if issue.assigned_to | ||||
|
r2279 | message_id issue | ||
|
r8665 | @author = issue.author | ||
|
r9346 | @issue = issue | ||
@issue_url = url_for(:controller => 'issues', :action => 'show', :id => issue) | ||||
recipients = issue.recipients | ||||
cc = issue.watcher_recipients - recipients | ||||
mail :to => recipients, | ||||
:cc => cc, | ||||
:subject => "[#{issue.project.name} - #{issue.tracker.name} ##{issue.id}] (#{issue.status.name}) #{issue.subject}" | ||||
|
r330 | end | ||
|
r9480 | # Builds a Mail::Message object used to email recipients of the edited issue. | ||
|
r2536 | # | ||
# Example: | ||||
|
r9480 | # issue_edit(journal) => Mail::Message object | ||
# Mailer.issue_edit(journal).deliver => sends an email to issue recipients | ||||
|
r330 | def issue_edit(journal) | ||
|
r2581 | issue = journal.journalized.reload | ||
|
r1250 | redmine_headers 'Project' => issue.project.identifier, | ||
'Issue-Id' => issue.id, | ||||
'Issue-Author' => issue.author.login | ||||
redmine_headers 'Issue-Assignee' => issue.assigned_to.login if issue.assigned_to | ||||
|
r2279 | message_id journal | ||
references issue | ||||
|
r2223 | @author = journal.user | ||
|
r9346 | recipients = issue.recipients | ||
|
r450 | # Watchers in cc | ||
|
r9346 | cc = issue.watcher_recipients - recipients | ||
|
r1065 | s = "[#{issue.project.name} - #{issue.tracker.name} ##{issue.id}] " | ||
s << "(#{issue.status.name}) " if journal.new_value_for('status_id') | ||||
s << issue.subject | ||||
|
r9346 | @issue = issue | ||
@journal = journal | ||||
@issue_url = url_for(:controller => 'issues', :action => 'show', :id => issue, :anchor => "change-#{journal.id}") | ||||
mail :to => recipients, | ||||
:cc => cc, | ||||
:subject => s | ||||
|
r330 | end | ||
|
r1987 | |||
|
r1445 | def reminder(user, issues, days) | ||
set_language_if_valid user.language | ||||
|
r9346 | @issues = issues | ||
@days = days | ||||
@issues_url = url_for(:controller => 'issues', :action => 'index', | ||||
|
r7347 | :set_filter => 1, :assigned_to_id => user.id, | ||
:sort => 'due_date:asc') | ||||
|
r9346 | mail :to => user.mail, | ||
:subject => l(:mail_subject_reminder, :count => issues.size, :days => days) | ||||
|
r1445 | end | ||
|
r1987 | |||
|
r9480 | # Builds a Mail::Message object used to email users belonging to the added document's project. | ||
|
r2536 | # | ||
# Example: | ||||
|
r9480 | # document_added(document) => Mail::Message object | ||
# Mailer.document_added(document).deliver => sends an email to the document's project recipients | ||||
|
r823 | def document_added(document) | ||
|
r1250 | redmine_headers 'Project' => document.project.identifier | ||
|
r9117 | @author = User.current | ||
|
r9346 | @document = document | ||
@document_url = url_for(:controller => 'documents', :action => 'show', :id => document) | ||||
mail :to => document.recipients, | ||||
:subject => "[#{document.project.name}] #{l(:label_document_new)}: #{document.title}" | ||||
|
r330 | end | ||
|
r1987 | |||
|
r9480 | # Builds a Mail::Message object used to email recipients of a project when an attachements are added. | ||
|
r2536 | # | ||
# Example: | ||||
|
r9480 | # attachments_added(attachments) => Mail::Message object | ||
# Mailer.attachments_added(attachments).deliver => sends an email to the project's recipients | ||||
|
r823 | def attachments_added(attachments) | ||
|
r330 | container = attachments.first.container | ||
|
r658 | added_to = '' | ||
|
r864 | added_to_url = '' | ||
|
r9117 | @author = attachments.first.author | ||
|
r658 | case container.class.name | ||
|
r2115 | when 'Project' | ||
|
r5110 | added_to_url = url_for(:controller => 'files', :action => 'index', :project_id => container) | ||
|
r2115 | added_to = "#{l(:label_project)}: #{container}" | ||
|
r9346 | recipients = container.project.notified_users.select {|user| user.allowed_to?(:view_files, container.project)}.collect {|u| u.mail} | ||
|
r330 | when 'Version' | ||
|
r5110 | added_to_url = url_for(:controller => 'files', :action => 'index', :project_id => container.project) | ||
|
r330 | added_to = "#{l(:label_version)}: #{container.name}" | ||
|
r9346 | recipients = container.project.notified_users.select {|user| user.allowed_to?(:view_files, container.project)}.collect {|u| u.mail} | ||
|
r330 | when 'Document' | ||
|
r864 | added_to_url = url_for(:controller => 'documents', :action => 'show', :id => container.id) | ||
|
r330 | added_to = "#{l(:label_document)}: #{container.title}" | ||
|
r9346 | recipients = container.recipients | ||
|
r330 | end | ||
|
r1250 | redmine_headers 'Project' => container.project.identifier | ||
|
r9346 | @attachments = attachments | ||
@added_to = added_to | ||||
@added_to_url = added_to_url | ||||
mail :to => recipients, | ||||
:subject => "[#{container.project.name}] #{l(:label_attachment_new)}" | ||||
|
r330 | end | ||
|
r5696 | |||
|
r9480 | # Builds a Mail::Message object used to email recipients of a news' project when a news item is added. | ||
|
r2536 | # | ||
# Example: | ||||
|
r9480 | # news_added(news) => Mail::Message object | ||
# Mailer.news_added(news).deliver => sends an email to the news' project recipients | ||||
|
r717 | def news_added(news) | ||
|
r1250 | redmine_headers 'Project' => news.project.identifier | ||
|
r9117 | @author = news.author | ||
|
r2279 | message_id news | ||
|
r9346 | @news = news | ||
@news_url = url_for(:controller => 'news', :action => 'show', :id => news) | ||||
mail :to => news.recipients, | ||||
:subject => "[#{news.project.name}] #{l(:label_news)}: #{news.title}" | ||||
|
r717 | end | ||
|
r5696 | |||
|
r9480 | # Builds a Mail::Message object used to email recipients of a news' project when a news comment is added. | ||
|
r4883 | # | ||
# Example: | ||||
|
r9480 | # news_comment_added(comment) => Mail::Message object | ||
|
r4883 | # Mailer.news_comment_added(comment) => sends an email to the news' project recipients | ||
def news_comment_added(comment) | ||||
news = comment.commented | ||||
redmine_headers 'Project' => news.project.identifier | ||||
|
r9117 | @author = comment.author | ||
|
r4883 | message_id comment | ||
|
r9346 | @news = news | ||
@comment = comment | ||||
@news_url = url_for(:controller => 'news', :action => 'show', :id => news) | ||||
mail :to => news.recipients, | ||||
:cc => news.watcher_recipients, | ||||
:subject => "Re: [#{news.project.name}] #{l(:label_news)}: #{news.title}" | ||||
|
r4883 | end | ||
|
r864 | |||
|
r9480 | # Builds a Mail::Message object used to email the recipients of the specified message that was posted. | ||
|
r2536 | # | ||
# Example: | ||||
|
r9480 | # message_posted(message) => Mail::Message object | ||
# Mailer.message_posted(message).deliver => sends an email to the recipients | ||||
|
r3055 | def message_posted(message) | ||
|
r1250 | redmine_headers 'Project' => message.project.identifier, | ||
'Topic-Id' => (message.parent_id || message.id) | ||||
|
r9117 | @author = message.author | ||
|
r2279 | message_id message | ||
references message.parent unless message.parent.nil? | ||||
|
r9346 | recipients = message.recipients | ||
cc = ((message.root.watcher_recipients + message.board.watcher_recipients).uniq - recipients) | ||||
@message = message | ||||
@message_url = url_for(message.event_url) | ||||
mail :to => recipients, | ||||
:cc => cc, | ||||
:subject => "[#{message.board.project.name} - #{message.board.name} - msg#{message.root.id}] #{message.subject}" | ||||
|
r864 | end | ||
|
r5696 | |||
|
r9480 | # Builds a Mail::Message object used to email the recipients of a project of the specified wiki content was added. | ||
|
r2650 | # | ||
# Example: | ||||
|
r9480 | # wiki_content_added(wiki_content) => Mail::Message object | ||
# Mailer.wiki_content_added(wiki_content).deliver => sends an email to the project's recipients | ||||
|
r2650 | def wiki_content_added(wiki_content) | ||
redmine_headers 'Project' => wiki_content.project.identifier, | ||||
'Wiki-Page-Id' => wiki_content.page.id | ||||
|
r9117 | @author = wiki_content.author | ||
|
r2650 | message_id wiki_content | ||
|
r9346 | recipients = wiki_content.recipients | ||
cc = wiki_content.page.wiki.watcher_recipients - recipients | ||||
@wiki_content = wiki_content | ||||
@wiki_content_url = url_for(:controller => 'wiki', :action => 'show', | ||||
|
r7343 | :project_id => wiki_content.project, | ||
:id => wiki_content.page.title) | ||||
|
r9346 | mail :to => recipients, | ||
:cc => cc, | ||||
:subject => "[#{wiki_content.project.name}] #{l(:mail_subject_wiki_content_added, :id => wiki_content.page.pretty_title)}" | ||||
|
r2650 | end | ||
|
r5696 | |||
|
r9480 | # Builds a Mail::Message object used to email the recipients of a project of the specified wiki content was updated. | ||
|
r2650 | # | ||
# Example: | ||||
|
r9480 | # wiki_content_updated(wiki_content) => Mail::Message object | ||
# Mailer.wiki_content_updated(wiki_content).deliver => sends an email to the project's recipients | ||||
|
r2650 | def wiki_content_updated(wiki_content) | ||
redmine_headers 'Project' => wiki_content.project.identifier, | ||||
'Wiki-Page-Id' => wiki_content.page.id | ||||
|
r9117 | @author = wiki_content.author | ||
|
r2650 | message_id wiki_content | ||
|
r9346 | recipients = wiki_content.recipients | ||
cc = wiki_content.page.wiki.watcher_recipients + wiki_content.page.watcher_recipients - recipients | ||||
@wiki_content = wiki_content | ||||
@wiki_content_url = url_for(:controller => 'wiki', :action => 'show', | ||||
|
r7344 | :project_id => wiki_content.project, | ||
|
r9346 | :id => wiki_content.page.title) | ||
@wiki_diff_url = url_for(:controller => 'wiki', :action => 'diff', | ||||
|
r7344 | :project_id => wiki_content.project, :id => wiki_content.page.title, | ||
:version => wiki_content.version) | ||||
|
r9346 | mail :to => recipients, | ||
:cc => cc, | ||||
:subject => "[#{wiki_content.project.name}] #{l(:mail_subject_wiki_content_updated, :id => wiki_content.page.pretty_title)}" | ||||
|
r2650 | end | ||
|
r1987 | |||
|
r9480 | # Builds a Mail::Message object used to email the specified user their account information. | ||
|
r2536 | # | ||
# Example: | ||||
|
r9480 | # account_information(user, password) => Mail::Message object | ||
# Mailer.account_information(user, password).deliver => sends account information to the user | ||||
|
r864 | def account_information(user, password) | ||
set_language_if_valid user.language | ||||
|
r9346 | @user = user | ||
@password = password | ||||
@login_url = url_for(:controller => 'account', :action => 'login') | ||||
mail :to => user.mail, | ||||
:subject => l(:mail_subject_register, Setting.app_title) | ||||
|
r864 | end | ||
|
r1987 | |||
|
r9480 | # Builds a Mail::Message object used to email all active administrators of an account activation request. | ||
|
r2536 | # | ||
# Example: | ||||
|
r9480 | # account_activation_request(user) => Mail::Message object | ||
# Mailer.account_activation_request(user).deliver => sends an email to all active administrators | ||||
|
r902 | def account_activation_request(user) | ||
# Send the email to all active administrators | ||||
|
r9346 | recipients = User.active.find(:all, :conditions => {:admin => true}).collect { |u| u.mail }.compact | ||
@user = user | ||||
@url = url_for(:controller => 'users', :action => 'index', | ||||
|
r7345 | :status => User::STATUS_REGISTERED, | ||
:sort_key => 'created_on', :sort_order => 'desc') | ||||
|
r9346 | mail :to => recipients, | ||
:subject => l(:mail_subject_account_activation_request, Setting.app_title) | ||||
|
r902 | end | ||
|
r864 | |||
|
r9480 | # Builds a Mail::Message object used to email the specified user that their account was activated by an administrator. | ||
|
r2536 | # | ||
# Example: | ||||
|
r9480 | # account_activated(user) => Mail::Message object | ||
# Mailer.account_activated(user).deliver => sends an email to the registered user | ||||
|
r2422 | def account_activated(user) | ||
set_language_if_valid user.language | ||||
|
r9346 | @user = user | ||
@login_url = url_for(:controller => 'account', :action => 'login') | ||||
mail :to => user.mail, | ||||
:subject => l(:mail_subject_register, Setting.app_title) | ||||
|
r2422 | end | ||
|
r330 | def lost_password(token) | ||
set_language_if_valid(token.user.language) | ||||
|
r9346 | @token = token | ||
@url = url_for(:controller => 'account', :action => 'lost_password', :token => token.value) | ||||
mail :to => token.user.mail, | ||||
:subject => l(:mail_subject_lost_password, Setting.app_title) | ||||
|
r1987 | end | ||
|
r330 | |||
def register(token) | ||||
set_language_if_valid(token.user.language) | ||||
|
r9346 | @token = token | ||
@url = url_for(:controller => 'account', :action => 'activate', :token => token.value) | ||||
mail :to => token.user.mail, | ||||
:subject => l(:mail_subject_register, Setting.app_title) | ||||
|
r528 | end | ||
|
r1987 | |||
|
r8960 | def test_email(user) | ||
|
r629 | set_language_if_valid(user.language) | ||
|
r9346 | @url = url_for(:controller => 'welcome') | ||
mail :to => user.mail, | ||||
:subject => 'Redmine test' | ||||
|
r864 | end | ||
|
r1160 | |||
# Overrides default deliver! method to prevent from sending an email | ||||
# with no recipient, cc or bcc | ||||
def deliver!(mail = @mail) | ||||
|
r3193 | set_language_if_valid @initial_language | ||
|
r1987 | return false if (recipients.nil? || recipients.empty?) && | ||
|
r1160 | (cc.nil? || cc.empty?) && | ||
(bcc.nil? || bcc.empty?) | ||||
|
r5696 | |||
|
r3242 | # Log errors when raise_delivery_errors is set to false, Rails does not | ||
raise_errors = self.class.raise_delivery_errors | ||||
self.class.raise_delivery_errors = true | ||||
begin | ||||
return super(mail) | ||||
rescue Exception => e | ||||
if raise_errors | ||||
raise e | ||||
elsif mylogger | ||||
|
r4632 | mylogger.error "The following error occured while sending email notification: \"#{e.message}\". Check your configuration in config/configuration.yml." | ||
|
r3242 | end | ||
ensure | ||||
self.class.raise_delivery_errors = raise_errors | ||||
end | ||||
|
r1160 | end | ||
|
r1987 | |||
|
r1445 | # Sends reminders to issue assignees | ||
# Available options: | ||||
# * :days => how many days in the future to remind about (defaults to 7) | ||||
# * :tracker => id of tracker for filtering issues (defaults to all trackers) | ||||
# * :project => id or identifier of project to process (defaults to all projects) | ||||
|
r10152 | # * :users => array of user/group ids who should be reminded | ||
|
r1445 | def self.reminders(options={}) | ||
days = options[:days] || 7 | ||||
project = options[:project] ? Project.find(options[:project]) : nil | ||||
tracker = options[:tracker] ? Tracker.find(options[:tracker]) : nil | ||||
|
r4053 | user_ids = options[:users] | ||
|
r1987 | |||
|
r8570 | scope = Issue.open.scoped(:conditions => ["#{Issue.table_name}.assigned_to_id IS NOT NULL" + | ||
|
r7967 | " AND #{Project.table_name}.status = #{Project::STATUS_ACTIVE}" + | ||
" AND #{Issue.table_name}.due_date <= ?", days.day.from_now.to_date] | ||||
) | ||||
scope = scope.scoped(:conditions => {:assigned_to_id => user_ids}) if user_ids.present? | ||||
scope = scope.scoped(:conditions => {:project_id => project.id}) if project | ||||
scope = scope.scoped(:conditions => {:tracker_id => tracker.id}) if tracker | ||||
|
r1987 | |||
|
r7967 | issues_by_assignee = scope.all(:include => [:status, :assigned_to, :project, :tracker]).group_by(&:assigned_to) | ||
|
r10152 | issues_by_assignee.keys.each do |assignee| | ||
if assignee.is_a?(Group) | ||||
assignee.users.each do |user| | ||||
issues_by_assignee[user] ||= [] | ||||
issues_by_assignee[user] += issues_by_assignee[assignee] | ||||
end | ||||
end | ||||
end | ||||
|
r1445 | issues_by_assignee.each do |assignee, issues| | ||
|
r9479 | reminder(assignee, issues, days).deliver if assignee.is_a?(User) && assignee.active? | ||
|
r1445 | end | ||
end | ||||
|
r5696 | |||
|
r3494 | # Activates/desactivates email deliveries during +block+ | ||
def self.with_deliveries(enabled = true, &block) | ||||
was_enabled = ActionMailer::Base.perform_deliveries | ||||
ActionMailer::Base.perform_deliveries = !!enabled | ||||
yield | ||||
ensure | ||||
ActionMailer::Base.perform_deliveries = was_enabled | ||||
end | ||||
|
r1160 | |||
|
r9233 | # Sends emails synchronously in the given block | ||
def self.with_synched_deliveries(&block) | ||||
saved_method = ActionMailer::Base.delivery_method | ||||
if m = saved_method.to_s.match(%r{^async_(.+)$}) | ||||
|
r9964 | synched_method = m[1] | ||
ActionMailer::Base.delivery_method = synched_method.to_sym | ||||
ActionMailer::Base.send "#{synched_method}_settings=", ActionMailer::Base.send("async_#{synched_method}_settings") | ||||
|
r9233 | end | ||
yield | ||||
ensure | ||||
ActionMailer::Base.delivery_method = saved_method | ||||
end | ||||
|
r9346 | def mail(headers={}) | ||
headers.merge! 'X-Mailer' => 'Redmine', | ||||
|
r1250 | 'X-Redmine-Host' => Setting.host_name, | ||
|
r2497 | 'X-Redmine-Site' => Setting.app_title, | ||
|
r7685 | 'X-Auto-Response-Suppress' => 'OOF', | ||
|
r9346 | 'Auto-Submitted' => 'auto-generated', | ||
|
r9504 | 'From' => Setting.mail_from, | ||
'List-Id' => "<#{Setting.mail_from.to_s.gsub('@', '.')}>" | ||||
|
r1987 | |||
|
r9117 | # Removes the author from the recipients and cc | ||
|
r931 | # if he doesn't want to receive notifications about what he does | ||
|
r9117 | if @author && @author.logged? && @author.pref[:no_self_notified] | ||
|
r9346 | headers[:to].delete(@author.mail) if headers[:to].is_a?(Array) | ||
headers[:cc].delete(@author.mail) if headers[:cc].is_a?(Array) | ||||
|
r931 | end | ||
|
r5696 | |||
|
r9117 | if @author && @author.logged? | ||
|
r8665 | redmine_headers 'Sender' => @author.login | ||
end | ||||
|
r931 | # Blind carbon copy recipients | ||
if Setting.bcc_recipients? | ||||
|
r9346 | headers[:bcc] = [headers[:to], headers[:cc]].flatten.uniq.reject(&:blank?) | ||
headers[:to] = nil | ||||
headers[:cc] = nil | ||||
end | ||||
if @message_id_object | ||||
headers[:message_id] = "<#{self.class.message_id_for(@message_id_object)}>" | ||||
end | ||||
if @references_objects | ||||
headers[:references] = @references_objects.collect {|o| "<#{self.class.message_id_for(o)}>"}.join(' ') | ||||
end | ||||
super headers do |format| | ||||
format.text | ||||
format.html unless Setting.plain_text_mail? | ||||
|
r1987 | end | ||
|
r9346 | |||
set_language_if_valid @initial_language | ||||
end | ||||
def initialize(*args) | ||||
@initial_language = current_language | ||||
set_language_if_valid Setting.default_language | ||||
super | ||||
end | ||||
def self.deliver_mail(mail) | ||||
return false if mail.to.blank? && mail.cc.blank? && mail.bcc.blank? | ||||
|
r886 | super | ||
end | ||||
|
r1987 | |||
|
r9346 | def self.method_missing(method, *args, &block) | ||
if m = method.to_s.match(%r{^deliver_(.+)$}) | ||||
|
r9456 | ActiveSupport::Deprecation.warn "Mailer.deliver_#{m[1]}(*args) is deprecated. Use Mailer.#{m[1]}(*args).deliver instead." | ||
|
r9346 | send(m[1], *args).deliver | ||
|
r2847 | else | ||
|
r9346 | super | ||
|
r2847 | end | ||
|
r1930 | end | ||
|
r1987 | |||
|
r9346 | private | ||
# Appends a Redmine header field (name is prepended with 'X-Redmine-') | ||||
def redmine_headers(h) | ||||
h.each { |k,v| headers["X-Redmine-#{k}"] = v.to_s } | ||||
end | ||||
|
r5696 | |||
|
r2279 | # Returns a predictable Message-Id for the given object | ||
def self.message_id_for(object) | ||||
# id + timestamp should reduce the odds of a collision | ||||
# as far as we don't send multiple emails for the same object | ||||
|
r5696 | timestamp = object.send(object.respond_to?(:created_on) ? :created_on : :updated_on) | ||
|
r2650 | hash = "redmine.#{object.class.name.demodulize.underscore}-#{object.id}.#{timestamp.strftime("%Y%m%d%H%M%S")}" | ||
|
r2279 | host = Setting.mail_from.to_s.gsub(%r{^.*@}, '') | ||
host = "#{::Socket.gethostname}.redmine" if host.empty? | ||||
|
r9346 | "#{hash}@#{host}" | ||
|
r2279 | end | ||
|
r5696 | |||
|
r2279 | def message_id(object) | ||
@message_id_object = object | ||||
end | ||||
|
r5696 | |||
|
r2279 | def references(object) | ||
@references_objects ||= [] | ||||
@references_objects << object | ||||
end | ||||
|
r5696 | |||
|
r3241 | def mylogger | ||
|
r7364 | Rails.logger | ||
|
r3241 | end | ||
|
r2279 | end | ||