emoji api packs changes in routes with docs update

3 files changed, 64 insertions, 143 deletions

diff --git a/lib/pleroma/emoji/pack.ex b/lib/pleroma/emoji/pack.ex
index 21ed12c78..eb50e52fa 100644
--- a/lib/pleroma/emoji/pack.ex
+++ b/lib/pleroma/emoji/pack.ex
@@ -102,9 +102,9 @@ defmodule Pleroma.Emoji.Pack do
     end
   end
 
-  @spec remove_file(String.t(), String.t()) ::
+  @spec delete_file(String.t(), String.t()) ::
           {:ok, t()} | {:error, File.posix()} | {:error, :empty_values}
-  def remove_file(name, shortcode) when byte_size(name) > 0 and byte_size(shortcode) > 0 do
+  def delete_file(name, shortcode) when byte_size(name) > 0 and byte_size(shortcode) > 0 do
     with {_, %__MODULE__{} = pack} <- {:loaded, load_pack(name)},
          {_, {filename, files}} when not is_nil(filename) <-
            {:exists, Map.pop(pack.files, shortcode)},
@@ -131,7 +131,7 @@ defmodule Pleroma.Emoji.Pack do
     end
   end
 
-  def remove_file(_, _), do: {:error, :empty_values}
+  def delete_file(_, _), do: {:error, :empty_values}
 
   @spec update_file(String.t(), String.t(), String.t(), String.t(), boolean()) ::
           {:ok, t()} | {:error, File.posix()} | {:error, :empty_values}
@@ -249,8 +249,8 @@ defmodule Pleroma.Emoji.Pack do
     end
   end
 
-  @spec list_remote_packs(String.t()) :: {:ok, map()}
-  def list_remote_packs(url) do
+  @spec list_remote(String.t()) :: {:ok, map()}
+  def list_remote(url) do
     uri =
       url
       |> String.trim()
@@ -269,8 +269,8 @@ defmodule Pleroma.Emoji.Pack do
     end
   end
 
-  @spec list_local_packs() :: {:ok, map()}
-  def list_local_packs do
+  @spec list_local() :: {:ok, map()}
+  def list_local do
     emoji_path = emoji_path()
 
     # Create the directory first if it does not exist. This is probably the first request made
@@ -315,8 +315,8 @@ defmodule Pleroma.Emoji.Pack do
       end)
   end
 
-  @spec download(String.t()) :: {:ok, binary()}
-  def download(name) do
+  @spec get_archive(String.t()) :: {:ok, binary()}
+  def get_archive(name) do
     with {_, %__MODULE__{} = pack} <- {:exists?, load_pack(name)},
          {_, true} <- {:can_download?, downloadable?(pack)} do
       {:ok, fetch_archive(pack)}
@@ -356,15 +356,14 @@ defmodule Pleroma.Emoji.Pack do
     result
   end
 
-  @spec download_from_source(String.t(), String.t(), String.t()) :: :ok
-  def download_from_source(name, url, as) do
+  @spec download(String.t(), String.t(), String.t()) :: :ok
+  def download(name, url, as) do
     uri =
       url
       |> String.trim()
       |> URI.parse()
 
     with {_, true} <- {:shareable, shareable_packs_available?(uri)} do
-      # TODO: why do we load all packs, if we know the name of pack we need
       remote_pack =
         uri
         |> URI.merge("/api/pleroma/emoji/packs/#{name}")
@@ -379,8 +378,7 @@ defmodule Pleroma.Emoji.Pack do
             {:ok,
              %{
                sha: sha,
-               url:
-                 URI.merge(uri, "/api/pleroma/emoji/packs/#{name}/download_shared") |> to_string()
+               url: URI.merge(uri, "/api/pleroma/emoji/packs/#{name}/archive") |> to_string()
              }}
 
           %{"fallback-src" => src, "fallback-src-sha256" => sha} when is_binary(src) ->
