2018-12-23 20:04:54 +00:00
|
|
|
# Pleroma: A lightweight social networking server
|
2021-01-13 06:49:20 +00:00
|
|
|
# Copyright © 2017-2021 Pleroma Authors <https://pleroma.social/>
|
2018-12-23 20:04:54 +00:00
|
|
|
# SPDX-License-Identifier: AGPL-3.0-only
|
|
|
|
|
2018-12-01 05:26:59 +00:00
|
|
|
defmodule Pleroma.HTTP.RequestBuilder do
|
|
|
|
@moduledoc """
|
|
|
|
Helper functions for building Tesla requests
|
|
|
|
"""
|
|
|
|
|
2020-02-11 07:12:57 +00:00
|
|
|
alias Pleroma.HTTP.Request
|
|
|
|
alias Tesla.Multipart
|
2018-12-01 05:26:59 +00:00
|
|
|
|
2022-07-04 16:30:38 +00:00
|
|
|
@mix_env Mix.env()
|
|
|
|
|
2020-02-11 07:12:57 +00:00
|
|
|
@doc """
|
|
|
|
Creates new request
|
2018-12-01 05:26:59 +00:00
|
|
|
"""
|
2020-02-11 07:12:57 +00:00
|
|
|
@spec new(Request.t()) :: Request.t()
|
|
|
|
def new(%Request{} = request \\ %Request{}), do: request
|
2018-12-01 05:26:59 +00:00
|
|
|
|
|
|
|
@doc """
|
|
|
|
Specify the request method when building a request
|
2020-02-11 07:12:57 +00:00
|
|
|
"""
|
|
|
|
@spec method(Request.t(), Request.method()) :: Request.t()
|
|
|
|
def method(request, m), do: %{request | method: m}
|
2018-12-01 05:26:59 +00:00
|
|
|
|
2020-02-11 07:12:57 +00:00
|
|
|
@doc """
|
|
|
|
Specify the request method when building a request
|
2018-12-01 05:26:59 +00:00
|
|
|
"""
|
2020-02-11 07:12:57 +00:00
|
|
|
@spec url(Request.t(), Request.url()) :: Request.t()
|
|
|
|
def url(request, u), do: %{request | url: u}
|
2018-12-01 05:26:59 +00:00
|
|
|
|
|
|
|
@doc """
|
|
|
|
Add headers to the request
|
|
|
|
"""
|
2020-02-11 07:12:57 +00:00
|
|
|
@spec headers(Request.t(), Request.headers()) :: Request.t()
|
|
|
|
def headers(request, headers) do
|
2022-07-04 16:30:38 +00:00
|
|
|
headers_list = maybe_add_user_agent(headers, @mix_env)
|
2019-05-17 20:28:58 +00:00
|
|
|
|
2020-02-11 07:12:57 +00:00
|
|
|
%{request | headers: headers_list}
|
2018-12-01 05:26:59 +00:00
|
|
|
end
|
|
|
|
|
|
|
|
@doc """
|
|
|
|
Add custom, per-request middleware or adapter options to the request
|
|
|
|
"""
|
2020-02-11 07:12:57 +00:00
|
|
|
@spec opts(Request.t(), keyword()) :: Request.t()
|
|
|
|
def opts(request, options), do: %{request | opts: options}
|
2018-12-01 05:26:59 +00:00
|
|
|
|
|
|
|
@doc """
|
|
|
|
Add optional parameters to the request
|
|
|
|
"""
|
2020-02-11 07:12:57 +00:00
|
|
|
@spec add_param(Request.t(), atom(), atom(), any()) :: Request.t()
|
|
|
|
def add_param(request, :query, :query, values), do: %{request | query: values}
|
2019-01-15 19:31:13 +00:00
|
|
|
|
2020-02-11 07:12:57 +00:00
|
|
|
def add_param(request, :body, :body, value), do: %{request | body: value}
|
2018-12-01 05:26:59 +00:00
|
|
|
|
|
|
|
def add_param(request, :body, key, value) do
|
|
|
|
request
|
2020-02-11 07:12:57 +00:00
|
|
|
|> Map.put(:body, Multipart.new())
|
2018-12-01 05:26:59 +00:00
|
|
|
|> Map.update!(
|
|
|
|
:body,
|
2020-02-11 07:12:57 +00:00
|
|
|
&Multipart.add_field(
|
2019-01-15 19:31:13 +00:00
|
|
|
&1,
|
|
|
|
key,
|
|
|
|
Jason.encode!(value),
|
2020-02-11 07:12:57 +00:00
|
|
|
headers: [{"content-type", "application/json"}]
|
2018-12-01 05:26:59 +00:00
|
|
|
)
|
|
|
|
)
|
|
|
|
end
|
|
|
|
|
|
|
|
def add_param(request, :file, name, path) do
|
|
|
|
request
|
2020-02-11 07:12:57 +00:00
|
|
|
|> Map.put(:body, Multipart.new())
|
|
|
|
|> Map.update!(:body, &Multipart.add_file(&1, path, name: name))
|
2018-12-01 05:26:59 +00:00
|
|
|
end
|
|
|
|
|
|
|
|
def add_param(request, :form, name, value) do
|
2020-02-11 07:12:57 +00:00
|
|
|
Map.update(request, :body, %{name => value}, &Map.put(&1, name, value))
|
2018-12-01 05:26:59 +00:00
|
|
|
end
|
|
|
|
|
|
|
|
def add_param(request, location, key, value) do
|
|
|
|
Map.update(request, location, [{key, value}], &(&1 ++ [{key, value}]))
|
|
|
|
end
|
2020-02-11 07:12:57 +00:00
|
|
|
|
|
|
|
def convert_to_keyword(request) do
|
|
|
|
request
|
|
|
|
|> Map.from_struct()
|
|
|
|
|> Enum.into([])
|
|
|
|
end
|
2022-07-04 16:30:38 +00:00
|
|
|
|
|
|
|
defp maybe_add_user_agent(headers, :test) do
|
|
|
|
with true <- Pleroma.Config.get([:http, :send_user_agent]) do
|
|
|
|
[{"user-agent", Pleroma.Application.user_agent()} | headers]
|
|
|
|
else
|
|
|
|
_ ->
|
|
|
|
headers
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
|
|
|
defp maybe_add_user_agent(headers, _),
|
|
|
|
do: [{"user-agent", Pleroma.Application.user_agent()} | headers]
|
2018-12-01 05:26:59 +00:00
|
|
|
end
|