1 # Pleroma: A lightweight social networking server
2 # Copyright © 2017-2021 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.
37 with :ok <- check_hellthread_threshold(),
38 :ok <- check_old_mrf_config(),
39 :ok <- check_media_proxy_whitelist_config(),
40 :ok <- check_welcome_message_config(),
41 :ok <- check_gun_pool_options(),
42 :ok <- check_activity_expiration_config(),
43 :ok <- check_remote_ip_plug_name(),
44 :ok <- check_uploders_s3_public_endpoint() do
52 def check_welcome_message_config do
53 instance_config = Pleroma.Config.get([:instance])
56 Keyword.has_key?(instance_config, :welcome_user_nickname) or
57 Keyword.has_key?(instance_config, :welcome_message)
61 !!!DEPRECATION WARNING!!!
62 Your config is using the old namespace for Welcome messages configuration. You need to convert to the new namespace. e.g.,
63 \n* `config :pleroma, :instance, welcome_user_nickname` and `config :pleroma, :instance, welcome_message` are now equal to:
64 \n* `config :pleroma, :welcome, direct_message: [enabled: true, sender_nickname: "NICKNAME", message: "Your welcome message"]`"
73 def check_old_mrf_config do
75 !!!DEPRECATION WARNING!!!
76 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:
79 move_namespace_and_warn(@mrf_config_map, warning_preface)
82 @spec move_namespace_and_warn([config_map()], String.t()) :: :ok | nil
83 def move_namespace_and_warn(config_map, warning_preface) do
85 Enum.reduce(config_map, "", fn
86 {old, new, err_msg}, acc ->
87 old_config = Config.get(old)
90 Config.put(new, old_config)
100 Logger.warn(warning_preface <> warning)
105 @spec check_media_proxy_whitelist_config() :: :ok | nil
106 def check_media_proxy_whitelist_config do
107 whitelist = Config.get([:media_proxy, :whitelist])
109 if Enum.any?(whitelist, &(not String.starts_with?(&1, "http"))) do
111 !!!DEPRECATION WARNING!!!
112 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 `config :pleroma, :connections_pool, await_up_timeout`. Please change to `config :pleroma, :connections_pool, connect_timeout` to ensure compatibility with future releases.
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)
166 @spec check_activity_expiration_config() :: :ok | nil
167 def check_activity_expiration_config do
168 warning_preface = """
169 !!!DEPRECATION WARNING!!!
170 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:
173 move_namespace_and_warn(
175 {Pleroma.ActivityExpiration, Pleroma.Workers.PurgeExpiredActivity,
176 "\n* `config :pleroma, Pleroma.ActivityExpiration` is now `config :pleroma, Pleroma.Workers.PurgeExpiredActivity`"}
182 @spec check_remote_ip_plug_name() :: :ok | nil
183 def check_remote_ip_plug_name do
184 warning_preface = """
185 !!!DEPRECATION WARNING!!!
186 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:
189 move_namespace_and_warn(
191 {Pleroma.Plugs.RemoteIp, Pleroma.Web.Plugs.RemoteIp,
192 "\n* `config :pleroma, Pleroma.Plugs.RemoteIp` is now `config :pleroma, Pleroma.Web.Plugs.RemoteIp`"}
198 @spec check_uploders_s3_public_endpoint() :: :ok | nil
199 def check_uploders_s3_public_endpoint do
200 s3_config = Pleroma.Config.get([Pleroma.Uploaders.S3])
202 use_old_config = Keyword.has_key?(s3_config, :public_endpoint)
206 !!!DEPRECATION WARNING!!!
207 Your config is using the old setting for controlling the URL of media uploaded to your S3 bucket.\n
208 Please make the following change at your earliest convenience.\n
209 \n* `config :pleroma, Pleroma.Uploaders.S3, public_endpoint` is now equal to:
210 \n* `config :pleroma, Pleroma.Upload, base_url`