Module: EmailsHelper

Includes:
AppearancesHelper, SafeFormatHelper
Included in:
Notify
Defined in:
app/helpers/emails_helper.rb

Instance Method Summary collapse

Methods included from SafeFormatHelper

#safe_format, #tag_pair

Methods included from AppearancesHelper

#appearance_maskable_logo, #appearance_pwa_description, #appearance_pwa_icon_path_scaled, #appearance_pwa_name, #appearance_pwa_short_name, #append_root_path, #brand_header_logo, #brand_image, #brand_image_path, #brand_new_project_guidelines, #brand_profile_image_guidelines, #brand_title, #current_appearance, #custom_sign_in_description, #default_brand_title, #footer_message, #header_message

Methods included from MarkupHelper

#cross_project_reference, #first_line_in_markdown, #link_to_html, #link_to_markdown, #link_to_markdown_field, #markdown, #markdown_field, #markup, #render_wiki_content

Instance Method Details

#action_title(url) ⇒ Object 



16
17
18
19
20
21
22
23
24
25
26
 
# File 'app/helpers/emails_helper.rb', line 16

def action_title(url)
  return unless url

  %w[merge_requests issues commit].each do |action|
    if url.split("/").include?(action)
      return "View #{action.humanize.singularize}"
    end
  end

  nil
end

#admin_changed_password_text(format: nil) ⇒ Object 



228
229
230
231
232
233
234
235
236
237
238
 
# File 'app/helpers/emails_helper.rb', line 228

def admin_changed_password_text(format: nil)
  url = Gitlab.config.gitlab.url

  case format
  when :html
    link_to = generate_link(url, url).html_safe
    _('An administrator changed the password for your GitLab account on %{link_to}.').html_safe % { link_to: link_to }
  else
    _('An administrator changed the password for your GitLab account on %{link_to}.') % { link_to: url }
  end
end

#change_reviewer_notification_text(new_reviewers, previous_reviewers, html_tag = nil) ⇒ Object 



329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
 
# File 'app/helpers/emails_helper.rb', line 329

def change_reviewer_notification_text(new_reviewers, previous_reviewers, html_tag = nil)
  if new_reviewers.empty?
    s_('ChangeReviewer|All reviewers were removed.')
  else
    added_reviewers = new_reviewers - previous_reviewers
    removed_reviewers = previous_reviewers - new_reviewers

    added_reviewers_text = if added_reviewers.any?
                             n_(
                               '%{reviewer_names} was added as a reviewer.',
                               '%{reviewer_names} were added as reviewers.',
                               added_reviewers.size) % {
                                 reviewer_names: format_reviewers_string(added_reviewers, html_tag)
                               }
                           end

    removed_reviewers_text = if removed_reviewers.any?
                               n_(
                                 '%{reviewer_names} was removed from reviewers.',
                                 '%{reviewer_names} were removed from reviewers.',
                                 removed_reviewers.size) % {
                                   reviewer_names: format_reviewers_string(removed_reviewers, html_tag)
                                 }
                             end

    line_delimiter = html_tag.present? ? '<br>' : "\n"

    [added_reviewers_text, removed_reviewers_text].compact.join(line_delimiter).html_safe
  end
end

#closure_reason_text(closed_via, format: nil) ⇒ Object 



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'app/helpers/emails_helper.rb', line 93

def closure_reason_text(closed_via, format: nil)
  case closed_via
  when MergeRequest
    merge_request = MergeRequest.find(closed_via[:id]).present

    return "" unless Ability.allowed?(@recipient, :read_merge_request, merge_request)

    case format
    when :html
      merge_request_link = link_to(merge_request.to_reference, merge_request.web_url)
      _("via merge request %{link}").html_safe % { link: merge_request_link }
    else
      # If it's not HTML nor text then assume it's text to be safe
      _("via merge request %{link}") % { link: "#{merge_request.to_reference} (#{merge_request.web_url})" }
    end
  when String
    # Technically speaking this should be Commit but per
    # https://gitlab.com/gitlab-org/gitlab-foss/merge_requests/15610#note_163812339
    # we can't deserialize Commit without custom serializer for ActiveJob
    return "" unless Ability.allowed?(@recipient, :download_code, @project)

    _("via %{closed_via}") % { closed_via: closed_via }
  else
    ""
  end
