app/models/mailer.rb

   1 # redMine - project management software
   2 # Copyright (C) 2006-2007  Jean-Philippe Lang
   3 #
   4 # This program is free software; you can redistribute it and/or
   5 # modify it under the terms of the GNU General Public License
   6 # as published by the Free Software Foundation; either version 2
   7 # of the License, or (at your option) any later version.
   8 #
   9 # This program is distributed in the hope that it will be useful,
  10 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12 # GNU General Public License for more details.
  13 #
  14 # You should have received a copy of the GNU General Public License
  15 # along with this program; if not, write to the Free Software
  16 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  17
  18 require 'ar_condition'
  19
  20 class Mailer < ActionMailer::Base
  21   layout 'mailer'
  22   helper :application
  23   helper :issues
  24   helper :custom_fields
  25
  26   include ActionController::UrlWriter
  27   include Redmine::I18n
  28
  29   def self.default_url_options
  30     h = Setting.host_name
  31     h = h.to_s.gsub(%r{\/.*$}, '') unless Redmine::Utils.relative_url_root.blank?
  32     { :host => h, :protocol => Setting.protocol }
  33   end
  34
  35   # Builds a tmail object used to email recipients of the added issue.
  36   #
  37   # Example:
  38   #   issue_add(issue) => tmail object
  39   #   Mailer.deliver_issue_add(issue) => sends an email to issue recipients
  40   def issue_add(issue)
  41     redmine_headers 'Project' => issue.project.identifier,
  42                     'Issue-Id' => issue.id,
  43                     'Issue-Author' => issue.author.login
  44     redmine_headers 'Issue-Assignee' => issue.assigned_to.login if issue.assigned_to
  45     message_id issue
  46     recipients issue.recipients
  47     cc(issue.watcher_recipients - @recipients)
  48     subject "[#{issue.project.name} - #{issue.tracker.name} ##{issue.id}] (#{issue.status.name}) #{issue.subject}"
  49     body :issue => issue,
  50          :issue_url => url_for(:controller => 'issues', :action => 'show', :id => issue)
  51     render_multipart('issue_add', body)
  52   end
  53
  54   # Builds a tmail object used to email recipients of the edited issue.
  55   #
  56   # Example:
  57   #   issue_edit(journal) => tmail object
  58   #   Mailer.deliver_issue_edit(journal) => sends an email to issue recipients
  59   def issue_edit(journal)
  60     issue = journal.journalized.reload
  61     redmine_headers 'Project' => issue.project.identifier,
  62                     'Issue-Id' => issue.id,
  63                     'Issue-Author' => issue.author.login
  64     redmine_headers 'Issue-Assignee' => issue.assigned_to.login if issue.assigned_to
  65     message_id journal
  66     references issue
  67     @author = journal.user
  68     recipients issue.recipients
  69     # Watchers in cc
  70     cc(issue.watcher_recipients - @recipients)
  71     s = "[#{issue.project.name} - #{issue.tracker.name} ##{issue.id}] "
  72     s << "(#{issue.status.name}) " if journal.new_value_for('status_id')
  73     s << issue.subject
  74     subject s
  75     body :issue => issue,
  76          :journal => journal,
  77          :issue_url => url_for(:controller => 'issues', :action => 'show', :id => issue)
  78
  79     render_multipart('issue_edit', body)
  80   end
  81
  82   def reminder(user, issues, days)
  83     set_language_if_valid user.language
  84     recipients user.mail
  85     subject l(:mail_subject_reminder, :count => issues.size, :days => days)
  86     body :issues => issues,
  87          :days => days,
  88          :issues_url => url_for(:controller => 'issues', :action => 'index', :set_filter => 1, :assigned_to_id => user.id, :sort_key => 'due_date', :sort_order => 'asc')
  89     render_multipart('reminder', body)
  90   end
  91
  92   # Builds a tmail object used to email users belonging to the added document's project.
  93   #
  94   # Example:
  95   #   document_added(document) => tmail object
  96   #   Mailer.deliver_document_added(document) => sends an email to the document's project recipients
  97   def document_added(document)
  98     redmine_headers 'Project' => document.project.identifier
  99     recipients document.recipients
 100     subject "[#{document.project.name}] #{l(:label_document_new)}: #{document.title}"
 101     body :document => document,
 102          :document_url => url_for(:controller => 'documents', :action => 'show', :id => document)
 103     render_multipart('document_added', body)
 104   end
 105
 106   # Builds a tmail object used to email recipients of a project when an attachements are added.
 107   #
 108   # Example:
 109   #   attachments_added(attachments) => tmail object
 110   #   Mailer.deliver_attachments_added(attachments) => sends an email to the project's recipients
 111   def attachments_added(attachments)
 112     container = attachments.first.container
 113     added_to = ''
 114     added_to_url = ''
 115     case container.class.name
 116     when 'Project'
 117       added_to_url = url_for(:controller => 'projects', :action => 'list_files', :id => container)
 118       added_to = "#{l(:label_project)}: #{container}"
 119       recipients container.project.notified_users.select {|user| user.allowed_to?(:view_files, container.project)}.collect  {|u| u.mail}
 120     when 'Version'
 121       added_to_url = url_for(:controller => 'projects', :action => 'list_files', :id => container.project_id)
 122       added_to = "#{l(:label_version)}: #{container.name}"
 123       recipients container.project.notified_users.select {|user| user.allowed_to?(:view_files, container.project)}.collect  {|u| u.mail}
 124     when 'Document'
 125       added_to_url = url_for(:controller => 'documents', :action => 'show', :id => container.id)
 126       added_to = "#{l(:label_document)}: #{container.title}"
 127       recipients container.recipients
 128     end
 129     redmine_headers 'Project' => container.project.identifier
 130     subject "[#{container.project.name}] #{l(:label_attachment_new)}"
 131     body :attachments => attachments,
 132          :added_to => added_to,
 133          :added_to_url => added_to_url
 134     render_multipart('attachments_added', body)
 135   end
 136
 137   # Builds a tmail object used to email recipients of a news' project when a news item is added.
 138   #
 139   # Example:
 140   #   news_added(news) => tmail object
 141   #   Mailer.deliver_news_added(news) => sends an email to the news' project recipients
 142   def news_added(news)
 143     redmine_headers 'Project' => news.project.identifier
 144     message_id news
 145     recipients news.recipients
 146     subject "[#{news.project.name}] #{l(:label_news)}: #{news.title}"
 147     body :news => news,
 148          :news_url => url_for(:controller => 'news', :action => 'show', :id => news)
 149     render_multipart('news_added', body)
 150   end
 151
 152   # Builds a tmail object used to email the recipients of the specified message that was posted.
 153   #
 154   # Example:
 155   #   message_posted(message) => tmail object
 156   #   Mailer.deliver_message_posted(message) => sends an email to the recipients
 157   def message_posted(message)
 158     redmine_headers 'Project' => message.project.identifier,
 159                     'Topic-Id' => (message.parent_id || message.id)
 160     message_id message
 161     references message.parent unless message.parent.nil?
 162     recipients(message.recipients)
 163     cc((message.root.watcher_recipients + message.board.watcher_recipients).uniq - @recipients)
 164     subject "[#{message.board.project.name} - #{message.board.name} - msg#{message.root.id}] #{message.subject}"
 165     body :message => message,
 166          :message_url => url_for(message.event_url)
 167     render_multipart('message_posted', body)
 168   end
 169
 170   # Builds a tmail object used to email the recipients of a project of the specified wiki content was added.
 171   #
 172   # Example:
 173   #   wiki_content_added(wiki_content) => tmail object
 174   #   Mailer.deliver_wiki_content_added(wiki_content) => sends an email to the project's recipients
 175   def wiki_content_added(wiki_content)
 176     redmine_headers 'Project' => wiki_content.project.identifier,
 177                     'Wiki-Page-Id' => wiki_content.page.id
 178     message_id wiki_content
 179     recipients wiki_content.recipients
 180     cc(wiki_content.page.wiki.watcher_recipients - recipients)
 181     subject "[#{wiki_content.project.name}] #{l(:mail_subject_wiki_content_added, :page => wiki_content.page.pretty_title)}"
 182     body :wiki_content => wiki_content,
 183          :wiki_content_url => url_for(:controller => 'wiki', :action => 'index', :id => wiki_content.project, :page => wiki_content.page.title)
 184     render_multipart('wiki_content_added', body)
 185   end
 186
 187   # Builds a tmail object used to email the recipients of a project of the specified wiki content was updated.
 188   #
 189   # Example:
 190   #   wiki_content_updated(wiki_content) => tmail object
 191   #   Mailer.deliver_wiki_content_updated(wiki_content) => sends an email to the project's recipients
 192   def wiki_content_updated(wiki_content)
 193     redmine_headers 'Project' => wiki_content.project.identifier,
 194                     'Wiki-Page-Id' => wiki_content.page.id
 195     message_id wiki_content
 196     recipients wiki_content.recipients
 197     cc(wiki_content.page.wiki.watcher_recipients + wiki_content.page.watcher_recipients - recipients)
 198     subject "[#{wiki_content.project.name}] #{l(:mail_subject_wiki_content_updated, :page => wiki_content.page.pretty_title)}"
 199     body :wiki_content => wiki_content,
 200          :wiki_content_url => url_for(:controller => 'wiki', :action => 'index', :id => wiki_content.project, :page => wiki_content.page.title),
 201          :wiki_diff_url => url_for(:controller => 'wiki', :action => 'diff', :id => wiki_content.project, :page => wiki_content.page.title, :version => wiki_content.version)
 202     render_multipart('wiki_content_updated', body)
 203   end
 204
 205   # Builds a tmail object used to email the specified user their account information.
 206   #
 207   # Example:
 208   #   account_information(user, password) => tmail object
 209   #   Mailer.deliver_account_information(user, password) => sends account information to the user
 210   def account_information(user, password)
 211     set_language_if_valid user.language
 212     recipients user.mail
 213     subject l(:mail_subject_register, Setting.app_title)
 214     body :user => user,
 215          :password => password,
 216          :login_url => url_for(:controller => 'account', :action => 'login')
 217     render_multipart('account_information', body)
 218   end
 219
 220   # Builds a tmail object used to email all active administrators of an account activation request.
 221   #
 222   # Example:
 223   #   account_activation_request(user) => tmail object
 224   #   Mailer.deliver_account_activation_request(user)=> sends an email to all active administrators
 225   def account_activation_request(user)
 226     # Send the email to all active administrators
 227     recipients User.active.find(:all, :conditions => {:admin => true}).collect { |u| u.mail }.compact
 228     subject l(:mail_subject_account_activation_request, Setting.app_title)
 229     body :user => user,
 230          :url => url_for(:controller => 'users', :action => 'index', :status => User::STATUS_REGISTERED, :sort_key => 'created_on', :sort_order => 'desc')
 231     render_multipart('account_activation_request', body)
 232   end
 233
 234   # Builds a tmail object used to email the specified user that their account was activated by an administrator.
 235   #
 236   # Example:
 237   #   account_activated(user) => tmail object
 238   #   Mailer.deliver_account_activated(user) => sends an email to the registered user
 239   def account_activated(user)
 240     set_language_if_valid user.language
 241     recipients user.mail
 242     subject l(:mail_subject_register, Setting.app_title)
 243     body :user => user,
 244          :login_url => url_for(:controller => 'account', :action => 'login')
 245     render_multipart('account_activated', body)
 246   end
 247
 248   def lost_password(token)
 249     set_language_if_valid(token.user.language)
 250     recipients token.user.mail
 251     subject l(:mail_subject_lost_password, Setting.app_title)
 252     body :token => token,
 253          :url => url_for(:controller => 'account', :action => 'lost_password', :token => token.value)
 254     render_multipart('lost_password', body)
 255   end
 256
 257   def register(token)
 258     set_language_if_valid(token.user.language)
 259     recipients token.user.mail
 260     subject l(:mail_subject_register, Setting.app_title)
 261     body :token => token,
 262          :url => url_for(:controller => 'account', :action => 'activate', :token => token.value)
 263     render_multipart('register', body)
 264   end
 265
 266   def test(user)
 267     set_language_if_valid(user.language)
 268     recipients user.mail
 269     subject 'Redmine test'
 270     body :url => url_for(:controller => 'welcome')
 271     render_multipart('test', body)
 272   end
 273
 274   # Overrides default deliver! method to prevent from sending an email
 275   # with no recipient, cc or bcc
 276   def deliver!(mail = @mail)
 277     set_language_if_valid @initial_language
 278     return false if (recipients.nil? || recipients.empty?) &&
 279                     (cc.nil? || cc.empty?) &&
 280                     (bcc.nil? || bcc.empty?)
 281
 282     # Set Message-Id and References
 283     if @message_id_object
 284       mail.message_id = self.class.message_id_for(@message_id_object)
 285     end
 286     if @references_objects
 287       mail.references = @references_objects.collect {|o| self.class.message_id_for(o)}
 288     end
 289
 290     # Log errors when raise_delivery_errors is set to false, Rails does not
 291     raise_errors = self.class.raise_delivery_errors
 292     self.class.raise_delivery_errors = true
 293     begin
 294       return super(mail)
 295     rescue Exception => e
 296       if raise_errors
 297         raise e
 298       elsif mylogger
 299         mylogger.error "The following error occured while sending email notification: \"#{e.message}\". Check your configuration in config/email.yml."
 300       end
 301     ensure
 302       self.class.raise_delivery_errors = raise_errors
 303     end
 304   end
 305
 306   # Sends reminders to issue assignees
 307   # Available options:
 308   # * :days     => how many days in the future to remind about (defaults to 7)
 309   # * :tracker  => id of tracker for filtering issues (defaults to all trackers)
 310   # * :project  => id or identifier of project to process (defaults to all projects)
 311   # * :users    => array of user ids who should be reminded
 312   def self.reminders(options={})
 313     days = options[:days] || 7
 314     project = options[:project] ? Project.find(options[:project]) : nil
 315     tracker = options[:tracker] ? Tracker.find(options[:tracker]) : nil
 316     user_ids = options[:users]
 317
 318     s = ARCondition.new ["#{IssueStatus.table_name}.is_closed = ? AND #{Issue.table_name}.due_date <= ?", false, days.day.from_now.to_date]
 319     s << "#{Issue.table_name}.assigned_to_id IS NOT NULL"
 320     s << ["#{Issue.table_name}.assigned_to_id IN (?)", user_ids] if user_ids.present?
 321     s << "#{Project.table_name}.status = #{Project::STATUS_ACTIVE}"
 322     s << "#{Issue.table_name}.project_id = #{project.id}" if project
 323     s << "#{Issue.table_name}.tracker_id = #{tracker.id}" if tracker
 324
 325     issues_by_assignee = Issue.find(:all, :include => [:status, :assigned_to, :project, :tracker],
 326                                           :conditions => s.conditions
 327                                     ).group_by(&:assigned_to)
 328     issues_by_assignee.each do |assignee, issues|
 329       deliver_reminder(assignee, issues, days) unless assignee.nil?
 330     end
 331   end
 332
 333   # Activates/desactivates email deliveries during +block+
 334   def self.with_deliveries(enabled = true, &block)
 335     was_enabled = ActionMailer::Base.perform_deliveries
 336     ActionMailer::Base.perform_deliveries = !!enabled
 337     yield
 338   ensure
 339     ActionMailer::Base.perform_deliveries = was_enabled
 340   end
 341
 342   private
 343   def initialize_defaults(method_name)
 344     super
 345     @initial_language = current_language
 346     set_language_if_valid Setting.default_language
 347     from Setting.mail_from
 348
 349     # Common headers
 350     headers 'X-Mailer' => 'Redmine',
 351             'X-Redmine-Host' => Setting.host_name,
 352             'X-Redmine-Site' => Setting.app_title,
 353             'Precedence' => 'bulk',
 354             'Auto-Submitted' => 'auto-generated'
 355   end
 356
 357   # Appends a Redmine header field (name is prepended with 'X-Redmine-')
 358   def redmine_headers(h)
 359     h.each { |k,v| headers["X-Redmine-#{k}"] = v }
 360   end
 361
 362   # Overrides the create_mail method
 363   def create_mail
 364     # Removes the current user from the recipients and cc
 365     # if he doesn't want to receive notifications about what he does
 366     @author ||= User.current
 367     if @author.pref[:no_self_notified]
 368       recipients.delete(@author.mail) if recipients
 369       cc.delete(@author.mail) if cc
 370     end
 371
 372     notified_users = [recipients, cc].flatten.compact.uniq
 373     # Rails would log recipients only, not cc and bcc
 374     mylogger.info "Sending email notification to: #{notified_users.join(', ')}" if mylogger
 375
 376     # Blind carbon copy recipients
 377     if Setting.bcc_recipients?
 378       bcc(notified_users)
 379       recipients []
 380       cc []
 381     end
 382     super
 383   end
 384
 385   # Rails 2.3 has problems rendering implicit multipart messages with
 386   # layouts so this method will wrap an multipart messages with
 387   # explicit parts.
 388   #
 389   # https://rails.lighthouseapp.com/projects/8994/tickets/2338-actionmailer-mailer-views-and-content-type
 390   # https://rails.lighthouseapp.com/projects/8994/tickets/1799-actionmailer-doesnt-set-template_format-when-rendering-layouts
 391
 392   def render_multipart(method_name, body)
 393     if Setting.plain_text_mail?
 394       content_type "text/plain"
 395       body render(:file => "#{method_name}.text.plain.rhtml", :body => body, :layout => 'mailer.text.plain.erb')
 396     else
 397       content_type "multipart/alternative"
 398       part :content_type => "text/plain", :body => render(:file => "#{method_name}.text.plain.rhtml", :body => body, :layout => 'mailer.text.plain.erb')
 399       part :content_type => "text/html", :body => render_message("#{method_name}.text.html.rhtml", body)
 400     end
 401   end
 402
 403   # Makes partial rendering work with Rails 1.2 (retro-compatibility)
 404   def self.controller_path
 405     ''
 406   end unless respond_to?('controller_path')
 407
 408   # Returns a predictable Message-Id for the given object
 409   def self.message_id_for(object)
 410     # id + timestamp should reduce the odds of a collision
 411     # as far as we don't send multiple emails for the same object
 412     timestamp = object.send(object.respond_to?(:created_on) ? :created_on : :updated_on)
 413     hash = "redmine.#{object.class.name.demodulize.underscore}-#{object.id}.#{timestamp.strftime("%Y%m%d%H%M%S")}"
 414     host = Setting.mail_from.to_s.gsub(%r{^.*@}, '')
 415     host = "#{::Socket.gethostname}.redmine" if host.empty?
 416     "<#{hash}@#{host}>"
 417   end
 418
 419   private
 420
 421   def message_id(object)
 422     @message_id_object = object
 423   end
 424
 425   def references(object)
 426     @references_objects ||= []
 427     @references_objects << object
 428   end
 429
 430   def mylogger
 431     RAILS_DEFAULT_LOGGER
 432   end
 433 end
 434
 435 # Patch TMail so that message_id is not overwritten
 436 module TMail
 437   class Mail
 438     def add_message_id( fqdn = nil )
 439       self.message_id ||= ::TMail::new_message_id(fqdn)
 440     end
 441   end
 442 end