Class: SystemMessage

Inherits:
Object
  • Object
show all
Defined in:
lib/system_message.rb

Overview

Handle sending a message to a user from the system.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(recipient) ⇒ SystemMessage

Returns a new instance of SystemMessage.



15
16
17
# File 'lib/system_message.rb', line 15

def initialize(recipient)
  @recipient = recipient
end

Class Method Details

.create(recipient, type, params = {}) ⇒ Object



6
7
8
# File 'lib/system_message.rb', line 6

def self.create(recipient, type, params = {})
  self.new(recipient).create(type, params)
end

.create_from_system_user(recipient, type, params = {}) ⇒ Object



10
11
12
13
# File 'lib/system_message.rb', line 10

def self.create_from_system_user(recipient, type, params = {})
  params = params.merge(from_system: true)
  self.new(recipient).create(type, params)
end

Instance Method Details

#create(type, params = {}) ⇒ Object

Raises:

  • (StandardError)


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
50
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
88
89
90
# File 'lib/system_message.rb', line 19

def create(type, params = {})
  method_params = params.dup

  from_system = params.delete(:from_system)
  target_group_names = params.delete(:target_group_names)

  params = defaults.merge(params)

  title =
    params[:message_title] ||
      I18n.with_locale(@recipient.effective_locale) do
        I18n.t("system_messages.#{type}.subject_template", params)
      end
  raw =
    params[:message_raw] ||
      I18n.with_locale(@recipient.effective_locale) do
        I18n.t("system_messages.#{type}.text_body_template", params)
      end

  if from_system
    user = Discourse.system_user
  else
    user = Discourse.site_contact_user
    target_group_names =
      (
        if Group.exists?(name: SiteSetting.site_contact_group_name)
          SiteSetting.site_contact_group_name
        else
          nil
        end
      )
  end

  post_creator_args = [
    user,
    title: title,
    raw: raw,
    archetype: Archetype.private_message,
    target_usernames: @recipient.username,
    target_group_names: target_group_names,
    subtype: TopicSubtype.system_message,
    skip_validations: true,
    post_alert_options: params[:post_alert_options],
  ]

  DiscourseEvent.trigger(
    :before_system_message_sent,
    message_type: type,
    recipient: @recipient,
    post_creator_args: post_creator_args,
    params: method_params,
  )

  creator = PostCreator.new(*post_creator_args)

  post = I18n.with_locale(@recipient.effective_locale) { creator.create }

  DiscourseEvent.trigger(
    :system_message_sent,
    post: post,
    message_type: type,
    recipient: @recipient,
  )

  raise StandardError, creator.errors.full_messages.join(" ") if creator.errors.present?

  unless from_system
    UserArchivedMessage.create!(user: Discourse.site_contact_user, topic: post.topic)
  end

  post
end

#defaultsObject



92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
# File 'lib/system_message.rb', line 92

def defaults
  {
    site_name: SiteSetting.title,
    username: @recipient.username,
    name: @recipient.name,
    name_or_username: @recipient.name.presence || @recipient.username,
    user_preferences_url: "#{@recipient.full_url}/preferences",
    new_user_tips:
      I18n.with_locale(@recipient.effective_locale) do
        I18n.t("system_messages.usage_tips.text_body_template", base_url: Discourse.base_url)
      end,
    site_password: "",
    base_url: Discourse.base_url,
  }
end