Commit | Line | Data |
e601adda |
1 | package Catalyst::Action::SerializeBase; |
2 | |
930013e6 |
3 | use Moose; |
4 | use namespace::autoclean; |
e601adda |
5 | |
930013e6 |
6 | extends 'Catalyst::Action'; |
e601adda |
7 | use Module::Pluggable::Object; |
9a76221e |
8 | use Catalyst::Request::REST; |
5132f5e4 |
9 | use Catalyst::Utils (); |
9a76221e |
10 | |
cc188065 |
11 | # VERSION |
f465980c |
12 | |
05009b91 |
13 | after BUILDARGS => sub { |
14 | my $class = shift; |
15 | my $config = shift; |
16 | Catalyst::Request::REST->_insert_self_into( $config->{class} ); |
17 | }; |
e601adda |
18 | |
05009b91 |
19 | has [qw(_serialize_plugins _loaded_plugins)] => ( is => 'rw' ); |
e601adda |
20 | |
21 | sub _load_content_plugins { |
22 | my $self = shift; |
23 | my ( $search_path, $controller, $c ) = @_; |
24 | |
25 | unless ( defined( $self->_loaded_plugins ) ) { |
26 | $self->_loaded_plugins( {} ); |
27 | } |
28 | |
29 | # Load the Serialize Classes |
30 | unless ( defined( $self->_serialize_plugins ) ) { |
31 | my @plugins; |
32 | my $mpo = |
33 | Module::Pluggable::Object->new( 'search_path' => [$search_path], ); |
34 | @plugins = $mpo->plugins; |
35 | $self->_serialize_plugins( \@plugins ); |
36 | } |
37 | |
e601adda |
38 | # Finally, we load the class. If you have a default serializer, |
39 | # and we still don't have a content-type that exists in the map, |
40 | # we'll use it. |
41 | my $sclass = $search_path . "::"; |
42 | my $sarg; |
faf5c20b |
43 | my $map; |
367b3ff4 |
44 | |
faf5c20b |
45 | my $config; |
46 | |
07682cbc |
47 | if ( exists $controller->{'serialize'} ) { |
9cd203c9 |
48 | $c->log->info("Catalyst::Action::REST - deprecated use of 'serialize' for configuration."); |
49 | $c->log->info("Please see 'CONFIGURATION' in Catalyst::Controller::REST."); |
07682cbc |
50 | $config = $controller->{'serialize'}; |
7b8c5be2 |
51 | # if they're using the deprecated config, they may be expecting a |
52 | # default mapping too. |
53 | $config->{map} ||= $controller->{map}; |
faf5c20b |
54 | } else { |
07682cbc |
55 | $config = $controller; |
faf5c20b |
56 | } |
57 | $map = $config->{'map'}; |
c0aef9cd |
58 | |
a51e7bbd |
59 | # pick preferred content type |
60 | my @accepted_types; # priority order, best first |
61 | # give top priority to content type specified by stash, if any |
62 | my $content_type_stash_key = $config->{content_type_stash_key}; |
63 | if ($content_type_stash_key |
64 | and my $stashed = $c->stash->{$content_type_stash_key} |
65 | ) { |
66 | # convert to array if not already a ref |
67 | $stashed = [ $stashed ] if not ref $stashed; |
68 | push @accepted_types, @$stashed; |
367b3ff4 |
69 | } |
a51e7bbd |
70 | # then content types requested by caller |
71 | push @accepted_types, @{ $c->request->accepted_content_types }; |
72 | # then the default |
73 | push @accepted_types, $config->{'default'} if $config->{'default'}; |
74 | # pick the best match that we have a serializer mapping for |
75 | my ($content_type) = grep { $map->{$_} } @accepted_types; |
76 | |
b3996af8 |
77 | return $self->unsupported_media_type($c, $content_type) |
a51e7bbd |
78 | if not $content_type; |
367b3ff4 |
79 | |
c0aef9cd |
80 | # carp about old text/x-json |
81 | if ($content_type eq 'text/x-json') { |
82 | $c->log->info('Using deprecated text/x-json content-type.'); |
83 | $c->log->info('Use application/json instead!'); |
84 | } |
85 | |
e601adda |
86 | if ( exists( $map->{$content_type} ) ) { |
87 | my $mc; |
88 | if ( ref( $map->{$content_type} ) eq "ARRAY" ) { |
89 | $mc = $map->{$content_type}->[0]; |
90 | $sarg = $map->{$content_type}->[1]; |
91 | } else { |
92 | $mc = $map->{$content_type}; |
93 | } |
94 | # TODO: Handle custom serializers more elegantly.. this is a start, |
95 | # but how do we determine which is Serialize and Deserialize? |
96 | #if ($mc =~ /^+/) { |
97 | # $sclass = $mc; |
98 | # $sclass =~ s/^+//g; |
99 | #} else { |
100 | $sclass .= $mc; |
101 | #} |
102 | if ( !grep( /^$sclass$/, @{ $self->_serialize_plugins } ) ) { |
b3996af8 |
103 | return $self->unsupported_media_type($c, $content_type); |
e601adda |
104 | } |
105 | } else { |
b3996af8 |
106 | return $self->unsupported_media_type($c, $content_type); |
e601adda |
107 | } |
108 | unless ( exists( $self->_loaded_plugins->{$sclass} ) ) { |
109 | my $load_class = $sclass; |
110 | $load_class =~ s/::/\//g; |
111 | $load_class =~ s/$/.pm/g; |
112 | eval { require $load_class; }; |
113 | if ($@) { |
114 | $c->log->error( |
d4611771 |
115 | "Error loading $sclass for " . $content_type . ": $!" ); |
b3996af8 |
116 | return $self->unsupported_media_type($c, $content_type); |
e601adda |
117 | } else { |
118 | $self->_loaded_plugins->{$sclass} = 1; |
119 | } |
120 | } |
121 | |
122 | if ($search_path eq "Catalyst::Action::Serialize") { |
123 | if ($content_type) { |
124 | $c->response->header( 'Vary' => 'Content-Type' ); |
9a76221e |
125 | } elsif ($c->request->accept_only) { |
e601adda |
126 | $c->response->header( 'Vary' => 'Accept' ); |
127 | } |
128 | $c->response->content_type($content_type); |
129 | } |
130 | |
131 | return $sclass, $sarg, $content_type; |
132 | } |
133 | |
b3996af8 |
134 | sub unsupported_media_type { |
e601adda |
135 | my ( $self, $c, $content_type ) = @_; |
136 | $c->res->content_type('text/plain'); |
137 | $c->res->status(415); |
2224bad1 |
138 | if (defined($content_type) && $content_type ne "") { |
e601adda |
139 | $c->res->body( |
140 | "Content-Type " . $content_type . " is not supported.\r\n" ); |
141 | } else { |
142 | $c->res->body( |
143 | "Cannot find a Content-Type supported by your client.\r\n" ); |
144 | } |
145 | return undef; |
146 | } |
147 | |
b3996af8 |
148 | sub serialize_bad_request { |
e601adda |
149 | my ( $self, $c, $content_type, $error ) = @_; |
150 | $c->res->content_type('text/plain'); |
151 | $c->res->status(400); |
152 | $c->res->body( |
153 | "Content-Type " . $content_type . " had a problem with your request.\r\n***ERROR***\r\n$error" ); |
154 | return undef; |
155 | } |
156 | |
05009b91 |
157 | __PACKAGE__->meta->make_immutable; |
e601adda |
158 | |
8d30469f |
159 | 1; |
160 | |
e601adda |
161 | =head1 NAME |
162 | |
26b59bcb |
163 | Catalyst::Action::SerializeBase - Base class for Catalyst::Action::Serialize and Catlayst::Action::Deserialize. |
e601adda |
164 | |
165 | =head1 DESCRIPTION |
166 | |
167 | This module implements the plugin loading and content-type negotiating |
168 | code for L<Catalyst::Action::Serialize> and L<Catalyst::Action::Deserialize>. |
169 | |
170 | =head1 SEE ALSO |
171 | |
172 | L<Catalyst::Action::Serialize>, L<Catalyst::Action::Deserialize>, |
173 | L<Catalyst::Controller::REST>, |
174 | |
5cb5f6bb |
175 | =head1 AUTHORS |
e601adda |
176 | |
5cb5f6bb |
177 | See L<Catalyst::Action::REST> for authors. |
e601adda |
178 | |
179 | =head1 LICENSE |
180 | |
181 | You may distribute this code under the same terms as Perl itself. |
182 | |
183 | =cut |