notification_service.rb 13.7 KB
Newer Older
1 2
# NotificationService class
#
J
Johannes Schleifenbaum 已提交
3
# Used for notifying users with emails about different events
4 5 6 7 8 9 10
#
# Ex.
#   NotificationService.new.new_issue(issue, current_user)
#
class NotificationService
  # Always notify user about ssh key added
  # only if ssh key is not deploy key
11 12 13
  #
  # This is security email so it will be sent
  # even if user disabled notifications
14 15
  def new_key(key)
    if key.user
D
Dmitriy Zaporozhets 已提交
16
      mailer.new_ssh_key_email(key.id)
17 18 19
    end
  end

20 21 22 23 24 25 26
  # Always notify user about email added to profile
  def new_email(email)
    if email.user
      mailer.new_email_email(email.id)
    end
  end

27 28
  # When create an issue we should send next emails:
  #
29
  #  * issue assignee if their notification level is not Disabled
30 31 32
  #  * project team members with notification level higher then Participating
  #
  def new_issue(issue, current_user)
I
Izaak Alpert 已提交
33
    new_resource_email(issue, issue.project, 'new_issue_email')
34 35 36
  end

  # When we close an issue we should send next emails:
37
  #
38 39
  #  * issue author if their notification level is not Disabled
  #  * issue assignee if their notification level is not Disabled
40 41 42
  #  * project team members with notification level higher then Participating
  #
  def close_issue(issue, current_user)
I
Izaak Alpert 已提交
43
    close_resource_email(issue, issue.project, current_user, 'closed_issue_email')
44 45 46 47
  end

  # When we reassign an issue we should send next emails:
  #
48 49
  #  * issue old assignee if their notification level is not Disabled
  #  * issue new assignee if their notification level is not Disabled
50 51
  #
  def reassigned_issue(issue, current_user)
I
Izaak Alpert 已提交
52
    reassign_resource_email(issue, issue.project, current_user, 'reassigned_issue_email')
53 54
  end

55 56 57

  # When create a merge request we should send next emails:
  #
58
  #  * mr assignee if their notification level is not Disabled
59 60
  #
  def new_merge_request(merge_request, current_user)
I
Izaak Alpert 已提交
61
    new_resource_email(merge_request, merge_request.target_project, 'new_merge_request_email')
62
  end
63 64 65

  # When we reassign a merge_request we should send next emails:
  #
66 67
  #  * merge_request old assignee if their notification level is not Disabled
  #  * merge_request assignee if their notification level is not Disabled
68 69
  #
  def reassigned_merge_request(merge_request, current_user)
I
Izaak Alpert 已提交
70
    reassign_resource_email(merge_request, merge_request.target_project, current_user, 'reassigned_merge_request_email')
71
  end
72

73 74
  # When we close a merge request we should send next emails:
  #
75 76
  #  * merge_request author if their notification level is not Disabled
  #  * merge_request assignee if their notification level is not Disabled
77 78
  #  * project team members with notification level higher then Participating
  #
79
  def close_mr(merge_request, current_user)
I
Izaak Alpert 已提交
80
    close_resource_email(merge_request, merge_request.target_project, current_user, 'closed_merge_request_email')
81 82
  end

83 84 85 86
  def reopen_issue(issue, current_user)
    reopen_resource_email(issue, issue.project, current_user, 'issue_status_changed_email', 'reopened')
  end

87 88
  # When we merge a merge request we should send next emails:
  #
89 90
  #  * merge_request author if their notification level is not Disabled
  #  * merge_request assignee if their notification level is not Disabled
91 92
  #  * project team members with notification level higher then Participating
  #
93
  def merge_mr(merge_request, current_user)
94
    recipients = reject_muted_users([merge_request.author, merge_request.assignee], merge_request.target_project)
V
tests  
Valery Sizov 已提交
95 96
    recipients = add_subscribed_users(recipients, merge_request)
    recipients = reject_unsubscribed_users(recipients, merge_request)
I
Izaak Alpert 已提交
97
    recipients = recipients.concat(project_watchers(merge_request.target_project)).uniq