diff --git a/lib/pleroma/web/pleroma_api/controllers/emoji_api_controller.ex b/lib/pleroma/web/pleroma_api/controllers/emoji_api_controller.ex
index 9fa857474..83a7f03e8 100644
--- a/lib/pleroma/web/pleroma_api/controllers/emoji_api_controller.ex
+++ b/lib/pleroma/web/pleroma_api/controllers/emoji_api_controller.ex
@@ -7,12 +7,15 @@ defmodule Pleroma.Web.PleromaAPI.EmojiAPIController do
     Pleroma.Plugs.OAuthScopesPlug,
     %{scopes: ["write"], admin: true}
     when action in [
+           :import,
+           :remote,
+           :download,
            :create,
+           :update,
            :delete,
-           :download_from,
-           :import_from_fs,
+           :add_file,
            :update_file,
-           :update_metadata
+           :delete_file
          ]
   )
 
@@ -22,14 +25,8 @@ defmodule Pleroma.Web.PleromaAPI.EmojiAPIController do
     when action in [:download_shared, :list_packs, :list_from]
   )
 
-  @doc """
-  Lists packs from the remote instance.
-
-  Since JS cannot ask remote instances for their packs due to CPS, it has to
-  be done by the server
-  """
-  def list_from(conn, %{"instance_address" => address}) do
-    with {:ok, packs} <- Pack.list_remote_packs(address) do
+  def remote(conn, %{"url" => url}) do
+    with {:ok, packs} <- Pack.list_remote(url) do
       json(conn, packs)
     else
       {:shareable, _} ->
@@ -39,20 +36,14 @@ defmodule Pleroma.Web.PleromaAPI.EmojiAPIController do
     end
   end
 
-  @doc """
-  Lists the packs available on the instance as JSON.
-
-  The information is public and does not require authentication. The format is
-  a map of "pack directory name" to pack.json contents.
-  """
-  def list_packs(conn, _params) do
+  def list(conn, _params) do
     emoji_path =
       Path.join(
         Pleroma.Config.get!([:instance, :static_dir]),
         "emoji"
       )
 
-    with {:ok, packs} <- Pack.list_local_packs() do
+    with {:ok, packs} <- Pack.list_local() do
       json(conn, packs)
     else
       {:create_dir, {:error, e}} ->
@@ -87,12 +78,8 @@ defmodule Pleroma.Web.PleromaAPI.EmojiAPIController do
     end
   end
 
-  @doc """
-  An endpoint for other instances (via admin UI) or users (via browser)
-  to download packs that the instance shares.
-  """
-  def download_shared(conn, %{"name" => name}) do
-    with {:ok, archive} <- Pack.download(name) do
+  def archive(conn, %{"name" => name}) do
+    with {:ok, archive} <- Pack.get_archive(name) do
       send_download(conn, {:binary, archive}, filename: "#{name}.zip")
     else
       {:can_download?, _} ->
@@ -110,15 +97,8 @@ defmodule Pleroma.Web.PleromaAPI.EmojiAPIController do
     end
   end
 
-  @doc """
-  An admin endpoint to request downloading and storing a pack named `pack_name` from the instance
-  `instance_address`.
-
-  If the requested instance's admin chose to share the pack, it will be downloaded
-  from that instance, otherwise it will be downloaded from the fallback source, if there is one.
-  """
-  def download_from(conn, %{"instance_address" => address, "pack_name" => name} = params) do
-    with :ok <- Pack.download_from_source(name, address, params["as"]) do
+  def download(conn, %{"url" => url, "name" => name} = params) do
+    with :ok <- Pack.download(name, url, params["as"]) do
       json(conn, "ok")
     else
       {:shareable, _} ->
@@ -138,9 +118,6 @@ defmodule Pleroma.Web.PleromaAPI.EmojiAPIController do
     end
   end
 
-  @doc """
-  Creates an empty pack named `name` which then can be updated via the admin UI.
-  """
   def create(conn, %{"name" => name}) do
     name = String.trim(name)
 
@@ -166,9 +143,6 @@ defmodule Pleroma.Web.PleromaAPI.EmojiAPIController do
     end
   end
 
-  @doc """
-  Deletes the pack `name` and all it's files.
-  """
   def delete(conn, %{"name" => name}) do
     name = String.trim(name)
 
@@ -192,13 +166,8 @@ defmodule Pleroma.Web.PleromaAPI.EmojiAPIController do
     end
   end
 
