/usr/share/perl5/Catalyst/Action/SerializeBase.pm is in libcatalyst-action-rest-perl 1.21-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 | package Catalyst::Action::SerializeBase;
$Catalyst::Action::SerializeBase::VERSION = '1.21';
use Moose;
use namespace::autoclean;
extends 'Catalyst::Action';
use Module::Pluggable::Object;
use Catalyst::Request::REST;
use Catalyst::Utils ();
after BUILDARGS => sub {
my $class = shift;
my $config = shift;
Catalyst::Request::REST->_insert_self_into( $config->{class} );
};
has [qw(_serialize_plugins _loaded_plugins)] => ( is => 'rw' );
sub _load_content_plugins {
my $self = shift;
my ( $search_path, $controller, $c ) = @_;
unless ( defined( $self->_loaded_plugins ) ) {
$self->_loaded_plugins( {} );
}
# Load the Serialize Classes
unless ( defined( $self->_serialize_plugins ) ) {
my @plugins;
my $mpo =
Module::Pluggable::Object->new( 'search_path' => [$search_path], );
@plugins = $mpo->plugins;
$self->_serialize_plugins( \@plugins );
}
# 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->{'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;
}
$map = $config->{'map'};
$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} ) ) {
my $mc;
if ( ref( $map->{$content_type} ) eq "ARRAY" ) {
$mc = $map->{$content_type}->[0];
$sarg = $map->{$content_type}->[1];
} else {
$mc = $map->{$content_type};
}
# TODO: Handle custom serializers more elegantly.. this is a start,
# but how do we determine which is Serialize and Deserialize?
#if ($mc =~ /^+/) {
# $sclass = $mc;
# $sclass =~ s/^+//g;
#} else {
$sclass .= $mc;
#}
if ( !grep( /^$sclass$/, @{ $self->_serialize_plugins } ) ) {
return $self->unsupported_media_type($c, $content_type);
}
} else {
return $self->unsupported_media_type($c, $content_type);
}
unless ( exists( $self->_loaded_plugins->{$sclass} ) ) {
my $load_class = $sclass;
$load_class =~ s/::/\//g;
$load_class =~ s/$/.pm/g;
eval { require $load_class; };
if ($@) {
$c->log->error(
"Error loading $sclass for " . $content_type . ": $!" );
return $self->unsupported_media_type($c, $content_type);
} else {
$self->_loaded_plugins->{$sclass} = 1;
}
}
if ($search_path eq "Catalyst::Action::Serialize") {
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);
}
return $sclass, $sarg, $content_type;
}
sub unsupported_media_type {
my ( $self, $c, $content_type ) = @_;
$c->res->content_type('text/plain');
$c->res->status(415);
if (defined($content_type) && $content_type ne "") {
$c->res->body(
"Content-Type " . $content_type . " is not supported.\r\n" );
} else {
$c->res->body(
"Cannot find a Content-Type supported by your client.\r\n" );
}
return undef;
}
sub serialize_bad_request {
my ( $self, $c, $content_type, $error ) = @_;
$c->res->content_type('text/plain');
$c->res->status(400);
$c->res->body(
"Content-Type " . $content_type . " had a problem with your request.\r\n***ERROR***\r\n$error" );
return undef;
}
__PACKAGE__->meta->make_immutable;
1;
=head1 NAME
Catalyst::Action::SerializeBase - Base class for Catalyst::Action::Serialize and Catlayst::Action::Deserialize.
=head1 DESCRIPTION
This module implements the plugin loading and content-type negotiating
code for L<Catalyst::Action::Serialize> and L<Catalyst::Action::Deserialize>.
=head1 SEE ALSO
L<Catalyst::Action::Serialize>, L<Catalyst::Action::Deserialize>,
L<Catalyst::Controller::REST>,
=head1 AUTHORS
See L<Catalyst::Action::REST> for authors.
=head1 LICENSE
You may distribute this code under the same terms as Perl itself.
=cut
|