A platform for community discussion. Free, open, simple.
FEATURE: Add `emoji_picker_pinned_groups` for pinning groups in the picker (#41881)
Steven Chang07a13cfd47e0
diff --git a/app/controllers/emojis_controller.rb b/app/controllers/emojis_controller.rbindex 6a35c6faabe..bb5af9846b5 100644--- a/app/controllers/emojis_controller.rb+++ b/app/controllers/emojis_controller.rb@@ -2,8 +2,7 @@class EmojisController < ApplicationControllerdef index- emojis = Emoji.allowed.group_by(&:group)- render json: MultiJson.dump(emojis)+ render json: MultiJson.dump(Emoji.grouped)enddef search_aliasesdiff --git a/app/models/emoji.rb b/app/models/emoji.rbindex 826586c90c1..094d89f6e13 100644--- a/app/models/emoji.rb+++ b/app/models/emoji.rb@@ -47,6 +47,14 @@ class EmojiDiscourse.cache.fetch(cache_key("denied_emojis")) { load_denied }end+ def self.grouped+ groups = allowed.group_by(&:group)+ pinned = SiteSetting.emoji_picker_pinned_groups_map+ return groups if pinned.empty?++ groups.sort_by { |key, _| pinned.index(key) || pinned.length }.to_h+ end+def self.aliasesaliases_dbenddiff --git a/config/locales/server.en.yml b/config/locales/server.en.ymlindex 54371aabf57..eacaf3a0661 100644--- a/config/locales/server.en.yml+++ b/config/locales/server.en.yml@@ -2720,6 +2720,7 @@ en:emoji_autocomplete_min_chars: "Minimum number of characters required to trigger autocomplete emoji popup"enable_inline_emoji_translation: "Enables translation for inline emojis (without any space or punctuation before)"emoji_deny_list: "These emoji will not be available to use in menus or shortcodes."+ emoji_picker_pinned_groups: "Emoji groups to pin to the top of the emoji picker. All other groups follow after any pinned groups."enable_gifs: "Adds a button to easily search and insert GIFs in posts."klipy_api_key: "Klipy API key. Required to power GIF search."klipy_file_detail: "Image format to use. WebP has smaller files that load quicker, while GIF provides compatibility with older browsers."@@ -2982,6 +2983,9 @@ en:invalid_integer_max: "Value cannot be higher than %{max}."invalid_integer: "Value must be an integer."regex_mismatch: "Value doesn't match the required format."+ emoji_picker_pinned_groups_invalid:+ one: "Unknown emoji group: %{groups}."+ other: "Unknown emoji groups: %{groups}."must_include_latest: "Top menu must include the 'latest' tab."top_menu_unread_not_allowed_with_unified_new: "The 'unread' menu item cannot be used when unified new is enabled."invalid_string: "Invalid value."diff --git a/config/site_settings.yml b/config/site_settings.ymlindex 62eb3b38450..d0a1dd4b90b 100644--- a/config/site_settings.yml+++ b/config/site_settings.yml@@ -1695,6 +1695,15 @@ posting:client: truerefresh: truearea: "emojis"+ emoji_picker_pinned_groups:+ type: list+ list_type: simple+ allow_any: true+ default: ""+ client: true+ refresh: true+ validator: "EmojiPickerPinnedGroupsValidator"+ area: "emojis"enable_gifs:default: falseclient: truediff --git a/frontend/discourse/app/components/emoji-picker/content.gjs b/frontend/discourse/app/components/emoji-picker/content.gjsindex edc68831819..61a2d26dc59 100644--- a/frontend/discourse/app/components/emoji-picker/content.gjs+++ b/frontend/discourse/app/components/emoji-picker/content.gjs@@ -34,7 +34,6 @@ import dAutoFocus from "discourse/ui-kit/modifiers/d-auto-focus";import { i18n } from "discourse-i18n";import DiversityMenu from "./diversity-menu";-const DEFAULT_VISIBLE_SECTIONS = ["favorites", "smileys_&_emotion"];const DEFAULT_LAST_SECTION = "favorites";const tonableEmojiTitle = (emoji, diversity) => {@@ -57,12 +56,13 @@ export default class EmojiPicker extends Component {@service emojiStore;@service capabilities;@service site;+ @service siteSettings;@tracked isFiltering = false;@tracked filteredEmojis = null;@tracked scrollObserverEnabled = true;@tracked scrollDirection = "up";- @tracked visibleSections = DEFAULT_VISIBLE_SECTIONS;+ @tracked visibleSections = this.initialVisibleSections;@tracked lastVisibleSection = DEFAULT_LAST_SECTION;@tracked term = this.args.term;@@ -100,6 +100,14 @@ export default class EmojiPicker extends Component {};});+ get initialVisibleSections() {+ const pinned =+ this.siteSettings.emoji_picker_pinned_groups+ ?.split("|")+ .filter(Boolean) ?? [];+ return ["favorites", ...[...pinned, "smileys_&_emotion"].slice(0, 3)];+ }+addVisibleSections(sections) {this.visibleSections = uniqueItemsFromArray(makeArray(this.visibleSections).concat(makeArray(sections))@@ -163,7 +171,7 @@ export default class EmojiPicker extends Component {if (!value?.length) {cancel(this.debouncedFilterHandler);- this.visibleSections = DEFAULT_VISIBLE_SECTIONS;+ this.visibleSections = this.initialVisibleSections;this.filteredEmojis = null;this.isFiltering = false;return;diff --git a/lib/compression/safe_zip_reader.rb b/lib/compression/safe_zip_reader.rbindex bf3855ac4db..3cbae17f617 100644--- a/lib/compression/safe_zip_reader.rb+++ b/lib/compression/safe_zip_reader.rb@@ -50,7 +50,7 @@ module Compressionenddef find_entry(name)- zip_file.find_entry(name)+ zip_file.find_entry(name) || find_prefixed_entry(name)enddef read_entry(entry_or_name, max_bytes:, required: false)@@ -77,6 +77,32 @@ module Compressionprivate+ # macOS Finder's "Compress" wraps the folder's contents in a root+ # directory and adds __MACOSX metadata entries, so lookups fall back to+ # resolving names through that wrapper directory.+ def find_prefixed_entry(name)+ root_prefix && zip_file.find_entry("#{root_prefix}#{name}")+ end++ def root_prefix+ return @root_prefix if defined?(@root_prefix)++ @root_prefix = compute_root_prefix+ end++ def compute_root_prefix+ names = entries.map(&:name).reject { |name| metadata_entry?(name) }+ first_segment, separator, _rest = names.first.to_s.partition("/")+ return if separator.empty?++ prefix = "#{first_segment}/"+ prefix if names.all? { |name| name.start_with?(prefix) }+ end++ def metadata_entry?(name)+ name.start_with?("__MACOSX/") || File.basename(name).start_with?(".")+ end+def resolve_entry(entry_or_name)entry_or_name.respond_to?(:get_input_stream) ? entry_or_name : find_entry(entry_or_name)enddiff --git a/lib/validators/emoji_picker_pinned_groups_validator.rb b/lib/validators/emoji_picker_pinned_groups_validator.rbnew file mode 100644index 00000000000..69f17525190--- /dev/null+++ b/lib/validators/emoji_picker_pinned_groups_validator.rb@@ -0,0 +1,30 @@+# frozen_string_literal: true++class EmojiPickerPinnedGroupsValidator+ def initialize(opts = {})+ @opts = opts+ end++ def valid_value?(val)+ return true if val.blank?++ groups = val.split("|").map(&:strip).reject(&:blank?)+ valid_groups = Set.new(Emoji.allowed.map(&:group))++ invalid = groups.reject { |g| valid_groups.include?(g) }+ if invalid.any?+ @invalid_groups = invalid+ return false+ end++ true+ end++ def error_message+ I18n.t(+ "site_settings.errors.emoji_picker_pinned_groups_invalid",+ groups: @invalid_groups.join(", "),+ count: @invalid_groups.size,+ )+ end+enddiff --git a/spec/lib/compression/safe_zip_reader_spec.rb b/spec/lib/compression/safe_zip_reader_spec.rbindex 99ea1f651c2..7a1cbccb68e 100644--- a/spec/lib/compression/safe_zip_reader_spec.rb+++ b/spec/lib/compression/safe_zip_reader_spec.rb@@ -77,6 +77,48 @@ RSpec.describe Compression::SafeZipReader do)end+ describe "root prefix handling" do+ it "resolves entries nested under a single root directory, ignoring macOS metadata entries" do+ create_zip(+ "cats/emojis.csv" => "csv",+ "cats/smile.png" => "png",+ "__MACOSX/._cats" => "junk",+ "__MACOSX/cats/._emojis.csv" => "junk",+ ".DS_Store" => "junk",+ )++ described_class.open(zip_path) do |zip|+ expect(zip.read_entry("emojis.csv", max_bytes: 10)).to eq("csv")+ expect(zip.read_entry("smile.png", max_bytes: 10)).to eq("png")+ end+ end++ it "still resolves entries by their exact nested name" do+ create_zip("cats/emojis.csv" => "csv")++ described_class.open(zip_path) do |zip|+ expect(zip.read_entry("cats/emojis.csv", max_bytes: 10)).to eq("csv")+ end+ end++ it "does not apply a prefix when entries span multiple top-level names" do+ create_zip("cats/emojis.csv" => "csv", "dogs/emojis.csv" => "csv")++ described_class.open(zip_path) do |zip|+ expect(zip.read_entry("emojis.csv", max_bytes: 10)).to be_nil+ end+ end++ it "does not treat a lone root-level file as a prefix" do+ create_zip("emojis.csv" => "csv")++ described_class.open(zip_path) do |zip|+ expect(zip.read_entry("emojis.csv", max_bytes: 10)).to eq("csv")+ expect(zip.read_entry("missing.csv", max_bytes: 10)).to be_nil+ end+ end+ end+it "streams entries to files within the configured limits" docreate_zip("document.xml" => "hello")diff --git a/spec/lib/validators/emoji_picker_pinned_groups_validator_spec.rb b/spec/lib/validators/emoji_picker_pinned_groups_validator_spec.rbnew file mode 100644index 00000000000..683517a7f52--- /dev/null+++ b/spec/lib/validators/emoji_picker_pinned_groups_validator_spec.rb@@ -0,0 +1,49 @@+# frozen_string_literal: true++RSpec.describe EmojiPickerPinnedGroupsValidator do+ subject(:validator) { described_class.new }++ before { Emoji.clear_cache }++ describe "#valid_value?" do+ it "accepts a blank value" do+ expect(validator.valid_value?("")).to be(true)+ expect(validator.valid_value?(nil)).to be(true)+ end++ it "accepts a standard emoji group name" do+ expect(validator.valid_value?("flags")).to be(true)+ end++ it "accepts multiple valid group names" do+ expect(validator.valid_value?("flags|activities")).to be(true)+ end++ it "accepts a custom emoji group name" do+ CustomEmoji.create!(name: "partyblob", upload_id: 9999, group: "reactions")+ Emoji.clear_cache+ expect(validator.valid_value?("reactions")).to be(true)+ end++ it "accepts the default custom group name" do+ CustomEmoji.create!(name: "partyblob", upload_id: 9999, group: nil)+ Emoji.clear_cache+ expect(validator.valid_value?(Emoji::DEFAULT_GROUP)).to be(true)+ end++ it "rejects an unknown group name" do+ expect(validator.valid_value?("nonexistent_group")).to be(false)+ end++ it "rejects a mix of valid and invalid group names" do+ expect(validator.valid_value?("flags|nonexistent_group")).to be(false)+ end+ end++ describe "#error_message" do+ it "lists the invalid group names" do+ validator.valid_value?("flags|bad_group|another_bad")+ expect(validator.error_message).to include("bad_group", "another_bad")+ end+ end+enddiff --git a/spec/models/emoji_spec.rb b/spec/models/emoji_spec.rbindex 231676897dc..f0e006ef83c 100644--- a/spec/models/emoji_spec.rb+++ b/spec/models/emoji_spec.rb@@ -254,6 +254,56 @@ RSpec.describe Emoji doendend+ describe ".grouped" do+ before { Emoji.clear_cache }++ it "returns all groups with standard groups present" do+ groups = Emoji.grouped+ expect(groups.keys).to include("flags", "smileys_&_emotion")+ end++ it "preserves standard group order when no groups are pinned" do+ SiteSetting.emoji_picker_pinned_groups = ""+ keys = Emoji.grouped.keys+ expect(keys.index("smileys_&_emotion")).to be < keys.index("flags")+ end++ it "pins a standard group to the top" do+ SiteSetting.emoji_picker_pinned_groups = "flags"+ expect(Emoji.grouped.keys.first).to eq("flags")+ end++ it "pins multiple groups in the configured order" do+ SiteSetting.emoji_picker_pinned_groups = "flags|activities"+ keys = Emoji.grouped.keys+ expect(keys[0]).to eq("flags")+ expect(keys[1]).to eq("activities")+ end++ it "pins a custom group to the top" do+ CustomEmoji.create!(name: "partyblob", upload_id: 9999, group: "reactions")+ Emoji.clear_cache+ SiteSetting.emoji_picker_pinned_groups = "reactions"+ expect(Emoji.grouped.keys.first).to eq("reactions")+ end++ it "silently ignores pinned groups that no longer exist" do+ # Simulate a group that was valid when saved but has since been deleted+ SiteSetting.stubs(:emoji_picker_pinned_groups).returns("nonexistent_group")+ expect { Emoji.grouped }.not_to raise_error+ expect(Emoji.grouped.keys).not_to include("nonexistent_group")+ end++ it "keeps unpinned groups after pinned ones" do+ SiteSetting.emoji_picker_pinned_groups = "flags"+ keys = Emoji.grouped.keys+ flags_index = keys.index("flags")+ smileys_index = keys.index("smileys_&_emotion")+ expect(flags_index).to eq(0)+ expect(smileys_index).to be > flags_index+ end+ end+describe ".load_standard" doit "removes nil emojis" doexpect(Emoji.load_standard.any?(&:nil?)).to be(false)