1 # Pleroma: A lightweight social networking server
2 # Copyright © 2017-2019 Pleroma Authors <https://pleroma.social/>
3 # SPDX-License-Identifier: AGPL-3.0-only
5 defmodule Pleroma.ConfigDB do
9 import Pleroma.Web.Gettext
13 @type t :: %__MODULE__{}
17 field(:group, :string)
18 field(:value, :binary)
19 field(:db, {:array, :string}, virtual: true, default: [])
24 @spec get_all_as_keyword() :: keyword()
25 def get_all_as_keyword do
27 |> select([c], {c.group, c.key, c.value})
29 |> Enum.reduce([], fn {group, key, value}, acc ->
30 group = ConfigDB.from_string(group)
31 key = ConfigDB.from_string(key)
32 value = from_binary(value)
34 Keyword.update(acc, group, [{key, value}], &Keyword.merge(&1, [{key, value}]))
38 @spec get_by_params(map()) :: ConfigDB.t() | nil
39 def get_by_params(params), do: Repo.get_by(ConfigDB, params)
41 @spec changeset(ConfigDB.t(), map()) :: Changeset.t()
42 def changeset(config, params \\ %{}) do
43 params = Map.put(params, :value, transform(params[:value]))
46 |> cast(params, [:key, :group, :value])
47 |> validate_required([:key, :group, :value])
48 |> unique_constraint(:key, name: :config_group_key_index)
51 @spec create(map()) :: {:ok, ConfigDB.t()} | {:error, Changeset.t()}
58 @spec update(ConfigDB.t(), map()) :: {:ok, ConfigDB.t()} | {:error, Changeset.t()}
59 def update(%ConfigDB{} = config, %{value: value}) do
61 |> changeset(%{value: value})
65 @spec get_db_keys(ConfigDB.t()) :: [String.t()]
66 def get_db_keys(%ConfigDB{} = config) do
68 |> ConfigDB.from_binary()
69 |> get_db_keys(config.key)
72 @spec get_db_keys(keyword() | any()) :: [String.t()]
73 def get_db_keys(value, key) do
74 if Keyword.keyword?(value) do
75 value |> Keyword.keys() |> Enum.map(&convert(&1))
82 {:pleroma, :ecto_repos},
86 {:cors_plug, [:max_age, :methods, :expose, :headers]},
87 {:auto_linker, :opts},
88 {:swarm, :node_blacklist},
92 defp only_full_update?(%ConfigDB{} = config) do
93 config_group = ConfigDB.from_string(config.group)
94 config_key = ConfigDB.from_string(config.key)
96 Enum.any?(@full_key_update, fn
97 {group, key} when is_list(key) ->
98 config_group == group and config_key in key
101 config_group == group and config_key == key
105 defp can_be_partially_updated?(%ConfigDB{} = config), do: not only_full_update?(config)
107 @spec update_or_create(map()) :: {:ok, ConfigDB.t()} | {:error, Changeset.t()}
108 def update_or_create(params) do
109 search_opts = Map.take(params, [:group, :key])
111 with %ConfigDB{} = config <- ConfigDB.get_by_params(search_opts),
112 {:partial_update, true, config} <-
113 {:partial_update, can_be_partially_updated?(config), config},
114 old_value <- from_binary(config.value),
115 transformed_value <- do_transform(params[:value]),
116 {:can_be_merged, true, config} <- {:can_be_merged, is_list(transformed_value), config},
117 new_value <- DeepMerge.deep_merge(old_value, transformed_value) do
118 ConfigDB.update(config, %{value: new_value, transformed?: true})
120 {reason, false, config} when reason in [:partial_update, :can_be_merged] ->
121 ConfigDB.update(config, params)
124 ConfigDB.create(params)
128 @spec delete(map()) :: {:ok, ConfigDB.t()} | {:error, Changeset.t()} | {:ok, nil}
129 def delete(params) do
130 search_opts = Map.delete(params, :subkeys)
132 with %ConfigDB{} = config <- ConfigDB.get_by_params(search_opts),
133 {config, sub_keys} when is_list(sub_keys) <- {config, params[:subkeys]},
134 old_value <- from_binary(config.value),
135 keys <- Enum.map(sub_keys, &do_transform_string(&1)),
136 new_value <- Keyword.drop(old_value, keys) do
137 ConfigDB.update(config, %{value: new_value})
145 dgettext("errors", "Config with params %{params} not found", params: inspect(params))
151 @spec from_binary(binary()) :: term()
152 def from_binary(binary), do: :erlang.binary_to_term(binary)
154 @spec from_binary_with_convert(binary()) :: any()
155 def from_binary_with_convert(binary) do
161 @spec from_string(String.t()) :: atom() | no_return()
162 def from_string(":" <> entity), do: String.to_existing_atom(entity)
164 def from_string(entity) when is_binary(entity) do
165 if is_module_name?(entity) do
166 String.to_existing_atom("Elixir.#{entity}")
172 @spec convert(any()) :: any()
173 def convert(entity), do: do_convert(entity)
175 defp do_convert(entity) when is_list(entity) do
176 for v <- entity, into: [], do: do_convert(v)
179 defp do_convert(%Regex{} = entity), do: inspect(entity)
181 defp do_convert(entity) when is_map(entity) do
182 for {k, v} <- entity, into: %{}, do: {do_convert(k), do_convert(v)}
185 defp do_convert({:proxy_url, {type, :localhost, port}}) do
186 %{"tuple" => [":proxy_url", %{"tuple" => [do_convert(type), "localhost", port]}]}
189 defp do_convert({:proxy_url, {type, host, port}}) when is_tuple(host) do
192 |> :inet_parse.ntoa()
198 %{"tuple" => [do_convert(type), ip, port]}
203 defp do_convert({:proxy_url, {type, host, port}}) do
207 %{"tuple" => [do_convert(type), to_string(host), port]}
212 # TODO: will become useless after removing hackney
213 defp do_convert({:partial_chain, entity}), do: %{"tuple" => [":partial_chain", inspect(entity)]}
215 defp do_convert(entity) when is_tuple(entity),
216 do: %{"tuple" => do_convert(Tuple.to_list(entity))}
218 defp do_convert(entity) when is_boolean(entity) or is_number(entity) or is_nil(entity),
221 defp do_convert(entity)
222 when is_atom(entity) and entity in [:"tlsv1.1", :"tlsv1.2", :"tlsv1.3"] do
223 ":#{to_string(entity)}"
226 defp do_convert(entity) when is_atom(entity), do: inspect(entity)
228 defp do_convert(entity) when is_binary(entity), do: entity
230 @spec transform(any()) :: binary() | no_return()
231 def transform(entity) when is_binary(entity) or is_map(entity) or is_list(entity) do
237 def transform(entity), do: to_binary(entity)
239 @spec to_binary(any()) :: binary()
240 def to_binary(entity), do: :erlang.term_to_binary(entity)
242 defp do_transform(%Regex{} = entity), do: entity
244 defp do_transform(%{"tuple" => [":proxy_url", %{"tuple" => [type, host, port]}]}) do
245 {:proxy_url, {do_transform_string(type), parse_host(host), port}}
248 # TODO: will become useless after removing hackney
249 defp do_transform(%{"tuple" => [":partial_chain", entity]}) do
250 {partial_chain, []} =
252 |> String.replace(~r/[^\w|^{:,[|^,|^[|^\]^}|^\/|^\.|^"]^\s/, "")
253 |> Code.eval_string()
255 {:partial_chain, partial_chain}
258 defp do_transform(%{"tuple" => entity}) do
259 Enum.reduce(entity, {}, fn val, acc -> Tuple.append(acc, do_transform(val)) end)
262 defp do_transform(entity) when is_map(entity) do
263 for {k, v} <- entity, into: %{}, do: {do_transform(k), do_transform(v)}
266 defp do_transform(entity) when is_list(entity) do
267 for v <- entity, into: [], do: do_transform(v)
270 defp do_transform(entity) when is_binary(entity) do
273 |> do_transform_string()
276 defp do_transform(entity), do: entity
278 defp parse_host("localhost"), do: :localhost
280 defp parse_host(host) do
281 charlist = to_charlist(host)
283 case :inet.parse_address(charlist) do
292 @delimiters ["/", "|", "\"", "'", {"(", ")"}, {"[", "]"}, {"{", "}"}, {"<", ">"}]
294 defp find_valid_delimiter([], _string, _),
295 do: raise(ArgumentError, message: "valid delimiter for Regex expression not found")
297 defp find_valid_delimiter([{leading, closing} = delimiter | others], pattern, regex_delimiter)
298 when is_tuple(delimiter) do
299 if String.contains?(pattern, closing) do
300 find_valid_delimiter(others, pattern, regex_delimiter)
302 {:ok, {leading, closing}}
306 defp find_valid_delimiter([delimiter | others], pattern, regex_delimiter) do
307 if String.contains?(pattern, delimiter) do
308 find_valid_delimiter(others, pattern, regex_delimiter)
310 {:ok, {delimiter, delimiter}}
314 @regex_parts ~r/^~r(?'delimiter'[\/|"'([{<]{1})(?'pattern'.+)[\/|"')\]}>]{1}(?'modifier'[uismxfU]*)/u
316 defp do_transform_string("~r" <> _pattern = regex) do
317 with %{"modifier" => modifier, "pattern" => pattern, "delimiter" => regex_delimiter} <-
318 Regex.named_captures(@regex_parts, regex),
319 {:ok, {leading, closing}} <- find_valid_delimiter(@delimiters, pattern, regex_delimiter),
320 {result, _} <- Code.eval_string("~r#{leading}#{pattern}#{closing}#{modifier}") do
325 defp do_transform_string(":" <> atom), do: String.to_atom(atom)
327 defp do_transform_string(value) do
328 if is_module_name?(value) do
329 String.to_existing_atom("Elixir." <> value)
335 @spec is_module_name?(String.t()) :: boolean()
336 def is_module_name?(string) do
337 Regex.match?(~r/^(Pleroma|Phoenix|Tesla|Quack|Ueberauth)\./, string) or
338 string in ["Oban", "Ueberauth", "ExSyslogger"]