98
    recipients.delete(current_user)
99 100

    recipients.each do |recipient|
101
      mailer.merged_merge_request_email(recipient.id, merge_request.id, current_user.id)
102 103 104
    end
  end

M
Marin Jankovski 已提交
105 106 107 108
  def reopen_mr(merge_request, current_user)
    reopen_resource_email(merge_request, merge_request.target_project, current_user, 'merge_request_status_email', 'reopened')
  end

109
  # Notify new user with email after creation
110
  def new_user(user, token = nil)
J
Johannes Schleifenbaum 已提交
111
    # Don't email omniauth created users
112
    mailer.new_user_email(user.id, token) unless user.identities.any?
113 114 115 116 117 118 119
  end

  # Notify users on new note in system
  #
  # TODO: split on methods and refactor
  #
  def new_note(note)
120 121
    return true unless note.noteable_type.present?

122
    # ignore gitlab service messages
123
    return true if note.note.start_with?('Status changed to closed')
124
    return true if note.cross_reference? && note.system == true
125

126
    target = note.noteable
127

128
    recipients = []
129

D
Douwe Maan 已提交
130 131
    # Add all users participating in the thread (author, assignee, comment authors)
    participants = 
132 133 134
      if target.is_a?(Commit)
        target.participants(note.project)
      elsif target.respond_to?(:participants)
D
Douwe Maan 已提交
135
        target.participants
D
Douwe Maan 已提交
136
      else
D
Douwe Maan 已提交
137
        note.mentioned_users
D
Douwe Maan 已提交
138 139
      end
    recipients = recipients.concat(participants)
140 141 142 143

    # Merge project watchers
    recipients = recipients.concat(project_watchers(note.project)).compact.uniq

D
Douwe Maan 已提交
144 145 146
    # Reject users with Mention notification level, except those mentioned in _this_ note.
    recipients = reject_mention_users(recipients - note.mentioned_users, note.project)
    recipients = recipients + note.mentioned_users
147

148
    # Reject mutes users
149
    recipients = reject_muted_users(recipients, note.project)
150

V
Valery Sizov 已提交
151 152 153 154
    recipients = add_subscribed_users(recipients, note.noteable)
    
    recipients = reject_unsubscribed_users(recipients, note.noteable)

155 156 157 158 159 160 161
    # Reject author
    recipients.delete(note.author)

    # build notify method like 'note_commit_email'
    notify_method = "note_#{note.noteable_type.underscore}_email".to_sym

    recipients.each do |recipient|
D
Dmitriy Zaporozhets 已提交
162
      mailer.send(notify_method, recipient.id, note.id)
163 164
    end
  end
165

D
Douwe Maan 已提交
166 167 168 169 170 171 172 173
  def invite_project_member(project_member, token)
    mailer.project_member_invited_email(project_member.id, token)
  end

  def accept_project_invite(project_member)
    mailer.project_invite_accepted_email(project_member.id)
  end

D
Douwe Maan 已提交
174 175 176 177
  def decline_project_invite(project_member)
    mailer.project_invite_declined_email(project_member.project.id, project_member.invite_email, project_member.access_level, project_member.created_by_id)
  end

178
  def new_project_member(project_member)
179
    mailer.project_access_granted_email(project_member.id)
180 181
  end

182
  def update_project_member(project_member)
183
    mailer.project_access_granted_email(project_member.id)
184
  end
185

D
Douwe Maan 已提交
186 187 188 189 190 191 192 193
  def invite_group_member(group_member, token)
    mailer.group_member_invited_email(group_member.id, token)
  end

  def accept_group_invite(group_member)
    mailer.group_invite_accepted_email(group_member.id)
  end

D
Douwe Maan 已提交
194 195 196 197
  def decline_group_invite(group_member)
    mailer.group_invite_declined_email(group_member.group.id, group_member.invite_email, group_member.access_level, group_member.created_by_id)
  end

198 199
  def new_group_member(group_member)
    mailer.group_access_granted_email(group_member.id)
200 201
  end

202 203
  def update_group_member(group_member)
    mailer.group_access_granted_email(group_member.id)
