2018-12-23 20:04:54 +00:00
|
|
|
# Pleroma: A lightweight social networking server
|
2023-01-02 20:38:50 +00:00
|
|
|
# Copyright © 2017-2022 Pleroma Authors <https://pleroma.social/>
|
2018-12-23 20:04:54 +00:00
|
|
|
# SPDX-License-Identifier: AGPL-3.0-only
|
|
|
|
|
2017-12-30 16:35:53 +00:00
|
|
|
defmodule Pleroma.HTTP do
|
2018-12-04 14:51:49 +00:00
|
|
|
@moduledoc """
|
2020-02-11 07:12:57 +00:00
|
|
|
Wrapper for `Tesla.request/2`.
|
2018-12-04 14:51:49 +00:00
|
|
|
"""
|
|
|
|
|
2020-05-05 22:51:10 +00:00
|
|
|
alias Pleroma.HTTP.AdapterHelper
|
2020-02-11 07:12:57 +00:00
|
|
|
alias Pleroma.HTTP.Request
|
2018-12-01 05:26:59 +00:00
|
|
|
alias Pleroma.HTTP.RequestBuilder, as: Builder
|
2020-02-11 07:12:57 +00:00
|
|
|
alias Tesla.Client
|
|
|
|
alias Tesla.Env
|
|
|
|
|
|
|
|
require Logger
|
2018-08-24 20:01:13 +00:00
|
|
|
|
2018-12-29 09:48:54 +00:00
|
|
|
@type t :: __MODULE__
|
2020-06-24 06:12:32 +00:00
|
|
|
@type method() :: :get | :post | :put | :delete | :head
|
2018-12-29 09:48:54 +00:00
|
|
|
|
2018-12-04 14:48:55 +00:00
|
|
|
@doc """
|
2020-02-11 07:12:57 +00:00
|
|
|
Performs GET request.
|
|
|
|
|
|
|
|
See `Pleroma.HTTP.request/5`
|
|
|
|
"""
|
|
|
|
@spec get(Request.url() | nil, Request.headers(), keyword()) ::
|
|
|
|
nil | {:ok, Env.t()} | {:error, any()}
|
|
|
|
def get(url, headers \\ [], options \\ [])
|
|
|
|
def get(nil, _, _), do: nil
|
|
|
|
def get(url, headers, options), do: request(:get, url, "", headers, options)
|
|
|
|
|
2020-06-24 06:12:32 +00:00
|
|
|
@spec head(Request.url(), Request.headers(), keyword()) :: {:ok, Env.t()} | {:error, any()}
|
|
|
|
def head(url, headers \\ [], options \\ []), do: request(:head, url, "", headers, options)
|
|
|
|
|
2020-02-11 07:12:57 +00:00
|
|
|
@doc """
|
|
|
|
Performs POST request.
|
|
|
|
|
|
|
|
See `Pleroma.HTTP.request/5`
|
|
|
|
"""
|
IPFS uploader: dialyzer fixes
lib/pleroma/uploaders/ipfs.ex:43:no_return
Function put_file/1 has no local return.
________________________________________________________________________________
lib/pleroma/uploaders/ipfs.ex:49:call
The function call will not succeed.
Pleroma.HTTP.post(
binary(),
_mp :: %Tesla.Multipart{
:boundary => binary(),
:content_type_params => [binary()],
:parts => [
%Tesla.Multipart.Part{
:body => binary(),
:dispositions => [any()],
:headers => [any()]
},
...
]
},
[],
[{:params, [{:"cid-version", <<49>>}]}]
)
will never return since the success typing is:
(binary(), binary(), [{binary(), binary()}], Keyword.t()) ::
{:error, _}
| {:ok,
%Tesla.Env{
:__client__ => %Tesla.Client{
:adapter => nil | {_, _} | {_, _, _},
:fun => _,
:post => [any()],
:pre => [any()]
},
:__module__ => atom(),
:body => _,
:headers => [{_, _}],
:method => :delete | :get | :head | :options | :patch | :post | :put | :trace,
:opts => [{_, _}],
:query => [{_, _}],
:status => nil | integer(),
:url => binary()
}}
and the contract is
(Pleroma.HTTP.Request.url(), String.t(), Pleroma.HTTP.Request.headers(), :elixir.keyword()) ::
{:ok, Tesla.Env.t()} | {:error, any()}
2024-05-28 17:14:34 +00:00
|
|
|
@spec post(Request.url(), Tesla.Env.body(), Request.headers(), keyword()) ::
|
2020-02-11 07:12:57 +00:00
|
|
|
{:ok, Env.t()} | {:error, any()}
|
|
|
|
def post(url, body, headers \\ [], options \\ []),
|
|
|
|
do: request(:post, url, body, headers, options)
|
|
|
|
|
|
|
|
@doc """
|
|
|
|
Builds and performs http request.
|
2018-12-04 14:51:49 +00:00
|
|
|
|
|
|
|
# Arguments:
|
2020-06-24 06:12:32 +00:00
|
|
|
`method` - :get, :post, :put, :delete, :head
|
2020-02-11 07:12:57 +00:00
|
|
|
`url` - full url
|
|
|
|
`body` - request body
|
2018-12-04 14:51:49 +00:00
|
|
|
`headers` - a keyworld list of headers, e.g. `[{"content-type", "text/plain"}]`
|
|
|
|
`options` - custom, per-request middleware or adapter options
|
|
|
|
|
|
|
|
# Returns:
|
|
|
|
`{:ok, %Tesla.Env{}}` or `{:error, error}`
|
|
|
|
|
2018-12-04 14:48:55 +00:00
|
|
|
"""
|
IPFS uploader: dialyzer fixes
lib/pleroma/uploaders/ipfs.ex:43:no_return
Function put_file/1 has no local return.
________________________________________________________________________________
lib/pleroma/uploaders/ipfs.ex:49:call
The function call will not succeed.
Pleroma.HTTP.post(
binary(),
_mp :: %Tesla.Multipart{
:boundary => binary(),
:content_type_params => [binary()],
:parts => [
%Tesla.Multipart.Part{
:body => binary(),
:dispositions => [any()],
:headers => [any()]
},
...
]
},
[],
[{:params, [{:"cid-version", <<49>>}]}]
)
will never return since the success typing is:
(binary(), binary(), [{binary(), binary()}], Keyword.t()) ::
{:error, _}
| {:ok,
%Tesla.Env{
:__client__ => %Tesla.Client{
:adapter => nil | {_, _} | {_, _, _},
:fun => _,
:post => [any()],
:pre => [any()]
},
:__module__ => atom(),
:body => _,
:headers => [{_, _}],
:method => :delete | :get | :head | :options | :patch | :post | :put | :trace,
:opts => [{_, _}],
:query => [{_, _}],
:status => nil | integer(),
:url => binary()
}}
and the contract is
(Pleroma.HTTP.Request.url(), String.t(), Pleroma.HTTP.Request.headers(), :elixir.keyword()) ::
{:ok, Tesla.Env.t()} | {:error, any()}
2024-05-28 17:14:34 +00:00
|
|
|
@spec request(method(), Request.url(), Tesla.Env.body(), Request.headers(), keyword()) ::
|
2020-02-11 07:12:57 +00:00
|
|
|
{:ok, Env.t()} | {:error, any()}
|
|
|
|
def request(method, url, body, headers, options) when is_binary(url) do
|
2020-03-03 12:11:48 +00:00
|
|
|
uri = URI.parse(url)
|
2020-09-07 13:57:42 +00:00
|
|
|
adapter_opts = AdapterHelper.options(uri, options || [])
|
2020-03-03 12:11:48 +00:00
|
|
|
|
2020-09-03 20:15:22 +00:00
|
|
|
options = put_in(options[:adapter], adapter_opts)
|
|
|
|
params = options[:params] || []
|
|
|
|
request = build_request(method, headers, options, url, body, params)
|
|
|
|
|
|
|
|
adapter = Application.get_env(:tesla, :adapter)
|
|
|
|
|
|
|
|
client = Tesla.client(adapter_middlewares(adapter), adapter)
|
|
|
|
|
|
|
|
maybe_limit(
|
|
|
|
fn ->
|
|
|
|
request(client, request)
|
|
|
|
end,
|
|
|
|
adapter,
|
|
|
|
adapter_opts
|
|
|
|
)
|
2018-08-24 20:01:13 +00:00
|
|
|
end
|
|
|
|
|
2020-03-05 14:31:06 +00:00
|
|
|
@spec request(Client.t(), keyword()) :: {:ok, Env.t()} | {:error, any()}
|
|
|
|
def request(client, request), do: Tesla.request(client, request)
|
2017-12-30 16:35:53 +00:00
|
|
|
|
2020-02-11 07:12:57 +00:00
|
|
|
defp build_request(method, headers, options, url, body, params) do
|
|
|
|
Builder.new()
|
|
|
|
|> Builder.method(method)
|
|
|
|
|> Builder.headers(headers)
|
|
|
|
|> Builder.opts(options)
|
|
|
|
|> Builder.url(url)
|
|
|
|
|> Builder.add_param(:body, :body, body)
|
|
|
|
|> Builder.add_param(:query, :query, params)
|
|
|
|
|> Builder.convert_to_keyword()
|
2017-12-30 16:35:53 +00:00
|
|
|
end
|
2020-05-17 19:16:02 +00:00
|
|
|
|
|
|
|
@prefix Pleroma.Gun.ConnectionPool
|
|
|
|
defp maybe_limit(fun, Tesla.Adapter.Gun, opts) do
|
|
|
|
ConcurrentLimiter.limit(:"#{@prefix}.#{opts[:pool] || :default}", fun)
|
|
|
|
end
|
|
|
|
|
|
|
|
defp maybe_limit(fun, _, _) do
|
|
|
|
fun.()
|
|
|
|
end
|
2020-07-18 11:17:38 +00:00
|
|
|
|
|
|
|
defp adapter_middlewares(Tesla.Adapter.Gun) do
|
2020-09-03 20:15:22 +00:00
|
|
|
[Tesla.Middleware.FollowRedirects, Pleroma.Tesla.Middleware.ConnectionPool]
|
2020-07-18 11:17:38 +00:00
|
|
|
end
|
|
|
|
|
2023-12-29 05:50:50 +00:00
|
|
|
defp adapter_middlewares({Tesla.Adapter.Finch, _}) do
|
|
|
|
[Tesla.Middleware.FollowRedirects]
|
|
|
|
end
|
|
|
|
|
2021-03-04 10:06:12 +00:00
|
|
|
defp adapter_middlewares(_) do
|
|
|
|
if Pleroma.Config.get(:env) == :test do
|
|
|
|
# Emulate redirects in test env, which are handled by adapters in other environments
|
|
|
|
[Tesla.Middleware.FollowRedirects]
|
|
|
|
else
|
|
|
|
[]
|
|
|
|
end
|
|
|
|
end
|
2017-12-30 16:35:53 +00:00
|
|
|
end
|