From b2a0718e83c2d61fc081ca3a1b3cd67a47da1e98 Mon Sep 17 00:00:00 2001 From: Tusooa Zhu Date: Wed, 13 Jul 2022 17:59:23 -0400 Subject: Extract config descriptions for translation --- lib/pleroma/docs/translator.ex | 9 ++++ lib/pleroma/docs/translator/compiler.ex | 75 +++++++++++++++++++++++++++++++++ 2 files changed, 84 insertions(+) create mode 100644 lib/pleroma/docs/translator.ex create mode 100644 lib/pleroma/docs/translator/compiler.ex (limited to 'lib') diff --git a/lib/pleroma/docs/translator.ex b/lib/pleroma/docs/translator.ex new file mode 100644 index 000000000..db985b7c2 --- /dev/null +++ b/lib/pleroma/docs/translator.ex @@ -0,0 +1,9 @@ +# Pleroma: A lightweight social networking server +# Copyright © 2017-2022 Pleroma Authors +# SPDX-License-Identifier: AGPL-3.0-only + +defmodule Pleroma.Docs.Translator do + require Pleroma.Web.Gettext + + @before_compile Pleroma.Docs.Translator.Compiler +end diff --git a/lib/pleroma/docs/translator/compiler.ex b/lib/pleroma/docs/translator/compiler.ex new file mode 100644 index 000000000..21c02b50b --- /dev/null +++ b/lib/pleroma/docs/translator/compiler.ex @@ -0,0 +1,75 @@ +# Pleroma: A lightweight social networking server +# Copyright © 2017-2022 Pleroma Authors +# SPDX-License-Identifier: AGPL-3.0-only + +defmodule Pleroma.Docs.Translator.Compiler do + @external_resource "config/description.exs" + @raw_config Pleroma.Config.Loader.read("config/description.exs") + @raw_descriptions @raw_config[:pleroma][:config_description] + + defmacro __before_compile__(_env) do + strings = + __MODULE__.descriptions() + |> __MODULE__.extract_strings() + + quote do + def placeholder do + unquote do + Enum.map( + strings, + fn string -> + quote do + Pleroma.Web.Gettext.dgettext_noop("config_descriptions", unquote(string)) + end + end + ) + end + end + end + end + + def descriptions do + Pleroma.Web.ActivityPub.MRF.config_descriptions() + |> Enum.reduce(@raw_descriptions, fn description, acc -> [description | acc] end) + |> Pleroma.Docs.Generator.convert_to_strings() + end + + def extract_strings(descriptions) do + descriptions + |> Enum.reduce([], &process_item/2) + end + + defp process_item(entity, acc) do + current_level = + acc + |> process_desc(entity) + |> process_label(entity) + + process_children(entity, current_level) + end + + defp process_desc(acc, %{description: desc}) do + [desc | acc] + end + + defp process_desc(acc, _) do + acc + end + + defp process_label(acc, %{label: label}) do + [label | acc] + end + + defp process_label(acc, _) do + acc + end + + defp process_children(%{children: children}, acc) do + children + |> Enum.reduce(acc, &process_item/2) + end + + defp process_children(_, acc) do + acc + end +end -- cgit v1.2.3 From 20588517fc5ed86c77865d879027618a1eb54106 Mon Sep 17 00:00:00 2001 From: Tusooa Zhu Date: Wed, 13 Jul 2022 18:31:35 -0400 Subject: Make admin api use translated config descriptions --- .../web/admin_api/controllers/config_controller.ex | 34 +++++++++++++++++++++- 1 file changed, 33 insertions(+), 1 deletion(-) (limited to 'lib') diff --git a/lib/pleroma/web/admin_api/controllers/config_controller.ex b/lib/pleroma/web/admin_api/controllers/config_controller.ex index 55ab6d063..f6fbbc910 100644 --- a/lib/pleroma/web/admin_api/controllers/config_controller.ex +++ b/lib/pleroma/web/admin_api/controllers/config_controller.ex @@ -22,10 +22,42 @@ defmodule Pleroma.Web.AdminAPI.ConfigController do defdelegate open_api_operation(action), to: Pleroma.Web.ApiSpec.Admin.ConfigOperation + defp translate_descriptions(descriptions) do + Enum.map(descriptions, &translate_item/1) + end + + defp translate_string(str) do + Gettext.dgettext(Pleroma.Web.Gettext, "config_descriptions", str) + end + + defp maybe_put_translated(item, key) do + if item[key] do + Map.put(item, key, translate_string(item[key])) + else + item + end + end + + defp translate_item(item) do + item + |> maybe_put_translated(:label) + |> maybe_put_translated(:description) + |> translate_children() + end + + defp translate_children(%{children: children} = item) when is_list(children) do + item + |> Map.put(:children, translate_descriptions(children)) + end + + defp translate_children(item) do + item + end + def descriptions(conn, _params) do descriptions = Enum.filter(Pleroma.Docs.JSON.compiled_descriptions(), &whitelisted_config?/1) - json(conn, descriptions) + json(conn, translate_descriptions(descriptions)) end def show(conn, %{only_db: true}) do -- cgit v1.2.3 From 7473868880b21850eaa5431b2db66af05a854405 Mon Sep 17 00:00:00 2001 From: Tusooa Zhu Date: Wed, 13 Jul 2022 18:46:21 -0400 Subject: Fix compile error --- lib/pleroma/docs/translator.ex | 1 + 1 file changed, 1 insertion(+) (limited to 'lib') diff --git a/lib/pleroma/docs/translator.ex b/lib/pleroma/docs/translator.ex index db985b7c2..13e33c87e 100644 --- a/lib/pleroma/docs/translator.ex +++ b/lib/pleroma/docs/translator.ex @@ -3,6 +3,7 @@ # SPDX-License-Identifier: AGPL-3.0-only defmodule Pleroma.Docs.Translator do + require Pleroma.Docs.Translator.Compiler require Pleroma.Web.Gettext @before_compile Pleroma.Docs.Translator.Compiler -- cgit v1.2.3 From 1d7e8d6e013bb39e6ca61bd595a22490412db084 Mon Sep 17 00:00:00 2001 From: Tusooa Zhu Date: Thu, 14 Jul 2022 17:41:33 -0400 Subject: Pass in msgctxt for config translation strings --- lib/pleroma/docs/translator/compiler.ex | 62 ++++++++++++++++++---- .../web/admin_api/controllers/config_controller.ex | 42 ++++++++++----- 2 files changed, 82 insertions(+), 22 deletions(-) (limited to 'lib') diff --git a/lib/pleroma/docs/translator/compiler.ex b/lib/pleroma/docs/translator/compiler.ex index 21c02b50b..5d27d9fa2 100644 --- a/lib/pleroma/docs/translator/compiler.ex +++ b/lib/pleroma/docs/translator/compiler.ex @@ -17,9 +17,15 @@ defmodule Pleroma.Docs.Translator.Compiler do unquote do Enum.map( strings, - fn string -> + fn {path, type, string} -> + ctxt = msgctxt_for(path, type) + quote do - Pleroma.Web.Gettext.dgettext_noop("config_descriptions", unquote(string)) + Pleroma.Web.Gettext.dpgettext_noop( + "config_descriptions", + unquote(ctxt), + unquote(string) + ) end end ) @@ -36,7 +42,8 @@ defmodule Pleroma.Docs.Translator.Compiler do def extract_strings(descriptions) do descriptions - |> Enum.reduce([], &process_item/2) + |> Enum.reduce(%{strings: [], path: []}, &process_item/2) + |> Map.get(:strings) end defp process_item(entity, acc) do @@ -48,28 +55,65 @@ defmodule Pleroma.Docs.Translator.Compiler do process_children(entity, current_level) end - defp process_desc(acc, %{description: desc}) do - [desc | acc] + defp process_desc(acc, %{description: desc} = item) do + %{ + strings: [{acc.path ++ [key_for(item)], "description", desc} | acc.strings], + path: acc.path + } end defp process_desc(acc, _) do acc end - defp process_label(acc, %{label: label}) do - [label | acc] + defp process_label(acc, %{label: label} = item) do + %{ + strings: [{acc.path ++ [key_for(item)], "label", label} | acc.strings], + path: acc.path + } end defp process_label(acc, _) do acc end - defp process_children(%{children: children}, acc) do + defp process_children(%{children: children} = item, acc) do + current_level = Map.put(acc, :path, acc.path ++ [key_for(item)]) + children - |> Enum.reduce(acc, &process_item/2) + |> Enum.reduce(current_level, &process_item/2) + |> Map.put(:path, acc.path) end defp process_children(_, acc) do acc end + + def msgctxt_for(path, type) do + "config #{type} at #{Enum.join(path, " > ")}" + end + + defp convert_group({_, group}) do + group + end + + defp convert_group(group) do + group + end + + def key_for(%{group: group, key: key}) do + "#{convert_group(group)}-#{key}" + end + + def key_for(%{group: group}) do + convert_group(group) + end + + def key_for(%{key: key}) do + key + end + + def key_for(_) do + nil + end end diff --git a/lib/pleroma/web/admin_api/controllers/config_controller.ex b/lib/pleroma/web/admin_api/controllers/config_controller.ex index f6fbbc910..a03318c0e 100644 --- a/lib/pleroma/web/admin_api/controllers/config_controller.ex +++ b/lib/pleroma/web/admin_api/controllers/config_controller.ex @@ -22,35 +22,51 @@ defmodule Pleroma.Web.AdminAPI.ConfigController do defdelegate open_api_operation(action), to: Pleroma.Web.ApiSpec.Admin.ConfigOperation - defp translate_descriptions(descriptions) do - Enum.map(descriptions, &translate_item/1) + defp translate_descriptions(descriptions, path \\ []) do + Enum.map(descriptions, fn desc -> translate_item(desc, path) end) end - defp translate_string(str) do - Gettext.dgettext(Pleroma.Web.Gettext, "config_descriptions", str) + defp translate_string(str, path, type) do + Gettext.dpgettext( + Pleroma.Web.Gettext, + "config_descriptions", + Pleroma.Docs.Translator.Compiler.msgctxt_for(path, type), + str + ) end - defp maybe_put_translated(item, key) do + defp maybe_put_translated(item, key, path) do if item[key] do - Map.put(item, key, translate_string(item[key])) + Map.put( + item, + key, + translate_string( + item[key], + path ++ [Pleroma.Docs.Translator.Compiler.key_for(item)], + to_string(key) + ) + ) else item end end - defp translate_item(item) do + defp translate_item(item, path) do item - |> maybe_put_translated(:label) - |> maybe_put_translated(:description) - |> translate_children() + |> maybe_put_translated(:label, path) + |> maybe_put_translated(:description, path) + |> translate_children(path) end - defp translate_children(%{children: children} = item) when is_list(children) do + defp translate_children(%{children: children} = item, path) when is_list(children) do item - |> Map.put(:children, translate_descriptions(children)) + |> Map.put( + :children, + translate_descriptions(children, path ++ [Pleroma.Docs.Translator.Compiler.key_for(item)]) + ) end - defp translate_children(item) do + defp translate_children(item, _path) do item end -- cgit v1.2.3