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)
23 @spec get_all_as_keyword() :: keyword()
24 def get_all_as_keyword do
26 |> select([c], {c.group, c.key, c.value})
28 |> Enum.reduce([], fn {group, key, value}, acc ->
29 group = ConfigDB.from_string(group)
30 key = ConfigDB.from_string(key)
31 value = from_binary(value)
33 Keyword.update(acc, group, [{key, value}], &Keyword.merge(&1, [{key, value}]))
37 @spec get_by_params(map()) :: ConfigDB.t() | nil
38 def get_by_params(params), do: Repo.get_by(ConfigDB, params)
40 @spec changeset(ConfigDB.t(), map()) :: Changeset.t()
41 def changeset(config, params \\ %{}) do
42 params = Map.put(params, :value, transform(params[:value]))
45 |> cast(params, [:key, :group, :value])
46 |> validate_required([:key, :group, :value])
47 |> unique_constraint(:key, name: :config_group_key_index)
50 @spec create(map()) :: {:ok, ConfigDB.t()} | {:error, Changeset.t()}
57 @spec update(ConfigDB.t(), map()) :: {:ok, ConfigDB.t()} | {:error, Changeset.t()}
58 def update(%ConfigDB{} = config, %{value: value}) do
60 |> changeset(%{value: value})
65 {:pleroma, :ecto_repos},
69 {:cors_plug, [:max_age, :methods, :expose, :headers]},
70 {:auto_linker, :opts},
71 {:swarm, :node_blacklist},
75 defp only_full_update?(%ConfigDB{} = config) do
76 config_group = ConfigDB.from_string(config.group)
77 config_key = ConfigDB.from_string(config.key)
79 Enum.any?(@full_key_update, fn
80 {group, key} when is_list(key) ->
81 config_group == group and config_key in key
84 config_group == group and config_key == key
88 defp can_be_partially_updated?(%ConfigDB{} = config), do: not only_full_update?(config)
90 @spec update_or_create(map()) :: {:ok, ConfigDB.t()} | {:error, Changeset.t()}
91 def update_or_create(params) do
92 search_opts = Map.take(params, [:group, :key])
94 with %ConfigDB{} = config <- ConfigDB.get_by_params(search_opts),
95 {:partial_update, true, config} <-
96 {:partial_update, can_be_partially_updated?(config), config},
97 old_value <- from_binary(config.value),
98 transformed_value <- do_transform(params[:value]),
99 {:can_be_merged, true, config} <- {:can_be_merged, is_list(transformed_value), config},
100 new_value <- DeepMerge.deep_merge(old_value, transformed_value) do
101 ConfigDB.update(config, %{value: new_value, transformed?: true})
103 {reason, false, config} when reason in [:partial_update, :can_be_merged] ->
104 ConfigDB.update(config, params)
107 ConfigDB.create(params)
111 @spec delete(map()) :: {:ok, ConfigDB.t()} | {:error, Changeset.t()} | {:ok, nil}
112 def delete(params) do
113 search_opts = Map.delete(params, :subkeys)
115 with %ConfigDB{} = config <- ConfigDB.get_by_params(search_opts),
116 {config, sub_keys} when is_list(sub_keys) <- {config, params[:subkeys]},
117 old_value <- from_binary(config.value),
118 keys <- Enum.map(sub_keys, &do_transform_string(&1)),
119 new_value <- Keyword.drop(old_value, keys) do
120 ConfigDB.update(config, %{value: new_value})
128 dgettext("errors", "Config with params %{params} not found", params: inspect(params))
134 @spec from_binary(binary()) :: term()
135 def from_binary(binary), do: :erlang.binary_to_term(binary)
137 @spec from_binary_with_convert(binary()) :: any()
138 def from_binary_with_convert(binary) do
144 @spec from_string(String.t()) :: atom() | no_return()
145 def from_string(":" <> entity), do: String.to_existing_atom(entity)
147 def from_string(entity) when is_binary(entity) do
148 if is_module_name?(entity) do
149 String.to_existing_atom("Elixir.#{entity}")
155 @spec convert(any()) :: any()
156 def convert(entity), do: do_convert(entity)
158 defp do_convert(entity) when is_list(entity) do
159 for v <- entity, into: [], do: do_convert(v)
162 defp do_convert(%Regex{} = entity), do: inspect(entity)
164 defp do_convert(entity) when is_map(entity) do
165 for {k, v} <- entity, into: %{}, do: {do_convert(k), do_convert(v)}
168 defp do_convert({:proxy_url, {type, :localhost, port}}) do
169 %{"tuple" => [":proxy_url", %{"tuple" => [do_convert(type), "localhost", port]}]}
172 defp do_convert({:proxy_url, {type, host, port}}) when is_tuple(host) do
175 |> :inet_parse.ntoa()
181 %{"tuple" => [do_convert(type), ip, port]}
186 defp do_convert({:proxy_url, {type, host, port}}) do
190 %{"tuple" => [do_convert(type), to_string(host), port]}
195 defp do_convert({:dispatch, [entity]}), do: %{"tuple" => [":dispatch", [inspect(entity)]]}
196 # TODO: will become useless after removing hackney
197 defp do_convert({:partial_chain, entity}), do: %{"tuple" => [":partial_chain", inspect(entity)]}
199 defp do_convert(entity) when is_tuple(entity),
200 do: %{"tuple" => do_convert(Tuple.to_list(entity))}
202 defp do_convert(entity) when is_boolean(entity) or is_number(entity) or is_nil(entity),
205 defp do_convert(entity)
206 when is_atom(entity) and entity in [:"tlsv1.1", :"tlsv1.2", :"tlsv1.3"] do
207 ":#{to_string(entity)}"
210 defp do_convert(entity) when is_atom(entity), do: inspect(entity)
212 defp do_convert(entity) when is_binary(entity), do: entity
214 @spec transform(any()) :: binary() | no_return()
215 def transform(entity) when is_binary(entity) or is_map(entity) or is_list(entity) do
221 def transform(entity), do: to_binary(entity)
223 @spec to_binary(any()) :: binary()
224 def to_binary(entity), do: :erlang.term_to_binary(entity)
226 defp do_transform(%Regex{} = entity), do: entity
228 defp do_transform(%{"tuple" => [":proxy_url", %{"tuple" => [type, host, port]}]}) do
229 {:proxy_url, {do_transform_string(type), parse_host(host), port}}
232 defp do_transform(%{"tuple" => [":dispatch", [entity]]}) do
233 {dispatch_settings, []} = do_eval(entity)
234 {:dispatch, [dispatch_settings]}
237 # TODO: will become useless after removing hackney
238 defp do_transform(%{"tuple" => [":partial_chain", entity]}) do
239 {partial_chain, []} = do_eval(entity)
240 {:partial_chain, partial_chain}
243 defp do_transform(%{"tuple" => entity}) do
244 Enum.reduce(entity, {}, fn val, acc -> Tuple.append(acc, do_transform(val)) end)
247 defp do_transform(entity) when is_map(entity) do
248 for {k, v} <- entity, into: %{}, do: {do_transform(k), do_transform(v)}
251 defp do_transform(entity) when is_list(entity) do
252 for v <- entity, into: [], do: do_transform(v)
255 defp do_transform(entity) when is_binary(entity) do
258 |> do_transform_string()
261 defp do_transform(entity), do: entity
263 defp parse_host("localhost"), do: :localhost
265 defp parse_host(host) do
266 charlist = to_charlist(host)
268 case :inet.parse_address(charlist) do
277 @delimiters ["/", "|", "\"", "'", {"(", ")"}, {"[", "]"}, {"{", "}"}, {"<", ">"}]
279 defp find_valid_delimiter([], _string, _),
280 do: raise(ArgumentError, message: "valid delimiter for Regex expression not found")
282 defp find_valid_delimiter([{leading, closing} = delimiter | others], pattern, regex_delimiter)
283 when is_tuple(delimiter) do
284 if String.contains?(pattern, closing) do
285 find_valid_delimiter(others, pattern, regex_delimiter)
287 {:ok, {leading, closing}}
291 defp find_valid_delimiter([delimiter | others], pattern, regex_delimiter) do
292 if String.contains?(pattern, delimiter) do
293 find_valid_delimiter(others, pattern, regex_delimiter)
295 {:ok, {delimiter, delimiter}}
299 @regex_parts ~r/^~r(?'delimiter'[\/|"'([{<]{1})(?'pattern'.+)[\/|"')\]}>]{1}(?'modifier'[uismxfU]*)/u
301 defp do_transform_string("~r" <> _pattern = regex) do
302 with %{"modifier" => modifier, "pattern" => pattern, "delimiter" => regex_delimiter} <-
303 Regex.named_captures(@regex_parts, regex),
304 {:ok, {leading, closing}} <- find_valid_delimiter(@delimiters, pattern, regex_delimiter),
305 {result, _} <- Code.eval_string("~r#{leading}#{pattern}#{closing}#{modifier}") do
310 defp do_transform_string(":" <> atom), do: String.to_atom(atom)
312 defp do_transform_string(value) do
313 if is_module_name?(value) do
314 String.to_existing_atom("Elixir." <> value)
320 @spec is_module_name?(String.t()) :: boolean()
321 def is_module_name?(string) do
322 Regex.match?(~r/^(Pleroma|Phoenix|Tesla|Quack)\./, string) or
323 string in ["Oban", "Ueberauth", "ExSyslogger"]
326 defp do_eval(entity) do
327 cleaned_string = String.replace(entity, ~r/[^\w|^{:,[|^,|^[|^\]^}|^\/|^\.|^"]^\s/, "")
328 Code.eval_string(cleaned_string)