Pleroma v1.1.9-10-g42f76306+dev Pleroma.Uploaders.Uploader behaviour View Source

Defines the contract to put and get an uploaded file to any backend.

Link to this section Summary

Instructs how to get the file from the backend.

Put a file to the backend.

file_spec() :: {:file | :url, String.t()}

get_method() ::
  {:static_dir, directory :: String.t()} | {:url, url :: String.t()}

put_file(module(), Pleroma.Upload.t()) ::
  {:ok, file_spec()} | {:error, String.t()}

get_file(file :: String.t()) :: {:ok, get_method()}

Instructs how to get the file from the backend.

(optional)

http_callback(Plug.Conn.t(), Map.t()) ::
  {:ok, Plug.Conn.t()}
  | {:ok, Plug.Conn.t(), file_spec()}
  | {:error, Plug.Conn.t(), String.t()}

put_file(Pleroma.Upload.t()) ::
  :ok | {:ok, file_spec()} | {:error, String.t()} | :wait_callback

Put a file to the backend.

Returns:

:ok which assumes {:ok, upload.path}
{: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.
:wait_callback will wait for an http post request at /api/pleroma/upload_callback/:upload_path and call the uploader's http_callback/3 method.