1 defmodule Pleroma.Emoji.Pack do
2 @derive {Jason.Encoder, only: [:files, :pack, :files_count]}
10 @type t() :: %__MODULE__{
11 files: %{String.t() => Path.t()},
12 files_count: non_neg_integer(),
20 alias Pleroma.Emoji.Pack
22 @spec create(String.t()) :: {:ok, t()} | {:error, File.posix()} | {:error, :empty_values}
24 with :ok <- validate_not_empty([name]),
25 dir <- Path.join(emoji_path(), name),
26 :ok <- File.mkdir(dir) do
27 %__MODULE__{pack_file: Path.join(dir, "pack.json")}
32 defp paginate(entities, 1, page_size), do: Enum.take(entities, page_size)
34 defp paginate(entities, page, page_size) do
36 |> Enum.chunk_every(page_size)
40 @spec show(keyword()) :: {:ok, t()} | {:error, atom()}
44 with :ok <- validate_not_empty([name]),
45 {:ok, pack} <- load_pack(name) do
50 |> paginate(opts[:page], opts[:page_size])
52 pack = Map.put(pack, :files, Map.take(pack.files, shortcodes))
54 {:ok, validate_pack(pack)}
58 @spec delete(String.t()) ::
59 {:ok, [binary()]} | {:error, File.posix(), binary()} | {:error, :empty_values}
61 with :ok <- validate_not_empty([name]) do
68 @spec unpack_zip_emojies(list(tuple())) :: list(map())
69 defp unpack_zip_emojies(zip_files) do
70 Enum.reduce(zip_files, [], fn
71 {_, path, s, _, _, _}, acc when elem(s, 2) == :regular ->
73 filename <- Path.basename(path),
74 shortcode <- Path.basename(filename, Path.extname(filename)),
75 false <- Emoji.exist?(shortcode)
77 [%{path: path, filename: path, shortcode: shortcode} | acc]
87 @spec add_file(t(), String.t(), Path.t(), Plug.Upload.t()) ::
89 | {:error, File.posix() | atom()}
90 def add_file(%Pack{} = pack, _, _, %Plug.Upload{content_type: "application/zip"} = file) do
91 with {:ok, zip_files} <- :zip.table(to_charlist(file.path)),
92 [_ | _] = emojies <- unpack_zip_emojies(zip_files),
93 {:ok, tmp_dir} <- Pleroma.Utils.tmp_dir("emoji") do
97 to_charlist(file.path),
98 [{:file_list, Enum.map(emojies, & &1[:path])}, {:cwd, tmp_dir}]
102 Enum.map_reduce(emojies, pack, fn item, emoji_pack ->
103 emoji_file = %Plug.Upload{
104 filename: item[:filename],
105 path: Path.join(tmp_dir, item[:path])
108 {:ok, updated_pack} =
112 to_string(item[:filename]),
126 {:error, _} = error ->
134 def add_file(%Pack{} = pack, shortcode, filename, %Plug.Upload{} = file) do
135 with :ok <- validate_not_empty([shortcode, filename]),
136 :ok <- validate_emoji_not_exists(shortcode),
137 {:ok, updated_pack} <- do_add_file(pack, shortcode, filename, file) do
143 defp do_add_file(pack, shortcode, filename, file) do
144 with :ok <- save_file(file, pack, filename) do
146 |> put_emoji(shortcode, filename)
151 @spec delete_file(t(), String.t()) ::
152 {:ok, t()} | {:error, File.posix() | atom()}
153 def delete_file(%Pack{} = pack, shortcode) do
154 with :ok <- validate_not_empty([shortcode]),
155 :ok <- remove_file(pack, shortcode),
156 {:ok, updated_pack} <- pack |> delete_emoji(shortcode) |> save_pack() do
162 @spec update_file(t(), String.t(), String.t(), String.t(), boolean()) ::
163 {:ok, t()} | {:error, File.posix() | atom()}
164 def update_file(%Pack{} = pack, shortcode, new_shortcode, new_filename, force) do
165 with :ok <- validate_not_empty([shortcode, new_shortcode, new_filename]),
166 {:ok, filename} <- get_filename(pack, shortcode),
167 :ok <- validate_emoji_not_exists(new_shortcode, force),
168 :ok <- rename_file(pack, filename, new_filename),
169 {:ok, updated_pack} <-
171 |> delete_emoji(shortcode)
172 |> put_emoji(new_shortcode, new_filename)
179 @spec import_from_filesystem() :: {:ok, [String.t()]} | {:error, File.posix() | atom()}
180 def import_from_filesystem do
181 emoji_path = emoji_path()
183 with {:ok, %{access: :read_write}} <- File.stat(emoji_path),
184 {:ok, results} <- File.ls(emoji_path) do
187 |> Enum.map(&Path.join(emoji_path, &1))
188 |> Enum.reject(fn path ->
189 File.dir?(path) and File.exists?(Path.join(path, "pack.json"))
191 |> Enum.map(&write_pack_contents/1)
192 |> Enum.reject(&is_nil/1)
196 {:ok, %{access: _}} -> {:error, :no_read_write}
201 @spec list_remote(String.t()) :: {:ok, map()} | {:error, atom()}
202 def list_remote(url) do
203 uri = url |> String.trim() |> URI.parse()
205 with :ok <- validate_shareable_packs_available(uri) do
207 |> URI.merge("/api/pleroma/emoji/packs")
212 @spec list_local(keyword()) :: {:ok, map(), non_neg_integer()}
213 def list_local(opts) do
214 with {:ok, results} <- list_packs_dir() do
217 |> Enum.map(fn name ->
218 case load_pack(name) do
223 |> Enum.reject(&is_nil/1)
227 |> paginate(opts[:page], opts[:page_size])
228 |> Map.new(fn pack -> {pack.name, validate_pack(pack)} end)
230 {:ok, packs, length(all_packs)}
234 @spec get_archive(String.t()) :: {:ok, binary()} | {:error, atom()}
235 def get_archive(name) do
236 with {:ok, pack} <- load_pack(name),
237 :ok <- validate_downloadable(pack) do
238 {:ok, fetch_archive(pack)}
242 @spec download(String.t(), String.t(), String.t()) :: {:ok, t()} | {:error, atom()}
243 def download(name, url, as) do
244 uri = url |> String.trim() |> URI.parse()
246 with :ok <- validate_shareable_packs_available(uri),
247 {:ok, remote_pack} <- uri |> URI.merge("/api/pleroma/emoji/packs/#{name}") |> http_get(),
248 {:ok, %{sha: sha, url: url} = pack_info} <- fetch_pack_info(remote_pack, uri, name),
249 {:ok, archive} <- download_archive(url, sha),
250 pack <- copy_as(remote_pack, as || name),
251 {:ok, _} = unzip(archive, pack_info, remote_pack, pack) do
252 # Fallback can't contain a pack.json file, since that would cause the fallback-src-sha256
253 # in it to depend on itself
254 if pack_info[:fallback] do
262 @spec save_metadata(map(), t()) :: {:ok, t()} | {:error, File.posix()}
263 def save_metadata(metadata, %__MODULE__{} = pack) do
265 |> Map.put(:pack, metadata)
269 @spec update_metadata(String.t(), map()) :: {:ok, t()} | {:error, File.posix()}
270 def update_metadata(name, data) do
271 with {:ok, pack} <- load_pack(name) do
272 if fallback_sha_changed?(pack, data) do
273 update_sha_and_save_metadata(pack, data)
275 save_metadata(data, pack)
280 @spec load_pack(String.t()) :: {:ok, t()} | {:error, :not_found}
281 def load_pack(name) do
282 pack_file = Path.join([emoji_path(), name, "pack.json"])
284 if File.exists?(pack_file) do
289 |> Map.put(:pack_file, pack_file)
290 |> Map.put(:path, Path.dirname(pack_file))
291 |> Map.put(:name, name)
298 {:ok, Map.put(pack, :files_count, files_count)}
304 @spec emoji_path() :: Path.t()
306 [:instance, :static_dir]
307 |> Pleroma.Config.get!()
308 |> Path.join("emoji")
311 defp validate_emoji_not_exists(shortcode, force \\ false)
312 defp validate_emoji_not_exists(_shortcode, true), do: :ok
314 defp validate_emoji_not_exists(shortcode, _) do
315 if Emoji.exist?(shortcode) do
316 {:error, :already_exists}
322 defp write_pack_contents(path) do
324 files: files_from_path(path),
326 pack_file: Path.join(path, "pack.json")
329 case save_pack(pack) do
330 {:ok, _pack} -> Path.basename(path)
335 defp files_from_path(path) do
336 txt_path = Path.join(path, "emoji.txt")
338 if File.exists?(txt_path) do
339 # There's an emoji.txt file, it's likely from a pack installed by the pack manager.
340 # Make a pack.json file from the contents of that emoji.txt file
342 # FIXME: Copy-pasted from Pleroma.Emoji/load_from_file_stream/2
344 # Create a map of shortcodes to filenames from emoji.txt
347 |> String.split("\n")
348 |> Enum.map(&String.trim/1)
349 |> Enum.map(fn line ->
350 case String.split(line, ~r/,\s*/) do
351 # This matches both strings with and without tags
352 # and we don't care about tags here
354 file_dir_name = Path.dirname(file)
356 if String.ends_with?(path, file_dir_name) do
357 {name, Path.basename(file)}
366 |> Enum.reject(&is_nil/1)
369 # If there's no emoji.txt, assume all files
370 # that are of certain extensions from the config are emojis and import them all
371 pack_extensions = Pleroma.Config.get!([:emoji, :pack_extensions])
372 Emoji.Loader.make_shortcode_to_file_map(path, pack_extensions)
376 defp validate_pack(pack) do
378 if downloadable?(pack) do
379 archive = fetch_archive(pack)
380 archive_sha = :crypto.hash(:sha256, archive) |> Base.encode16()
383 |> Map.put("can-download", true)
384 |> Map.put("download-sha256", archive_sha)
386 Map.put(pack.pack, "can-download", false)
389 Map.put(pack, :pack, info)
392 defp downloadable?(pack) do
393 # If the pack is set as shared, check if it can be downloaded
394 # That means that when asked, the pack can be packed and sent to the remote
395 # Otherwise, they'd have to download it from external-src
396 pack.pack["share-files"] &&
397 Enum.all?(pack.files, fn {_, file} ->
404 defp create_archive_and_cache(pack, hash) do
405 files = ['pack.json' | Enum.map(pack.files, fn {_, file} -> to_charlist(file) end)]
408 :zip.zip('#{pack.name}.zip', files, [:memory, cwd: to_charlist(pack.path)])
410 ttl_per_file = Pleroma.Config.get!([:emoji, :shared_pack_cache_seconds_per_file])
411 overall_ttl = :timer.seconds(ttl_per_file * Enum.count(files))
416 # if pack.json MD5 changes, the cache is not valid anymore
417 %{hash: hash, pack_data: result},
418 # Add a minute to cache time for every file in the pack
425 defp save_pack(pack) do
426 with {:ok, json} <- Jason.encode(pack, pretty: true),
427 :ok <- File.write(pack.pack_file, json) do
432 defp from_json(json) do
433 map = Jason.decode!(json)
435 struct(__MODULE__, %{files: map["files"], pack: map["pack"]})
438 defp validate_shareable_packs_available(uri) do
439 with {:ok, %{"links" => links}} <- uri |> URI.merge("/.well-known/nodeinfo") |> http_get(),
440 # Get the actual nodeinfo address and fetch it
441 {:ok, %{"metadata" => %{"features" => features}}} <-
442 links |> List.last() |> Map.get("href") |> http_get() do
443 if Enum.member?(features, "shareable_emoji_packs") do
446 {:error, :not_shareable}
451 defp validate_not_empty(list) do
452 if Enum.all?(list, fn i -> is_binary(i) and i != "" end) do
455 {:error, :empty_values}
459 defp save_file(%Plug.Upload{path: upload_path}, pack, filename) do
460 file_path = Path.join(pack.path, filename)
461 create_subdirs(file_path)
463 with {:ok, _} <- File.copy(upload_path, file_path) do
468 defp put_emoji(pack, shortcode, filename) do
469 files = Map.put(pack.files, shortcode, filename)
470 %{pack | files: files, files_count: length(Map.keys(files))}
473 defp delete_emoji(pack, shortcode) do
474 files = Map.delete(pack.files, shortcode)
475 %{pack | files: files}
478 defp rename_file(pack, filename, new_filename) do
479 old_path = Path.join(pack.path, filename)
480 new_path = Path.join(pack.path, new_filename)
481 create_subdirs(new_path)
483 with :ok <- File.rename(old_path, new_path) do
484 remove_dir_if_empty(old_path, filename)
488 defp create_subdirs(file_path) do
489 if String.contains?(file_path, "/") do
496 defp remove_file(pack, shortcode) do
497 with {:ok, filename} <- get_filename(pack, shortcode),
498 emoji <- Path.join(pack.path, filename),
499 :ok <- File.rm(emoji) do
500 remove_dir_if_empty(emoji, filename)
504 defp remove_dir_if_empty(emoji, filename) do
505 dir = Path.dirname(emoji)
507 if String.contains?(filename, "/") and File.ls!(dir) == [] do
514 defp get_filename(pack, shortcode) do
515 with %{^shortcode => filename} when is_binary(filename) <- pack.files,
516 true <- pack.path |> Path.join(filename) |> File.exists?() do
519 _ -> {:error, :doesnt_exist}
523 defp http_get(%URI{} = url), do: url |> to_string() |> http_get()
525 defp http_get(url) do
526 with {:ok, %{body: body}} <- url |> Pleroma.HTTP.get() do
531 defp list_packs_dir do
532 emoji_path = emoji_path()
533 # Create the directory first if it does not exist. This is probably the first request made
534 # with the API so it should be sufficient
535 with {:create_dir, :ok} <- {:create_dir, File.mkdir_p(emoji_path)},
536 {:ls, {:ok, results}} <- {:ls, File.ls(emoji_path)} do
537 {:ok, Enum.sort(results)}
539 {:create_dir, {:error, e}} -> {:error, :create_dir, e}
540 {:ls, {:error, e}} -> {:error, :ls, e}
544 defp validate_downloadable(pack) do
545 if downloadable?(pack), do: :ok, else: {:error, :cant_download}
548 defp copy_as(remote_pack, local_name) do
549 path = Path.join(emoji_path(), local_name)
554 files: remote_pack["files"],
555 pack_file: Path.join(path, "pack.json")
559 defp unzip(archive, pack_info, remote_pack, local_pack) do
560 with :ok <- File.mkdir_p!(local_pack.path) do
561 files = Enum.map(remote_pack["files"], fn {_, path} -> to_charlist(path) end)
562 # Fallback cannot contain a pack.json file
563 files = if pack_info[:fallback], do: files, else: ['pack.json' | files]
565 :zip.unzip(archive, cwd: to_charlist(local_pack.path), file_list: files)
569 defp fetch_pack_info(remote_pack, uri, name) do
570 case remote_pack["pack"] do
571 %{"share-files" => true, "can-download" => true, "download-sha256" => sha} ->
575 url: URI.merge(uri, "/api/pleroma/emoji/packs/#{name}/archive") |> to_string()
578 %{"fallback-src" => src, "fallback-src-sha256" => sha} when is_binary(src) ->
587 {:error, "The pack was not set as shared and there is no fallback src to download from"}
591 defp download_archive(url, sha) do
592 with {:ok, %{body: archive}} <- Tesla.get(url) do
593 if Base.decode16!(sha) == :crypto.hash(:sha256, archive) do
596 {:error, :invalid_checksum}
601 defp fetch_archive(pack) do
602 hash = :crypto.hash(:md5, File.read!(pack.pack_file))
604 case Cachex.get!(:emoji_packs_cache, pack.name) do
605 %{hash: ^hash, pack_data: archive} -> archive
606 _ -> create_archive_and_cache(pack, hash)
610 defp fallback_sha_changed?(pack, data) do
611 is_binary(data[:"fallback-src"]) and data[:"fallback-src"] != pack.pack["fallback-src"]
614 defp update_sha_and_save_metadata(pack, data) do
615 with {:ok, %{body: zip}} <- Tesla.get(data[:"fallback-src"]),
616 :ok <- validate_has_all_files(pack, zip) do
617 fallback_sha = :sha256 |> :crypto.hash(zip) |> Base.encode16()
620 |> Map.put("fallback-src-sha256", fallback_sha)
621 |> save_metadata(pack)
625 defp validate_has_all_files(pack, zip) do
626 with {:ok, f_list} <- :zip.unzip(zip, [:memory]) do
627 # Check if all files from the pack.json are in the archive
629 |> Enum.all?(fn {_, from_manifest} ->
630 List.keyfind(f_list, to_charlist(from_manifest), 0)
632 |> if(do: :ok, else: {:error, :incomplete})