Documentation updates for stable release (#73)
[akkoma] / lib / mix / tasks / pleroma / config.ex
index ebaf2c623841d135660789ec68a4dcafcb2828d2..c259a6cbd27ecc92c42ce01d22b86530f1282117 100644 (file)
@@ -1,17 +1,18 @@
 # 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
   alias Pleroma.Repo
 
   @shortdoc "Manages the location of the config"
-  @moduledoc File.read!("docs/administration/CLI_tasks/config.md")
+  @moduledoc File.read!("docs/docs/administration/CLI_tasks/config.md")
 
   def run(["migrate_to_db"]) do
     check_configdb(fn ->
@@ -26,7 +27,7 @@ defmodule Mix.Tasks.Pleroma.Config do
 
       {opts, _} =
         OptionParser.parse!(options,
-          strict: [env: :string, delete: :boolean],
+          strict: [env: :string, delete: :boolean, path: :string],
           aliases: [d: :delete]
         )
 
@@ -48,7 +49,7 @@ defmodule Mix.Tasks.Pleroma.Config do
       unless settings == [] do
         shell_info("#{header}")
 
-        settings |> Enum.each(&dump(&1))
+        Enum.each(settings, &dump(&1))
       else
         shell_error("No settings in ConfigDB.")
       end
@@ -62,7 +63,9 @@ defmodule Mix.Tasks.Pleroma.Config do
       group = maybe_atomize(group)
       key = maybe_atomize(key)
 
-      dump_key(group, key)
+      group
+      |> ConfigDB.get_by_group_and_key(key)
+      |> dump()
     end)
   end
 
@@ -82,10 +85,9 @@ defmodule Mix.Tasks.Pleroma.Config do
 
       groups =
         ConfigDB
+        |> distinct([c], true)
+        |> select([c], c.group)
         |> 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")
@@ -132,7 +134,18 @@ defmodule Mix.Tasks.Pleroma.Config do
     group = maybe_atomize(group)
     key = maybe_atomize(key)
 
-    delete_key(group, 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
+      _ ->
+        shell_error("No settings in ConfigDB for #{inspect(group)}, #{inspect(key)}. Aborting.")
+    end
   end
 
   def run(["delete", "--force", group]) do
@@ -140,7 +153,13 @@ defmodule Mix.Tasks.Pleroma.Config do
 
     group = maybe_atomize(group)
 
-    delete_group(group)
+    with true <- group_exists?(group) do
+      shell_info("The following settings will be removed from ConfigDB:\n")
+      dump_group(group)
+      delete_group(group)
+    else
+      _ -> shell_error("No settings in ConfigDB for #{inspect(group)}. Aborting.")
+    end
   end
 
   def run(["delete", group, key]) do
@@ -149,10 +168,21 @@ defmodule Mix.Tasks.Pleroma.Config do
     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
-      delete_key(group, 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()
+
+      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
-      shell_error("No changes made.")
+      _ ->
+        shell_error("No settings in ConfigDB for #{inspect(group)}, #{inspect(key)}. Aborting.")
     end
   end
 
@@ -161,10 +191,17 @@ defmodule Mix.Tasks.Pleroma.Config do
 
     group = maybe_atomize(group)
 
-    if shell_prompt("Are you sure you want to continue?", "n") in ~w(Yn Y y) do
-      delete_group(group)
+    with true <- 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
+        delete_group(group)
+      else
+        shell_error("No changes made.")
+      end
     else
-      shell_error("No changes made.")
+      _ -> shell_error("No settings in ConfigDB for #{inspect(group)}. Aborting.")
     end
   end
 
@@ -222,18 +259,41 @@ defmodule Mix.Tasks.Pleroma.Config do
   defp migrate_from_db(opts) do
     env = opts[:env] || Pleroma.Config.get(:env)
 
+    filename = "#{env}.exported_from_db.secret.exs"
+
     config_path =
-      if Pleroma.Config.get(:release) do
-        :config_path
-        |> Pleroma.Config.get()
-        |> Path.dirname()
-      else
-        "config"
+      cond do
+        opts[:path] ->
+          opts[:path]
+
+        Pleroma.Config.get(:release) ->
+          :config_path
+          |> Pleroma.Config.get()
+          |> Path.dirname()
+
+        true ->
+          "config"
       end
-      |> Path.join("#{env}.exported_from_db.secret.exs")
+      |> Path.join(filename)
+
+    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
+      _ ->
+        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)
 
-    file = File.open!(config_path, [:write, :utf8])
+        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 write_config(file, path, opts) do
     IO.write(file, config_header())
 
     ConfigDB
@@ -241,11 +301,7 @@ defmodule Mix.Tasks.Pleroma.Config do
     |> Enum.each(&write_and_delete(&1, file, opts[:delete]))
 
     :ok = File.close(file)
-    System.cmd("mix", ["format", config_path])
-
-    shell_info(
-      "Database configuration settings have been exported to config/#{env}.exported_from_db.secret.exs"
-    )
+    System.cmd("mix", ["format", path])
   end
 
   if Code.ensure_loaded?(Config.Reader) do
@@ -280,58 +336,40 @@ defmodule Mix.Tasks.Pleroma.Config do
 
   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 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(_), do: :noop
 
   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)
+    group
+    |> ConfigDB.get_all_by_group()
+    |> Enum.each(&dump/1)
   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)
+  defp group_exists?(group) do
+    group
+    |> ConfigDB.get_all_by_group()
+    |> Enum.any?()
+  end
 
-    unless result == [] do
-      true
-    else
-      false
-    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) when is_binary(arg) do
-    chars = String.codepoints(arg)
+  defp maybe_atomize(":" <> arg), do: maybe_atomize(arg)
 
-    # hack to make sure input like Pleroma.Mailer.Foo is formatted correctly
-    # for matching against values returned by Ecto
-    if "." in chars do
-      :"Elixir.#{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
@@ -350,36 +388,19 @@ defmodule Mix.Tasks.Pleroma.Config do
 
   defp delete_key(group, key) do
     check_configdb(fn ->
-      ConfigDB
-      |> Repo.all()
-      |> Enum.filter(fn x ->
-        if x.group == group and x.key == key do
-          x |> delete(true)
-        end
-      end)
+      ConfigDB.delete(%{group: group, key: key})
     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
-        |> Repo.all()
-        |> Enum.filter(fn x ->
-          if x.group == group do
-            x |> delete(true)
-          end
-        end)
-      else
-        _ -> shell_error("No settings in ConfigDB for #{inspect(group)}. Aborting.")
-      end
+      group
+      |> ConfigDB.get_all_by_group()
+      |> Enum.each(&ConfigDB.delete/1)
     end)
   end
 
-  defp truncatedb() do
+  defp truncatedb do
     Ecto.Adapters.SQL.query!(Repo, "TRUNCATE config;")
     Ecto.Adapters.SQL.query!(Repo, "ALTER SEQUENCE config_id_seq RESTART;")
   end