1 # Pleroma: A lightweight social networking server
2 # Copyright © 2017-2020 Pleroma Authors <https://pleroma.social/>
3 # SPDX-License-Identifier: AGPL-3.0-only
5 defmodule Pleroma.Config.DeprecationWarnings do
11 @type config_namespace() :: atom() | [atom()]
12 @type config_map() :: {config_namespace(), config_namespace(), String.t()}
15 {[:instance, :rewrite_policy], [:mrf, :policies],
16 "\n* `config :pleroma, :instance, rewrite_policy` is now `config :pleroma, :mrf, policies`"},
17 {[:instance, :mrf_transparency], [:mrf, :transparency],
18 "\n* `config :pleroma, :instance, mrf_transparency` is now `config :pleroma, :mrf, transparency`"},
19 {[:instance, :mrf_transparency_exclusions], [:mrf, :transparency_exclusions],
20 "\n* `config :pleroma, :instance, mrf_transparency_exclusions` is now `config :pleroma, :mrf, transparency_exclusions`"}
23 def check_hellthread_threshold do
24 if Config.get([:mrf_hellthread, :threshold]) do
26 !!!DEPRECATION WARNING!!!
27 You are using the old configuration mechanism for the hellthread filter. Please check config.md.
32 def mrf_user_allowlist do
33 config = Config.get(:mrf_user_allowlist)
35 if config && Enum.any?(config, fn {k, _} -> is_atom(k) end) do
37 Enum.reduce(Config.get(:mrf_user_allowlist), Map.new(), fn {k, v}, acc ->
38 Map.put(acc, to_string(k), v)
41 Config.put(:mrf_user_allowlist, rewritten)
44 !!!DEPRECATION WARNING!!!
45 As of Pleroma 2.0.7, the `mrf_user_allowlist` setting changed of format.
46 Pleroma 2.1 will remove support for the old format. Please change your configuration to match this:
48 config :pleroma, :mrf_user_allowlist, #{inspect(rewritten, pretty: true)}
54 check_hellthread_threshold()
56 check_old_mrf_config()
57 check_media_proxy_whitelist_config()
58 check_welcome_message_config()
59 check_gun_pool_options()
60 check_activity_expiration_config()
63 def check_welcome_message_config do
64 instance_config = Pleroma.Config.get([:instance])
67 Keyword.has_key?(instance_config, :welcome_user_nickname) or
68 Keyword.has_key?(instance_config, :welcome_message)
72 !!!DEPRECATION WARNING!!!
73 Your config is using the old namespace for Welcome messages configuration. You need to change to the new namespace:
74 \n* `config :pleroma, :instance, welcome_user_nickname` is now `config :pleroma, :welcome, :direct_message, :sender_nickname`
75 \n* `config :pleroma, :instance, welcome_message` is now `config :pleroma, :welcome, :direct_message, :message`
80 def check_old_mrf_config do
82 !!!DEPRECATION WARNING!!!
83 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:
86 move_namespace_and_warn(@mrf_config_map, warning_preface)
89 @spec move_namespace_and_warn([config_map()], String.t()) :: :ok | nil
90 def move_namespace_and_warn(config_map, warning_preface) do
92 Enum.reduce(config_map, "", fn
93 {old, new, err_msg}, acc ->
94 old_config = Config.get(old)
97 Config.put(new, old_config)
105 Logger.warn(warning_preface <> warning)
109 @spec check_media_proxy_whitelist_config() :: :ok | nil
110 def check_media_proxy_whitelist_config do
111 whitelist = Config.get([:media_proxy, :whitelist])
113 if Enum.any?(whitelist, &(not String.starts_with?(&1, "http"))) do
115 !!!DEPRECATION WARNING!!!
116 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.
121 def check_gun_pool_options do
122 pool_config = Config.get(:connections_pool)
124 if timeout = pool_config[:await_up_timeout] do
126 !!!DEPRECATION WARNING!!!
127 Your config is using old setting name `await_up_timeout` instead of `connect_timeout`. Setting should work for now, but you are advised to change format to scheme with port to prevent possible issues later.
130 Config.put(:connections_pool, Keyword.put_new(pool_config, :connect_timeout, timeout))
133 pools_configs = Config.get(:pools)
135 warning_preface = """
136 !!!DEPRECATION WARNING!!!
137 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.
141 Enum.reduce(pools_configs, [], fn {pool_name, config}, acc ->
142 if timeout = config[:timeout] do
143 Keyword.put(acc, pool_name, Keyword.put_new(config, :recv_timeout, timeout))
149 if updated_config != [] do
153 |> Enum.map(fn pool_name ->
154 "\n* `:timeout` options in #{pool_name} pool is now `:recv_timeout`"
157 Logger.warn(Enum.join([warning_preface | pool_warnings]))
159 Config.put(:pools, updated_config)
163 @spec check_activity_expiration_config() :: :ok | nil
164 def check_activity_expiration_config do
165 warning_preface = """
166 !!!DEPRECATION WARNING!!!
167 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:
170 move_namespace_and_warn(
172 {Pleroma.ActivityExpiration, Pleroma.Workers.PurgeExpiredActivity,
173 "\n* `config :pleroma, Pleroma.ActivityExpiration` is now `config :pleroma, Pleroma.Workers.PurgeExpiredActivity`"}