A platform for community discussion. Free, open, simple.
FIX: Moderators can enable plugins when enable_category_type_setup SiteSetting is enabled (#40246)
Juan David Martínez Cubillose7dde434253e
diff --git a/app/controllers/categories_controller.rb b/app/controllers/categories_controller.rbindex 7ba236ae44b..84c0166dcee 100644--- a/app/controllers/categories_controller.rb+++ b/app/controllers/categories_controller.rb@@ -138,7 +138,7 @@ class CategoriesController < ApplicationControllerendrender json: {- types: Categories::TypeRegistry.list(only_visible: true),+ types: Categories::TypeRegistry.list(only_visible: true, guardian:),counts: counts_by_type,}end@@ -180,43 +180,44 @@ class CategoriesController < ApplicationControllerreturn render json: { errors: [e.message] }, status: :unprocessable_entityend- if @category.save- @category.move_to(position.to_i) if position-- if category_type.present? &&- UpcomingChanges.enabled_for_user?(:enable_simplified_category_creation, current_user)- type_class = Categories::TypeRegistry.get(category_type.to_sym)- allowed_setting_keys = type_class&.configuration_schema_keys(:category_settings) || []- type_settings = params[:category_type_settings]&.slice(*allowed_setting_keys)&.permit!-- Categories::Configure.call(- guardian:,- params: {- category_id: @category.id,- category_type:,- site_setting_configuration_values: params[:category_type_site_settings],- category_configuration_values: [- category_params[:custom_fields],- type_settings,- ].compact.reduce(:merge),- },- ) do |result|- on_failed_policy(:type_is_available) do- return(- render json: {- errors: [- I18n.t(- "category_types.not_available",- type_name: category_type.capitalize,- ),- ],- },- status: :unprocessable_entity- )+ configure_error = nil++ Category.transaction do+ if @category.save+ @category.move_to(position.to_i) if position++ if category_type.present? &&+ UpcomingChanges.enabled_for_user?(:enable_simplified_category_creation, current_user)+ type_class = Categories::TypeRegistry.get(category_type.to_sym)+ allowed_setting_keys = type_class&.configuration_schema_keys(:category_settings) || []+ type_settings = params[:category_type_settings]&.slice(*allowed_setting_keys)&.permit!++ Categories::Configure.call(+ guardian:,+ params: {+ category_id: @category.id,+ category_type:,+ site_setting_configuration_values: params[:category_type_site_settings],+ category_configuration_values: [+ category_params[:custom_fields],+ type_settings,+ ].compact.reduce(:merge),+ },+ ) do+ on_failed_policy(:type_is_available) do+ configure_error = category_type_unavailable_error(category_type)+ raise ActiveRecord::Rollback+ endendendend+ end+ if configure_error+ return render json: { errors: [configure_error] }, status: :unprocessable_entity+ end++ if @category.persisted?Scheduler::Defer.later "Log staff action create category" do@staff_action_logger.log_category_creation(@category)end@@ -243,7 +244,7 @@ class CategoriesController < ApplicationController# Handles adding or removing category types registered by plugins# based on the multi-type selector in the General tab for categories.if UpcomingChanges.enabled_for_user?(:enable_simplified_category_creation, current_user)- manage_category_types(cat, pending_custom_fields || {})+ return nil unless manage_category_types(cat, pending_custom_fields || {})cat.reloadend@@ -557,6 +558,23 @@ class CategoriesController < ApplicationControllerendend+ def category_type_unavailable_error(category_type)+ type_id = category_type.to_sym+ type_class = Categories::TypeRegistry.get(type_id)++ if type_class&.enables_plugin?+ plugin_name =+ Categories::TypeRegistry+ .owner(type_id)+ &.sub(/^discourse-/, "")+ &.sub(/-plugin$/, "")+ &.titleize+ I18n.t("category_types.requires_plugin", type_name: category_type.to_s.humanize, plugin_name:)+ else+ I18n.t("category_types.not_available", type_name: category_type.to_s.humanize)+ end+ end+def manage_category_types(category, pending_custom_fields)# NOTE: The code in this block is pretty similar to what we are doing in# configure_site_settings in Categories::Types::Base, however here we@@ -623,23 +641,19 @@ class CategoriesController < ApplicationControllercategory_id: category.id,category_type:,},- ) do |result|+ ) doon_failed_policy(:type_is_available) do- return(- render json: {- errors: [- I18n.t(- "category_types.not_available",- type_name: category_type.capitalize,- ),- ],- },- status: :unprocessable_entity- )+ render json: {+ errors: [category_type_unavailable_error(category_type)],+ },+ status: :unprocessable_entity+ return falseendendendend++ trueenddef topics_per_pagediff --git a/app/serializers/category_serializer.rb b/app/serializers/category_serializer.rbindex 2096ab4919a..2e59314beff 100644--- a/app/serializers/category_serializer.rb+++ b/app/serializers/category_serializer.rb@@ -176,6 +176,6 @@ class CategorySerializer < SiteCategorySerializerdef available_category_typesreturn [] if !SiteSetting.enable_simplified_category_creation- Categories::TypeRegistry.list(only_visible: true)+ Categories::TypeRegistry.list(only_visible: true, guardian: scope)endenddiff --git a/app/services/categories/configure.rb b/app/services/categories/configure.rbindex 5a792c98f03..58bfaeffdfe 100644--- a/app/services/categories/configure.rb+++ b/app/services/categories/configure.rb@@ -50,8 +50,8 @@ module CategoriesCategories::TypeRegistry.get(params.category_type)end- def type_is_available(type_class:)- type_class.available?+ def type_is_available(type_class:, guardian:)+ type_class.available?(guardian)enddef enable_plugin(type_class:)diff --git a/app/services/categories/type_registry.rb b/app/services/categories/type_registry.rbindex 5d214676463..d4e0cc0ca19 100644--- a/app/services/categories/type_registry.rb+++ b/app/services/categories/type_registry.rb@@ -31,14 +31,21 @@ module Categoriestypesend- def list(only_visible: false)- types.values.select { |type| only_visible ? type.visible? : true }.map(&:metadata)+ def list(only_visible: false, guardian: nil)+ types+ .values+ .select { |type| only_visible ? type.visible? : true }+ .map { |type| type.metadata(guardian:) }enddef valid?(id)types.key?(id.to_sym)end+ def owner(id)+ owners[id.to_sym]+ end+def reset!@types = nil@owners = nildiff --git a/app/services/categories/types/base.rb b/app/services/categories/types/base.rbindex 58d829cd444..caa625c150f 100644--- a/app/services/categories/types/base.rb+++ b/app/services/categories/types/base.rb@@ -124,6 +124,12 @@ module Categoriesdef enable_pluginend+ # Returns true if this type overrides enable_plugin with actual behavior.+ # Used to determine if admin privileges are required to configure this type.+ def enables_plugin?+ method(:enable_plugin).owner != Categories::Types::Base.singleton_class+ end+# Configure any category-specific settings or custom fields that are# specific to this category type, including whatever setting or custom# field values make this category type unique.@@ -251,7 +257,10 @@ module Categories# Used as an extension point to limit access to a category type# based on certain conditions, mostly for Discourse hosting.- def available?+ # When guardian is provided, also checks if admin is required for+ # types that enable plugins.+ def available?(guardian = nil)+ return false if enables_plugin? && guardian && !guardian.is_admin?trueend@@ -328,18 +337,26 @@ module Categoriesend# Used when serializing the category configuration schema to the client.- def metadata+ def metadata(guardian: nil)name = I18n.t("category_types.#{type_id}.name", default: type_id.to_s.titleize)- {+ result = {id: type_id,name: name,title: I18n.t("category_types.#{type_id}.title", default: name),description: I18n.t("category_types.#{type_id}.description", default: ""),icon:,- available: available?,+ available: available?(guardian),visible: visible?,configuration_schema: resolved_configuration_schema,- }.merge(additional_metadata)+ }+ if enables_plugin?+ plugin_name = Categories::TypeRegistry.owner(type_id)+ result[:required_plugin] = plugin_name+ &.sub(/^discourse-/, "")+ &.sub(/-plugin$/, "")+ &.titleize+ end+ result.merge(additional_metadata)endprivatediff --git a/config/locales/client.en.yml b/config/locales/client.en.ymlindex 1484cb97744..60e7be46a61 100644--- a/config/locales/client.en.yml+++ b/config/locales/client.en.yml@@ -4947,7 +4947,8 @@ en:site_settings: "Site settings"choose_type:title: "Choose category type"- requires_plugin: "Requires plugin"+ requires_plugin: "Requires %{plugin_name} plugin"+ unavailable: "Unavailable"create_category: "Create category"save: "Save category"unsaved_changes: "You have unsaved changes"diff --git a/config/locales/server.en.yml b/config/locales/server.en.ymlindex c57b5b90d0a..d73d6e91353 100644--- a/config/locales/server.en.yml+++ b/config/locales/server.en.yml@@ -910,6 +910,7 @@ en:category_types:not_available: "Category type '%{type_name}' is not available"+ requires_plugin: "Category type '%{type_name}' requires the '%{plugin_name}' plugin to be enabled. Ask an administrator to enable it or create this category."discussion:name: "Discussion"title: "discussion"diff --git a/frontend/discourse/app/components/category-type-cards.gjs b/frontend/discourse/app/components/category-type-cards.gjsindex b0476ff869b..9b4d622babb 100644--- a/frontend/discourse/app/components/category-type-cards.gjs+++ b/frontend/discourse/app/components/category-type-cards.gjs@@ -9,6 +9,15 @@ import dConcatClass from "discourse/ui-kit/helpers/d-concat-class";import dEmoji from "discourse/ui-kit/helpers/d-emoji";import { i18n } from "discourse-i18n";+function unavailableBadgeText(type) {+ if (type.required_plugin) {+ return i18n("category.choose_type.requires_plugin", {+ plugin_name: type.required_plugin,+ });+ }+ return i18n("category.choose_type.unavailable");+}+export default class CategoryTypeCards extends Component {@service categoryTypeChooser;@service router;@@ -53,7 +62,7 @@ export default class CategoryTypeCards extends Component {@name="category-type-card-top-right-corner"@outletArgs={{lazyHash type=type}}>- {{i18n "category.choose_type.requires_plugin"}}+ {{unavailableBadgeText type}}</PluginOutlet></span>{{/unless}}diff --git a/spec/requests/categories_controller_spec.rb b/spec/requests/categories_controller_spec.rbindex 82d822019b1..a64bc62358e 100644--- a/spec/requests/categories_controller_spec.rb+++ b/spec/requests/categories_controller_spec.rb@@ -1327,6 +1327,63 @@ RSpec.describe CategoriesController doexpect(response.status).to eq(200)expect(category.reload.locale).to be_nilend++ context "when adding category_types that enable plugins" do+ let(:test_type_class) do+ Class.new(Categories::Types::Base) do+ type_id :test_plugin_type++ def self.enable_plugin+ end++ def self.category_matches?(category)+ false+ end++ def self.find_matches+ Category.none+ end++ def self.configure_category(category, guardian:, configuration_values: {})+ end++ def self.unconfigure_category(category, guardian:)+ end+ end+ end++ before do+ SiteSetting.enable_simplified_category_creation = true+ Categories::TypeRegistry.register(+ test_type_class,+ plugin_identifier: "discourse-test-plugin",+ )+ end++ after { Categories::TypeRegistry.reset! }++ it "returns 422 when a moderator tries to add a plugin-enabling type" do+ sign_in(Fabricate(:moderator))+ SiteSetting.moderators_manage_categories = true++ put "/categories/#{category.id}.json", params: { category_types: %w[test_plugin_type] }++ expect(response.status).to eq(422)+ expect(response.parsed_body["errors"]).to include(+ I18n.t(+ "category_types.requires_plugin",+ type_name: "Test plugin type",+ plugin_name: "Test",+ ),+ )+ end++ it "allows an admin to add a plugin-enabling type" do+ put "/categories/#{category.id}.json", params: { category_types: %w[test_plugin_type] }++ expect(response.status).to eq(200)+ end+ endendenddiff --git a/spec/services/categories/configure_spec.rb b/spec/services/categories/configure_spec.rbindex ecc5f37ce71..93b71a899e5 100644--- a/spec/services/categories/configure_spec.rb+++ b/spec/services/categories/configure_spec.rb@@ -46,6 +46,62 @@ RSpec.describe Categories::Configure doit { is_expected.to fail_a_policy(:type_is_available) }end+ context "when type does not enable a plugin (Discussion)" do+ context "when user is a moderator" do+ fab!(:moderator)++ let(:dependencies) { { guardian: moderator.guardian } }++ before { SiteSetting.moderators_manage_categories = true }++ it { is_expected.to run_successfully }+ end+ end++ context "when type enables a plugin" do+ let(:test_type_class) do+ Class.new(Categories::Types::Base) do+ type_id :test_plugin_type++ def self.enable_plugin+ end++ def self.category_matches?(category)+ false+ end++ def self.find_matches+ Category.none+ end++ def self.configure_category(category, guardian:, configuration_values: {})+ end++ def self.unconfigure_category(category, guardian:)+ end+ end+ end++ let(:params) { { category_id: category.id, category_type: "test_plugin_type" } }++ before { Categories::TypeRegistry.register(test_type_class) }+ after { Categories::TypeRegistry.reset! }++ context "when user is a moderator" do+ fab!(:moderator)++ let(:dependencies) { { guardian: moderator.guardian } }++ before { SiteSetting.moderators_manage_categories = true }++ it { is_expected.to fail_a_policy(:type_is_available) }+ end++ context "when user is an admin" do+ it { is_expected.to run_successfully }+ end+ end+context "when everything's ok" doit { is_expected.to run_successfully }diff --git a/spec/services/categories/types/base_spec.rb b/spec/services/categories/types/base_spec.rbindex c84a6e85b09..8cec6ed77bb 100644--- a/spec/services/categories/types/base_spec.rb+++ b/spec/services/categories/types/base_spec.rb@@ -13,6 +13,26 @@ RSpec.describe Categories::Types::Base doendend+ describe ".enables_plugin?" do+ it "returns false when enable_plugin is not overridden" do+ test_type = Class.new(described_class) { type_id :no_plugin }++ expect(test_type.enables_plugin?).to eq(false)+ end++ it "returns true when enable_plugin is overridden" do+ test_type =+ Class.new(described_class) do+ type_id :with_plugin++ def self.enable_plugin+ end+ end++ expect(test_type.enables_plugin?).to eq(true)+ end+ end+describe ".metadata" doit "returns type information including configuration_schema" doexpect(described_class.metadata).to include(