2018-11-20 20:47:30 +05:30
# frozen_string_literal: true
2014-09-02 18:07:02 +05:30
class EmailsOnPushService < Service
2020-03-13 15:44:24 +05:30
include NotificationBranchSelection
2021-04-29 21:17:54 +05:30
RECIPIENTS_LIMIT = 750
2017-08-17 22:00:37 +05:30
boolean_accessor :send_from_committer_email
boolean_accessor :disable_diffs
2020-03-13 15:44:24 +05:30
prop_accessor :recipients , :branches_to_be_notified
2021-04-29 21:17:54 +05:30
validates :recipients , presence : true , if : :validate_recipients?
validate :number_of_recipients_within_limit , if : :validate_recipients?
def self . valid_recipients ( recipients )
recipients . split . select do | recipient |
recipient . include? ( '@' )
end . uniq ( & :downcase )
end
2014-09-02 18:07:02 +05:30
def title
2019-07-31 22:56:46 +05:30
s_ ( 'EmailsOnPushService|Emails on push' )
2014-09-02 18:07:02 +05:30
end
def description
2019-07-31 22:56:46 +05:30
s_ ( 'EmailsOnPushService|Email the commits and diff of each push to a list of recipients.' )
2014-09-02 18:07:02 +05:30
end
2017-08-17 22:00:37 +05:30
def self . to_param
2014-09-02 18:07:02 +05:30
'emails_on_push'
end
2017-08-17 22:00:37 +05:30
def self . supported_events
2015-04-26 12:48:37 +05:30
%w( push tag_push )
end
2020-03-13 15:44:24 +05:30
def initialize_properties
super
self . branches_to_be_notified = 'all' if branches_to_be_notified . nil?
end
2014-09-02 18:07:02 +05:30
def execute ( push_data )
2015-04-26 12:48:37 +05:30
return unless supported_events . include? ( push_data [ :object_kind ] )
2019-10-12 21:52:04 +05:30
return if project . emails_disabled?
2020-03-13 15:44:24 +05:30
return unless notify_for_ref? ( push_data )
2015-04-26 12:48:37 +05:30
EmailsOnPushWorker . perform_async (
2017-08-17 22:00:37 +05:30
project_id ,
recipients ,
push_data ,
send_from_committer_email : send_from_committer_email? ,
disable_diffs : disable_diffs?
2015-04-26 12:48:37 +05:30
)
end
2020-03-13 15:44:24 +05:30
def notify_for_ref? ( push_data )
return true if push_data [ :object_kind ] == 'tag_push'
return true if push_data . dig ( :object_attributes , :tag )
notify_for_branch? ( push_data )
end
2015-04-26 12:48:37 +05:30
def send_from_committer_email?
2017-08-17 22:00:37 +05:30
Gitlab :: Utils . to_boolean ( self . send_from_committer_email )
2015-04-26 12:48:37 +05:30
end
def disable_diffs?
2017-08-17 22:00:37 +05:30
Gitlab :: Utils . to_boolean ( self . disable_diffs )
2014-09-02 18:07:02 +05:30
end
def fields
2015-04-26 12:48:37 +05:30
domains = Notify . allowed_email_domains . map { | domain | " user@ #{ domain } " } . join ( " , " )
2014-09-02 18:07:02 +05:30
[
2019-07-31 22:56:46 +05:30
{ type : 'checkbox' , name : 'send_from_committer_email' , title : s_ ( " EmailsOnPushService|Send from committer " ) ,
2021-04-29 21:17:54 +05:30
help : s_ ( " EmailsOnPushService|Send notifications from the committer's email address if the domain matches the domain used by your GitLab instance (such as %{domains}). " ) % { domains : domains } } ,
2019-07-31 22:56:46 +05:30
{ type : 'checkbox' , name : 'disable_diffs' , title : s_ ( " EmailsOnPushService|Disable code diffs " ) ,
help : s_ ( " EmailsOnPushService|Don't include possibly sensitive code diffs in notification body. " ) } ,
2020-04-22 19:07:51 +05:30
{ type : 'select' , name : 'branches_to_be_notified' , choices : branch_choices } ,
2021-04-29 21:17:54 +05:30
{
type : 'textarea' ,
name : 'recipients' ,
placeholder : s_ ( 'EmailsOnPushService|tanuki@example.com gitlab@example.com' ) ,
help : s_ ( 'EmailsOnPushService|Emails separated by whitespace.' )
}
2014-09-02 18:07:02 +05:30
]
end
2021-04-29 21:17:54 +05:30
private
def number_of_recipients_within_limit
return if recipients . blank?
if self . class . valid_recipients ( recipients ) . size > RECIPIENTS_LIMIT
errors . add ( :recipients , s_ ( " EmailsOnPushService|can't exceed %{recipients_limit} " ) % { recipients_limit : RECIPIENTS_LIMIT } )
end
end
2014-09-02 18:07:02 +05:30
end