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 Mix.Tasks.Pleroma.Config do
10 alias Pleroma.ConfigDB
13 @shortdoc "Manages the location of the config"
14 @moduledoc File.read!("docs/administration/CLI_tasks/config.md")
16 def run(["migrate_to_db"]) do
23 def run(["migrate_from_db" | options]) do
28 OptionParser.parse!(options,
29 strict: [env: :string, delete: :boolean],
41 header = config_header()
48 unless settings == [] do
49 shell_info("#{header}")
51 settings |> Enum.each(&dump(&1))
53 shell_error("No settings in ConfigDB.")
58 def run(["dump", group, key]) do
62 group = maybe_atomize(group)
63 key = maybe_atomize(key)
66 |> ConfigDB.get_all_by_group_and_key(key)
71 def run(["dump", group]) do
75 group = maybe_atomize(group)
81 def run(["groups"]) do
88 |> Enum.map(fn x -> x.group end)
92 if length(groups) > 0 do
93 shell_info("The following configuration groups are set in ConfigDB:\r\n")
94 groups |> Enum.each(fn x -> shell_info("- #{x}") end)
100 def run(["reset", "--force"]) do
104 shell_info("The ConfigDB settings have been removed from the database.")
108 def run(["reset"]) do
112 shell_info("The following settings will be permanently removed:")
117 |> Enum.each(&dump(&1))
119 shell_error("\nTHIS CANNOT BE UNDONE!")
121 if shell_prompt("Are you sure you want to continue?", "n") in ~w(Yn Y y) do
124 shell_info("The ConfigDB settings have been removed from the database.")
126 shell_error("No changes made.")
131 def run(["delete", "--force", group, key]) do
134 group = maybe_atomize(group)
135 key = maybe_atomize(key)
137 delete_key(group, key)
140 def run(["delete", "--force", group]) do
143 group = maybe_atomize(group)
148 def run(["delete", group, key]) do
151 group = maybe_atomize(group)
152 key = maybe_atomize(key)
154 if shell_prompt("Are you sure you want to continue?", "n") in ~w(Yn Y y) do
155 delete_key(group, key)
157 shell_error("No changes made.")
161 def run(["delete", group]) do
164 group = maybe_atomize(group)
166 if shell_prompt("Are you sure you want to continue?", "n") in ~w(Yn Y y) do
169 shell_error("No changes made.")
173 @spec migrate_to_db(Path.t() | nil) :: any()
174 def migrate_to_db(file_path \\ nil) do
175 with :ok <- Pleroma.Config.DeprecationWarnings.warn() do
180 if Pleroma.Config.get(:release) do
181 Pleroma.Config.get(:config_path)
183 "config/#{Pleroma.Config.get(:env)}.secret.exs"
187 do_migrate_to_db(config_file)
190 shell_error("Migration is not allowed until all deprecation warnings have been resolved.")
194 defp do_migrate_to_db(config_file) do
195 if File.exists?(config_file) do
196 shell_info("Migrating settings from file: #{Path.expand(config_file)}")
206 |> Enum.each(&create(&1, custom_config))
208 shell_info("To migrate settings, you must define custom settings in #{config_file}.")
212 defp create(group, settings) do
214 |> Pleroma.Config.Loader.filter_group(settings)
215 |> Enum.each(fn {key, value} ->
216 {:ok, _} = ConfigDB.update_or_create(%{group: group, key: key, value: value})
218 shell_info("Settings for key #{key} migrated.")
221 shell_info("Settings for group #{inspect(group)} migrated.")
224 defp migrate_from_db(opts) do
225 env = opts[:env] || Pleroma.Config.get(:env)
228 if Pleroma.Config.get(:release) do
230 |> Pleroma.Config.get()
235 |> Path.join("#{env}.exported_from_db.secret.exs")
237 file = File.open!(config_path, [:write, :utf8])
239 IO.write(file, config_header())
243 |> Enum.each(&write_and_delete(&1, file, opts[:delete]))
245 :ok = File.close(file)
246 System.cmd("mix", ["format", config_path])
249 "Database configuration settings have been exported to config/#{env}.exported_from_db.secret.exs"
253 if Code.ensure_loaded?(Config.Reader) do
254 defp config_header, do: "import Config\r\n\r\n"
255 defp read_file(config_file), do: Config.Reader.read_imports!(config_file)
257 defp config_header, do: "use Mix.Config\r\n\r\n"
258 defp read_file(config_file), do: Mix.Config.eval!(config_file)
261 defp write_and_delete(config, file, delete?) do
267 defp write(config, file) do
268 value = inspect(config.value, limit: :infinity)
270 IO.write(file, "config #{inspect(config.group)}, #{inspect(config.key)}, #{value}\r\n\r\n")
275 defp delete(config, true) do
276 {:ok, _} = Repo.delete(config)
279 "config #{inspect(config.group)}, #{inspect(config.key)} was deleted from the ConfigDB."
283 defp delete(_config, _), do: :ok
285 defp dump(%Pleroma.ConfigDB{} = config) do
286 value = inspect(config.value, limit: :infinity)
288 shell_info("config #{inspect(config.group)}, #{inspect(config.key)}, #{value}\r\n\r\n")
291 defp dump_group(group) when is_atom(group) do
293 |> ConfigDB.get_all_by_group()
294 |> Enum.each(&dump/1)
297 defp group_exists?(group) do
299 |> ConfigDB.get_all_by_group()
303 defp maybe_atomize(arg) when is_atom(arg), do: arg
305 defp maybe_atomize(arg) when is_binary(arg) do
306 if Pleroma.ConfigDB.module_name?(arg) do
307 String.to_existing_atom("Elixir." <> arg)
313 defp check_configdb(callback) do
314 with true <- Pleroma.Config.get([:configurable_from_database]) do
319 "ConfigDB not enabled. Please check the value of :configurable_from_database in your configuration."
324 defp delete_key(group, key) do
327 |> ConfigDB.get_all_by_group_and_key(key)
328 |> Enum.each(&delete(&1, true))
332 defp delete_group(group) do
334 with true <- group_exists?(group) do
335 shell_info("The following settings will be removed from ConfigDB:\n")
339 |> ConfigDB.get_all_by_group()
340 |> Enum.each(&delete(&1, true))
342 _ -> shell_error("No settings in ConfigDB for #{inspect(group)}. Aborting.")
348 Ecto.Adapters.SQL.query!(Repo, "TRUNCATE config;")
349 Ecto.Adapters.SQL.query!(Repo, "ALTER SEQUENCE config_id_seq RESTART;")