A platform for community discussion. Free, open, simple.
# frozen_string_literal: true
module SvgSprite
SVG_ICONS =
Set.new(
%w[
a
address-book
address-card
align-center
align-left
align-right
anchor
angle-down
angle-left
angle-right
angle-up
angles-down
angles-left
angles-right
angles-up
arrow-down
arrow-down-wide-short
arrow-left
arrow-right
arrow-rotate-left
arrow-rotate-right
arrow-up
arrow-up-from-bracket
arrows-rotate
asterisk
at
backward
backward-fast
backward-step
ban
bars
bars-staggered
bed
bell
bell-slash
bold
book
book-open-reader
bookmark
bookmark-delete
box-archive
briefcase
bullseye
calendar-days
caret-down
caret-left
caret-right
caret-up
certificate
chart-bar
chart-pie
check
chevron-down
chevron-left
chevron-right
chevron-up
circle
circle-check
circle-chevron-down
circle-exclamation
circle-half-stroke
circle-info
circle-minus
circle-plus
circle-question
circle-user
circle-xmark
clock
clock-rotate-left
cloud-arrow-down
cloud-arrow-up
code
code-branch
comment
comments
compress
copy
crosshairs
cube
cubes
desktop
diagram-project
dice
discourse-amazon
discourse-bell-exclamation
discourse-bell-one
discourse-bell-slash
discourse-bookmark-clock
discourse-chevron-collapse
discourse-chevron-expand
discourse-circle-minus
discourse-circle-plus
discourse-compress
discourse-dnd
discourse-emojis
discourse-expand
discourse-flask-check
discourse-other-tab
discourse-sidebar
discourse-sparkles
discourse-table
discourse-text
discourse-threads
discourse-chat-search
discourse-add-translation
download
discourse-h1
discourse-h2
discourse-h3
discourse-h4
discourse-h5
earth-americas
ellipsis
ellipsis-vertical
envelope
expand
eye
eye-dropper
eye-slash
fab-android
fab-apple
fab-chrome
fab-discord
fab-discourse
fab-edge
fab-facebook
fab-facebook-square
fab-firefox-browser
fab-github
fab-google
fab-instagram
fab-internet-explorer
fab-linkedin-in
fab-linux
fab-microsoft
fab-markdown
fab-opera
fab-qq
fab-safari
fab-threads
fab-threads-square
fab-twitter
fab-twitter-square
fab-x-twitter
fab-wikipedia-w
fab-windows
far-bell
far-bell-slash
far-bookmark
far-calendar-plus
far-chart-bar
far-circle
far-circle-dot
far-circle-question
far-clipboard
far-clock
far-comment
far-comments
far-copyright
far-envelope
far-eye
far-eye-slash
far-face-frown
far-face-meh
far-face-smile
far-file-lines
far-heart
far-image
far-moon
far-pen-to-square
far-rectangle-list
far-square
far-square-check
far-star
far-sun
far-thumbs-down
far-thumbs-up
far-trash-can
file
file-lines
filter
filter-circle-xmark
flag
flask
folder
folder-open
font
forward
forward-fast
forward-step
gavel
gear
gif
gift
globe
grip-lines
grip-vertical
hand-point-right
handshake-angle
hashtag
heart
hourglass-start
house
id-card
image
images
inbox
italic
key
keyboard
language
layer-group
left-right
link
link-slash
list
list-check
list-ol
list-ul
location-dot
lock
magnifying-glass
magnifying-glass-minus
magnifying-glass-plus
microphone-slash
minus
mobile-screen-button
moon
nested-thread
paintbrush
palette
paper-plane
pause
pen
pencil
play
plug
plus
power-off
puzzle-piece
question
quote-left
quote-right
reply
right-from-bracket
right-left
right-to-bracket
robot
rocket
rotate
screwdriver-wrench
scroll
share
shield-halved
shuffle
signal
sign-hanging
sliders
spinner
square-check
square-envelope
square-full
square-plus
star
sun
table
table-cells
table-cells-minus
table-cells-plus
table-columns
tag
tags
temperature-three-quarters
thumbs-down
thumbs-up
thumbtack
tippy-rounded-arrow
toggle-off
toggle-on
trash-can
triangle-exclamation
truck-medical
unlock
unlock-keyhole
up-down
up-right-from-square
upload
user
user-check
user-gear
user-group
user-pen
user-plus
user-secret
user-shield
user-xmark
users
video
wand-magic
wrench
xmark
],
)
THEME_SPRITE_VAR_NAME = "icons-sprite"
MAX_THEME_SPRITE_SIZE = 1024.kilobytes
def self.preload
settings_icons
group_icons
badge_icons
end
def self.symbols_for(svg_filename, sprite, strict:)
if strict
Nokogiri.XML(sprite) { |config| config.options = Nokogiri::XML::ParseOptions::NOBLANKS }
else
Nokogiri.XML(sprite)
end.css("symbol")
.filter_map do |sym|
icon_id = prepare_symbol(sym, svg_filename)
if icon_id.present?
sym.attributes["id"].value = icon_id
# Some glyphs draw outside their viewBox; Firefox and Safari clip a <use> symbol
# to its viewBox unless overflow is set on the symbol itself (page CSS can't reach it)
sym["overflow"] = "visible"
sym.css("title").each(&:remove)
[icon_id, sym.to_xml]
end
end
.to_h
end
def self.core_svgs_files
@svg_files ||= Dir.glob("#{Rails.root.join("vendor/assets/svg-icons/**/*.svg")}")
end
def self.core_svgs
@core_svgs ||=
core_svgs_files.reduce({}) do |symbols, path|
symbols.merge!(symbols_for(File.basename(path, ".svg"), File.read(path), strict: true))
end
end
def self.legacy_icon_ids
@legacy_icon_ids ||=
core_svgs_files
.select { |path| File.basename(File.dirname(path)) == FontAwesomeSync::LEGACY_DIRECTORY }
.flat_map do |path|
symbols_for(File.basename(path, ".svg"), File.read(path), strict: true).keys
end
end
def self.site_symbols(icon_ids)
symbols = core_svgs.slice(*icon_ids)
DiscoursePluginRegistry.svg_symbol_sources.each do |source|
missing = icon_ids - symbols.keys
break if missing.empty?
symbols.merge!(source.symbols(missing).slice(*missing))
end
symbols
end
# Just used in tests
def self.clear_plugin_svg_sprite_cache!
@plugin_svgs = nil
end
def self.plugin_svgs
@plugin_svgs ||=
begin
plugin_paths = []
Discourse
.plugins
.map { |plugin| File.dirname(plugin.path) }
.each { |path| plugin_paths << "#{path}/svg-icons/*.svg" }
custom_sprite_paths = Dir.glob(plugin_paths)
custom_sprite_paths.reduce({}) do |symbols, path|
symbols.merge!(symbols_for(File.basename(path, ".svg"), File.read(path), strict: true))
end
end
end
def self.theme_svgs(theme_id)
if theme_id.present?
cache
.defer_get_set_bulk(
Theme.transform_ids(theme_id),
lambda { |_theme_id| "theme_svg_sprites_#{_theme_id}" },
) do |theme_ids|
theme_field_uploads =
ThemeField.where(
type_id: ThemeField.types[:theme_upload_var],
name: THEME_SPRITE_VAR_NAME,
theme_id: theme_ids,
).pluck(:upload_id)
theme_sprites =
ThemeSvgSprite.where(theme_id: theme_ids).pluck(:theme_id, :upload_id, :sprite)
missing_sprites = (theme_field_uploads - theme_sprites.map(&:second))
if missing_sprites.present?
Rails.logger.warn(
"Missing ThemeSvgSprites for theme #{theme_id}, uploads #{missing_sprites.join(", ")}",
)
end
theme_sprites
.map do |(_theme_id, upload_id, sprite)|
[_theme_id, symbols_for("theme_#{_theme_id}_#{upload_id}.svg", sprite, strict: false)]
rescue => e
Rails.logger.warn(
"Bad XML in custom sprite in theme with ID=#{_theme_id}. Error info: #{e.inspect}",
)
end
.compact
.to_h
.values_at(*theme_ids)
end
.values
.compact
.reduce({}) { |a, b| a.merge!(b) }
else
{}
end
end
def self.custom_svgs(theme_id)
plugin_svgs.merge(theme_svgs(theme_id))
end
def self.all_icons(theme_id = nil)
get_set_cache("icons_#{Theme.transform_ids(theme_id).join(",")}") do
Set
.new()
.merge(settings_icons)
.merge(plugin_icons)
.merge(plugin_icon_sources)
.merge(badge_icons)
.merge(group_icons)
.merge(theme_icons(theme_id))
.merge(custom_icons(theme_id))
.delete_if { |i| i.blank? || i.include?("/") }
.map!(&:strip)
.merge(SVG_ICONS)
.sort
end
end
def self.version(theme_id = nil)
get_set_cache("version_#{Theme.transform_ids(theme_id).join(",")}") do
Digest::SHA1.hexdigest(bundle(theme_id))
end
end
def self.path(theme_id = nil)
"/svg-sprite/#{Discourse.current_hostname}/svg-#{theme_id}-#{version(theme_id)}.js"
end
def self.expire_cache
cache&.clear
end
def self.bundle(theme_id = nil)
icons = all_icons(theme_id)
svg_subset =
"" \
"<!--
Discourse SVG subset of Font Awesome Free by @fontawesome - https://fontawesome.com
License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License)
-->
<svg xmlns='http://www.w3.org/2000/svg' style='display: none;'>
" \
"".dup
symbols = site_symbols(icons)
svg_subset << icons.filter_map { |icon| symbols[icon] }.join
svg_subset << custom_svgs(theme_id).values.join
svg_subset << "</svg>"
end
def self.search(searched_icon)
icon = searched_icon.strip
theme_id = SiteSetting.default_theme_id
custom = theme_id.present? ? custom_svgs(theme_id) : {}
custom[icon] || site_symbols([icon])[icon] || false
end
def self.icon_picker_search(keyword, only_available, page:, per_page:, theme_id: nil)
keyword = keyword.to_s.downcase
limit = (page + 1) * per_page + 1
in_sprite = picker_sprite_icon_ids(theme_id)
ids = in_sprite.lazy.select { |id| id.downcase.include?(keyword) }.first(limit)
if !only_available && ids.size < limit
ids.concat(picker_other_icon_ids(theme_id, keyword, limit - ids.size))
end
ids = ids.drop(page * per_page)
has_more = ids.size > per_page
ids = ids.take(per_page)
missing = only_available ? [] : (ids - in_sprite).to_set
return { icons: ids.map { |id| { id: } }, has_more: } if missing.empty?
custom = theme_id.present? ? custom_svgs(theme_id) : {}
site = site_symbols(missing.to_a)
icons =
ids.map { |id| missing.include?(id) ? { id:, symbol: custom[id] || site[id] } : { id: } }
{ icons:, has_more: }
end
def self.picker_sprite_icon_ids(theme_id)
get_set_cache("picker_sprite_icon_ids_#{Theme.transform_ids(theme_id).join(",")}") do
icons = all_icons(theme_id)
available = site_symbols(icons).keys.to_set
available.merge(custom_svgs(theme_id).keys) if theme_id.present?
icons.select { |id| available.include?(id) }
end
end
def self.picker_other_icon_ids(theme_id, keyword, limit)
in_sprite = picker_sprite_icon_ids(theme_id)
local =
get_set_cache("picker_other_icon_ids_#{Theme.transform_ids(theme_id).join(",")}") do
ids = core_svgs.keys
ids |= custom_svgs(theme_id).keys if theme_id.present?
# Legacy names still render where already used, but aren't offered for new picks
(ids - in_sprite - legacy_icon_ids).sort
end
ids = local.lazy.select { |id| id.downcase.include?(keyword) }.first(limit)
DiscoursePluginRegistry.svg_symbol_sources.each do |source|
ids.concat(source.search_icon_ids(keyword, limit: limit + in_sprite.size) - in_sprite)
end
ids.uniq.sort.first(limit)
end
# For use in no_ember .html.erb layouts
def self.raw_svg(name)
get_set_cache("raw_svg_#{name}") do
symbol = search(name)
break "" unless symbol
symbol = Nokogiri.XML(symbol).children.first
symbol.name = "svg"
<<~HTML
<svg class="fa d-icon svg-icon svg-node" aria-hidden="true">#{symbol}</svg>
HTML
end.html_safe
end
def self.theme_sprite_variable_name
THEME_SPRITE_VAR_NAME
end
def self.prepare_symbol(symbol, svg_filename = nil)
icon_id = symbol.attr("id")
case svg_filename
when "regular"
icon_id = icon_id.prepend("far-")
when "brands"
icon_id = icon_id.prepend("fab-")
end
icon_id
end
def self.settings_icons
get_set_cache("settings_icons") do
# includes svg_icon_subset, icon type settings, icon properties of objects
# type settings, and any settings containing _icon (incl. plugin settings)
site_setting_icons = []
SiteSetting.settings_hash.each do |key, value|
next unless String === value
if key.to_s.include?("_icon") || SiteSetting.type_supervisor.get_type(key) == :icon
site_setting_icons |= value.split("|")
elsif SiteSetting.type_supervisor.get_type(key) == :objects && value.present?
schema = SiteSetting.type_supervisor.type_hash(key)[:schema]
site_setting_icons |= objects_setting_icons(schema, JSON.parse(value)) if schema
end
end
site_setting_icons
end
end
def self.plugin_icons
DiscoursePluginRegistry.svg_icons
end
def self.plugin_icon_sources
DiscoursePluginRegistry.svg_icon_sources.flat_map { |source| Array(source.call) }
end
def self.badge_icons
get_set_cache("badge_icons") { Badge.pluck(:icon).uniq }
end
def self.group_icons
get_set_cache("group_icons") { Group.pluck(:flair_icon).uniq }
end
def self.theme_icons(theme_id)
return [] if theme_id.blank?
theme_icon_settings = []
theme_ids = Theme.transform_ids(theme_id)
# Need to load full records for default values
Theme
.where(id: theme_ids)
.each do |theme|
settings = theme.cached_settings
type_info = settings["theme_setting_type_info"] || {}
settings.each do |key, value|
if String === value
if key.to_s.include?("_icon") || type_info.dig(key, :type) == "icon"
theme_icon_settings |= value.split("|")
end
elsif type_info.dig(key, :type) == "objects" && value.is_a?(Array)
schema = type_info.dig(key, :schema)
theme_icon_settings |= objects_setting_icons(schema, value) if schema
end
end
end
theme_icon_settings |= ThemeModifierHelper.new(theme_ids: theme_ids).svg_icons
theme_icon_settings
end
def self.objects_setting_icons(schema, objects)
SchemaSettingsObjectValidator.property_values_of_type(schema:, objects:, type: "icon").grep(
String,
)
end
def self.custom_icons(theme_id)
# Automatically register icons in sprites added via themes or plugins
custom_svgs(theme_id).keys
end
def self.get_set_cache(key, &block)
cache.defer_get_set(key, &block)
end
def self.cache
@cache ||= DistributedCache.new("svg_sprite")
end
end