# Pleroma: A lightweight social networking server
-# Copyright © 2017-2020 Pleroma Authors <https://pleroma.social/>
+# Copyright © 2017-2021 Pleroma Authors <https://pleroma.social/>
# SPDX-License-Identifier: AGPL-3.0-only
defmodule Mix.Tasks.Pleroma.Config do
use Mix.Task
+ import Ecto.Query
import Mix.Pleroma
alias Pleroma.ConfigDB
@moduledoc File.read!("docs/administration/CLI_tasks/config.md")
def run(["migrate_to_db"]) do
- start_pleroma()
- migrate_to_db()
+ check_configdb(fn ->
+ start_pleroma()
+ migrate_to_db()
+ end)
end
def run(["migrate_from_db" | options]) do
- start_pleroma()
+ check_configdb(fn ->
+ start_pleroma()
- {opts, _} =
- OptionParser.parse!(options,
- strict: [env: :string, delete: :boolean],
- aliases: [d: :delete]
- )
+ {opts, _} =
+ OptionParser.parse!(options,
+ strict: [env: :string, delete: :boolean, path: :string],
+ aliases: [d: :delete]
+ )
- migrate_from_db(opts)
+ migrate_from_db(opts)
+ end)
end
def run(["dump"]) do
- with true <- Pleroma.Config.get([:configurable_from_database]) do
+ check_configdb(fn ->
start_pleroma()
header = config_header()
- shell_info("#{header}")
+ settings =
+ ConfigDB
+ |> Repo.all()
+ |> Enum.sort()
+
+ unless settings == [] do
+ shell_info("#{header}")
+
+ Enum.each(settings, &dump(&1))
+ else
+ shell_error("No settings in ConfigDB.")
+ end
+ end)
+ end
+
+ def run(["dump", group, key]) do
+ check_configdb(fn ->
+ start_pleroma()
+
+ group = maybe_atomize(group)
+ key = maybe_atomize(key)
+
+ group
+ |> ConfigDB.get_by_group_and_key(key)
+ |> dump()
+ end)
+ end
+
+ def run(["dump", group]) do
+ check_configdb(fn ->
+ start_pleroma()
+
+ group = maybe_atomize(group)
+
+ dump_group(group)
+ end)
+ end
+
+ def run(["groups"]) do
+ check_configdb(fn ->
+ start_pleroma()
+
+ groups =
+ ConfigDB
+ |> distinct([c], true)
+ |> select([c], c.group)
+ |> Repo.all()
+
+ 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)
+ end
+
+ def run(["reset", "--force"]) do
+ check_configdb(fn ->
+ start_pleroma()
+ truncatedb()
+ shell_info("The ConfigDB settings have been removed from the database.")
+ end)
+ end
+
+ def run(["reset"]) do
+ check_configdb(fn ->
+ start_pleroma()
+
+ shell_info("The following settings will be permanently removed:")
ConfigDB
|> Repo.all()
+ |> Enum.sort()
|> Enum.each(&dump(&1))
+
+ shell_error("\nTHIS CANNOT BE UNDONE!")
+
+ if shell_prompt("Are you sure you want to continue?", "n") in ~w(Yn Y y) do
+ truncatedb()
+
+ shell_info("The ConfigDB settings have been removed from the database.")
+ else
+ shell_error("No changes made.")
+ end
+ end)
+ end
+
+ def run(["delete", "--force", group, key]) do
+ start_pleroma()
+
+ group = maybe_atomize(group)
+ key = maybe_atomize(key)
+
+ with true <- key_exists?(group, key) do
+ shell_info("The following settings will be removed from ConfigDB:\n")
+
+ group
+ |> ConfigDB.get_by_group_and_key(key)
+ |> dump()
+
+ delete_key(group, key)
else
- _ -> configdb_not_enabled()
+ _ ->
+ shell_error("No settings in ConfigDB for #{inspect(group)}, #{inspect(key)}. Aborting.")
end
end
- def run(["dump" | dbkey]) do
- with true <- Pleroma.Config.get([:configurable_from_database]) do
- start_pleroma()
+ def run(["delete", "--force", group]) do
+ start_pleroma()
- dbkey = dbkey |> List.first() |> String.to_atom()
+ group = maybe_atomize(group)
- ConfigDB
- |> Repo.all()
- |> Enum.filter(fn x ->
- if x.key == dbkey do
- x |> dump
- end
- end)
+ with true <- group_exists?(group) do
+ shell_info("The following settings will be removed from ConfigDB:\n")
+ dump_group(group)
+ delete_group(group)
else
- _ -> configdb_not_enabled()
+ _ -> shell_error("No settings in ConfigDB for #{inspect(group)}. Aborting.")
end
end
- def run(["keylist"]) do
- with true <- Pleroma.Config.get([:configurable_from_database]) do
- start_pleroma()
+ def run(["delete", group, key]) do
+ start_pleroma()
- keys =
- ConfigDB
- |> Repo.all()
- |> Enum.map(fn x -> x.key end)
+ group = maybe_atomize(group)
+ key = maybe_atomize(key)
- if length(keys) > 0 do
- shell_info("The following configuration keys are set in ConfigDB:\r\n")
- keys |> Enum.each(fn x -> shell_info("- #{x}") end)
- shell_info("\r\n")
+ with true <- key_exists?(group, key) do
+ shell_info("The following settings will be removed from ConfigDB:\n")
+
+ group
+ |> ConfigDB.get_by_group_and_key(key)
+ |> dump()
+
+ if shell_prompt("Are you sure you want to continue?", "n") in ~w(Yn Y y) do
+ delete_key(group, key)
+ else
+ shell_error("No changes made.")
end
else
- _ -> configdb_not_enabled()
+ _ ->
+ shell_error("No settings in ConfigDB for #{inspect(group)}, #{inspect(key)}. Aborting.")
end
end
- def run(["keydel" | dbkey]) do
- unless [] == dbkey do
- with true <- Pleroma.Config.get([:configurable_from_database]) do
- start_pleroma()
+ def run(["delete", group]) do
+ start_pleroma()
+
+ group = maybe_atomize(group)
- dbkey = dbkey |> List.first() |> String.to_atom()
+ with true <- group_exists?(group) do
+ shell_info("The following settings will be removed from ConfigDB:\n")
+ dump_group(group)
- ConfigDB
- |> Repo.all()
- |> Enum.filter(fn x ->
- if x.key == dbkey do
- x |> delete(true)
- end
- end)
+ if shell_prompt("Are you sure you want to continue?", "n") in ~w(Yn Y y) do
+ delete_group(group)
else
- _ -> configdb_not_enabled()
+ shell_error("No changes made.")
end
else
- shell_error(
- "You must provide a key to delete. Use the keylist command to get a list of valid keys."
- )
+ _ -> shell_error("No settings in ConfigDB for #{inspect(group)}. Aborting.")
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
+ with :ok <- Pleroma.Config.DeprecationWarnings.warn() do
config_file =
if file_path do
file_path
do_migrate_to_db(config_file)
else
- :error -> deprecation_error()
- _ -> migration_error()
+ _ ->
+ shell_error("Migration is not allowed until all deprecation warnings have been resolved.")
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;")
- Ecto.Adapters.SQL.query!(Repo, "ALTER SEQUENCE config_id_seq RESTART;")
+ truncatedb()
custom_config =
config_file
shell_info("Settings for key #{key} migrated.")
end)
- shell_info("Settings for group :#{group} migrated.")
+ shell_info("Settings for group #{inspect(group)} migrated.")
end
defp migrate_from_db(opts) do
- if Pleroma.Config.get([:configurable_from_database]) do
- env = opts[:env] || Pleroma.Config.get(:env)
+ env = opts[:env] || Pleroma.Config.get(:env)
- config_path =
- if Pleroma.Config.get(:release) do
+ filename = "#{env}.exported_from_db.secret.exs"
+
+ config_path =
+ cond do
+ opts[:path] ->
+ opts[:path]
+
+ Pleroma.Config.get(:release) ->
: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]))
-
- :ok = File.close(file)
- System.cmd("mix", ["format", config_path])
+ true ->
+ "config"
+ end
+ |> Path.join(filename)
- shell_info(
- "Database configuration settings have been exported to config/#{env}.exported_from_db.secret.exs"
- )
+ with {:ok, file} <- File.open(config_path, [:write, :utf8]) do
+ write_config(file, config_path, opts)
+ shell_info("Database configuration settings have been exported to #{config_path}")
else
- migration_error()
+ _ ->
+ shell_error("Impossible to save settings to this directory #{Path.dirname(config_path)}")
+ tmp_config_path = Path.join(System.tmp_dir!(), filename)
+ file = File.open!(tmp_config_path)
+
+ shell_info(
+ "Saving database configuration settings to #{tmp_config_path}. Copy it to the #{
+ Path.dirname(config_path)
+ } manually."
+ )
+
+ write_config(file, tmp_config_path, opts)
end
end
- 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`"
- )
- end
+ defp write_config(file, path, opts) do
+ IO.write(file, config_header())
+
+ ConfigDB
+ |> Repo.all()
+ |> Enum.each(&write_and_delete(&1, file, opts[:delete]))
- defp deprecation_error do
- shell_error("Migration is not allowed until all deprecation warnings have been resolved.")
+ :ok = File.close(file)
+ System.cmd("mix", ["format", path])
end
if Code.ensure_loaded?(Config.Reader) do
defp delete(config, true) do
{:ok, _} = Repo.delete(config)
- shell_info("#{config.key} deleted from the ConfigDB.")
+
+ shell_info(
+ "config #{inspect(config.group)}, #{inspect(config.key)} was deleted from the ConfigDB."
+ )
end
defp delete(_config, _), do: :ok
- defp dump(%Pleroma.ConfigDB{} = config) do
+ defp dump(%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."
- )
+ defp dump(_), do: :noop
+
+ defp dump_group(group) when is_atom(group) do
+ group
+ |> ConfigDB.get_all_by_group()
+ |> Enum.each(&dump/1)
+ end
+
+ defp group_exists?(group) do
+ group
+ |> ConfigDB.get_all_by_group()
+ |> Enum.any?()
+ end
+
+ defp key_exists?(group, key) do
+ group
+ |> ConfigDB.get_by_group_and_key(key)
+ |> is_nil
+ |> Kernel.!()
+ end
+
+ defp maybe_atomize(arg) when is_atom(arg), do: arg
+
+ defp maybe_atomize(":" <> arg), do: maybe_atomize(arg)
+
+ defp maybe_atomize(arg) when is_binary(arg) do
+ if ConfigDB.module_name?(arg) do
+ String.to_existing_atom("Elixir." <> arg)
+ else
+ String.to_atom(arg)
+ end
+ end
+
+ defp check_configdb(callback) do
+ with true <- Pleroma.Config.get([:configurable_from_database]) do
+ callback.()
+ else
+ _ ->
+ shell_error(
+ "ConfigDB not enabled. Please check the value of :configurable_from_database in your configuration."
+ )
+ end
+ end
+
+ defp delete_key(group, key) do
+ check_configdb(fn ->
+ ConfigDB.delete(%{group: group, key: key})
+ end)
+ end
+
+ defp delete_group(group) do
+ check_configdb(fn ->
+ group
+ |> ConfigDB.get_all_by_group()
+ |> Enum.each(&ConfigDB.delete/1)
+ end)
+ end
+
+ defp truncatedb do
+ Ecto.Adapters.SQL.query!(Repo, "TRUNCATE config;")
+ Ecto.Adapters.SQL.query!(Repo, "ALTER SEQUENCE config_id_seq RESTART;")
end
end
projects / akkoma / blobdiff