Pleroma/lib/pleroma/upload.ex

224 lines
7.3 KiB
Elixir
Raw Normal View History

# Pleroma: A lightweight social networking server
2018-12-31 16:41:47 +01:00
# Copyright © 2017-2019 Pleroma Authors <https://pleroma.social/>
# SPDX-License-Identifier: AGPL-3.0-only
2017-03-29 01:39:01 +02:00
defmodule Pleroma.Upload do
2018-11-29 21:11:45 +01:00
@moduledoc """
# Upload
Options:
* `:type`: presets for activity type (defaults to Document) and size limits from app configuration
* `:description`: upload alternative text
2018-11-30 17:44:12 +01:00
* `:base_url`: override base url
2018-11-29 21:11:45 +01:00
* `:uploader`: override uploader
* `:filters`: override filters
* `:size_limit`: override size limit
* `:activity_type`: override activity type
The `%Pleroma.Upload{}` struct: all documented fields are meant to be overwritten in filters:
* `:id` - the upload id.
* `:name` - the upload file name.
* `:path` - the upload path: set at first to `id/name` but can be changed. Keep in mind that the path
is once created permanent and changing it (especially in uploaders) is probably a bad idea!
* `:tempfile` - path to the temporary file. Prefer in-place changes on the file rather than changing the
path as the temporary file is also tracked by `Plug.Upload{}` and automatically deleted once the request is over.
Related behaviors:
* `Pleroma.Uploaders.Uploader`
* `Pleroma.Upload.Filter`
"""
alias Ecto.UUID
2018-11-23 17:40:45 +01:00
require Logger
2018-11-29 21:11:45 +01:00
@type source ::
Plug.Upload.t() | data_uri_string ::
String.t() | {:from_local, name :: String.t(), id :: String.t(), path :: String.t()}
@type option ::
{:type, :avatar | :banner | :background}
| {:description, String.t()}
| {:activity_type, String.t()}
| {:size_limit, nil | non_neg_integer()}
| {:uploader, module()}
| {:filters, [module()]}
@type t :: %__MODULE__{
id: String.t(),
name: String.t(),
tempfile: String.t(),
content_type: String.t(),
path: String.t()
}
defstruct [:id, :name, :tempfile, :content_type, :path]
@spec store(source, options :: [option()]) :: {:ok, Map.t()} | {:error, any()}
2018-11-23 17:40:45 +01:00
def store(upload, opts \\ []) do
opts = get_opts(opts)
2018-11-29 21:11:45 +01:00
with {:ok, upload} <- prepare_upload(upload, opts),
upload = %__MODULE__{upload | path: upload.path || "#{upload.id}/#{upload.name}"},
{:ok, upload} <- Pleroma.Upload.Filter.filter(opts.filters, upload),
{:ok, url_spec} <- Pleroma.Uploaders.Uploader.put_file(opts.uploader, upload) do
2018-11-23 17:40:45 +01:00
{:ok,
%{
2018-11-29 21:11:45 +01:00
"type" => opts.activity_type,
2018-11-23 17:40:45 +01:00
"url" => [
%{
"type" => "Link",
2018-11-29 21:11:45 +01:00
"mediaType" => upload.content_type,
2018-11-30 17:44:12 +01:00
"href" => url_from_spec(opts.base_url, url_spec)
2018-11-23 17:40:45 +01:00
}
],
2018-11-29 21:11:45 +01:00
"name" => Map.get(opts, :description) || upload.name
2018-11-23 17:40:45 +01:00
}}
else
{:error, error} ->
Logger.error(
"#{__MODULE__} store (using #{inspect(opts.uploader)}) failed: #{inspect(error)}"
)
2018-03-30 15:01:53 +02:00
2018-11-23 17:40:45 +01:00
{:error, error}
end
end
2018-11-23 17:40:45 +01:00
defp get_opts(opts) do
2018-11-29 21:11:45 +01:00
{size_limit, activity_type} =
case Keyword.get(opts, :type) do
:banner ->
{Pleroma.Config.get!([:instance, :banner_upload_limit]), "Image"}
:avatar ->
{Pleroma.Config.get!([:instance, :avatar_upload_limit]), "Image"}
:background ->
{Pleroma.Config.get!([:instance, :background_upload_limit]), "Image"}
_ ->
{Pleroma.Config.get!([:instance, :upload_limit]), "Document"}
end
opts = %{
activity_type: Keyword.get(opts, :activity_type, activity_type),
size_limit: Keyword.get(opts, :size_limit, size_limit),
uploader: Keyword.get(opts, :uploader, Pleroma.Config.get([__MODULE__, :uploader])),
filters: Keyword.get(opts, :filters, Pleroma.Config.get([__MODULE__, :filters])),
2018-11-30 17:44:12 +01:00
description: Keyword.get(opts, :description),
base_url:
Keyword.get(
opts,
:base_url,
Pleroma.Config.get([__MODULE__, :base_url], Pleroma.Web.base_url())
)
2018-11-23 17:40:45 +01:00
}
2018-11-29 21:11:45 +01:00
# TODO: 1.0+ : remove old config compatibility
opts =
if Pleroma.Config.get([__MODULE__, :strip_exif]) == true &&
!Enum.member?(opts.filters, Pleroma.Upload.Filter.Mogrify) do
Logger.warn("""
Pleroma: configuration `:instance, :strip_exif` is deprecated, please instead set:
2018-11-30 11:35:10 +01:00
:pleroma, Pleroma.Upload, [filters: [Pleroma.Upload.Filter.Mogrify]]
2018-11-29 21:11:45 +01:00
2018-11-30 11:35:10 +01:00
:pleroma, Pleroma.Upload.Filter.Mogrify, args: "strip"
2018-11-29 21:11:45 +01:00
""")
Pleroma.Config.put([Pleroma.Upload.Filter.Mogrify], args: "strip")
Map.put(opts, :filters, opts.filters ++ [Pleroma.Upload.Filter.Mogrify])
else
opts
end
2018-12-09 10:12:48 +01:00
if Pleroma.Config.get([:instance, :dedupe_media]) == true &&
!Enum.member?(opts.filters, Pleroma.Upload.Filter.Dedupe) do
Logger.warn("""
Pleroma: configuration `:instance, :dedupe_media` is deprecated, please instead set:
2018-11-29 21:11:45 +01:00
2018-12-09 10:12:48 +01:00
:pleroma, Pleroma.Upload, [filters: [Pleroma.Upload.Filter.Dedupe]]
""")
2018-11-29 21:11:45 +01:00
2018-12-09 10:12:48 +01:00
Map.put(opts, :filters, opts.filters ++ [Pleroma.Upload.Filter.Dedupe])
else
opts
end
2018-11-23 17:40:45 +01:00
end
2018-11-29 21:11:45 +01:00
defp prepare_upload(%Plug.Upload{} = file, opts) do
2018-11-23 17:40:45 +01:00
with :ok <- check_file_size(file.path, opts.size_limit),
2018-11-29 21:11:45 +01:00
{:ok, content_type, name} <- Pleroma.MIME.file_mime_type(file.path, file.filename) do
{:ok,
%__MODULE__{
id: UUID.generate(),
name: name,
tempfile: file.path,
content_type: content_type
}}
end
2017-03-29 01:39:01 +02:00
end
2018-11-29 21:11:45 +01:00
defp prepare_upload(%{"img" => "data:image/" <> image_data}, opts) do
2017-04-16 14:23:30 +02:00
parsed = Regex.named_captures(~r/(?<filetype>jpeg|png|gif);base64,(?<data>.*)/, image_data)
2018-04-16 01:37:51 +02:00
data = Base.decode64!(parsed["data"], ignore: :whitespace)
2018-11-23 17:40:45 +01:00
hash = String.downcase(Base.encode16(:crypto.hash(:sha256, data)))
2018-11-23 17:40:45 +01:00
with :ok <- check_binary_size(data, opts.size_limit),
tmp_path <- tempfile_for_image(data),
2018-11-29 21:11:45 +01:00
{:ok, content_type, name} <-
Pleroma.MIME.bin_mime_type(data, hash <> "." <> parsed["filetype"]) do
{:ok,
%__MODULE__{
id: UUID.generate(),
name: name,
tempfile: tmp_path,
content_type: content_type
}}
2018-11-23 17:40:45 +01:00
end
end
# For Mix.Tasks.MigrateLocalUploads
2018-11-29 21:11:45 +01:00
defp prepare_upload(upload = %__MODULE__{tempfile: path}, _opts) do
with {:ok, content_type} <- Pleroma.MIME.file_mime_type(path) do
{:ok, %__MODULE__{upload | content_type: content_type}}
2018-11-23 17:40:45 +01:00
end
end
defp check_binary_size(binary, size_limit)
when is_integer(size_limit) and size_limit > 0 and byte_size(binary) >= size_limit do
{:error, :file_too_large}
end
defp check_binary_size(_, _), do: :ok
2018-11-23 17:40:45 +01:00
defp check_file_size(path, size_limit) when is_integer(size_limit) and size_limit > 0 do
with {:ok, %{size: size}} <- File.stat(path),
true <- size <= size_limit do
:ok
else
2018-11-23 17:40:45 +01:00
false -> {:error, :file_too_large}
error -> error
end
2017-04-16 14:23:30 +02:00
end
2018-11-23 17:40:45 +01:00
defp check_file_size(_, _), do: :ok
# Creates a tempfile using the Plug.Upload Genserver which cleans them up
# automatically.
defp tempfile_for_image(data) do
{:ok, tmp_path} = Plug.Upload.random_file("profile_pics")
{:ok, tmp_file} = File.open(tmp_path, [:write, :raw, :binary])
IO.binwrite(tmp_file, data)
tmp_path
end
2017-04-16 14:23:30 +02:00
2018-11-30 17:44:12 +01:00
defp url_from_spec(base_url, {:file, path}) do
[base_url, "media", path]
2018-11-23 17:40:45 +01:00
|> Path.join()
end
2018-12-10 07:39:57 +01:00
defp url_from_spec(_base_url, {:url, url}), do: url
2017-03-29 01:39:01 +02:00
end