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
18 {Connection.host(), pos_integer()}
19 | {Connection.proxy_type(), Connection.host(), pos_integer()}
21 @callback options(keyword(), URI.t()) :: keyword()
23 @spec format_proxy(String.t() | tuple() | nil) :: proxy() | nil
24 def format_proxy(nil), do: nil
26 def format_proxy(proxy_url) do
27 case parse_proxy(proxy_url) do
28 {:ok, host, port} -> {:http, host, port, []}
29 {:ok, type, host, port} -> {type, host, port, []}
34 @spec maybe_add_proxy(keyword(), proxy() | nil) :: keyword()
35 def maybe_add_proxy(opts, nil), do: opts
37 def maybe_add_proxy(opts, proxy) do
38 Keyword.put(opts, :proxy, proxy)
41 def maybe_add_proxy_pool(opts, nil), do: opts
43 def maybe_add_proxy_pool(opts, proxy) do
44 Logger.info("Using HTTP Proxy: #{inspect(proxy)}")
48 |> maybe_add_default_pool()
49 |> maybe_add_conn_opts()
50 |> put_in([:pools, :default, :conn_opts, :proxy], proxy)
53 defp maybe_add_pools(opts) do
54 if Keyword.has_key?(opts, :pools) do
57 Keyword.put(opts, :pools, %{})
61 defp maybe_add_default_pool(opts) do
62 pools = Keyword.get(opts, :pools)
64 if Map.has_key?(pools, :default) do
67 put_in(opts, [:pools, :default], [])
71 defp maybe_add_conn_opts(opts) do
72 conn_opts = get_in(opts, [:pools, :default, :conn_opts])
74 unless is_nil(conn_opts) do
77 put_in(opts, [:pools, :default, :conn_opts], [])
82 Merge default connection & adapter options with received ones.
85 @spec options(URI.t(), keyword()) :: keyword()
86 def options(%URI{} = uri, opts \\ []) do
88 |> Keyword.merge(opts)
89 |> AdapterHelper.Default.options(uri)
92 defp proxy_type("http"), do: {:ok, :http}
93 defp proxy_type("https"), do: {:ok, :https}
94 defp proxy_type(_), do: {:error, :unknown}
96 @spec parse_proxy(String.t() | tuple() | nil) ::
97 {:ok, host(), pos_integer()}
98 | {:ok, proxy_type(), host(), pos_integer()}
101 def parse_proxy(nil), do: nil
102 def parse_proxy(""), do: nil
104 def parse_proxy(proxy) when is_binary(proxy) do
105 with %URI{} = uri <- URI.parse(proxy),
106 {:ok, type} <- proxy_type(uri.scheme) do
107 {:ok, type, uri.host, uri.port}
110 Logger.warn("Parsing proxy failed #{inspect(proxy)}, #{inspect(e)}")
111 {:error, :invalid_proxy}
115 def parse_proxy(proxy) when is_tuple(proxy) do
116 with {type, host, port} <- proxy do
117 {:ok, type, host, port}
120 Logger.warn("Parsing proxy failed #{inspect(proxy)}")
121 {:error, :invalid_proxy}
125 @spec parse_host(String.t() | atom() | charlist()) :: charlist() | :inet.ip_address()
126 def parse_host(host) when is_list(host), do: host
127 def parse_host(host) when is_atom(host), do: to_charlist(host)
129 def parse_host(host) when is_binary(host) do
130 host = to_charlist(host)
132 case :inet.parse_address(host) do
133 {:error, :einval} -> host
138 @spec format_host(String.t()) :: charlist()
139 def format_host(host) do
140 host_charlist = to_charlist(host)
142 case :inet.parse_address(host_charlist) do
144 :idna.encode(host_charlist)