204 205
  end

206 207 208 209 210 211 212 213 214
  def project_was_moved(project)
    recipients = project.team.members
    recipients = reject_muted_users(recipients, project)

    recipients.each do |recipient|
      mailer.project_was_moved_email(project.id, recipient.id)
    end
  end

215 216
  protected

217 218
  # Get project users with WATCH notification level
  def project_watchers(project)
219
    project_members = project_member_notification(project)
220

221
    users_with_project_level_global = project_member_notification(project, Notification::N_GLOBAL)
222
    users_with_group_level_global = group_member_notification(project, Notification::N_GLOBAL)
223
    users = users_with_global_level_watch([users_with_project_level_global, users_with_group_level_global].flatten.uniq)
224

225
    users_with_project_setting = select_project_member_setting(project, users_with_project_level_global, users)
226
    users_with_group_setting = select_group_member_setting(project, project_members, users_with_group_level_global, users)
227

228
    User.where(id: users_with_project_setting.concat(users_with_group_setting).uniq).to_a
229 230
  end

231
  def project_member_notification(project, notification_level=nil)
232
    project_members = project.project_members
233

234 235 236 237 238
    if notification_level
      project_members.where(notification_level: notification_level).pluck(:user_id)
    else
      project_members.pluck(:user_id)
    end
239 240
  end

241
  def group_member_notification(project, notification_level)
242
    if project.group
243
      project.group.group_members.where(notification_level: notification_level).pluck(:user_id)
244 245
    else
      []
246
    end
247
  end
248

249 250 251 252 253 254 255 256
  def users_with_global_level_watch(ids)
    User.where(
      id: ids,
      notification_level: Notification::N_WATCH
    ).pluck(:id)
  end

  # Build a list of users based on project notifcation settings
257 258
  def select_project_member_setting(project, global_setting, users_global_level_watch)
    users = project_member_notification(project, Notification::N_WATCH)
259

260 261 262 263
    # If project setting is global, add to watch list if global setting is watch
    global_setting.each do |user_id|
      if users_global_level_watch.include?(user_id)
        users << user_id
264 265
      end
    end
266 267

    users
268 269
  end

S
Steven Burgart 已提交
270
  # Build a list of users based on group notification settings
271 272
  def select_group_member_setting(project, project_members, global_setting, users_global_level_watch)
    uids = group_member_notification(project, Notification::N_WATCH)
273 274 275 276 277 278

    # Group setting is watch, add to users list if user is not project member
    users = []
    uids.each do |user_id|
      if project_members.exclude?(user_id)
        users << user_id
279 280 281
      end
    end

282 283 284 285
    # Group setting is global, add to users list if global setting is watch
    global_setting.each do |user_id|
      if project_members.exclude?(user_id) && users_global_level_watch.include?(user_id)
        users << user_id
286 287 288
      end
    end

289
    users
290 291
  end

292 293
  # Remove users with disabled notifications from array
  # Also remove duplications and nil recipients
294
  def reject_muted_users(users, project = nil)
D
Dmitriy Zaporozhets 已提交
295
    users = users.to_a.compact.uniq
296
    users = users.reject(&:blocked?)
297 298 299 300

    users.reject do |user|
      next user.notification.disabled? unless project

D
Douwe Maan 已提交
301
      member = project.project_members.find_by(user_id: user.id)
302

D
Douwe Maan 已提交
303 304
      if !member && project.group
        member = project.group.group_members.find_by(user_id: user.id)
305 306
      end

307
      # reject users who globally disabled notification and has no membership
D
Douwe Maan 已提交
308
      next user.notification.disabled? unless member
309 310

      # reject users who disabled notification in project
D
Douwe Maan 已提交
311
      next true if member.notification.disabled?
312 313

      # reject users who have N_GLOBAL in project and disabled in global settings
D
Douwe Maan 已提交
314
      member.notification.global? && user.notification.disabled?
315 316 317
    end
  end

318 319 320 321 322 323 324
  # Remove users with notification level 'Mentioned'
  def reject_mention_users(users, project = nil)
    users = users.to_a.compact.uniq

    users.reject do |user|
      next user.notification.mention? unless project

