1 # Pleroma: A lightweight social networking server
2 # Copyright © 2017-2019 Pleroma Authors <https://pleroma.social/>
3 # SPDX-License-Identifier: AGPL-3.0-only
5 defmodule Pleroma.Emoji do
7 The emojis are loaded from:
9 * emoji packs in INSTANCE-DIR/emoji
10 * the files: `config/emoji.txt` and `config/custom_emoji.txt`
11 * glob paths, nested folder is used as tag name for grouping e.g. priv/static/emoji/custom/nested_folder
13 This GenServer stores in an ETS table the list of the loaded emojis, and also allows to reload the list at runtime.
19 @type pattern :: Regex.t() | module() | String.t()
20 @type patterns :: pattern() | [pattern()]
21 @type group_patterns :: keyword(patterns())
24 @ets_options [:ordered_set, :protected, :named_table, {:read_concurrency, true}]
25 @groups Pleroma.Config.get([:emoji, :groups])
29 GenServer.start_link(__MODULE__, [], name: __MODULE__)
32 @doc "Reloads the emojis from disk."
35 GenServer.call(__MODULE__, :reload)
38 @doc "Returns the path of the emoji `name`."
39 @spec get(String.t()) :: String.t() | nil
41 case :ets.lookup(@ets, name) do
47 @doc "Returns all the emojos!!"
48 @spec get_all() :: [{String.t(), String.t()}, ...]
55 @ets = :ets.new(@ets, @ets_options)
56 GenServer.cast(self(), :reload)
61 def handle_cast(:reload, state) do
67 def handle_call(:reload, _from, state) do
73 def terminate(_, _) do
78 def code_change(_old_vsn, state, _extra) do
86 Pleroma.Config.get!([:instance, :static_dir]),
90 case File.ls(emoji_dir_path) do
92 # The custom emoji directory doesn't exist,
97 # There was some other error
98 Logger.error("Could not access the custom emoji directory #{emoji_dir_path}: #{e}")
102 Enum.group_by(results, fn file -> File.dir?(Path.join(emoji_dir_path, file)) end)
104 packs = grouped[true] || []
105 files = grouped[false] || []
107 # Print the packs we've found
108 Logger.info("Found emoji packs: #{Enum.join(packs, ", ")}")
110 if not Enum.empty?(files) do
112 "Found files in the emoji folder. These will be ignored, please move them to a subdirectory\nFound files: #{
113 Enum.join(files, ", ")
121 fn pack -> load_pack(Path.join(emoji_dir_path, pack)) end
124 true = :ets.insert(@ets, emojis)
127 # Compat thing for old custom emoji handling & default emoji,
128 # it should run even if there are no emoji packs
129 shortcode_globs = Pleroma.Config.get([:emoji, :shortcode_globs], [])
132 (load_from_file("config/emoji.txt") ++
133 load_from_file("config/custom_emoji.txt") ++
134 load_from_globs(shortcode_globs))
135 |> Enum.reject(fn value -> value == nil end)
137 true = :ets.insert(@ets, emojis)
142 defp load_pack(pack_dir) do
143 pack_name = Path.basename(pack_dir)
145 emoji_txt = Path.join(pack_dir, "emoji.txt")
147 if File.exists?(emoji_txt) do
148 load_from_file(emoji_txt)
151 "No emoji.txt found for pack \"#{pack_name}\", assuming all .png files are emoji"
154 make_shortcode_to_file_map(pack_dir, [".png"])
155 |> Enum.map(fn {shortcode, rel_file} ->
156 filename = Path.join("/emoji/#{pack_name}", rel_file)
158 {shortcode, filename, [to_string(match_extra(@groups, filename))]}
163 def make_shortcode_to_file_map(pack_dir, exts) do
164 find_all_emoji(pack_dir, exts)
165 |> Enum.map(&Path.relative_to(&1, pack_dir))
166 |> Enum.map(fn f -> {f |> Path.basename() |> Path.rootname(), f} end)
170 def find_all_emoji(dir, exts) do
175 filepath = Path.join(dir, f)
177 if File.dir?(filepath) do
178 acc ++ find_all_emoji(filepath, exts)
184 |> Enum.filter(fn f -> Path.extname(f) in exts end)
187 defp load_from_file(file) do
188 if File.exists?(file) do
189 load_from_file_stream(File.stream!(file))
195 defp load_from_file_stream(stream) do
197 |> Stream.map(&String.trim/1)
198 |> Stream.map(fn line ->
199 case String.split(line, ~r/,\s*/) do
201 {name, file, [to_string(match_extra(@groups, file))]}
203 [name, file | tags] ->
213 defp load_from_globs(globs) do
214 static_path = Path.join(:code.priv_dir(:pleroma), "static")
217 Enum.map(globs, fn glob ->
218 Path.join(static_path, glob)
223 Enum.map(paths, fn path ->
224 tag = match_extra(@groups, Path.join("/", Path.relative_to(path, static_path)))
225 shortcode = Path.basename(path, Path.extname(path))
226 external_path = Path.join("/", Path.relative_to(path, static_path))
227 {shortcode, external_path, [to_string(tag)]}
232 Finds a matching group for the given emoji filename
234 @spec match_extra(group_patterns(), String.t()) :: atom() | nil
235 def match_extra(group_patterns, filename) do
236 match_group_patterns(group_patterns, fn pattern ->
238 %Regex{} = regex -> Regex.match?(regex, filename)
239 string when is_binary(string) -> filename == string
244 defp match_group_patterns(group_patterns, matcher) do
245 Enum.find_value(group_patterns, fn {group, patterns} ->
249 |> Enum.map(fn pattern ->
250 if String.contains?(pattern, "*") do
251 ~r(#{String.replace(pattern, "*", ".*")})
257 Enum.any?(patterns, matcher) && group