1 package Catalyst::Action::DeserializeMultiPart;
4 use namespace::autoclean;
6 extends 'Catalyst::Action::Deserialize';
10 $VERSION = eval $VERSION;
12 our $NO_HTTP_BODY_TYPES_INITIALIZATION;
13 $HTTP::Body::TYPES->{'multipart/mixed'} = 'HTTP::Body::MultiPart' unless $NO_HTTP_BODY_TYPES_INITIALIZATION;
15 override execute => sub {
17 my ( $controller, $c ) = @_;
18 if($c->request->content_type =~ m{^multipart/}i && !defined($c->request->body)){
19 my $REST_part = $self->attributes->{DeserializePart} || [];
20 my($REST_body) = $c->request->upload($REST_part->[0] || 'REST');
22 $c->request->_body->body( $REST_body->fh );
23 $c->request->content_type( $REST_body->type );
29 __PACKAGE__->meta->make_immutable;
35 Catalyst::Action::DeserializeMultiPart - Deserialize Data in a Multi-Part Request
39 package Foo::Controller::Bar;
42 # see Catalyst::Action::Deserialize for standard config
45 sub begin :ActionClass('DeserializeMultiPart') DeserializePart('REST') {}
49 This action will deserialize multi-part HTTP POST, PUT, OPTIONS and DELETE
50 requests. It is a simple extension of L<Catalyst::Action::Deserialize>
51 with the exception that rather than using the entire request body (which
52 may contain multiple sections), it will look for a single part in the request
53 body named according to the C<DeserializePart> attribute on that action
54 (defaulting to C<REST>). If a part is found under that name, it then
55 proceeds to deserialize the request as normal based on the content-type
56 of that individual part. If no such part is found, the request would
57 be processed as if no data was sent.
59 This module's code will only come into play if the following conditions are met:
63 =item * The C<Content-type> of the request is C<multipart/*>
65 =item * The request body (as returned by C<$c->request->body> is not defined
67 =item * There is a part of the request body (as returned by C<$c->request->upload($DeserializePart)>) available
71 =head1 CONFIGURING HTTP::Body
73 By default, L<HTTP::Body> parses C<multipart/*> requests as an
74 L<HTTP::Body::OctetStream>. L<HTTP::Body::OctetStream> does not separate
75 out the individual parts of the request body. In order to make use of
76 the individual parts, L<HTTP::Body> must be told which content types
77 to map to L<HTTP::Body::MultiPart>. This module makes the assumption
78 that you would like to have all C<multipart/mixed> requests parsed by
79 L<HTTP::Body::MultiPart> module. This is done by a package variable
80 inside L<HTTP::Body>: C<$HTTP::Body::Types> (a HASH ref).
82 B<WARNING:> As this module modifys the behaviour of HTTP::Body globally,
83 adding it to an application can have unintended consequences as multipart
84 bodies will be treated differently to before.
87 add other content-types to this hash if needed or if you would prefer
88 that C<multipart/mixed> NOT be added to this hash, simply delete it
89 after loading this module.
92 use Catalyst::Action::DeserializeMultiPart;
94 delete $HTTP::Body::Types->{'multipart/mixed'};
95 $HTTP::Body::Types->{'multipart/my-crazy-content-type'} = 'HTTP::Body::MultiPart';
99 This is a simple sub-class of L<Catalyst::Action::Deserialize>.
103 See L<Catalyst::Action::REST> for authors.
107 You may distribute this code under the same terms as Perl itself.