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.Web.AdminAPI.Config do
8 import Pleroma.Web.Gettext
12 @type t :: %__MODULE__{}
16 field(:group, :string)
17 field(:value, :binary)
22 @spec get_by_params(map()) :: Config.t() | nil
23 def get_by_params(params), do: Repo.get_by(Config, params)
25 @spec changeset(Config.t(), map()) :: Changeset.t()
26 def changeset(config, params \\ %{}) do
27 params = Map.put(params, :value, transform(params[:value]))
30 |> cast(params, [:key, :group, :value])
31 |> validate_required([:key, :group, :value])
32 |> unique_constraint(:key, name: :config_group_key_index)
35 @spec create(map()) :: {:ok, Config.t()} | {:error, Changeset.t()}
42 @spec update(Config.t(), map()) :: {:ok, Config} | {:error, Changeset.t()}
43 def update(%Config{} = config, %{value: value}) do
45 |> changeset(%{value: value})
50 {:pleroma, :ecto_repos},
54 {:cors_plug, [:max_age, :methods, :expose, :headers]},
55 {:auto_linker, :opts},
56 {:swarm, :node_blacklist},
60 defp only_full_update?(%Config{} = config) do
61 config_group = Config.from_string(config.group)
62 config_key = Config.from_string(config.key)
64 Enum.any?(@full_key_update, fn
65 {group, key} when is_list(key) ->
66 config_group == group and config_key in key
69 config_group == group and config_key == key
73 defp can_be_partially_updated?(%Config{} = config), do: not only_full_update?(config)
75 @spec update_or_create(map()) :: {:ok, Config.t()} | {:error, Changeset.t()}
76 def update_or_create(params) do
77 search_opts = Map.take(params, [:group, :key])
79 with %Config{} = config <- Config.get_by_params(search_opts),
80 {:partial_update, true, config} <-
81 {:partial_update, can_be_partially_updated?(config), config},
82 old_value <- from_binary(config.value),
83 transformed_value <- do_transform(params[:value]),
84 {:can_be_merged, true, config} <- {:can_be_merged, is_list(transformed_value), config},
85 new_value <- DeepMerge.deep_merge(old_value, transformed_value) do
86 Config.update(config, %{value: new_value, transformed?: true})
88 {reason, false, config} when reason in [:partial_update, :can_be_merged] ->
89 Config.update(config, params)
96 @spec delete(map()) :: {:ok, Config.t()} | {:error, Changeset.t()} | {:ok, nil}
98 search_opts = Map.delete(params, :subkeys)
100 with %Config{} = config <- Config.get_by_params(search_opts),
101 {config, sub_keys} when is_list(sub_keys) <- {config, params[:subkeys]},
102 old_value <- from_binary(config.value),
103 keys <- Enum.map(sub_keys, &do_transform_string(&1)),
104 new_value <- Keyword.drop(old_value, keys) do
105 Config.update(config, %{value: new_value})
113 dgettext("errors", "Config with params %{params} not found", params: inspect(params))
119 @spec from_binary(binary()) :: term()
120 def from_binary(binary), do: :erlang.binary_to_term(binary)
122 @spec from_binary_with_convert(binary()) :: any()
123 def from_binary_with_convert(binary) do
129 @spec from_string(String.t()) :: atom() | no_return()
130 def from_string(":" <> entity), do: String.to_existing_atom(entity)
132 def from_string(entity) when is_binary(entity) do
133 if is_module_name?(entity) do
134 String.to_existing_atom("Elixir.#{entity}")
140 defp do_convert(entity) when is_list(entity) do
141 for v <- entity, into: [], do: do_convert(v)
144 defp do_convert(%Regex{} = entity), do: inspect(entity)
146 defp do_convert(entity) when is_map(entity) do
147 for {k, v} <- entity, into: %{}, do: {do_convert(k), do_convert(v)}
150 defp do_convert({:proxy_url, {type, :localhost, port}}) do
151 %{"tuple" => [":proxy_url", %{"tuple" => [do_convert(type), "localhost", port]}]}
154 defp do_convert({:proxy_url, {type, host, port}}) when is_tuple(host) do
157 |> :inet_parse.ntoa()
163 %{"tuple" => [do_convert(type), ip, port]}
168 defp do_convert({:proxy_url, {type, host, port}}) do
172 %{"tuple" => [do_convert(type), to_string(host), port]}
177 defp do_convert({:dispatch, [entity]}), do: %{"tuple" => [":dispatch", [inspect(entity)]]}
178 # TODO: will become useless after removing hackney
179 defp do_convert({:partial_chain, entity}), do: %{"tuple" => [":partial_chain", inspect(entity)]}
181 defp do_convert(entity) when is_tuple(entity),
182 do: %{"tuple" => do_convert(Tuple.to_list(entity))}
184 defp do_convert(entity) when is_boolean(entity) or is_number(entity) or is_nil(entity),
187 defp do_convert(entity)
188 when is_atom(entity) and entity in [:"tlsv1.1", :"tlsv1.2", :"tlsv1.3"] do
189 ":#{to_string(entity)}"
192 defp do_convert(entity) when is_atom(entity), do: inspect(entity)
194 defp do_convert(entity) when is_binary(entity), do: entity
196 @spec transform(any()) :: binary() | no_return()
197 def transform(entity) when is_binary(entity) or is_map(entity) or is_list(entity) do
203 def transform(entity), do: to_binary(entity)
205 @spec to_binary(any()) :: binary()
206 def to_binary(entity), do: :erlang.term_to_binary(entity)
208 defp do_transform(%Regex{} = entity), do: entity
210 defp do_transform(%{"tuple" => [":proxy_url", %{"tuple" => [type, host, port]}]}) do
211 {:proxy_url, {do_transform_string(type), parse_host(host), port}}
214 defp do_transform(%{"tuple" => [":dispatch", [entity]]}) do
215 {dispatch_settings, []} = do_eval(entity)
216 {:dispatch, [dispatch_settings]}
219 # TODO: will become useless after removing hackney
220 defp do_transform(%{"tuple" => [":partial_chain", entity]}) do
221 {partial_chain, []} = do_eval(entity)
222 {:partial_chain, partial_chain}
225 defp do_transform(%{"tuple" => entity}) do
226 Enum.reduce(entity, {}, fn val, acc -> Tuple.append(acc, do_transform(val)) end)
229 defp do_transform(entity) when is_map(entity) do
230 for {k, v} <- entity, into: %{}, do: {do_transform(k), do_transform(v)}
233 defp do_transform(entity) when is_list(entity) do
234 for v <- entity, into: [], do: do_transform(v)
237 defp do_transform(entity) when is_binary(entity) do
240 |> do_transform_string()
243 defp do_transform(entity), do: entity
245 defp parse_host("localhost"), do: :localhost
247 defp parse_host(host) do
248 charlist = to_charlist(host)
250 case :inet.parse_address(charlist) do
259 @delimiters ["/", "|", "\"", "'", {"(", ")"}, {"[", "]"}, {"{", "}"}, {"<", ">"}]
261 defp find_valid_delimiter([], _string, _),
262 do: raise(ArgumentError, message: "valid delimiter for Regex expression not found")
264 defp find_valid_delimiter([{leading, closing} = delimiter | others], pattern, regex_delimiter)
265 when is_tuple(delimiter) do
266 if String.contains?(pattern, closing) do
267 find_valid_delimiter(others, pattern, regex_delimiter)
269 {:ok, {leading, closing}}
273 defp find_valid_delimiter([delimiter | others], pattern, regex_delimiter) do
274 if String.contains?(pattern, delimiter) do
275 find_valid_delimiter(others, pattern, regex_delimiter)
277 {:ok, {delimiter, delimiter}}
281 @regex_parts ~r/^~r(?'delimiter'[\/|"'([{<]{1})(?'pattern'.+)[\/|"')\]}>]{1}(?'modifier'[uismxfU]*)/u
283 defp do_transform_string("~r" <> _pattern = regex) do
284 with %{"modifier" => modifier, "pattern" => pattern, "delimiter" => regex_delimiter} <-
285 Regex.named_captures(@regex_parts, regex),
286 {:ok, {leading, closing}} <- find_valid_delimiter(@delimiters, pattern, regex_delimiter),
287 {result, _} <- Code.eval_string("~r#{leading}#{pattern}#{closing}#{modifier}") do
292 defp do_transform_string(":" <> atom), do: String.to_atom(atom)
294 defp do_transform_string(value) do
295 if is_module_name?(value) do
296 String.to_existing_atom("Elixir." <> value)
302 @spec is_module_name?(String.t()) :: boolean()
303 def is_module_name?(string) do
304 Regex.match?(~r/^(Pleroma|Phoenix|Tesla|Quack)\./, string) or
305 string in ["Oban", "Ueberauth", "ExSyslogger"]
308 defp do_eval(entity) do
309 cleaned_string = String.replace(entity, ~r/[^\w|^{:,[|^,|^[|^\]^}|^\/|^\.|^"]^\s/, "")
310 Code.eval_string(cleaned_string)