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.TransferTask do
14 @type env() :: :test | :benchmark | :dev | :prod
17 {:pleroma, :hackney_pools},
20 {:pleroma, :rate_limit},
22 {:pleroma, :streamer},
24 {:pleroma, :connections_pool}
27 @reboot_time_subkeys [
28 {:pleroma, Pleroma.Captcha, [:seconds_valid]},
29 {:pleroma, Pleroma.Upload, [:proxy_remote]},
30 {:pleroma, :instance, [:upload_limit]},
31 {:pleroma, :email_notifications, [:digest]},
32 {:pleroma, :oauth2, [:clean_expired_tokens]},
33 {:pleroma, Pleroma.ActivityExpiration, [:enabled]},
34 {:pleroma, Pleroma.ScheduledActivity, [:enabled]},
35 {:pleroma, :gopher, [:enabled]}
40 if Config.get(:env) == :test, do: Ecto.Adapters.SQL.Sandbox.checkin(Repo)
44 @spec load_and_update_env([ConfigDB.t()], boolean()) :: :ok
45 def load_and_update_env(deleted_settings \\ [], restart_pleroma? \\ true) do
46 with {_, true} <- {:configurable, Config.get(:configurable_from_database)} do
47 # We need to restart applications for loaded settings take effect
50 (Repo.all(ConfigDB) ++ deleted_settings)
51 |> Enum.map(&transform_and_merge/1)
52 |> Enum.split_with(fn {group, _, _, _} -> group in [:logger, :quack] end)
56 |> Enum.each(&configure/1)
58 started_applications = Application.started_applications()
60 # TODO: some problem with prometheus after restart!
61 reject = [nil, :prometheus, :postgrex]
64 if restart_pleroma? do
71 |> Enum.map(&update/1)
73 |> Enum.reject(&(&1 in reject))
74 |> maybe_set_pleroma_last()
75 |> Enum.each(&restart(started_applications, &1, Config.get(:env)))
79 {:configurable, false} -> Restarter.Pleroma.rebooted()
83 defp maybe_set_pleroma_last(apps) do
84 # to be ensured that pleroma will be restarted last
85 if :pleroma in apps do
87 |> List.delete(:pleroma)
88 |> List.insert_at(-1, :pleroma)
90 Restarter.Pleroma.rebooted()
95 defp transform_and_merge(%{group: group, key: key, value: value} = setting) do
96 group = ConfigDB.from_string(group)
97 key = ConfigDB.from_string(key)
98 value = ConfigDB.from_binary(value)
100 default = Config.Holder.default_config(group, key)
104 Ecto.get_meta(setting, :state) == :deleted -> default
105 can_be_merged?(default, value) -> ConfigDB.merge_group(group, key, default, value)
109 {group, key, value, merged}
112 # change logger configuration in runtime, without restart
113 defp configure({:quack, key, _, merged}) do
114 Logger.configure_backend(Quack.Logger, [{key, merged}])
115 :ok = update_env(:quack, key, merged)
118 defp configure({_, :backends, _, merged}) do
119 # removing current backends
120 Enum.each(Application.get_env(:logger, :backends), &Logger.remove_backend/1)
122 Enum.each(merged, &Logger.add_backend/1)
124 :ok = update_env(:logger, :backends, merged)
127 defp configure({_, key, _, merged}) when key in [:console, :ex_syslogger] do
129 if key == :console do
130 put_in(merged[:format], merged[:format] <> "\n")
136 if key == :ex_syslogger,
137 do: {ExSyslogger, :ex_syslogger},
140 Logger.configure_backend(backend, merged)
141 :ok = update_env(:logger, key, merged)
144 defp configure({_, key, _, merged}) do
145 Logger.configure([{key, merged}])
146 :ok = update_env(:logger, key, merged)
149 defp update({group, key, value, merged}) do
151 :ok = update_env(group, key, merged)
153 if group != :pleroma or pleroma_need_restart?(group, key, value), do: group
157 "updating env causes error, group: #{inspect(group)}, key: #{inspect(key)}, value: #{
159 } error: #{inspect(error)}"
161 Logger.warn(error_msg)
167 defp update_env(group, key, nil), do: Application.delete_env(group, key)
168 defp update_env(group, key, value), do: Application.put_env(group, key, value)
170 @spec pleroma_need_restart?(atom(), atom(), any()) :: boolean()
171 def pleroma_need_restart?(group, key, value) do
172 group_and_key_need_reboot?(group, key) or group_and_subkey_need_reboot?(group, key, value)
175 defp group_and_key_need_reboot?(group, key) do
176 Enum.any?(@reboot_time_keys, fn {g, k} -> g == group and k == key end)
179 defp group_and_subkey_need_reboot?(group, key, value) do
180 Keyword.keyword?(value) and
181 Enum.any?(@reboot_time_subkeys, fn {g, k, subkeys} ->
182 g == group and k == key and
183 Enum.any?(Keyword.keys(value), &(&1 in subkeys))
187 defp restart(_, :pleroma, env), do: Restarter.Pleroma.restart_after_boot(env)
189 defp restart(started_applications, app, _) do
190 with {^app, _, _} <- List.keyfind(started_applications, app, 0),
191 :ok <- Application.stop(app) do
192 :ok = Application.start(app)
195 Logger.warn("#{app} is not started.")
204 defp can_be_merged?(val1, val2) when is_list(val1) and is_list(val2) do
205 Keyword.keyword?(val1) and Keyword.keyword?(val2)
208 defp can_be_merged?(_val1, _val2), do: false