git.squeep.com Git - akkoma/blob - lib/pleroma/http/adapter_helper.ex

   1 # Pleroma: A lightweight social networking server
   2 # Copyright © 2017-2021 Pleroma Authors <https://pleroma.social/>
   3 # SPDX-License-Identifier: AGPL-3.0-only
   4
   5 defmodule Pleroma.HTTP.AdapterHelper do
   6   @moduledoc """
   7   Configure Tesla.Client with default and customized adapter options.
   8   """
   9   @defaults [name: MyFinch, pool_timeout: 5_000, receive_timeout: 5_000]
  10
  11   @type proxy_type() :: :socks4 | :socks5
  12   @type host() :: charlist() | :inet.ip_address()
  13
  14   alias Pleroma.HTTP.AdapterHelper
  15   require Logger
  16
  17   @type proxy :: {Connection.proxy_type(), Connection.host(), pos_integer(), list()}
  18
  19   @callback options(keyword(), URI.t()) :: keyword()
  20
  21   @spec format_proxy(String.t() | tuple() | nil) :: proxy() | nil
  22   def format_proxy(nil), do: nil
  23
  24   def format_proxy(proxy_url) do
  25     case parse_proxy(proxy_url) do
  26       {:ok, type, host, port} -> {type, host, port, []}
  27       _ -> nil
  28     end
  29   end
  30
  31   @spec maybe_add_proxy(keyword(), proxy() | nil) :: keyword()
  32   def maybe_add_proxy(opts, nil), do: opts
  33
  34   def maybe_add_proxy(opts, proxy) do
  35     Keyword.put(opts, :proxy, proxy)
  36   end
  37
  38   def maybe_add_proxy_pool(opts, nil), do: opts
  39
  40   def maybe_add_proxy_pool(opts, proxy) do
  41     Logger.info("Using HTTP Proxy: #{inspect(proxy)}")
  42
  43     opts
  44     |> maybe_add_pools()
  45     |> maybe_add_default_pool()
  46     |> maybe_add_conn_opts()
  47     |> put_in([:pools, :default, :conn_opts, :proxy], proxy)
  48   end
  49
  50   defp maybe_add_pools(opts) do
  51     if Keyword.has_key?(opts, :pools) do
  52       opts
  53     else
  54       Keyword.put(opts, :pools, %{})
  55     end
  56   end
  57
  58   defp maybe_add_default_pool(opts) do
  59     pools = Keyword.get(opts, :pools)
  60
  61     if Map.has_key?(pools, :default) do
  62       opts
  63     else
  64       put_in(opts, [:pools, :default], [])
  65     end
  66   end
  67
  68   defp maybe_add_conn_opts(opts) do
  69     conn_opts = get_in(opts, [:pools, :default, :conn_opts])
  70
  71     unless is_nil(conn_opts) do
  72       opts
  73     else
  74       put_in(opts, [:pools, :default, :conn_opts], [])
  75     end
  76   end
  77
  78   @doc """
  79   Merge default connection & adapter options with received ones.
  80   """
  81
  82   @spec options(URI.t(), keyword()) :: keyword()
  83   def options(%URI{} = uri, opts \\ []) do
  84     @defaults
  85     |> Keyword.merge(opts)
  86     |> AdapterHelper.Default.options(uri)
  87   end
  88
  89   defp proxy_type("http"), do: {:ok, :http}
  90   defp proxy_type("https"), do: {:ok, :https}
  91   defp proxy_type(_), do: {:error, :unknown}
  92
  93   @spec parse_proxy(String.t() | tuple() | nil) ::
  94           {:ok, proxy_type(), host(), pos_integer()}
  95           | {:error, atom()}
  96           | nil
  97   def parse_proxy(nil), do: nil
  98   def parse_proxy(""), do: nil
  99
 100   def parse_proxy(proxy) when is_binary(proxy) do
 101     with %URI{} = uri <- URI.parse(proxy),
 102          {:ok, type} <- proxy_type(uri.scheme) do
 103       {:ok, type, uri.host, uri.port}
 104     else
 105       e ->
 106         Logger.warn("Parsing proxy failed #{inspect(proxy)}, #{inspect(e)}")
 107         {:error, :invalid_proxy}
 108     end
 109   end
 110
 111   def parse_proxy(proxy) when is_tuple(proxy) do
 112     with {type, host, port} <- proxy do
 113       {:ok, type, host, port}
 114     else
 115       _ ->
 116         Logger.warn("Parsing proxy failed #{inspect(proxy)}")
 117         {:error, :invalid_proxy}
 118     end
 119   end
 120
 121   @spec parse_host(String.t() | atom() | charlist()) :: charlist() | :inet.ip_address()
 122   def parse_host(host) when is_list(host), do: host
 123   def parse_host(host) when is_atom(host), do: to_charlist(host)
 124
 125   def parse_host(host) when is_binary(host) do
 126     host = to_charlist(host)
 127
 128     case :inet.parse_address(host) do
 129       {:error, :einval} -> host
 130       {:ok, ip} -> ip
 131     end
 132   end
 133
 134   @spec format_host(String.t()) :: charlist()
 135   def format_host(host) do
 136     host_charlist = to_charlist(host)
 137
 138     case :inet.parse_address(host_charlist) do
 139       {:error, :einval} ->
 140         :idna.encode(host_charlist)
 141
 142       {:ok, _ip} ->
 143         host_charlist
 144     end
 145   end
 146 end