2019-07-10 07:13:23 +02:00
|
|
|
# Pleroma: A lightweight social networking server
|
2020-03-02 06:08:45 +01:00
|
|
|
# Copyright © 2017-2020 Pleroma Authors <https://pleroma.social/>
|
2019-07-10 07:13:23 +02:00
|
|
|
# SPDX-License-Identifier: AGPL-3.0-only
|
|
|
|
|
2019-06-14 17:45:05 +02:00
|
|
|
defmodule Mix.Tasks.Pleroma.Config do
|
|
|
|
use Mix.Task
|
2020-01-17 09:45:44 +01:00
|
|
|
|
2019-06-20 01:05:19 +02:00
|
|
|
import Mix.Pleroma
|
2020-01-17 09:45:44 +01:00
|
|
|
|
2020-01-16 06:50:27 +01:00
|
|
|
alias Pleroma.ConfigDB
|
2019-06-14 17:45:05 +02:00
|
|
|
alias Pleroma.Repo
|
2020-01-17 09:45:44 +01:00
|
|
|
|
2019-06-14 17:45:05 +02:00
|
|
|
@shortdoc "Manages the location of the config"
|
2019-10-03 13:12:57 +02:00
|
|
|
@moduledoc File.read!("docs/administration/CLI_tasks/config.md")
|
2019-09-29 10:17:38 +02:00
|
|
|
|
2019-06-14 17:45:05 +02:00
|
|
|
def run(["migrate_to_db"]) do
|
2020-12-02 19:33:34 +01:00
|
|
|
check_configdb(fn ->
|
|
|
|
start_pleroma()
|
|
|
|
migrate_to_db()
|
|
|
|
end)
|
2019-06-14 17:45:05 +02:00
|
|
|
end
|
|
|
|
|
2019-09-29 10:17:38 +02:00
|
|
|
def run(["migrate_from_db" | options]) do
|
2020-12-02 19:33:34 +01:00
|
|
|
check_configdb(fn ->
|
|
|
|
start_pleroma()
|
2019-06-14 17:45:05 +02:00
|
|
|
|
2020-12-02 19:33:34 +01:00
|
|
|
{opts, _} =
|
|
|
|
OptionParser.parse!(options,
|
|
|
|
strict: [env: :string, delete: :boolean],
|
|
|
|
aliases: [d: :delete]
|
|
|
|
)
|
2019-06-14 17:45:05 +02:00
|
|
|
|
2020-12-02 19:33:34 +01:00
|
|
|
migrate_from_db(opts)
|
|
|
|
end)
|
2020-01-18 14:55:33 +01:00
|
|
|
end
|
|
|
|
|
2020-11-25 19:44:06 +01:00
|
|
|
def run(["dump"]) do
|
2020-12-02 19:33:34 +01:00
|
|
|
check_configdb(fn ->
|
|
|
|
start_pleroma()
|
2020-11-25 19:44:06 +01:00
|
|
|
|
2020-12-02 19:33:34 +01:00
|
|
|
header = config_header()
|
2020-11-25 19:44:06 +01:00
|
|
|
|
2020-12-02 19:33:34 +01:00
|
|
|
settings =
|
|
|
|
ConfigDB
|
|
|
|
|> Repo.all()
|
|
|
|
|> Enum.sort()
|
2020-11-25 19:44:06 +01:00
|
|
|
|
2020-12-02 19:33:34 +01:00
|
|
|
unless settings == [] do
|
|
|
|
shell_info("#{header}")
|
2020-11-27 21:44:05 +01:00
|
|
|
|
2020-12-02 19:33:34 +01:00
|
|
|
settings |> Enum.each(&dump(&1))
|
|
|
|
else
|
|
|
|
shell_error("No settings in ConfigDB.")
|
|
|
|
end
|
|
|
|
end)
|
2020-11-25 19:44:06 +01:00
|
|
|
end
|
|
|
|
|
2020-11-27 20:55:43 +01:00
|
|
|
def run(["dump", group, key]) do
|
2020-12-02 19:33:34 +01:00
|
|
|
check_configdb(fn ->
|
|
|
|
start_pleroma()
|
2020-11-25 19:44:06 +01:00
|
|
|
|
2020-12-02 19:33:34 +01:00
|
|
|
group = maybe_atomize(group)
|
|
|
|
key = maybe_atomize(key)
|
2020-11-27 21:44:05 +01:00
|
|
|
|
2020-12-02 19:33:34 +01:00
|
|
|
dump_key(group, key)
|
|
|
|
end)
|
2020-11-27 20:55:43 +01:00
|
|
|
end
|
|
|
|
|
|
|
|
def run(["dump", group]) do
|
2020-12-02 19:33:34 +01:00
|
|
|
check_configdb(fn ->
|
|
|
|
start_pleroma()
|
2020-11-27 20:55:43 +01:00
|
|
|
|
2020-12-02 19:33:34 +01:00
|
|
|
group = maybe_atomize(group)
|
2020-11-27 21:44:05 +01:00
|
|
|
|
2020-12-02 19:33:34 +01:00
|
|
|
dump_group(group)
|
|
|
|
end)
|
2020-11-25 19:44:06 +01:00
|
|
|
end
|
|
|
|
|
2020-11-26 00:49:36 +01:00
|
|
|
def run(["groups"]) do
|
2020-12-02 19:33:34 +01:00
|
|
|
check_configdb(fn ->
|
|
|
|
start_pleroma()
|
2020-11-29 20:29:36 +01:00
|
|
|
|
2020-12-02 19:33:34 +01:00
|
|
|
groups =
|
|
|
|
ConfigDB
|
|
|
|
|> Repo.all()
|
|
|
|
|> Enum.map(fn x -> x.group end)
|
|
|
|
|> Enum.sort()
|
|
|
|
|> Enum.uniq()
|
|
|
|
|
|
|
|
if length(groups) > 0 do
|
|
|
|
shell_info("The following configuration groups are set in ConfigDB:\r\n")
|
|
|
|
groups |> Enum.each(fn x -> shell_info("- #{x}") end)
|
|
|
|
shell_info("\r\n")
|
|
|
|
end
|
|
|
|
end)
|
2020-11-27 19:33:55 +01:00
|
|
|
end
|
|
|
|
|
2020-11-26 00:31:44 +01:00
|
|
|
def run(["reset"]) do
|
2020-12-02 19:33:34 +01:00
|
|
|
check_configdb(fn ->
|
|
|
|
start_pleroma()
|
2020-11-26 00:31:44 +01:00
|
|
|
|
2020-12-02 19:33:34 +01:00
|
|
|
shell_info("The following settings will be permanently removed:")
|
2020-11-27 23:32:46 +01:00
|
|
|
|
2020-12-02 19:33:34 +01:00
|
|
|
ConfigDB
|
|
|
|
|> Repo.all()
|
|
|
|
|> Enum.sort()
|
|
|
|
|> Enum.each(&dump(&1))
|
2020-11-27 23:32:46 +01:00
|
|
|
|
2020-12-02 19:33:34 +01:00
|
|
|
shell_error("\nTHIS CANNOT BE UNDONE!")
|
2020-11-27 23:32:46 +01:00
|
|
|
|
2020-12-02 19:33:34 +01:00
|
|
|
if shell_prompt("Are you sure you want to continue?", "n") in ~w(Yn Y y) do
|
|
|
|
Ecto.Adapters.SQL.query!(Repo, "TRUNCATE config;")
|
|
|
|
Ecto.Adapters.SQL.query!(Repo, "ALTER SEQUENCE config_id_seq RESTART;")
|
2020-11-26 00:31:44 +01:00
|
|
|
|
2020-12-02 19:33:34 +01:00
|
|
|
shell_info("The ConfigDB settings have been removed from the database.")
|
|
|
|
else
|
|
|
|
shell_error("No changes made.")
|
|
|
|
end
|
|
|
|
end)
|
2020-11-26 00:31:44 +01:00
|
|
|
end
|
|
|
|
|
2020-11-27 21:02:45 +01:00
|
|
|
def run(["delete", group]) do
|
2020-12-02 19:33:34 +01:00
|
|
|
check_configdb(fn ->
|
|
|
|
start_pleroma()
|
2020-11-27 21:44:05 +01:00
|
|
|
|
2020-12-02 19:33:34 +01:00
|
|
|
group = maybe_atomize(group)
|
2020-11-27 21:02:45 +01:00
|
|
|
|
2020-12-02 19:33:34 +01:00
|
|
|
if group_exists?(group) do
|
|
|
|
shell_info("The following settings will be removed from ConfigDB:\n")
|
2020-11-27 21:02:45 +01:00
|
|
|
|
2020-12-02 19:33:34 +01:00
|
|
|
dump_group(group)
|
|
|
|
|
|
|
|
if shell_prompt("Are you sure you want to continue?", "n") in ~w(Yn Y y) do
|
|
|
|
ConfigDB
|
|
|
|
|> Repo.all()
|
|
|
|
|> Enum.filter(fn x ->
|
|
|
|
if x.group == group do
|
|
|
|
x |> delete(true)
|
|
|
|
end
|
|
|
|
end)
|
|
|
|
else
|
|
|
|
shell_error("No changes made.")
|
|
|
|
end
|
|
|
|
else
|
|
|
|
shell_error("No settings in ConfigDB for #{inspect(group)}. Aborting.")
|
|
|
|
end
|
|
|
|
end)
|
|
|
|
end
|
|
|
|
|
|
|
|
def run(["delete", group, key]) do
|
|
|
|
check_configdb(fn ->
|
|
|
|
start_pleroma()
|
|
|
|
|
|
|
|
group = maybe_atomize(group)
|
|
|
|
key = maybe_atomize(key)
|
2020-11-25 19:44:06 +01:00
|
|
|
|
2020-11-27 20:55:43 +01:00
|
|
|
if shell_prompt("Are you sure you want to continue?", "n") in ~w(Yn Y y) do
|
2020-11-25 19:44:06 +01:00
|
|
|
ConfigDB
|
|
|
|
|> Repo.all()
|
|
|
|
|> Enum.filter(fn x ->
|
2020-12-02 19:33:34 +01:00
|
|
|
if x.group == group and x.key == key do
|
2020-11-25 19:44:06 +01:00
|
|
|
x |> delete(true)
|
|
|
|
end
|
|
|
|
end)
|
|
|
|
else
|
2020-11-27 21:44:05 +01:00
|
|
|
shell_error("No changes made.")
|
2020-11-25 19:44:06 +01:00
|
|
|
end
|
2020-12-02 19:33:34 +01:00
|
|
|
end)
|
2020-11-25 19:44:06 +01:00
|
|
|
end
|
|
|
|
|
2020-01-17 09:45:44 +01:00
|
|
|
@spec migrate_to_db(Path.t() | nil) :: any()
|
|
|
|
def migrate_to_db(file_path \\ nil) do
|
2020-11-29 20:29:36 +01:00
|
|
|
with :ok <- Pleroma.Config.DeprecationWarnings.warn() do
|
2020-01-21 15:49:22 +01:00
|
|
|
config_file =
|
|
|
|
if file_path do
|
|
|
|
file_path
|
|
|
|
else
|
|
|
|
if Pleroma.Config.get(:release) do
|
|
|
|
Pleroma.Config.get(:config_path)
|
|
|
|
else
|
|
|
|
"config/#{Pleroma.Config.get(:env)}.secret.exs"
|
|
|
|
end
|
|
|
|
end
|
2020-01-18 14:55:33 +01:00
|
|
|
|
2020-01-17 09:45:44 +01:00
|
|
|
do_migrate_to_db(config_file)
|
|
|
|
else
|
2020-12-02 20:00:07 +01:00
|
|
|
_ ->
|
|
|
|
shell_error("Migration is not allowed until all deprecation warnings have been resolved.")
|
2020-01-17 09:45:44 +01:00
|
|
|
end
|
|
|
|
end
|
|
|
|
|
|
|
|
defp do_migrate_to_db(config_file) do
|
|
|
|
if File.exists?(config_file) do
|
2020-06-20 11:34:34 +02:00
|
|
|
shell_info("Migrating settings from file: #{Path.expand(config_file)}")
|
2020-01-23 15:23:02 +01:00
|
|
|
Ecto.Adapters.SQL.query!(Repo, "TRUNCATE config;")
|
2020-01-23 15:48:45 +01:00
|
|
|
Ecto.Adapters.SQL.query!(Repo, "ALTER SEQUENCE config_id_seq RESTART;")
|
2020-01-23 15:23:02 +01:00
|
|
|
|
2020-01-21 15:49:22 +01:00
|
|
|
custom_config =
|
|
|
|
config_file
|
|
|
|
|> read_file()
|
|
|
|
|> elem(0)
|
2020-01-17 09:45:44 +01:00
|
|
|
|
|
|
|
custom_config
|
|
|
|
|> Keyword.keys()
|
2020-01-21 15:49:22 +01:00
|
|
|
|> Enum.each(&create(&1, custom_config))
|
2020-01-17 09:45:44 +01:00
|
|
|
else
|
2020-01-18 14:55:33 +01:00
|
|
|
shell_info("To migrate settings, you must define custom settings in #{config_file}.")
|
2020-01-17 09:45:44 +01:00
|
|
|
end
|
|
|
|
end
|
|
|
|
|
|
|
|
defp create(group, settings) do
|
2020-01-21 15:49:22 +01:00
|
|
|
group
|
|
|
|
|> Pleroma.Config.Loader.filter_group(settings)
|
2019-09-29 10:17:38 +02:00
|
|
|
|> Enum.each(fn {key, value} ->
|
2020-05-31 09:46:02 +02:00
|
|
|
{:ok, _} = ConfigDB.update_or_create(%{group: group, key: key, value: value})
|
2019-09-29 10:17:38 +02:00
|
|
|
|
2020-01-18 14:55:33 +01:00
|
|
|
shell_info("Settings for key #{key} migrated.")
|
2019-09-29 10:17:38 +02:00
|
|
|
end)
|
|
|
|
|
2020-11-28 19:24:37 +01:00
|
|
|
shell_info("Settings for group #{inspect(group)} migrated.")
|
2019-09-29 10:17:38 +02:00
|
|
|
end
|
|
|
|
|
2020-01-21 15:49:22 +01:00
|
|
|
defp migrate_from_db(opts) do
|
2020-11-29 20:29:36 +01:00
|
|
|
env = opts[:env] || Pleroma.Config.get(:env)
|
2020-01-21 15:49:22 +01:00
|
|
|
|
2020-11-29 20:29:36 +01:00
|
|
|
config_path =
|
|
|
|
if Pleroma.Config.get(:release) do
|
|
|
|
:config_path
|
|
|
|
|> Pleroma.Config.get()
|
|
|
|
|> Path.dirname()
|
|
|
|
else
|
|
|
|
"config"
|
|
|
|
end
|
|
|
|
|> Path.join("#{env}.exported_from_db.secret.exs")
|
2020-01-21 15:49:22 +01:00
|
|
|
|
2020-11-29 20:29:36 +01:00
|
|
|
file = File.open!(config_path, [:write, :utf8])
|
2020-01-21 15:49:22 +01:00
|
|
|
|
2020-11-29 20:29:36 +01:00
|
|
|
IO.write(file, config_header())
|
2019-09-29 10:17:38 +02:00
|
|
|
|
2020-11-29 20:29:36 +01:00
|
|
|
ConfigDB
|
|
|
|
|> Repo.all()
|
|
|
|
|> Enum.each(&write_and_delete(&1, file, opts[:delete]))
|
2020-07-13 17:32:17 +02:00
|
|
|
|
2020-11-29 20:29:36 +01:00
|
|
|
:ok = File.close(file)
|
|
|
|
System.cmd("mix", ["format", config_path])
|
2020-01-21 15:49:22 +01:00
|
|
|
|
2020-11-29 20:29:36 +01:00
|
|
|
shell_info(
|
|
|
|
"Database configuration settings have been exported to config/#{env}.exported_from_db.secret.exs"
|
2020-01-21 15:49:22 +01:00
|
|
|
)
|
|
|
|
end
|
|
|
|
|
|
|
|
if Code.ensure_loaded?(Config.Reader) do
|
|
|
|
defp config_header, do: "import Config\r\n\r\n"
|
|
|
|
defp read_file(config_file), do: Config.Reader.read_imports!(config_file)
|
|
|
|
else
|
|
|
|
defp config_header, do: "use Mix.Config\r\n\r\n"
|
|
|
|
defp read_file(config_file), do: Mix.Config.eval!(config_file)
|
|
|
|
end
|
|
|
|
|
|
|
|
defp write_and_delete(config, file, delete?) do
|
|
|
|
config
|
|
|
|
|> write(file)
|
|
|
|
|> delete(delete?)
|
|
|
|
end
|
|
|
|
|
|
|
|
defp write(config, file) do
|
2020-05-31 09:46:02 +02:00
|
|
|
value = inspect(config.value, limit: :infinity)
|
2020-01-21 15:49:22 +01:00
|
|
|
|
2020-05-31 09:46:02 +02:00
|
|
|
IO.write(file, "config #{inspect(config.group)}, #{inspect(config.key)}, #{value}\r\n\r\n")
|
2020-01-21 15:49:22 +01:00
|
|
|
|
|
|
|
config
|
|
|
|
end
|
|
|
|
|
|
|
|
defp delete(config, true) do
|
|
|
|
{:ok, _} = Repo.delete(config)
|
2020-11-27 21:44:05 +01:00
|
|
|
|
|
|
|
shell_info(
|
|
|
|
"config #{inspect(config.group)}, #{inspect(config.key)} deleted from the ConfigDB."
|
|
|
|
)
|
2020-01-21 15:49:22 +01:00
|
|
|
end
|
|
|
|
|
|
|
|
defp delete(_config, _), do: :ok
|
2020-11-25 19:44:06 +01:00
|
|
|
|
|
|
|
defp dump(%Pleroma.ConfigDB{} = config) do
|
|
|
|
value = inspect(config.value, limit: :infinity)
|
|
|
|
|
|
|
|
shell_info("config #{inspect(config.group)}, #{inspect(config.key)}, #{value}\r\n\r\n")
|
|
|
|
end
|
|
|
|
|
2020-11-27 23:32:32 +01:00
|
|
|
defp dump_key(group, key) when is_atom(group) and is_atom(key) do
|
2020-11-27 19:33:55 +01:00
|
|
|
ConfigDB
|
|
|
|
|> Repo.all()
|
|
|
|
|> Enum.filter(fn x ->
|
|
|
|
if x.group == group && x.key == key do
|
|
|
|
x |> dump
|
|
|
|
end
|
|
|
|
end)
|
|
|
|
end
|
|
|
|
|
2020-11-27 21:44:05 +01:00
|
|
|
defp dump_group(group) when is_atom(group) do
|
2020-11-27 19:33:55 +01:00
|
|
|
ConfigDB
|
|
|
|
|> Repo.all()
|
|
|
|
|> Enum.filter(fn x ->
|
|
|
|
if x.group == group do
|
|
|
|
x |> dump
|
|
|
|
end
|
|
|
|
end)
|
|
|
|
end
|
2020-11-27 21:44:05 +01:00
|
|
|
|
|
|
|
defp group_exists?(group) when is_atom(group) do
|
|
|
|
result =
|
|
|
|
ConfigDB
|
|
|
|
|> Repo.all()
|
|
|
|
|> Enum.filter(fn x ->
|
|
|
|
if x.group == group do
|
|
|
|
x
|
|
|
|
end
|
|
|
|
end)
|
|
|
|
|
|
|
|
unless result == [] do
|
|
|
|
true
|
|
|
|
else
|
|
|
|
false
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
2020-11-29 19:59:03 +01:00
|
|
|
defp maybe_atomize(arg) when is_atom(arg), do: arg
|
2020-11-27 23:20:28 +01:00
|
|
|
|
2020-11-29 19:59:03 +01:00
|
|
|
defp maybe_atomize(arg) when is_binary(arg) do
|
2020-11-27 23:20:28 +01:00
|
|
|
chars = String.codepoints(arg)
|
|
|
|
|
|
|
|
if "." in chars do
|
|
|
|
:"Elixir.#{arg}"
|
|
|
|
else
|
|
|
|
String.to_atom(arg)
|
|
|
|
end
|
|
|
|
end
|
2020-11-29 20:29:36 +01:00
|
|
|
|
2020-12-02 19:33:34 +01:00
|
|
|
defp check_configdb(callback) do
|
2020-11-29 20:29:36 +01:00
|
|
|
with true <- Pleroma.Config.get([:configurable_from_database]) do
|
2020-12-02 19:33:34 +01:00
|
|
|
callback.()
|
2020-11-29 20:29:36 +01:00
|
|
|
else
|
2020-12-02 20:00:07 +01:00
|
|
|
_ ->
|
|
|
|
shell_error(
|
|
|
|
"ConfigDB not enabled. Please check the value of :configurable_from_database in your configuration."
|
|
|
|
)
|
2020-11-29 20:29:36 +01:00
|
|
|
end
|
|
|
|
end
|
2019-06-14 17:45:05 +02:00
|
|
|
end
|