2017-01-11 01:18:48 +08:00
|
|
|
require_dependency 'slug'
|
|
|
|
|
2014-03-05 20:52:20 +08:00
|
|
|
class Badge < ActiveRecord::Base
|
2016-06-13 21:37:14 +08:00
|
|
|
# NOTE: These badge ids are not in order! They are grouped logically.
|
|
|
|
# When picking an id, *search* for it.
|
2016-04-06 03:12:02 +08:00
|
|
|
|
2017-02-20 21:35:05 +08:00
|
|
|
BasicUser = 1
|
|
|
|
Member = 2
|
|
|
|
Regular = 3
|
|
|
|
Leader = 4
|
|
|
|
|
2014-07-03 15:29:44 +08:00
|
|
|
Welcome = 5
|
|
|
|
NicePost = 6
|
|
|
|
GoodPost = 7
|
|
|
|
GreatPost = 8
|
|
|
|
Autobiographer = 9
|
2014-07-07 15:55:25 +08:00
|
|
|
Editor = 10
|
2018-10-19 21:30:27 +08:00
|
|
|
WikiEditor = 48
|
2016-04-06 03:12:02 +08:00
|
|
|
|
2014-07-09 10:17:39 +08:00
|
|
|
FirstLike = 11
|
|
|
|
FirstShare = 12
|
|
|
|
FirstFlag = 13
|
2014-07-10 09:18:02 +08:00
|
|
|
FirstLink = 14
|
2014-07-11 12:17:01 +08:00
|
|
|
FirstQuote = 15
|
2016-04-06 03:12:02 +08:00
|
|
|
FirstMention = 40
|
|
|
|
FirstEmoji = 41
|
2016-04-13 02:09:59 +08:00
|
|
|
FirstOnebox = 42
|
2016-06-13 21:37:14 +08:00
|
|
|
FirstReplyByEmail = 43
|
2016-04-06 03:12:02 +08:00
|
|
|
|
2014-07-16 14:26:22 +08:00
|
|
|
ReadGuidelines = 16
|
2014-07-15 13:16:41 +08:00
|
|
|
Reader = 17
|
2014-09-11 10:36:37 +08:00
|
|
|
NiceTopic = 18
|
|
|
|
GoodTopic = 19
|
|
|
|
GreatTopic = 20
|
2014-09-11 11:10:37 +08:00
|
|
|
NiceShare = 21
|
|
|
|
GoodShare = 22
|
|
|
|
GreatShare = 23
|
2017-04-29 00:20:05 +08:00
|
|
|
Anniversary = 24
|
2016-03-17 01:48:14 +08:00
|
|
|
|
2015-05-15 10:04:41 +08:00
|
|
|
Promoter = 25
|
|
|
|
Campaigner = 26
|
|
|
|
Champion = 27
|
2016-03-17 01:48:14 +08:00
|
|
|
|
2015-08-28 00:52:31 +08:00
|
|
|
PopularLink = 28
|
|
|
|
HotLink = 29
|
|
|
|
FamousLink = 30
|
2016-03-17 01:48:14 +08:00
|
|
|
|
2016-03-17 01:03:17 +08:00
|
|
|
Appreciated = 36
|
|
|
|
Respected = 37
|
2016-03-16 02:14:10 +08:00
|
|
|
Admired = 31
|
2016-03-17 01:48:14 +08:00
|
|
|
|
2016-03-17 00:31:26 +08:00
|
|
|
OutOfLove = 33
|
2016-03-17 23:42:22 +08:00
|
|
|
HigherLove = 34
|
2016-03-17 00:31:26 +08:00
|
|
|
CrazyInLove = 35
|
2015-05-15 10:04:41 +08:00
|
|
|
|
2016-03-17 01:48:14 +08:00
|
|
|
ThankYou = 38
|
|
|
|
GivesBack = 32
|
|
|
|
Empathetic = 39
|
|
|
|
|
2017-09-07 04:35:08 +08:00
|
|
|
Enthusiast = 45
|
|
|
|
Aficionado = 46
|
|
|
|
Devotee = 47
|
|
|
|
|
2017-04-01 04:30:30 +08:00
|
|
|
NewUserOfTheMonth = 44
|
2017-03-31 03:19:51 +08:00
|
|
|
|
2014-07-03 15:29:44 +08:00
|
|
|
# other consts
|
|
|
|
AutobiographerMinBioLength = 10
|
|
|
|
|
2017-10-30 13:21:05 +08:00
|
|
|
# used by serializer
|
|
|
|
attr_accessor :has_badge
|
|
|
|
|
2014-07-24 16:28:09 +08:00
|
|
|
def self.trigger_hash
|
|
|
|
Hash[*(
|
2017-07-28 09:20:09 +08:00
|
|
|
Badge::Trigger.constants.map { |k|
|
2014-07-24 16:28:09 +08:00
|
|
|
[k.to_s.underscore, Badge::Trigger.const_get(k)]
|
|
|
|
}.flatten
|
|
|
|
)]
|
|
|
|
end
|
|
|
|
|
2014-07-22 10:46:31 +08:00
|
|
|
module Trigger
|
2014-07-24 16:28:09 +08:00
|
|
|
None = 0
|
2014-07-22 09:11:30 +08:00
|
|
|
PostAction = 1
|
2014-07-23 09:42:24 +08:00
|
|
|
PostRevision = 2
|
|
|
|
TrustLevelChange = 4
|
|
|
|
UserChange = 8
|
2016-08-11 01:24:01 +08:00
|
|
|
PostProcessed = 16 # deprecated
|
FEATURE: Badge query validation, preview results, and EXPLAIN
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
2014-08-26 06:17:29 +08:00
|
|
|
|
|
|
|
def self.is_none?(trigger)
|
2014-09-01 10:36:31 +08:00
|
|
|
[None].include? trigger
|
FEATURE: Badge query validation, preview results, and EXPLAIN
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
2014-08-26 06:17:29 +08:00
|
|
|
end
|
|
|
|
|
|
|
|
def self.uses_user_ids?(trigger)
|
2016-08-11 01:24:01 +08:00
|
|
|
[TrustLevelChange, UserChange].include? trigger
|
FEATURE: Badge query validation, preview results, and EXPLAIN
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
2014-08-26 06:17:29 +08:00
|
|
|
end
|
|
|
|
|
|
|
|
def self.uses_post_ids?(trigger)
|
2014-09-01 10:36:31 +08:00
|
|
|
[PostAction, PostRevision].include? trigger
|
FEATURE: Badge query validation, preview results, and EXPLAIN
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
2014-08-26 06:17:29 +08:00
|
|
|
end
|
2014-07-22 09:11:30 +08:00
|
|
|
end
|
2014-07-03 15:29:44 +08:00
|
|
|
|
2014-03-05 20:52:20 +08:00
|
|
|
belongs_to :badge_type
|
2014-07-18 13:46:36 +08:00
|
|
|
belongs_to :badge_grouping
|
|
|
|
|
2014-03-21 20:26:06 +08:00
|
|
|
has_many :user_badges, dependent: :destroy
|
2014-03-05 20:52:20 +08:00
|
|
|
|
|
|
|
validates :name, presence: true, uniqueness: true
|
|
|
|
validates :badge_type, presence: true
|
2014-04-26 02:25:29 +08:00
|
|
|
validates :allow_title, inclusion: [true, false]
|
2014-05-24 10:33:46 +08:00
|
|
|
validates :multiple_grant, inclusion: [true, false]
|
2014-05-05 02:15:38 +08:00
|
|
|
|
2017-07-28 09:20:09 +08:00
|
|
|
scope :enabled, -> { where(enabled: true) }
|
2014-07-14 15:40:01 +08:00
|
|
|
|
2014-08-06 08:51:39 +08:00
|
|
|
before_create :ensure_not_system
|
|
|
|
|
2018-11-27 05:49:57 +08:00
|
|
|
after_commit do
|
|
|
|
SvgSprite.expire_cache
|
|
|
|
end
|
|
|
|
|
2014-07-24 16:28:09 +08:00
|
|
|
# fields that can not be edited on system badges
|
|
|
|
def self.protected_system_fields
|
2016-03-28 15:38:38 +08:00
|
|
|
[
|
2017-02-20 21:35:05 +08:00
|
|
|
:name, :badge_type_id, :multiple_grant,
|
2016-03-28 15:38:38 +08:00
|
|
|
:target_posts, :show_posts, :query,
|
|
|
|
:trigger, :auto_revoke, :listable
|
|
|
|
]
|
2014-07-24 16:28:09 +08:00
|
|
|
end
|
|
|
|
|
2014-05-05 02:15:38 +08:00
|
|
|
def self.trust_level_badge_ids
|
|
|
|
(1..4).to_a
|
|
|
|
end
|
2014-05-16 08:34:06 +08:00
|
|
|
|
2014-07-03 15:29:44 +08:00
|
|
|
def self.like_badge_counts
|
|
|
|
@like_badge_counts ||= {
|
|
|
|
NicePost => 10,
|
|
|
|
GoodPost => 25,
|
2014-09-11 11:30:47 +08:00
|
|
|
GreatPost => 50,
|
|
|
|
NiceTopic => 10,
|
|
|
|
GoodTopic => 25,
|
|
|
|
GreatTopic => 50
|
2014-07-03 15:29:44 +08:00
|
|
|
}
|
|
|
|
end
|
|
|
|
|
2017-02-20 21:35:05 +08:00
|
|
|
def self.ensure_consistency!
|
2018-06-19 14:13:14 +08:00
|
|
|
DB.exec <<~SQL
|
2017-02-20 21:35:05 +08:00
|
|
|
DELETE FROM user_badges
|
|
|
|
USING user_badges ub
|
2017-04-25 04:36:07 +08:00
|
|
|
LEFT JOIN users u ON u.id = ub.user_id
|
|
|
|
WHERE u.id IS NULL
|
|
|
|
AND user_badges.id = ub.id
|
2017-02-20 21:35:05 +08:00
|
|
|
SQL
|
|
|
|
|
2018-06-19 14:13:14 +08:00
|
|
|
DB.exec <<~SQL
|
2017-04-25 04:36:07 +08:00
|
|
|
WITH X AS (
|
|
|
|
SELECT badge_id
|
|
|
|
, COUNT(user_id) users
|
|
|
|
FROM user_badges
|
|
|
|
GROUP BY badge_id
|
|
|
|
)
|
|
|
|
UPDATE badges
|
|
|
|
SET grant_count = X.users
|
|
|
|
FROM X
|
|
|
|
WHERE id = X.badge_id
|
|
|
|
AND grant_count <> X.users
|
|
|
|
SQL
|
2017-02-20 21:35:05 +08:00
|
|
|
end
|
|
|
|
|
2018-09-21 10:06:08 +08:00
|
|
|
def self.i18n_name(name)
|
|
|
|
name.downcase.tr(' ', '_')
|
|
|
|
end
|
|
|
|
|
|
|
|
def self.display_name(name)
|
|
|
|
key = "badges.#{i18n_name(name)}.name"
|
|
|
|
I18n.t(key, default: name)
|
|
|
|
end
|
|
|
|
|
2017-01-11 01:18:48 +08:00
|
|
|
def awarded_for_trust_level?
|
|
|
|
id <= 4
|
|
|
|
end
|
|
|
|
|
2014-05-16 08:34:06 +08:00
|
|
|
def reset_grant_count!
|
|
|
|
self.grant_count = UserBadge.where(badge_id: id).count
|
|
|
|
save!
|
|
|
|
end
|
|
|
|
|
2014-05-21 15:22:42 +08:00
|
|
|
def single_grant?
|
|
|
|
!self.multiple_grant?
|
|
|
|
end
|
|
|
|
|
2014-10-02 13:55:33 +08:00
|
|
|
def default_icon=(val)
|
2016-10-21 07:53:58 +08:00
|
|
|
unless self.image
|
|
|
|
self.icon ||= val
|
2017-02-20 21:35:05 +08:00
|
|
|
self.icon = val if self.icon == "fa-certificate"
|
2016-10-21 07:53:58 +08:00
|
|
|
end
|
2014-10-02 13:55:33 +08:00
|
|
|
end
|
|
|
|
|
2014-07-30 06:46:46 +08:00
|
|
|
def default_allow_title=(val)
|
|
|
|
self.allow_title ||= val
|
|
|
|
end
|
|
|
|
|
2014-07-17 14:10:44 +08:00
|
|
|
def default_badge_grouping_id=(val)
|
2014-07-18 13:55:42 +08:00
|
|
|
# allow to correct orphans
|
|
|
|
if !self.badge_grouping_id || self.badge_grouping_id < 0
|
|
|
|
self.badge_grouping_id = val
|
|
|
|
end
|
2014-07-17 14:10:44 +08:00
|
|
|
end
|
2014-08-06 08:51:39 +08:00
|
|
|
|
2015-09-24 04:52:43 +08:00
|
|
|
def display_name
|
2018-09-21 10:06:08 +08:00
|
|
|
self.class.display_name(name)
|
2015-09-24 04:52:43 +08:00
|
|
|
end
|
|
|
|
|
|
|
|
def long_description
|
2016-04-08 15:52:50 +08:00
|
|
|
key = "badges.#{i18n_name}.long_description"
|
2017-11-01 03:18:52 +08:00
|
|
|
I18n.t(key, default: self[:long_description] || '', base_uri: Discourse.base_uri)
|
2015-09-24 04:52:43 +08:00
|
|
|
end
|
|
|
|
|
2016-03-28 15:38:38 +08:00
|
|
|
def long_description=(val)
|
2017-02-20 21:35:05 +08:00
|
|
|
self[:long_description] = val if val != long_description
|
2016-03-28 15:38:38 +08:00
|
|
|
val
|
|
|
|
end
|
|
|
|
|
|
|
|
def description
|
2016-04-08 15:52:50 +08:00
|
|
|
key = "badges.#{i18n_name}.description"
|
2017-11-01 03:18:52 +08:00
|
|
|
I18n.t(key, default: self[:description] || '', base_uri: Discourse.base_uri)
|
2016-03-28 15:38:38 +08:00
|
|
|
end
|
|
|
|
|
|
|
|
def description=(val)
|
2017-02-20 21:35:05 +08:00
|
|
|
self[:description] = val if val != description
|
2016-03-28 15:38:38 +08:00
|
|
|
val
|
|
|
|
end
|
|
|
|
|
2015-09-24 04:52:43 +08:00
|
|
|
def slug
|
|
|
|
Slug.for(self.display_name, '-')
|
|
|
|
end
|
|
|
|
|
2018-01-22 11:10:53 +08:00
|
|
|
def manually_grantable?
|
|
|
|
query.blank? && !system?
|
|
|
|
end
|
|
|
|
|
2014-08-06 08:51:39 +08:00
|
|
|
protected
|
2016-04-06 03:12:02 +08:00
|
|
|
|
2018-06-07 13:28:18 +08:00
|
|
|
def ensure_not_system
|
|
|
|
self.id = [Badge.maximum(:id) + 1, 100].max unless id
|
|
|
|
end
|
2015-09-24 04:52:43 +08:00
|
|
|
|
2018-06-07 13:28:18 +08:00
|
|
|
def i18n_name
|
2018-09-21 10:06:08 +08:00
|
|
|
@i18n_name ||= self.class.i18n_name(name)
|
2018-06-07 13:28:18 +08:00
|
|
|
end
|
2014-03-05 20:52:20 +08:00
|
|
|
end
|
|
|
|
|
|
|
|
# == Schema Information
|
|
|
|
#
|
|
|
|
# Table name: badges
|
|
|
|
#
|
2014-07-17 14:10:44 +08:00
|
|
|
# id :integer not null, primary key
|
2018-02-20 14:28:58 +08:00
|
|
|
# name :string not null
|
2014-07-17 14:10:44 +08:00
|
|
|
# description :text
|
|
|
|
# badge_type_id :integer not null
|
|
|
|
# grant_count :integer default(0), not null
|
2014-08-27 13:19:25 +08:00
|
|
|
# created_at :datetime not null
|
|
|
|
# updated_at :datetime not null
|
2014-07-17 14:10:44 +08:00
|
|
|
# allow_title :boolean default(FALSE), not null
|
|
|
|
# multiple_grant :boolean default(FALSE), not null
|
2018-02-20 14:28:58 +08:00
|
|
|
# icon :string default("fa-certificate")
|
2014-07-17 14:10:44 +08:00
|
|
|
# listable :boolean default(TRUE)
|
|
|
|
# target_posts :boolean default(FALSE)
|
|
|
|
# query :text
|
|
|
|
# enabled :boolean default(TRUE), not null
|
|
|
|
# auto_revoke :boolean default(TRUE), not null
|
2014-07-22 10:46:31 +08:00
|
|
|
# badge_grouping_id :integer default(5), not null
|
|
|
|
# trigger :integer
|
2014-07-24 16:28:09 +08:00
|
|
|
# show_posts :boolean default(FALSE), not null
|
2014-08-07 11:33:11 +08:00
|
|
|
# system :boolean default(FALSE), not null
|
2014-11-20 11:53:15 +08:00
|
|
|
# image :string(255)
|
2015-09-18 08:41:10 +08:00
|
|
|
# long_description :text
|
2014-03-05 20:52:20 +08:00
|
|
|
#
|
|
|
|
# Indexes
|
|
|
|
#
|
2018-02-20 14:28:58 +08:00
|
|
|
# index_badges_on_badge_type_id (badge_type_id)
|
|
|
|
# index_badges_on_name (name) UNIQUE
|
2014-03-05 20:52:20 +08:00
|
|
|
#
|