1 package Catalyst::Response;
5 use Moose::Util::TypeConstraints;
6 use namespace::autoclean;
8 with 'MooseX::Emulate::Class::Accessor::Fast';
13 writer => '_set_response_cb',
14 clearer => '_clear_response_cb',
15 predicate => '_has_response_cb',
18 subtype 'Catalyst::Engine::Types::Writer', as duck_type( [qw(write close)] );
22 isa => 'Catalyst::Engine::Types::Writer'
23 , #Pointless since we control how this is built
24 #writer => '_set_writer', Now that its lazy I think this is safe to remove
25 clearer => '_clear_writer',
26 predicate => '_has_writer',
28 builder => '_build_writer',
34 ## These two lines are probably crap now...
35 $self->_context->finalize_headers
36 unless $self->finalized_headers;
39 $self->headers->scan( sub { push @headers, @_ } );
41 my $writer = $self->_response_cb->( [ $self->status, \@headers ] );
42 $self->_clear_response_cb;
49 predicate => '_has_write_fh',
51 builder => '_build_write_fh',
54 sub _build_write_fh { shift->_writer }
58 return if $self->_has_write_fh;
59 if ( $self->_has_writer ) {
60 $self->_writer->close;
64 has cookies => ( is => 'rw', default => sub { {} } );
65 has body => ( is => 'rw', default => undef );
66 sub has_body { defined( $_[0]->body ) }
68 has location => ( is => 'rw', writer => '_set_location' );
69 has status => ( is => 'rw', default => 200 );
70 has finalized_headers => ( is => 'rw', default => 0 );
73 isa => 'HTTP::Headers',
74 handles => [qw(content_encoding content_length content_type header)],
75 default => sub { HTTP::Headers->new() },
82 clearer => '_clear_context',
86 qw(status headers content_encoding content_length content_type header)]
90 $self->_context->log->warn(
91 "Useless setting a header value after finalize_headers called."
92 . " Not what you want." )
93 if ( $self->finalized_headers && @_ );
96 sub output { shift->body(@_) }
98 sub code { shift->status(@_) }
101 my ( $self, $buffer ) = @_;
103 # Finalize headers if someone manually writes output
104 $self->_context->finalize_headers unless $self->finalized_headers;
106 $buffer = q[] unless defined $buffer;
108 my $len = length($buffer);
109 $self->_writer->write($buffer);
114 sub finalize_headers {
119 sub from_psgi_response {
120 my ( $self, $psgi_res ) = @_;
121 if ( ref $psgi_res eq 'ARRAY' ) {
122 my ( $status, $headers, $body ) = @$psgi_res;
123 $self->status($status);
124 $self->headers( HTTP::Headers->new(@$headers) );
126 } elsif ( ref $psgi_res eq 'CODE' ) {
129 my $response = shift;
130 my ( $status, $headers, $maybe_body ) = @$response;
131 $self->status($status);
132 $self->headers( HTTP::Headers->new(@$headers) );
133 if ( defined $maybe_body ) {
134 $self->body($maybe_body);
136 return $self->write_fh;
142 "You can't set a Catalyst response from that, expect a valid PSGI response";
148 Catalyst::Response - stores output responding to the current client request
155 $res->content_encoding;
156 $res->content_length;
168 This is the Catalyst Response class, which provides methods for responding to
169 the current client request. The appropriate L<Catalyst::Engine> for your environment
170 will turn the Catalyst::Response into a HTTP Response and return it to the client.
174 =head2 $res->body( $text | $fh | $iohandle_object )
176 $c->response->body('Catalyst rocks!');
178 Sets or returns the output (text or binary data). If you are returning a large body,
179 you might want to use a L<IO::Handle> type of object (Something that implements the read method
180 in the same fashion), or a filehandle GLOB. Catalyst
181 will write it piece by piece into the response.
183 When using a L<IO::Handle> type of object and no content length has been
184 already set in the response headers Catalyst will make a reasonable attempt
185 to determine the size of the Handle. Depending on the implementation of your
186 handle object, setting the content length may fail. If it is at all possible
187 for you to determine the content length of your handle object,
188 it is recommended that you set the content length in the response headers
189 yourself, which will be respected and sent by Catalyst in the response.
191 =head2 $res->has_body
193 Predicate which returns true when a body has been set.
197 Alias for $res->status.
199 =head2 $res->content_encoding
201 Shortcut for $res->headers->content_encoding.
203 =head2 $res->content_length
205 Shortcut for $res->headers->content_length.
207 =head2 $res->content_type
209 Shortcut for $res->headers->content_type.
211 This value is typically set by your view or plugin. For example,
212 L<Catalyst::Plugin::Static::Simple> will guess the mime type based on the file
213 it found, while L<Catalyst::View::TT> defaults to C<text/html>.
217 Returns a reference to a hash containing cookies to be set. The keys of the
218 hash are the cookies' names, and their corresponding values are hash
219 references used to construct a L<CGI::Simple::Cookie> object.
221 $c->response->cookies->{foo} = { value => '123' };
223 The keys of the hash reference on the right correspond to the L<CGI::Simple::Cookie>
224 parameters of the same name, except they are used without a leading dash.
225 Possible parameters are:
245 Shortcut for $res->headers->header.
249 Returns an L<HTTP::Headers> object, which can be used to set headers.
251 $c->response->headers->header( 'X-Catalyst' => $Catalyst::VERSION );
255 Alias for $res->body.
257 =head2 $res->redirect( $url, $status )
259 Causes the response to redirect to the specified URL. The default status is
262 $c->response->redirect( 'http://slashdot.org' );
263 $c->response->redirect( 'http://slashdot.org', 307 );
265 This is a convenience method that sets the Location header to the
266 redirect destination, and then sets the response status. You will
267 want to C< return > or C<< $c->detach() >> to interrupt the normal
268 processing flow if you want the redirect to occur straight away.
270 B<Note:> do not give a relative URL as $url, i.e: one that is not fully
271 qualified (= C<http://...>, etc.) or that starts with a slash
272 (= C</path/here>). While it may work, it is not guaranteed to do the right
273 thing and is not a standard behaviour. You may opt to use uri_for() or
274 uri_for_action() instead.
282 my $location = shift;
283 my $status = shift || 302;
285 $self->location($location);
286 $self->status($status);
290 return $self->location;
293 around '_set_location' => sub {
299 my $location = shift;
301 if ( $location =~ m/[\n\r]/ ) { # check for header injection
303 die "blocking header injection";
307 $self->$orig($location);
319 =head2 $res->location
321 Sets or returns the HTTP 'Location'.
325 Sets or returns the HTTP status.
327 $c->response->status(404);
329 $res->code is an alias for this, to match HTTP::Response->code.
331 =head2 $res->write( $data )
333 Writes $data to the output stream.
335 =head2 $res->write_fh
337 Returns a PSGI $writer object that has two methods, write and close. You can
338 close over this object for asynchronous and nonblocking applications. For
339 example (assuming you are using a supporting server, like L<Twiggy>
341 package AsyncExample::Controller::Root;
345 BEGIN { extends 'Catalyst::Controller' }
351 $write_fh->write("Finishing: $message\n");
356 sub anyevent :Local :Args(0) {
358 my $cb = $self->prepare_cb($c->res->write_fh);
361 $watcher = AnyEvent->timer(
364 $cb->(scalar localtime);
365 undef $watcher; # cancel circular-ref
369 =head2 $res->print( @data )
371 Prints @data to the output stream, separated by $,. This lets you pass
372 the response object to functions that want to write to an L<IO::Handle>.
374 =head2 $self->finalize_headers($c)
376 Writes headers to response if not already written
378 =head2 from_psgi_response
380 Given a PSGI response (either three element ARRAY reference OR coderef expecting
381 a $responder) set the response from it.
383 Properly supports streaming and delayed response and / or async IO if running
384 under an expected event loop.
388 package MyApp::Web::Controller::Test;
390 use base 'Catalyst::Controller';
391 use Plack::App::Directory;
394 my $app = Plack::App::Directory->new({ root => "/path/to/htdocs" })
397 sub myaction :Local Args {
399 $c->res->from_psgi_response($app->($c->req->env));
402 Please note this does not attempt to map or nest your PSGI application under
403 the Controller and Action namespace or path.
407 Ensures that the response is flushed and closed at the end of the
420 defined $self->write($data) or return;
423 defined $self->write($,) or return;
424 defined $self->write($_) or return;
426 defined $self->write($\) or return;
433 Catalyst Contributors, see Catalyst.pm
437 This library is free software. You can redistribute it and/or modify
438 it under the same terms as Perl itself.
442 __PACKAGE__->meta->make_immutable;