Class: PostAlerter

Inherits:
Object
  • Object
show all
Defined in:
app/services/post_alerter.rb

Constant Summary collapse

USER_BATCH_SIZE = 
100
NOTIFIABLE_TYPES = 
%i[
  mentioned
  replied
  quoted
  posted
  linked
  private_message
  group_mentioned
  watching_first_post
  event_reminder
  event_invitation
].map { |t| Notification.types[t] }

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(default_opts = {}) ⇒ PostAlerter

Returns a new instance of PostAlerter.



89
90
91
 
# File 'app/services/post_alerter.rb', line 89

def initialize(default_opts = {})
  @default_opts = default_opts
end

Class Method Details

.create_notification_alert(user:, post:, notification_type:, excerpt: nil, username: nil) ⇒ Object 



16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
 
# File 'app/services/post_alerter.rb', line 16

def self.create_notification_alert(user:, post:, notification_type:, excerpt: nil, username: nil)
  return if user.suspended?

  if post_url = post.url
    payload = {
      notification_type: notification_type,
      post_number: post.post_number,
      topic_title: post.topic.title,
      topic_id: post.topic.id,
      excerpt:
        excerpt ||
          post.excerpt(
            400,
            text_entities: true,
            strip_links: true,
            remap_emoji: true,
            plain_hashtags: true,
          ),
      username: username || post.username,
      post_url: post_url,
    }

    DiscourseEvent.trigger(:pre_notification_alert, user, payload)

    if user.allow_live_notifications?
      MessageBus.publish("/notification-alert/#{user.id}", payload, user_ids: [user.id])
    end

    push_notification(user, payload)

    # deprecated. use push_notification instead
    DiscourseEvent.trigger(:post_notification_alert, user, payload)
  end
end

.post_created(post, opts = {}) ⇒ Object 



6
7
8
9
 
# File 'app/services/post_alerter.rb', line 6

def self.post_created(post, opts = {})
  PostAlerter.new(opts).after_save_post(post, true)
  post
end

.post_edited(post, opts = {}) ⇒ Object 



11
12
13
14
 
# File 'app/services/post_alerter.rb', line 11

def self.post_edited(post, opts = {})
  PostAlerter.new(opts).after_save_post(post, false)
  post
end

.push_notification(user, payload) ⇒ Object 



51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'app/services/post_alerter.rb', line 51

def self.push_notification(user, payload)
  return if user.do_not_disturb?

  DiscoursePluginRegistry.push_notification_filters.each do |filter|
    return unless filter.call(user, payload)
  end

  if user.push_subscriptions.exists?
    if user.seen_since?(SiteSetting.push_notification_time_window_mins.minutes.ago)
      delay =
        (SiteSetting.push_notification_time_window_mins - (Time.now - user.last_seen_at) / 60)
      Jobs.enqueue_in(delay.minutes, :send_push_notification, user_id: user.id, payload: payload)
    else
      Jobs.enqueue(:send_push_notification, user_id: user.id, payload: payload)
    end
  end

  if SiteSetting.allow_user_api_key_scopes.split("|").include?("push") &&
       SiteSetting.allowed_user_api_push_urls.present?
    clients =
      user
        .user_api_keys
        .joins(:scopes)
        .where("user_api_key_scopes.name IN ('push', 'notifications')")
        .where("push_url IS NOT NULL AND push_url <> ''")
        .where("position(push_url IN ?) > 0", SiteSetting.allowed_user_api_push_urls)
        .where("revoked_at IS NULL")
        .order(client_id: :asc)
        .pluck(:client_id, :push_url)

    if clients.length > 0
      Jobs.enqueue(:push_notification, clients: clients, payload: payload, user_id: user.id)
    end
  end

  DiscourseEvent.trigger(:push_notification, user, payload)
end

Instance Method Details

#after_save_post(post, new_record = false) ⇒ Object 



129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
 
# File 'app/services/post_alerter.rb', line 129

