discourse/app/models/theme_modifier_set.rb
Sam c08c40dc23
FEATURE: theme_modifiers can depend on theme settings (plus serialize_post_user_badges) ()
Theme modifiers can now be defined as theme settings, this allows for
site operators to override behavior of theme modifiers.

New syntax is:

```
{
    ...
   "modifiers": {
      "modifier_name": {
         "type": "setting",
         "value": "setting_name"
      }
   }
}
```

This also introduces a new theme modifier for serialize_post_user_badges. Name of badge must match the name of the badge in the badges table. The client-side is updated to load this new data from the post-stream serializer.

Co-authored-by: David Taylor <david@taylorhq.com>
2024-10-17 15:16:16 +01:00

157 lines
4.5 KiB
Ruby

# frozen_string_literal: true
class ThemeModifierSet < ActiveRecord::Base
class ThemeModifierSetError < StandardError
end
belongs_to :theme
def self.modifiers
@modifiers ||= self.load_modifiers
end
validate :type_validator
def type_validator
ThemeModifierSet.modifiers.each do |k, config|
value = read_attribute(k)
next if value.nil?
case config[:type]
when :boolean
next if [true, false].include?(value)
when :string_array
next if value.is_a?(Array) && value.all? { |v| v.is_a?(String) }
end
errors.add(k, :invalid)
end
end
after_save do
SvgSprite.expire_cache if saved_change_to_svg_icons?
CSP::Extension.clear_theme_extensions_cache! if saved_change_to_csp_extensions?
end
# Given the ids of multiple active themes / theme components, this function
# will combine them into a 'resolved' behavior
def self.resolve_modifier_for_themes(theme_ids, modifier_name)
return nil if !(config = self.modifiers[modifier_name])
all_values =
self
.where(theme_id: theme_ids)
.where.not(modifier_name => nil)
.map { |s| s.public_send(modifier_name) }
case config[:type]
when :boolean
all_values.any?
when :string_array
all_values.flatten(1)
else
raise ThemeModifierSetError, "Invalid theme modifier combine_mode"
end
end
def topic_thumbnail_sizes
array = read_attribute(:topic_thumbnail_sizes)
return if array.nil?
array
.map do |dimension|
parts = dimension.split("x")
next if parts.length != 2
[parts[0].to_i, parts[1].to_i]
end
.filter(&:present?)
end
def topic_thumbnail_sizes=(val)
return write_attribute(:topic_thumbnail_sizes, val) if val.nil?
return write_attribute(:topic_thumbnail_sizes, val) if !val.is_a?(Array)
if !val.all? { |v| v.is_a?(Array) && v.length == 2 }
return write_attribute(:topic_thumbnail_sizes, val)
end
super(val.map { |dim| "#{dim[0]}x#{dim[1]}" })
end
def add_theme_setting_modifier(modifier_name, setting_name)
self.theme_setting_modifiers ||= {}
self.theme_setting_modifiers[modifier_name] = setting_name
end
def refresh_theme_setting_modifiers(target_setting_name: nil, target_setting_value: nil)
changed = false
if self.theme_setting_modifiers.present?
self.theme_setting_modifiers.each do |modifier_name, setting_name|
modifier_name = modifier_name.to_sym
setting_name = setting_name.to_sym
next if target_setting_name.present? && target_setting_name.to_sym != setting_name
value =
target_setting_name.present? ? target_setting_value : theme.settings[setting_name]&.value
value = coerce_setting_value(modifier_name, value)
if read_attribute(modifier_name) != value
write_attribute(modifier_name, value)
changed = true
end
end
end
changed
end
private
def coerce_setting_value(modifier_name, value)
type = ThemeModifierSet.modifiers.dig(modifier_name, :type)
if type == :boolean
value.to_s != "false"
elsif type == :string_array
value.is_a?(Array) ? value : value.to_s.split("|")
end
end
# Build the list of modifiers from the DB schema.
# This allows plugins to introduce new modifiers by adding columns to the table
def self.load_modifiers
hash = {}
columns_hash.each do |column_name, info|
next if %w[id theme_id theme_setting_modifiers].include?(column_name)
type = nil
if info.type == :string && info.array?
type = :string_array
elsif info.type == :boolean && !info.array?
type = :boolean
else
if !%i[boolean string].include?(info.type)
raise ThemeModifierSetError "Invalid theme modifier column type"
end
end
hash[column_name.to_sym] = { type: type }
end
hash
end
end
# == Schema Information
#
# Table name: theme_modifier_sets
#
# id :bigint not null, primary key
# theme_id :bigint not null
# serialize_topic_excerpts :boolean
# csp_extensions :string is an Array
# svg_icons :string is an Array
# topic_thumbnail_sizes :string is an Array
# custom_homepage :boolean
# serialize_post_user_badges :string is an Array
# theme_setting_modifiers :jsonb
#
# Indexes
#
# index_theme_modifier_sets_on_theme_id (theme_id) UNIQUE
#