Chris@909: # Redmine - project management software Chris@909: # Copyright (C) 2006-2011 Jean-Philippe Lang Chris@909: # Chris@909: # This program is free software; you can redistribute it and/or Chris@909: # modify it under the terms of the GNU General Public License Chris@909: # as published by the Free Software Foundation; either version 2 Chris@909: # of the License, or (at your option) any later version. Chris@909: # Chris@909: # This program is distributed in the hope that it will be useful, Chris@909: # but WITHOUT ANY WARRANTY; without even the implied warranty of Chris@909: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the Chris@909: # GNU General Public License for more details. Chris@909: # Chris@909: # You should have received a copy of the GNU General Public License Chris@909: # along with this program; if not, write to the Free Software Chris@909: # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. Chris@909: Chris@909: require 'ar_condition' Chris@909: Chris@909: class Mailer < ActionMailer::Base Chris@909: layout 'mailer' Chris@909: helper :application Chris@909: helper :issues Chris@909: helper :custom_fields Chris@909: Chris@909: include ActionController::UrlWriter Chris@909: include Redmine::I18n Chris@909: Chris@909: def self.default_url_options Chris@909: h = Setting.host_name Chris@909: h = h.to_s.gsub(%r{\/.*$}, '') unless Redmine::Utils.relative_url_root.blank? Chris@909: { :host => h, :protocol => Setting.protocol } Chris@909: end Chris@909: Chris@909: # Builds a tmail object used to email recipients of the added issue. Chris@909: # Chris@909: # Example: Chris@909: # issue_add(issue) => tmail object Chris@909: # Mailer.deliver_issue_add(issue) => sends an email to issue recipients Chris@909: def issue_add(issue) Chris@909: redmine_headers 'Project' => issue.project.identifier, Chris@909: 'Issue-Id' => issue.id, Chris@909: 'Issue-Author' => issue.author.login Chris@909: redmine_headers 'Issue-Assignee' => issue.assigned_to.login if issue.assigned_to Chris@909: message_id issue Chris@909: recipients issue.recipients Chris@909: cc(issue.watcher_recipients - @recipients) Chris@909: subject "[#{issue.project.name} - #{issue.tracker.name} ##{issue.id}] (#{issue.status.name}) #{issue.subject}" Chris@909: body :issue => issue, Chris@909: :issue_url => url_for(:controller => 'issues', :action => 'show', :id => issue) Chris@909: render_multipart('issue_add', body) Chris@909: end Chris@909: Chris@909: # Builds a tmail object used to email recipients of the edited issue. Chris@909: # Chris@909: # Example: Chris@909: # issue_edit(journal) => tmail object Chris@909: # Mailer.deliver_issue_edit(journal) => sends an email to issue recipients Chris@909: def issue_edit(journal) Chris@909: issue = journal.journalized.reload Chris@909: redmine_headers 'Project' => issue.project.identifier, Chris@909: 'Issue-Id' => issue.id, Chris@909: 'Issue-Author' => issue.author.login Chris@909: redmine_headers 'Issue-Assignee' => issue.assigned_to.login if issue.assigned_to Chris@909: message_id journal Chris@909: references issue Chris@909: @author = journal.user Chris@909: recipients issue.recipients Chris@909: # Watchers in cc Chris@909: cc(issue.watcher_recipients - @recipients) Chris@909: s = "[#{issue.project.name} - #{issue.tracker.name} ##{issue.id}] " Chris@909: s << "(#{issue.status.name}) " if journal.new_value_for('status_id') Chris@909: s << issue.subject Chris@909: subject s Chris@909: body :issue => issue, Chris@909: :journal => journal, Chris@909: :issue_url => url_for(:controller => 'issues', :action => 'show', :id => issue, :anchor => "change-#{journal.id}") Chris@909: Chris@909: render_multipart('issue_edit', body) Chris@909: end Chris@909: Chris@909: def reminder(user, issues, days) Chris@909: set_language_if_valid user.language Chris@909: recipients user.mail Chris@909: subject l(:mail_subject_reminder, :count => issues.size, :days => days) Chris@909: body :issues => issues, Chris@909: :days => days, Chris@909: :issues_url => url_for(:controller => 'issues', :action => 'index', Chris@909: :set_filter => 1, :assigned_to_id => user.id, Chris@909: :sort => 'due_date:asc') Chris@909: render_multipart('reminder', body) Chris@909: end Chris@909: Chris@909: # Builds a tmail object used to email users belonging to the added document's project. Chris@909: # Chris@909: # Example: Chris@909: # document_added(document) => tmail object Chris@909: # Mailer.deliver_document_added(document) => sends an email to the document's project recipients Chris@909: def document_added(document) Chris@909: redmine_headers 'Project' => document.project.identifier Chris@909: recipients document.recipients Chris@909: subject "[#{document.project.name}] #{l(:label_document_new)}: #{document.title}" Chris@909: body :document => document, Chris@909: :document_url => url_for(:controller => 'documents', :action => 'show', :id => document) Chris@909: render_multipart('document_added', body) Chris@909: end Chris@909: Chris@909: # Builds a tmail object used to email recipients of a project when an attachements are added. Chris@909: # Chris@909: # Example: Chris@909: # attachments_added(attachments) => tmail object Chris@909: # Mailer.deliver_attachments_added(attachments) => sends an email to the project's recipients Chris@909: def attachments_added(attachments) Chris@909: container = attachments.first.container Chris@909: added_to = '' Chris@909: added_to_url = '' Chris@909: case container.class.name Chris@909: when 'Project' Chris@909: added_to_url = url_for(:controller => 'files', :action => 'index', :project_id => container) Chris@909: added_to = "#{l(:label_project)}: #{container}" Chris@909: recipients container.project.notified_users.select {|user| user.allowed_to?(:view_files, container.project)}.collect {|u| u.mail} Chris@909: when 'Version' Chris@909: added_to_url = url_for(:controller => 'files', :action => 'index', :project_id => container.project) Chris@909: added_to = "#{l(:label_version)}: #{container.name}" Chris@909: recipients container.project.notified_users.select {|user| user.allowed_to?(:view_files, container.project)}.collect {|u| u.mail} Chris@909: when 'Document' Chris@909: added_to_url = url_for(:controller => 'documents', :action => 'show', :id => container.id) Chris@909: added_to = "#{l(:label_document)}: #{container.title}" Chris@909: recipients container.recipients Chris@909: end Chris@909: redmine_headers 'Project' => container.project.identifier Chris@909: subject "[#{container.project.name}] #{l(:label_attachment_new)}" Chris@909: body :attachments => attachments, Chris@909: :added_to => added_to, Chris@909: :added_to_url => added_to_url Chris@909: render_multipart('attachments_added', body) Chris@909: end Chris@909: Chris@909: # Builds a tmail object used to email recipients of a news' project when a news item is added. Chris@909: # Chris@909: # Example: Chris@909: # news_added(news) => tmail object Chris@909: # Mailer.deliver_news_added(news) => sends an email to the news' project recipients Chris@909: def news_added(news) Chris@909: redmine_headers 'Project' => news.project.identifier Chris@909: message_id news Chris@909: recipients news.recipients Chris@909: subject "[#{news.project.name}] #{l(:label_news)}: #{news.title}" Chris@909: body :news => news, Chris@909: :news_url => url_for(:controller => 'news', :action => 'show', :id => news) Chris@909: render_multipart('news_added', body) Chris@909: end Chris@909: Chris@909: # Builds a tmail object used to email recipients of a news' project when a news comment is added. Chris@909: # Chris@909: # Example: Chris@909: # news_comment_added(comment) => tmail object Chris@909: # Mailer.news_comment_added(comment) => sends an email to the news' project recipients Chris@909: def news_comment_added(comment) Chris@909: news = comment.commented Chris@909: redmine_headers 'Project' => news.project.identifier Chris@909: message_id comment Chris@909: recipients news.recipients Chris@909: cc news.watcher_recipients Chris@909: subject "Re: [#{news.project.name}] #{l(:label_news)}: #{news.title}" Chris@909: body :news => news, Chris@909: :comment => comment, Chris@909: :news_url => url_for(:controller => 'news', :action => 'show', :id => news) Chris@909: render_multipart('news_comment_added', body) Chris@909: end Chris@909: Chris@909: # Builds a tmail object used to email the recipients of the specified message that was posted. Chris@909: # Chris@909: # Example: Chris@909: # message_posted(message) => tmail object Chris@909: # Mailer.deliver_message_posted(message) => sends an email to the recipients Chris@909: def message_posted(message) Chris@909: redmine_headers 'Project' => message.project.identifier, Chris@909: 'Topic-Id' => (message.parent_id || message.id) Chris@909: message_id message Chris@909: references message.parent unless message.parent.nil? Chris@909: recipients(message.recipients) Chris@909: cc((message.root.watcher_recipients + message.board.watcher_recipients).uniq - @recipients) Chris@909: subject "[#{message.board.project.name} - #{message.board.name} - msg#{message.root.id}] #{message.subject}" Chris@909: body :message => message, Chris@909: :message_url => url_for(message.event_url) Chris@909: render_multipart('message_posted', body) Chris@909: end Chris@909: Chris@909: # Builds a tmail object used to email the recipients of a project of the specified wiki content was added. Chris@909: # Chris@909: # Example: Chris@909: # wiki_content_added(wiki_content) => tmail object Chris@909: # Mailer.deliver_wiki_content_added(wiki_content) => sends an email to the project's recipients Chris@909: def wiki_content_added(wiki_content) Chris@909: redmine_headers 'Project' => wiki_content.project.identifier, Chris@909: 'Wiki-Page-Id' => wiki_content.page.id Chris@909: message_id wiki_content Chris@909: recipients wiki_content.recipients Chris@909: cc(wiki_content.page.wiki.watcher_recipients - recipients) Chris@909: subject "[#{wiki_content.project.name}] #{l(:mail_subject_wiki_content_added, :id => wiki_content.page.pretty_title)}" Chris@909: body :wiki_content => wiki_content, Chris@909: :wiki_content_url => url_for(:controller => 'wiki', :action => 'show', Chris@909: :project_id => wiki_content.project, Chris@909: :id => wiki_content.page.title) Chris@909: render_multipart('wiki_content_added', body) Chris@909: end Chris@909: Chris@909: # Builds a tmail object used to email the recipients of a project of the specified wiki content was updated. Chris@909: # Chris@909: # Example: Chris@909: # wiki_content_updated(wiki_content) => tmail object Chris@909: # Mailer.deliver_wiki_content_updated(wiki_content) => sends an email to the project's recipients Chris@909: def wiki_content_updated(wiki_content) Chris@909: redmine_headers 'Project' => wiki_content.project.identifier, Chris@909: 'Wiki-Page-Id' => wiki_content.page.id Chris@909: message_id wiki_content Chris@909: recipients wiki_content.recipients Chris@909: cc(wiki_content.page.wiki.watcher_recipients + wiki_content.page.watcher_recipients - recipients) Chris@909: subject "[#{wiki_content.project.name}] #{l(:mail_subject_wiki_content_updated, :id => wiki_content.page.pretty_title)}" Chris@909: body :wiki_content => wiki_content, Chris@909: :wiki_content_url => url_for(:controller => 'wiki', :action => 'show', Chris@909: :project_id => wiki_content.project, Chris@909: :id => wiki_content.page.title), Chris@909: :wiki_diff_url => url_for(:controller => 'wiki', :action => 'diff', Chris@909: :project_id => wiki_content.project, :id => wiki_content.page.title, Chris@909: :version => wiki_content.version) Chris@909: render_multipart('wiki_content_updated', body) Chris@909: end Chris@909: Chris@909: # Builds a tmail object used to email the specified user their account information. Chris@909: # Chris@909: # Example: Chris@909: # account_information(user, password) => tmail object Chris@909: # Mailer.deliver_account_information(user, password) => sends account information to the user Chris@909: def account_information(user, password) Chris@909: set_language_if_valid user.language Chris@909: recipients user.mail Chris@909: subject l(:mail_subject_register, Setting.app_title) Chris@909: body :user => user, Chris@909: :password => password, Chris@909: :login_url => url_for(:controller => 'account', :action => 'login') Chris@909: render_multipart('account_information', body) Chris@909: end Chris@909: Chris@909: # Builds a tmail object used to email all active administrators of an account activation request. Chris@909: # Chris@909: # Example: Chris@909: # account_activation_request(user) => tmail object Chris@909: # Mailer.deliver_account_activation_request(user)=> sends an email to all active administrators Chris@909: def account_activation_request(user) Chris@909: # Send the email to all active administrators Chris@909: recipients User.active.find(:all, :conditions => {:admin => true}).collect { |u| u.mail }.compact Chris@909: subject l(:mail_subject_account_activation_request, Setting.app_title) Chris@909: body :user => user, Chris@909: :url => url_for(:controller => 'users', :action => 'index', Chris@909: :status => User::STATUS_REGISTERED, Chris@909: :sort_key => 'created_on', :sort_order => 'desc') Chris@909: render_multipart('account_activation_request', body) Chris@909: end Chris@909: Chris@909: # Builds a tmail object used to email the specified user that their account was activated by an administrator. Chris@909: # Chris@909: # Example: Chris@909: # account_activated(user) => tmail object Chris@909: # Mailer.deliver_account_activated(user) => sends an email to the registered user Chris@909: def account_activated(user) Chris@909: set_language_if_valid user.language Chris@909: recipients user.mail Chris@909: subject l(:mail_subject_register, Setting.app_title) Chris@909: body :user => user, Chris@909: :login_url => url_for(:controller => 'account', :action => 'login') Chris@909: render_multipart('account_activated', body) Chris@909: end Chris@909: Chris@909: def lost_password(token) Chris@909: set_language_if_valid(token.user.language) Chris@909: recipients token.user.mail Chris@909: subject l(:mail_subject_lost_password, Setting.app_title) Chris@909: body :token => token, Chris@909: :url => url_for(:controller => 'account', :action => 'lost_password', :token => token.value) Chris@909: render_multipart('lost_password', body) Chris@909: end Chris@909: Chris@909: def register(token) Chris@909: set_language_if_valid(token.user.language) Chris@909: recipients token.user.mail Chris@909: subject l(:mail_subject_register, Setting.app_title) Chris@909: body :token => token, Chris@909: :url => url_for(:controller => 'account', :action => 'activate', :token => token.value) Chris@909: render_multipart('register', body) Chris@909: end Chris@909: Chris@909: def test(user) Chris@909: set_language_if_valid(user.language) Chris@909: recipients user.mail Chris@909: subject 'Redmine test' Chris@909: body :url => url_for(:controller => 'welcome') Chris@909: render_multipart('test', body) Chris@909: end Chris@909: Chris@909: # Overrides default deliver! method to prevent from sending an email Chris@909: # with no recipient, cc or bcc Chris@909: def deliver!(mail = @mail) Chris@909: set_language_if_valid @initial_language Chris@909: return false if (recipients.nil? || recipients.empty?) && Chris@909: (cc.nil? || cc.empty?) && Chris@909: (bcc.nil? || bcc.empty?) Chris@909: Chris@909: # Set Message-Id and References Chris@909: if @message_id_object Chris@909: mail.message_id = self.class.message_id_for(@message_id_object) Chris@909: end Chris@909: if @references_objects Chris@909: mail.references = @references_objects.collect {|o| self.class.message_id_for(o)} Chris@909: end Chris@909: Chris@909: # Log errors when raise_delivery_errors is set to false, Rails does not Chris@909: raise_errors = self.class.raise_delivery_errors Chris@909: self.class.raise_delivery_errors = true Chris@909: begin Chris@909: return super(mail) Chris@909: rescue Exception => e Chris@909: if raise_errors Chris@909: raise e Chris@909: elsif mylogger Chris@909: mylogger.error "The following error occured while sending email notification: \"#{e.message}\". Check your configuration in config/configuration.yml." Chris@909: end Chris@909: ensure Chris@909: self.class.raise_delivery_errors = raise_errors Chris@909: end Chris@909: end Chris@909: Chris@909: # Sends reminders to issue assignees Chris@909: # Available options: Chris@909: # * :days => how many days in the future to remind about (defaults to 7) Chris@909: # * :tracker => id of tracker for filtering issues (defaults to all trackers) Chris@909: # * :project => id or identifier of project to process (defaults to all projects) Chris@909: # * :users => array of user ids who should be reminded Chris@909: def self.reminders(options={}) Chris@909: days = options[:days] || 7 Chris@909: project = options[:project] ? Project.find(options[:project]) : nil Chris@909: tracker = options[:tracker] ? Tracker.find(options[:tracker]) : nil Chris@909: user_ids = options[:users] Chris@909: Chris@909: s = ARCondition.new ["#{IssueStatus.table_name}.is_closed = ? AND #{Issue.table_name}.due_date <= ?", false, days.day.from_now.to_date] Chris@909: s << "#{Issue.table_name}.assigned_to_id IS NOT NULL" Chris@909: s << ["#{Issue.table_name}.assigned_to_id IN (?)", user_ids] if user_ids.present? Chris@909: s << "#{Project.table_name}.status = #{Project::STATUS_ACTIVE}" Chris@909: s << "#{Issue.table_name}.project_id = #{project.id}" if project Chris@909: s << "#{Issue.table_name}.tracker_id = #{tracker.id}" if tracker Chris@909: Chris@909: issues_by_assignee = Issue.find(:all, :include => [:status, :assigned_to, :project, :tracker], Chris@909: :conditions => s.conditions Chris@909: ).group_by(&:assigned_to) Chris@909: issues_by_assignee.each do |assignee, issues| Chris@909: deliver_reminder(assignee, issues, days) if assignee && assignee.active? Chris@909: end Chris@909: end Chris@909: Chris@909: # Activates/desactivates email deliveries during +block+ Chris@909: def self.with_deliveries(enabled = true, &block) Chris@909: was_enabled = ActionMailer::Base.perform_deliveries Chris@909: ActionMailer::Base.perform_deliveries = !!enabled Chris@909: yield Chris@909: ensure Chris@909: ActionMailer::Base.perform_deliveries = was_enabled Chris@909: end Chris@909: Chris@909: private Chris@909: def initialize_defaults(method_name) Chris@909: super Chris@909: @initial_language = current_language Chris@909: set_language_if_valid Setting.default_language Chris@909: from Setting.mail_from Chris@909: Chris@909: # Common headers Chris@909: headers 'X-Mailer' => 'Redmine', Chris@909: 'X-Redmine-Host' => Setting.host_name, Chris@909: 'X-Redmine-Site' => Setting.app_title, Chris@909: 'X-Auto-Response-Suppress' => 'OOF', Chris@909: 'Auto-Submitted' => 'auto-generated' Chris@909: end Chris@909: Chris@909: # Appends a Redmine header field (name is prepended with 'X-Redmine-') Chris@909: def redmine_headers(h) Chris@909: h.each { |k,v| headers["X-Redmine-#{k}"] = v } Chris@909: end Chris@909: Chris@909: # Overrides the create_mail method Chris@909: def create_mail Chris@909: # Removes the current user from the recipients and cc Chris@909: # if he doesn't want to receive notifications about what he does Chris@909: @author ||= User.current Chris@909: if @author.pref[:no_self_notified] Chris@909: recipients.delete(@author.mail) if recipients Chris@909: cc.delete(@author.mail) if cc Chris@909: end Chris@909: Chris@909: notified_users = [recipients, cc].flatten.compact.uniq Chris@909: # Rails would log recipients only, not cc and bcc Chris@909: mylogger.info "Sending email notification to: #{notified_users.join(', ')}" if mylogger Chris@909: Chris@909: # Blind carbon copy recipients Chris@909: if Setting.bcc_recipients? Chris@909: bcc(notified_users) Chris@909: recipients [] Chris@909: cc [] Chris@909: end Chris@909: super Chris@909: end Chris@909: Chris@909: # Rails 2.3 has problems rendering implicit multipart messages with Chris@909: # layouts so this method will wrap an multipart messages with Chris@909: # explicit parts. Chris@909: # Chris@909: # https://rails.lighthouseapp.com/projects/8994/tickets/2338-actionmailer-mailer-views-and-content-type Chris@909: # https://rails.lighthouseapp.com/projects/8994/tickets/1799-actionmailer-doesnt-set-template_format-when-rendering-layouts Chris@909: Chris@909: def render_multipart(method_name, body) Chris@909: if Setting.plain_text_mail? Chris@909: content_type "text/plain" Chris@909: body render(:file => "#{method_name}.text.erb", Chris@909: :body => body, Chris@909: :layout => 'mailer.text.erb') Chris@909: else Chris@909: content_type "multipart/alternative" Chris@909: part :content_type => "text/plain", Chris@909: :body => render(:file => "#{method_name}.text.erb", Chris@909: :body => body, :layout => 'mailer.text.erb') Chris@909: part :content_type => "text/html", Chris@909: :body => render_message("#{method_name}.html.erb", body) Chris@909: end Chris@909: end Chris@909: Chris@909: # Makes partial rendering work with Rails 1.2 (retro-compatibility) Chris@909: def self.controller_path Chris@909: '' Chris@909: end unless respond_to?('controller_path') Chris@909: Chris@909: # Returns a predictable Message-Id for the given object Chris@909: def self.message_id_for(object) Chris@909: # id + timestamp should reduce the odds of a collision Chris@909: # as far as we don't send multiple emails for the same object Chris@909: timestamp = object.send(object.respond_to?(:created_on) ? :created_on : :updated_on) Chris@909: hash = "redmine.#{object.class.name.demodulize.underscore}-#{object.id}.#{timestamp.strftime("%Y%m%d%H%M%S")}" Chris@909: host = Setting.mail_from.to_s.gsub(%r{^.*@}, '') Chris@909: host = "#{::Socket.gethostname}.redmine" if host.empty? Chris@909: "<#{hash}@#{host}>" Chris@909: end Chris@909: Chris@909: private Chris@909: Chris@909: def message_id(object) Chris@909: @message_id_object = object Chris@909: end Chris@909: Chris@909: def references(object) Chris@909: @references_objects ||= [] Chris@909: @references_objects << object Chris@909: end Chris@909: Chris@909: def mylogger Chris@909: Rails.logger Chris@909: end Chris@909: end Chris@909: Chris@909: # Patch TMail so that message_id is not overwritten Chris@909: module TMail Chris@909: class Mail Chris@909: def add_message_id( fqdn = nil ) Chris@909: self.message_id ||= ::TMail::new_message_id(fqdn) Chris@909: end Chris@909: end Chris@909: end