9ec80eb69b87d85f44980bdf6916c65693faa14b
[akkoma] / lib / pleroma / config / transfer_task.ex
1 # Pleroma: A lightweight social networking server
2 # Copyright © 2017-2020 Pleroma Authors <https://pleroma.social/>
3 # SPDX-License-Identifier: AGPL-3.0-only
4
5 defmodule Pleroma.Config.TransferTask do
6 use Task
7
8 alias Pleroma.Config
9 alias Pleroma.ConfigDB
10 alias Pleroma.Repo
11
12 require Logger
13
14 @type env() :: :test | :benchmark | :dev | :prod
15
16 @reboot_time_keys [
17 {:pleroma, :hackney_pools},
18 {:pleroma, :chat},
19 {:pleroma, Oban},
20 {:pleroma, :rate_limit},
21 {:pleroma, :markup},
22 {:pleroma, :streamer},
23 {:pleroma, :pools},
24 {:pleroma, :connections_pool}
25 ]
26
27 @reboot_time_subkeys [
28 {:pleroma, Pleroma.Captcha, [:seconds_valid]},
29 {:pleroma, :instance, [:upload_limit]},
30 {:pleroma, :gopher, [:enabled]}
31 ]
32
33 def start_link(restart_pleroma? \\ true) do
34 load_and_update_env([], restart_pleroma?)
35 if Config.get(:env) == :test, do: Ecto.Adapters.SQL.Sandbox.checkin(Repo)
36 :ignore
37 end
38
39 @spec load_and_update_env([ConfigDB.t()], boolean()) :: :ok
40 def load_and_update_env(deleted_settings \\ [], restart_pleroma? \\ true) do
41 with {_, true} <- {:configurable, Config.get(:configurable_from_database)} do
42 # We need to restart applications for loaded settings take effect
43
44 {logger, other} =
45 (Repo.all(ConfigDB) ++ deleted_settings)
46 |> Enum.map(&merge_with_default/1)
47 |> Enum.split_with(fn {group, _, _, _} -> group in [:logger, :quack] end)
48
49 logger
50 |> Enum.sort()
51 |> Enum.each(&configure/1)
52
53 started_applications = Application.started_applications()
54
55 # TODO: some problem with prometheus after restart!
56 reject = [nil, :prometheus, :postgrex]
57
58 reject =
59 if restart_pleroma? do
60 reject
61 else
62 [:pleroma | reject]
63 end
64
65 other
66 |> Enum.map(&update/1)
67 |> Enum.uniq()
68 |> Enum.reject(&(&1 in reject))
69 |> maybe_set_pleroma_last()
70 |> Enum.each(&restart(started_applications, &1, Config.get(:env)))
71
72 :ok
73 else
74 {:configurable, false} -> Restarter.Pleroma.rebooted()
75 end
76 end
77
78 defp maybe_set_pleroma_last(apps) do
79 # to be ensured that pleroma will be restarted last
80 if :pleroma in apps do
81 apps
82 |> List.delete(:pleroma)
83 |> List.insert_at(-1, :pleroma)
84 else
85 Restarter.Pleroma.rebooted()
86 apps
87 end
88 end
89
90 defp merge_with_default(%{group: group, key: key, value: value} = setting) do
91 default = Config.Holder.default_config(group, key)
92
93 merged =
94 cond do
95 Ecto.get_meta(setting, :state) == :deleted -> default
96 can_be_merged?(default, value) -> ConfigDB.merge_group(group, key, default, value)
97 true -> value
98 end
99
100 {group, key, value, merged}
101 end
102
103 # change logger configuration in runtime, without restart
104 defp configure({:quack, key, _, merged}) do
105 Logger.configure_backend(Quack.Logger, [{key, merged}])
106 :ok = update_env(:quack, key, merged)
107 end
108
109 defp configure({_, :backends, _, merged}) do
110 # removing current backends
111 Enum.each(Application.get_env(:logger, :backends), &Logger.remove_backend/1)
112
113 Enum.each(merged, &Logger.add_backend/1)
114
115 :ok = update_env(:logger, :backends, merged)
116 end
117
118 defp configure({_, key, _, merged}) when key in [:console, :ex_syslogger] do
119 merged =
120 if key == :console do
121 put_in(merged[:format], merged[:format] <> "\n")
122 else
123 merged
124 end
125
126 backend =
127 if key == :ex_syslogger,
128 do: {ExSyslogger, :ex_syslogger},
129 else: key
130
131 Logger.configure_backend(backend, merged)
132 :ok = update_env(:logger, key, merged)
133 end
134
135 defp configure({_, key, _, merged}) do
136 Logger.configure([{key, merged}])
137 :ok = update_env(:logger, key, merged)
138 end
139
140 defp update({group, key, value, merged}) do
141 try do
142 :ok = update_env(group, key, merged)
143
144 if group != :pleroma or pleroma_need_restart?(group, key, value), do: group
145 rescue
146 error ->
147 error_msg =
148 "updating env causes error, group: #{inspect(group)}, key: #{inspect(key)}, value: #{
149 inspect(value)
150 } error: #{inspect(error)}"
151
152 Logger.warn(error_msg)
153
154 nil
155 end
156 end
157
158 defp update_env(group, key, nil), do: Application.delete_env(group, key)
159 defp update_env(group, key, value), do: Application.put_env(group, key, value)
160
161 @spec pleroma_need_restart?(atom(), atom(), any()) :: boolean()
162 def pleroma_need_restart?(group, key, value) do
163 group_and_key_need_reboot?(group, key) or group_and_subkey_need_reboot?(group, key, value)
164 end
165
166 defp group_and_key_need_reboot?(group, key) do
167 Enum.any?(@reboot_time_keys, fn {g, k} -> g == group and k == key end)
168 end
169
170 defp group_and_subkey_need_reboot?(group, key, value) do
171 Keyword.keyword?(value) and
172 Enum.any?(@reboot_time_subkeys, fn {g, k, subkeys} ->
173 g == group and k == key and
174 Enum.any?(Keyword.keys(value), &(&1 in subkeys))
175 end)
176 end
177
178 defp restart(_, :pleroma, env), do: Restarter.Pleroma.restart_after_boot(env)
179
180 defp restart(started_applications, app, _) do
181 with {^app, _, _} <- List.keyfind(started_applications, app, 0),
182 :ok <- Application.stop(app) do
183 :ok = Application.start(app)
184 else
185 nil ->
186 Logger.warn("#{app} is not started.")
187
188 error ->
189 error
190 |> inspect()
191 |> Logger.warn()
192 end
193 end
194
195 defp can_be_merged?(val1, val2) when is_list(val1) and is_list(val2) do
196 Keyword.keyword?(val1) and Keyword.keyword?(val2)
197 end
198
199 defp can_be_merged?(_val1, _val2), do: false
200 end