1 # Pleroma: A lightweight social networking server
2 # Copyright © 2017-2021 Pleroma Authors <https://pleroma.social/>
3 # SPDX-License-Identifier: AGPL-3.0-only
5 defmodule Pleroma.HTTP.AdapterHelper do
7 Configure Tesla.Client with default and customized adapter options.
9 @defaults [name: MyFinch, pool_timeout: 5_000, receive_timeout: 5_000]
11 @type proxy_type() :: :socks4 | :socks5
12 @type host() :: charlist() | :inet.ip_address()
14 alias Pleroma.HTTP.AdapterHelper
17 @type proxy :: {Connection.proxy_type(), Connection.host(), pos_integer(), list()}
19 @callback options(keyword(), URI.t()) :: keyword()
21 @spec format_proxy(String.t() | tuple() | nil) :: proxy() | nil
22 def format_proxy(nil), do: nil
24 def format_proxy(proxy_url) do
25 case parse_proxy(proxy_url) do
26 {:ok, type, host, port} -> {type, host, port, []}
31 @spec maybe_add_proxy(keyword(), proxy() | nil) :: keyword()
32 def maybe_add_proxy(opts, nil), do: opts
34 def maybe_add_proxy(opts, proxy) do
35 Keyword.put(opts, :proxy, proxy)
38 def maybe_add_proxy_pool(opts, nil), do: opts
40 def maybe_add_proxy_pool(opts, proxy) do
41 Logger.info("Using HTTP Proxy: #{inspect(proxy)}")
45 |> maybe_add_default_pool()
46 |> maybe_add_conn_opts()
47 |> put_in([:pools, :default, :conn_opts, :proxy], proxy)
50 defp maybe_add_pools(opts) do
51 if Keyword.has_key?(opts, :pools) do
54 Keyword.put(opts, :pools, %{})
58 defp maybe_add_default_pool(opts) do
59 pools = Keyword.get(opts, :pools)
61 if Map.has_key?(pools, :default) do
64 put_in(opts, [:pools, :default], [])
68 defp maybe_add_conn_opts(opts) do
69 conn_opts = get_in(opts, [:pools, :default, :conn_opts])
71 unless is_nil(conn_opts) do
74 put_in(opts, [:pools, :default, :conn_opts], [])
79 Merge default connection & adapter options with received ones.
82 @spec options(URI.t(), keyword()) :: keyword()
83 def options(%URI{} = uri, opts \\ []) do
85 |> Keyword.merge(opts)
86 |> AdapterHelper.Default.options(uri)
89 defp proxy_type("http"), do: {:ok, :http}
90 defp proxy_type("https"), do: {:ok, :https}
91 defp proxy_type(_), do: {:error, :unknown}
93 @spec parse_proxy(String.t() | tuple() | nil) ::
94 {:ok, proxy_type(), host(), pos_integer()}
97 def parse_proxy(nil), do: nil
98 def parse_proxy(""), do: nil
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}
106 Logger.warn("Parsing proxy failed #{inspect(proxy)}, #{inspect(e)}")
107 {:error, :invalid_proxy}
111 def parse_proxy(proxy) when is_tuple(proxy) do
112 with {type, host, port} <- proxy do
113 {:ok, type, host, port}
116 Logger.warn("Parsing proxy failed #{inspect(proxy)}")
117 {:error, :invalid_proxy}
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)
125 def parse_host(host) when is_binary(host) do
126 host = to_charlist(host)
128 case :inet.parse_address(host) do
129 {:error, :einval} -> host
134 @spec format_host(String.t()) :: charlist()
135 def format_host(host) do
136 host_charlist = to_charlist(host)
138 case :inet.parse_address(host_charlist) do
140 :idna.encode(host_charlist)