X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FCatalyst%2FAction%2FSerializeBase.pm;h=ba0cdf4e6313e34957974c928eaca50d976d4cdc;hb=c0008fc76f34cc22ceaf80003191f73a2300bfe5;hp=7dfe1e8db70f54e3cc20f3664e69c790937df9a9;hpb=d4611771994693e9145e19c00c4b2d5bc7b485eb;p=catagits%2FCatalyst-Action-REST.git diff --git a/lib/Catalyst/Action/SerializeBase.pm b/lib/Catalyst/Action/SerializeBase.pm index 7dfe1e8..ba0cdf4 100644 --- a/lib/Catalyst/Action/SerializeBase.pm +++ b/lib/Catalyst/Action/SerializeBase.pm @@ -1,23 +1,20 @@ -# -# Catlyst::Action::SerializeBase.pm -# Created by: Adam Jacob, Marchex, -# -# $Id$ - package Catalyst::Action::SerializeBase; -use strict; -use warnings; +use Moose; +use namespace::autoclean; -use base 'Catalyst::Action'; +extends 'Catalyst::Action'; use Module::Pluggable::Object; -use Data::Dump qw(dump); use Catalyst::Request::REST; +use Catalyst::Utils (); -Catalyst->request_class('Catalyst::Request::REST') - unless Catalyst->request_class->isa('Catalyst::Request::REST'); +after BUILDARGS => sub { + my $class = shift; + my $config = shift; + Catalyst::Request::REST->_insert_self_into( $config->{class} ); +}; -__PACKAGE__->mk_accessors(qw(_serialize_plugins _loaded_plugins)); +has [qw(_serialize_plugins _loaded_plugins)] => ( is => 'rw' ); sub _load_content_plugins { my $self = shift; @@ -36,33 +33,76 @@ sub _load_content_plugins { $self->_serialize_plugins( \@plugins ); } - my $content_type = $c->request->preferred_content_type || ''; - # Finally, we load the class. If you have a default serializer, # and we still don't have a content-type that exists in the map, # we'll use it. my $sclass = $search_path . "::"; my $sarg; my $map; + my $compliance_mode; + my $default; my $config; - if ( exists $controller->config->{'serialize'} ) { - $c->log->info("Using deprecated configuration for Catalyst::Action::REST!"); - $c->log->info("Please see perldoc Catalyst::Action::REST for the update guide"); - $config = $controller->config->{'serialize'}; + if ( exists $controller->{'serialize'} ) { + $c->log->info("Catalyst::Action::REST - deprecated use of 'serialize' for configuration."); + $c->log->info("Please see 'CONFIGURATION' in Catalyst::Controller::REST."); + $config = $controller->{'serialize'}; + # if they're using the deprecated config, they may be expecting a + # default mapping too. + $config->{map} ||= $controller->{map}; } else { - $config = $controller->config; + $config = $controller; } $map = $config->{'map'}; - # If we don't have a handler for our preferred content type, try - # the default - if ( ! exists $map->{$content_type} ) { - if( exists $config->{'default'} ) { - $content_type = $config->{'default'} ; - } else { - return $self->_unsupported_media_type($c, $content_type); - } + $default = $config->{'default'} if $config->{'default'}; + + # If we're in RFC 7231 compliance mode we need to determine if we're + # serializing or deserializing, then set the request object to + # look at the appropriate set of supported content types. + $compliance_mode = $config->{'compliance_mode'}; + if($compliance_mode) { + my $serialize_mode = (split '::', $search_path)[-1]; + if($serialize_mode eq 'Deserialize') { + # Tell the request object to only look at the Content-Type header + $c->request->set_content_type_only(); + + # If we're in compliance mode and doing deserializing we want + # to use the allowed content types for deserializing, not the + # serializer map + $map = $config->{'deserialize_map'}; + $default = $config->{'deserialize_default'} if $config->{'deserialize_default'}; + } elsif($serialize_mode eq 'Serialize') { + # Tell the request object to only look at the Accept header + $c->request->set_accept_only(); + } + } + + # pick preferred content type + my @accepted_types; # priority order, best first + # give top priority to content type specified by stash, if any + my $content_type_stash_key = $config->{content_type_stash_key}; + if ($content_type_stash_key + and my $stashed = $c->stash->{$content_type_stash_key} + ) { + # convert to array if not already a ref + $stashed = [ $stashed ] if not ref $stashed; + push @accepted_types, @$stashed; + } + # then content types requested by caller + push @accepted_types, @{ $c->request->accepted_content_types }; + # then the default + push @accepted_types, $default if $default; + # pick the best match that we have a serializer mapping for + my ($content_type) = grep { $map->{$_} } @accepted_types; + + return $self->unsupported_media_type($c, $content_type) + if not $content_type; + + # carp about old text/x-json + if ($content_type eq 'text/x-json') { + $c->log->info('Using deprecated text/x-json content-type.'); + $c->log->info('Use application/json instead!'); } if ( exists( $map->{$content_type} ) ) { @@ -82,10 +122,10 @@ sub _load_content_plugins { $sclass .= $mc; #} if ( !grep( /^$sclass$/, @{ $self->_serialize_plugins } ) ) { - return $self->_unsupported_media_type($c, $content_type); + return $self->unsupported_media_type($c, $content_type); } } else { - return $self->_unsupported_media_type($c, $content_type); + return $self->unsupported_media_type($c, $content_type); } unless ( exists( $self->_loaded_plugins->{$sclass} ) ) { my $load_class = $sclass; @@ -95,17 +135,19 @@ sub _load_content_plugins { if ($@) { $c->log->error( "Error loading $sclass for " . $content_type . ": $!" ); - return $self->_unsupported_media_type($c, $content_type); + return $self->unsupported_media_type($c, $content_type); } else { $self->_loaded_plugins->{$sclass} = 1; } } if ($search_path eq "Catalyst::Action::Serialize") { - if ($content_type) { - $c->response->header( 'Vary' => 'Content-Type' ); - } elsif ($c->request->accept_only) { - $c->response->header( 'Vary' => 'Accept' ); + unless( $c->response->header( 'Vary' ) ) { + if ($content_type) { + $c->response->header( 'Vary' => 'Content-Type' ); + } elsif ($c->request->accept_only) { + $c->response->header( 'Vary' => 'Accept' ); + } } $c->response->content_type($content_type); } @@ -113,7 +155,7 @@ sub _load_content_plugins { return $sclass, $sarg, $content_type; } -sub _unsupported_media_type { +sub unsupported_media_type { my ( $self, $c, $content_type ) = @_; $c->res->content_type('text/plain'); $c->res->status(415); @@ -127,7 +169,7 @@ sub _unsupported_media_type { return undef; } -sub _serialize_bad_request { +sub serialize_bad_request { my ( $self, $c, $content_type, $error ) = @_; $c->res->content_type('text/plain'); $c->res->status(400); @@ -136,13 +178,13 @@ sub _serialize_bad_request { return undef; } +__PACKAGE__->meta->make_immutable; + 1; =head1 NAME -B - -Base class for Catalyst::Action::Serialize and Catlayst::Action::Deserialize. +Catalyst::Action::SerializeBase - Base class for Catalyst::Action::Serialize and Catlayst::Action::Deserialize. =head1 DESCRIPTION @@ -154,15 +196,12 @@ code for L and L. L, L, L, -=head1 AUTHOR +=head1 AUTHORS -Adam Jacob , with lots of help from mst and jrockway. - -Marchex, Inc. paid me while I developed this module. (http://www.marchex.com) +See L for authors. =head1 LICENSE You may distribute this code under the same terms as Perl itself. =cut -