github-mirror/discourse
2
0
Fork 0
mirror of https://github.com/discourse/discourse.git synced 2025-05-31 14:31:03 +08:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

DEV: Add framework for filtered plugin registers (#9763)

Browse Source 
* DEV: Add framework for filtered plugin registers

Plugins often need to add values to a list, and we need to filter those lists at runtime to ignore values from disabled plugins. This commit provides a re-usable way to do that, which should make it easier to add new registers in future, and also reduce repeated code.

Follow-up commits will migrate existing registers to use this new system

* DEV: Migrate user and group custom field APIs to plugin registry

This gives us a consistent system for checking plugin enabled state, so we are repeating less logic. API changes are backwards compatible
This commit is contained in:
David Taylor
2020-05-15 14:04:38 +01:00
committed by GitHub
parent 0495a748d0
commit 461b4e5cc6
12 changed files with 111 additions and 78 deletions
Download Patch File Download Diff File Expand all files Collapse all files

56
app/models/user.rb
View File

@ -267,72 +267,44 @@ class User < ActiveRecord::Base
end
end
def self.plugin_editable_user_custom_fields
@plugin_editable_user_custom_fields ||= {}
end
def self.plugin_staff_editable_user_custom_fields
@plugin_staff_editable_user_custom_fields ||= {}
end
def self.register_plugin_editable_user_custom_field(custom_field_name, plugin, staff_only: false)
if staff_only
plugin_staff_editable_user_custom_fields[custom_field_name] = plugin
else
plugin_editable_user_custom_fields[custom_field_name] = plugin
end
end
def self.editable_user_custom_fields(by_staff: false)
fields = []
plugin_editable_user_custom_fields.each do |k, v|
fields << k if v.enabled?
end
if by_staff
plugin_staff_editable_user_custom_fields.each do |k, v|
fields << k if v.enabled?
end
end
fields.push *DiscoursePluginRegistry.self_editable_user_custom_fields
fields.push *DiscoursePluginRegistry.staff_editable_user_custom_fields if by_staff
fields.uniq
end
def self.plugin_staff_user_custom_fields
@plugin_staff_user_custom_fields ||= {}
def self.register_plugin_editable_user_custom_field(custom_field_name, plugin, staff_only: false)
Discourse.deprecate("Editable user custom fields should be registered using the plugin API", since: "v2.4.0.beta4", drop_from: "v2.5.0")
DiscoursePluginRegistry.register_editable_user_custom_field(custom_field_name, plugin, staff_only: staff_only)
end
def self.register_plugin_staff_custom_field(custom_field_name, plugin)
plugin_staff_user_custom_fields[custom_field_name] = plugin
end
def self.plugin_public_user_custom_fields
@plugin_public_user_custom_fields ||= {}
Discourse.deprecate("Staff user custom fields should be registered using the plugin API", since: "v2.4.0.beta4", drop_from: "v2.5.0")
DiscoursePluginRegistry.register_staff_user_custom_field(custom_field_name, plugin)
end
def self.register_plugin_public_custom_field(custom_field_name, plugin)
plugin_public_user_custom_fields[custom_field_name] = plugin
Discourse.deprecate("Public user custom fields should be registered using the plugin API", since: "v2.4.0.beta4", drop_from: "v2.5.0")
DiscoursePluginRegistry.register_public_user_custom_field(custom_field_name, plugin)
end
def self.whitelisted_user_custom_fields(guardian)
fields = []
plugin_public_user_custom_fields.each do |k, v|
fields << k if v.enabled?
end
fields.push *DiscoursePluginRegistry.public_user_custom_fields
if SiteSetting.public_user_custom_fields.present?
fields += SiteSetting.public_user_custom_fields.split('|')
fields.push *SiteSetting.public_user_custom_fields.split('|')
end
if guardian.is_staff?
if SiteSetting.staff_user_custom_fields.present?
fields += SiteSetting.staff_user_custom_fields.split('|')
end
plugin_staff_user_custom_fields.each do |k, v|
fields << k if v.enabled?
fields.push *SiteSetting.staff_user_custom_fields.split('|')
end
fields.push *DiscoursePluginRegistry.staff_user_custom_fields
end
fields.uniq