Merge remote-tracking branch 'pleroma/develop' into feature/disable-account
[akkoma] / lib / mix / tasks / pleroma / emoji.ex
index 2126588b1ae83b0a475a8639279d015d72c2444c..d2ddf450aeb58f89b4c03fb99c5fe4ec66c38701 100644 (file)
@@ -5,11 +5,57 @@
 defmodule Mix.Tasks.Pleroma.Emoji do
   use Mix.Task
 
-  @shortdoc "Manages Pleroma instance"
+  @shortdoc "Manages emoji packs"
   @moduledoc """
+  Manages emoji packs
+
+  ## ls-packs
+
+      mix pleroma.emoji ls-packs [OPTION...]
+
+  Lists the emoji packs and metadata specified in the manifest.
+
+  ### Options
+
+  - `-m, --manifest PATH/URL` - path to a custom manifest, it can
+    either be an URL starting with `http`, in that case the
+    manifest will be fetched from that address, or a local path
+
+  ## get-packs
+
+      mix pleroma.emoji get-packs [OPTION...] PACKS
+
+  Fetches, verifies and installs the specified PACKS from the
+  manifest into the `STATIC-DIR/emoji/PACK-NAME`
+
+  ### Options
+
+  - `-m, --manifest PATH/URL` - same as ls-packs
+
+  ## gen-pack
+
+      mix pleroma.emoji gen-pack PACK-URL
+
+  Creates a new manifest entry and a file list from the specified
+  remote pack file. Currently, only .zip archives are recognized
+  as remote pack files and packs are therefore assumed to be zip
+  archives. This command is intended to run interactively and will
+  first ask you some basic questions about the pack, then download
+  the remote file and generate an SHA256 checksum for it, then
+  generate an emoji file list for you.
+
+  The manifest entry will either be written to a newly created
+  `index.json` file or appended to the existing one, *replacing*
+  the old pack with the same name if it was in the file previously.
+
+  The file list will be written to the file specified previously,
+  *replacing* that file. You _should_ check that the file list doesn't
+  contain anything you don't need in the pack, that is, anything that is
+  not an emoji (the whole pack is downloaded, but only emoji files
+  are extracted).
   """
 
-  @default_manifest "https://git.pleroma.social/vaartis/emoji-index/raw/master/index.json"
+  @default_manifest Pleroma.Config.get!([:emoji, :default_manifest])
 
   def run(["ls-packs" | args]) do
     Application.ensure_all_started(:hackney)
@@ -31,6 +77,9 @@ defmodule Mix.Tasks.Pleroma.Emoji do
       for {param, value} <- to_print do
         IO.puts(IO.ANSI.format([:bright, param, :normal, ": ", value]))
       end
+
+      # A newline
+      IO.puts("")
     end)
   end
 
@@ -60,16 +109,17 @@ defmodule Mix.Tasks.Pleroma.Emoji do
           ])
         )
 
-        binary_archive = Tesla.get!(src_url).body
-        archive_md5 = :crypto.hash(:md5, binary_archive) |> Base.encode16()
+        binary_archive = Tesla.get!(client(), src_url).body
+        archive_sha = :crypto.hash(:sha256, binary_archive) |> Base.encode16()
+
+        sha_status_text = ["SHA256 of ", :bright, pack_name, :normal, " source file is ", :bright]
 
-        md5_status_text = ["MD5 of ", :bright, pack_name, :normal, " source file is ", :bright]
-        if archive_md5 == String.upcase(pack["src_md5"]) do
-          IO.puts(IO.ANSI.format(md5_status_text ++ [:green, "OK"]))
+        if archive_sha == String.upcase(pack["src_sha256"]) do
+          IO.puts(IO.ANSI.format(sha_status_text ++ [:green, "OK"]))
         else
-          IO.puts(IO.ANSI.format(md5_status_text ++ [:red, "BAD"]))
+          IO.puts(IO.ANSI.format(sha_status_text ++ [:red, "BAD"]))
 
-          raise "Bad MD5 for #{pack_name}"
+          raise "Bad SHA256 for #{pack_name}"
         end
 
         # The url specified in files should be in the same directory
@@ -87,15 +137,12 @@ defmodule Mix.Tasks.Pleroma.Emoji do
           ])
         )
 
-        files = Tesla.get!(files_url).body |> Poison.decode!()
+        files = Tesla.get!(client(), files_url).body |> Jason.decode!()
 
         IO.puts(IO.ANSI.format(["Unpacking ", :bright, pack_name]))
 