end

#contact_your_administrator_text ⇒ Object 



325
326
327
 
# File 'app/helpers/emails_helper.rb', line 325

def contact_your_administrator_text
  _('Please contact your administrator with any questions.')
end

#create_list_id_string(project, list_id_max_length = 255) ⇒ Object 



133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
 
# File 'app/helpers/emails_helper.rb', line 133

def create_list_id_string(project, list_id_max_length = 255)
  project_path_as_domain = project.full_path.downcase
    .split('/').reverse.join('/')
    .gsub(%r{[^a-z0-9\/]}, '-')
    .gsub(%r{\/+}, '.')
    .gsub(/(\A\.+|\.+\z)/, '')

  max_domain_length = list_id_max_length - Gitlab.config.gitlab.host.length - project.id.to_s.length - 2

  if max_domain_length < 3
    return "#{project.id}...#{Gitlab.config.gitlab.host}"
  end

  if project_path_as_domain.length > max_domain_length
    project_path_as_domain = project_path_as_domain.slice(0, max_domain_length)

    last_dot_index = project_path_as_domain[0..-2].rindex(".")
    last_dot_index ||= max_domain_length - 2

    project_path_as_domain = project_path_as_domain.slice(0, last_dot_index).concat("..")
  end

  "#{project.id}.#{project_path_as_domain}.#{Gitlab.config.gitlab.host}"
end

#email_action(url) ⇒ Object

Google Actions developers.google.com/gmail/markup/reference/go-to-action



9
10
11
12
13
14
 
# File 'app/helpers/emails_helper.rb', line 9

def email_action(url)
  name = action_title(url)
  return unless name

  gmail_goto_action(name, url)
end

#email_default_heading(text) ⇒ Object 



80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'app/helpers/emails_helper.rb', line 80

def email_default_heading(text)
  content_tag :h1, text, style: [
    "font-family:'Helvetica Neue',Helvetica,Arial,sans-serif",
    'color:#333333',
    'font-size:18px',
    'font-weight:400',
    'line-height:1.4',
    'padding:0',
    'margin:0',
    'text-align:center'
  ].join(';')
end

#gmail_goto_action(name, url) ⇒ Object 



28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
 
# File 'app/helpers/emails_helper.rb', line 28

def gmail_goto_action(name, url)
  data = {
    "@context" => "http://schema.org",
    "@type" => "EmailMessage",
    "action" => {
      "@type" => "ViewAction",
      "name" => name,
      "url" => url
    }
  }

  content_tag :script, type: 'application/ld+json' do
    data.to_json.html_safe
  end
end

#group_membership_expiration_changed_link(member, group, format: nil) ⇒ Object 



289
290
291
292
293
294
295
296
297
298
299
 
# File 'app/helpers/emails_helper.rb', line 289

def group_membership_expiration_changed_link(member, group, format: nil)
  url = group_group_members_url(group, search: member.user.username)

  case format
  when :html
    link_to = generate_link('group membership', url).html_safe
    _('For additional information, review your %{link_to} or contact your group owner.').html_safe % { link_to: link_to }
  else
    _('For additional information, review your group membership: %{link_to} or contact your group owner.') % { link_to: url }
  end
end

#group_membership_expiration_changed_text(member, group) ⇒ Object 



278
279
280
281
282
283
284
285
286
287
 
# File 'app/helpers/emails_helper.rb', line 278

def group_membership_expiration_changed_text(member, group)
  if member.expires?
    days = (member.expires_at - Date.today).to_i
    days_formatted = pluralize(days, 'day')

    _('Your %{group} membership will now expire in %{days}.') % { group: group.human_name, days: days_formatted }
  else
    _('Your membership in %{group} no longer expires.') % { group: group.human_name }
  end
end

#header_logo ⇒ Object 



65
66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'app/helpers/emails_helper.rb', line 65

def 
  if current_appearance&.header_logo? && !current_appearance..filename.ends_with?('.svg')
    image_tag(
      current_appearance.header_logo_path,
      style: 'height: 50px'
    )
  else
    image_tag(
      image_url('mailers/gitlab_logo.png'),
      size: '55x55',
      alt: 'GitLab'
    )
  end