def after_save_post(post, new_record = false)
  notified = [post.user, post.last_editor].uniq

  DiscourseEvent.trigger(:post_alerter_before_mentions, post, new_record, notified)

  # mentions (users/groups)
  mentioned_groups, mentioned_users, mentioned_here = extract_mentions(post)

  if mentioned_groups || mentioned_users || mentioned_here
    mentioned_opts = {}
    editor = post.last_editor

    if post.last_editor_id != post.user_id
      # Mention comes from an edit by someone else, so notification should say who added the mention.
      mentioned_opts = {
        user_id: editor.id,
        original_username: editor.username,
        display_username: editor.username,
      }
    end

    if mentioned_users
      mentioned_users = only_allowed_users(mentioned_users, post)
      mentioned_users = mentioned_users - pm_watching_users(post)
      notified += notify_users(mentioned_users - notified, :mentioned, post, mentioned_opts)
    end

    expand_group_mentions(mentioned_groups, post) do |group, users|
      users = only_allowed_users(users, post)
      to_notify =
        DiscoursePluginRegistry.apply_modifier(
          :expand_group_mention_users,
          users - notified,
          group,
        )

      notified +=
        notify_users(to_notify, :group_mentioned, post, mentioned_opts.merge(group: group))
    end

    if mentioned_here
      users = expand_here_mention(post, exclude_ids: notified.map(&:id))
      users = only_allowed_users(users, post)
      notified += notify_users(users - notified, :mentioned, post, mentioned_opts)
    end
  end

  DiscourseEvent.trigger(:post_alerter_before_replies, post, new_record, notified)

  # replies
  reply_to_user = post.reply_notification_target

  if new_record && notify_about_reply?(post)
    if reply_to_user && !notified.include?(reply_to_user)
      notified += notify_non_pm_users(reply_to_user, :replied, post)
    end

    topic_author = post.topic.user
    if topic_author && !notified.include?(topic_author) &&
         user_watching_topic?(topic_author, post.topic)
      notified += notify_non_pm_users(topic_author, :replied, post)
    end
  end

  DiscourseEvent.trigger(:post_alerter_before_quotes, post, new_record, notified)

  # quotes
  quoted_users = extract_quoted_users(post)
  notified += notify_non_pm_users(quoted_users - notified, :quoted, post)

  DiscourseEvent.trigger(:post_alerter_before_linked, post, new_record, notified)

  # linked
  linked_users = extract_linked_users(post)
  notified += notify_non_pm_users(linked_users - notified, :linked, post)

  DiscourseEvent.trigger(:post_alerter_before_post, post, new_record, notified)

  notified = notified + category_or_tag_muters(post.topic)

  if new_record
    if post.topic.private_message?
      # private messages
      notified += notify_pm_users(post, reply_to_user, quoted_users, notified, new_record)
    elsif notify_about_reply?(post)
      # posts
      notified +=
        notify_post_users(
          post,
          notified,
          new_record: new_record,
          include_category_watchers: false,
          include_tag_watchers: false,
        )
      notified +=
        notify_post_users(
          post,
          notified,
          new_record: new_record,
          include_topic_watchers: false,
          notification_type: :watching_category_or_tag,
        )
    end
  end

  sync_group_mentions(post, mentioned_groups)

  DiscourseEvent.trigger(:post_alerter_before_first_post, post, new_record, notified)

  if new_record && post.post_number == 1
    topic = post.topic

    if topic.present?
      watchers = category_watchers(topic) + tag_watchers(topic) + group_watchers(topic)
      # Notify only users who can see the topic
      watchers &= topic.all_allowed_users.pluck(:id) if post.topic.private_message?
      notified += notify_first_post_watchers(post, watchers, notified)
    end
  end

  DiscourseEvent.trigger(:post_alerter_after_save_post, post, new_record, notified)
end

#all_allowed_users(post) ⇒ Object 



97
98
99
 
# File 'app/services/post_alerter.rb', line 97

def all_allowed_users(post)
  @all_allowed_users ||= post.topic.all_allowed_users.reject { |u| not_allowed?(u, post) }
end

#allowed_group_users(post) ⇒ Object 



105
106
107
 
# File 'app/services/post_alerter.rb', line 105

def allowed_group_users(post)
  @allowed_group_users ||= post.topic.allowed_group_users.reject { |u| not_allowed?(u, post) }
end

#allowed_users(post) ⇒ Object 



101
102
103
 
# File 'app/services/post_alerter.rb', line 101

def allowed_users(post)
  @allowed_users ||= post.topic.allowed_users.reject { |u| not_allowed?(u, post) }
end

#category_or_tag_muters(topic) ⇒ Object 



274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
 
# File 'app/services/post_alerter.rb', line 274