-        static_path = Path.join(:code.priv_dir(:pleroma), "static")
-
         pack_path =
           Path.join([
-            static_path,
             Pleroma.Config.get!([:instance, :static_dir]),
             "emoji",
             pack_name
@@ -119,7 +166,8 @@ defmodule Mix.Tasks.Pleroma.Emoji do
           Enum.map(
             files,
             fn {shortcode, path} ->
-              "#{shortcode}, /instance/static/emoji/#{pack_name}/#{path}"
+              emojo_path = Path.join("/emoji/#{pack_name}", path)
+              "#{shortcode}, #{emojo_path}"
             end
           )
           |> Enum.join("\n")
@@ -149,20 +197,26 @@ defmodule Mix.Tasks.Pleroma.Emoji do
 
     default_exts = [".png", ".gif"]
     default_exts_str = Enum.join(default_exts, " ")
+
     exts =
-      String.trim(IO.gets("Emoji file extensions (separated with spaces) [#{default_exts_str}]: "))
-    exts = if String.length(exts) > 0 do
-      String.split(exts, " ") |> Enum.filter(fn e -> (e |> String.trim() |> String.length()) > 0 end)
-    else
-      default_exts
-    end
+      String.trim(
+        IO.gets("Emoji file extensions (separated with spaces) [#{default_exts_str}]: ")
+      )
+
+    exts =
+      if String.length(exts) > 0 do
+        String.split(exts, " ")
+        |> Enum.filter(fn e -> e |> String.trim() |> String.length() > 0 end)
+      else
+        default_exts
+      end
 
-    IO.puts "Downloading the pack and generating MD5"
+    IO.puts("Downloading the pack and generating SHA256")
 
-    binary_archive = Tesla.get!(src).body
-    archive_md5 = :crypto.hash(:md5, binary_archive) |> Base.encode16()
+    binary_archive = Tesla.get!(client(), src).body
+    archive_sha = :crypto.hash(:sha256, binary_archive) |> Base.encode16()
 
-    IO.puts "MD5 is #{archive_md5}"
+    IO.puts("SHA256 is #{archive_sha}")
 
     pack_json = %{
       name => %{
@@ -170,38 +224,35 @@ defmodule Mix.Tasks.Pleroma.Emoji do
         homepage: homepage,
         description: description,
         src: src,
-        src_md5: archive_md5,
+        src_sha256: archive_sha,
         files: files_name
       }
     }
 
     tmp_pack_dir = Path.join(System.tmp_dir!(), "emoji-pack-#{name}")
+
     {:ok, _} =
       :zip.unzip(
         binary_archive,
         cwd: tmp_pack_dir
       )
 
-    emoji_map =
-      find_all_emoji(tmp_pack_dir, exts) |>
-      Enum.map(&Path.relative_to(&1, tmp_pack_dir)) |>
-      Enum.map(fn f -> {f |> Path.basename() |> Path.rootname(), f} end) |>
-      Enum.into(%{})
+    emoji_map = Pleroma.Emoji.make_shortcode_to_file_map(tmp_pack_dir, exts)
 
-    File.write!(files_name, Poison.encode!(emoji_map, pretty: true))
+    File.write!(files_name, Jason.encode!(emoji_map, pretty: true))
 
-    IO.puts """
+    IO.puts("""
 
     #{files_name} has been created and contains the list of all found emojis in the pack.
     Please review the files in the remove those not needed.
-    """
+    """)
 
     if File.exists?("index.json") do
-      existing_data = File.read!("index.json") |> Poison.decode!()
+      existing_data = File.read!("index.json") |> Jason.decode!()
 
       File.write!(
         "index.json",
-        Poison.encode!(
+        Jason.encode!(
           Map.merge(
             existing_data,
             pack_json
@@ -210,32 +261,22 @@ defmodule Mix.Tasks.Pleroma.Emoji do
         )
       )
 
-      IO.puts "index.json file has been update with the #{name} pack"
+      IO.puts("index.json file has been update with the #{name} pack")
     else
-      File.write!("index.json", Poison.encode!(pack_json, pretty: true))
+      File.write!("index.json", Jason.encode!(pack_json, pretty: true))
 
-      IO.puts "index.json has been created with the #{name} pack"
+      IO.puts("index.json has been created with the #{name} pack")
     end
-
-  end
-
-  defp find_all_emoji(dir, exts) do
-    Enum.reduce(
-      File.ls!(dir),
-      [],
-      fn f, acc ->
-        filepath = Path.join(dir, f)
-        if File.dir?(filepath) do
-          acc ++ find_all_emoji(filepath, exts)
-        else
-          acc ++ [filepath]
-        end
-      end
-    ) |> Enum.filter(fn f -> Path.extname(f) in exts end)
   end
 
   defp fetch_manifest(from) do
-    Tesla.get!(from).body |> Poison.decode!()
+    Jason.decode!(
+      if String.starts_with?(from, "http") do
+        Tesla.get!(client(), from).body
+      else
+        File.read!(from)
+      end
+    )
   end
 
   defp parse_global_opts(args) do
@@ -249,4 +290,12 @@ defmodule Mix.Tasks.Pleroma.Emoji do
       ]
     )
   end
+
+  defp client do
+    middleware = [
+      {Tesla.Middleware.FollowRedirects, [max_redirects: 3]}
+    ]
+
+    Tesla.client(middleware)
+  end
 end