Merge branch 'display-name' into 'develop'
Add optional `display-name` parameter for custom emoji packs See merge request pleroma/pleroma!3092
This commit is contained in:
commit
7408f004aa
@ -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
|
||||
|
@ -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,
|
||||
|
@ -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
|
||||
|
@ -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
|
||||
|
||||
|
@ -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},
|
||||
|
@ -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"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
3
test/fixtures/emoji/packs/manifest.json
vendored
3
test/fixtures/emoji/packs/manifest.json
vendored
@ -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"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
@ -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
|
||||
}
|
||||
}
|
||||
}
|
||||
|
@ -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"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
@ -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
|
||||
}
|
||||
}
|
||||
}
|
||||
|
BIN
test/instance_static/emoji/test_pack_no_display_name/blank5.png
Normal file
BIN
test/instance_static/emoji/test_pack_no_display_name/blank5.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 95 B |
@ -0,0 +1,11 @@
|
||||
{
|
||||
"files": {
|
||||
"blank5": "blank5.png"
|
||||
},
|
||||
"pack": {
|
||||
"description": "Test description",
|
||||
"homepage": "https://pleroma.social",
|
||||
"license": "Test license",
|
||||
"share-files": true
|
||||
}
|
||||
}
|
@ -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"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
Binary file not shown.
After Width: | Height: | Size: 95 B |
@ -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
|
||||
}
|
||||
}
|
@ -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",
|
||||
|
@ -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
|
||||
|
@ -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= ")
|
||||
|
Loading…
Reference in New Issue
Block a user