1 package Catalyst::Response;
5 use Moose::Util::TypeConstraints;
6 use namespace::autoclean;
7 use Scalar::Util 'blessed';
8 use Catalyst::Response::Writer;
9 use Catalyst::Utils ();
11 with 'MooseX::Emulate::Class::Accessor::Fast';
13 our $DEFAULT_ENCODE_CONTENT_TYPE_MATCH = qr{text|xml$|javascript$};
15 has encodable_content_type => (
18 default => sub { $DEFAULT_ENCODE_CONTENT_TYPE_MATCH }
24 writer => '_set_response_cb',
25 clearer => '_clear_response_cb',
26 predicate => '_has_response_cb',
29 subtype 'Catalyst::Engine::Types::Writer',
30 as duck_type([qw(write close)]);
34 isa => 'Catalyst::Engine::Types::Writer', #Pointless since we control how this is built
35 #writer => '_set_writer', Now that its lazy I think this is safe to remove
36 clearer => '_clear_writer',
37 predicate => '_has_writer',
39 builder => '_build_writer',
45 ## These two lines are probably crap now...
46 $self->_context->finalize_headers unless
47 $self->finalized_headers;
50 $self->headers->scan(sub { push @headers, @_ });
52 my $writer = $self->_response_cb->([ $self->status, \@headers ]);
53 $self->_clear_response_cb;
60 predicate=>'_has_write_fh',
62 builder=>'_build_write_fh',
66 my $writer = $_[0]->_writer; # We need to get the finalize headers side effect...
67 my $requires_encoding = $_[0]->encodable_response;
70 _context => $_[0]->_context,
71 _requires_encoding => $requires_encoding,
74 return bless \%fields, 'Catalyst::Response::Writer';
79 return if $self->_has_write_fh;
80 if($self->_has_writer) {
85 has cookies => (is => 'rw', default => sub { {} });
86 has body => (is => 'rw', default => undef);
87 sub has_body { defined($_[0]->body) }
89 has location => (is => 'rw');
90 has status => (is => 'rw', default => 200);
91 has finalized_headers => (is => 'rw', default => 0);
94 isa => 'HTTP::Headers',
95 handles => [qw(content_encoding content_length content_type content_type_charset header)],
96 default => sub { HTTP::Headers->new() },
103 clearer => '_clear_context',
106 before [qw(status headers content_encoding content_length content_type )] => sub {
109 $self->_context->log->warn(
110 "Useless setting a header value after finalize_headers and the response callback has been called." .
111 " Since we don't support tail headers this will not work as you might expect." )
112 if ( $self->_context && $self->finalized_headers && !$self->_has_response_cb && @_ );
115 # This has to be different since the first param to ->header is the header name and presumably
116 # you should be able to request the header even after finalization, just not try to change it.
117 before 'header' => sub {
121 $self->_context->log->warn(
122 "Useless setting a header value after finalize_headers and the response callback has been called." .
123 " Since we don't support tail headers this will not work as you might expect." )
124 if ( $self->_context && $self->finalized_headers && !$self->_has_response_cb && @_ );
127 sub output { shift->body(@_) }
129 sub code { shift->status(@_) }
132 my ( $self, $buffer ) = @_;
134 # Finalize headers if someone manually writes output
135 $self->_context->finalize_headers unless $self->finalized_headers;
137 $buffer = q[] unless defined $buffer;
139 if($self->encodable_response) {
140 $buffer = $self->_context->encoding->encode( $buffer, $self->_context->_encode_check )
143 my $len = length($buffer);
144 $self->_writer->write($buffer);
149 sub unencoded_write {
150 my ( $self, $buffer ) = @_;
152 # Finalize headers if someone manually writes output
153 $self->_context->finalize_headers unless $self->finalized_headers;
155 $buffer = q[] unless defined $buffer;
157 my $len = length($buffer);
158 $self->_writer->write($buffer);
163 sub finalize_headers {
168 sub from_psgi_response {
169 my ($self, $psgi_res) = @_;
170 if(blessed($psgi_res) && $psgi_res->can('as_psgi')) {
171 $psgi_res = $psgi_res->as_psgi;
173 if(ref $psgi_res eq 'ARRAY') {
174 my ($status, $headers, $body) = @$psgi_res;
175 $self->status($status);
176 $self->headers(HTTP::Headers->new(@$headers));
177 # Can be arrayref or filehandle...
178 if(defined $body) { # probably paranoia
179 ref $body eq 'ARRAY' ? $self->body(join('', @$body)) : $self->body($body);
181 } elsif(ref $psgi_res eq 'CODE') {
183 my $response = shift;
184 my ($status, $headers, $maybe_body) = @$response;
185 $self->status($status);
186 $self->headers(HTTP::Headers->new(@$headers));
187 if(defined $maybe_body) {
188 # Can be arrayref or filehandle...
189 ref $maybe_body eq 'ARRAY' ? $self->body(join('', @$maybe_body)) : $self->body($maybe_body);
191 return $self->write_fh;
195 die "You can't set a Catalyst response from that, expect a valid PSGI response";
198 # Encoding compatibilty. If the response set a charset, well... we need
199 # to assume its properly encoded and NOT encode for this response. Otherwise
200 # We risk double encoding.
201 if($self->content_type_charset) {
202 # We have to do this since for backcompat reasons having a charset doesn't always
203 # mean that the body is already encoded :(
204 $self->_context->clear_encoding;
210 Catalyst::Response - stores output responding to the current client request
217 $res->content_encoding;
218 $res->content_length;
230 This is the Catalyst Response class, which provides methods for responding to
231 the current client request. The appropriate L<Catalyst::Engine> for your environment
232 will turn the Catalyst::Response into a HTTP Response and return it to the client.
236 =head2 $res->body( $text | $fh | $iohandle_object )
238 $c->response->body('Catalyst rocks!');
240 Sets or returns the output (text or binary data). If you are returning a large body,
241 you might want to use a L<IO::Handle> type of object (Something that implements the getline method
242 in the same fashion), or a filehandle GLOB. These will be passed down to the PSGI
243 handler you are using and might be optimized using server specific abilities (for
244 example L<Twiggy> will attempt to server a real local file in a non blocking manner).
246 If you are using a filehandle as the body response you are responsible for
247 making sure it conforms to the L<PSGI> specification with regards to content
248 encoding. Unlike with scalar body values or when using the streaming interfaces
249 we currently do not attempt to normalize and encode your filehandle. In general
250 this means you should be sure to be sending bytes not UTF8 decoded multibyte
253 Most of the time when you do:
255 open(my $fh, '<:raw', $path);
257 You should be fine. If you open a filehandle with a L<PerlIO> layer you probably
258 are not fine. You can usually fix this by explicitly using binmode to set
259 the IOLayer to :raw. Its possible future versions of L<Catalyst> will try to
260 'do the right thing'.
262 When using a L<IO::Handle> type of object and no content length has been
263 already set in the response headers Catalyst will make a reasonable attempt
264 to determine the size of the Handle. Depending on the implementation of your
265 handle object, setting the content length may fail. If it is at all possible
266 for you to determine the content length of your handle object,
267 it is recommended that you set the content length in the response headers
268 yourself, which will be respected and sent by Catalyst in the response.
270 Please note that the object needs to implement C<getline>, not just
271 C<read>. Older versions of L<Catalyst> expected your filehandle like objects
272 to do read. If you have code written for this expectation and you cannot
273 change the code to meet the L<PSGI> specification, you can try the following
274 middleware L<Plack::Middleware::AdaptFilehandleRead> which will attempt to
275 wrap your object in an interface that so conforms.
277 Starting from version 5.90060, when using an L<IO::Handle> object, you
278 may want to use L<Plack::Middleware::XSendfile>, to delegate the
279 actual serving to the frontend server. To do so, you need to pass to
280 C<body> an IO object with a C<path> method. This can be achieved in
283 Either using L<Plack::Util>:
285 my $fh = IO::File->new($file, 'r');
286 Plack::Util::set_io_path($fh, $file);
288 Or using L<IO::File::WithPath>
290 my $fh = IO::File::WithPath->new($file, 'r');
292 And then passing the filehandle to body and setting headers, if needed.
294 $c->response->body($fh);
295 $c->response->headers->content_type('text/plain');
296 $c->response->headers->content_length(-s $file);
297 $c->response->headers->last_modified((stat($file))[9]);
299 L<Plack::Middleware::XSendfile> can be loaded in the application so:
304 # other middlewares here...
308 B<Beware> that loading the middleware without configuring the
309 webserver to set the request header C<X-Sendfile-Type> to a supported
310 type (C<X-Accel-Redirect> for nginx, C<X-Sendfile> for Apache and
311 Lighttpd), could lead to the disclosure of private paths to malicious
312 clients setting that header.
314 Nginx needs the additional X-Accel-Mapping header to be set in the
315 webserver configuration, so the middleware will replace the absolute
316 path of the IO object with the internal nginx path. This is also
317 useful to prevent a buggy app to server random files from the
318 filesystem, as it's an internal redirect.
320 An nginx configuration for FastCGI could look so:
323 server_name example.com;
325 location /private/repo/ {
329 location /private/staging/ {
331 alias /my/app/staging/;
334 include /etc/nginx/fastcgi_params;
335 fastcgi_param SCRIPT_NAME '';
336 fastcgi_param PATH_INFO $fastcgi_script_name;
337 fastcgi_param HTTP_X_SENDFILE_TYPE X-Accel-Redirect;
338 fastcgi_param HTTP_X_ACCEL_MAPPING /my/app=/private;
339 fastcgi_pass unix:/my/app/run/app.sock;
343 In the example above, passing filehandles with a local path matching
344 /my/app/staging or /my/app/repo will be served by nginx. Passing paths
345 with other locations will lead to an internal server error.
347 Setting the body to a filehandle without the C<path> method bypasses
348 the middleware completely.
350 For Apache and Lighttpd, the mapping doesn't apply and setting the
351 X-Sendfile-Type is enough.
353 =head2 $res->has_body
355 Predicate which returns true when a body has been set.
359 Alias for $res->status.
361 =head2 $res->content_encoding
363 Shortcut for $res->headers->content_encoding.
365 =head2 $res->content_length
367 Shortcut for $res->headers->content_length.
369 =head2 $res->content_type
371 Shortcut for $res->headers->content_type.
373 This value is typically set by your view or plugin. For example,
374 L<Catalyst::Plugin::Static::Simple> will guess the mime type based on the file
375 it found, while L<Catalyst::View::TT> defaults to C<text/html>.
377 =head2 $res->content_type_charset
379 Shortcut for $res->headers->content_type_charset;
383 Returns a reference to a hash containing cookies to be set. The keys of the
384 hash are the cookies' names, and their corresponding values are hash
385 references used to construct a L<CGI::Simple::Cookie> object.
387 $c->response->cookies->{foo} = { value => '123' };
389 The keys of the hash reference on the right correspond to the L<CGI::Simple::Cookie>
390 parameters of the same name, except they are used without a leading dash.
391 Possible parameters are:
411 Shortcut for $res->headers->header.
415 Returns an L<HTTP::Headers> object, which can be used to set headers.
417 $c->response->headers->header( 'X-Catalyst' => $Catalyst::VERSION );
421 Alias for $res->body.
423 =head2 $res->redirect( $url, $status )
425 Causes the response to redirect to the specified URL. The default status is
428 $c->response->redirect( 'http://slashdot.org' );
429 $c->response->redirect( 'http://slashdot.org', 307 );
431 This is a convenience method that sets the Location header to the
432 redirect destination, and then sets the response status. You will
433 want to C< return > or C<< $c->detach() >> to interrupt the normal
434 processing flow if you want the redirect to occur straight away.
436 B<Note:> do not give a relative URL as $url, i.e: one that is not fully
437 qualified (= C<http://...>, etc.) or that starts with a slash
438 (= C</path/here>). While it may work, it is not guaranteed to do the right
439 thing and is not a standard behaviour. You may opt to use uri_for() or
440 uri_for_action() instead.
442 B<Note:> If $url is an object that does ->as_string (such as L<URI>, which is
443 what you get from ->uri_for) we automatically call that to stringify. This
444 should ease the common case usage
446 return $c->res->redirect( $c->uri_for(...));
454 my $location = shift;
455 my $status = shift || 302;
457 if(blessed($location) && $location->can('as_string')) {
458 $location = $location->as_string;
461 $self->location($location);
462 $self->status($status);
465 return $self->location;
468 =head2 $res->location
470 Sets or returns the HTTP 'Location'.
474 Sets or returns the HTTP status.
476 $c->response->status(404);
478 $res->code is an alias for this, to match HTTP::Response->code.
480 =head2 $res->write( $data )
482 Writes $data to the output stream. Calling this method will finalize your
483 headers and send the headers and status code response to the client (so changing
484 them afterwards is a waste... be sure to set your headers correctly first).
486 You may call this as often as you want throughout your response cycle. You may
487 even set a 'body' afterward. So for example you might write your HTTP headers
488 and the HEAD section of your document and then set the body from a template
489 driven from a database. In some cases this can seem to the client as if you had
490 a faster overall response (but note that unless your server support chunked
491 body your content is likely to get queued anyway (L<Starman> and most other
492 http 1.1 webservers support this).
494 If there is an encoding set, we encode each line of the response (the default
497 =head2 $res->unencoded_write( $data )
499 Works just like ->write but we don't apply any content encoding to C<$data>. Use
500 this if you are already encoding the $data or the data is arriving from an encoded
503 =head2 $res->write_fh
505 Returns an instance of L<Catalyst::Response::Writer>, which is a lightweight
506 decorator over the PSGI C<$writer> object (see L<PSGI.pod\Delayed-Response-and-Streaming-Body>).
508 In addition to proxying the C<write> and C<close> method from the underlying PSGI
509 writer, this proxy object knows any application wide encoding, and provides a method
510 C<write_encoded> that will properly encode your written lines based upon your
511 encoding settings. By default in L<Catalyst> responses are UTF-8 encoded and this
512 is the encoding used if you respond via C<write_encoded>. If you want to handle
513 encoding yourself, you can use the C<write> method directly.
515 Encoding only applies to content types for which it matters. Currently the following
516 content types are assumed to need encoding: text (including HTML), xml and javascript.
518 We provide access to this object so that you can properly close over it for use in
519 asynchronous and nonblocking applications. For example (assuming you are using a supporting
520 server, like L<Twiggy>:
522 package AsyncExample::Controller::Root;
526 BEGIN { extends 'Catalyst::Controller' }
532 $write_fh->write("Finishing: $message\n");
537 sub anyevent :Local :Args(0) {
539 my $cb = $self->prepare_cb($c->res->write_fh);
542 $watcher = AnyEvent->timer(
545 $cb->(scalar localtime);
546 undef $watcher; # cancel circular-ref
550 Like the 'write' method, calling this will finalize headers. Unlike 'write' when you
551 can this it is assumed you are taking control of the response so the body is never
552 finalized (there isn't one anyway) and you need to call the close method.
554 =head2 $res->print( @data )
556 Prints @data to the output stream, separated by $,. This lets you pass
557 the response object to functions that want to write to an L<IO::Handle>.
559 =head2 $self->finalize_headers($c)
561 Writes headers to response if not already written
563 =head2 from_psgi_response
565 Given a PSGI response (either three element ARRAY reference OR coderef expecting
566 a $responder) set the response from it.
568 Properly supports streaming and delayed response and / or async IO if running
569 under an expected event loop.
571 If passed an object, will expect that object to do a method C<as_psgi>.
575 package MyApp::Web::Controller::Test;
577 use base 'Catalyst::Controller';
578 use Plack::App::Directory;
581 my $app = Plack::App::Directory->new({ root => "/path/to/htdocs" })
584 sub myaction :Local Args {
586 $c->res->from_psgi_response($app->($c->req->env));
589 Please note this does not attempt to map or nest your PSGI application under
590 the Controller and Action namespace or path. You may wish to review 'PSGI Helpers'
591 under L<Catalyst::Utils> for help in properly nesting applications.
593 B<NOTE> If your external PSGI application returns a response that has a character
594 set associated with the content type (such as "text/html; charset=UTF-8") we set
595 $c->clear_encoding to remove any additional content type encoding processing later
596 in the application (this is done to avoid double encoding issues).
598 =head2 encodable_content_type
600 This is a regular expression used to determine of the current content type
601 should be considered encodable. Currently we apply default encoding (usually
602 UTF8) to text type contents. Here's the default regular expression:
604 This would match content types like:
609 application/javascript
611 application/vnd.user+xml
613 B<NOTE>: We don't encode JSON content type responses by default since most
614 of the JSON serializers that are commonly used for this task will do so
615 automatically and we don't want to double encode. If you are not using a
616 tool like L<JSON> to produce JSON type content, (for example you are using
617 a template system, or creating the strings manually) you will need to either
618 encoding the body yourself:
620 $c->response->body( $c->encoding->encode( $body, $c->_encode_check ) );
622 Or you can alter the regular expression using this attribute.
624 =head2 encodable_response
626 Given a L<Catalyst::Response> return true if its one that can be encoded.
628 make sure there is an encoding set on the response
629 make sure the content type is encodable
630 make sure no content type charset has been already set to something different from the global encoding
631 make sure no content encoding is present.
633 Note this does not inspect a body since we do allow automatic encoding on streaming
638 sub encodable_response {
640 return 0 unless $self->_context; # Cases like returning a HTTP Exception response you don't have a context here...
641 return 0 unless $self->_context->encoding;
643 # The response is considered to have a 'manual charset' when a charset is already set on
644 # the content type of the response AND it is not the same as the one we set in encoding.
645 # If there is no charset OR we are asking for the one which is the same as the current
646 # required encoding, that is a flag that we want Catalyst to encode the response automatically.
647 my $has_manual_charset = 0;
648 if(my $charset = $self->content_type_charset) {
649 $has_manual_charset = (uc($charset) ne uc($self->_context->encoding->mime_name)) ? 1:0;
652 # Content type is encodable if it matches the regular expression stored in this attribute
653 my $encodable_content_type = $self->content_type =~ m/${\$self->encodable_content_type}/ ? 1:0;
655 # The content encoding is allowed (for charset encoding) only if its empty or is set to identity
656 my $allowed_content_encoding = (!$self->content_encoding || $self->content_encoding eq 'identity') ? 1:0;
658 # The content type must be an encodable type, and there must be NO manual charset and also
659 # the content encoding must be the allowed values;
661 $encodable_content_type and
662 !$has_manual_charset and
663 $allowed_content_encoding
673 Ensures that the response is flushed and closed at the end of the
686 defined $self->write($data) or return;
689 defined $self->write($,) or return;
690 defined $self->write($_) or return;
692 defined $self->write($\) or return;
699 Catalyst Contributors, see Catalyst.pm
703 This library is free software. You can redistribute it and/or modify
704 it under the same terms as Perl itself.
708 __PACKAGE__->meta->make_immutable;