git.squeep.com Git - akkoma/blob - lib/pleroma/config/config_db.ex

   1 # Pleroma: A lightweight social networking server
   2 # Copyright © 2017-2019 Pleroma Authors <https://pleroma.social/>
   3 # SPDX-License-Identifier: AGPL-3.0-only
   4
   5 defmodule Pleroma.ConfigDB do
   6   use Ecto.Schema
   7   import Ecto.Changeset
   8   import Ecto.Query
   9   import Pleroma.Web.Gettext
  10   alias __MODULE__
  11   alias Pleroma.Repo
  12
  13   @type t :: %__MODULE__{}
  14
  15   schema "config" do
  16     field(:key, :string)
  17     field(:group, :string)
  18     field(:value, :binary)
  19     field(:db, {:array, :string}, virtual: true, default: [])
  20
  21     timestamps()
  22   end
  23
  24   @spec get_all_as_keyword() :: keyword()
  25   def get_all_as_keyword do
  26     ConfigDB
  27     |> select([c], {c.group, c.key, c.value})
  28     |> Repo.all()
  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)
  33
  34       Keyword.update(acc, group, [{key, value}], &Keyword.merge(&1, [{key, value}]))
  35     end)
  36   end
  37
  38   @spec get_by_params(map()) :: ConfigDB.t() | nil
  39   def get_by_params(params), do: Repo.get_by(ConfigDB, params)
  40
  41   @spec changeset(ConfigDB.t(), map()) :: Changeset.t()
  42   def changeset(config, params \\ %{}) do
  43     params = Map.put(params, :value, transform(params[:value]))
  44
  45     config
  46     |> cast(params, [:key, :group, :value])
  47     |> validate_required([:key, :group, :value])
  48     |> unique_constraint(:key, name: :config_group_key_index)
  49   end
  50
  51   @spec create(map()) :: {:ok, ConfigDB.t()} | {:error, Changeset.t()}
  52   def create(params) do
  53     %ConfigDB{}
  54     |> changeset(params)
  55     |> Repo.insert()
  56   end
  57
  58   @spec update(ConfigDB.t(), map()) :: {:ok, ConfigDB.t()} | {:error, Changeset.t()}
  59   def update(%ConfigDB{} = config, %{value: value}) do
  60     config
  61     |> changeset(%{value: value})
  62     |> Repo.update()
  63   end
  64
  65   @spec get_db_keys(ConfigDB.t()) :: [String.t()]
  66   def get_db_keys(%ConfigDB{} = config) do
  67     config.value
  68     |> ConfigDB.from_binary()
  69     |> get_db_keys(config.key)
  70   end
  71
  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))
  76     else
  77       [convert(key)]
  78     end
  79   end
  80
  81   @full_subkey_update [
  82     {:pleroma, :assets, :mascots},
  83     {:pleroma, :emoji, :groups},
  84     {:pleroma, :workers, :retries},
  85     {:pleroma, :mrf_subchain, :match_actor},
  86     {:pleroma, :mrf_keyword, :replace}
  87   ]
  88
  89   @spec deep_merge(atom(), atom(), keyword(), keyword()) :: keyword()
  90   def deep_merge(group, key, old_value, new_value) do
  91     old_keys =
  92       old_value
  93       |> Keyword.keys()
  94       |> MapSet.new()
  95
  96     new_keys =
  97       new_value
  98       |> Keyword.keys()
  99       |> MapSet.new()
 100
 101     intersect_keys = old_keys |> MapSet.intersection(new_keys) |> MapSet.to_list()
 102
 103     subkeys = sub_key_full_update(group, key, intersect_keys)
 104
 105     merged_value = ConfigDB.merge(old_value, new_value)
 106
 107     Enum.reduce(subkeys, merged_value, fn subkey, acc ->
 108       Keyword.put(acc, subkey, new_value[subkey])
 109     end)
 110   end
 111
 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
 116     end)
 117   end
 118
 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: []
 123
 124       _ ->
 125         []
 126     end)
 127     |> List.flatten()
 128   end
 129
 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)
 134       else
 135         app2
 136       end
 137     end)
 138   end
 139
 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)
 143     else
 144       value2
 145     end
 146   end
 147
 148   @full_key_update [
 149     {:pleroma, :ecto_repos},
 150     {:quack, :meta},
 151     {:mime, :types},
 152     {:cors_plug, [:max_age, :methods, :expose, :headers]},
 153     {:auto_linker, :opts},
 154     {:swarm, :node_blacklist},
 155     {:logger, :backends}
 156   ]
 157
 158   defp only_full_update?(%ConfigDB{} = config) do
 159     config_group = ConfigDB.from_string(config.group)
 160     config_key = ConfigDB.from_string(config.key)
 161
 162     Enum.any?(@full_key_update, fn
 163       {group, key} when is_list(key) ->
 164         config_group == group and config_key in key
 165
 166       {group, key} ->
 167         config_group == group and config_key == key
 168     end)
 169   end
 170
 171   defp can_be_partially_updated?(%ConfigDB{} = config), do: not only_full_update?(config)
 172
 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])
 176
 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},
 183          new_value <-
 184            deep_merge(
 185              ConfigDB.from_string(config.group),
 186              ConfigDB.from_string(config.key),
 187              old_value,
 188              transformed_value
 189            ) do
 190       ConfigDB.update(config, %{value: new_value})
 191     else
 192       {reason, false, config} when reason in [:partial_update, :can_be_merged] ->
 193         ConfigDB.update(config, params)
 194
 195       nil ->
 196         ConfigDB.create(params)
 197     end
 198   end
 199
 200   @spec delete(map()) :: {:ok, ConfigDB.t()} | {:error, Changeset.t()} | {:ok, nil}
 201   def delete(params) do
 202     search_opts = Map.delete(params, :subkeys)
 203
 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})
 210     else
 211       {config, nil} ->
 212         Repo.delete(config)
 213         {:ok, nil}
 214
 215       nil ->
 216         err =
 217           dgettext("errors", "Config with params %{params} not found", params: inspect(params))
 218
 219         {:error, err}
 220     end
 221   end
 222
 223   @spec from_binary(binary()) :: term()
 224   def from_binary(binary), do: :erlang.binary_to_term(binary)
 225
 226   @spec from_binary_with_convert(binary()) :: any()
 227   def from_binary_with_convert(binary) do
 228     binary
 229     |> from_binary()
 230     |> do_convert()
 231   end
 232
 233   @spec from_string(String.t()) :: atom() | no_return()
 234   def from_string(":" <> entity), do: String.to_existing_atom(entity)
 235
 236   def from_string(entity) when is_binary(entity) do
 237     if is_module_name?(entity) do
 238       String.to_existing_atom("Elixir.#{entity}")
 239     else
 240       entity
 241     end
 242   end
 243
 244   @spec convert(any()) :: any()
 245   def convert(entity), do: do_convert(entity)
 246
 247   defp do_convert(entity) when is_list(entity) do
 248     for v <- entity, into: [], do: do_convert(v)
 249   end
 250
 251   defp do_convert(%Regex{} = entity), do: inspect(entity)
 252
 253   defp do_convert(entity) when is_map(entity) do
 254     for {k, v} <- entity, into: %{}, do: {do_convert(k), do_convert(v)}
 255   end
 256
 257   defp do_convert({:proxy_url, {type, :localhost, port}}) do
 258     %{"tuple" => [":proxy_url", %{"tuple" => [do_convert(type), "localhost", port]}]}
 259   end
 260
 261   defp do_convert({:proxy_url, {type, host, port}}) when is_tuple(host) do
 262     ip =
 263       host
 264       |> :inet_parse.ntoa()
 265       |> to_string()
 266
 267     %{
 268       "tuple" => [
 269         ":proxy_url",
 270         %{"tuple" => [do_convert(type), ip, port]}
 271       ]
 272     }
 273   end
 274
 275   defp do_convert({:proxy_url, {type, host, port}}) do
 276     %{
 277       "tuple" => [
 278         ":proxy_url",
 279         %{"tuple" => [do_convert(type), to_string(host), port]}
 280       ]
 281     }
 282   end
 283
 284   # TODO: will become useless after removing hackney
 285   defp do_convert({:partial_chain, entity}), do: %{"tuple" => [":partial_chain", inspect(entity)]}
 286
 287   defp do_convert(entity) when is_tuple(entity),
 288     do: %{"tuple" => do_convert(Tuple.to_list(entity))}
 289
 290   defp do_convert(entity) when is_boolean(entity) or is_number(entity) or is_nil(entity),
 291     do: entity
 292
 293   defp do_convert(entity)
 294        when is_atom(entity) and entity in [:"tlsv1.1", :"tlsv1.2", :"tlsv1.3"] do
 295     ":#{to_string(entity)}"
 296   end
 297
 298   defp do_convert(entity) when is_atom(entity), do: inspect(entity)
 299
 300   defp do_convert(entity) when is_binary(entity), do: entity
 301
 302   @spec transform(any()) :: binary() | no_return()
 303   def transform(entity) when is_binary(entity) or is_map(entity) or is_list(entity) do
 304     entity
 305     |> do_transform()
 306     |> to_binary()
 307   end
 308
 309   def transform(entity), do: to_binary(entity)
 310
 311   @spec transform_with_out_binary(any()) :: any()
 312   def transform_with_out_binary(entity), do: do_transform(entity)
 313
 314   @spec to_binary(any()) :: binary()
 315   def to_binary(entity), do: :erlang.term_to_binary(entity)
 316
 317   defp do_transform(%Regex{} = entity), do: entity
 318
 319   defp do_transform(%{"tuple" => [":proxy_url", %{"tuple" => [type, host, port]}]}) do
 320     {:proxy_url, {do_transform_string(type), parse_host(host), port}}
 321   end
 322
 323   # TODO: will become useless after removing hackney
 324   defp do_transform(%{"tuple" => [":partial_chain", entity]}) do
 325     {partial_chain, []} =
 326       entity
 327       |> String.replace(~r/[^\w|^{:,[|^,|^[|^\]^}|^\/|^\.|^"]^\s/, "")
 328       |> Code.eval_string()
 329
 330     {:partial_chain, partial_chain}
 331   end
 332
 333   defp do_transform(%{"tuple" => entity}) do
 334     Enum.reduce(entity, {}, fn val, acc -> Tuple.append(acc, do_transform(val)) end)
 335   end
 336
 337   defp do_transform(entity) when is_map(entity) do
 338     for {k, v} <- entity, into: %{}, do: {do_transform(k), do_transform(v)}
 339   end
 340
 341   defp do_transform(entity) when is_list(entity) do
 342     for v <- entity, into: [], do: do_transform(v)
 343   end
 344
 345   defp do_transform(entity) when is_binary(entity) do
 346     entity
 347     |> String.trim()
 348     |> do_transform_string()
 349   end
 350
 351   defp do_transform(entity), do: entity
 352
 353   defp parse_host("localhost"), do: :localhost
 354
 355   defp parse_host(host) do
 356     charlist = to_charlist(host)
 357
 358     case :inet.parse_address(charlist) do
 359       {:error, :einval} ->
 360         charlist
 361
 362       {:ok, ip} ->
 363         ip
 364     end
 365   end
 366
 367   @delimiters ["/", "|", "\"", "'", {"(", ")"}, {"[", "]"}, {"{", "}"}, {"<", ">"}]
 368
 369   defp find_valid_delimiter([], _string, _),
 370     do: raise(ArgumentError, message: "valid delimiter for Regex expression not found")
 371
 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)
 376     else
 377       {:ok, {leading, closing}}
 378     end
 379   end
 380
 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)
 384     else
 385       {:ok, {delimiter, delimiter}}
 386     end
 387   end
 388
 389   @regex_parts ~r/^~r(?'delimiter'[\/|"'([{<]{1})(?'pattern'.+)[\/|"')\]}>]{1}(?'modifier'[uismxfU]*)/u
 390
 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
 396       result
 397     end
 398   end
 399
 400   defp do_transform_string(":" <> atom), do: String.to_atom(atom)
 401
 402   defp do_transform_string(value) do
 403     if is_module_name?(value) do
 404       String.to_existing_atom("Elixir." <> value)
 405     else
 406       value
 407     end
 408   end
 409
 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"]
 414   end
 415 end