mirror of
https://github.com/discourse/discourse.git
synced 2024-12-03 02:33:44 +08:00
03818e642a
This introduces new APIs for obtaining optimized thumbnails for topics. There are a few building blocks required for this:
- Introduces new `image_upload_id` columns on the `posts` and `topics` table. This replaces the old `image_url` column, which means that thumbnails are now restricted to uploads. Hotlinked thumbnails are no longer possible. In normal use (with pull_hotlinked_images enabled), this has no noticeable impact
- A migration attempts to match existing urls to upload records. If a match cannot be found then the posts will be queued for rebake
- Optimized thumbnails are generated during post_process_cooked. If thumbnails are missing when serializing a topic list, then a sidekiq job is queued
- Topic lists and topics now include a `thumbnails` key, which includes all the available images:
```
"thumbnails": [
{
"max_width": null,
"max_height": null,
"url": "//example.com/original-image.png",
"width": 1380,
"height": 1840
},
{
"max_width": 1024,
"max_height": 1024,
"url": "//example.com/optimized-image.png",
"width": 768,
"height": 1024
}
]
```
- Themes can request additional thumbnail sizes by using a modifier in their `about.json` file:
```
"modifiers": {
"topic_thumbnail_sizes": [
[200, 200],
[800, 800]
],
...
```
Remember that these are generated asynchronously, so your theme should include logic to fallback to other available thumbnails if your requested size has not yet been generated
- Two new raw plugin outlets are introduced, to improve the customisability of the topic list. `topic-list-before-columns` and `topic-list-before-link`
112 lines
3.1 KiB
Ruby
112 lines
3.1 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
|
|
if saved_change_to_svg_icons?
|
|
SvgSprite.expire_cache
|
|
end
|
|
if saved_change_to_csp_extensions?
|
|
CSP::Extension.clear_theme_extensions_cache!
|
|
end
|
|
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)
|
|
return write_attribute(:topic_thumbnail_sizes, val) if !val.all? { |v| v.is_a?(Array) && v.length == 2 }
|
|
|
|
super(val.map { |dim| "#{dim[0]}x#{dim[1]}" })
|
|
end
|
|
|
|
private
|
|
|
|
# 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 ["id", "theme_id"].include?(column_name)
|
|
|
|
type = nil
|
|
if info.type == :string && info.array?
|
|
type = :string_array
|
|
elsif info.type == :boolean && !info.array?
|
|
type = :boolean
|
|
else
|
|
raise ThemeModifierSetError "Invalid theme modifier column type" if ![:boolean, :string].include?(info.type)
|
|
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
|
|
#
|
|
# Indexes
|
|
#
|
|
# index_theme_modifier_sets_on_theme_id (theme_id) UNIQUE
|
|
#
|