mirror of
https://github.com/discourse/discourse.git
synced 2025-10-03 17:21:20 +08:00
This commit introduces the concept of themeable site settings, which is a new tool for theme authors that lives alongside theme modifiers and theme settings. Here is a quick summary: * Theme settings - These are custom settings used to control UI and functionality within your theme or component and provide configuration options. These cannot change core Discourse functionality. * Theme modifiers - Allows a theme or a component to modify selected server-side functionality of core Discourse as an alternative to building a plugin. * Themeable site settings (new) - Allows a theme (not components) to override a small subset of core site settings, which generally control parts of the UI and other minor functionality. This allows themes to have a greater control over the full site experience. Themeable site settings will be shown for all themes, whether the theme changes the value or not, and have a similar UI to custom theme settings. We are also introducing a new page at `/admin/config/theme-site-settings` that allows admins to see all possible themeable site settings, and which themes are changing the value from the default. ### Configuration Theme authors can configure initial values themeable site settings using a section in the `about.json` file like so: ```json "theme_site_settings": { "search_experience": "search_field" } ``` These values will not change when the theme updates, because we cannot know if admins have manually changed them. ### Limitations Themeable site settings are only really intended to control elements of the UI, and when retrieving their value we require a theme ID, so these limitations apply: - Themeable site settings cannot be used in Sidekiq jobs - Themeable site settings cannot be used in markdown rules - Themeable site settings will be cached separately to client site settings using theme ID as a key - Themeable site settings will override keys on the `siteSettings` service on the client using the application preloader - `SiteSetting.client_settings_json` will not include themeable site settings, instead you can call `SiteSetting.theme_site_settings_json` with a theme ID ### Initial settings There are only two site settings that will be themeable to begin with: * `enable_welcome_banner` * `search_experience` And our new Horizon theme will take advantage of both. Over time, more settings that control elements of the UI will be exposed this way.
149 lines
4.3 KiB
Ruby
149 lines
4.3 KiB
Ruby
# frozen_string_literal: true
|
|
|
|
class ApplicationLayoutPreloader
|
|
include ReadOnlyMixin
|
|
|
|
def self.banner_json_cache
|
|
@banner_json_cache ||= DistributedCache.new("banner_json")
|
|
end
|
|
|
|
def initialize(guardian:, theme_id:, theme_target:, login_method:)
|
|
@guardian = guardian
|
|
@theme_id = theme_id
|
|
@theme_target = theme_target
|
|
@login_method = login_method
|
|
@preloaded = {}
|
|
end
|
|
|
|
def store_preloaded(key, json)
|
|
# I dislike that there is a gsub as opposed to a gsub!
|
|
# but we can not be mucking with user input, I wonder if there is a way
|
|
# to inject this safety deeper in the library or even in AM serializer
|
|
@preloaded[key] = json.gsub("</", "<\\/")
|
|
end
|
|
|
|
def preloaded_data
|
|
preload_anonymous_data
|
|
|
|
if @guardian.authenticated?
|
|
@guardian.user.sync_notification_channel_position
|
|
preload_current_user_data
|
|
end
|
|
|
|
@preloaded
|
|
end
|
|
|
|
def banner_json
|
|
return "{}" if !@guardian.authenticated? && SiteSetting.login_required?
|
|
|
|
self
|
|
.class
|
|
.banner_json_cache
|
|
.defer_get_set("json") do
|
|
topic = Topic.where(archetype: Archetype.banner).first
|
|
banner = topic.present? ? topic.banner(@guardian) : {}
|
|
MultiJson.dump(banner)
|
|
end
|
|
end
|
|
|
|
def custom_html_json
|
|
data =
|
|
if @theme_id.present?
|
|
{
|
|
top: Theme.lookup_field(@theme_id, @theme_target, "after_header"),
|
|
footer: Theme.lookup_field(@theme_id, @theme_target, "footer"),
|
|
}
|
|
else
|
|
{}
|
|
end
|
|
|
|
data.merge! DiscoursePluginRegistry.custom_html if DiscoursePluginRegistry.custom_html
|
|
|
|
DiscoursePluginRegistry.html_builders.each do |name, _|
|
|
if name.start_with?("client:")
|
|
data[name.sub(/\Aclient:/, "")] = DiscoursePluginRegistry.build_html(name, self)
|
|
end
|
|
end
|
|
|
|
MultiJson.dump(data)
|
|
end
|
|
|
|
private
|
|
|
|
def preload_current_user_data
|
|
@preloaded["currentUser"] = MultiJson.dump(
|
|
CurrentUserSerializer.new(
|
|
@guardian.user,
|
|
scope: @guardian,
|
|
root: false,
|
|
login_method: @login_method,
|
|
),
|
|
)
|
|
|
|
report = TopicTrackingState.report(@guardian.user)
|
|
serializer = TopicTrackingStateSerializer.new(report, scope: @guardian, root: false)
|
|
hash = serializer.as_json
|
|
|
|
@preloaded["topicTrackingStates"] = MultiJson.dump(hash[:data])
|
|
@preloaded["topicTrackingStateMeta"] = MultiJson.dump(hash[:meta])
|
|
|
|
if @guardian.is_admin?
|
|
# This is used in the wizard so we can preload fonts using the FontMap JS API.
|
|
@preloaded["fontMap"] = MultiJson.dump(load_font_map)
|
|
|
|
# Used to show plugin-specific admin routes in the sidebar.
|
|
@preloaded["visiblePlugins"] = MultiJson.dump(
|
|
Discourse
|
|
.plugins_sorted_by_name(enabled_only: false)
|
|
.map do |plugin|
|
|
{
|
|
name: plugin.name.downcase,
|
|
humanized_name: plugin.humanized_name,
|
|
admin_route: plugin.full_admin_route,
|
|
enabled: plugin.enabled?,
|
|
description: plugin.metadata.about,
|
|
}
|
|
end,
|
|
)
|
|
end
|
|
end
|
|
|
|
def preload_anonymous_data
|
|
check_readonly_mode if @readonly_mode.nil?
|
|
@preloaded["site"] = Site.json_for(@guardian)
|
|
@preloaded["siteSettings"] = SiteSetting.client_settings_json
|
|
@preloaded["themeSiteSettingOverrides"] = SiteSetting.theme_site_settings_json(@theme_id)
|
|
@preloaded["customHTML"] = custom_html_json
|
|
@preloaded["banner"] = banner_json
|
|
@preloaded["customEmoji"] = custom_emoji
|
|
@preloaded["isReadOnly"] = @readonly_mode.to_json
|
|
@preloaded["isStaffWritesOnly"] = @staff_writes_only_mode.to_json
|
|
@preloaded["activatedThemes"] = activated_themes_json
|
|
end
|
|
|
|
def activated_themes_json
|
|
id = @theme_id
|
|
return "{}" if id.blank?
|
|
ids = Theme.transform_ids(id)
|
|
Theme.where(id: ids).pluck(:id, :name).to_h.to_json
|
|
end
|
|
|
|
def load_font_map
|
|
DiscourseFonts
|
|
.fonts
|
|
.each_with_object({}) do |font, font_map|
|
|
next if !font[:variants]
|
|
font_map[font[:key]] = font[:variants].map do |v|
|
|
{
|
|
url: "#{Discourse.base_url}/fonts/#{v[:filename]}?v=#{DiscourseFonts::VERSION}",
|
|
weight: v[:weight],
|
|
}
|
|
end
|
|
end
|
|
end
|
|
|
|
def custom_emoji
|
|
serializer = ActiveModel::ArraySerializer.new(Emoji.custom, each_serializer: EmojiSerializer)
|
|
MultiJson.dump(serializer)
|
|
end
|
|
end
|