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 header)] => sub {
109 $self->_context->log->warn(
110 "Useless setting a header value after finalize_headers and the response callback has been called." .
111 " Not what you want." )
112 if ( $self->_context && $self->finalized_headers && !$self->_has_response_cb && @_ );
115 sub output { shift->body(@_) }
117 sub code { shift->status(@_) }
120 my ( $self, $buffer ) = @_;
122 # Finalize headers if someone manually writes output
123 $self->_context->finalize_headers unless $self->finalized_headers;
125 $buffer = q[] unless defined $buffer;
127 if($self->encodable_response) {
128 $buffer = $self->_context->encoding->encode( $buffer, $self->_context->_encode_check )
131 my $len = length($buffer);
132 $self->_writer->write($buffer);
137 sub unencoded_write {
138 my ( $self, $buffer ) = @_;
140 # Finalize headers if someone manually writes output
141 $self->_context->finalize_headers unless $self->finalized_headers;
143 $buffer = q[] unless defined $buffer;
145 my $len = length($buffer);
146 $self->_writer->write($buffer);
151 sub finalize_headers {
156 sub from_psgi_response {
157 my ($self, $psgi_res) = @_;
158 if(blessed($psgi_res) && $psgi_res->can('as_psgi')) {
159 $psgi_res = $psgi_res->as_psgi;
161 if(ref $psgi_res eq 'ARRAY') {
162 my ($status, $headers, $body) = @$psgi_res;
163 $self->status($status);
164 $self->headers(HTTP::Headers->new(@$headers));
165 # Can be arrayref or filehandle...
166 if(defined $body) { # probably paranoia
167 ref $body eq 'ARRAY' ? $self->body(join('', @$body)) : $self->body($body);
169 } elsif(ref $psgi_res eq 'CODE') {
171 my $response = shift;
172 my ($status, $headers, $maybe_body) = @$response;
173 $self->status($status);
174 $self->headers(HTTP::Headers->new(@$headers));
175 if(defined $maybe_body) {
176 # Can be arrayref or filehandle...
177 ref $maybe_body eq 'ARRAY' ? $self->body(join('', @$maybe_body)) : $self->body($maybe_body);
179 return $self->write_fh;
183 die "You can't set a Catalyst response from that, expect a valid PSGI response";
186 # Encoding compatibilty. If the response set a charset, well... we need
187 # to assume its properly encoded and NOT encode for this response. Otherwise
188 # We risk double encoding.
189 if($self->content_type_charset) {
190 # We have to do this since for backcompat reasons having a charset doesn't always
191 # mean that the body is already encoded :(
192 $self->_context->clear_encoding;
198 Catalyst::Response - stores output responding to the current client request
205 $res->content_encoding;
206 $res->content_length;
218 This is the Catalyst Response class, which provides methods for responding to
219 the current client request. The appropriate L<Catalyst::Engine> for your environment
220 will turn the Catalyst::Response into a HTTP Response and return it to the client.
224 =head2 $res->body( $text | $fh | $iohandle_object )
226 $c->response->body('Catalyst rocks!');
228 Sets or returns the output (text or binary data). If you are returning a large body,
229 you might want to use a L<IO::Handle> type of object (Something that implements the getline method
230 in the same fashion), or a filehandle GLOB. These will be passed down to the PSGI
231 handler you are using and might be optimized using server specific abilities (for
232 example L<Twiggy> will attempt to server a real local file in a non blocking manner).
234 If you are using a filehandle as the body response you are responsible for
235 making sure it conforms to the L<PSGI> specification with regards to content
236 encoding. Unlike with scalar body values or when using the streaming interfaces
237 we currently do not attempt to normalize and encode your filehandle. In general
238 this means you should be sure to be sending bytes not UTF8 decoded multibyte
241 Most of the time when you do:
243 open(my $fh, '<:raw', $path);
245 You should be fine. If you open a filehandle with a L<PerlIO> layer you probably
246 are not fine. You can usually fix this by explicitly using binmode to set
247 the IOLayer to :raw. Its possible future versions of L<Catalyst> will try to
248 'do the right thing'.
250 When using a L<IO::Handle> type of object and no content length has been
251 already set in the response headers Catalyst will make a reasonable attempt
252 to determine the size of the Handle. Depending on the implementation of your
253 handle object, setting the content length may fail. If it is at all possible
254 for you to determine the content length of your handle object,
255 it is recommended that you set the content length in the response headers
256 yourself, which will be respected and sent by Catalyst in the response.
258 Please note that the object needs to implement C<getline>, not just
259 C<read>. Older versions of L<Catalyst> expected your filehandle like objects
260 to do read. If you have code written for this expectation and you cannot
261 change the code to meet the L<PSGI> specification, you can try the following
262 middleware L<Plack::Middleware::AdaptFilehandleRead> which will attempt to
263 wrap your object in an interface that so conforms.
265 Starting from version 5.90060, when using an L<IO::Handle> object, you
266 may want to use L<Plack::Middleware::XSendfile>, to delegate the
267 actual serving to the frontend server. To do so, you need to pass to
268 C<body> an IO object with a C<path> method. This can be achieved in
271 Either using L<Plack::Util>:
273 my $fh = IO::File->new($file, 'r');
274 Plack::Util::set_io_path($fh, $file);
276 Or using L<IO::File::WithPath>
278 my $fh = IO::File::WithPath->new($file, 'r');
280 And then passing the filehandle to body and setting headers, if needed.
282 $c->response->body($fh);
283 $c->response->headers->content_type('text/plain');
284 $c->response->headers->content_length(-s $file);
285 $c->response->headers->last_modified((stat($file))[9]);
287 L<Plack::Middleware::XSendfile> can be loaded in the application so:
292 # other middlewares here...
296 B<Beware> that loading the middleware without configuring the
297 webserver to set the request header C<X-Sendfile-Type> to a supported
298 type (C<X-Accel-Redirect> for nginx, C<X-Sendfile> for Apache and
299 Lighttpd), could lead to the disclosure of private paths to malicious
300 clients setting that header.
302 Nginx needs the additional X-Accel-Mapping header to be set in the
303 webserver configuration, so the middleware will replace the absolute
304 path of the IO object with the internal nginx path. This is also
305 useful to prevent a buggy app to server random files from the
306 filesystem, as it's an internal redirect.
308 An nginx configuration for FastCGI could look so:
311 server_name example.com;
313 location /private/repo/ {
317 location /private/staging/ {
319 alias /my/app/staging/;
322 include /etc/nginx/fastcgi_params;
323 fastcgi_param SCRIPT_NAME '';
324 fastcgi_param PATH_INFO $fastcgi_script_name;
325 fastcgi_param HTTP_X_SENDFILE_TYPE X-Accel-Redirect;
326 fastcgi_param HTTP_X_ACCEL_MAPPING /my/app=/private;
327 fastcgi_pass unix:/my/app/run/app.sock;
331 In the example above, passing filehandles with a local path matching
332 /my/app/staging or /my/app/repo will be served by nginx. Passing paths
333 with other locations will lead to an internal server error.
335 Setting the body to a filehandle without the C<path> method bypasses
336 the middleware completely.
338 For Apache and Lighttpd, the mapping doesn't apply and setting the
339 X-Sendfile-Type is enough.
341 =head2 $res->has_body
343 Predicate which returns true when a body has been set.
347 Alias for $res->status.
349 =head2 $res->content_encoding
351 Shortcut for $res->headers->content_encoding.
353 =head2 $res->content_length
355 Shortcut for $res->headers->content_length.
357 =head2 $res->content_type
359 Shortcut for $res->headers->content_type.
361 This value is typically set by your view or plugin. For example,
362 L<Catalyst::Plugin::Static::Simple> will guess the mime type based on the file
363 it found, while L<Catalyst::View::TT> defaults to C<text/html>.
365 =head2 $res->content_type_charset
367 Shortcut for $res->headers->content_type_charset;
371 Returns a reference to a hash containing cookies to be set. The keys of the
372 hash are the cookies' names, and their corresponding values are hash
373 references used to construct a L<CGI::Simple::Cookie> object.
375 $c->response->cookies->{foo} = { value => '123' };
377 The keys of the hash reference on the right correspond to the L<CGI::Simple::Cookie>
378 parameters of the same name, except they are used without a leading dash.
379 Possible parameters are:
399 Shortcut for $res->headers->header.
403 Returns an L<HTTP::Headers> object, which can be used to set headers.
405 $c->response->headers->header( 'X-Catalyst' => $Catalyst::VERSION );
409 Alias for $res->body.
411 =head2 $res->redirect( $url, $status )
413 Causes the response to redirect to the specified URL. The default status is
416 $c->response->redirect( 'http://slashdot.org' );
417 $c->response->redirect( 'http://slashdot.org', 307 );
419 This is a convenience method that sets the Location header to the
420 redirect destination, and then sets the response status. You will
421 want to C< return > or C<< $c->detach() >> to interrupt the normal
422 processing flow if you want the redirect to occur straight away.
424 B<Note:> do not give a relative URL as $url, i.e: one that is not fully
425 qualified (= C<http://...>, etc.) or that starts with a slash
426 (= C</path/here>). While it may work, it is not guaranteed to do the right
427 thing and is not a standard behaviour. You may opt to use uri_for() or
428 uri_for_action() instead.
430 B<Note:> If $url is an object that does ->as_string (such as L<URI>, which is
431 what you get from ->uri_for) we automatically call that to stringify. This
432 should ease the common case usage
434 return $c->res->redirect( $c->uri_for(...));
442 my $location = shift;
443 my $status = shift || 302;
445 if(blessed($location) && $location->can('as_string')) {
446 $location = $location->as_string;
449 $self->location($location);
450 $self->status($status);
453 return $self->location;
456 =head2 $res->location
458 Sets or returns the HTTP 'Location'.
462 Sets or returns the HTTP status.
464 $c->response->status(404);
466 $res->code is an alias for this, to match HTTP::Response->code.
468 =head2 $res->write( $data )
470 Writes $data to the output stream. Calling this method will finalize your
471 headers and send the headers and status code response to the client (so changing
472 them afterwards is a waste... be sure to set your headers correctly first).
474 You may call this as often as you want throughout your response cycle. You may
475 even set a 'body' afterward. So for example you might write your HTTP headers
476 and the HEAD section of your document and then set the body from a template
477 driven from a database. In some cases this can seem to the client as if you had
478 a faster overall response (but note that unless your server support chunked
479 body your content is likely to get queued anyway (L<Starman> and most other
480 http 1.1 webservers support this).
482 If there is an encoding set, we encode each line of the response (the default
485 =head2 $res->write_fh
487 Returns an instance of L<Catalyst::Response::Writer>, which is a lightweight
488 decorator over the PSGI C<$writer> object (see L<PSGI.pod\Delayed-Response-and-Streaming-Body>).
490 In addition to proxying the C<write> and C<close> method from the underlying PSGI
491 writer, this proxy object knows any application wide encoding, and provides a method
492 C<write_encoded> that will properly encode your written lines based upon your
493 encoding settings. By default in L<Catalyst> responses are UTF-8 encoded and this
494 is the encoding used if you respond via C<write_encoded>. If you want to handle
495 encoding yourself, you can use the C<write> method directly.
497 Encoding only applies to content types for which it matters. Currently the following
498 content types are assumed to need encoding: text (including HTML), xml and javascript.
500 We provide access to this object so that you can properly close over it for use in
501 asynchronous and nonblocking applications. For example (assuming you are using a supporting
502 server, like L<Twiggy>:
504 package AsyncExample::Controller::Root;
508 BEGIN { extends 'Catalyst::Controller' }
514 $write_fh->write("Finishing: $message\n");
519 sub anyevent :Local :Args(0) {
521 my $cb = $self->prepare_cb($c->res->write_fh);
524 $watcher = AnyEvent->timer(
527 $cb->(scalar localtime);
528 undef $watcher; # cancel circular-ref
532 Like the 'write' method, calling this will finalize headers. Unlike 'write' when you
533 can this it is assumed you are taking control of the response so the body is never
534 finalized (there isn't one anyway) and you need to call the close method.
536 =head2 $res->print( @data )
538 Prints @data to the output stream, separated by $,. This lets you pass
539 the response object to functions that want to write to an L<IO::Handle>.
541 =head2 $self->finalize_headers($c)
543 Writes headers to response if not already written
545 =head2 from_psgi_response
547 Given a PSGI response (either three element ARRAY reference OR coderef expecting
548 a $responder) set the response from it.
550 Properly supports streaming and delayed response and / or async IO if running
551 under an expected event loop.
553 If passed an object, will expect that object to do a method C<as_psgi>.
557 package MyApp::Web::Controller::Test;
559 use base 'Catalyst::Controller';
560 use Plack::App::Directory;
563 my $app = Plack::App::Directory->new({ root => "/path/to/htdocs" })
566 sub myaction :Local Args {
568 $c->res->from_psgi_response($app->($c->req->env));
571 Please note this does not attempt to map or nest your PSGI application under
572 the Controller and Action namespace or path. You may wish to review 'PSGI Helpers'
573 under L<Catalyst::Utils> for help in properly nesting applications.
575 B<NOTE> If your external PSGI application returns a response that has a character
576 set associated with the content type (such as "text/html; charset=UTF-8") we set
577 $c->clear_encoding to remove any additional content type encoding processing later
578 in the application (this is done to avoid double encoding issues).
580 =head2 encodable_content_type
582 This is a regular expression used to determine of the current content type
583 should be considered encodable. Currently we apply default encoding (usually
584 UTF8) to text type contents. Here's the default regular expression:
586 This would match content types like:
591 application/javascript
593 application/vnd.user+xml
595 B<NOTE>: We don't encode JSON content type responses by default since most
596 of the JSON serializers that are commonly used for this task will do so
597 automatically and we don't want to double encode. If you are not using a
598 tool like L<JSON> to produce JSON type content, (for example you are using
599 a template system, or creating the strings manually) you will need to either
600 encoding the body yourself:
602 $c->response->body( $c->encoding->encode( $body, $c->_encode_check ) );
604 Or you can alter the regular expression using this attribute.
606 =head2 encodable_response
608 Given a L<Catalyst::Response> return true if its one that can be encoded.
610 make sure there is an encoding set on the response
611 make sure the content type is encodable
612 make sure no content type charset has been already set to something different from the global encoding
613 make sure no content encoding is present.
615 Note this does not inspect a body since we do allow automatic encoding on streaming
620 sub encodable_response {
622 return 0 unless $self->_context; # Cases like returning a HTTP Exception response you don't have a context here...
623 return 0 unless $self->_context->encoding;
625 # The response is considered to have a 'manual charset' when a charset is already set on
626 # the content type of the response AND it is not the same as the one we set in encoding.
627 # If there is no charset OR we are asking for the one which is the same as the current
628 # required encoding, that is a flag that we want Catalyst to encode the response automatically.
629 my $has_manual_charset = 0;
630 if(my $charset = $self->content_type_charset) {
631 $has_manual_charset = (uc($charset) ne uc($self->_context->encoding->mime_name)) ? 1:0;
634 # Content type is encodable if it matches the regular expression stored in this attribute
635 my $encodable_content_type = $self->content_type =~ m/${\$self->encodable_content_type}/ ? 1:0;
637 # The content encoding is allowed (for charset encoding) only if its empty or is set to identity
638 my $allowed_content_encoding = (!$self->content_encoding || $self->content_encoding eq 'identity') ? 1:0;
640 # The content type must be an encodable type, and there must be NO manual charset and also
641 # the content encoding must be the allowed values;
643 $encodable_content_type and
644 !$has_manual_charset and
645 $allowed_content_encoding
655 Ensures that the response is flushed and closed at the end of the
668 defined $self->write($data) or return;
671 defined $self->write($,) or return;
672 defined $self->write($_) or return;
674 defined $self->write($\) or return;
681 Catalyst Contributors, see Catalyst.pm
685 This library is free software. You can redistribute it and/or modify
686 it under the same terms as Perl itself.
690 __PACKAGE__->meta->make_immutable;