mirror of
https://github.com/discourse/discourse.git
synced 2024-11-29 12:13:58 -06:00
1833b43ae2
Upon saving a badge or requesting a badge result preview, BadgeGranter.contract_checks! will examine the provided badge SQL for some contractual obligations - namely, the returned columns and use of trigger parameters. Saving the badge is wrapped in a transaction to make this easier, by raising ActiveRecord::Rollback on a detected violation. On the client, a modal view is added for the badge query sample run results, named admin-badge-preview. The preview action is moved up to the route. The save action, on failure, triggers a 'saveError' action (also in the route). The preview action gains a new parameter, 'explain', which will give the output of an EXPLAIN query for the badge sql, which can be used by forum admins to estimate the cost of their badge queries. The preview link is replaced by two links, one which omits (false) and includes (true) the EXPLAIN query. The Badge.save() method is amended to propogate errors. Badge::Trigger gets some utility methods for use in the BadgeGranter.contract_checks! method. Additionally, extra checks outside of BadgeGranter.contract_checks! are added in the preview() method, to cover cases of null granted_at columns. An uninitialized variable path is removed in the backfill() method. TODO - it would be nice to be able to get the actual names of all columns the provided query returns, so we could give more errors
281 lines
7.3 KiB
Ruby
281 lines
7.3 KiB
Ruby
class Badge < ActiveRecord::Base
|
|
# badge ids
|
|
Welcome = 5
|
|
NicePost = 6
|
|
GoodPost = 7
|
|
GreatPost = 8
|
|
Autobiographer = 9
|
|
Editor = 10
|
|
FirstLike = 11
|
|
FirstShare = 12
|
|
FirstFlag = 13
|
|
FirstLink = 14
|
|
FirstQuote = 15
|
|
ReadGuidelines = 16
|
|
Reader = 17
|
|
|
|
# other consts
|
|
AutobiographerMinBioLength = 10
|
|
|
|
def self.trigger_hash
|
|
Hash[*(
|
|
Badge::Trigger.constants.map{|k|
|
|
[k.to_s.underscore, Badge::Trigger.const_get(k)]
|
|
}.flatten
|
|
)]
|
|
end
|
|
|
|
module Trigger
|
|
None = 0
|
|
PostAction = 1
|
|
PostRevision = 2
|
|
TrustLevelChange = 4
|
|
UserChange = 8
|
|
|
|
def self.is_none?(trigger)
|
|
[0].include? trigger
|
|
end
|
|
|
|
def self.uses_user_ids?(trigger)
|
|
[4, 8].include? trigger
|
|
end
|
|
|
|
def self.uses_post_ids?(trigger)
|
|
[1, 2].include? trigger
|
|
end
|
|
end
|
|
|
|
module Queries
|
|
|
|
Reader = <<SQL
|
|
SELECT id user_id, current_timestamp granted_at
|
|
FROM users
|
|
WHERE id IN
|
|
(
|
|
SELECT pt.user_id
|
|
FROM post_timings pt
|
|
JOIN badge_posts b ON b.post_number = pt.post_number AND
|
|
b.topic_id = pt.topic_id
|
|
JOIN topics t ON t.id = pt.topic_id
|
|
LEFT JOIN user_badges ub ON ub.badge_id = 17 AND ub.user_id = pt.user_id
|
|
WHERE ub.id IS NULL AND t.posts_count > 100
|
|
GROUP BY pt.user_id, pt.topic_id, t.posts_count
|
|
HAVING count(*) = t.posts_count
|
|
)
|
|
SQL
|
|
|
|
ReadGuidelines = <<SQL
|
|
SELECT user_id, read_faq granted_at
|
|
FROM user_stats
|
|
WHERE read_faq IS NOT NULL AND (user_id IN (:user_ids) OR :backfill)
|
|
SQL
|
|
|
|
FirstQuote = <<SQL
|
|
SELECT ids.user_id, q.post_id, q.created_at granted_at
|
|
FROM
|
|
(
|
|
SELECT p1.user_id, MIN(q1.id) id
|
|
FROM quoted_posts q1
|
|
JOIN badge_posts p1 ON p1.id = q1.post_id
|
|
JOIN badge_posts p2 ON p2.id = q1.quoted_post_id
|
|
WHERE (:backfill OR ( p1.id IN (:post_ids) ))
|
|
GROUP BY p1.user_id
|
|
) ids
|
|
JOIN quoted_posts q ON q.id = ids.id
|
|
SQL
|
|
|
|
FirstLink = <<SQL
|
|
SELECT l.user_id, l.post_id, l.created_at granted_at
|
|
FROM
|
|
(
|
|
SELECT MIN(l1.id) id
|
|
FROM topic_links l1
|
|
JOIN badge_posts p1 ON p1.id = l1.post_id
|
|
JOIN badge_posts p2 ON p2.id = l1.link_post_id
|
|
WHERE NOT reflection AND p1.topic_id <> p2.topic_id AND not quote AND
|
|
(:backfill OR ( p1.id in (:post_ids) ))
|
|
GROUP BY l1.user_id
|
|
) ids
|
|
JOIN topic_links l ON l.id = ids.id
|
|
SQL
|
|
|
|
FirstShare = <<SQL
|
|
SELECT views.user_id, i2.post_id, i2.created_at granted_at
|
|
FROM
|
|
(
|
|
SELECT i.user_id, MIN(i.id) i_id
|
|
FROM incoming_links i
|
|
JOIN badge_posts p on p.id = i.post_id
|
|
WHERE i.user_id IS NOT NULL
|
|
GROUP BY i.user_id
|
|
) as views
|
|
JOIN incoming_links i2 ON i2.id = views.i_id
|
|
SQL
|
|
|
|
FirstFlag = <<SQL
|
|
SELECT pa1.user_id, pa1.created_at granted_at, pa1.post_id
|
|
FROM (
|
|
SELECT pa.user_id, min(pa.id) id
|
|
FROM post_actions pa
|
|
JOIN badge_posts p on p.id = pa.post_id
|
|
WHERE post_action_type_id IN (#{PostActionType.flag_types.values.join(",")}) AND
|
|
(:backfill OR pa.post_id IN (:post_ids) )
|
|
GROUP BY pa.user_id
|
|
) x
|
|
JOIN post_actions pa1 on pa1.id = x.id
|
|
SQL
|
|
|
|
FirstLike = <<SQL
|
|
SELECT pa1.user_id, pa1.created_at granted_at, pa1.post_id
|
|
FROM (
|
|
SELECT pa.user_id, min(pa.id) id
|
|
FROM post_actions pa
|
|
JOIN badge_posts p on p.id = pa.post_id
|
|
WHERE post_action_type_id = 2 AND
|
|
(:backfill OR pa.post_id IN (:post_ids) )
|
|
GROUP BY pa.user_id
|
|
) x
|
|
JOIN post_actions pa1 on pa1.id = x.id
|
|
SQL
|
|
|
|
# Incorrect, but good enough - (earlies post edited vs first edit)
|
|
Editor = <<SQL
|
|
SELECT p.user_id, min(p.id) post_id, min(p.created_at) granted_at
|
|
FROM badge_posts p
|
|
WHERE p.self_edits > 0 AND
|
|
(:backfill OR p.id IN (:post_ids) )
|
|
GROUP BY p.user_id
|
|
SQL
|
|
|
|
Welcome = <<SQL
|
|
SELECT p.user_id, min(post_id) post_id, min(pa.created_at) granted_at
|
|
FROM post_actions pa
|
|
JOIN badge_posts p on p.id = pa.post_id
|
|
WHERE post_action_type_id = 2 AND
|
|
(:backfill OR pa.post_id IN (:post_ids) )
|
|
GROUP BY p.user_id
|
|
SQL
|
|
|
|
Autobiographer = <<SQL
|
|
SELECT u.id user_id, current_timestamp granted_at
|
|
FROM users u
|
|
JOIN user_profiles up on u.id = up.user_id
|
|
WHERE bio_raw IS NOT NULL AND LENGTH(TRIM(bio_raw)) > #{Badge::AutobiographerMinBioLength} AND
|
|
uploaded_avatar_id IS NOT NULL AND
|
|
(:backfill OR u.id IN (:user_ids) )
|
|
SQL
|
|
|
|
def self.like_badge(count)
|
|
# we can do better with dates, but its hard work
|
|
"
|
|
SELECT p.user_id, p.id post_id, p.updated_at granted_at
|
|
FROM badge_posts p
|
|
WHERE p.like_count >= #{count.to_i} AND
|
|
(:backfill OR p.id IN (:post_ids) )
|
|
"
|
|
end
|
|
|
|
def self.trust_level(level)
|
|
# we can do better with dates, but its hard work figuring this out historically
|
|
"
|
|
SELECT u.id user_id, current_timestamp granted_at FROM users u
|
|
WHERE trust_level >= #{level.to_i} AND (
|
|
:backfill OR u.id IN (:user_ids)
|
|
)
|
|
"
|
|
end
|
|
end
|
|
|
|
belongs_to :badge_type
|
|
belongs_to :badge_grouping
|
|
|
|
has_many :user_badges, dependent: :destroy
|
|
|
|
validates :name, presence: true, uniqueness: true
|
|
validates :badge_type, presence: true
|
|
validates :allow_title, inclusion: [true, false]
|
|
validates :multiple_grant, inclusion: [true, false]
|
|
|
|
scope :enabled, ->{ where(enabled: true) }
|
|
|
|
before_create :ensure_not_system
|
|
|
|
# fields that can not be edited on system badges
|
|
def self.protected_system_fields
|
|
[:badge_type_id, :multiple_grant, :target_posts, :show_posts, :query, :trigger, :auto_revoke, :listable]
|
|
end
|
|
|
|
|
|
def self.trust_level_badge_ids
|
|
(1..4).to_a
|
|
end
|
|
|
|
def self.like_badge_counts
|
|
@like_badge_counts ||= {
|
|
NicePost => 10,
|
|
GoodPost => 25,
|
|
GreatPost => 50
|
|
}
|
|
end
|
|
|
|
def reset_grant_count!
|
|
self.grant_count = UserBadge.where(badge_id: id).count
|
|
save!
|
|
end
|
|
|
|
def single_grant?
|
|
!self.multiple_grant?
|
|
end
|
|
|
|
def default_name=(val)
|
|
self.name ||= val
|
|
end
|
|
|
|
def default_allow_title=(val)
|
|
self.allow_title ||= val
|
|
end
|
|
|
|
def default_badge_grouping_id=(val)
|
|
# allow to correct orphans
|
|
if !self.badge_grouping_id || self.badge_grouping_id < 0
|
|
self.badge_grouping_id = val
|
|
end
|
|
end
|
|
|
|
protected
|
|
def ensure_not_system
|
|
unless id
|
|
self.id = [Badge.maximum(:id) + 1, 100].max
|
|
end
|
|
end
|
|
end
|
|
|
|
# == Schema Information
|
|
#
|
|
# Table name: badges
|
|
#
|
|
# id :integer not null, primary key
|
|
# name :string(255) not null
|
|
# description :text
|
|
# badge_type_id :integer not null
|
|
# grant_count :integer default(0), not null
|
|
# created_at :datetime not null
|
|
# updated_at :datetime not null
|
|
# allow_title :boolean default(FALSE), not null
|
|
# multiple_grant :boolean default(FALSE), not null
|
|
# icon :string(255) default("fa-certificate")
|
|
# listable :boolean default(TRUE)
|
|
# target_posts :boolean default(FALSE)
|
|
# query :text
|
|
# enabled :boolean default(TRUE), not null
|
|
# auto_revoke :boolean default(TRUE), not null
|
|
# badge_grouping_id :integer default(5), not null
|
|
# trigger :integer
|
|
# show_posts :boolean default(FALSE), not null
|
|
# system :boolean default(FALSE), not null
|
|
#
|
|
# Indexes
|
|
#
|
|
# index_badges_on_name (name) UNIQUE
|
|
#
|