end

#html_footer_message ⇒ Object 



164
165
166
167
168
 
# File 'app/helpers/emails_helper.rb', line 164

def html_footer_message
  return unless show_footer?

  render_message(:footer_message, style: '')
end

#html_header_message ⇒ Object 



158
159
160
161
162
 
# File 'app/helpers/emails_helper.rb', line 158

def html_header_message
  return unless show_header?

  render_message(:header_message, style: '')
end

#instance_access_request_link(user, format: nil) ⇒ Object 



305
306
307
308
309
310
311
312
313
314
315
 
# File 'app/helpers/emails_helper.rb', line 305

def instance_access_request_link(user, format: nil)
  url = admin_user_url(user)

  case format
  when :html
    user_page = '<a href="%{url}" target="_blank" rel="noopener noreferrer">'.html_safe % { url: url }
    _("Click %{link_start}here%{link_end} to view the request.").html_safe % { link_start: user_page, link_end: '</a>'.html_safe }
  else
    _('Click %{link_to} to view the request.') % { link_to: url }
  end
end

#instance_access_request_text(user, format: nil) ⇒ Object 



301
302
303
 
# File 'app/helpers/emails_helper.rb', line 301

def instance_access_request_text(user, format: nil)
  _('%{username} has asked for a GitLab account on your instance %{host}:').html_safe % { username: sanitize_name(user.name), host: gitlab_host_link(format) }
end

#link_end ⇒ Object 



321
322
323
 
# File 'app/helpers/emails_helper.rb', line 321

def link_end
  '</a>'.html_safe
end

#link_start(url) ⇒ Object 



317
318
319
 
# File 'app/helpers/emails_helper.rb', line 317

def link_start(url)
  '<a href="%{url}" target="_blank" rel="noopener noreferrer">'.html_safe % { url: url }
end

#member_about_to_expire_link(member, member_source, format: nil) ⇒ Object 



259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
 
# File 'app/helpers/emails_helper.rb', line 259

def member_about_to_expire_link(member, member_source, format: nil)
  project_or_group = member_source.human_name

  case member_source
  when Project
    url = project_project_members_url(member_source, search: member.user.username)
  when Group
    url = group_group_members_url(member_source, search: member.user.username)
  end

  case format
  when :html
    link_to = generate_link("#{member_source.class.name.downcase} membership", url).html_safe
    safe_format(_('For additional information, review your %{link_to} or contact your %{project_or_group} owner.'), link_to: link_to, project_or_group: project_or_group)
  else
    _('For additional information, review your %{project_or_group} membership: %{url} or contact your %{project_or_group} owner.') % { project_or_group: project_or_group, url: url }
  end
end

#member_about_to_expire_text(member_source, days_to_expire, format: nil) ⇒ Object 



240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
 
# File 'app/helpers/emails_helper.rb', line 240

def member_about_to_expire_text(member_source, days_to_expire, format: nil)
  days_formatted = pluralize(days_to_expire, 'day')

  case member_source
  when Project
    url = project_url(member_source)
  when Group
    url = group_url(member_source)
  end

  case format
  when :html
    link_to = generate_link(member_source.human_name, url).html_safe
    safe_format(_("Your membership in %{link_to} %{project_or_group_name} will expire in %{days_formatted}."), link_to: link_to, project_or_group_name: member_source.model_name.singular, days_formatted: days_formatted)
  else
    _("Your membership in %{project_or_group} %{project_or_group_name} will expire in %{days_formatted}.") % { project_or_group: member_source.human_name, project_or_group_name: member_source.model_name.singular, days_formatted: days_formatted }
  end
end

#new_email_address_added_text(email) ⇒ Object 



211
212
213
 
# File 'app/helpers/emails_helper.rb', line 211

def new_email_address_added_text(email)
  _('A new email address has been added to your GitLab account: %{email}') % { email: email }
end

#notification_reason_text(reason: nil, show_manage_notifications_link: false, show_help_link: false, manage_label_subscriptions_url: nil, unsubscribe_url: nil, format: :text) ⇒ Object

“You are receiving this email because … on #host. …”



121
122
123
124
125
126
127
128
129
130
131
 
# File 'app/helpers/emails_helper.rb', line 121

