# Redmine - project management software # Copyright (C) 2006-2013 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. # # 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. # # 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 layout 'mailer' helper :application helper :issues helper :custom_fields include Redmine::I18n include CoursesHelper def self.default_url_options { :host => Setting.host_name, :protocol => Setting.protocol } end # Builds a Mail::Message object used to email recipients of the added journals for message. # 留言分为直接留言,和对留言人留言的回复 # 字段说明在JournalsForMessage.rb # 直接留言后 reply_id,m_parent_id 为空,相对应的at_user取值为nil def journals_for_message_add(user, journals_for_message) @user = journals_for_message.user # 留言人 @mail = journals_for_message.jour if journals_for_message.at_user.nil? # 留言 @mail = journals_for_message.at_user if journals_for_message.at_user @message = journals_for_message.notes @title = "#@user #{t(:label_leave_your_message, :locale => 'zh')}" @url = case journals_for_message.jour.class.to_s.to_sym # 判断留言的对象所属类型 when :Bid respond_url(journals_for_message.jour, anchor: "word_li_#{journals_for_message.id}") when :Project return -1 if journals_for_message.jour.project_type == Project::ProjectType_project project_feedback_url(journals_for_message.jour, anchor: "word_li_#{journals_for_message.id}") when :Course course_feedback_url(journals_for_message.jour, anchor: "word_li_#{journals_for_message.id}") when :Contest show_contest_contest_url(journals_for_message.jour, anchor: "word_li_#{journals_for_message.id}") when :User user_newfeedback_user_url(journals_for_message.jour, anchor: "word_li_#{journals_for_message.id}") else Rails.logger.error "[Builds a Mail::Message ERROR] journalsForMessage's jour is unkown type, journalsForMessage.id = #{journals_for_message.id}" return -1 end # modify by nwb #如果是直接留言并且留言对象是课程 if !journals_for_message.at_user && journals_for_message.jour.class.to_s.to_sym == :Course course = journals_for_message.jour @author = journals_for_message.user #课程的教师 @teachers = searchTeacherAndAssistant journals_for_message.jour #收件人邮箱 @recipients ||= [] @teachers.each do |teacher| if teacher.user.notify_about? journals_for_message @recipients << teacher.user.mail end end mail :to => @recipients, :subject => "#{l(:label_your_course)}#{journals_for_message.jour.name}#{l(:label_have_message)} " elsif journals_for_message.jour.class.to_s.to_sym == :Bid if !journals_for_message.jour.author.notify_about? journals_for_message return -1 end mail :to => journals_for_message.jour.author.mail, :subject => @title elsif journals_for_message.jour.class.to_s.to_sym == :Contest if !journals_for_message.jour.author.notify_about? journals_for_message return -1 end mail :to => journals_for_message.jour.author.mail, :subject => @title else mail :to => @mail.mail, :subject => @title end end # Builds a Mail::Message object used to email recipients of the added issue. # # Example: # issue_add(issue) => Mail::Message object # Mailer.issue_add(issue).deliver => sends an email to issue recipients def issue_add(issue) issue_id = issue.project_index 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 message_id issue @author = issue.author @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}" end # Builds a Mail::Message object used to email recipients of the edited issue. # # Example: # issue_edit(journal) => Mail::Message object # Mailer.issue_edit(journal).deliver => sends an email to issue recipients def issue_edit(journal) issue = journal.journalized.reload issue_id = issue.project_index redmine_headers 'Project' => issue.project.identifier, 'Issue-Id' => issue_id.to_s, 'Issue-Author' => issue.author.login redmine_headers 'Issue-Assignee' => issue.assigned_to.login if issue.assigned_to message_id journal references issue @author = journal.user recipients = journal.recipients # Watchers in cc cc = journal.watcher_recipients - recipients s = "[#{issue.project.name} - #{issue.tracker.name} ##{issue_id}] " s << "(#{issue.status.name}) " if journal.new_value_for('status_id') s << issue.subject @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 end # 用户申请加入项目邮件通知 def applied_project(applied) @project =applied.project redmine_headers 'Project' => @project, 'User' => applied.user @user = applied.user recipients = @project.manager_recipients s = l(:text_applied_project, :id => "##{@user.show_name}", :project => @project.name) @applied_url = url_for(:controller => 'projects', :action => 'settings', :id => @project.id,:tab=>'members') mail :to => recipients, :subject => s end def reminder(user, issues, days) set_language_if_valid user.language @issues = issues @days = days @issues_url = url_for(:controller => 'issues', :action => 'index', :set_filter => 1, :assigned_to_id => user.id, :sort => 'due_date:asc') mail :to => user.mail, :subject => l(:mail_subject_reminder, :count => issues.size, :days => days) end #缺陷到期邮件通知 def issue_expire issue #@issues = issues #s = l(:text_issue_expire,:issue => "[#{issue.project.name} - #{issue.tracker.name} ##{issue_id}] (#{issue.status.name}) #{issue.subject}") #puts s + "////" + issue.assigned_to.mail #@issues_url = url_for(:controller => 'issues', :action => 'show',:id => issue.id) #mail :to => issue.assigned_to.mail, # :subject => s issue_id = issue.project_index 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 message_id issue @author = issue.author @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}" end # Builds a Mail::Message object used to email users belonging to the added document's project. # # Example: # document_added(document) => Mail::Message object # Mailer.document_added(document).deliver => sends an email to the document's project recipients def document_added(document) redmine_headers 'Project' => document.project.identifier @author = User.current @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}" end # Builds a Mail::Message object used to email recipients of a project when an attachements are added. # # Example: # attachments_added(attachments) => Mail::Message object # Mailer.attachments_added(attachments).deliver => sends an email to the project's recipients def attachments_added(attachments) container = attachments.first.container added_to = '' added_to_url = '' @author = attachments.first.author case container.class.name when 'Project' added_to_url = url_for(:controller => 'files', :action => 'index', :project_id => container) added_to = "#{l(:label_project)}: #{container}" recipients = container.notified_users.select { |user| user.allowed_to?(:view_files, container) }.collect { |u| u.mail } when 'Course' added_to_url = url_for(:controller => 'files', :action => 'index', :course_id => container) added_to = "#{l(:label_course)}: #{container}" recipients = container.notified_users.select { |user| user.allowed_to?(:view_files, container) }.collect { |u| u.mail } when 'Version' added_to_url = url_for(:controller => 'files', :action => 'index', :project_id => container.project) added_to = "#{l(:label_version)}: #{container.name}" recipients = container.project.notified_users.select { |user| user.allowed_to?(:view_files, container.project) }.collect { |u| u.mail } when 'Document' added_to_url = url_for(:controller => 'documents', :action => 'show', :id => container.id) added_to = "#{l(:label_document)}: #{container.title}" recipients = container.recipients end if container.class.name == 'Course' redmine_headers 'Course' => container.id @attachments = attachments @added_to = added_to @added_to_url = added_to_url mail :to => recipients, :subject => "[#{container.name}] #{l(:label_attachment_new)}" elsif container.class.name == 'Project' redmine_headers 'Project' => container.id @attachments = attachments @added_to = added_to @added_to_url = added_to_url mail :to => recipients, :subject => "[#{container.name}] #{l(:label_attachment_new)}" else redmine_headers 'Project' => container.project.identifier @attachments = attachments @added_to = added_to @added_to_url = added_to_url mail :to => recipients, :subject => "[#{container.project.name}] #{l(:label_attachment_new)}" end end # Builds a Mail::Message object used to email recipients of a news' project when a news item is added. # # Example: # news_added(news) => Mail::Message object # Mailer.news_added(news).deliver => sends an email to the news' project recipients def news_added(news) redmine_headers 'Project' => news.project.identifier @author = news.author message_id news @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}" end # Builds a Mail::Message object used to email recipients of a news' project when a news comment is added. # # Example: # news_comment_added(comment) => Mail::Message object # 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 @author = comment.author message_id comment @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}" end # Builds a Mail::Message object used to email the recipients of the specified message that was posted. # # Example: # message_posted(message) => Mail::Message object # Mailer.message_posted(message).deliver => sends an email to the recipients def message_posted(message) redmine_headers 'Project' => message.project.identifier, 'Topic-Id' => (message.parent_id || message.id) @author = message.author message_id message references message.parent unless message.parent.nil? 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}" end # Builds a Mail::Message object used to email the recipients of a project of the specified wiki content was added. # # Example: # wiki_content_added(wiki_content) => Mail::Message object # Mailer.wiki_content_added(wiki_content).deliver => sends an email to the project's recipients def wiki_content_added(wiki_content) redmine_headers 'Project' => wiki_content.project.identifier, 'Wiki-Page-Id' => wiki_content.page.id @author = wiki_content.author message_id wiki_content 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', :project_id => wiki_content.project, :id => wiki_content.page.title) mail :to => recipients, :cc => cc, :subject => "[#{wiki_content.project.name}] #{l(:mail_subject_wiki_content_added, :id => wiki_content.page.pretty_title)}" end # Builds a Mail::Message object used to email the recipients of a project of the specified wiki content was updated. # # Example: # wiki_content_updated(wiki_content) => Mail::Message object # Mailer.wiki_content_updated(wiki_content).deliver => 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 @author = wiki_content.author message_id wiki_content 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', :project_id => wiki_content.project, :id => wiki_content.page.title) @wiki_diff_url = url_for(:controller => 'wiki', :action => 'diff', :project_id => wiki_content.project, :id => wiki_content.page.title, :version => wiki_content.version) mail :to => recipients, :cc => cc, :subject => "[#{wiki_content.project.name}] #{l(:mail_subject_wiki_content_updated, :id => wiki_content.page.pretty_title)}" end # Builds a Mail::Message object used to email the specified user their account information. # # Example: # account_information(user, password) => Mail::Message object # Mailer.account_information(user, password).deliver => sends account information to the user def account_information(user, password) set_language_if_valid user.language @user = user @password = password @login_url = url_for(:controller => 'account', :action => 'login') mail :to => user.mail, :subject => l(:mail_subject_register, Setting.app_title) end # Builds a Mail::Message object used to email all active administrators of an account activation request. # # Example: # account_activation_request(user) => Mail::Message object # Mailer.account_activation_request(user).deliver => sends an email to all active administrators def account_activation_request(user) # Send the email to all active administrators recipients = User.active.where(:admin => true).all.collect { |u| u.mail }.compact @user = user @url = url_for(:controller => 'users', :action => 'index', :status => User::STATUS_REGISTERED, :sort_key => 'created_on', :sort_order => 'desc') mail :to => recipients, :subject => l(:mail_subject_account_activation_request, Setting.app_title) end # Builds a Mail::Message object used to email the specified user that their account was activated by an administrator. # # Example: # account_activated(user) => Mail::Message object # Mailer.account_activated(user).deliver => sends an email to the registered user def account_activated(user) set_language_if_valid user.language @user = user @login_url = url_for(:controller => 'account', :action => 'login') mail :to => user.mail, :subject => l(:mail_subject_register, Setting.app_title) end def lost_password(token) set_language_if_valid(token.user.language) @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) end def register(token) set_language_if_valid(token.user.language) @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) end def test_email(user) set_language_if_valid(user.language) @url = url_for(:controller => 'welcome') mail :to => user.mail, :subject => 'forge test' end # Overrides default deliver! method to prevent from sending an email # with no recipient, cc or bcc def deliver!(mail = @mail) set_language_if_valid @initial_language return false if (recipients.nil? || recipients.empty?) && (cc.nil? || cc.empty?) && (bcc.nil? || bcc.empty?) # 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 mylogger.error "The following error occured while sending email notification: \"#{e.message}\". Check your configuration in config/configuration.yml." end ensure self.class.raise_delivery_errors = raise_errors end end # 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) # * :users => array of user/group ids who should be reminded def self.reminders(options={}) days = options[:days] || 7 project = options[:project] ? Project.find(options[:project]) : nil tracker = options[:tracker] ? Tracker.find(options[:tracker]) : nil user_ids = options[:users] scope = Issue.open.where("#{Issue.table_name}.assigned_to_id IS NOT NULL" + " AND #{Project.table_name}.status = #{Project::STATUS_ACTIVE}" + " AND #{Issue.table_name}.due_date <= ?", days.day.from_now.to_date ) scope = scope.where(:assigned_to_id => user_ids) if user_ids.present? scope = scope.where(:project_id => project.id) if project scope = scope.where(:tracker_id => tracker.id) if tracker issues_by_assignee = scope.includes(:status, :assigned_to, :project, :tracker).all.group_by(&:assigned_to) 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 issues_by_assignee.each do |assignee, issues| reminder(assignee, issues, days).deliver if assignee.is_a?(User) && assignee.active? end end # 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 # 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_(.+)$}) 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") end yield ensure ActionMailer::Base.delivery_method = saved_method end def mail(headers={}) headers.merge! 'X-Mailer' => 'Redmine', 'X-Redmine-Host' => Setting.host_name, 'X-Redmine-Site' => Setting.app_title, 'X-Auto-Response-Suppress' => 'OOF', 'Auto-Submitted' => 'auto-generated', 'From' => Setting.mail_from, 'List-Id' => "<#{Setting.mail_from.to_s.gsub('@', '.')}>" # Removes the author from the recipients and cc # if he doesn't want to receive notifications about what he does if @author && @author.logged? && @author.pref[:no_self_notified] headers[:to].delete(@author.mail) if headers[:to].is_a?(Array) headers[:cc].delete(@author.mail) if headers[:cc].is_a?(Array) end if @author && @author.logged? redmine_headers 'Sender' => @author.login end # Blind carbon copy recipients if Setting.bcc_recipients? 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? end 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? Thread.new do super end end def self.method_missing(method, *args, &block) if m = method.to_s.match(%r{^deliver_(.+)$}) ActiveSupport::Deprecation.warn "Mailer.deliver_#{m[1]}(*args) is deprecated. Use Mailer.#{m[1]}(*args).deliver instead." send(m[1], *args).deliver else super end end #缺陷到期后发送邮件提示 def mail_issue threads = [] issues = Issue.where("done_ratio <> 100 && closed_on is null && due_date is not null") issues.each do |issue| thread = Thread.start do while true cur_issue = Issue.find issue.id if cur_issue.done_ratio == 100 || cur_issue.closed_on != nil break end if Time.now < Time.parse(cur_issue.due_date.to_s) #休眠一个小时。。。 sleep 3600 else #发邮件 puts issue.id.to_s Mailer.issue_expire(issue).deliver #Mailer.issue_add(issue).deliver break end end end threads << thread end puts threads.count.to_s threads end 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 # 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 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")}" host = Setting.mail_from.to_s.gsub(%r{^.*@}, '') host = "#{::Socket.gethostname}.redmine" if host.empty? "#{hash}@#{host}" end def message_id(object) @message_id_object = object end def references(object) @references_objects ||= [] @references_objects << object end def mylogger Rails.logger end end