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.Upload do
10 * `:type`: presets for activity type (defaults to Document) and size limits from app configuration
11 * `:description`: upload alternative text
12 * `:base_url`: override base url
13 * `:uploader`: override uploader
14 * `:filters`: override filters
15 * `:size_limit`: override size limit
16 * `:activity_type`: override activity type
18 The `%Pleroma.Upload{}` struct: all documented fields are meant to be overwritten in filters:
20 * `:id` - the upload id.
21 * `:name` - the upload file name.
22 * `:path` - the upload path: set at first to `id/name` but can be changed. Keep in mind that the path
23 is once created permanent and changing it (especially in uploaders) is probably a bad idea!
24 * `:tempfile` - path to the temporary file. Prefer in-place changes on the file rather than changing the
25 path as the temporary file is also tracked by `Plug.Upload{}` and automatically deleted once the request is over.
29 * `Pleroma.Uploaders.Uploader`
30 * `Pleroma.Upload.Filter`
39 | (data_uri_string :: String.t())
40 | {:from_local, name :: String.t(), id :: String.t(), path :: String.t()}
44 {:type, :avatar | :banner | :background}
45 | {:description, String.t()}
46 | {:activity_type, String.t()}
47 | {:size_limit, nil | non_neg_integer()}
48 | {:uploader, module()}
49 | {:filters, [module()]}
51 @type t :: %__MODULE__{
55 content_type: String.t(),
58 defstruct [:id, :name, :tempfile, :content_type, :path]
60 defp get_description(opts, upload) do
61 case {opts[:description], Pleroma.Config.get([Pleroma.Upload, :default_description])} do
62 {description, _} when is_binary(description) -> description
63 {_, :filename} -> upload.name
64 {_, str} when is_binary(str) -> str
69 @spec store(source, options :: [option()]) :: {:ok, Map.t()} | {:error, any()}
70 @doc "Store a file. If using a `Plug.Upload{}` as the source, be sure to use `Majic.Plug` to ensure its content_type and filename is correct."
71 def store(upload, opts \\ []) do
74 with {:ok, upload} <- prepare_upload(upload, opts),
75 upload = %__MODULE__{upload | path: upload.path || "#{upload.id}/#{upload.name}"},
76 {:ok, upload} <- Pleroma.Upload.Filter.filter(opts.filters, upload),
77 description = get_description(opts, upload),
80 String.length(description) <= Pleroma.Config.get([:instance, :description_limit])},
81 {:ok, url_spec} <- Pleroma.Uploaders.Uploader.put_file(opts.uploader, upload) do
84 "type" => opts.activity_type,
85 "mediaType" => upload.content_type,
89 "mediaType" => upload.content_type,
90 "href" => url_from_spec(upload, opts.base_url, url_spec)
96 {:description_limit, _} ->
97 {:error, :description_too_long}
101 "#{__MODULE__} store (using #{inspect(opts.uploader)}) failed: #{inspect(error)}"
108 def char_unescaped?(char) do
109 URI.char_unreserved?(char) or char == ?/
112 defp get_opts(opts) do
113 {size_limit, activity_type} =
114 case Keyword.get(opts, :type) do
116 {Pleroma.Config.get!([:instance, :banner_upload_limit]), "Image"}
119 {Pleroma.Config.get!([:instance, :avatar_upload_limit]), "Image"}
122 {Pleroma.Config.get!([:instance, :background_upload_limit]), "Image"}
125 {Pleroma.Config.get!([:instance, :upload_limit]), "Document"}
129 activity_type: Keyword.get(opts, :activity_type, activity_type),
130 size_limit: Keyword.get(opts, :size_limit, size_limit),
131 uploader: Keyword.get(opts, :uploader, Pleroma.Config.get([__MODULE__, :uploader])),
132 filters: Keyword.get(opts, :filters, Pleroma.Config.get([__MODULE__, :filters])),
133 description: Keyword.get(opts, :description),
138 Pleroma.Config.get([__MODULE__, :base_url], Pleroma.Web.base_url())
143 defp prepare_upload(%Plug.Upload{} = file, opts) do
144 with :ok <- check_file_size(file.path, opts.size_limit) do
150 content_type: file.content_type
155 defp prepare_upload(%{img: "data:image/" <> image_data}, opts) do
156 parsed = Regex.named_captures(~r/(?<filetype>jpeg|png|gif);base64,(?<data>.*)/, image_data)
157 data = Base.decode64!(parsed["data"], ignore: :whitespace)
158 hash = Base.encode16(:crypto.hash(:sha256, data), lower: true)
160 with :ok <- check_binary_size(data, opts.size_limit),
161 tmp_path <- tempfile_for_image(data),
162 {:ok, %{mime_type: content_type}} <-
163 Majic.perform({:bytes, data}, pool: Pleroma.MajicPool),
164 [ext | _] <- MIME.extensions(content_type) do
168 name: hash <> "." <> ext,
170 content_type: content_type
175 # For Mix.Tasks.MigrateLocalUploads
176 defp prepare_upload(%__MODULE__{tempfile: path} = upload, _opts) do
177 with {:ok, %{mime_type: content_type}} <- Majic.perform(path, pool: Pleroma.MajicPool) do
178 {:ok, %__MODULE__{upload | content_type: content_type}}
182 defp check_binary_size(binary, size_limit)
183 when is_integer(size_limit) and size_limit > 0 and byte_size(binary) >= size_limit do
184 {:error, :file_too_large}
187 defp check_binary_size(_, _), do: :ok
189 defp check_file_size(path, size_limit) when is_integer(size_limit) and size_limit > 0 do
190 with {:ok, %{size: size}} <- File.stat(path),
191 true <- size <= size_limit do
194 false -> {:error, :file_too_large}
199 defp check_file_size(_, _), do: :ok
201 # Creates a tempfile using the Plug.Upload Genserver which cleans them up
203 defp tempfile_for_image(data) do
204 {:ok, tmp_path} = Plug.Upload.random_file("profile_pics")
205 {:ok, tmp_file} = File.open(tmp_path, [:write, :raw, :binary])
206 IO.binwrite(tmp_file, data)
211 defp url_from_spec(%__MODULE__{name: name}, base_url, {:file, path}) do
213 URI.encode(path, &char_unescaped?/1) <>
214 if Pleroma.Config.get([__MODULE__, :link_name], false) do
215 "?name=#{URI.encode(name, &char_unescaped?/1)}"
221 if is_nil(Pleroma.Config.get([__MODULE__, :base_url])) do
227 [base_url, prefix, path]
231 defp url_from_spec(_upload, _base_url, {:url, url}), do: url
234 uploader = Config.get([Pleroma.Upload, :uploader])
235 upload_base_url = Config.get([Pleroma.Upload, :base_url])
236 public_endpoint = Config.get([uploader, :public_endpoint])
239 Pleroma.Uploaders.Local ->
240 upload_base_url || Pleroma.Web.base_url() <> "/media/"
242 Pleroma.Uploaders.S3 ->
243 bucket = Config.get([Pleroma.Uploaders.S3, :bucket])
245 bucket_with_namespace =
247 truncated_namespace = Config.get([Pleroma.Uploaders.S3, :truncated_namespace]) ->
250 namespace = Config.get([Pleroma.Uploaders.S3, :bucket_namespace]) ->
251 namespace <> ":" <> bucket
257 if public_endpoint do
258 Path.join([public_endpoint, bucket_with_namespace])
260 Path.join([upload_base_url, bucket_with_namespace])
264 public_endpoint || upload_base_url