3 # Created by: Adam Jacob, Marchex, <adam@hjksolutions.com>
4 # Created on: 10/13/2006 03:54:33 PM PDT
8 package Catalyst::Request::REST;
13 use base qw/Catalyst::Request Class::Accessor::Fast/;
16 use HTTP::Headers::Util qw(split_header_words);
18 sub _insert_self_into {
19 my ($class, $app_class ) = @_;
20 # the fallback to $app_class is for the (rare and deprecated) case when
21 # people are defining actions in MyApp.pm instead of in a controller.
22 my $app = Catalyst::Utils::class2appclass( $app_class ) || $app_class;
24 my $req_class = $app->request_class;
25 return if $req_class->isa($class);
26 if ($req_class eq 'Catalyst::Request') {
27 $app->request_class($class);
29 die "$app has a custom request class $req_class, "
30 . "which is not a $class; see Catalyst::Request::REST";
36 Catalyst::Request::REST - A REST-y subclass of Catalyst::Request
40 if ( $c->request->accepts('application/json') ) {
44 my $types = $c->request->accepted_content_types();
48 This is a subclass of C<Catalyst::Request> that adds a few methods to
49 the request object to faciliate writing REST-y code. Currently, these
50 methods are all related to the content types accepted by the client.
52 Note that if you have a custom request class in your application, and it does
53 not inherit from C<Catalyst::Request::REST>, your application will fail with an
54 error indicating a conflict the first time it tries to use
55 C<Catalyst::Request::REST>'s functionality. To fix this error, make sure your
56 custom request class inherits from C<Catalyst::Request::REST>.
60 If the request went through the Deserializer action, this method will
61 returned the deserialized data structure.
65 __PACKAGE__->mk_accessors(qw(data accept_only));
69 =item accepted_content_types
71 Returns an array reference of content types accepted by the
74 The list of types is created by looking at the following sources:
78 =item * Content-type header
80 If this exists, this will always be the first type in the list.
82 =item * content-type parameter
84 If the request is a GET request and there is a "content-type"
85 parameter in the query string, this will come before any types in the
90 This will be parsed and the types found will be ordered by the
91 relative quality specified for each type.
95 If a type appears in more than one of these places, it is ordered based on
96 where it is first found.
100 sub accepted_content_types {
103 return $self->{content_types} if $self->{content_types};
107 # First, we use the content type in the HTTP Request. It wins all.
108 $types{ $self->content_type } = 3
109 if $self->content_type;
111 if ($self->method eq "GET" && $self->param('content-type')) {
112 $types{ $self->param('content-type') } = 2;
115 # Third, we parse the Accept header, and see if the client
116 # takes a format we understand.
118 # This is taken from chansen's Apache2::UploadProgress.
119 if ( $self->header('Accept') ) {
120 $self->accept_only(1) unless keys %types;
122 my $accept_header = $self->header('Accept');
125 foreach my $pair ( split_header_words($accept_header) ) {
126 my ( $type, $qvalue ) = @{$pair}[ 0, 3 ];
127 next if $types{$type};
129 unless ( defined $qvalue ) {
130 $qvalue = 1 - ( ++$counter / 1000 );
133 $types{$type} = sprintf( '%.3f', $qvalue );
137 return $self->{content_types} =
138 [ sort { $types{$b} <=> $types{$a} } keys %types ];
141 =item preferred_content_type
143 This returns the first content type found. It is shorthand for:
145 $request->accepted_content_types->[0]
149 sub preferred_content_type { $_[0]->accepted_content_types->[0] }
153 Given a content type, this returns true if the type is accepted.
155 Note that this does not do any wildcard expansion of types.
163 return grep { $_ eq $type } @{ $self->accepted_content_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.