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.
36 def mrf_user_allowlist do
37 config = Config.get(:mrf_user_allowlist)
39 if config && Enum.any?(config, fn {k, _} -> is_atom(k) end) do
41 Enum.reduce(Config.get(:mrf_user_allowlist), Map.new(), fn {k, v}, acc ->
42 Map.put(acc, to_string(k), v)
45 Config.put(:mrf_user_allowlist, rewritten)
48 !!!DEPRECATION WARNING!!!
49 As of Pleroma 2.0.7, the `mrf_user_allowlist` setting changed of format.
50 Pleroma 2.1 will remove support for the old format. Please change your configuration to match this:
52 config :pleroma, :mrf_user_allowlist, #{inspect(rewritten, pretty: true)}
62 with :ok <- check_hellthread_threshold(),
63 :ok <- mrf_user_allowlist(),
64 :ok <- check_old_mrf_config(),
65 :ok <- check_media_proxy_whitelist_config(),
66 :ok <- check_welcome_message_config(),
67 :ok <- check_gun_pool_options(),
68 :ok <- check_activity_expiration_config() do
76 def check_welcome_message_config do
77 instance_config = Pleroma.Config.get([:instance])
80 Keyword.has_key?(instance_config, :welcome_user_nickname) or
81 Keyword.has_key?(instance_config, :welcome_message)
85 !!!DEPRECATION WARNING!!!
86 Your config is using the old namespace for Welcome messages configuration. You need to change to the new namespace:
87 \n* `config :pleroma, :instance, welcome_user_nickname` is now `config :pleroma, :welcome, :direct_message, :sender_nickname`
88 \n* `config :pleroma, :instance, welcome_message` is now `config :pleroma, :welcome, :direct_message, :message`
97 def check_old_mrf_config do
99 !!!DEPRECATION WARNING!!!
100 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:
103 move_namespace_and_warn(@mrf_config_map, warning_preface)
106 @spec move_namespace_and_warn([config_map()], String.t()) :: :ok | nil
107 def move_namespace_and_warn(config_map, warning_preface) do
109 Enum.reduce(config_map, "", fn
110 {old, new, err_msg}, acc ->
111 old_config = Config.get(old)
114 Config.put(new, old_config)
124 Logger.warn(warning_preface <> warning)
129 @spec check_media_proxy_whitelist_config() :: :ok | nil
130 def check_media_proxy_whitelist_config do
131 whitelist = Config.get([:media_proxy, :whitelist])
133 if Enum.any?(whitelist, &(not String.starts_with?(&1, "http"))) do
135 !!!DEPRECATION WARNING!!!
136 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.
145 def check_gun_pool_options do
146 pool_config = Config.get(:connections_pool)
148 if timeout = pool_config[:await_up_timeout] do
150 !!!DEPRECATION WARNING!!!
151 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.
154 Config.put(:connections_pool, Keyword.put_new(pool_config, :connect_timeout, timeout))
157 pools_configs = Config.get(:pools)
159 warning_preface = """
160 !!!DEPRECATION WARNING!!!
161 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.
165 Enum.reduce(pools_configs, [], fn {pool_name, config}, acc ->
166 if timeout = config[:timeout] do
167 Keyword.put(acc, pool_name, Keyword.put_new(config, :recv_timeout, timeout))
173 if updated_config != [] do
177 |> Enum.map(fn pool_name ->
178 "\n* `:timeout` options in #{pool_name} pool is now `:recv_timeout`"
181 Logger.warn(Enum.join([warning_preface | pool_warnings]))
183 Config.put(:pools, updated_config)
190 @spec check_activity_expiration_config() :: :ok | nil
191 def check_activity_expiration_config do
192 warning_preface = """
193 !!!DEPRECATION WARNING!!!
194 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:
197 move_namespace_and_warn(
199 {Pleroma.ActivityExpiration, Pleroma.Workers.PurgeExpiredActivity,
200 "\n* `config :pleroma, Pleroma.ActivityExpiration` is now `config :pleroma, Pleroma.Workers.PurgeExpiredActivity`"}