mailer.rb
387 lines
| 15.9 KiB
| text/x-ruby
|
RubyLexer
|
r330 | # redMine - project management software | ||
# Copyright (C) 2006-2007 Jean-Philippe Lang | ||||
# | ||||
# 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 | ||||
|
r1153 | helper :application | ||
helper :issues | ||||
helper :custom_fields | ||||
|
r1987 | |||
|
r864 | include ActionController::UrlWriter | ||
|
r2430 | include Redmine::I18n | ||
|
r1987 | |||
|
r2458 | def self.default_url_options | ||
h = Setting.host_name | ||||
h = h.to_s.gsub(%r{\/.*$}, '') unless Redmine::Utils.relative_url_root.blank? | ||||
{ :host => h, :protocol => Setting.protocol } | ||||
end | ||||
|
r2536 | # Builds a tmail object used to email recipients of the added issue. | ||
# | ||||
# Example: | ||||
# issue_add(issue) => tmail object | ||||
# Mailer.deliver_issue_add(issue) => 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 | ||
|
r1987 | recipients issue.recipients | ||
|
r2162 | cc(issue.watcher_recipients - @recipients) | ||
|
r1065 | subject "[#{issue.project.name} - #{issue.tracker.name} ##{issue.id}] (#{issue.status.name}) #{issue.subject}" | ||
|
r864 | body :issue => issue, | ||
:issue_url => url_for(:controller => 'issues', :action => 'show', :id => issue) | ||||
|
r330 | end | ||
|
r2536 | # Builds a tmail object used to email recipients of the edited issue. | ||
# | ||||
# Example: | ||||
# issue_edit(journal) => tmail object | ||||
# Mailer.deliver_issue_edit(journal) => 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 | ||
|
r864 | recipients issue.recipients | ||
|
r450 | # Watchers in cc | ||
|
r864 | 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 | ||||
subject s | ||||
|
r864 | body :issue => issue, | ||
:journal => journal, | ||||
:issue_url => url_for(:controller => 'issues', :action => 'show', :id => issue) | ||||
|
r330 | end | ||
|
r1987 | |||
|
r1445 | def reminder(user, issues, days) | ||
set_language_if_valid user.language | ||||
recipients user.mail | ||||
subject l(:mail_subject_reminder, issues.size) | ||||
body :issues => issues, | ||||
:days => days, | ||||
|
r2169 | :issues_url => url_for(:controller => 'issues', :action => 'index', :set_filter => 1, :assigned_to_id => user.id, :sort_key => 'due_date', :sort_order => 'asc') | ||
|
r1445 | end | ||
|
r1987 | |||
|
r2536 | # Builds a tmail object used to email users belonging to the added document's project. | ||
# | ||||
# Example: | ||||
# document_added(document) => tmail object | ||||
# Mailer.deliver_document_added(document) => sends an email to the document's project recipients | ||||
|
r823 | def document_added(document) | ||
|
r1250 | redmine_headers 'Project' => document.project.identifier | ||
|
r864 | recipients document.project.recipients | ||
subject "[#{document.project.name}] #{l(:label_document_new)}: #{document.title}" | ||||
body :document => document, | ||||
:document_url => url_for(:controller => 'documents', :action => 'show', :id => document) | ||||
|
r330 | end | ||
|
r1987 | |||
|
r2536 | # Builds a tmail object used to email recipients of a project when an attachements are added. | ||
# | ||||
# Example: | ||||
# attachments_added(attachments) => tmail object | ||||
# Mailer.deliver_attachments_added(attachments) => 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 = '' | ||
|
r658 | case container.class.name | ||
|
r2115 | when 'Project' | ||
added_to_url = url_for(:controller => 'projects', :action => 'list_files', :id => container) | ||||
added_to = "#{l(:label_project)}: #{container}" | ||||
|
r330 | when 'Version' | ||
|
r864 | added_to_url = url_for(:controller => 'projects', :action => 'list_files', :id => container.project_id) | ||
|
r330 | added_to = "#{l(:label_version)}: #{container.name}" | ||
when 'Document' | ||||
|
r864 | added_to_url = url_for(:controller => 'documents', :action => 'show', :id => container.id) | ||
|
r330 | added_to = "#{l(:label_document)}: #{container.title}" | ||
end | ||||
|
r1250 | redmine_headers 'Project' => container.project.identifier | ||
|
r864 | recipients container.project.recipients | ||
subject "[#{container.project.name}] #{l(:label_attachment_new)}" | ||||
body :attachments => attachments, | ||||
:added_to => added_to, | ||||
:added_to_url => added_to_url | ||||
|
r330 | end | ||
|
r2536 | |||
# Builds a tmail object used to email recipients of a news' project when a news item is added. | ||||
# | ||||
# Example: | ||||
# news_added(news) => tmail object | ||||
# Mailer.deliver_news_added(news) => sends an email to the news' project recipients | ||||
|
r717 | def news_added(news) | ||
|
r1250 | redmine_headers 'Project' => news.project.identifier | ||
|
r2279 | message_id news | ||
|
r864 | recipients news.project.recipients | ||
subject "[#{news.project.name}] #{l(:label_news)}: #{news.title}" | ||||
body :news => news, | ||||
:news_url => url_for(:controller => 'news', :action => 'show', :id => news) | ||||
|
r717 | end | ||
|
r864 | |||
|
r2536 | # Builds a tmail object used to email the specified recipients of the specified message that was posted. | ||
# | ||||
# Example: | ||||
# message_posted(message, recipients) => tmail object | ||||
# Mailer.deliver_message_posted(message, recipients) => sends an email to the recipients | ||||
|
r864 | def message_posted(message, recipients) | ||
|
r1250 | redmine_headers 'Project' => message.project.identifier, | ||
'Topic-Id' => (message.parent_id || message.id) | ||||
|
r2279 | message_id message | ||
references message.parent unless message.parent.nil? | ||||
|
r864 | recipients(recipients) | ||
|
r2292 | subject "[#{message.board.project.name} - #{message.board.name} - msg#{message.root.id}] #{message.subject}" | ||
|
r864 | body :message => message, | ||
:message_url => url_for(:controller => 'messages', :action => 'show', :board_id => message.board_id, :id => message.root) | ||||
end | ||||
|
r2650 | |||
|
r2657 | # Builds a tmail object used to email the recipients of a project of the specified wiki content was added. | ||
|
r2650 | # | ||
# Example: | ||||
|
r2657 | # wiki_content_added(wiki_content) => tmail object | ||
# Mailer.deliver_wiki_content_added(wiki_content) => 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 | ||||
message_id wiki_content | ||||
recipients wiki_content.project.recipients | ||||
|
r2666 | cc(wiki_content.page.wiki.watcher_recipients - recipients) | ||
|
r2650 | subject "[#{wiki_content.project.name}] #{l(:mail_subject_wiki_content_added, :page => wiki_content.page.pretty_title)}" | ||
body :wiki_content => wiki_content, | ||||
:wiki_content_url => url_for(:controller => 'wiki', :action => 'index', :id => wiki_content.project, :page => wiki_content.page.title) | ||||
end | ||||
# Builds a tmail object used to email the recipients of a project of the specified wiki content was updated. | ||||
# | ||||
# Example: | ||||
# wiki_content_updated(wiki_content) => tmail object | ||||
# Mailer.deliver_wiki_content_updated(wiki_content) => sends an email to the project's recipients | ||||
def wiki_content_updated(wiki_content) | ||||
redmine_headers 'Project' => wiki_content.project.identifier, | ||||
'Wiki-Page-Id' => wiki_content.page.id | ||||
message_id wiki_content | ||||
recipients wiki_content.project.recipients | ||||
|
r2666 | cc(wiki_content.page.wiki.watcher_recipients + wiki_content.page.watcher_recipients - recipients) | ||
|
r2650 | subject "[#{wiki_content.project.name}] #{l(:mail_subject_wiki_content_updated, :page => wiki_content.page.pretty_title)}" | ||
body :wiki_content => wiki_content, | ||||
:wiki_content_url => url_for(:controller => 'wiki', :action => 'index', :id => wiki_content.project, :page => wiki_content.page.title), | ||||
:wiki_diff_url => url_for(:controller => 'wiki', :action => 'diff', :id => wiki_content.project, :page => wiki_content.page.title, :version => wiki_content.version) | ||||
end | ||||
|
r1987 | |||
|
r2536 | # Builds a tmail object used to email the specified user their account information. | ||
# | ||||
# Example: | ||||
# account_information(user, password) => tmail object | ||||
# Mailer.deliver_account_information(user, password) => sends account information to the user | ||||
|
r864 | def account_information(user, password) | ||
set_language_if_valid user.language | ||||
recipients user.mail | ||||
|
r1239 | subject l(:mail_subject_register, Setting.app_title) | ||
|
r864 | body :user => user, | ||
:password => password, | ||||
:login_url => url_for(:controller => 'account', :action => 'login') | ||||
end | ||||
|
r1987 | |||
|
r2536 | # Builds a tmail object used to email all active administrators of an account activation request. | ||
# | ||||
# Example: | ||||
# account_activation_request(user) => tmail object | ||||
# Mailer.deliver_account_activation_request(user)=> sends an email to all active administrators | ||||
|
r902 | def account_activation_request(user) | ||
# Send the email to all active administrators | ||||
|
r2077 | recipients User.active.find(:all, :conditions => {:admin => true}).collect { |u| u.mail }.compact | ||
|
r1239 | subject l(:mail_subject_account_activation_request, Setting.app_title) | ||
|
r902 | body :user => user, | ||
:url => url_for(:controller => 'users', :action => 'index', :status => User::STATUS_REGISTERED, :sort_key => 'created_on', :sort_order => 'desc') | ||||
end | ||||
|
r864 | |||
|
r2536 | # Builds a tmail object used to email the specified user that their account was activated by an administrator. | ||
# | ||||
# Example: | ||||
# account_activated(user) => tmail object | ||||
# Mailer.deliver_account_activated(user) => sends an email to the registered user | ||||
|
r2422 | def account_activated(user) | ||
set_language_if_valid user.language | ||||
recipients user.mail | ||||
subject l(:mail_subject_register, Setting.app_title) | ||||
body :user => user, | ||||
:login_url => url_for(:controller => 'account', :action => 'login') | ||||
end | ||||
|
r330 | def lost_password(token) | ||
set_language_if_valid(token.user.language) | ||||
|
r864 | recipients token.user.mail | ||
|
r1239 | subject l(:mail_subject_lost_password, Setting.app_title) | ||
|
r864 | body :token => token, | ||
:url => url_for(:controller => 'account', :action => 'lost_password', :token => token.value) | ||||
|
r1987 | end | ||
|
r330 | |||
def register(token) | ||||
set_language_if_valid(token.user.language) | ||||
|
r864 | recipients token.user.mail | ||
|
r1239 | subject l(:mail_subject_register, Setting.app_title) | ||
|
r864 | body :token => token, | ||
|
r902 | :url => url_for(:controller => 'account', :action => 'activate', :token => token.value) | ||
|
r528 | end | ||
|
r1987 | |||
|
r629 | def test(user) | ||
set_language_if_valid(user.language) | ||||
|
r864 | recipients user.mail | ||
subject 'Redmine test' | ||||
body :url => url_for(:controller => 'welcome') | ||||
end | ||||
|
r1160 | |||
# Overrides default deliver! method to prevent from sending an email | ||||
# with no recipient, cc or bcc | ||||
def deliver!(mail = @mail) | ||||
|
r1987 | return false if (recipients.nil? || recipients.empty?) && | ||
|
r1160 | (cc.nil? || cc.empty?) && | ||
(bcc.nil? || bcc.empty?) | ||||
|
r2279 | |||
# Set Message-Id and References | ||||
if @message_id_object | ||||
mail.message_id = self.class.message_id_for(@message_id_object) | ||||
end | ||||
if @references_objects | ||||
mail.references = @references_objects.collect {|o| self.class.message_id_for(o)} | ||||
end | ||||
super(mail) | ||||
|
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) | ||||
def self.reminders(options={}) | ||||
days = options[:days] || 7 | ||||
project = options[:project] ? Project.find(options[:project]) : nil | ||||
tracker = options[:tracker] ? Tracker.find(options[:tracker]) : nil | ||||
|
r1987 | |||
|
r1469 | s = ARCondition.new ["#{IssueStatus.table_name}.is_closed = ? AND #{Issue.table_name}.due_date <= ?", false, days.day.from_now.to_date] | ||
s << "#{Issue.table_name}.assigned_to_id IS NOT NULL" | ||||
s << "#{Project.table_name}.status = #{Project::STATUS_ACTIVE}" | ||||
|
r1445 | s << "#{Issue.table_name}.project_id = #{project.id}" if project | ||
s << "#{Issue.table_name}.tracker_id = #{tracker.id}" if tracker | ||||
|
r1987 | |||
|
r1445 | issues_by_assignee = Issue.find(:all, :include => [:status, :assigned_to, :project, :tracker], | ||
:conditions => s.conditions | ||||
).group_by(&:assigned_to) | ||||
issues_by_assignee.each do |assignee, issues| | ||||
deliver_reminder(assignee, issues, days) unless assignee.nil? | ||||
end | ||||
end | ||||
|
r1160 | |||
|
r864 | private | ||
def initialize_defaults(method_name) | ||||
super | ||||
set_language_if_valid Setting.default_language | ||||
from Setting.mail_from | ||||
|
r1990 | |||
|
r1250 | # Common headers | ||
headers 'X-Mailer' => 'Redmine', | ||||
'X-Redmine-Host' => Setting.host_name, | ||||
|
r2497 | 'X-Redmine-Site' => Setting.app_title, | ||
|
r2566 | 'Precedence' => 'bulk', | ||
'Auto-Submitted' => 'auto-generated' | ||||
|
r1250 | end | ||
|
r1987 | |||
|
r1250 | # Appends a Redmine header field (name is prepended with 'X-Redmine-') | ||
def redmine_headers(h) | ||||
h.each { |k,v| headers["X-Redmine-#{k}"] = v } | ||||
|
r864 | end | ||
|
r1987 | |||
|
r931 | # Overrides the create_mail method | ||
|
r886 | def create_mail | ||
|
r931 | # Removes the current user from the recipients and cc | ||
# if he doesn't want to receive notifications about what he does | ||||
|
r2223 | @author ||= User.current | ||
if @author.pref[:no_self_notified] | ||||
recipients.delete(@author.mail) if recipients | ||||
cc.delete(@author.mail) if cc | ||||
|
r931 | end | ||
# Blind carbon copy recipients | ||||
if Setting.bcc_recipients? | ||||
bcc([recipients, cc].flatten.compact.uniq) | ||||
recipients [] | ||||
cc [] | ||||
|
r1987 | end | ||
|
r886 | super | ||
end | ||||
|
r1987 | |||
|
r864 | # Renders a message with the corresponding layout | ||
def render_message(method_name, body) | ||||
|
r2232 | layout = method_name.to_s.match(%r{text\.html\.(rhtml|rxml)}) ? 'layout.text.html.rhtml' : 'layout.text.plain.rhtml' | ||
|
r864 | body[:content_for_layout] = render(:file => method_name, :body => body) | ||
|
r1809 | ActionView::Base.new(template_root, body, self).render(:file => "mailer/#{layout}", :use_full_path => true) | ||
|
r629 | end | ||
|
r1930 | |||
# for the case of plain text only | ||||
def body(*params) | ||||
value = super(*params) | ||||
if Setting.plain_text_mail? | ||||
templates = Dir.glob("#{template_path}/#{@template}.text.plain.{rhtml,erb}") | ||||
unless String === @body or templates.empty? | ||||
template = File.basename(templates.first) | ||||
@body[:content_for_layout] = render(:file => template, :body => @body) | ||||
@body = ActionView::Base.new(template_root, @body, self).render(:file => "mailer/layout.text.plain.rhtml", :use_full_path => true) | ||||
return @body | ||||
end | ||||
end | ||||
return value | ||||
end | ||||
|
r1987 | |||
|
r962 | # Makes partial rendering work with Rails 1.2 (retro-compatibility) | ||
def self.controller_path | ||||
'' | ||||
end unless respond_to?('controller_path') | ||||
|
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 | ||||
|
r2650 | timestamp = object.send(object.respond_to?(:created_on) ? :created_on : :updated_on) | ||
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? | ||||
"<#{hash}@#{host}>" | ||||
end | ||||
private | ||||
def message_id(object) | ||||
@message_id_object = object | ||||
end | ||||
def references(object) | ||||
@references_objects ||= [] | ||||
@references_objects << object | ||||
end | ||||
end | ||||
# Patch TMail so that message_id is not overwritten | ||||
module TMail | ||||
class Mail | ||||
def add_message_id( fqdn = nil ) | ||||
self.message_id ||= ::TMail::new_message_id(fqdn) | ||||
end | ||||
end | ||||
|
r2 | end | ||