2 # Catlyst::Action::SerializeBase.pm
3 # Created by: Adam Jacob, Marchex, <adam@hjksolutions.com>
7 package Catalyst::Action::SerializeBase;
12 use base 'Catalyst::Action';
13 use Module::Pluggable::Object;
14 use Catalyst::Request::REST;
15 use Catalyst::Utils ();
20 Catalyst::Request::REST->_insert_self_into(
21 Catalyst::Utils::class2appclass($config->{class})
23 return $class->SUPER::new($config, @_);
26 __PACKAGE__->mk_accessors(qw(_serialize_plugins _loaded_plugins));
28 sub _load_content_plugins {
30 my ( $search_path, $controller, $c ) = @_;
32 unless ( defined( $self->_loaded_plugins ) ) {
33 $self->_loaded_plugins( {} );
36 # Load the Serialize Classes
37 unless ( defined( $self->_serialize_plugins ) ) {
40 Module::Pluggable::Object->new( 'search_path' => [$search_path], );
41 @plugins = $mpo->plugins;
42 $self->_serialize_plugins( \@plugins );
45 # Finally, we load the class. If you have a default serializer,
46 # and we still don't have a content-type that exists in the map,
48 my $sclass = $search_path . "::";
54 if ( exists $controller->{'serialize'} ) {
55 $c->log->info("Using deprecated configuration for Catalyst::Action::REST!");
56 $c->log->info("Please see perldoc Catalyst::Action::REST for the update guide");
57 $config = $controller->{'serialize'};
59 $config = $controller;
61 $map = $config->{'map'};
63 # pick preferred content type
64 my @accepted_types; # priority order, best first
65 # give top priority to content type specified by stash, if any
66 my $content_type_stash_key = $config->{content_type_stash_key};
67 if ($content_type_stash_key
68 and my $stashed = $c->stash->{$content_type_stash_key}
70 # convert to array if not already a ref
71 $stashed = [ $stashed ] if not ref $stashed;
72 push @accepted_types, @$stashed;
74 # then content types requested by caller
75 push @accepted_types, @{ $c->request->accepted_content_types };
77 push @accepted_types, $config->{'default'} if $config->{'default'};
78 # pick the best match that we have a serializer mapping for
79 my ($content_type) = grep { $map->{$_} } @accepted_types;
81 return $self->_unsupported_media_type($c, $content_type)
84 # carp about old text/x-json
85 if ($content_type eq 'text/x-json') {
86 $c->log->info('Using deprecated text/x-json content-type.');
87 $c->log->info('Use application/json instead!');
90 if ( exists( $map->{$content_type} ) ) {
92 if ( ref( $map->{$content_type} ) eq "ARRAY" ) {
93 $mc = $map->{$content_type}->[0];
94 $sarg = $map->{$content_type}->[1];
96 $mc = $map->{$content_type};
98 # TODO: Handle custom serializers more elegantly.. this is a start,
99 # but how do we determine which is Serialize and Deserialize?
102 # $sclass =~ s/^+//g;
106 if ( !grep( /^$sclass$/, @{ $self->_serialize_plugins } ) ) {
107 return $self->_unsupported_media_type($c, $content_type);
110 return $self->_unsupported_media_type($c, $content_type);
112 unless ( exists( $self->_loaded_plugins->{$sclass} ) ) {
113 my $load_class = $sclass;
114 $load_class =~ s/::/\//g;
115 $load_class =~ s/$/.pm/g;
116 eval { require $load_class; };
119 "Error loading $sclass for " . $content_type . ": $!" );
120 return $self->_unsupported_media_type($c, $content_type);
122 $self->_loaded_plugins->{$sclass} = 1;
126 if ($search_path eq "Catalyst::Action::Serialize") {
128 $c->response->header( 'Vary' => 'Content-Type' );
129 } elsif ($c->request->accept_only) {
130 $c->response->header( 'Vary' => 'Accept' );
132 $c->response->content_type($content_type);
135 return $sclass, $sarg, $content_type;
138 sub _unsupported_media_type {
139 my ( $self, $c, $content_type ) = @_;
140 $c->res->content_type('text/plain');
141 $c->res->status(415);
142 if (defined($content_type) && $content_type ne "") {
144 "Content-Type " . $content_type . " is not supported.\r\n" );
147 "Cannot find a Content-Type supported by your client.\r\n" );
152 sub _serialize_bad_request {
153 my ( $self, $c, $content_type, $error ) = @_;
154 $c->res->content_type('text/plain');
155 $c->res->status(400);
157 "Content-Type " . $content_type . " had a problem with your request.\r\n***ERROR***\r\n$error" );
165 B<Catalyst::Action::SerializeBase>
167 Base class for Catalyst::Action::Serialize and Catlayst::Action::Deserialize.
171 This module implements the plugin loading and content-type negotiating
172 code for L<Catalyst::Action::Serialize> and L<Catalyst::Action::Deserialize>.
176 L<Catalyst::Action::Serialize>, L<Catalyst::Action::Deserialize>,
177 L<Catalyst::Controller::REST>,
181 Adam Jacob <adam@stalecoffee.org>, with lots of help from mst and jrockway.
183 Marchex, Inc. paid me while I developed this module. (http://www.marchex.com)
187 You may distribute this code under the same terms as Perl itself.