diff --git a/docs/development/API/pleroma_api.md b/docs/development/API/pleroma_api.md index 8f6422da0..d72db14a9 100644 --- a/docs/development/API/pleroma_api.md +++ b/docs/development/API/pleroma_api.md @@ -418,6 +418,7 @@ The status posting endpoint takes an additional parameter, `in_reply_to_conversa * Params: * `name`: pack name * `metadata`: metadata to replace the old one + * `display-name`: Pack name that returns in `category` for each emoji in its pack whenever called from `/api/v1/custom_emojis` * `license`: Pack license * `homepage`: Pack home page url * `description`: Pack description diff --git a/lib/mix/tasks/pleroma/emoji.ex b/lib/mix/tasks/pleroma/emoji.ex index 9ad4a7467..e1e3b7239 100644 --- a/lib/mix/tasks/pleroma/emoji.ex +++ b/lib/mix/tasks/pleroma/emoji.ex @@ -20,6 +20,7 @@ defmodule Mix.Tasks.Pleroma.Emoji do Enum.each(manifest, fn {name, info} -> to_print = [ {"Name", name}, + {"Display name", info["display-name"]}, {"Homepage", info["homepage"]}, {"Description", info["description"]}, {"License", info["license"]}, @@ -119,6 +120,7 @@ defmodule Mix.Tasks.Pleroma.Emoji do pack_json = %{ pack: %{ + "display-name" => pack["display_name"], "license" => pack["license"], "homepage" => pack["homepage"], "description" => pack["description"], @@ -144,6 +146,7 @@ defmodule Mix.Tasks.Pleroma.Emoji do args, strict: [ name: :string, + display_name: :string, license: :string, homepage: :string, description: :string, @@ -154,6 +157,7 @@ defmodule Mix.Tasks.Pleroma.Emoji do proposed_name = Path.basename(src) |> Path.rootname() name = get_option(opts, :name, "Pack name:", proposed_name) + display_name = get_option(opts, :display_name, "Display name:") license = get_option(opts, :license, "License:") homepage = get_option(opts, :homepage, "Homepage:") description = get_option(opts, :description, "Description:") @@ -190,6 +194,7 @@ defmodule Mix.Tasks.Pleroma.Emoji do pack_json = %{ name => %{ + display_name: display_name, license: license, homepage: homepage, description: description, diff --git a/lib/pleroma/emoji/loader.ex b/lib/pleroma/emoji/loader.ex index 95937a892..101049bd3 100644 --- a/lib/pleroma/emoji/loader.ex +++ b/lib/pleroma/emoji/loader.ex @@ -105,10 +105,12 @@ defmodule Pleroma.Emoji.Loader do if File.exists?(pack_file) do contents = Jason.decode!(File.read!(pack_file)) + display_name = contents["pack"]["display-name"] || "pack:#{pack_name}" + contents["files"] |> Enum.map(fn {name, rel_file} -> filename = Path.join("/emoji/#{pack_name}", rel_file) - {name, filename, ["pack:#{pack_name}"]} + {name, filename, ["#{display_name}"]} end) else # Load from emoji.txt / all files diff --git a/lib/pleroma/emoji/pack.ex b/lib/pleroma/emoji/pack.ex index 09bfcc868..71ec5a045 100644 --- a/lib/pleroma/emoji/pack.ex +++ b/lib/pleroma/emoji/pack.ex @@ -275,10 +275,15 @@ defmodule Pleroma.Emoji.Pack do @spec update_metadata(String.t(), map()) :: {:ok, t()} | {:error, File.posix()} def update_metadata(name, data) do with {:ok, pack} <- load_pack(name) do - if fallback_sha_changed?(pack, data) do - update_sha_and_save_metadata(pack, data) - else - save_metadata(data, pack) + cond do + fallback_sha_changed?(pack, data) -> + update_sha_and_save_metadata(pack, data) + + display_name_blank?(data) -> + remove_display_name_and_save_metadata(pack, data) + + true -> + save_metadata(data, pack) end end end @@ -630,14 +635,31 @@ defmodule Pleroma.Emoji.Pack do is_binary(data[:"fallback-src"]) and data[:"fallback-src"] != pack.pack["fallback-src"] end + defp display_name_blank?(data) do + data[:"display-name"] == "" or data[:"display-name"] == nil + end + + defp remove_display_name_and_save_metadata(pack, data) do + data + |> Map.delete(:"display-name") + |> save_metadata(pack) + end + defp update_sha_and_save_metadata(pack, data) do with {:ok, %{body: zip}} <- Pleroma.HTTP.get(data[:"fallback-src"]), :ok <- validate_has_all_files(pack, zip) do fallback_sha = :sha256 |> :crypto.hash(zip) |> Base.encode16() - data - |> Map.put("fallback-src-sha256", fallback_sha) - |> save_metadata(pack) + if display_name_blank?(data) do + data + |> Map.put("fallback-src-sha256", fallback_sha) + + remove_display_name_and_save_metadata(pack, data) + else + data + |> Map.put("fallback-src-sha256", fallback_sha) + |> save_metadata(pack) + end end end diff --git a/lib/pleroma/web/api_spec/operations/pleroma_emoji_pack_operation.ex b/lib/pleroma/web/api_spec/operations/pleroma_emoji_pack_operation.ex index 49247d9b6..465468b9a 100644 --- a/lib/pleroma/web/api_spec/operations/pleroma_emoji_pack_operation.ex +++ b/lib/pleroma/web/api_spec/operations/pleroma_emoji_pack_operation.ex @@ -248,6 +248,7 @@ defmodule Pleroma.Web.ApiSpec.PleromaEmojiPackOperation do pack: %Schema{ type: :object, properties: %{ + "display-name": %Schema{type: :string}, license: %Schema{type: :string}, homepage: %Schema{type: :string, format: :uri}, description: %Schema{type: :string}, @@ -260,6 +261,7 @@ defmodule Pleroma.Web.ApiSpec.PleromaEmojiPackOperation do example: %{ "files" => %{"emacs" => "emacs.png", "guix" => "guix.png"}, "pack" => %{ + "display-name" => "Test display name", "license" => "Test license", "homepage" => "https://pleroma.social", "description" => "Test description", @@ -287,6 +289,7 @@ defmodule Pleroma.Web.ApiSpec.PleromaEmojiPackOperation do type: :object, description: "Metadata to replace the old one", properties: %{ + "display-name": %Schema{type: :string}, license: %Schema{type: :string}, homepage: %Schema{type: :string, format: :uri}, description: %Schema{type: :string}, @@ -310,6 +313,7 @@ defmodule Pleroma.Web.ApiSpec.PleromaEmojiPackOperation do %Schema{ type: :object, properties: %{ + "display-name": %Schema{type: :string}, license: %Schema{type: :string}, homepage: %Schema{type: :string, format: :uri}, description: %Schema{type: :string}, diff --git a/test/fixtures/emoji/packs/default-manifest.json b/test/fixtures/emoji/packs/default-manifest.json index c8433808d..dfe9692bb 100644 --- a/test/fixtures/emoji/packs/default-manifest.json +++ b/test/fixtures/emoji/packs/default-manifest.json @@ -1,5 +1,6 @@ { "finmoji": { + "display-name": "Finmoji", "license": "CC BY-NC-ND 4.0", "homepage": "https://finland.fi/emoji/", "description": "Finland is the first country in the world to publish its own set of country themed emojis. The Finland emoji collection contains 56 tongue-in-cheek emotions, which were created to explain some hard-to-describe Finnish emotions, Finnish words and customs.", @@ -7,4 +8,4 @@ "src_sha256": "384025A1AC6314473863A11AC7AB38A12C01B851A3F82359B89B4D4211D3291D", "files": "finmoji.json" } -} \ No newline at end of file +} diff --git a/test/fixtures/emoji/packs/manifest.json b/test/fixtures/emoji/packs/manifest.json index 2d51a459b..2e57048dd 100644 --- a/test/fixtures/emoji/packs/manifest.json +++ b/test/fixtures/emoji/packs/manifest.json @@ -1,5 +1,6 @@ { "blobs.gg": { + "display-name": "Blob Emoji", "src_sha256": "3a12f3a181678d5b3584a62095411b0d60a335118135910d879920f8ade5a57f", "src": "https://git.pleroma.social/pleroma/emoji-index/raw/master/packs/blobs_gg.zip", "license": "Apache 2.0", @@ -7,4 +8,4 @@ "files": "blobs_gg.json", "description": "Blob Emoji from blobs.gg repacked as apng" } -} \ No newline at end of file +} diff --git a/test/instance_static/emoji/blobs.gg/pack.json b/test/instance_static/emoji/blobs.gg/pack.json index 481891b08..a1c8829cf 100644 --- a/test/instance_static/emoji/blobs.gg/pack.json +++ b/test/instance_static/emoji/blobs.gg/pack.json @@ -3,9 +3,10 @@ "blank": "blank.png" }, "pack": { + "display-name": "Test display name", "description": "Test description", "homepage": "https://pleroma.social", "license": "Test license", "share-files": true } -} \ No newline at end of file +} diff --git a/test/instance_static/emoji/pack_bad_sha/pack.json b/test/instance_static/emoji/pack_bad_sha/pack.json index 35caf4298..379941ff9 100644 --- a/test/instance_static/emoji/pack_bad_sha/pack.json +++ b/test/instance_static/emoji/pack_bad_sha/pack.json @@ -1,5 +1,6 @@ { "pack": { + "display-name": "Test display name", "license": "Test license", "homepage": "https://pleroma.social", "description": "Test description", @@ -10,4 +11,4 @@ "files": { "blank": "blank.png" } -} \ No newline at end of file +} diff --git a/test/instance_static/emoji/test_pack/pack.json b/test/instance_static/emoji/test_pack/pack.json index 5b33fbb32..c108fbe62 100644 --- a/test/instance_static/emoji/test_pack/pack.json +++ b/test/instance_static/emoji/test_pack/pack.json @@ -4,9 +4,10 @@ "blank2": "blank2.png" }, "pack": { + "display-name": "Test display name", "description": "Test description", "homepage": "https://pleroma.social", "license": "Test license", "share-files": true } -} \ No newline at end of file +} diff --git a/test/instance_static/emoji/test_pack_no_display_name/blank5.png b/test/instance_static/emoji/test_pack_no_display_name/blank5.png new file mode 100644 index 000000000..8f50fa023 Binary files /dev/null and b/test/instance_static/emoji/test_pack_no_display_name/blank5.png differ diff --git a/test/instance_static/emoji/test_pack_no_display_name/pack.json b/test/instance_static/emoji/test_pack_no_display_name/pack.json new file mode 100644 index 000000000..f13dd9c5e --- /dev/null +++ b/test/instance_static/emoji/test_pack_no_display_name/pack.json @@ -0,0 +1,11 @@ +{ + "files": { + "blank5": "blank5.png" + }, + "pack": { + "description": "Test description", + "homepage": "https://pleroma.social", + "license": "Test license", + "share-files": true + } +} diff --git a/test/instance_static/emoji/test_pack_nonshared/pack.json b/test/instance_static/emoji/test_pack_nonshared/pack.json index 09f6274d1..f473db5a0 100644 --- a/test/instance_static/emoji/test_pack_nonshared/pack.json +++ b/test/instance_static/emoji/test_pack_nonshared/pack.json @@ -1,5 +1,6 @@ { "pack": { + "display-name": "Test display name", "license": "Test license", "homepage": "https://pleroma.social", "description": "Test description", @@ -10,4 +11,4 @@ "files": { "blank": "blank.png" } -} \ No newline at end of file +} diff --git a/test/instance_static/emoji/test_pack_with_display_name/blank6.png b/test/instance_static/emoji/test_pack_with_display_name/blank6.png new file mode 100644 index 000000000..8f50fa023 Binary files /dev/null and b/test/instance_static/emoji/test_pack_with_display_name/blank6.png differ diff --git a/test/instance_static/emoji/test_pack_with_display_name/pack.json b/test/instance_static/emoji/test_pack_with_display_name/pack.json new file mode 100644 index 000000000..c7cc55f2c --- /dev/null +++ b/test/instance_static/emoji/test_pack_with_display_name/pack.json @@ -0,0 +1,12 @@ +{ + "files": { + "blank6": "blank6.png" + }, + "pack": { + "display-name": "Test display name", + "description": "Test description", + "homepage": "https://pleroma.social", + "license": "Test license", + "share-files": true + } +} diff --git a/test/mix/tasks/pleroma/emoji_test.exs b/test/mix/tasks/pleroma/emoji_test.exs index bd20f285c..5f54238c1 100644 --- a/test/mix/tasks/pleroma/emoji_test.exs +++ b/test/mix/tasks/pleroma/emoji_test.exs @@ -154,6 +154,8 @@ defmodule Mix.Tasks.Pleroma.EmojiTest do url, "--name", name, + "--display-name", + "display_name", "--license", "license", "--homepage", @@ -193,6 +195,8 @@ defmodule Mix.Tasks.Pleroma.EmojiTest do url, "--name", name, + "--display-name", + "display_name", "--license", "license", "--homepage", @@ -219,6 +223,8 @@ defmodule Mix.Tasks.Pleroma.EmojiTest do url, "--name", name, + "--display-name", + "display_name", "--license", "license", "--homepage", diff --git a/test/pleroma/web/mastodon_api/controllers/custom_emoji_controller_test.exs b/test/pleroma/web/mastodon_api/controllers/custom_emoji_controller_test.exs index cbb1d54a6..59746fa0a 100644 --- a/test/pleroma/web/mastodon_api/controllers/custom_emoji_controller_test.exs +++ b/test/pleroma/web/mastodon_api/controllers/custom_emoji_controller_test.exs @@ -20,4 +20,33 @@ defmodule Pleroma.Web.MastodonAPI.CustomEmojiControllerTest do assert Map.has_key?(emoji, "url") assert Map.has_key?(emoji, "visible_in_picker") end + + test "with display name", %{conn: conn} do + assert resp = + conn + |> get("/api/v1/custom_emojis") + |> json_response_and_validate_schema(200) + + assert test_pack = + conn + |> get("/api/pleroma/emoji/pack?name=test_pack_with_display_name") + |> json_response_and_validate_schema(200) + + assert emoji = Enum.at(Enum.filter(resp, fn x -> x["shortcode"] == "blank6" end), 0) + assert emoji["category"] == test_pack["pack"]["display-name"] + assert Enum.at(emoji["tags"], 0) == test_pack["pack"]["display-name"] + end + + test "without display name", %{conn: conn} do + assert resp = + conn + |> get("/api/v1/custom_emojis") + |> json_response_and_validate_schema(200) + + assert test_pack_name = "test_pack_no_display_name" + + assert emoji = Enum.at(Enum.filter(resp, fn x -> x["shortcode"] == "blank5" end), 0) + assert emoji["category"] == "pack:#{test_pack_name}" + assert Enum.at(emoji["tags"], 0) == "pack:#{test_pack_name}" + end end diff --git a/test/pleroma/web/pleroma_api/controllers/emoji_pack_controller_test.exs b/test/pleroma/web/pleroma_api/controllers/emoji_pack_controller_test.exs index d1ba067b8..bd559dbc9 100644 --- a/test/pleroma/web/pleroma_api/controllers/emoji_pack_controller_test.exs +++ b/test/pleroma/web/pleroma_api/controllers/emoji_pack_controller_test.exs @@ -37,11 +37,11 @@ defmodule Pleroma.Web.PleromaAPI.EmojiPackControllerTest do test "GET /api/pleroma/emoji/packs", %{conn: conn} do resp = conn |> get("/api/pleroma/emoji/packs") |> json_response_and_validate_schema(200) - assert resp["count"] == 4 + assert resp["count"] == 6 assert resp["packs"] |> Map.keys() - |> length() == 4 + |> length() == 6 shared = resp["packs"]["test_pack"] assert shared["files"] == %{"blank" => "blank.png", "blank2" => "blank2.png"} @@ -53,12 +53,15 @@ defmodule Pleroma.Web.PleromaAPI.EmojiPackControllerTest do assert non_shared["pack"]["share-files"] == false assert non_shared["pack"]["can-download"] == false + no_display_name = resp["packs"]["test_pack_no_display_name"] + assert no_display_name["pack"]["display-name"] == nil + resp = conn |> get("/api/pleroma/emoji/packs?page_size=1") |> json_response_and_validate_schema(200) - assert resp["count"] == 4 + assert resp["count"] == 6 packs = Map.keys(resp["packs"]) @@ -71,7 +74,7 @@ defmodule Pleroma.Web.PleromaAPI.EmojiPackControllerTest do |> get("/api/pleroma/emoji/packs?page_size=1&page=2") |> json_response_and_validate_schema(200) - assert resp["count"] == 4 + assert resp["count"] == 6 packs = Map.keys(resp["packs"]) assert length(packs) == 1 [pack2] = packs @@ -81,7 +84,7 @@ defmodule Pleroma.Web.PleromaAPI.EmojiPackControllerTest do |> get("/api/pleroma/emoji/packs?page_size=1&page=3") |> json_response_and_validate_schema(200) - assert resp["count"] == 4 + assert resp["count"] == 6 packs = Map.keys(resp["packs"]) assert length(packs) == 1 [pack3] = packs @@ -91,7 +94,7 @@ defmodule Pleroma.Web.PleromaAPI.EmojiPackControllerTest do |> get("/api/pleroma/emoji/packs?page_size=1&page=4") |> json_response_and_validate_schema(200) - assert resp["count"] == 4 + assert resp["count"] == 6 packs = Map.keys(resp["packs"]) assert length(packs) == 1 [pack4] = packs @@ -358,6 +361,7 @@ defmodule Pleroma.Web.PleromaAPI.EmojiPackControllerTest do {:ok, pack_file: pack_file, new_data: %{ + "display-name" => "Test display name changed", "license" => "Test license changed", "homepage" => "https://pleroma.social", "description" => "Test description", @@ -587,6 +591,7 @@ defmodule Pleroma.Web.PleromaAPI.EmojiPackControllerTest do "files_count" => 2, "pack" => %{ "can-download" => true, + "display-name" => "Test display name", "description" => "Test description", "download-sha256" => _, "homepage" => "https://pleroma.social", @@ -627,6 +632,7 @@ defmodule Pleroma.Web.PleromaAPI.EmojiPackControllerTest do "files_count" => 1, "pack" => %{ "can-download" => true, + "display-name" => "Test display name", "description" => "Test description", "download-sha256" => _, "homepage" => "https://pleroma.social", @@ -647,6 +653,24 @@ defmodule Pleroma.Web.PleromaAPI.EmojiPackControllerTest do } end + test "for pack with no display name", %{conn: conn} do + assert %{ + "files" => _files, + "files_count" => 1, + "pack" => %{ + "can-download" => true, + "description" => "Test description", + "download-sha256" => _, + "homepage" => "https://pleroma.social", + "license" => "Test license", + "share-files" => true + } + } = + conn + |> get("/api/pleroma/emoji/pack?name=test_pack_no_display_name") + |> json_response_and_validate_schema(200) + end + test "error name", %{conn: conn} do assert conn |> get("/api/pleroma/emoji/pack?name= ")