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, :assets, :mascots},
83 {:pleroma, :emoji, :groups},
84 {:pleroma, :workers, :retries},
85 {:pleroma, :mrf_subchain, :match_actor},
86 {:pleroma, :mrf_keyword, :replace}
89 @spec deep_merge(atom(), atom(), keyword(), keyword()) :: keyword()
90 def deep_merge(group, key, old_value, new_value) do
101 intersect_keys = old_keys |> MapSet.intersection(new_keys) |> MapSet.to_list()
103 subkeys = sub_key_full_update(group, key, intersect_keys)
105 merged_value = ConfigDB.merge(old_value, new_value)
107 Enum.reduce(subkeys, merged_value, fn subkey, acc ->
108 Keyword.put(acc, subkey, new_value[subkey])
112 @spec sub_key_full_update?(atom(), atom(), [Keyword.key()]) :: boolean()
113 def sub_key_full_update?(group, key, subkeys) do
114 Enum.any?(@full_subkey_update, fn {g, k, subkey} ->
115 g == group and k == key and subkey in subkeys
119 defp sub_key_full_update(group, key, subkeys) do
120 Enum.map(@full_subkey_update, fn
121 {g, k, subkey} when g == group and k == key ->
122 if subkey in subkeys, do: subkey, else: []
130 def merge(config1, config2) when is_list(config1) and is_list(config2) do
131 Keyword.merge(config1, config2, fn _, app1, app2 ->
132 if Keyword.keyword?(app1) and Keyword.keyword?(app2) do
133 Keyword.merge(app1, app2, &deep_merge/3)
140 defp deep_merge(_key, value1, value2) do
141 if Keyword.keyword?(value1) and Keyword.keyword?(value2) do
142 Keyword.merge(value1, value2, &deep_merge/3)
149 {:pleroma, :ecto_repos},
152 {:cors_plug, [:max_age, :methods, :expose, :headers]},
153 {:auto_linker, :opts},
154 {:swarm, :node_blacklist},
158 defp only_full_update?(%ConfigDB{} = config) do
159 config_group = ConfigDB.from_string(config.group)
160 config_key = ConfigDB.from_string(config.key)
162 Enum.any?(@full_key_update, fn
163 {group, key} when is_list(key) ->
164 config_group == group and config_key in key
167 config_group == group and config_key == key
171 defp can_be_partially_updated?(%ConfigDB{} = config), do: not only_full_update?(config)
173 @spec update_or_create(map()) :: {:ok, ConfigDB.t()} | {:error, Changeset.t()}
174 def update_or_create(params) do
175 search_opts = Map.take(params, [:group, :key])
177 with %ConfigDB{} = config <- ConfigDB.get_by_params(search_opts),
178 {:partial_update, true, config} <-
179 {:partial_update, can_be_partially_updated?(config), config},
180 old_value <- from_binary(config.value),
181 transformed_value <- do_transform(params[:value]),
182 {:can_be_merged, true, config} <- {:can_be_merged, is_list(transformed_value), config},
185 ConfigDB.from_string(config.group),
186 ConfigDB.from_string(config.key),
190 ConfigDB.update(config, %{value: new_value})
192 {reason, false, config} when reason in [:partial_update, :can_be_merged] ->
193 ConfigDB.update(config, params)
196 ConfigDB.create(params)
200 @spec delete(map()) :: {:ok, ConfigDB.t()} | {:error, Changeset.t()} | {:ok, nil}
201 def delete(params) do
202 search_opts = Map.delete(params, :subkeys)
204 with %ConfigDB{} = config <- ConfigDB.get_by_params(search_opts),
205 {config, sub_keys} when is_list(sub_keys) <- {config, params[:subkeys]},
206 old_value <- from_binary(config.value),
207 keys <- Enum.map(sub_keys, &do_transform_string(&1)),
208 new_value <- Keyword.drop(old_value, keys) do
209 ConfigDB.update(config, %{value: new_value})
217 dgettext("errors", "Config with params %{params} not found", params: inspect(params))
223 @spec from_binary(binary()) :: term()
224 def from_binary(binary), do: :erlang.binary_to_term(binary)
226 @spec from_binary_with_convert(binary()) :: any()
227 def from_binary_with_convert(binary) do
233 @spec from_string(String.t()) :: atom() | no_return()
234 def from_string(":" <> entity), do: String.to_existing_atom(entity)
236 def from_string(entity) when is_binary(entity) do
237 if is_module_name?(entity) do
238 String.to_existing_atom("Elixir.#{entity}")
244 @spec convert(any()) :: any()
245 def convert(entity), do: do_convert(entity)
247 defp do_convert(entity) when is_list(entity) do
248 for v <- entity, into: [], do: do_convert(v)
251 defp do_convert(%Regex{} = entity), do: inspect(entity)
253 defp do_convert(entity) when is_map(entity) do
254 for {k, v} <- entity, into: %{}, do: {do_convert(k), do_convert(v)}
257 defp do_convert({:proxy_url, {type, :localhost, port}}) do
258 %{"tuple" => [":proxy_url", %{"tuple" => [do_convert(type), "localhost", port]}]}
261 defp do_convert({:proxy_url, {type, host, port}}) when is_tuple(host) do
264 |> :inet_parse.ntoa()
270 %{"tuple" => [do_convert(type), ip, port]}
275 defp do_convert({:proxy_url, {type, host, port}}) do
279 %{"tuple" => [do_convert(type), to_string(host), port]}
284 # TODO: will become useless after removing hackney
285 defp do_convert({:partial_chain, entity}), do: %{"tuple" => [":partial_chain", inspect(entity)]}
287 defp do_convert(entity) when is_tuple(entity),
288 do: %{"tuple" => do_convert(Tuple.to_list(entity))}
290 defp do_convert(entity) when is_boolean(entity) or is_number(entity) or is_nil(entity),
293 defp do_convert(entity)
294 when is_atom(entity) and entity in [:"tlsv1.1", :"tlsv1.2", :"tlsv1.3"] do
295 ":#{to_string(entity)}"
298 defp do_convert(entity) when is_atom(entity), do: inspect(entity)
300 defp do_convert(entity) when is_binary(entity), do: entity
302 @spec transform(any()) :: binary() | no_return()
303 def transform(entity) when is_binary(entity) or is_map(entity) or is_list(entity) do
309 def transform(entity), do: to_binary(entity)
311 @spec transform_with_out_binary(any()) :: any()
312 def transform_with_out_binary(entity), do: do_transform(entity)
314 @spec to_binary(any()) :: binary()
315 def to_binary(entity), do: :erlang.term_to_binary(entity)
317 defp do_transform(%Regex{} = entity), do: entity
319 defp do_transform(%{"tuple" => [":proxy_url", %{"tuple" => [type, host, port]}]}) do
320 {:proxy_url, {do_transform_string(type), parse_host(host), port}}
323 # TODO: will become useless after removing hackney
324 defp do_transform(%{"tuple" => [":partial_chain", entity]}) do
325 {partial_chain, []} =
327 |> String.replace(~r/[^\w|^{:,[|^,|^[|^\]^}|^\/|^\.|^"]^\s/, "")
328 |> Code.eval_string()
330 {:partial_chain, partial_chain}
333 defp do_transform(%{"tuple" => entity}) do
334 Enum.reduce(entity, {}, fn val, acc -> Tuple.append(acc, do_transform(val)) end)
337 defp do_transform(entity) when is_map(entity) do
338 for {k, v} <- entity, into: %{}, do: {do_transform(k), do_transform(v)}
341 defp do_transform(entity) when is_list(entity) do
342 for v <- entity, into: [], do: do_transform(v)
345 defp do_transform(entity) when is_binary(entity) do
348 |> do_transform_string()
351 defp do_transform(entity), do: entity
353 defp parse_host("localhost"), do: :localhost
355 defp parse_host(host) do
356 charlist = to_charlist(host)
358 case :inet.parse_address(charlist) do
367 @delimiters ["/", "|", "\"", "'", {"(", ")"}, {"[", "]"}, {"{", "}"}, {"<", ">"}]
369 defp find_valid_delimiter([], _string, _),
370 do: 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 @regex_parts ~r/^~r(?'delimiter'[\/|"'([{<]{1})(?'pattern'.+)[\/|"')\]}>]{1}(?'modifier'[uismxfU]*)/u
391 defp do_transform_string("~r" <> _pattern = regex) do
392 with %{"modifier" => modifier, "pattern" => pattern, "delimiter" => regex_delimiter} <-
393 Regex.named_captures(@regex_parts, regex),
394 {:ok, {leading, closing}} <- find_valid_delimiter(@delimiters, pattern, regex_delimiter),
395 {result, _} <- Code.eval_string("~r#{leading}#{pattern}#{closing}#{modifier}") do
400 defp do_transform_string(":" <> atom), do: String.to_atom(atom)
402 defp do_transform_string(value) do
403 if is_module_name?(value) do
404 String.to_existing_atom("Elixir." <> value)
410 @spec is_module_name?(String.t()) :: boolean()
411 def is_module_name?(string) do
412 Regex.match?(~r/^(Pleroma|Phoenix|Tesla|Quack|Ueberauth)\./, string) or
413 string in ["Oban", "Ueberauth", "ExSyslogger"]