@moduledoc File.read!("docs/administration/CLI_tasks/config.md")
def run(["migrate_to_db"]) do
- check_configdb()
- start_pleroma()
- migrate_to_db()
+ check_configdb(fn ->
+ start_pleroma()
+ migrate_to_db()
+ end)
end
def run(["migrate_from_db" | options]) do
- check_configdb()
- 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],
+ aliases: [d: :delete]
+ )
- migrate_from_db(opts)
+ migrate_from_db(opts)
+ end)
end
def run(["dump"]) do
- check_configdb()
- start_pleroma()
+ check_configdb(fn ->
+ start_pleroma()
- header = config_header()
+ header = config_header()
- settings =
- ConfigDB
- |> Repo.all()
- |> Enum.sort()
+ settings =
+ ConfigDB
+ |> Repo.all()
+ |> Enum.sort()
- unless settings == [] do
- shell_info("#{header}")
+ unless settings == [] do
+ shell_info("#{header}")
- settings |> Enum.each(&dump(&1))
- else
- shell_error("No settings in ConfigDB.")
- end
+ settings |> Enum.each(&dump(&1))
+ else
+ shell_error("No settings in ConfigDB.")
+ end
+ end)
end
def run(["dump", group, key]) do
- check_configdb()
- start_pleroma()
+ check_configdb(fn ->
+ start_pleroma()
- group = maybe_atomize(group)
- key = maybe_atomize(key)
+ group = maybe_atomize(group)
+ key = maybe_atomize(key)
- dump_key(group, key)
+ %{group: group, key: key}
+ |> ConfigDB.get_by_params()
+ |> Repo.all()
+ |> Enum.each(&dump/1)
+ end)
end
def run(["dump", group]) do
- check_configdb()
- start_pleroma()
+ check_configdb(fn ->
+ start_pleroma()
- group = maybe_atomize(group)
+ group = maybe_atomize(group)
- dump_group(group)
+ dump_group(group)
+ end)
end
def run(["groups"]) do
- check_configdb()
- start_pleroma()
+ check_configdb(fn ->
+ 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
+ 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:")
- groups =
ConfigDB
|> Repo.all()
- |> Enum.map(fn x -> x.group end)
|> Enum.sort()
- |> Enum.uniq()
+ |> Enum.each(&dump(&1))
- 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
+ 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(["reset"]) do
- check_configdb()
+ def run(["delete", "--force", group, key]) do
start_pleroma()
- shell_info("The following settings will be permanently removed:")
+ group = maybe_atomize(group)
+ key = maybe_atomize(key)
- ConfigDB
- |> Repo.all()
- |> Enum.sort()
- |> Enum.each(&dump(&1))
+ delete_key(group, key)
+ end
- shell_error("\nTHIS CANNOT BE UNDONE!")
+ def run(["delete", "--force", group]) 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;")
+ group = maybe_atomize(group)
- shell_info("The ConfigDB settings have been removed from the database.")
- else
- shell_error("No changes made.")
- end
+ delete_group(group)
end
- def run(["delete", group]) do
- check_configdb()
+ def run(["delete", group, key]) do
start_pleroma()
group = maybe_atomize(group)
+ key = maybe_atomize(key)
- 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
+ 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 settings in ConfigDB for #{inspect(group)}. Aborting.")
+ shell_error("No changes made.")
end
end
- def run(["delete", group, key]) do
- check_configdb()
+ def run(["delete", group]) 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)
+ delete_group(group)
else
shell_error("No changes made.")
end
do_migrate_to_db(config_file)
else
- _ -> deprecation_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
)
end
- defp deprecation_error do
- shell_error("Migration is not allowed until all deprecation warnings have been resolved.")
- 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)
{:ok, _} = Repo.delete(config)
shell_info(
- "config #{inspect(config.group)}, #{inspect(config.key)} deleted from the ConfigDB."
+ "config #{inspect(config.group)}, #{inspect(config.key)} was deleted from the ConfigDB."
)
end
shell_info("config #{inspect(config.group)}, #{inspect(config.key)}, #{value}\r\n\r\n")
end
- defp configdb_not_enabled do
- raise(
- "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()
end
defp dump_group(group) when is_atom(group) do
- ConfigDB
+ %{group: group}
+ |> ConfigDB.get_by_params()
|> Repo.all()
- |> Enum.filter(fn x ->
- if x.group == group do
- x |> dump
- end
- end)
+ |> Enum.each(&dump/1)
end
- defp group_exists?(group) when is_atom(group) do
- result =
- ConfigDB
+ defp group_exists?(group) do
+ %{group: group}
+ |> ConfigDB.get_by_params()
|> Repo.all()
- |> Enum.filter(fn x ->
- if x.group == group do
- x
- end
- end)
-
- unless result == [] do
- true
- else
- false
- end
+ |> Enum.empty?()
end
defp maybe_atomize(arg) when is_atom(arg), do: arg
defp maybe_atomize(arg) when is_binary(arg) do
- chars = String.codepoints(arg)
-
- if "." in chars do
- :"Elixir.#{arg}"
+ if Pleroma.ConfigDB.module_name?(arg) do
+ String.to_existing_atom("Elixir." <> arg)
else
String.to_atom(arg)
- end
+ end
end
- defp check_configdb() do
+ defp check_configdb(callback) do
with true <- Pleroma.Config.get([:configurable_from_database]) do
- :ok
+ callback.()
else
- _ -> configdb_not_enabled()
+ _ ->
+ 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.get_by_params(%{group: group, key: key})
+ |> Repo.all()
+ |> Enum.each(&delete(&1, true))
+ end)
+ end
+
+ defp delete_group(group) do
+ check_configdb(fn ->
+ with true <- group_exists?(group) do
+ shell_info("The following settings will be removed from ConfigDB:\n")
+ dump_group(group)
+
+ ConfigDB.get_by_params(%{group: group})
+ |> Repo.all()
+ |> Enum.each(&delete(&1, true))
+
+ else
+ _ -> shell_error("No settings in ConfigDB for #{inspect(group)}. Aborting.")
+ end
+ 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