D
Douwe Maan 已提交
325
      member = project.project_members.find_by(user_id: user.id)
326

D
Douwe Maan 已提交
327 328
      if !member && project.group
        member = project.group.group_members.find_by(user_id: user.id)
329 330 331
      end

      # reject users who globally set mention notification and has no membership
D
Douwe Maan 已提交
332
      next user.notification.mention? unless member
333 334

      # reject users who set mention notification in project
D
Douwe Maan 已提交
335
      next true if member.notification.mention?
336 337

      # reject users who have N_MENTION in project and disabled in global settings
D
Douwe Maan 已提交
338
      member.notification.global? && user.notification.mention?
339 340 341
    end
  end

V
Valery Sizov 已提交
342
  def reject_unsubscribed_users(recipients, target)
V
Valery Sizov 已提交
343 344
    return recipients unless target.respond_to? :subscriptions
    
V
Valery Sizov 已提交
345
    recipients.reject do |user|
346 347
      subscription = target.subscriptions.find_by_user_id(user.id)
      subscription && !subscription.subscribed
V
Valery Sizov 已提交
348 349 350
    end
  end

V
Valery Sizov 已提交
351 352 353 354 355 356
  def add_subscribed_users(recipients, target)
    return recipients unless target.respond_to? :subscriptions

    subscriptions = target.subscriptions

    if subscriptions.any?
V
tests  
Valery Sizov 已提交
357
      recipients + subscriptions.where(subscribed: true).map(&:user)
V
Valery Sizov 已提交
358 359 360 361 362
    else
      recipients
    end
  end
  
I
Izaak Alpert 已提交
363
  def new_resource_email(target, project, method)
364
    recipients = build_recipients(target, project)
365 366 367
    recipients.delete(target.author)

    recipients.each do |recipient|
D
Dmitriy Zaporozhets 已提交
368
      mailer.send(method, recipient.id, target.id)
369 370 371
    end
  end

I
Izaak Alpert 已提交
372
  def close_resource_email(target, project, current_user, method)
373
    recipients = build_recipients(target, project)
374 375 376
    recipients.delete(current_user)

    recipients.each do |recipient|
D
Dmitriy Zaporozhets 已提交
377
      mailer.send(method, recipient.id, target.id, current_user.id)
378 379 380
    end
  end

I
Izaak Alpert 已提交
381
  def reassign_resource_email(target, project, current_user, method)
382
    assignee_id_was = previous_record(target, "assignee_id")
383
    recipients = build_recipients(target, project)
384 385
    recipients.delete(current_user)

386
    recipients.each do |recipient|
387
      mailer.send(method, recipient.id, target.id, assignee_id_was, current_user.id)
388 389
    end
  end
D
Dmitriy Zaporozhets 已提交
390

391
  def reopen_resource_email(target, project, current_user, method, status)
392 393 394 395 396 397 398 399 400 401
    recipients = build_recipients(target, project)
    recipients.delete(current_user)

    recipients.each do |recipient|
      mailer.send(method, recipient.id, target.id, status, current_user.id)
    end
  end

  def build_recipients(target, project)
    recipients =
402 403 404 405 406 407
      if target.respond_to?(:participants)
        target.participants
      else
        [target.author, target.assignee]
      end

408
    recipients = reject_muted_users(recipients, project)
409
    recipients = reject_mention_users(recipients, project)
V
Valery Sizov 已提交
410
    recipients = add_subscribed_users(recipients, target)
411
    recipients = recipients.concat(project_watchers(project)).uniq
V
Valery Sizov 已提交
412
    recipients = reject_unsubscribed_users(recipients, target)
413
    recipients
414 415
  end

D
Dmitriy Zaporozhets 已提交
416 417 418
  def mailer
    Notify.delay
  end
419 420 421 422

  def previous_record(object, attribute)
    if object && attribute
      if object.previous_changes.include?(attribute)
M
Marin Jankovski 已提交
423
        object.previous_changes[attribute].first
424 425 426
      end
    end
  end
427
end