1 # Pleroma: A lightweight social networking server
2 # Copyright © 2017-2019 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`
38 | (data_uri_string :: String.t())
39 | {:from_local, name :: String.t(), id :: String.t(), path :: String.t()}
42 {:type, :avatar | :banner | :background}
43 | {:description, String.t()}
44 | {:activity_type, String.t()}
45 | {:size_limit, nil | non_neg_integer()}
46 | {:uploader, module()}
47 | {:filters, [module()]}
49 @type t :: %__MODULE__{
53 content_type: String.t(),
56 defstruct [:id, :name, :tempfile, :content_type, :path]
58 @spec store(source, options :: [option()]) :: {:ok, Map.t()} | {:error, any()}
59 def store(upload, opts \\ []) do
62 with {:ok, upload} <- prepare_upload(upload, opts),
63 upload = %__MODULE__{upload | path: upload.path || "#{upload.id}/#{upload.name}"},
64 {:ok, upload} <- Pleroma.Upload.Filter.filter(opts.filters, upload),
65 {:ok, url_spec} <- Pleroma.Uploaders.Uploader.put_file(opts.uploader, upload) do
68 "type" => opts.activity_type,
72 "mediaType" => upload.content_type,
73 "href" => url_from_spec(upload, opts.base_url, url_spec)
76 "name" => Map.get(opts, :description) || upload.name
81 "#{__MODULE__} store (using #{inspect(opts.uploader)}) failed: #{inspect(error)}"
88 def char_unescaped?(char) do
89 URI.char_unreserved?(char) or char == ?/
92 defp get_opts(opts) do
93 {size_limit, activity_type} =
94 case Keyword.get(opts, :type) do
96 {Pleroma.Config.get!([:instance, :banner_upload_limit]), "Image"}
99 {Pleroma.Config.get!([:instance, :avatar_upload_limit]), "Image"}
102 {Pleroma.Config.get!([:instance, :background_upload_limit]), "Image"}
105 {Pleroma.Config.get!([:instance, :upload_limit]), "Document"}
109 activity_type: Keyword.get(opts, :activity_type, activity_type),
110 size_limit: Keyword.get(opts, :size_limit, size_limit),
111 uploader: Keyword.get(opts, :uploader, Pleroma.Config.get([__MODULE__, :uploader])),
112 filters: Keyword.get(opts, :filters, Pleroma.Config.get([__MODULE__, :filters])),
113 description: Keyword.get(opts, :description),
118 Pleroma.Config.get([__MODULE__, :base_url], Pleroma.Web.base_url())
123 defp prepare_upload(%Plug.Upload{} = file, opts) do
124 with :ok <- check_file_size(file.path, opts.size_limit),
125 {:ok, content_type, name} <- Pleroma.MIME.file_mime_type(file.path, file.filename) do
131 content_type: content_type
136 defp prepare_upload(%{"img" => "data:image/" <> image_data}, opts) do
137 parsed = Regex.named_captures(~r/(?<filetype>jpeg|png|gif);base64,(?<data>.*)/, image_data)
138 data = Base.decode64!(parsed["data"], ignore: :whitespace)
139 hash = String.downcase(Base.encode16(:crypto.hash(:sha256, data)))
141 with :ok <- check_binary_size(data, opts.size_limit),
142 tmp_path <- tempfile_for_image(data),
143 {:ok, content_type, name} <-
144 Pleroma.MIME.bin_mime_type(data, hash <> "." <> parsed["filetype"]) do
150 content_type: content_type
155 # For Mix.Tasks.MigrateLocalUploads
156 defp prepare_upload(%__MODULE__{tempfile: path} = upload, _opts) do
157 with {:ok, content_type} <- Pleroma.MIME.file_mime_type(path) do
158 {:ok, %__MODULE__{upload | content_type: content_type}}
162 defp check_binary_size(binary, size_limit)
163 when is_integer(size_limit) and size_limit > 0 and byte_size(binary) >= size_limit do
164 {:error, :file_too_large}
167 defp check_binary_size(_, _), do: :ok
169 defp check_file_size(path, size_limit) when is_integer(size_limit) and size_limit > 0 do
170 with {:ok, %{size: size}} <- File.stat(path),
171 true <- size <= size_limit do
174 false -> {:error, :file_too_large}
179 defp check_file_size(_, _), do: :ok
181 # Creates a tempfile using the Plug.Upload Genserver which cleans them up
183 defp tempfile_for_image(data) do
184 {:ok, tmp_path} = Plug.Upload.random_file("profile_pics")
185 {:ok, tmp_file} = File.open(tmp_path, [:write, :raw, :binary])
186 IO.binwrite(tmp_file, data)
191 defp url_from_spec(%__MODULE__{name: name}, base_url, {:file, path}) do
193 URI.encode(path, &char_unescaped?/1) <>
194 if Pleroma.Config.get([__MODULE__, :link_name], false) do
195 "?name=#{URI.encode(name, &char_unescaped?/1)}"
201 if is_nil(Pleroma.Config.get([__MODULE__, :base_url])) do
207 [base_url, prefix, path]
211 defp url_from_spec(_upload, _base_url, {:url, url}), do: url