debian-mirror-gitlab/app/mailers/notify.rb

216 lines
6.6 KiB
Ruby
Raw Normal View History

2018-11-20 20:47:30 +05:30
# frozen_string_literal: true
2015-09-25 12:07:36 +05:30
class Notify < BaseMailer
2014-09-02 18:07:02 +05:30
include ActionDispatch::Routing::PolymorphicRoutes
2017-09-10 17:25:29 +05:30
include GitlabRoutingHelper
2019-02-15 15:39:39 +05:30
include EmailsHelper
2019-07-31 22:56:46 +05:30
include IssuablesHelper
2014-09-02 18:07:02 +05:30
include Emails::Issues
include Emails::MergeRequests
include Emails::Notes
2018-03-17 18:26:18 +05:30
include Emails::PagesDomains
2014-09-02 18:07:02 +05:30
include Emails::Projects
include Emails::Profile
2016-11-03 12:29:30 +05:30
include Emails::Pipelines
include Emails::Members
2018-11-20 20:47:30 +05:30
include Emails::AutoDevops
2019-02-15 15:39:39 +05:30
include Emails::RemoteMirrors
2014-09-02 18:07:02 +05:30
2019-02-15 15:39:39 +05:30
helper MilestonesHelper
2017-08-17 22:00:37 +05:30
helper MergeRequestsHelper
helper DiffHelper
helper BlobHelper
helper EmailsHelper
helper MembersHelper
2018-05-09 12:01:36 +05:30
helper AvatarsHelper
2017-08-17 22:00:37 +05:30
helper GitlabRoutingHelper
2019-07-31 22:56:46 +05:30
helper IssuablesHelper
2015-04-26 12:48:37 +05:30
def test_email(recipient_email, subject, body)
mail(to: recipient_email,
subject: subject,
body: body.html_safe,
content_type: 'text/html'
2015-12-23 02:04:40 +05:30
)
2015-04-26 12:48:37 +05:30
end
# 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
def can_send_from_user_email?(sender)
sender_domain = sender.email.split("@").last
self.class.allowed_email_domains.include?(sender_domain)
end
2015-12-23 02:04:40 +05:30
private
2014-09-02 18:07:02 +05:30
# Return an email address that displays the name of the sender.
# Only the displayed name changes; the actual email address is always the same.
2015-04-26 12:48:37 +05:30
def sender(sender_id, send_from_user_email = false)
return unless sender = User.find(sender_id)
2015-09-11 14:41:01 +05:30
2015-04-26 12:48:37 +05:30
address = default_sender_address
address.display_name = sender.name
if send_from_user_email && can_send_from_user_email?(sender)
address.address = sender.email
2014-09-02 18:07:02 +05:30
end
2015-04-26 12:48:37 +05:30
address.format
2014-09-02 18:07:02 +05:30
end
# 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)
2015-04-26 12:48:37 +05:30
@current_user = User.find(recipient_id)
@current_user.notification_email
2014-09-02 18:07:02 +05:30
end
# 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')
# => "Lorem ipsum"
#
# # 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')
# => "Ruby on Rails | Lorem ipsum "
#
# # Accepts multiple arguments
# >> subject('Lorem ipsum', 'Dolor sit amet')
# => "Lorem ipsum | Dolor sit amet"
def subject(*extra)
2018-11-20 20:47:30 +05:30
subject = []
subject << @project.name if @project
subject << @group.name if @group
subject.concat(extra) if extra.present?
subject << Gitlab.config.gitlab.email_subject_suffix if Gitlab.config.gitlab.email_subject_suffix.present?
subject.join(' | ')
2014-09-02 18:07:02 +05:30
end
# 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
2015-09-25 12:07:36 +05:30
def mail_thread(model, headers = {})
2016-01-29 22:53:50 +05:30
add_project_headers
2017-08-17 22:00:37 +05:30
add_unsubscription_headers_and_links
2015-09-25 12:07:36 +05:30
headers["X-GitLab-#{model.class.name}-ID"] = model.id
2018-12-13 13:39:08 +05:30
headers["X-GitLab-#{model.class.name}-IID"] = model.iid if model.respond_to?(:iid)
headers['X-GitLab-Reply-Key'] = reply_key
2015-09-25 12:07:36 +05:30
2018-03-17 18:26:18 +05:30
@reason = headers['X-GitLab-NotificationReason']
2017-08-17 22:00:37 +05:30
if Gitlab::IncomingEmail.enabled? && @sent_notification
2018-10-15 14:42:47 +05:30
headers['Reply-To'] = Mail::Address.new(Gitlab::IncomingEmail.reply_address(reply_key)).tap do |address|
address.display_name = reply_display_name(model)
end
2015-09-25 12:07:36 +05:30
2019-02-15 15:39:39 +05:30
fallback_reply_message_id = "<reply-#{reply_key}@#{Gitlab.config.gitlab.host}>"
2018-03-17 18:26:18 +05:30
headers['References'] ||= []
2018-11-18 11:00:15 +05:30
headers['References'].unshift(fallback_reply_message_id)
2016-06-02 11:05:42 +05:30
2015-09-25 12:07:36 +05:30
@reply_by_email = true
end
mail(headers)
end
2018-10-15 14:42:47 +05:30
# `model` is used on EE code
def reply_display_name(_model)
@project.full_name
end
2014-09-02 18:07:02 +05:30
# Send an email that starts a new conversation thread,
# with headers suitable for grouping by thread in email clients.
#
# See: mail_answer_thread
2015-09-25 12:07:36 +05:30
def mail_new_thread(model, headers = {})
2014-09-02 18:07:02 +05:30
headers['Message-ID'] = message_id(model)
2015-09-25 12:07:36 +05:30
mail_thread(model, headers)
2014-09-02 18:07:02 +05:30
end
# 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'
#
2015-09-25 12:07:36 +05:30
def mail_answer_thread(model, headers = {})
2015-10-24 18:46:33 +05:30
headers['Message-ID'] = "<#{SecureRandom.hex}@#{Gitlab.config.gitlab.host}>"
2014-09-02 18:07:02 +05:30
headers['In-Reply-To'] = message_id(model)
2018-11-18 11:00:15 +05:30
headers['References'] = [message_id(model)]
2014-09-02 18:07:02 +05:30
2019-02-15 15:39:39 +05:30
headers[:subject] = "Re: #{headers[:subject]}" if headers[:subject]
2014-09-02 18:07:02 +05:30
2015-09-25 12:07:36 +05:30
mail_thread(model, headers)
2014-09-02 18:07:02 +05:30
end
2015-04-26 12:48:37 +05:30
2018-03-17 18:26:18 +05:30
def mail_answer_note_thread(model, note, headers = {})
headers['Message-ID'] = message_id(note)
headers['In-Reply-To'] = message_id(note.references.last)
headers['References'] = note.references.map { |ref| message_id(ref) }
headers['X-GitLab-Discussion-ID'] = note.discussion.id if note.part_of_discussion?
2019-02-15 15:39:39 +05:30
headers[:subject] = "Re: #{headers[:subject]}" if headers[:subject]
2018-03-17 18:26:18 +05:30
mail_thread(model, headers)
end
2015-09-25 12:07:36 +05:30
def reply_key
@reply_key ||= SentNotification.reply_key
2015-04-26 12:48:37 +05:30
end
2016-01-29 22:53:50 +05:30
def add_project_headers
return unless @project
headers['X-GitLab-Project'] = @project.name
headers['X-GitLab-Project-Id'] = @project.id
2017-09-10 17:25:29 +05:30
headers['X-GitLab-Project-Path'] = @project.full_path
2019-02-15 15:39:39 +05:30
headers['List-Id'] = "#{@project.full_path} <#{create_list_id_string(@project)}>"
2016-01-29 22:53:50 +05:30
end
2017-08-17 22:00:37 +05:30
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(',')
@unsubscribe_url = unsubscribe_sent_notification_url(@sent_notification)
end
2014-09-02 18:07:02 +05:30
end