/usr/share/perl5/Dancer2/Core/Response.pm is in libdancer2-perl 0.204002+dfsg-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 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 | # ABSTRACT: Response object for Dancer2
package Dancer2::Core::Response;
$Dancer2::Core::Response::VERSION = '0.204002';
use Moo;
use Encode;
use Dancer2::Core::Types;
use Dancer2 ();
use Dancer2::Core::HTTP;
use HTTP::Headers::Fast;
use Scalar::Util qw(blessed);
use Plack::Util;
use Safe::Isa;
use Sub::Quote ();
use overload
'@{}' => sub { $_[0]->to_psgi },
'""' => sub { $_[0] };
has headers => (
is => 'ro',
isa => InstanceOf['HTTP::Headers'],
lazy => 1,
coerce => sub {
my ($value) = @_;
# HTTP::Headers::Fast reports that it isa 'HTTP::Headers',
# but there is no actual inheritance.
$value->$_isa('HTTP::Headers')
? $value
: HTTP::Headers::Fast->new(@{$value});
},
default => sub {
HTTP::Headers::Fast->new();
},
handles => [qw<header push_header>],
);
sub headers_to_array {
my $self = shift;
my $headers = shift || $self->headers;
my @hdrs;
$headers->scan( sub {
my ( $k, $v ) = @_;
$v =~ s/\015\012[\040|\011]+/chr(32)/ge; # replace LWS with a single SP
$v =~ s/\015|\012//g; # remove CR and LF since the char is invalid here
push @hdrs, $k => $v;
});
return \@hdrs;
}
# boolean to tell if the route passes or not
has has_passed => (
is => 'rw',
isa => Bool,
default => sub {0},
);
sub pass { shift->has_passed(1) }
has serializer => (
is => 'ro',
isa => ConsumerOf ['Dancer2::Core::Role::Serializer'],
);
has is_encoded => (
is => 'rw',
isa => Bool,
default => sub {0},
);
has is_halted => (
is => 'rw',
isa => Bool,
default => sub {0},
);
sub halt {
my ( $self, $content ) = @_;
$self->content( $content ) if @_ > 1;
$self->is_halted(1);
}
has status => (
is => 'rw',
isa => Num,
default => sub {200},
lazy => 1,
coerce => sub { Dancer2::Core::HTTP->status(shift) },
);
has content => (
is => 'rw',
isa => Str,
predicate => 'has_content',
clearer => 'clear_content',
);
has server_tokens => (
is => 'ro',
isa => Bool,
default => sub {1},
);
around content => sub {
my ( $orig, $self ) = ( shift, shift );
# called as getter?
@_ or return $self->$orig;
# No serializer defined; encode content
$self->serializer
or return $self->$orig( $self->encode_content(@_) );
# serialize content
my $serialized = $self->serialize(@_);
$self->is_encoded(1); # All serializers return byte strings
return $self->$orig( defined $serialized ? $serialized : '' );
};
has default_content_type => (
is => 'rw',
isa => Str,
default => sub {'text/html'},
);
sub encode_content {
my ( $self, $content ) = @_;
return $content if $self->is_encoded;
# Apply default content type if none set.
my $ct = $self->content_type ||
$self->content_type( $self->default_content_type );
return $content if $ct !~ /^text/;
# we don't want to encode an empty string, it will break the output
$content or return $content;
$self->content_type("$ct; charset=UTF-8")
if $ct !~ /charset/;
$self->is_encoded(1);
return Encode::encode( 'UTF-8', $content );
}
sub new_from_plack {
my ($self, $psgi_res) = @_;
return Dancer2::Core::Response->new(
status => $psgi_res->status,
headers => $psgi_res->headers,
content => $psgi_res->body,
);
}
sub new_from_array {
my ($self, $arrayref) = @_;
return Dancer2::Core::Response->new(
status => $arrayref->[0],
headers => $arrayref->[1],
content => $arrayref->[2][0],
);
}
sub to_psgi {
my ($self) = @_;
$self->server_tokens
and $self->header( 'Server' => "Perl Dancer2 " . Dancer2->VERSION );
my $headers = $self->headers;
my $status = $self->status;
Plack::Util::status_with_no_entity_body($status)
and return [ $status, $self->headers_to_array($headers), [] ];
my $content = $self->content;
# It is possible to have no content and/or no content type set
# e.g. if all routes 'pass'. Set the default value for the content
# (an empty string), allowing serializer hooks to be triggered
# as they may change the content..
$content = $self->content('') if ! defined $content;
if ( !$headers->header('Content-Length') &&
!$headers->header('Transfer-Encoding') &&
defined( my $content_length = length $content ) ) {
$headers->push_header( 'Content-Length' => $content_length );
}
# More defaults
$self->content_type or $self->content_type($self->default_content_type);
return [ $status, $self->headers_to_array($headers), [ $content ], ];
}
# sugar for accessing the content_type header, with mimetype care
sub content_type {
my $self = shift;
if ( scalar @_ > 0 ) {
my $runner = Dancer2::runner();
my $mimetype = $runner->mime_type->name_or_type(shift);
$self->header( 'Content-Type' => $mimetype );
return $mimetype;
}
else {
return $self->header('Content-Type');
}
}
has _forward => (
is => 'rw',
isa => HashRef,
);
sub forward {
my ( $self, $uri, $params, $opts ) = @_;
$self->_forward( { to_url => $uri, params => $params, options => $opts } );
}
sub is_forwarded {
my $self = shift;
$self->_forward;
}
sub redirect {
my ( $self, $destination, $status ) = @_;
$self->status( $status || 302 );
# we want to stringify the $destination object (URI object)
$self->header( 'Location' => "$destination" );
}
sub error {
my $self = shift;
my $error = Dancer2::Core::Error->new(
response => $self,
@_,
);
$error->throw;
return $error;
}
sub serialize {
my ($self, $content) = @_;
my $serializer = $self->serializer
or return;
$content = $serializer->serialize($content)
or return;
$self->content_type( $serializer->content_type );
return $content;
}
1;
__END__
=pod
=encoding UTF-8
=head1 NAME
Dancer2::Core::Response - Response object for Dancer2
=head1 VERSION
version 0.204002
=head1 ATTRIBUTES
=head2 is_encoded
Flag to tell if the content has already been encoded.
=head2 is_halted
Flag to tell whether or not the response should continue to be processed.
=head2 status
The HTTP status for the response.
=head2 content
The content for the response, stored as a string. If a reference is passed, the
response will try coerce it to a string via double quote interpolation.
=head2 default_content_type
Default mime type to use for the response Content-Type header
if nothing was specified
=head2 headers
The attribute that store the headers in a L<HTTP::Headers::Fast> object.
That attribute coerces from ArrayRef and defaults to an empty L<HTTP::Headers::Fast>
instance.
=head1 METHODS
=head2 pass
Set has_passed to true.
=head2 serializer()
Returns the optional serializer object used to deserialize request parameters
=head2 halt
Shortcut to halt the current response by setting the is_halted flag.
=head2 encode_content
Encodes the stored content according to the stored L<content_type>. If the content_type
is a text format C<^text>, then no encoding will take place.
Internally, it uses the L<is_encoded> flag to make sure that content is not encoded twice.
If it encodes the content, then it will return the encoded content. In all other
cases it returns C<false>.
=head2 new_from_plack
Creates a new response object from a L<Plack::Response> object.
=head2 new_from_array
Creates a new response object from a PSGI arrayref.
=head2 to_psgi
Converts the response object to a PSGI array.
=head2 content_type($type)
A little sugar for setting or accessing the content_type of the response, via the headers.
=head2 redirect ($destination, $status)
Sets a header in this response to give a redirect to $destination, and sets the
status to $status. If $status is omitted, or false, then it defaults to a status of
302.
=head2 error( @args )
$response->error( message => "oops" );
Creates a L<Dancer2::Core::Error> object with the given I<@args> and I<throw()>
it against the response object. Returns the error object.
=head2 serialize( $content )
$response->serialize( $content );
Serialize and return $content with the response's serializer.
set content-type accordingly.
=head2 header($name)
Return the value of the given header, if present. If the header has multiple
values, returns the list of values if called in list context, the first one
if in scalar context.
=head2 push_header
Add the header no matter if it already exists or not.
$self->push_header( 'X-Wing' => '1' );
It can also be called with multiple values to add many times the same header
with different values:
$self->push_header( 'X-Wing' => 1, 2, 3 );
=head2 headers_to_array($headers)
Convert the C<$headers> to a PSGI ArrayRef.
If no C<$headers> are provided, it will use the current response headers.
=head1 AUTHOR
Dancer Core Developers
=head1 COPYRIGHT AND LICENSE
This software is copyright (c) 2016 by Alexis Sukrieh.
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.
=cut
|