def category_or_tag_muters(topic)
  user_option_condition_sql_fragment =
    if SiteSetting.watched_precedence_over_muted
      "uo.watched_precedence_over_muted IS false"
    else
      "(uo.watched_precedence_over_muted IS NULL OR uo.watched_precedence_over_muted IS false)"
    end

  user_ids_sql = <<~SQL
      SELECT uo.user_id FROM user_options uo
      LEFT JOIN topic_users tus ON tus.user_id = uo.user_id AND tus.topic_id = #{topic.id}
      LEFT JOIN category_users cu ON cu.user_id = uo.user_id AND cu.category_id = #{topic.category_id.to_i}
      LEFT JOIN tag_users tu ON tu.user_id = uo.user_id
      JOIN topic_tags tt ON tt.tag_id = tu.tag_id AND tt.topic_id = #{topic.id}
      WHERE
        (tus.id IS NULL OR tus.notification_level != #{TopicUser.notification_levels[:watching]})
        AND (cu.notification_level = #{CategoryUser.notification_levels[:muted]} OR tu.notification_level = #{TagUser.notification_levels[:muted]})
        AND #{user_option_condition_sql_fragment}
      SQL

  User.where("id IN (#{user_ids_sql})")
end

#category_watchers(topic) ⇒ Object 



267
268
269
270
271
272
 
# File 'app/services/post_alerter.rb', line 267

def category_watchers(topic)
  topic
    .category_users
    .where(notification_level: CategoryUser.notification_levels[:watching_first_post])
    .pluck(:user_id)
end

#create_notification(user, type, post, opts = {}) ⇒ Object 



487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
 
# File 'app/services/post_alerter.rb', line 487

def create_notification(user, type, post, opts = {})
  opts = @default_opts.merge(opts)

  DiscourseEvent.trigger(:before_create_notification, user, type, post, opts)

  return if user.blank? || user.bot? || post.blank?
  return if (topic = post.topic).blank?

  is_liked = type == Notification.types[:liked]
  if is_liked &&
       user.user_option.like_notification_frequency ==
         UserOption.like_notification_frequency_type[:never]
    return
  end

  return if !Guardian.new(user).can_receive_post_notifications?(post)

  return if user.staged? && topic.category&.mailinglist_mirror?

  notifier_id = opts[:user_id] || post.user_id # xxxxx look at revision history
  if notifier_id &&
       UserCommScreener.new(
         acting_user_id: notifier_id,
         target_user_ids: user.id,
       ).ignoring_or_muting_actor?(user.id)
    return
  end

  # skip if muted on the topic
  if TopicUser.where(
       topic: topic,
       user: user,
       notification_level: TopicUser.notification_levels[:muted],
     ).exists?
    return
  end

  # skip if muted on the group
  if group = opts[:group]
    if GroupUser.where(
         group_id: opts[:group_id],
         user_id: user.id,
         notification_level: TopicUser.notification_levels[:muted],
       ).exists?
      return
    end
  end

  existing_notifications =
    user
      .notifications
      .order("notifications.id DESC")
      .where(topic_id: post.topic_id, post_number: post.post_number)
      .limit(10)

  # Don't notify the same user about the same type of notification on the same post
  existing_notification_of_same_type =
    existing_notifications.find { |n| n.notification_type == type }

  if existing_notification_of_same_type &&
       !should_notify_previous?(user, post, existing_notification_of_same_type, opts)
    return
  end

  # linked, quoted, mentioned, chat_quoted may be suppressed if you already have a reply notification
  if [
       Notification.types[:quoted],
       Notification.types[:linked],
       Notification.types[:mentioned],
       Notification.types[:chat_quoted],
     ].include?(type)
    if existing_notifications.find { |n| n.notification_type == Notification.types[:replied] }
      return
    end
  end

  collapsed = false

  if COLLAPSED_NOTIFICATION_TYPES.include?(type)
    destroy_notifications(user, COLLAPSED_NOTIFICATION_TYPES, topic)
    collapsed = true
  end

  original_post = post
  original_username = opts[:display_username].presence || post.username

  if collapsed
    post = first_unread_post(user, topic) || post
    count = unread_count(user, topic)
    if count > 1
      I18n.with_locale(user.effective_locale) do
        opts[:display_username] = I18n.t("embed.replies", count: count)
      end
    end
  end

  UserActionManager.notification_created(original_post, user, type, opts[:acting_user_id])

  topic_title = topic.title
  # when sending a private message email, keep the original title
  if topic.private_message? && modifications = post.revisions.map(&:modifications)
    if first_title_modification = modifications.find { |m| m.has_key?("title") }
      topic_title = first_title_modification["title"][0]
    end
  end

  notification_data = {
    topic_title: topic_title,
    original_post_id: original_post.id,
    original_post_type: original_post.post_type,
    original_username: original_username,
    revision_number: opts[:revision_number],
    display_username: opts[:display_username] || post.user.username,
  }

  opts[:custom_data].each { |k, v| notification_data[k] = v } if opts[:custom_data]&.is_a?(Hash)

  if group = opts[:group]
    notification_data[:group_id] = group.id
    notification_data[:group_name] = group.name
  end

  if opts[:skip_send_email_to]&.include?(user.email)
    skip_send_email = true
  elsif original_post.via_email && (incoming_email = original_post.incoming_email)
    skip_send_email =
      incoming_email.to_addresses_split.include?(user.email) ||
        incoming_email.cc_addresses_split.include?(user.email)
  else
    skip_send_email = opts[:skip_send_email]
  end

  # Create the notification
  notification_data =
    DiscoursePluginRegistry.apply_modifier(:notification_data, notification_data)

  created =
    user.notifications.consolidate_or_create!(
      notification_type: type,
      topic_id: post.topic_id,
      post_number: post.post_number,
      post_action_id: opts[:post_action_id],
      data: notification_data.to_json,
      skip_send_email: skip_send_email,
    )

  if created.id && existing_notifications.empty? && NOTIFIABLE_TYPES.include?(type)
    create_notification_alert(
      user: user,
      post: original_post,
      notification_type: type,
      username: original_username,
    )
  end

  created.id ? created : nil
end

#create_notification_alert(user:, post:, notification_type:, excerpt: nil, username: nil) ⇒ Object 



645
646
647
648
649
650
651
652
653
 
# File 'app/services/post_alerter.rb', line 645

def create_notification_alert(user:, post:, notification_type:, excerpt: nil, username: nil)
  self.class.create_notification_alert(
    user: user,
    post: post,
    notification_type: notification_type,
    excerpt: excerpt,
    username: username,
  )
end

#destroy_notifications(user, types, topic) ⇒ Object 



373
374
375
376
377
378
379
380
381
382
383
 
# File 'app/services/post_alerter.rb', line 373

def destroy_notifications(user, types, topic)
  return if user.blank?
  return unless Guardian.new(user).can_see?(topic)

  User.transaction do
    user.notifications.where(notification_type: types, topic_id: topic.id).destroy_all

    # Reload so notification counts sync up correctly
    user.reload
  end
end

#directly_targeted_users(post) ⇒ Object 



109
110
111
 
# File 'app/services/post_alerter.rb', line 109

def directly_targeted_users(post)
  allowed_users(post) - allowed_group_users(post)
end

#email_using_group_smtp_if_configured(post) ⇒ Object 



835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
 
# File 'app/services/post_alerter.rb', line 835

def email_using_group_smtp_if_configured(post)
  emails_to_skip_send = []
  group = group_notifying_via_smtp(post)
  return emails_to_skip_send if group.blank?

  to_address = nil
  cc_addresses = []

  # We need to use topic_allowed_users here instead of directly_targeted_users
  # because we want to make sure the to_address goes to the OP of the topic.
  topic_allowed_users_by_age =
    post
      .topic
      .topic_allowed_users
      .includes(:user)
      .order(:created_at)
      .reject { |tau| not_allowed?(tau.user, post) }
  return emails_to_skip_send if topic_allowed_users_by_age.empty?

  # This should usually be the OP of the topic, unless they are the one
  # replying by email (they are excluded by not_allowed? then)
  to_address = topic_allowed_users_by_age.first.user.email
  cc_addresses = topic_allowed_users_by_age[1..-1].map { |tau| tau.user.email }
  email_addresses = [to_address, cc_addresses].flatten

  # If any of these email addresses were cc address on the
  # incoming email for the target post, do not send them emails (they
  # already have been notified by the CC on the email)
  if post.incoming_email.present?
    cc_addresses = cc_addresses - post.incoming_email.cc_addresses_split

    # If the to address is one of the recently added CC addresses, then we
    # need to bail early, because otherwise we are sending a notification
    # email to the user who was just added by CC. In this case the OP probably
    # replied and CC'd some people, and they are the only other topic users.
    return if post.incoming_email.cc_addresses_split.include?(to_address)

    # We don't want to create an email storm if someone emails the group and
    # CC's 50 support addresses from various places, which all then respond
    # with auto-responders saying they have received our email. Any auto-generated
    # emails should not propagate notifications to anyone else, not even
    # the regular topic user notifications.
    return email_addresses.dup.uniq if post.incoming_email.is_auto_generated?
  end

  # Send a single email using group SMTP settings to cut down on the
  # number of emails sent via SMTP, also to replicate how support systems
  # and group inboxes generally work in other systems.
  #
  # We need to send this on a delay to allow for editing and finalising
  # posts, the same way we do for private_message user emails/notifications.
  Jobs.enqueue_in(
    SiteSetting.personal_email_time_window_seconds,
    :group_smtp_email,
    group_id: group.id,
    post_id: post.id,
    email: to_address,
    cc_emails: cc_addresses,
  )

  # Add the group's email_username into the array, because it is used for
  # skip_send_email_to in the case of user private message notifications
  # (we do not want the group to be sent any emails from here because it
  # will make another email for IMAP to pick up in the group's mailbox)
  emails_to_skip_send = email_addresses.dup if email_addresses.any?
  emails_to_skip_send << group.email_username
  emails_to_skip_send.uniq
end

#expand_group_mentions(groups, post) ⇒ Object 



659
660
661
662
663
664
665
666
667
668
669
 
# File 'app/services/post_alerter.rb', line 659

def expand_group_mentions(groups, post)
  return unless post.user && groups

  Group
    .mentionable(post.user, include_public: false)
    .where(id: groups.map(&:id))
    .each do |group|
      next if group.user_count >= SiteSetting.max_users_notified_per_group_mention
      yield group, group.users
    end
end

#expand_here_mention(post, exclude_ids: nil) ⇒ Object 



671
672
673
674
675
676
677
678
679
680
681
682
 
# File 'app/services/post_alerter.rb', line 671

def expand_here_mention(post, exclude_ids: nil)
  posts = Post.where(topic_id: post.topic_id)
  posts = posts.where.not(user_id: exclude_ids) if exclude_ids.present?

  if post.user.staff?
    posts = posts.where(post_type: [Post.types[:regular], Post.types[:whisper]])
  else
    posts = posts.where(post_type: Post.types[:regular])
  end

  User.real.where(id: posts.select(:user_id)).limit(SiteSetting.max_here_mentioned)
end

#extract_linked_users(post) ⇒ Object 



720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
 
# File 'app/services/post_alerter.rb', line 720

def extract_linked_users(post)
  users =
    post
      .topic_links
      .where(reflection: false)
      .map do |link|
        linked_post = link.link_post
        if !linked_post && topic = link.link_topic
          linked_post = topic.posts.find_by(post_number: 1)
        end
        (linked_post && post.user_id != linked_post.user_id && linked_post.user) || nil
      end
      .compact

  DiscourseEvent.trigger(:after_extract_linked_users, users, post)

  users
end

#extract_mentions(post) ⇒ Object

TODO: Move to post-analyzer?



685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
 
# File 'app/services/post_alerter.rb', line 685

def extract_mentions(post)
  mentions = post.raw_mentions
  return if mentions.blank?

  groups = Group.where("LOWER(name) IN (?)", mentions)
  mentions -= groups.map(&:name).map(&:downcase)
  groups = nil if groups.empty?

  if mentions.present?
    users =
      User
        .where(username_lower: mentions)
        .includes(:do_not_disturb_timings)
        .where.not(id: post.user_id)
    users = nil if users.empty?
  end

  # @here can be a user mention and then this feature is disabled
  here = mentions.include?(SiteSetting.here_mention) && Guardian.new(post.user).can_mention_here?

  [groups, users, here]
end

#extract_quoted_users(post) ⇒ Object

TODO: Move to post-analyzer? Returns a list of users who were quoted in the post



710
711
712
713
714
715
716
717
718
 
# File 'app/services/post_alerter.rb', line 710

def extract_quoted_users(post)
  usernames =
    if SiteSetting.display_name_on_posts && !SiteSetting.prioritize_username_in_ux
      post.raw.scan(/username:([[:alnum:]]*)"(?=\])/)
    else
      post.raw.scan(/\[quote=\"([^,]+),.+\"\]/)
    end.uniq.map { |q| q.first.strip.downcase }
  User.where.not(id: post.user_id).where(username_lower: usernames)
end

#first_unread_post(user, topic) ⇒ Object 



365
366
367
 
# File 'app/services/post_alerter.rb', line 365

def first_unread_post(user, topic)
  unread_posts(user, topic).order("post_number").first
end

#group_notifying_via_smtp(post) ⇒ Object 



821
822
823
824
825
826
827
828
829
830
831
832
833
 
# File 'app/services/post_alerter.rb', line 821

def group_notifying_via_smtp(post)
  return if !SiteSetting.enable_smtp || post.post_type != Post.types[:regular]
  return if post.topic.allowed_groups.none?

  return post.topic.first_smtp_enabled_group if post.topic.allowed_groups.count == 1

  topic_incoming_email = post.topic.incoming_email.first
  return if topic_incoming_email.blank?

  group = Group.find_by_email(topic_incoming_email.to_addresses)
  return post.topic.first_smtp_enabled_group if !group&.smtp_enabled
  group
end

#group_stats(topic) ⇒ Object 



399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
 
# File 'app/services/post_alerter.rb', line 399

def group_stats(topic)
  sql = <<~SQL
    SELECT COUNT(*) FROM topics t
    JOIN topic_allowed_groups g ON g.group_id = :group_id AND g.topic_id = t.id
    LEFT JOIN group_archived_messages a ON a.topic_id = t.id AND a.group_id = g.group_id
    WHERE a.id IS NULL AND t.deleted_at is NULL AND t.archetype = 'private_message'
  SQL

  topic.allowed_groups.map do |g|
    {
      group_id: g.id,
      group_name: g.name,
      inbox_count: DB.query_single(sql, group_id: g.id).first.to_i,
    }
  end
end

#group_watchers(topic) ⇒ Object 



252
253
254
255
256
257
 
# File 'app/services/post_alerter.rb', line 252

def group_watchers(topic)
  GroupUser.where(
    group_id: topic.allowed_groups.pluck(:group_id),
    notification_level: GroupUser.notification_levels[:watching_first_post],
  ).pluck(:user_id)
end

#indirectly_targeted_users(post) ⇒ Object 



113
114
115
 
# File 'app/services/post_alerter.rb', line 113

def indirectly_targeted_users(post)
  allowed_group_users(post)
end

#not_allowed?(user, post) ⇒ Boolean

Returns:

  • (Boolean) 


93
94
95
 
# File 'app/services/post_alerter.rb', line 93

def not_allowed?(user, post)
  user.blank? || user.bot? || user.id == post.user_id
end

#notify_about_reply?(post) ⇒ Boolean

Returns:

  • (Boolean) 


122
123
124
125
126
127
 
# File 'app/services/post_alerter.rb', line 122

def notify_about_reply?(post)
  # small actions can be whispers in this case they will have an action code
  # we never want to notify on this
  post.post_type == Post.types[:regular] ||
    (post.post_type == Post.types[:whisper] && post.action_code.nil?)
end

#notify_first_post_watchers(post, user_ids, notified = nil) ⇒ Object 



297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
 
# File 'app/services/post_alerter.rb', line 297

def notify_first_post_watchers(post, user_ids, notified = nil)
  return [] if user_ids.blank?
  user_ids.uniq!

  warn_if_not_sidekiq

  # Don't notify the OP and last editor
  user_ids -= [post.user_id, post.last_editor_id]
  users = User.where(id: user_ids).includes(:do_not_disturb_timings)
  users = users.where.not(id: notified.map(&:id)) if notified.present?

  DiscourseEvent.trigger(:before_create_notifications_for_users, users, post)
  each_user_in_batches(users) do |user|
    create_notification(user, Notification.types[:watching_first_post], post)
  end

  users
end

#notify_group_summary(user, topic, acting_user_id: nil) ⇒ Object 



416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
 
# File 'app/services/post_alerter.rb', line 416

def notify_group_summary(user, topic, acting_user_id: nil)
  @group_stats ||= {}
  stats = (@group_stats[topic.id] ||= group_stats(topic))
  return unless stats

  group_id = topic.topic_allowed_groups.where(group_id: user.groups).pick(:group_id)

  stat = stats.find { |s| s[:group_id] == group_id }
  return unless stat

  DistributedMutex.synchronize("group_message_notify_#{user.id}") do
    if stat[:inbox_count] > 0
      Notification.consolidate_or_create!(
        notification_type: Notification.types[:group_message_summary],
        user_id: user.id,
        read: user.id === acting_user_id ? true : false,
        data: {
          group_id: stat[:group_id],
          group_name: stat[:group_name],
          inbox_count: stat[:inbox_count],
          username: user.username_lower,
        }.to_json,
      )
    else
      Notification
        .where(user_id: user.id, notification_type: Notification.types[:group_message_summary])
        .where("data::json ->> 'group_id' = ?", stat[:group_id].to_s)
        .delete_all
    end
  end

  # TODO decide if it makes sense to also publish a desktop notification
end

#notify_non_pm_users(users, type, post, opts = {}) ⇒ Object

Notify a bunch of users



740
741
742
743
744
 
# File 'app/services/post_alerter.rb', line 740

def notify_non_pm_users(users, type, post, opts = {})
  return [] if post.topic&.private_message?

  notify_users(users, type, post, opts)
end

#notify_pm_users(post, reply_to_user, quoted_users, notified, new_record = false) ⇒ Object 



766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
 
# File 'app/services/post_alerter.rb', line 766

def notify_pm_users(post, reply_to_user, quoted_users, notified, new_record = false)
  return [] unless post.topic

  warn_if_not_sidekiq

  # To simplify things and to avoid IMAP double sync issues, and to cut down
  # on emails sent via SMTP, any topic_allowed_users (except those who are
  # not_allowed?) for a group that has SMTP enabled will have their notification
  # email combined into one and sent via a single group SMTP email with CC addresses.
  emails_to_skip_send = email_using_group_smtp_if_configured(post)

  # We create notifications for all directly_targeted_users and email those
  # who do _not_ have their email addresses in the emails_to_skip_send array
  # (which will include all topic allowed users' email addresses if group SMTP
  # is enabled).
  users = directly_targeted_users(post).reject { |u| notified.include?(u) }
  DiscourseEvent.trigger(:before_create_notifications_for_users, users, post)
  users.each do |user|
    if reply_to_user == user || pm_watching_users(post).include?(user) || user.staged?
      create_notification(
        user,
        Notification.types[:private_message],
        post,
        skip_send_email_to: emails_to_skip_send,
      )
    end
  end

  # Users that are part of all mentioned groups. Emails sent by this notification
  # flow will not be sent via group SMTP if it is enabled.
  users = indirectly_targeted_users(post).reject { |u| notified.include?(u) }
  DiscourseEvent.trigger(:before_create_notifications_for_users, users, post)
  users.each do |user|
    case TopicUser.get(post.topic, user)&.notification_level
    when TopicUser.notification_levels[:watching]
      create_pm_notification(user, post, emails_to_skip_send)
    when TopicUser.notification_levels[:tracking]
      # TopicUser is the canonical source of topic notification levels, except for
      # new topics created within a group with default notification level set to
      # `watching_first_post`. TopicUser notification level is set to `tracking`
      # for these.
      if is_replying?(user, reply_to_user, quoted_users) ||
           (new_record && group_watched_first_post?(user, post))
        create_pm_notification(user, post, emails_to_skip_send)
      else
        notify_group_summary(user, post.topic)
      end
    when TopicUser.notification_levels[:regular]
      if is_replying?(user, reply_to_user, quoted_users)
        create_pm_notification(user, post, emails_to_skip_send)
      end
    end
  end
end

#notify_post_users(post, notified, group_ids: nil, include_topic_watchers: true, include_category_watchers: true, include_tag_watchers: true, new_record: false, notification_type: nil) ⇒ Object 



904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
 
# File 'app/services/post_alerter.rb', line 904

def notify_post_users(
  post,
  notified,
  group_ids: nil,
  include_topic_watchers: true,
  include_category_watchers: true,
  include_tag_watchers: true,
  new_record: false,
  notification_type: nil
)
  return [] unless post.topic

  warn_if_not_sidekiq

  condition = +<<~SQL
    users.id IN (
      SELECT id FROM users WHERE false
      /*topic*/
      /*category*/
      /*tags*/
    )
  SQL
  condition.sub! "/*topic*/", <<~SQL if include_topic_watchers
      UNION
      SELECT user_id
        FROM topic_users
       WHERE notification_level = :watching
         AND topic_id = :topic_id
    SQL

  condition.sub! "/*category*/", <<~SQL if include_category_watchers
      UNION

      SELECT cu.user_id
        FROM category_users cu
   LEFT JOIN topic_users tu ON tu.user_id = cu.user_id
                           AND tu.topic_id = :topic_id
       WHERE cu.notification_level = :watching
         AND cu.category_id = :category_id
         AND (tu.user_id IS NULL OR tu.notification_level = :watching)
    SQL

  tag_ids = post.topic.topic_tags.pluck("topic_tags.tag_id")

  condition.sub! "/*tags*/", <<~SQL if include_tag_watchers && tag_ids.present?
      UNION

      SELECT tag_users.user_id
        FROM tag_users
   LEFT JOIN topic_users tu ON tu.user_id = tag_users.user_id
                           AND tu.topic_id = :topic_id
   LEFT JOIN tag_group_memberships tgm ON tag_users.tag_id = tgm.tag_id
   LEFT JOIN tag_group_permissions tgp ON tgm.tag_group_id = tgp.tag_group_id
   LEFT JOIN group_users gu ON gu.user_id = tag_users.user_id
       WHERE (
          tgp.group_id IS NULL OR
          tgp.group_id = gu.group_id OR
          tgp.group_id = :everyone_group_id OR
          gu.group_id = :staff_group_id
        )
             AND (tag_users.notification_level = :watching
                  AND tag_users.tag_id IN (:tag_ids)
                  AND (tu.user_id IS NULL OR tu.notification_level = :watching))
    SQL

  notify =
    User.where(
      condition,
      watching: TopicUser.notification_levels[:watching],
      topic_id: post.topic_id,
      category_id: post.topic.category_id,
      tag_ids: tag_ids,
      staff_group_id: Group::AUTO_GROUPS[:staff],
      everyone_group_id: Group::AUTO_GROUPS[:everyone],
    )

  if group_ids.present?
    notify = notify.joins(:group_users).where("group_users.group_id IN (?)", group_ids)
  end

  notify = notify.where(staged: false).staff if post.topic.private_message?

  exclude_user_ids = notified.map(&:id)
  notify = notify.where("users.id NOT IN (?)", exclude_user_ids) if exclude_user_ids.present?

  DiscourseEvent.trigger(:before_create_notifications_for_users, notify, post)

  already_seen_user_ids =
    Set.new(
      TopicUser
        .where(topic_id: post.topic.id)
        .where("last_read_post_number >= ?", post.post_number)
        .pluck(:user_id),
    )

  each_user_in_batches(notify) do |user|
    calculated_type =
      if !new_record && already_seen_user_ids.include?(user.id)
        Notification.types[:edited]
      elsif notification_type
        Notification.types[notification_type]
      else
        Notification.types[:posted]
      end
    opts = {}
    opts[:display_username] = post.last_editor.username if calculated_type ==
      Notification.types[:edited]
    create_notification(user, calculated_type, post, opts)
  end

  notify
end

#notify_users(users, type, post, opts = {}) ⇒ Object 



746
747
748
749
750
751
752
753
754
755
756
 
# File 'app/services/post_alerter.rb', line 746

def notify_users(users, type, post, opts = {})
  users = [users] unless users.is_a?(Array)
  users.reject!(&:staged?) if post.topic&.private_message?

  warn_if_not_sidekiq

  DiscourseEvent.trigger(:before_create_notifications_for_users, users, post)
  users.each { |u| create_notification(u, Notification.types[type], post, opts) }

  users
end

#only_allowed_users(users, post) ⇒ Object 



117
118
119
120
 
# File 'app/services/post_alerter.rb', line 117

def only_allowed_users(users, post)
  return users unless post.topic.private_message?
  users.select { |u| all_allowed_users(post).include?(u) }
end

#pm_watching_users(post) ⇒ Object 



758
759
760
761
762
763
764
 
# File 'app/services/post_alerter.rb', line 758

def pm_watching_users(post)
  return [] if !post.topic.private_message?
  directly_targeted_users(post).filter do |u|
    notification_level = TopicUser.get(post.topic, u)&.notification_level
    notification_level == TopicUser.notification_levels[:watching]
  end
end

#push_notification(user, payload) ⇒ Object 



655
656
657
 
# File 'app/services/post_alerter.rb', line 655

def push_notification(user, payload)
  self.class.push_notification(user, payload)
end

#should_notify_edit?(notification, post, opts) ⇒ Boolean

Returns:

  • (Boolean) 


450
451
452
453
454
 
# File 'app/services/post_alerter.rb', line 450

def should_notify_edit?(notification, post, opts)
  notification.created_at < 1.day.ago ||
    notification.data_hash["display_username"] !=
      (opts[:display_username].presence || post.user.username)
end

#should_notify_like?(user, notification) ⇒ Boolean

Returns:

  • (Boolean) 


456
457
458
459
460
461
462
463
464
465
466
467
 
# File 'app/services/post_alerter.rb', line 456

def should_notify_like?(user, notification)
  if user.user_option.like_notification_frequency ==
       UserOption.like_notification_frequency_type[:always]
    return true
  end
  if user.user_option.like_notification_frequency ==
       UserOption.like_notification_frequency_type[:first_time_and_daily] &&
       notification.created_at < 1.day.ago
    return true
  end
  false
end

#should_notify_previous?(user, post, notification, opts) ⇒ Boolean

Returns:

  • (Boolean) 


469
470
471
472
473
474
475
476
477
478
 
# File 'app/services/post_alerter.rb', line 469

def should_notify_previous?(user, post, notification, opts)
  case notification.notification_type
  when Notification.types[:edited]
    should_notify_edit?(notification, post, opts)
  when Notification.types[:liked]
    should_notify_like?(user, notification)
  else
    false
  end
end

#sync_group_mentions(post, mentioned_groups) ⇒ Object 



316
317
318
319
320
321
322
323
324
325
326
327
328
329
 
# File 'app/services/post_alerter.rb', line 316

def sync_group_mentions(post, mentioned_groups)
  GroupMention.where(post_id: post.id).destroy_all
  return if mentioned_groups.blank?

  now = Time.zone.now

  # insert_all instead of insert_all! since multiple post_alert jobs might be
  # running concurrently
  GroupMention.insert_all(
    mentioned_groups.map do |group|
      { post_id: post.id, group_id: group.id, created_at: now, updated_at: now }
    end,
  )
end

#tag_watchers(topic) ⇒ Object 



259
260
261
262
263
264
265
 
# File 'app/services/post_alerter.rb', line 259

def tag_watchers(topic)
  topic
    .tag_users
    .notification_level_visible([TagUser.notification_levels[:watching_first_post]])
    .distinct(:user_id)
    .pluck(:user_id)
end

#unread_count(user, topic) ⇒ Object 



369
370
371
 
# File 'app/services/post_alerter.rb', line 369

def unread_count(user, topic)
  unread_posts(user, topic).count
end

#unread_posts(user, topic) ⇒ Object 



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
359
360
361
362
363
 
# File 'app/services/post_alerter.rb', line 331

def unread_posts(user, topic)
  Post
    .secured(Guardian.new(user))
    .where(
      "post_number > COALESCE((
             SELECT last_read_post_number FROM topic_users tu
             WHERE tu.user_id = ? AND tu.topic_id = ? ),0)",
      user.id,
      topic.id,
    )
    .where(
      "reply_to_user_id = :user_id
      OR exists(SELECT 1 from topic_users tu
                WHERE tu.user_id = :user_id AND
                  tu.topic_id = :topic_id AND
                  notification_level = :topic_level)
      OR exists(SELECT 1 from category_users cu
                WHERE cu.user_id = :user_id AND
                  cu.category_id = :category_id AND
                  notification_level = :category_level)
      OR exists(SELECT 1 from tag_users tu
                WHERE tu.user_id = :user_id AND
                  tu.tag_id IN (SELECT tag_id FROM topic_tags WHERE topic_id = :topic_id) AND
                  notification_level = :tag_level)",
      user_id: user.id,
      topic_id: topic.id,
      category_id: topic.category_id,
      topic_level: TopicUser.notification_levels[:watching],
      category_level: CategoryUser.notification_levels[:watching],
      tag_level: TagUser.notification_levels[:watching],
    )
    .where(topic_id: topic.id)
end

#warn_if_not_sidekiq ⇒ Object 



1017
1018
1019
1020
1021
1022
1023
 
# File 'app/services/post_alerter.rb', line 1017

def warn_if_not_sidekiq
  unless Sidekiq.server?
    Rails.logger.warn(
      "PostAlerter.#{caller_locations(1, 1)[0].label} was called outside of sidekiq",
    )
  end
end