def notification_reason_text(reason: nil, show_manage_notifications_link: false, show_help_link: false, manage_label_subscriptions_url: nil, unsubscribe_url: nil, format: :text)
  if unsubscribe_url && show_manage_notifications_link && show_help_link
    notification_reason_text_with_unsubscribe_and_manage_notifications_and_help_links(reason: reason, unsubscribe_url: unsubscribe_url, format: format)
  elsif !reason && manage_label_subscriptions_url && show_help_link
    notification_reason_text_with_manage_label_subscriptions_and_help_links(manage_label_subscriptions_url: manage_label_subscriptions_url, format: format)
  elsif show_manage_notifications_link && show_help_link
    notification_reason_text_with_manage_notifications_and_help_links(reason: reason, format: format)
  else
    notification_reason_text_without_links(reason: reason, format: format)
  end
end

#password_reset_token_valid_time ⇒ Object 



52
53
54
55
56
57
58
59
60
61
62
63
 
# File 'app/helpers/emails_helper.rb', line 52

def password_reset_token_valid_time
  valid_hours = Devise.reset_password_within / 60 / 60
  if valid_hours >= 24
    unit = 'day'
    valid_length = (valid_hours / 24).floor
  else
    unit = 'hour'
    valid_length = valid_hours.floor
  end

  pluralize(valid_length, unit)
end

#re_enable_two_factor_authentication_text(format: nil) ⇒ Object 



198
199
200
201
202
203
204
205
206
207
208
209
 
# File 'app/helpers/emails_helper.rb', line 198

def re_enable_two_factor_authentication_text(format: nil)
  url = profile_two_factor_auth_url

  case format
  when :html
    settings_link_to = generate_link(_('two-factor authentication settings'), url).html_safe
    _("If you want to re-enable two-factor authentication, visit the %{settings_link_to} page.").html_safe % { settings_link_to: settings_link_to }
  else
    _('If you want to re-enable two-factor authentication, visit %{two_factor_link}') %
      { two_factor_link: url }
  end
end

#remove_email_address_text(format: nil) ⇒ Object 



215
216
217
218
219
220
221
222
223
224
225
226
 
# File 'app/helpers/emails_helper.rb', line 215

def remove_email_address_text(format: nil)
  url = profile_emails_url

  case format
  when :html
    settings_link_to = generate_link(_('email address settings'), url).html_safe
    _("If you want to remove this email address, visit the %{settings_link_to} page.").html_safe % { settings_link_to: settings_link_to }
  else
    _('If you want to remove this email address, visit %{profile_link}') %
      { profile_link: url }
  end
end

#sanitize_name(name) ⇒ Object 



44
45
46
47
48
49
50
 
# File 'app/helpers/emails_helper.rb', line 44

def sanitize_name(name)
  if URI::DEFAULT_PARSER.regexp[:URI_REF].match?(name)
    name.tr('.', '_')
  else
    name
  end
end

#say_hello(user) ⇒ Object 



190
191
192
 
# File 'app/helpers/emails_helper.rb', line 190

def say_hello(user)
  _('Hello, %{username}!') % { username: sanitize_name(user.name) }
end

#say_hi(user) ⇒ Object 



186
187
188
 
# File 'app/helpers/emails_helper.rb', line 186

def say_hi(user)
  _('Hi %{username}!') % { username: sanitize_name(user.name) }
end

#service_desk_email_additional_text ⇒ Object 



182
183
184
 
# File 'app/helpers/emails_helper.rb', line 182

def service_desk_email_additional_text
  # overridden on EE
end

#text_footer_message ⇒ Object 



176
177
178
179
180
 
# File 'app/helpers/emails_helper.rb', line 176

def text_footer_message
  return unless show_footer?

  strip_tags(render_message(:footer_message, style: ''))
end

#text_header_message ⇒ Object 



170
171
172
173
174
 
# File 'app/helpers/emails_helper.rb', line 170

def text_header_message
  return unless show_header?

  strip_tags(render_message(:header_message, style: ''))
end

#two_factor_authentication_disabled_text ⇒ Object 



194
195
196
 
# File 'app/helpers/emails_helper.rb', line 194

def two_factor_authentication_disabled_text
  _('Two-factor authentication has been disabled for your GitLab account.')
end