BigW Consortium Gitlab

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

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

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

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

28 29 30 31 32 33 34 35 36 37 38 39 40 41
  # 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

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

47 48
  private

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

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

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

    address.format
62 63
  end

64 65 66 67 68 69
  # 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
70 71
    @current_user = User.find(recipient_id)
    @current_user.notification_email
72 73
  end

74 75 76 77 78 79 80
  # 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')
81
  #   => "Lorem ipsum"
82 83 84 85 86
  #
  #   # 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')
87
  #   => "Ruby on Rails | Lorem ipsum "
88 89 90
  #
  #   # Accepts multiple arguments
  #   >> subject('Lorem ipsum', 'Dolor sit amet')
91
  #   => "Lorem ipsum | Dolor sit amet"
92
  def subject(*extra)
93
    subject = ""
94
    subject << "#{@project.name} | " if @project
95
    subject << extra.join(' | ') if extra.present?
Fu Xu committed
96
    subject << " | #{Gitlab.config.gitlab.email_subject_suffix}" if Gitlab.config.gitlab.email_subject_suffix.present?
97
    subject
98
  end
99 100 101 102 103 104 105 106 107

  # 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

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

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

115 116
    @reason = headers['X-GitLab-NotificationReason']

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

      headers['Reply-To'] = address

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

127
      @reply_by_email = true
Douwe Maan committed
128 129 130
    end

    mail(headers)
131 132
  end

133 134 135 136 137
  # 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 = {})
138
    headers['Message-ID'] = message_id(model)
139 140 141 142

    mail_thread(model, headers)
  end

143 144 145 146 147 148 149 150
  # 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
151
  def mail_answer_thread(model, headers = {})
152
    headers['Message-ID'] = "<#{SecureRandom.hex}@#{Gitlab.config.gitlab.host}>"
153 154 155
    headers['In-Reply-To'] = message_id(model)
    headers['References'] = message_id(model)

156
    headers[:subject]&.prepend('Re: ')
Douwe Maan committed
157

158
    mail_thread(model, headers)
159
  end
Douwe Maan committed
160

161 162
  def mail_answer_note_thread(model, note, headers = {})
    headers['Message-ID'] = message_id(note)
163 164
    headers['In-Reply-To'] = message_id(note.references.last)
    headers['References'] = note.references.map { |ref| message_id(ref) }
165 166 167 168 169 170 171 172

    headers['X-GitLab-Discussion-ID'] = note.discussion.id if note.part_of_discussion?

    headers[:subject]&.prepend('Re: ')

    mail_thread(model, headers)
  end

Douwe Maan committed
173
  def reply_key
174
    @reply_key ||= SentNotification.reply_key
Douwe Maan committed
175
  end
176 177 178 179 180 181

  def add_project_headers
    return unless @project

    headers['X-GitLab-Project'] = @project.name
    headers['X-GitLab-Project-Id'] = @project.id
182
    headers['X-GitLab-Project-Path'] = @project.full_path
183
  end
184 185 186 187 188 189 190 191 192 193

  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
194
    @unsubscribe_url = unsubscribe_sent_notification_url(@sent_notification)
195
  end
gitlabhq committed
196
end