-  @doc """
-  An endpoint to update `pack_names`'s metadata.
-
-  `new_data` is the new metadata for the pack, that will replace the old metadata.
-  """
-  def update_metadata(conn, %{"pack_name" => name, "new_data" => new_data}) do
-    with {:ok, pack} <- Pack.update_metadata(name, new_data) do
+  def update(conn, %{"name" => name, "metadata" => metadata}) do
+    with {:ok, pack} <- Pack.update_metadata(name, metadata) do
       json(conn, pack.pack)
     else
       {:has_all_files?, _} ->
@@ -215,30 +184,11 @@ defmodule Pleroma.Web.PleromaAPI.EmojiAPIController do
     end
   end
 
-  @doc """
-  Updates a file in a pack.
-
-  Updating can mean three things:
-
-  - `add` adds an emoji named `shortcode` to the pack `pack_name`,
-    that means that the emoji file needs to be uploaded with the request
-    (thus requiring it to be a multipart request) and be named `file`.
-    There can also be an optional `filename` that will be the new emoji file name
-    (if it's not there, the name will be taken from the uploaded file).
-  - `update` changes emoji shortcode (from `shortcode` to `new_shortcode` or moves the file
-    (from the current filename to `new_filename`)
-  - `remove` removes the emoji named `shortcode` and it's associated file
-  """
-
-  # Add
-  def update_file(
-        conn,
-        %{"pack_name" => pack_name, "action" => "add"} = params
-      ) do
+  def add_file(conn, %{"name" => name} = params) do
     filename = params["filename"] || get_filename(params["file"])
     shortcode = params["shortcode"] || Path.basename(filename, Path.extname(filename))
 
-    with {:ok, pack} <- Pack.add_file(pack_name, shortcode, filename, params["file"]) do
+    with {:ok, pack} <- Pack.add_file(name, shortcode, filename, params["file"]) do
       json(conn, pack.files)
     else
       {:exists, _} ->
@@ -249,7 +199,7 @@ defmodule Pleroma.Web.PleromaAPI.EmojiAPIController do
       {:loaded, _} ->
         conn
         |> put_status(:bad_request)
-        |> json(%{error: "pack \"#{pack_name}\" is not found"})
+        |> json(%{error: "pack \"#{name}\" is not found"})
 
       {:error, :empty_values} ->
         conn
@@ -265,13 +215,12 @@ defmodule Pleroma.Web.PleromaAPI.EmojiAPIController do
     end
   end
 
-  # Remove
-  def update_file(conn, %{
-        "pack_name" => pack_name,
-        "action" => "remove",
-        "shortcode" => shortcode
-      }) do
-    with {:ok, pack} <- Pack.remove_file(pack_name, shortcode) do
+  def update_file(conn, %{"name" => name, "shortcode" => shortcode} = params) do
+    new_shortcode = params["new_shortcode"]
+    new_filename = params["new_filename"]
+    force = params["force"] == true
+
+    with {:ok, pack} <- Pack.update_file(name, shortcode, new_shortcode, new_filename, force) do
       json(conn, pack.files)
     else
       {:exists, _} ->
@@ -279,35 +228,35 @@ defmodule Pleroma.Web.PleromaAPI.EmojiAPIController do
         |> put_status(:bad_request)
         |> json(%{error: "Emoji \"#{shortcode}\" does not exist"})
 
+      {:not_used, _} ->
+        conn
+        |> put_status(:conflict)
+        |> json(%{
+          error:
+            "New shortcode \"#{new_shortcode}\" is already used. If you want to override emoji use 'force' option"
+        })
+
       {:loaded, _} ->
         conn
         |> put_status(:bad_request)
-        |> json(%{error: "pack \"#{pack_name}\" is not found"})
+        |> json(%{error: "pack \"#{name}\" is not found"})
 
       {:error, :empty_values} ->
         conn
         |> put_status(:bad_request)
-        |> json(%{error: "pack name or shortcode cannot be empty"})
+        |> json(%{error: "new_shortcode or new_filename cannot be empty"})
 
       {:error, _} ->
         render_error(
           conn,
           :internal_server_error,
-          "Unexpected error occurred while removing file from pack."
+          "Unexpected error occurred while updating file in pack."
         )
     end
   end
 
