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_simple_policy_tuples do
25 Config.get([:mrf_simple])
26 |> Enum.any?(fn {_, v} -> Enum.any?(v, &is_binary/1) end)
30 !!!DEPRECATION WARNING!!!
31 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:
34 config :pleroma, :mrf_simple,
35 media_removal: ["instance.tld"],
36 media_nsfw: ["instance.tld"],
37 federated_timeline_removal: ["instance.tld"],
38 report_removal: ["instance.tld"],
39 reject: ["instance.tld"],
40 followers_only: ["instance.tld"],
41 accept: ["instance.tld"],
42 avatar_removal: ["instance.tld"],
43 banner_removal: ["instance.tld"],
44 reject_deletes: ["instance.tld"]
51 config :pleroma, :mrf_simple,
52 media_removal: [{"instance.tld", "Reason for media removal"}],
53 media_nsfw: [{"instance.tld", "Reason for media nsfw"}],
54 federated_timeline_removal: [{"instance.tld", "Reason for federated timeline removal"}],
55 report_removal: [{"instance.tld", "Reason for report removal"}],
56 reject: [{"instance.tld", "Reason for reject"}],
57 followers_only: [{"instance.tld", "Reason for followers only"}],
58 accept: [{"instance.tld", "Reason for accept"}],
59 avatar_removal: [{"instance.tld", "Reason for avatar removal"}],
60 banner_removal: [{"instance.tld", "Reason for banner removal"}],
61 reject_deletes: [{"instance.tld", "Reason for reject deletes"}]
66 Config.get([:mrf_simple])
67 |> Enum.map(fn {k, v} ->
70 {instance, reason} -> {instance, reason}
71 instance -> {instance, ""}
75 Config.put([:mrf_simple], new_config)
83 def check_quarantined_instances_tuples do
84 has_strings = Config.get([:instance, :quarantined_instances]) |> Enum.any?(&is_binary/1)
88 !!!DEPRECATION WARNING!!!
89 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:
92 config :pleroma, :instance,
93 quarantined_instances: ["instance.tld"]
100 config :pleroma, :instance,
101 quarantined_instances: [{"instance.tld", "Reason for quarantine"}]
106 Config.get([:instance, :quarantined_instances])
108 {instance, reason} -> {instance, reason}
109 instance -> {instance, ""}
112 Config.put([:instance, :quarantined_instances], new_config)
120 def check_transparency_exclusions_tuples do
121 has_strings = Config.get([:mrf, :transparency_exclusions]) |> Enum.any?(&is_binary/1)
125 !!!DEPRECATION WARNING!!!
126 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:
129 config :pleroma, :mrf,
130 transparency_exclusions: ["instance.tld"]
137 config :pleroma, :mrf,
138 transparency_exclusions: [{"instance.tld", "Reason to exlude transparency"}]
143 Config.get([:mrf, :transparency_exclusions])
145 {instance, reason} -> {instance, reason}
146 instance -> {instance, ""}
149 Config.put([:mrf, :transparency_exclusions], new_config)
157 def check_hellthread_threshold do
158 if Config.get([:mrf_hellthread, :threshold]) do
160 !!!DEPRECATION WARNING!!!
161 You are using the old configuration mechanism for the hellthread filter. Please check config.md.
172 check_hellthread_threshold(),
173 check_old_mrf_config(),
174 check_media_proxy_whitelist_config(),
175 check_welcome_message_config(),
176 check_gun_pool_options(),
177 check_activity_expiration_config(),
178 check_remote_ip_plug_name(),
179 check_uploders_s3_public_endpoint(),
180 check_old_chat_shoutbox(),
181 check_quarantined_instances_tuples(),
182 check_transparency_exclusions_tuples(),
183 check_simple_policy_tuples()
185 |> Enum.reduce(:ok, fn
191 def check_welcome_message_config do
192 instance_config = Pleroma.Config.get([:instance])
195 Keyword.has_key?(instance_config, :welcome_user_nickname) or
196 Keyword.has_key?(instance_config, :welcome_message)
200 !!!DEPRECATION WARNING!!!
201 Your config is using the old namespace for Welcome messages configuration. You need to convert to the new namespace. e.g.,
202 \n* `config :pleroma, :instance, welcome_user_nickname` and `config :pleroma, :instance, welcome_message` are now equal to:
203 \n* `config :pleroma, :welcome, direct_message: [enabled: true, sender_nickname: "NICKNAME", message: "Your welcome message"]`"
212 def check_old_mrf_config do
213 warning_preface = """
214 !!!DEPRECATION WARNING!!!
215 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:
218 move_namespace_and_warn(@mrf_config_map, warning_preface)
221 @spec move_namespace_and_warn([config_map()], String.t()) :: :ok | nil
222 def move_namespace_and_warn(config_map, warning_preface) do
224 Enum.reduce(config_map, "", fn
225 {old, new, err_msg}, acc ->
226 old_config = Config.get(old)
229 Config.put(new, old_config)
239 Logger.warn(warning_preface <> warning)
244 @spec check_media_proxy_whitelist_config() :: :ok | nil
245 def check_media_proxy_whitelist_config do
246 whitelist = Config.get([:media_proxy, :whitelist])
248 if Enum.any?(whitelist, &(not String.starts_with?(&1, "http"))) do
250 !!!DEPRECATION WARNING!!!
251 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.
260 def check_gun_pool_options do
261 pool_config = Config.get(:connections_pool)
263 if timeout = pool_config[:await_up_timeout] do
265 !!!DEPRECATION WARNING!!!
266 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.
269 Config.put(:connections_pool, Keyword.put_new(pool_config, :connect_timeout, timeout))
272 pools_configs = Config.get(:pools)
274 warning_preface = """
275 !!!DEPRECATION WARNING!!!
276 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.
280 Enum.reduce(pools_configs, [], fn {pool_name, config}, acc ->
281 if timeout = config[:timeout] do
282 Keyword.put(acc, pool_name, Keyword.put_new(config, :recv_timeout, timeout))
288 if updated_config != [] do
292 |> Enum.map(fn pool_name ->
293 "\n* `:timeout` options in #{pool_name} pool is now `:recv_timeout`"
296 Logger.warn(Enum.join([warning_preface | pool_warnings]))
298 Config.put(:pools, updated_config)
305 @spec check_activity_expiration_config() :: :ok | nil
306 def check_activity_expiration_config do
307 warning_preface = """
308 !!!DEPRECATION WARNING!!!
309 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:
312 move_namespace_and_warn(
314 {Pleroma.ActivityExpiration, Pleroma.Workers.PurgeExpiredActivity,
315 "\n* `config :pleroma, Pleroma.ActivityExpiration` is now `config :pleroma, Pleroma.Workers.PurgeExpiredActivity`"}
321 @spec check_remote_ip_plug_name() :: :ok | nil
322 def check_remote_ip_plug_name do
323 warning_preface = """
324 !!!DEPRECATION WARNING!!!
325 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:
328 move_namespace_and_warn(
330 {Pleroma.Plugs.RemoteIp, Pleroma.Web.Plugs.RemoteIp,
331 "\n* `config :pleroma, Pleroma.Plugs.RemoteIp` is now `config :pleroma, Pleroma.Web.Plugs.RemoteIp`"}
337 @spec check_uploders_s3_public_endpoint() :: :ok | nil
338 def check_uploders_s3_public_endpoint do
339 s3_config = Pleroma.Config.get([Pleroma.Uploaders.S3])
341 use_old_config = Keyword.has_key?(s3_config, :public_endpoint)
345 !!!DEPRECATION WARNING!!!
346 Your config is using the old setting for controlling the URL of media uploaded to your S3 bucket.\n
347 Please make the following change at your earliest convenience.\n
348 \n* `config :pleroma, Pleroma.Uploaders.S3, public_endpoint` is now equal to:
349 \n* `config :pleroma, Pleroma.Upload, base_url`
358 @spec check_old_chat_shoutbox() :: :ok | nil
359 def check_old_chat_shoutbox do
360 instance_config = Pleroma.Config.get([:instance])
361 chat_config = Pleroma.Config.get([:chat]) || []
364 Keyword.has_key?(instance_config, :chat_limit) or
365 Keyword.has_key?(chat_config, :enabled)
369 !!!DEPRECATION WARNING!!!
370 Your config is using the old namespace for the Shoutbox configuration. You need to convert to the new namespace. e.g.,
371 \n* `config :pleroma, :chat, enabled` and `config :pleroma, :instance, chat_limit` are now equal to:
372 \n* `config :pleroma, :shout, enabled` and `config :pleroma, :shout, limit`