BigW Consortium Gitlab

notify.rb 5.59 KB
Newer Older
1
class Notify < BaseMailer
2 3
  include ActionDispatch::Routing::PolymorphicRoutes

4 5 6 7
  include Emails::Issues
  include Emails::MergeRequests
  include Emails::Notes
  include Emails::Projects
8
  include Emails::Profile
9
  include Emails::Pipelines
10
  include Emails::Members
11

12 13 14 15 16 17
  helper MergeRequestsHelper
  helper DiffHelper
  helper BlobHelper
  helper EmailsHelper
  helper MembersHelper
  helper GitlabRoutingHelper
gitlabhq committed
18

Steven Burgart committed
19 20
  def test_email(recipient_email, subject, body)
    mail(to: recipient_email,
21 22 23
         subject: subject,
         body: body.html_safe,
         content_type: 'text/html'
24
        )
25 26
  end

27 28 29 30 31 32 33 34 35 36 37 38 39 40
  # Splits "gitlab.corp.company.com" up into "gitlab.corp.company.com",
  # "corp.company.com" and "company.com".
  # Respects set tld length so "company.co.uk" won't match "somethingelse.uk"
  def self.allowed_email_domains
    domain_parts = Gitlab.config.gitlab.host.split(".")
    allowed_domains = []
    begin
      allowed_domains << domain_parts.join(".")
      domain_parts.shift
    end while domain_parts.length > ActionDispatch::Http::URL.tld_length

    allowed_domains
  end

41 42 43 44 45
  def can_send_from_user_email?(sender)
    sender_domain = sender.email.split("@").last
    self.class.allowed_email_domains.include?(sender_domain)
  end

46 47
  private

48 49
  # Return an email address that displays the name of the sender.
  # Only the displayed name changes; the actual email address is always the same.
50
  def sender(sender_id, send_from_user_email = false)
51
    return unless sender = User.find(sender_id)
52

53 54
    address = default_sender_address
    address.display_name = sender.name
55

56 57
    if send_from_user_email && can_send_from_user_email?(sender)
      address.address = sender.email
58
    end
59 60

    address.format
61 62
  end

63 64 65 66 67 68
  # Look up a User by their ID and return their email address
  #
  # recipient_id - User ID
  #
  # Returns a String containing the User's email address.
  def recipient(recipient_id)
Douwe Maan committed
69 70
    @current_user = User.find(recipient_id)
    @current_user.notification_email
71 72
  end

73 74 75 76 77 78 79
  # Formats arguments into a String suitable for use as an email subject
  #
  # extra - Extra Strings to be inserted into the subject
  #
  # Examples
  #
  #   >> subject('Lorem ipsum')
80
  #   => "Lorem ipsum"
81 82 83 84 85
  #
  #   # Automatically inserts Project name when @project is set
  #   >> @project = Project.last
  #   => #<Project id: 1, name: "Ruby on Rails", path: "ruby_on_rails", ...>
  #   >> subject('Lorem ipsum')
86
  #   => "Ruby on Rails | Lorem ipsum "
87 88 89
  #
  #   # Accepts multiple arguments
  #   >> subject('Lorem ipsum', 'Dolor sit amet')
90
  #   => "Lorem ipsum | Dolor sit amet"
91
  def subject(*extra)
92
    subject = ""
93
    subject << "#{@project.name} | " if @project
94
    subject << extra.join(' | ') if extra.present?
Fu Xu committed
95
    subject << " | #{Gitlab.config.gitlab.email_subject_suffix}" if Gitlab.config.gitlab.email_subject_suffix.present?
96
    subject
97
  end
98 99 100 101 102 103 104 105 106

  # Return a string suitable for inclusion in the 'Message-Id' mail header.
  #
  # The message-id is generated from the unique URL to a model object.
  def message_id(model)
    model_name = model.class.model_name.singular_route_key
    "<#{model_name}_#{model.id}@#{Gitlab.config.gitlab.host}>"
  end

107
  def mail_thread(model, headers = {})
108
    add_project_headers
109 110
    add_unsubscription_headers_and_links

Douwe Maan committed
111
    headers["X-GitLab-#{model.class.name}-ID"] = model.id
112
    headers['X-GitLab-Reply-Key'] = reply_key
Douwe Maan committed
113

Douwe Maan committed
114
    if Gitlab::IncomingEmail.enabled? && @sent_notification
115
      address = Mail::Address.new(Gitlab::IncomingEmail.reply_address(reply_key))
116 117 118 119
      address.display_name = @project.name_with_namespace

      headers['Reply-To'] = address

120 121 122 123
      fallback_reply_message_id = "<reply-#{reply_key}@#{Gitlab.config.gitlab.host}>".freeze
      headers['References'] ||= ''
      headers['References'] << ' ' << fallback_reply_message_id

124
      @reply_by_email = true
Douwe Maan committed
125 126 127
    end

    mail(headers)
128 129
  end

130 131 132 133 134
  # Send an email that starts a new conversation thread,
  # with headers suitable for grouping by thread in email clients.
  #
  # See: mail_answer_thread
  def mail_new_thread(model, headers = {})
135
    headers['Message-ID'] = message_id(model)
136 137 138 139

    mail_thread(model, headers)
  end

140 141 142 143 144 145 146 147
  # Send an email that responds to an existing conversation thread,
  # with headers suitable for grouping by thread in email clients.
  #
  # For grouping emails by thread, email clients heuristics require the answers to:
  #
  #  * have a subject that begin by 'Re: '
  #  * have a 'In-Reply-To' or 'References' header that references the original 'Message-ID'
  #
Douwe Maan committed
148
  def mail_answer_thread(model, headers = {})
149
    headers['Message-ID'] = "<#{SecureRandom.hex}@#{Gitlab.config.gitlab.host}>"
150 151 152
    headers['In-Reply-To'] = message_id(model)
    headers['References'] = message_id(model)

153
    headers[:subject]&.prepend('Re: ')
Douwe Maan committed
154

155
    mail_thread(model, headers)
156
  end
Douwe Maan committed
157

Douwe Maan committed
158
  def reply_key
159
    @reply_key ||= SentNotification.reply_key
Douwe Maan committed
160
  end
161 162 163 164 165 166 167 168

  def add_project_headers
    return unless @project

    headers['X-GitLab-Project'] = @project.name
    headers['X-GitLab-Project-Id'] = @project.id
    headers['X-GitLab-Project-Path'] = @project.path_with_namespace
  end
169 170 171 172 173 174 175 176 177 178

  def add_unsubscription_headers_and_links
    return unless !@labels_url && @sent_notification && @sent_notification.unsubscribable?

    list_unsubscribe_methods = [unsubscribe_sent_notification_url(@sent_notification, force: true)]
    if Gitlab::IncomingEmail.enabled? && Gitlab::IncomingEmail.supports_wildcard?
      list_unsubscribe_methods << "mailto:#{Gitlab::IncomingEmail.unsubscribe_address(reply_key)}"
    end

    headers['List-Unsubscribe'] = list_unsubscribe_methods.map { |e| "<#{e}>" }.join(',')
Douwe Maan committed
179
    @unsubscribe_url = unsubscribe_sent_notification_url(@sent_notification)
180
  end
gitlabhq committed
181
end