View Source Plug.Parsers.MULTIPART (Plug v1.14.0)

Parses multipart request body.



All options supported by Plug.Conn.read_body/2 are also supported here. They are repeated here for convenience:

  • :length - sets the maximum number of bytes to read from the request, defaults to 8_000_000 bytes

  • :read_length - sets the amount of bytes to read at one time from the underlying socket to fill the chunk, defaults to 1_000_000 bytes

  • :read_timeout - sets the timeout for each socket read, defaults to 15_000ms

So by default, Plug.Parsers will read 1_000_000 bytes at a time from the socket with an overall limit of 8_000_000 bytes.

Besides the options supported by Plug.Conn.read_body/2, the multipart parser also checks for:

  • :headers - containing the same :length, :read_length and :read_timeout options which are used explicitly for parsing multipart headers

  • :validate_utf8 - specifies whether multipart body parts should be validated as utf8 binaries. Defaults to true

  • :multipart_to_params - a MFA that receives the multipart headers and the connection and it must return a tuple of {:ok, params, conn}


Multipart to params

Once all multiparts are collected, they must be converted to params and this can be customize with a MFA. The default implementation of this function is equivalent to:

def multipart_to_params(parts, conn) do
  params =
    for {name, _headers, body} <- parts,
        name != nil,
        reduce: %{} do
      acc -> Plug.Conn.Query.decode_pair({name, body}, acc)

  {:ok, params, conn}

As you can notice, it discards all multiparts without a name. If you want to keep the unnamed parts, you can store all of them under a known prefix, such as:

def multipart_to_params(parts, conn) do
  params =
    for {name, _headers, body} <- parts, reduce: %{} do
      acc -> Plug.Conn.Query.decode_pair({name || "_parts[]", body}, acc)

  {:ok, params, conn}


Dynamic configuration

If you need to dynamically configure how Plug.Parsers.MULTIPART behave, for example, based on the connection or another system parameter, one option is to create your own parser that wraps it:

defmodule MyMultipart do
  @multipart Plug.Parsers.MULTIPART

  def init(opts) do

  def parse(conn, "multipart", subtype, headers, opts) do
    length = System.fetch_env!("UPLOAD_LIMIT") |> String.to_integer
    opts = @multipart.init([length: length] ++ opts)
    @multipart.parse(conn, "multipart", subtype, headers, opts)

  def parse(conn, _type, _subtype, _headers, _opts) do
    {:next, conn}