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.Loader do
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
17 @type pattern :: Regex.t() | module() | String.t()
18 @type patterns :: pattern() | [pattern()]
19 @type group_patterns :: keyword(patterns())
20 @type emoji :: {String.t(), String.t(), list(String.t())}
23 Loads emojis from files/packs.
25 returns list emojis in format:
26 `{"000", "/emoji/freespeechextremist.com/000.png", ["Custom"]}`
28 @spec load() :: list(emoji)
30 emoji_dir_path = Path.join(Config.get!([:instance, :static_dir]), "emoji")
32 emoji_groups = Config.get([:emoji, :groups])
35 case File.ls(emoji_dir_path) do
37 # The custom emoji directory doesn't exist,
42 # There was some other error
43 Logger.error("Could not access the custom emoji directory #{emoji_dir_path}: #{e}")
48 Enum.group_by(results, fn file ->
49 File.dir?(Path.join(emoji_dir_path, file))
52 packs = grouped[true] || []
53 files = grouped[false] || []
55 # Print the packs we've found
56 Logger.info("Found emoji packs: #{Enum.join(packs, ", ")}")
58 if not Enum.empty?(files) do
60 "Found files in the emoji folder. These will be ignored, please move them to a subdirectory\nFound files: #{
61 Enum.join(files, ", ")
66 Enum.flat_map(packs, fn pack ->
67 load_pack(Path.join(emoji_dir_path, pack), emoji_groups)
71 # Compat thing for old custom emoji handling & default emoji,
72 # it should run even if there are no emoji packs
73 shortcode_globs = Config.get([:emoji, :shortcode_globs], [])
76 (load_from_file("config/emoji.txt", emoji_groups) ++
77 load_from_file("config/custom_emoji.txt", emoji_groups) ++
78 load_from_globs(shortcode_globs, emoji_groups))
79 |> Enum.reject(fn value -> value == nil end)
81 Enum.map(emojis ++ emojis_txt, &prepare_emoji/1)
84 defp prepare_emoji({code, file, tags} = _emoji) do
89 Pleroma.HTML.strip_tags(code),
90 Pleroma.HTML.strip_tags(file)
94 defp load_pack(pack_dir, emoji_groups) do
95 pack_name = Path.basename(pack_dir)
97 emoji_txt = Path.join(pack_dir, "emoji.txt")
99 if File.exists?(emoji_txt) do
100 load_from_file(emoji_txt, emoji_groups)
102 extensions = Config.get([:emoji, :pack_extensions])
105 "No emoji.txt found for pack \"#{pack_name}\", assuming all #{Enum.join(extensions, ", ")} files are emoji"
108 make_shortcode_to_file_map(pack_dir, extensions)
109 |> Enum.map(fn {shortcode, rel_file} ->
110 filename = Path.join("/emoji/#{pack_name}", rel_file)
112 {shortcode, filename, [to_string(match_extra(emoji_groups, filename))]}
117 def make_shortcode_to_file_map(pack_dir, exts) do
118 find_all_emoji(pack_dir, exts)
119 |> Enum.map(&Path.relative_to(&1, pack_dir))
120 |> Enum.map(fn f -> {f |> Path.basename() |> Path.rootname(), f} end)
124 def find_all_emoji(dir, exts) do
127 |> Enum.flat_map(fn f ->
128 filepath = Path.join(dir, f)
130 if File.dir?(filepath) do
131 find_all_emoji(filepath, exts)
136 |> Enum.filter(fn f -> Path.extname(f) in exts end)
139 defp load_from_file(file, emoji_groups) do
140 if File.exists?(file) do
141 load_from_file_stream(File.stream!(file), emoji_groups)
147 defp load_from_file_stream(stream, emoji_groups) do
149 |> Stream.map(&String.trim/1)
150 |> Stream.map(fn line ->
151 case String.split(line, ~r/,\s*/) do
153 {name, file, [to_string(match_extra(emoji_groups, file))]}
155 [name, file | tags] ->
165 defp load_from_globs(globs, emoji_groups) do
166 static_path = Path.join(:code.priv_dir(:pleroma), "static")
169 Enum.map(globs, fn glob ->
170 Path.join(static_path, glob)
175 Enum.map(paths, fn path ->
176 tag = match_extra(emoji_groups, Path.join("/", Path.relative_to(path, static_path)))
177 shortcode = Path.basename(path, Path.extname(path))
178 external_path = Path.join("/", Path.relative_to(path, static_path))
179 {shortcode, external_path, [to_string(tag)]}
184 Finds a matching group for the given emoji filename
186 @spec match_extra(group_patterns(), String.t()) :: atom() | nil
187 def match_extra(group_patterns, filename) do
188 match_group_patterns(group_patterns, fn pattern ->
190 %Regex{} = regex -> Regex.match?(regex, filename)
191 string when is_binary(string) -> filename == string
196 defp match_group_patterns(group_patterns, matcher) do
197 Enum.find_value(group_patterns, fn {group, patterns} ->
201 |> Enum.map(fn pattern ->
202 if String.contains?(pattern, "*") do
203 ~r(#{String.replace(pattern, "*", ".*")})
209 Enum.any?(patterns, matcher) && group