3 # Created by: Adam Jacob, Marchex, <adam@hjksolutions.com>
4 # Created on: 10/13/2006 03:54:33 PM PDT
5 package Catalyst::Request::REST;
9 use Scalar::Util qw/blessed/;
11 use base qw/Catalyst::Request Class::Accessor::Fast/;
14 use HTTP::Headers::Util qw(split_header_words);
16 sub _insert_self_into {
17 my ($class, $app_class ) = @_;
18 # the fallback to $app_class is for the (rare and deprecated) case when
19 # people are defining actions in MyApp.pm instead of in a controller.
20 my $app = (blessed($app_class) && $app_class->can('_application'))
21 ? $app_class->_application : Catalyst::Utils::class2appclass( $app_class ) || $app_class;
23 my $req_class = $app->request_class;
24 return if $req_class->isa($class);
25 if ($req_class eq 'Catalyst::Request') {
26 $app->request_class($class);
28 die "$app has a custom request class $req_class, "
29 . "which is not a $class; see Catalyst::Request::REST";
33 __PACKAGE__->mk_accessors(qw(data accept_only));
35 sub accepted_content_types {
38 return $self->{content_types} if $self->{content_types};
42 # First, we use the content type in the HTTP Request. It wins all.
43 $types{ $self->content_type } = 3
44 if $self->content_type;
46 if ($self->method eq "GET" && $self->param('content-type')) {
47 $types{ $self->param('content-type') } = 2;
50 # Third, we parse the Accept header, and see if the client
51 # takes a format we understand.
53 # This is taken from chansen's Apache2::UploadProgress.
54 if ( $self->header('Accept') ) {
55 $self->accept_only(1) unless keys %types;
57 my $accept_header = $self->header('Accept');
60 foreach my $pair ( split_header_words($accept_header) ) {
61 my ( $type, $qvalue ) = @{$pair}[ 0, 3 ];
62 next if $types{$type};
64 # cope with invalid (missing required q parameter) header like:
65 # application/json; charset="utf-8"
66 # http://tools.ietf.org/html/rfc2616#section-14.1
67 unless ( defined $pair->[2] && lc $pair->[2] eq 'q' ) {
71 unless ( defined $qvalue ) {
72 $qvalue = 1 - ( ++$counter / 1000 );
75 $types{$type} = sprintf( '%.3f', $qvalue );
79 return $self->{content_types} =
80 [ sort { $types{$b} <=> $types{$a} } keys %types ];
83 sub preferred_content_type { $_[0]->accepted_content_types->[0] }
89 return grep { $_ eq $type } @{ $self->accepted_content_types };
94 Catalyst::Request::REST - A REST-y subclass of Catalyst::Request
98 if ( $c->request->accepts('application/json') ) {
102 my $types = $c->request->accepted_content_types();
106 This is a subclass of C<Catalyst::Request> that adds a few methods to
107 the request object to faciliate writing REST-y code. Currently, these
108 methods are all related to the content types accepted by the client.
110 Note that if you have a custom request class in your application, and it does
111 not inherit from C<Catalyst::Request::REST>, your application will fail with an
112 error indicating a conflict the first time it tries to use
113 C<Catalyst::Request::REST>'s functionality. To fix this error, make sure your
114 custom request class inherits from C<Catalyst::Request::REST>.
122 If the request went through the Deserializer action, this method will
123 return the deserialized data structure.
125 =item accepted_content_types
127 Returns an array reference of content types accepted by the
130 The list of types is created by looking at the following sources:
134 =item * Content-type header
136 If this exists, this will always be the first type in the list.
138 =item * content-type parameter
140 If the request is a GET request and there is a "content-type"
141 parameter in the query string, this will come before any types in the
144 =item * Accept header
146 This will be parsed and the types found will be ordered by the
147 relative quality specified for each type.
151 If a type appears in more than one of these places, it is ordered based on
152 where it is first found.
154 =item preferred_content_type
156 This returns the first content type found. It is shorthand for:
158 $request->accepted_content_types->[0]
162 Given a content type, this returns true if the type is accepted.
164 Note that this does not do any wildcard expansion of types.
170 Adam Jacob <adam@stalecoffee.org>, with lots of help from mst and jrockway
174 J. Shirley <jshirley@cpan.org>
178 You may distribute this code under the same terms as Perl itself.