A platform for community discussion. Free, open, simple.
# frozen_string_literal: true
class SidebarSectionsController < ApplicationController
requires_login
before_action :check_access_if_public
def index
sections =
SidebarSection
.strict_loading
.includes(:localizations, sidebar_urls: :localizations)
.where("public OR user_id = ?", current_user.id)
.order("section_type IS NOT NULL DESC, public DESC, title ASC")
sections =
ActiveModel::ArraySerializer.new(
sections,
each_serializer: SidebarSectionSerializer,
scope: guardian,
root: "sidebar_sections",
)
render json: sections
end
def show
sidebar_section =
SidebarSection.includes(:localizations, sidebar_urls: :localizations).find(params[:id])
@guardian.ensure_can_edit!(sidebar_section)
render_serialized(sidebar_section, SidebarSectionEditSerializer, root: "sidebar_section")
rescue Discourse::InvalidAccess
render json: failed_json, status: :forbidden
end
def create
new_section = SidebarSection.new(public: submitted_public)
ensure_localization_params_allowed(new_section)
sidebar_section =
SidebarSection.create!(
section_params(new_section).merge(sidebar_urls_attributes: links_params(new_section)),
)
if sidebar_section.public?
StaffActionLogger.new(current_user).log_create_public_sidebar_section(sidebar_section)
MessageBus.publish("/refresh-sidebar-sections", nil)
Site.clear_anon_cache!
end
render_serialized(sidebar_section, SidebarSectionSerializer)
rescue ActiveRecord::RecordInvalid => e
render_json_error(e.record.errors.full_messages.first)
rescue ActiveRecord::NestedAttributes::TooManyRecords => e
render_json_error(e.message)
rescue Discourse::InvalidAccess
render json: failed_json, status: :forbidden
end
def update
sidebar_section = SidebarSection.find(params[:id])
@guardian.ensure_can_edit!(sidebar_section)
ensure_localization_params_allowed(sidebar_section)
permitted_section_params = section_params(sidebar_section)
permitted_links_params = links_params(sidebar_section)
SidebarSectionUpdater.update!(
sidebar_section:,
user: current_user,
section_params: permitted_section_params,
links_params: permitted_links_params,
)
render_serialized(sidebar_section.reload, SidebarSectionSerializer)
rescue ActiveRecord::RecordInvalid => e
render_json_error(e.record.errors.full_messages.first)
rescue ActiveRecord::NestedAttributes::TooManyRecords => e
render_json_error(e.message)
rescue Discourse::InvalidAccess
render json: failed_json, status: :forbidden
end
def reset
sidebar_section = SidebarSection.find_by(id: params[:id])
raise Discourse::InvalidParameters if !sidebar_section
@guardian.ensure_can_edit!(sidebar_section)
case sidebar_section.section_type
when "community"
sidebar_section.reset_community!
Site.clear_anon_cache!
end
render_serialized(sidebar_section, SidebarSectionSerializer)
end
def reorder
SidebarSection::ReorderLinks.call(
service_params.deep_merge(params: { section_id: params[:id] }),
) do
on_success { |section:| render_serialized(section.reload, SidebarSectionSerializer) }
on_model_not_found(:section) { raise Discourse::NotFound }
on_failed_policy(:can_edit_section) { render json: failed_json, status: :forbidden }
on_failed_policy(:order_covers_every_link) do
raise Discourse::InvalidParameters.new(:links_order)
end
on_failed_contract do |contract|
render json: failed_json.merge(errors: contract.errors.full_messages), status: :bad_request
end
on_failure { render json: failed_json, status: :unprocessable_entity }
end
end
def move_link
SidebarSection::MoveLink.call(
service_params.deep_merge(params: { source_section_id: params[:id] }),
) do
on_success do |source_section:, target_section:|
sections = [source_section.reload, target_section.reload]
render json: {
sidebar_sections:
sections.map do |section|
SidebarSectionSerializer.new(section, scope: guardian, root: false).as_json
end,
}
end
on_model_not_found(:source_section) { raise Discourse::NotFound }
on_model_not_found(:target_section) { raise Discourse::NotFound }
on_model_not_found(:link) { raise Discourse::NotFound }
on_failed_policy(:can_edit_source_section) { render json: failed_json, status: :forbidden }
on_failed_policy(:can_edit_target_section) { render json: failed_json, status: :forbidden }
on_failed_policy(:sections_are_distinct) do
raise Discourse::InvalidParameters.new(:target_section_id)
end
on_failed_policy(:sections_are_custom) { raise Discourse::InvalidAccess }
on_failed_policy(:target_section_has_room) do |target_section:|
render_json_error(
I18n.t(
"activerecord.errors.models.sidebar_section.attributes.base.too_many_sidebar_urls",
limit: SiteSetting.max_sidebar_section_links,
count: target_section.sidebar_section_links.count + 1,
),
status: :unprocessable_entity,
)
end
on_failed_contract do |contract|
render json: failed_json.merge(errors: contract.errors.full_messages), status: :bad_request
end
on_failure { render json: failed_json, status: :unprocessable_entity }
end
end
def destroy
sidebar_section = SidebarSection.find(section_params["id"])
@guardian.ensure_can_delete!(sidebar_section)
sidebar_section.destroy!
if sidebar_section.public?
StaffActionLogger.new(current_user).log_destroy_public_sidebar_section(sidebar_section)
MessageBus.publish("/refresh-sidebar-sections", nil)
Site.clear_anon_cache!
end
render json: success_json
rescue Discourse::InvalidAccess
render json: failed_json, status: :forbidden
end
def section_params(sidebar_section = nil)
section_params = params.permit(:id, :title).to_h.with_indifferent_access
if current_user.admin?
section_params.merge!(params.permit(:public).to_h.with_indifferent_access)
if SiteSetting.content_localization_enabled &&
guardian.can_localize_sidebar_section_title?(sidebar_section, public: submitted_public)
validate_source_locale!(params[:locale], sidebar_section&.locale)
section_params.merge!(
params
.permit(:locale, localizations: %i[id locale title _destroy])
.to_h
.with_indifferent_access,
)
end
end
section_is_public = ActiveModel::Type::Boolean.new.cast(section_params[:public])
section_params.merge!(user: current_user) if !section_is_public
if section_params[:localizations]
section_params[:localizations_attributes] = prepare_localization_attributes(
section_params.delete(:localizations),
resolved_source_locale(section_params[:locale], sidebar_section&.locale),
)
end
section_params
end
def links_params(sidebar_section = nil)
permitted_link_params = %i[icon name value id _destroy segment]
if current_user.admin? && SiteSetting.content_localization_enabled
permitted_link_params << :locale
permitted_link_params << { localizations: %i[id locale name _destroy] }
end
links = params.permit(links: permitted_link_params)["links"]
public_submitted = submitted_public
stored_locales = nil
links&.each do |link|
next if link[:locale].blank? && link[:localizations].blank?
if sidebar_section.present? &&
!guardian.can_localize_sidebar_section_link?(
sidebar_section,
link[:value],
public: public_submitted,
)
link.delete(:locale)
link.delete(:localizations)
next
end
stored_locales ||=
sidebar_section ? sidebar_section.sidebar_urls.to_h { |url| [url.id, url.locale] } : {}
stored_locale = stored_locales[link[:id].to_i]
validate_source_locale!(link[:locale], stored_locale.presence || sidebar_section&.locale)
next if link[:localizations].blank?
link[:localizations_attributes] = prepare_localization_attributes(
link.delete(:localizations),
resolved_source_locale(link[:locale], stored_locale),
)
end
links
end
private
def check_access_if_public
return true if !submitted_public
raise Discourse::InvalidAccess.new if !guardian.can_create_public_sidebar_section?
end
def validate_source_locale!(locale, stored_locale)
return if locale.blank? || locale == stored_locale
return if LocaleSiteSetting.supported_locales.include?(locale)
raise Discourse::InvalidParameters.new(:locale)
end
def resolved_source_locale(submitted_locale, stored_locale)
return stored_locale.presence || SiteSetting.default_locale if submitted_locale.nil?
submitted_locale.presence || SiteSetting.default_locale
end
def submitted_public
ActiveModel::Type::Boolean.new.cast(params[:public]) if params.key?(:public)
end
def ensure_localization_params_allowed(sidebar_section)
return if !SiteSetting.content_localization_enabled
public = submitted_public
if (params[:locale].present? || params[:localizations].present?) &&
!guardian.can_localize_sidebar_section_title?(sidebar_section, public:)
raise Discourse::InvalidAccess
end
params[:links]&.each do |link|
next if link[:localizations].blank?
next if guardian.can_localize_sidebar_section_link?(sidebar_section, link[:value], public:)
raise Discourse::InvalidAccess
end
end
def prepare_localization_attributes(localizations, source_locale)
localizations.filter_map do |localization|
next localization if ActiveModel::Type::Boolean.new.cast(localization[:_destroy])
next localization if !LocaleNormalizer.is_same?(localization[:locale], source_locale)
if exact_locale_match?(localization[:locale], source_locale) && localization[:id].present?
localization.merge(_destroy: true)
end
end
end
def exact_locale_match?(locale, source_locale)
LocaleNormalizer.normalize_to_i18n(locale) == LocaleNormalizer.normalize_to_i18n(source_locale)
end
end