mirror of
https://akkoma.dev/AkkomaGang/akkoma.git
synced 2024-11-04 23:53:11 +00:00
36 lines
1.2 KiB
Elixir
36 lines
1.2 KiB
Elixir
defmodule Pleroma.Uploaders.Uploader do
|
|
@moduledoc """
|
|
Defines the contract to put and get an uploaded file to any backend.
|
|
"""
|
|
|
|
@doc """
|
|
Instructs how to get the file from the backend.
|
|
|
|
Used by `Pleroma.Plugs.UploadedMedia`.
|
|
"""
|
|
@type get_method :: {:static_dir, directory :: String.t()} | {:url, url :: String.t()}
|
|
@callback get_file(file :: String.t()) :: {:ok, get_method()}
|
|
|
|
@doc """
|
|
Put a file to the backend.
|
|
|
|
Returns:
|
|
|
|
* `{:ok, spec}` where spec is:
|
|
* `{:file, filename :: String.t}` to handle reads with `get_file/1` (recommended)
|
|
|
|
This allows to correctly proxy or redirect requests to the backend, while allowing to migrate backends without breaking any URL.
|
|
|
|
* `{url, url :: String.t}` to bypass `get_file/2` and use the `url` directly in the activity.
|
|
* `{:error, String.t}` error information if the file failed to be saved to the backend.
|
|
|
|
"""
|
|
@callback put_file(
|
|
name :: String.t(),
|
|
uuid :: String.t(),
|
|
file :: File.t(),
|
|
content_type :: String.t(),
|
|
options :: Map.t()
|
|
) :: {:ok, {:file, String.t()} | {:url, String.t()}} | {:error, String.t()}
|
|
end
|