# frozen_string_literal: true require_dependency 'distributed_cache' module SvgSprite SVG_ICONS ||= Set.new([ "adjust", "ambulance", "anchor", "angle-double-down", "angle-double-up", "angle-double-right", "angle-double-left", "angle-down", "angle-right", "angle-up", "archive", "arrow-down", "arrow-left", "arrow-up", "arrows-alt-h", "arrows-alt-v", "at", "backward", "ban", "bars", "bed", "bell-slash", "bold", "book", "bookmark", "briefcase", "calendar-alt", "caret-down", "caret-left", "caret-right", "caret-up", "certificate", "chart-bar", "chart-pie", "check", "check-circle", "check-square", "chevron-down", "chevron-left", "chevron-right", "chevron-up", "circle", "code", "cog", "columns", "comment", "compress", "copy", "crosshairs", "cube", "desktop", "discourse-compress", "discourse-expand", "download", "ellipsis-h", "ellipsis-v", "envelope", "envelope-square", "exchange-alt", "exclamation-circle", "exclamation-triangle", "external-link-alt", "fab-android", "fab-apple", "fab-chrome", "fab-discourse", "fab-facebook-square", "fab-facebook", "fab-github", "fab-google-plus-square", "fab-instagram", "fab-linux", "fab-twitter", "fab-twitter-square", "fab-windows", "far-bell", "far-bell-slash", "far-calendar-plus", "far-chart-bar", "far-check-square", "far-circle", "far-clipboard", "far-clock", "far-comment", "far-copyright", "far-dot-circle", "far-edit", "far-envelope", "far-eye", "far-eye-slash", "far-file-alt", "far-frown", "far-heart", "far-image", "far-list-alt", "far-moon", "far-smile", "far-square", "far-sun", "far-thumbs-down", "far-thumbs-up", "far-trash-alt", "fast-backward", "fast-forward", "file", "file-alt", "filter", "flag", "folder", "folder-open", "forward", "gavel", "globe", "globe-americas", "hand-point-right", "hands-helping", "heading", "heart", "home", "info-circle", "italic", "key", "link", "list", "list-ol", "list-ul", "lock", "magic", "map-marker-alt", "microphone-slash", "minus", "minus-circle", "mobile-alt", "paint-brush", "paper-plane", "pencil-alt", "play", "plug", "plus", "plus-circle", "plus-square", "power-off", "puzzle-piece", "question", "question-circle", "quote-left", "quote-right", "random", "redo", "reply", "rocket", "search", "share", "shield-alt", "shower", "sign-in-alt", "sign-out-alt", "signal", "step-backward", "step-forward", "sync", "table", "tag", "tasks", "thermometer-three-quarters", "thumbs-down", "thumbs-up", "thumbtack", "times", "times-circle", "trash-alt", "tv", "undo", "unlink", "unlock", "unlock-alt", "upload", "user", "user-edit", "user-plus", "user-secret", "user-shield", "user-times", "users", "wrench" ]) FA_ICON_MAP = { 'far fa-' => 'far-', 'fab fa-' => 'fab-', 'fas fa-' => '', 'fa-' => '' } CORE_SVG_SPRITES = Dir.glob("#{Rails.root}/vendor/assets/svg-icons/**/*.svg") THEME_SPRITE_VAR_NAME = "icons-sprite" def self.custom_svg_sprites(theme_ids = []) custom_sprite_paths = Dir.glob("#{Rails.root}/plugins/*/svg-icons/*.svg") ThemeField.where(type_id: ThemeField.types[:theme_upload_var], name: THEME_SPRITE_VAR_NAME, theme_id: Theme.transform_ids(theme_ids)) .pluck(:upload_id).each do |upload_id| upload = Upload.find(upload_id) rescue nil if Discourse.store.external? external_copy = Discourse.store.download(upload) rescue nil original_path = external_copy.try(:path) else original_path = Discourse.store.path_for(upload) end custom_sprite_paths << original_path if original_path.present? end custom_sprite_paths end def self.all_icons(theme_ids = []) get_set_cache("icons_#{Theme.transform_ids(theme_ids).join(',')}") do Set.new() .merge(settings_icons) .merge(plugin_icons) .merge(badge_icons) .merge(group_icons) .merge(theme_icons(theme_ids)) .merge(custom_icons(theme_ids)) .delete_if { |i| i.blank? || i.include?("/") } .map! { |i| process(i.dup) } .merge(SVG_ICONS) .sort end end def self.version(theme_ids = []) get_set_cache("version_#{Theme.transform_ids(theme_ids).join(',')}") do Digest::SHA1.hexdigest(all_icons(theme_ids).join('|')) end end def self.path(theme_ids = []) "/svg-sprite/#{Discourse.current_hostname}/svg-#{theme_ids&.join(",")}-#{version(theme_ids)}.js" end def self.expire_cache cache&.clear end def self.sprite_sources(theme_ids) CORE_SVG_SPRITES | custom_svg_sprites(theme_ids) end def self.bundle(theme_ids = []) icons = all_icons(theme_ids) svg_subset = """ """.dup sprite_sources(theme_ids).each do |fname| svg_file = Nokogiri::XML(File.open(fname)) do |config| config.options = Nokogiri::XML::ParseOptions::NOBLANKS end svg_filename = "#{File.basename(fname, ".svg")}" svg_file.css('symbol').each do |sym| icon_id = prepare_symbol(sym, svg_filename) if icons.include? icon_id sym.attributes['id'].value = icon_id sym.css('title').each(&:remove) svg_subset << sym.to_xml end end end svg_subset << '' end def self.search(searched_icon) searched_icon = process(searched_icon.dup) sprite_sources([SiteSetting.default_theme_id]).each do |fname| svg_file = Nokogiri::XML(File.open(fname)) svg_filename = "#{File.basename(fname, ".svg")}" svg_file.css('symbol').each do |sym| icon_id = prepare_symbol(sym, svg_filename) if searched_icon == icon_id sym.attributes['id'].value = icon_id sym.css('title').each(&:remove) return sym.to_xml end end end false 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 HTML end.html_safe end def self.theme_sprite_variable_name THEME_SPRITE_VAR_NAME end def self.prepare_symbol(symbol, svg_filename) 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 # includes svg_icon_subset and any settings containing _icon (incl. plugin settings) site_setting_icons = [] SiteSetting.settings_hash.select do |key, value| if key.to_s.include?("_icon") && String === value site_setting_icons |= value.split('|') end end site_setting_icons end def self.plugin_icons DiscoursePluginRegistry.svg_icons end def self.badge_icons Badge.pluck(:icon).uniq end def self.group_icons Group.where("flair_url LIKE '%fa-%'").pluck(:flair_url).uniq end def self.theme_icons(theme_ids) theme_icon_settings = [] # Need to load full records for default values Theme.where(id: Theme.transform_ids(theme_ids)).each do |theme| settings = theme.cached_settings.each do |key, value| if key.to_s.include?("_icon") && String === value theme_icon_settings |= value.split('|') end end end theme_icon_settings end def self.custom_icons(theme_ids) # Automatically register icons in sprites added via themes or plugins icons = [] custom_svg_sprites(theme_ids).each do |fname| svg_file = Nokogiri::XML(File.open(fname)) svg_file.css('symbol').each do |sym| icons << sym.attributes['id'].value if sym.attributes['id'].present? end end icons end def self.fa4_shim_file "#{Rails.root}/lib/svg_sprite/fa4-renames.json" end def self.fa4_to_fa5_names @db ||= File.open(fa4_shim_file, "r:UTF-8") { |f| JSON.parse(f.read) } end def self.process(icon_name) icon_name.strip! FA_ICON_MAP.each { |k, v| icon_name.sub!(k, v) } fa4_to_fa5_names[icon_name] || icon_name end def self.get_set_cache(key) cache[key] ||= yield end def self.cache @cache ||= DistributedCache.new('svg_sprite') end end