/ 
HTTP-Body-1.24_02
/ HTTP::Body

NAME

HTTP::Body - HTTP Body Parser

SYNOPSIS

use HTTP::Body;

sub handler : method {
    my ( $class, $r ) = @_;

    my $content_type   = $r->headers_in->get('Content-Type');
    my $content_length = $r->headers_in->get('Content-Length');

    my $body   = HTTP::Body->new( $content_type, $content_length );
    my $length = $content_length;

    while ( $length ) {

        $r->read( my $buffer, ( $length < 8192 ) ? $length : 8192 );

        $length -= length($buffer);

        $body->add($buffer);
    }

    my $uploads     = $body->upload;      # hashref
    my $params      = $body->param;       # hashref
    my $param_order = $body->param_order; # arrayref
    my $raw         = $body->body;        # IO::Handle
}

DESCRIPTION

HTTP::Body parses chunks of HTTP POST data and supports application/octet-stream, application/json, application/x-www-form-urlencoded, multipart/form-data, and XForms submissions (multipart/related and application/xml). A body of any other content type is handled like application/octet-stream.

Chunked bodies are supported by not passing a length value to new().

It is currently used by Catalyst, Dancer, Maypole, Web::Simple and Jedi.

NOTES

When parsing multipart bodies, temporary files are created to store any uploaded files. You must delete these temporary files yourself after processing them, or set $body->cleanup(1) to automatically delete them at DESTROY-time. The temporary file of a file part that is still incomplete at DESTROY-time is never returned by upload, so it is always deleted.

Limits

To stop hostile input from exhausting memory or CPU, add() enforces a few limits and croaks when one is exceeded. Each is a package variable you can raise to suit your forms, or set to 0 (or undef) to disable.

$HTTP::Body::MultiPart::max_parts
$HTTP::Body::UrlEncoded::max_params

The largest number of parts in a multipart body, and of fields in a urlencoded body (counted as & and ; separators, empty fields included); more make add croak. The default for both is 1000.

$HTTP::Body::MultiPart::max_header_size
$HTTP::Body::MultiPart::max_header_lines

The largest header block a multipart part may have, in bytes and in lines; a larger one makes add croak. The defaults are 32768 and 100.

$HTTP::Body::max_chunk_line_size

The largest chunk-size line (size, extensions and CRLF) of a chunked body, in bytes; a longer one makes add croak. The default is 1024. A chunked body whose framing is malformed (a line that is no chunk-size line, a size that does not fit an integer, chunk data not followed by CRLF) makes add croak as well.

$HTTP::Body::max_trailer_size
$HTTP::Body::max_trailer_lines

The largest trailer of a chunked body (its header lines and the blank line that ends it), in bytes, and the most header lines it may have; a larger one makes add croak. The defaults are 32768 and 100.

METHODS

new

Constructor. Takes content type and content length as parameters, returns a HTTP::Body object.

add

Feeds the next piece of the body to the parser, which parses as much of it as it can unless it is done already. Data beyond the content length is ignored.

With a content length, add returns the number of bytes still expected as a negative number, and 0 once the body is complete. For a chunked body it returns nothing.

add croaks when one of the limits under "Limits" is exceeded, and when the framing of a chunked body is malformed.

body

accessor for the body.

chunked

Returns 1 if the request is chunked.

cleanup

Set to 1 to enable automatic deletion of temporary files at DESTROY-time.

content_length

Returns the content-length for the body data if known. Returns -1 if the request is chunked.

content_type

Returns the content-type of the body data.

init

return self.

length

Returns the number of bytes of the body read so far, up to the content length. Of a chunked body only the chunk data counts.

trailing_headers

If a chunked request body had trailing headers, trailing_headers will return an HTTP::Headers object populated with those headers. The trailer is read up to the blank line that ends it, also when it arrives in later calls to add than the last, zero-size chunk; until then, trailing_headers returns the header lines that have arrived so far. The body itself is done at the last chunk.

spin

Abstract method to spin the io handle.

state

Returns the current state of the parser.

param

Get/set body parameters.

upload

Get/set file uploads.

part_data

Just like 'param' but gives you a hash of the full data associated with the part in a multipart type POST/PUT. Example:

{
  data => "test",
  done => 1,
  headers => {
    "Content-Disposition" => "form-data; name=\"arg2\"",
    "Content-Type" => "text/plain"
  },
  name => "arg2",
  size => 4
}
tmpdir

Specify a different path for temporary files. Defaults to the system temporary path.

param_order

Returns the array ref of the param keys in the order how they appeared on the body

CONFIGURING UPLOAD TEMPORARY FILES

By default, the temporary file that holds an uploaded file is given the extension .upload instead of the extension of the uploaded file itself. The following package variables control how these temporary files are created.

$HTTP::Body::MultiPart::file_temp_suffix

The extension given to every multipart upload file; the default is .upload. Set it to undef to keep the extension of the uploaded file instead, as releases before 1.23 did.

$HTTP::Body::MultiPart::basename_regexp

The regexp used to work out the uploaded file's extension. It only matters when file_temp_suffix is undefined, and is matched against the last 255 bytes of the uploaded file's basename, which is as long as a suffix can be. The default, qr/[^.]+(\.[^\\\/]+)$/, is not run as a regexp: as long as the variable still holds it, a string search with the same result is used.

$HTTP::Body::MultiPart::file_temp_template

Passed through to the File::Temp TEMPLATE parameter. There is no special default in our module.

%HTTP::Body::MultiPart::file_temp_parameters

Extra settings for the File::Temp invocation. These override every other setting.

SUPPORT

Note: This project was formerly hosted on the Shadowcat Systems git server. The repository has moved to GitHub.

AUTHOR

Christian Hansen, christian.hansen@mac.com

Sebastian Riedel, kraihx@googlemail.com

Andy Grundman, andy@hybridized.org

MAINTAINER

Torsten Raudssus, torsten@raudssus.de

CONTRIBUTORS

Simon Elliott cpan@papercreatures.com

Kent Fredric kentnl@cpan.org

Christian Walde walde.christian@gmail.com

LICENSE

This library is free software. You can redistribute it and/or modify it under the same terms as perl itself.