Deprectate strings for SimplePolicy
When strings are detected in the simplepolicy, a warning will be given and the config will be changed to use tuples instead
This commit is contained in:
parent
5f5dc24027
commit
647087d7fd
2 changed files with 138 additions and 1 deletions
|
@ -20,6 +20,66 @@ defmodule Pleroma.Config.DeprecationWarnings do
|
||||||
"\n* `config :pleroma, :instance, mrf_transparency_exclusions` is now `config :pleroma, :mrf, transparency_exclusions`"}
|
"\n* `config :pleroma, :instance, mrf_transparency_exclusions` is now `config :pleroma, :mrf, transparency_exclusions`"}
|
||||||
]
|
]
|
||||||
|
|
||||||
|
def check_simple_policy_tuples do
|
||||||
|
has_strings =
|
||||||
|
Config.get([:mrf_simple])
|
||||||
|
|> Enum.any?(fn {_, v} -> Enum.any?(v, fn e -> is_binary(e) end) end)
|
||||||
|
|
||||||
|
if has_strings do
|
||||||
|
Logger.warn("""
|
||||||
|
!!!DEPRECATION WARNING!!!
|
||||||
|
Your config is using strings in the SimplePolicy configuration instead of tuples. They should work for now, but you are advised to change to the new configuration to prevent possible issues later:
|
||||||
|
|
||||||
|
```
|
||||||
|
config :pleroma, :mrf_simple,
|
||||||
|
media_removal: ["instance.tld"],
|
||||||
|
media_nsfw: ["instance.tld"],
|
||||||
|
federated_timeline_removal: ["instance.tld"],
|
||||||
|
report_removal: ["instance.tld"],
|
||||||
|
reject: ["instance.tld"],
|
||||||
|
followers_only: ["instance.tld"],
|
||||||
|
accept: ["instance.tld"],
|
||||||
|
avatar_removal: ["instance.tld"],
|
||||||
|
banner_removal: ["instance.tld"],
|
||||||
|
reject_deletes: ["instance.tld"]
|
||||||
|
```
|
||||||
|
|
||||||
|
Is now
|
||||||
|
|
||||||
|
|
||||||
|
```
|
||||||
|
config :pleroma, :mrf_simple,
|
||||||
|
media_removal: [{"instance.tld", "Reason for media removal"}],
|
||||||
|
media_nsfw: [{"instance.tld", "Reason for media nsfw"}],
|
||||||
|
federated_timeline_removal: [{"instance.tld", "Reason for federated timeline removal"}],
|
||||||
|
report_removal: [{"instance.tld", "Reason for report removal"}],
|
||||||
|
reject: [{"instance.tld", "Reason for reject"}],
|
||||||
|
followers_only: [{"instance.tld", "Reason for followers only"}],
|
||||||
|
accept: [{"instance.tld", "Reason for accept"}],
|
||||||
|
avatar_removal: [{"instance.tld", "Reason for avatar removal"}],
|
||||||
|
banner_removal: [{"instance.tld", "Reason for banner removal"}],
|
||||||
|
reject_deletes: [{"instance.tld", "Reason for reject deletes"}]
|
||||||
|
```
|
||||||
|
""")
|
||||||
|
|
||||||
|
new_config =
|
||||||
|
Config.get([:mrf_simple])
|
||||||
|
|> Enum.map(fn {k, v} ->
|
||||||
|
{k,
|
||||||
|
Enum.map(v, fn
|
||||||
|
{instance, reason} -> {instance, reason}
|
||||||
|
instance -> {instance, ""}
|
||||||
|
end)}
|
||||||
|
end)
|
||||||
|
|
||||||
|
Config.put([:mrf_simple], new_config)
|
||||||
|
|
||||||
|
:error
|
||||||
|
else
|
||||||
|
:ok
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
def check_hellthread_threshold do
|
def check_hellthread_threshold do
|
||||||
if Config.get([:mrf_hellthread, :threshold]) do
|
if Config.get([:mrf_hellthread, :threshold]) do
|
||||||
Logger.warn("""
|
Logger.warn("""
|
||||||
|
@ -42,7 +102,8 @@ def warn do
|
||||||
:ok <- check_activity_expiration_config(),
|
:ok <- check_activity_expiration_config(),
|
||||||
:ok <- check_remote_ip_plug_name(),
|
:ok <- check_remote_ip_plug_name(),
|
||||||
:ok <- check_uploders_s3_public_endpoint(),
|
:ok <- check_uploders_s3_public_endpoint(),
|
||||||
:ok <- check_old_chat_shoutbox() do
|
:ok <- check_old_chat_shoutbox(),
|
||||||
|
:ok <- check_simple_policy_tuples() do
|
||||||
:ok
|
:ok
|
||||||
else
|
else
|
||||||
_ ->
|
_ ->
|
||||||
|
|
|
@ -11,6 +11,82 @@ defmodule Pleroma.Config.DeprecationWarningsTest do
|
||||||
alias Pleroma.Config
|
alias Pleroma.Config
|
||||||
alias Pleroma.Config.DeprecationWarnings
|
alias Pleroma.Config.DeprecationWarnings
|
||||||
|
|
||||||
|
describe "simple policy tuples" do
|
||||||
|
test "gives warning when there are still strings" do
|
||||||
|
clear_config([:mrf_simple],
|
||||||
|
media_removal: ["some.removal"],
|
||||||
|
media_nsfw: ["some.nsfw"],
|
||||||
|
federated_timeline_removal: ["some.tl.removal"],
|
||||||
|
report_removal: ["some.report.removal"],
|
||||||
|
reject: ["some.reject"],
|
||||||
|
followers_only: ["some.followers.only"],
|
||||||
|
accept: ["some.accept"],
|
||||||
|
avatar_removal: ["some.avatar.removal"],
|
||||||
|
banner_removal: ["some.banner.removal"],
|
||||||
|
reject_deletes: ["some.reject.deletes"]
|
||||||
|
)
|
||||||
|
|
||||||
|
assert capture_log(fn -> DeprecationWarnings.check_simple_policy_tuples() end) =~
|
||||||
|
"""
|
||||||
|
!!!DEPRECATION WARNING!!!
|
||||||
|
Your config is using strings in the SimplePolicy configuration instead of tuples. They should work for now, but you are advised to change to the new configuration to prevent possible issues later:
|
||||||
|
|
||||||
|
```
|
||||||
|
config :pleroma, :mrf_simple,
|
||||||
|
media_removal: ["instance.tld"],
|
||||||
|
media_nsfw: ["instance.tld"],
|
||||||
|
federated_timeline_removal: ["instance.tld"],
|
||||||
|
report_removal: ["instance.tld"],
|
||||||
|
reject: ["instance.tld"],
|
||||||
|
followers_only: ["instance.tld"],
|
||||||
|
accept: ["instance.tld"],
|
||||||
|
avatar_removal: ["instance.tld"],
|
||||||
|
banner_removal: ["instance.tld"],
|
||||||
|
reject_deletes: ["instance.tld"]
|
||||||
|
```
|
||||||
|
|
||||||
|
Is now
|
||||||
|
|
||||||
|
|
||||||
|
```
|
||||||
|
config :pleroma, :mrf_simple,
|
||||||
|
media_removal: [{"instance.tld", "Reason for media removal"}],
|
||||||
|
media_nsfw: [{"instance.tld", "Reason for media nsfw"}],
|
||||||
|
federated_timeline_removal: [{"instance.tld", "Reason for federated timeline removal"}],
|
||||||
|
report_removal: [{"instance.tld", "Reason for report removal"}],
|
||||||
|
reject: [{"instance.tld", "Reason for reject"}],
|
||||||
|
followers_only: [{"instance.tld", "Reason for followers only"}],
|
||||||
|
accept: [{"instance.tld", "Reason for accept"}],
|
||||||
|
avatar_removal: [{"instance.tld", "Reason for avatar removal"}],
|
||||||
|
banner_removal: [{"instance.tld", "Reason for banner removal"}],
|
||||||
|
reject_deletes: [{"instance.tld", "Reason for reject deletes"}]
|
||||||
|
```
|
||||||
|
"""
|
||||||
|
end
|
||||||
|
|
||||||
|
test "transforms config to tuples" do
|
||||||
|
clear_config([:mrf_simple],
|
||||||
|
media_removal: ["some.removal", {"some.other.instance", "Some reason"}]
|
||||||
|
)
|
||||||
|
|
||||||
|
expected_config = [
|
||||||
|
{:media_removal, [{"some.removal", ""}, {"some.other.instance", "Some reason"}]}
|
||||||
|
]
|
||||||
|
|
||||||
|
capture_log(fn -> DeprecationWarnings.check_simple_policy_tuples() end)
|
||||||
|
|
||||||
|
assert Config.get([:mrf_simple]) == expected_config
|
||||||
|
end
|
||||||
|
|
||||||
|
test "doesn't give a warning with correct config" do
|
||||||
|
clear_config([:mrf_simple],
|
||||||
|
media_removal: [{"some.removal", ""}, {"some.other.instance", "Some reason"}]
|
||||||
|
)
|
||||||
|
|
||||||
|
assert capture_log(fn -> DeprecationWarnings.check_simple_policy_tuples() end) == ""
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
test "check_old_mrf_config/0" do
|
test "check_old_mrf_config/0" do
|
||||||
clear_config([:instance, :rewrite_policy], [])
|
clear_config([:instance, :rewrite_policy], [])
|
||||||
clear_config([:instance, :mrf_transparency], true)
|
clear_config([:instance, :mrf_transparency], true)
|
||||||
|
|
Loading…
Reference in a new issue