381 lines
12 KiB
Elixir
381 lines
12 KiB
Elixir
# Pleroma: A lightweight social networking server
|
|
# Copyright © 2017-2021 Pleroma Authors <https://pleroma.social/>
|
|
# SPDX-License-Identifier: AGPL-3.0-only
|
|
|
|
defmodule Pleroma.Config.DeprecationWarnings do
|
|
alias Pleroma.Config
|
|
|
|
require Logger
|
|
alias Pleroma.Config
|
|
|
|
@type config_namespace() :: atom() | [atom()]
|
|
@type config_map() :: {config_namespace(), config_namespace(), String.t()}
|
|
|
|
@mrf_config_map [
|
|
{[:instance, :rewrite_policy], [:mrf, :policies],
|
|
"\n* `config :pleroma, :instance, rewrite_policy` is now `config :pleroma, :mrf, policies`"},
|
|
{[:instance, :mrf_transparency], [:mrf, :transparency],
|
|
"\n* `config :pleroma, :instance, mrf_transparency` is now `config :pleroma, :mrf, transparency`"},
|
|
{[:instance, :mrf_transparency_exclusions], [: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_quarantined_instances_tuples do
|
|
has_strings =
|
|
Config.get([:instance, :quarantined_instances]) |> Enum.any?(fn e -> is_binary(e) end)
|
|
|
|
if has_strings do
|
|
Logger.warn("""
|
|
!!!DEPRECATION WARNING!!!
|
|
Your config is using strings in the quarantined_instances 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, :instance,
|
|
quarantined_instances: ["instance.tld"]
|
|
```
|
|
|
|
Is now
|
|
|
|
|
|
```
|
|
config :pleroma, :instance,
|
|
quarantined_instances: [{"instance.tld", "Reason for quarantine"}]
|
|
```
|
|
""")
|
|
|
|
new_config =
|
|
Config.get([:instance, :quarantined_instances])
|
|
|> Enum.map(fn
|
|
{instance, reason} -> {instance, reason}
|
|
instance -> {instance, ""}
|
|
end)
|
|
|
|
Config.put([:instance, :quarantined_instances], new_config)
|
|
|
|
:error
|
|
else
|
|
:ok
|
|
end
|
|
end
|
|
|
|
def check_transparency_exclusions_tuples do
|
|
has_strings =
|
|
Config.get([:mrf, :transparency_exclusions]) |> Enum.any?(fn e -> is_binary(e) end)
|
|
|
|
if has_strings do
|
|
Logger.warn("""
|
|
!!!DEPRECATION WARNING!!!
|
|
Your config is using strings in the transparency_exclusions 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,
|
|
transparency_exclusions: ["instance.tld"]
|
|
```
|
|
|
|
Is now
|
|
|
|
|
|
```
|
|
config :pleroma, :mrf,
|
|
transparency_exclusions: [{"instance.tld", "Reason to exlude transparency"}]
|
|
```
|
|
""")
|
|
|
|
new_config =
|
|
Config.get([:mrf, :transparency_exclusions])
|
|
|> Enum.map(fn
|
|
{instance, reason} -> {instance, reason}
|
|
instance -> {instance, ""}
|
|
end)
|
|
|
|
Config.put([:mrf, :transparency_exclusions], new_config)
|
|
|
|
:error
|
|
else
|
|
:ok
|
|
end
|
|
end
|
|
|
|
def check_hellthread_threshold do
|
|
if Config.get([:mrf_hellthread, :threshold]) do
|
|
Logger.warn("""
|
|
!!!DEPRECATION WARNING!!!
|
|
You are using the old configuration mechanism for the hellthread filter. Please check config.md.
|
|
""")
|
|
|
|
:error
|
|
else
|
|
:ok
|
|
end
|
|
end
|
|
|
|
def warn do
|
|
with :ok <- check_hellthread_threshold(),
|
|
:ok <- check_old_mrf_config(),
|
|
:ok <- check_media_proxy_whitelist_config(),
|
|
:ok <- check_welcome_message_config(),
|
|
:ok <- check_gun_pool_options(),
|
|
:ok <- check_activity_expiration_config(),
|
|
:ok <- check_remote_ip_plug_name(),
|
|
:ok <- check_uploders_s3_public_endpoint(),
|
|
:ok <- check_old_chat_shoutbox(),
|
|
:ok <- check_quarantined_instances_tuples(),
|
|
:ok <- check_transparency_exclusions_tuples(),
|
|
:ok <- check_simple_policy_tuples() do
|
|
:ok
|
|
else
|
|
_ ->
|
|
:error
|
|
end
|
|
end
|
|
|
|
def check_welcome_message_config do
|
|
instance_config = Pleroma.Config.get([:instance])
|
|
|
|
use_old_config =
|
|
Keyword.has_key?(instance_config, :welcome_user_nickname) or
|
|
Keyword.has_key?(instance_config, :welcome_message)
|
|
|
|
if use_old_config do
|
|
Logger.error("""
|
|
!!!DEPRECATION WARNING!!!
|
|
Your config is using the old namespace for Welcome messages configuration. You need to convert to the new namespace. e.g.,
|
|
\n* `config :pleroma, :instance, welcome_user_nickname` and `config :pleroma, :instance, welcome_message` are now equal to:
|
|
\n* `config :pleroma, :welcome, direct_message: [enabled: true, sender_nickname: "NICKNAME", message: "Your welcome message"]`"
|
|
""")
|
|
|
|
:error
|
|
else
|
|
:ok
|
|
end
|
|
end
|
|
|
|
def check_old_mrf_config do
|
|
warning_preface = """
|
|
!!!DEPRECATION WARNING!!!
|
|
Your config is using old namespaces for MRF configuration. They should work for now, but you are advised to change to new namespaces to prevent possible issues later:
|
|
"""
|
|
|
|
move_namespace_and_warn(@mrf_config_map, warning_preface)
|
|
end
|
|
|
|
@spec move_namespace_and_warn([config_map()], String.t()) :: :ok | nil
|
|
def move_namespace_and_warn(config_map, warning_preface) do
|
|
warning =
|
|
Enum.reduce(config_map, "", fn
|
|
{old, new, err_msg}, acc ->
|
|
old_config = Config.get(old)
|
|
|
|
if old_config do
|
|
Config.put(new, old_config)
|
|
acc <> err_msg
|
|
else
|
|
acc
|
|
end
|
|
end)
|
|
|
|
if warning == "" do
|
|
:ok
|
|
else
|
|
Logger.warn(warning_preface <> warning)
|
|
:error
|
|
end
|
|
end
|
|
|
|
@spec check_media_proxy_whitelist_config() :: :ok | nil
|
|
def check_media_proxy_whitelist_config do
|
|
whitelist = Config.get([:media_proxy, :whitelist])
|
|
|
|
if Enum.any?(whitelist, &(not String.starts_with?(&1, "http"))) do
|
|
Logger.warn("""
|
|
!!!DEPRECATION WARNING!!!
|
|
Your config is using old format (only domain) for MediaProxy whitelist option. Setting should work for now, but you are advised to change format to scheme with port to prevent possible issues later.
|
|
""")
|
|
|
|
:error
|
|
else
|
|
:ok
|
|
end
|
|
end
|
|
|
|
def check_gun_pool_options do
|
|
pool_config = Config.get(:connections_pool)
|
|
|
|
if timeout = pool_config[:await_up_timeout] do
|
|
Logger.warn("""
|
|
!!!DEPRECATION WARNING!!!
|
|
Your config is using old setting `config :pleroma, :connections_pool, await_up_timeout`. Please change to `config :pleroma, :connections_pool, connect_timeout` to ensure compatibility with future releases.
|
|
""")
|
|
|
|
Config.put(:connections_pool, Keyword.put_new(pool_config, :connect_timeout, timeout))
|
|
end
|
|
|
|
pools_configs = Config.get(:pools)
|
|
|
|
warning_preface = """
|
|
!!!DEPRECATION WARNING!!!
|
|
Your config is using old setting name `timeout` instead of `recv_timeout` in pool settings. Setting should work for now, but you are advised to change format to scheme with port to prevent possible issues later.
|
|
"""
|
|
|
|
updated_config =
|
|
Enum.reduce(pools_configs, [], fn {pool_name, config}, acc ->
|
|
if timeout = config[:timeout] do
|
|
Keyword.put(acc, pool_name, Keyword.put_new(config, :recv_timeout, timeout))
|
|
else
|
|
acc
|
|
end
|
|
end)
|
|
|
|
if updated_config != [] do
|
|
pool_warnings =
|
|
updated_config
|
|
|> Keyword.keys()
|
|
|> Enum.map(fn pool_name ->
|
|
"\n* `:timeout` options in #{pool_name} pool is now `:recv_timeout`"
|
|
end)
|
|
|
|
Logger.warn(Enum.join([warning_preface | pool_warnings]))
|
|
|
|
Config.put(:pools, updated_config)
|
|
:error
|
|
else
|
|
:ok
|
|
end
|
|
end
|
|
|
|
@spec check_activity_expiration_config() :: :ok | nil
|
|
def check_activity_expiration_config do
|
|
warning_preface = """
|
|
!!!DEPRECATION WARNING!!!
|
|
Your config is using old namespace for activity expiration configuration. Setting should work for now, but you are advised to change to new namespace to prevent possible issues later:
|
|
"""
|
|
|
|
move_namespace_and_warn(
|
|
[
|
|
{Pleroma.ActivityExpiration, Pleroma.Workers.PurgeExpiredActivity,
|
|
"\n* `config :pleroma, Pleroma.ActivityExpiration` is now `config :pleroma, Pleroma.Workers.PurgeExpiredActivity`"}
|
|
],
|
|
warning_preface
|
|
)
|
|
end
|
|
|
|
@spec check_remote_ip_plug_name() :: :ok | nil
|
|
def check_remote_ip_plug_name do
|
|
warning_preface = """
|
|
!!!DEPRECATION WARNING!!!
|
|
Your config is using old namespace for RemoteIp Plug. Setting should work for now, but you are advised to change to new namespace to prevent possible issues later:
|
|
"""
|
|
|
|
move_namespace_and_warn(
|
|
[
|
|
{Pleroma.Plugs.RemoteIp, Pleroma.Web.Plugs.RemoteIp,
|
|
"\n* `config :pleroma, Pleroma.Plugs.RemoteIp` is now `config :pleroma, Pleroma.Web.Plugs.RemoteIp`"}
|
|
],
|
|
warning_preface
|
|
)
|
|
end
|
|
|
|
@spec check_uploders_s3_public_endpoint() :: :ok | nil
|
|
def check_uploders_s3_public_endpoint do
|
|
s3_config = Pleroma.Config.get([Pleroma.Uploaders.S3])
|
|
|
|
use_old_config = Keyword.has_key?(s3_config, :public_endpoint)
|
|
|
|
if use_old_config do
|
|
Logger.error("""
|
|
!!!DEPRECATION WARNING!!!
|
|
Your config is using the old setting for controlling the URL of media uploaded to your S3 bucket.\n
|
|
Please make the following change at your earliest convenience.\n
|
|
\n* `config :pleroma, Pleroma.Uploaders.S3, public_endpoint` is now equal to:
|
|
\n* `config :pleroma, Pleroma.Upload, base_url`
|
|
""")
|
|
|
|
:error
|
|
else
|
|
:ok
|
|
end
|
|
end
|
|
|
|
@spec check_old_chat_shoutbox() :: :ok | nil
|
|
def check_old_chat_shoutbox do
|
|
instance_config = Pleroma.Config.get([:instance])
|
|
chat_config = Pleroma.Config.get([:chat]) || []
|
|
|
|
use_old_config =
|
|
Keyword.has_key?(instance_config, :chat_limit) or
|
|
Keyword.has_key?(chat_config, :enabled)
|
|
|
|
if use_old_config do
|
|
Logger.error("""
|
|
!!!DEPRECATION WARNING!!!
|
|
Your config is using the old namespace for the Shoutbox configuration. You need to convert to the new namespace. e.g.,
|
|
\n* `config :pleroma, :chat, enabled` and `config :pleroma, :instance, chat_limit` are now equal to:
|
|
\n* `config :pleroma, :shout, enabled` and `config :pleroma, :shout, limit`
|
|
""")
|
|
|
|
:error
|
|
else
|
|
:ok
|
|
end
|
|
end
|
|
end
|