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
21 def run(["migrate_from_db" | options]) do
25 OptionParser.parse!(options,
26 strict: [env: :string, delete: :boolean],
33 @spec migrate_to_db(Path.t() | nil) :: any()
34 def migrate_to_db(file_path \\ nil) do
35 with true <- Pleroma.Config.get([:configurable_from_database]),
36 :ok <- Pleroma.Config.DeprecationWarnings.warn() do
41 if Pleroma.Config.get(:release) do
42 Pleroma.Config.get(:config_path)
44 "config/#{Pleroma.Config.get(:env)}.secret.exs"
48 do_migrate_to_db(config_file)
50 :error -> deprecation_error()
51 _ -> migration_error()
55 defp do_migrate_to_db(config_file) do
56 if File.exists?(config_file) do
57 shell_info("Migrating settings from file: #{Path.expand(config_file)}")
58 Ecto.Adapters.SQL.query!(Repo, "TRUNCATE config;")
59 Ecto.Adapters.SQL.query!(Repo, "ALTER SEQUENCE config_id_seq RESTART;")
68 |> Enum.each(&create(&1, custom_config))
70 shell_info("To migrate settings, you must define custom settings in #{config_file}.")
74 defp create(group, settings) do
76 |> Pleroma.Config.Loader.filter_group(settings)
77 |> Enum.each(fn {key, value} ->
78 {:ok, _} = ConfigDB.update_or_create(%{group: group, key: key, value: value})
80 shell_info("Settings for key #{key} migrated.")
83 shell_info("Settings for group :#{group} migrated.")
86 defp migrate_from_db(opts) do
87 if Pleroma.Config.get([:configurable_from_database]) do
88 env = opts[:env] || Pleroma.Config.get(:env)
91 if Pleroma.Config.get(:release) do
93 |> Pleroma.Config.get()
98 |> Path.join("#{env}.exported_from_db.secret.exs")
100 file = File.open!(config_path, [:write, :utf8])
102 IO.write(file, config_header())
106 |> Enum.each(&write_and_delete(&1, file, opts[:delete]))
108 :ok = File.close(file)
109 System.cmd("mix", ["format", config_path])
112 "Database configuration settings have been exported to config/#{env}.exported_from_db.secret.exs"
119 defp migration_error do
121 "Migration is not allowed in config. You can change this behavior by setting `config :pleroma, configurable_from_database: true`"
125 defp deprecation_error do
126 shell_error("Migration is not allowed until all deprecation warnings have been resolved.")
129 if Code.ensure_loaded?(Config.Reader) do
130 defp config_header, do: "import Config\r\n\r\n"
131 defp read_file(config_file), do: Config.Reader.read_imports!(config_file)
133 defp config_header, do: "use Mix.Config\r\n\r\n"
134 defp read_file(config_file), do: Mix.Config.eval!(config_file)
137 defp write_and_delete(config, file, delete?) do
143 defp write(config, file) do
144 value = inspect(config.value, limit: :infinity)
146 IO.write(file, "config #{inspect(config.group)}, #{inspect(config.key)}, #{value}\r\n\r\n")
151 defp delete(config, true) do
152 {:ok, _} = Repo.delete(config)
153 shell_info("#{config.key} deleted from DB.")
156 defp delete(_config, _), do: :ok