akkoma/lib/mix/tasks/pleroma/config.ex

389 lines
9.4 KiB
Elixir
Raw Normal View History

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