1 # Pleroma: A lightweight social networking server
2 # Copyright © 2017-2021 Pleroma Authors <https://pleroma.social/>
3 # SPDX-License-Identifier: AGPL-3.0-only
5 defmodule Pleroma.ConfigDB do
9 import Ecto.Query, only: [select: 3, from: 2]
10 import Pleroma.Web.Gettext
15 @type t :: %__MODULE__{}
18 {:pleroma, :assets, :mascots},
19 {:pleroma, :emoji, :groups},
20 {:pleroma, :workers, :retries},
21 {:pleroma, :mrf_subchain, :match_actor},
22 {:pleroma, :mrf_keyword, :replace}
26 field(:key, Pleroma.EctoType.Config.Atom)
27 field(:group, Pleroma.EctoType.Config.Atom)
28 field(:value, Pleroma.EctoType.Config.BinaryValue)
29 field(:db, {:array, :string}, virtual: true, default: [])
34 @spec get_all_as_keyword() :: keyword()
35 def get_all_as_keyword do
37 |> select([c], {c.group, c.key, c.value})
39 |> Enum.reduce([], fn {group, key, value}, acc ->
40 Keyword.update(acc, group, [{key, value}], &Keyword.merge(&1, [{key, value}]))
44 @spec get_all_by_group(atom() | String.t()) :: [t()]
45 def get_all_by_group(group) do
46 from(c in ConfigDB, where: c.group == ^group) |> Repo.all()
49 @spec get_by_group_and_key(atom() | String.t(), atom() | String.t()) :: t() | nil
50 def get_by_group_and_key(group, key) do
51 get_by_params(%{group: group, key: key})
54 @spec get_by_params(map()) :: ConfigDB.t() | nil
55 def get_by_params(%{group: _, key: _} = params), do: Repo.get_by(ConfigDB, params)
57 @spec changeset(ConfigDB.t(), map()) :: Changeset.t()
58 def changeset(config, params \\ %{}) do
60 |> cast(params, [:key, :group, :value])
61 |> validate_required([:key, :group, :value])
62 |> unique_constraint(:key, name: :config_group_key_index)
65 defp create(params) do
71 defp update(%ConfigDB{} = config, %{value: value}) do
73 |> changeset(%{value: value})
77 @spec get_db_keys(keyword(), any()) :: [String.t()]
78 def get_db_keys(value, key) do
80 if Keyword.keyword?(value) do
86 Enum.map(keys, &to_json_types(&1))
89 @spec merge_group(atom(), atom(), keyword(), keyword()) :: keyword()
90 def merge_group(group, key, old_value, new_value) do
91 new_keys = to_mapset(new_value)
93 intersect_keys = old_value |> to_mapset() |> MapSet.intersection(new_keys) |> MapSet.to_list()
95 merged_value = ConfigDB.merge(old_value, new_value)
99 {g, k, subkey} when g == group and k == key ->
100 if subkey in intersect_keys, do: subkey, else: []
106 |> Enum.reduce(merged_value, &Keyword.put(&2, &1, new_value[&1]))
109 defp to_mapset(keyword) do
115 @spec sub_key_full_update?(atom(), atom(), [Keyword.key()]) :: boolean()
116 def sub_key_full_update?(group, key, subkeys) do
117 Enum.any?(@full_subkey_update, fn {g, k, subkey} ->
118 g == group and k == key and subkey in subkeys
122 @spec merge(keyword(), keyword()) :: keyword()
123 def merge(config1, config2) when is_list(config1) and is_list(config2) do
124 Keyword.merge(config1, config2, fn _, app1, app2 ->
125 if Keyword.keyword?(app1) and Keyword.keyword?(app2) do
126 Keyword.merge(app1, app2, &deep_merge/3)
133 defp deep_merge(_key, value1, value2) do
134 if Keyword.keyword?(value1) and Keyword.keyword?(value2) do
135 Keyword.merge(value1, value2, &deep_merge/3)
141 @spec update_or_create(map()) :: {:ok, ConfigDB.t()} | {:error, Changeset.t()}
142 def update_or_create(params) do
143 params = Map.put(params, :value, to_elixir_types(params[:value]))
146 Map.take(params, [:group, :key]) |> Map.update!(:key, &string_to_elixir_types(&1))
148 with %ConfigDB{} = config <- ConfigDB.get_by_params(search_opts),
149 {_, true, config} <- {:partial_update, can_be_partially_updated?(config), config},
151 {:can_be_merged, is_list(params[:value]) and is_list(config.value), config} do
152 new_value = merge_group(config.group, config.key, config.value, params[:value])
153 update(config, %{value: new_value})
155 {reason, false, config} when reason in [:partial_update, :can_be_merged] ->
156 update(config, params)
163 defp can_be_partially_updated?(%ConfigDB{} = config), do: not only_full_update?(config)
165 defp only_full_update?(%ConfigDB{group: group, key: key}) do
167 {:pleroma, :ecto_repos},
170 {:cors_plug, [:max_age, :methods, :expose, :headers]},
171 {:swarm, :node_blacklist},
175 Enum.any?(full_key_update, fn
177 group == s_group and ((is_list(s_key) and key in s_key) or key == s_key)
181 @spec delete(ConfigDB.t() | map()) :: {:ok, ConfigDB.t()} | {:error, Changeset.t()}
182 def delete(%ConfigDB{} = config), do: Repo.delete(config)
184 def delete(params) do
185 search_opts = Map.delete(params, :subkeys)
187 with %ConfigDB{} = config <- ConfigDB.get_by_params(search_opts),
188 {config, sub_keys} when is_list(sub_keys) <- {config, params[:subkeys]},
189 keys <- Enum.map(sub_keys, &string_to_elixir_types(&1)),
190 {_, config, new_value} when new_value != [] <-
191 {:partial_remove, config, Keyword.drop(config.value, keys)} do
192 update(config, %{value: new_value})
194 {:partial_remove, config, []} ->
202 dgettext("errors", "Config with params %{params} not found", params: inspect(params))
208 @spec to_json_types(term()) :: map() | list() | boolean() | String.t()
209 def to_json_types(entity) when is_list(entity) do
210 Enum.map(entity, &to_json_types/1)
213 def to_json_types(%Regex{} = entity), do: inspect(entity)
215 def to_json_types(entity) when is_map(entity) do
216 Map.new(entity, fn {k, v} -> {to_json_types(k), to_json_types(v)} end)
219 def to_json_types({:args, args}) when is_list(args) do
222 arg when is_tuple(arg) -> inspect(arg)
223 arg -> to_json_types(arg)
226 %{"tuple" => [":args", arguments]}
229 def to_json_types({:proxy_url, {type, :localhost, port}}) do
230 %{"tuple" => [":proxy_url", %{"tuple" => [to_json_types(type), "localhost", port]}]}
233 def to_json_types({:proxy_url, {type, host, port}}) when is_tuple(host) do
236 |> :inet_parse.ntoa()
242 %{"tuple" => [to_json_types(type), ip, port]}
247 def to_json_types({:proxy_url, {type, host, port}}) do
251 %{"tuple" => [to_json_types(type), to_string(host), port]}
256 def to_json_types({:partial_chain, entity}),
257 do: %{"tuple" => [":partial_chain", inspect(entity)]}
259 def to_json_types(entity) when is_tuple(entity) do
268 def to_json_types(entity) when is_binary(entity), do: entity
270 def to_json_types(entity) when is_boolean(entity) or is_number(entity) or is_nil(entity) do
274 def to_json_types(entity) when entity in [:"tlsv1.1", :"tlsv1.2", :"tlsv1.3"] do
278 def to_json_types(entity) when is_atom(entity), do: inspect(entity)
280 @spec to_elixir_types(boolean() | String.t() | map() | list()) :: term()
281 def to_elixir_types(%{"tuple" => [":args", args]}) when is_list(args) do
283 Enum.map(args, fn arg ->
284 if String.contains?(arg, ["{", "}"]) do
285 {elem, []} = Code.eval_string(arg)
295 def to_elixir_types(%{"tuple" => [":proxy_url", %{"tuple" => [type, host, port]}]}) do
296 {:proxy_url, {string_to_elixir_types(type), parse_host(host), port}}
299 def to_elixir_types(%{"tuple" => [":partial_chain", entity]}) do
300 {partial_chain, []} =
302 |> String.replace(~r/[^\w|^{:,[|^,|^[|^\]^}|^\/|^\.|^"]^\s/, "")
303 |> Code.eval_string()
305 {:partial_chain, partial_chain}
308 def to_elixir_types(%{"tuple" => entity}) do
309 Enum.reduce(entity, {}, &Tuple.append(&2, to_elixir_types(&1)))
312 def to_elixir_types(entity) when is_map(entity) do
313 Map.new(entity, fn {k, v} -> {to_elixir_types(k), to_elixir_types(v)} end)
316 def to_elixir_types(entity) when is_list(entity) do
317 Enum.map(entity, &to_elixir_types/1)
320 def to_elixir_types(entity) when is_binary(entity) do
323 |> string_to_elixir_types()
326 def to_elixir_types(entity), do: entity
328 @spec string_to_elixir_types(String.t()) ::
329 atom() | Regex.t() | module() | String.t() | no_return()
330 def string_to_elixir_types("~r" <> _pattern = regex) do
332 ~r/^~r(?'delimiter'[\/|"'([{<]{1})(?'pattern'.+)[\/|"')\]}>]{1}(?'modifier'[uismxfU]*)/u
334 delimiters = ["/", "|", "\"", "'", {"(", ")"}, {"[", "]"}, {"{", "}"}, {"<", ">"}]
336 with %{"modifier" => modifier, "pattern" => pattern, "delimiter" => regex_delimiter} <-
337 Regex.named_captures(pattern, regex),
338 {:ok, {leading, closing}} <- find_valid_delimiter(delimiters, pattern, regex_delimiter),
339 {result, _} <- Code.eval_string("~r#{leading}#{pattern}#{closing}#{modifier}") do
344 def string_to_elixir_types(":" <> atom), do: String.to_atom(atom)
346 def string_to_elixir_types(value) do
347 if module_name?(value) do
348 String.to_existing_atom("Elixir." <> value)
354 defp parse_host("localhost"), do: :localhost
356 defp parse_host(host) do
357 charlist = to_charlist(host)
359 case :inet.parse_address(charlist) do
368 defp find_valid_delimiter([], _string, _) do
369 raise(ArgumentError, message: "valid delimiter for Regex expression not found")
372 defp find_valid_delimiter([{leading, closing} = delimiter | others], pattern, regex_delimiter)
373 when is_tuple(delimiter) do
374 if String.contains?(pattern, closing) do
375 find_valid_delimiter(others, pattern, regex_delimiter)
377 {:ok, {leading, closing}}
381 defp find_valid_delimiter([delimiter | others], pattern, regex_delimiter) do
382 if String.contains?(pattern, delimiter) do
383 find_valid_delimiter(others, pattern, regex_delimiter)
385 {:ok, {delimiter, delimiter}}
389 @spec module_name?(String.t()) :: boolean()
390 def module_name?(string) do
391 Regex.match?(~r/^(Pleroma|Phoenix|Tesla|Quack|Ueberauth|Swoosh)\./, string) or
392 string in ["Oban", "Ueberauth", "ExSyslogger", "ConcurrentLimiter"]