-  # Update
-  def update_file(
-        conn,
-        %{"pack_name" => name, "action" => "update", "shortcode" => shortcode} = params
-      ) do
-    new_shortcode = params["new_shortcode"]
-    new_filename = params["new_filename"]
-    force = params["force"] == true
-
-    with {:ok, pack} <- Pack.update_file(name, shortcode, new_shortcode, new_filename, force) do
+  def delete_file(conn, %{"name" => name, "shortcode" => shortcode}) do
+    with {:ok, pack} <- Pack.delete_file(name, shortcode) do
       json(conn, pack.files)
     else
       {:exists, _} ->
@@ -315,14 +264,6 @@ defmodule Pleroma.Web.PleromaAPI.EmojiAPIController do
         |> put_status(:bad_request)
         |> json(%{error: "Emoji \"#{shortcode}\" does not exist"})
 
-      {:not_used, _} ->
-        conn
-        |> put_status(:conflict)
-        |> json(%{
-          error:
-            "New shortcode \"#{new_shortcode}\" is already used. If you want to override emoji use 'force' option"
-        })
-
       {:loaded, _} ->
         conn
         |> put_status(:bad_request)
@@ -331,35 +272,18 @@ defmodule Pleroma.Web.PleromaAPI.EmojiAPIController do
       {:error, :empty_values} ->
         conn
         |> put_status(:bad_request)
-        |> json(%{error: "new_shortcode or new_filename cannot be empty"})
+        |> json(%{error: "pack name or shortcode cannot be empty"})
 
       {:error, _} ->
         render_error(
           conn,
           :internal_server_error,
-          "Unexpected error occurred while updating file in pack."
+          "Unexpected error occurred while removing file from pack."
         )
     end
   end
 
-  def update_file(conn, %{"action" => action}) do
-    conn
-    |> put_status(:bad_request)
-    |> json(%{error: "Unknown action: #{action}"})
-  end
-
-  @doc """
-  Imports emoji from the filesystem.
-
-  Importing means checking all the directories in the
-  `$instance_static/emoji/` for directories which do not have
-  `pack.json`. If one has an emoji.txt file, that file will be used
-  to create a `pack.json` file with it's contents. If the directory has
-  neither, all the files with specific configured extenstions will be
-  assumed to be emojis and stored in the new `pack.json` file.
-  """
-
-  def import_from_fs(conn, _params) do
+  def import_from_filesystem(conn, _params) do
     with {:ok, names} <- Pack.import_from_filesystem() do
       json(conn, names)
     else
diff --git a/lib/pleroma/web/router.ex b/lib/pleroma/web/router.ex
index 0fcb517cf..a7e1f2f57 100644
--- a/lib/pleroma/web/router.ex
+++ b/lib/pleroma/web/router.ex
@@ -214,25 +214,24 @@ defmodule Pleroma.Web.Router do
     scope "/packs" do
       pipe_through(:admin_api)
 
-      post("/import_from_fs", EmojiAPIController, :import_from_fs)
-      post("/:pack_name/update_file", EmojiAPIController, :update_file)
-      post("/:pack_name/update_metadata", EmojiAPIController, :update_metadata)
-      put("/:name", EmojiAPIController, :create)
+      get("/import", EmojiAPIController, :import_from_filesystem)
+      get("/remote", EmojiAPIController, :remote)
+      post("/download", EmojiAPIController, :download)
+
+      post("/:name", EmojiAPIController, :create)
+      patch("/:name", EmojiAPIController, :update)
       delete("/:name", EmojiAPIController, :delete)
 
-      # Note: /download_from downloads and saves to instance, not to requester
-      post("/download_from", EmojiAPIController, :download_from)
+      post("/:name/files", EmojiAPIController, :add_file)
+      patch("/:name/files", EmojiAPIController, :update_file)
+      delete("/:name/files", EmojiAPIController, :delete_file)
     end
 
     # Pack info / downloading
     scope "/packs" do
-      get("/", EmojiAPIController, :list_packs)
+      get("/", EmojiAPIController, :list)
       get("/:name", EmojiAPIController, :show)
-      get("/:name/download_shared/", EmojiAPIController, :download_shared)
-      get("/list_from", EmojiAPIController, :list_from)
-
-      # Deprecated: POST /api/pleroma/emoji/packs/list_from (use GET instead)
-      post("/list_from", EmojiAPIController, :list_from)
+      get("/:name/archive", EmojiAPIController, :archive)
     end
   end