Class: Promotion

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

Overview

Check whether a user is ready for a new trust level.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(user) ⇒ Promotion

Returns a new instance of Promotion.



7
8
9
# File 'lib/promotion.rb', line 7

def initialize(user)
  @user = user
end

Class Method Details

.recalculate(user, performed_by = nil, use_previous_trust_level: false) ⇒ Object

Figure out what a user’s trust level should be from scratch



135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
# File 'lib/promotion.rb', line 135

def self.recalculate(user, performed_by = nil, use_previous_trust_level: false)
  granted_trust_level =
    TrustLevel.calculate(user, use_previous_trust_level: use_previous_trust_level) ||
      TrustLevel[0]

  # TrustLevel.calculate always returns a value, however we added extra protection just
  # in case this changes
  user.update_column(:trust_level, TrustLevel[granted_trust_level])

  return if user.manual_locked_trust_level.present?

  promotion = Promotion.new(user)

  promotion.review_tl0 if granted_trust_level < TrustLevel[1]
  promotion.review_tl1 if granted_trust_level < TrustLevel[2]
  promotion.review_tl2 if granted_trust_level < TrustLevel[3]

  if user.trust_level == TrustLevel[3] && Promotion.tl3_lost?(user)
    user.change_trust_level!(TrustLevel[2], log_action_for: performed_by || Discourse.system_user)
  end
end

.tl1_met?(user) ⇒ Boolean

Returns:

  • (Boolean)


116
117
118
119
120
121
122
123
124
# File 'lib/promotion.rb', line 116

def self.tl1_met?(user)
  stat = user.user_stat
  return false if stat.topics_entered < SiteSetting.tl1_requires_topics_entered
  return false if stat.posts_read_count < SiteSetting.tl1_requires_read_posts
  return false if (stat.time_read / 60) < SiteSetting.tl1_requires_time_spent_mins
  return false if ((Time.now - user.created_at) / 60) < SiteSetting.tl1_requires_time_spent_mins

  true
end

.tl2_met?(user) ⇒ Boolean

Returns:

  • (Boolean)


102
103
104
105
106
107
108
109
110
111
112
113
114
# File 'lib/promotion.rb', line 102

def self.tl2_met?(user)
  stat = user.user_stat
  return false if stat.topics_entered < SiteSetting.tl2_requires_topics_entered
  return false if stat.posts_read_count < SiteSetting.tl2_requires_read_posts
  return false if (stat.time_read / 60) < SiteSetting.tl2_requires_time_spent_mins
  return false if ((Time.now - user.created_at) / 60) < SiteSetting.tl2_requires_time_spent_mins
  return false if stat.days_visited < SiteSetting.tl2_requires_days_visited
  return false if stat.likes_received < SiteSetting.tl2_requires_likes_received
  return false if stat.likes_given < SiteSetting.tl2_requires_likes_given
  return false if stat.calc_topic_reply_count! < SiteSetting.tl2_requires_topic_reply_count

  true
end

.tl3_lost?(user) ⇒ Boolean

Returns:

  • (Boolean)


130
131
132
# File 'lib/promotion.rb', line 130

def self.tl3_lost?(user)
  TrustLevel3Requirements.new(user).requirements_lost?
end

.tl3_met?(user) ⇒ Boolean

Returns:

  • (Boolean)


126
127
128
# File 'lib/promotion.rb', line 126

def self.tl3_met?(user)
  TrustLevel3Requirements.new(user).requirements_met?
end

Instance Method Details

#change_trust_level!(level, opts = {}) ⇒ Object



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
91
92
93
94
95
96
97
98
99
100
# File 'lib/promotion.rb', line 49

def change_trust_level!(level, opts = {})
  raise "Invalid trust level #{level}" unless TrustLevel.valid?(level)

  old_level = @user.trust_level
  new_level = level

  if new_level < old_level && @user.manual_locked_trust_level.nil?
    next_up = new_level + 1
    key = "tl#{next_up}_met?"
    if self.class.respond_to?(key) && self.class.public_send(key, @user)
      raise Discourse::InvalidAccess.new,
            I18n.t(
              "trust_levels.change_failed_explanation",
              user_name: @user.name,
              new_trust_level: new_level,
              current_trust_level: old_level,
            )
    end
  end

  admin = opts && opts[:log_action_for]

  @user.trust_level = new_level
  @user..bio_raw_will_change! # So it can get re-cooked based on the new trust level

  @user.transaction do
    if admin
      StaffActionLogger.new(admin).log_trust_level_change(@user, old_level, new_level)
    else
      UserHistory.create!(
        action: UserHistory.actions[:auto_trust_level_change],
        target_user_id: @user.id,
        previous_value: old_level,
        new_value: new_level,
      )
    end
    @user.skip_email_validation = true
    @user.save!
    @user..recook_bio
    @user..save!
    DiscourseEvent.trigger(
      :user_promoted,
      user_id: @user.id,
      new_trust_level: new_level,
      old_trust_level: old_level,
    )
    Group.user_trust_level_change!(@user.id, @user.trust_level)
    BadgeGranter.queue_badge_grant(Badge::Trigger::TrustLevelChange, user: @user)
  end

  true
end

#reviewObject

Review a user for a promotion. Delegates work to a review_#trust_level method. Returns true if the user was promoted, false otherwise.



13
14
15
16
17
18
19
20
21
22
23
24
# File 'lib/promotion.rb', line 13

def review
  # nil users are never promoted
  return false if @user.blank? || !@user.manual_locked_trust_level.nil?

  # Promotion beyond basic requires some expensive queries, so don't do that here.
  return false if @user.trust_level >= TrustLevel[2]

  review_method = :"review_tl#{@user.trust_level}"
  return public_send(review_method) if respond_to?(review_method)

  false
end

#review_tl0Object



26
27
28
29
30
31
32
33
34
35
# File 'lib/promotion.rb', line 26

def review_tl0
  if Promotion.tl1_met?(@user) && change_trust_level!(TrustLevel[1])
    if Badge.exists?(id: Badge::BasicUser, enabled: true) &&
         !@user.badges.exists?(id: Badge::BasicUser)
      @user.enqueue_member_welcome_message
    end
    return true
  end
  false
end

#review_tl1Object



37
38
39
40
41
42
43
# File 'lib/promotion.rb', line 37

def review_tl1
  if Promotion.tl2_met?(@user) && change_trust_level!(TrustLevel[2])
    @user.enqueue_tl2_promotion_message
    return true
  end
  false
end

#review_tl2Object



45
46
47
# File 'lib/promotion.rb', line 45

def review_tl2
  Promotion.tl3_met?(@user) && change_trust_level!(TrustLevel[3])
end