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',
19 as duck_type([qw(write close)]);
23 isa => 'Catalyst::Engine::Types::Writer',
24 writer => '_set_writer',
25 clearer => '_clear_writer',
26 predicate => '_has_writer',
31 predicate=>'has_write_fh',
33 builder=>'_build_write_fh',
38 $self->_context->finalize_headers unless
39 $self->finalized_headers;
45 return if $self->has_write_fh;
46 if($self->_has_writer) {
51 has cookies => (is => 'rw', default => sub { {} });
52 has body => (is => 'rw', default => undef);
53 sub has_body { defined($_[0]->body) }
55 has location => (is => 'rw');
56 has status => (is => 'rw', default => 200);
57 has finalized_headers => (is => 'rw', default => 0);
60 isa => 'HTTP::Headers',
61 handles => [qw(content_encoding content_length content_type header)],
62 default => sub { HTTP::Headers->new() },
69 clearer => '_clear_context',
72 sub output { shift->body(@_) }
74 sub code { shift->status(@_) }
77 my ( $self, $buffer ) = @_;
79 # Finalize headers if someone manually writes output
80 $self->_context->finalize_headers unless $self->finalized_headers;
82 $buffer = q[] unless defined $buffer;
84 my $len = length($buffer);
85 $self->_writer->write($buffer);
90 sub finalize_headers {
93 # This is a less-than-pretty hack to avoid breaking the old
94 # Catalyst::Engine::PSGI. 5.9 Catalyst::Engine sets a response_cb and
95 # expects us to pass headers to it here, whereas Catalyst::Enngine::PSGI
96 # just pulls the headers out of $ctx->response in its run method and never
97 # sets response_cb. So take the lack of a response_cb as a sign that we
98 # don't need to set the headers.
100 return unless $self->_has_response_cb;
102 # If we already have a writer, we already did this, so don't do it again
103 return if $self->_has_writer;
106 $self->headers->scan(sub { push @headers, @_ });
108 my $writer = $self->_response_cb->([ $self->status, \@headers ]);
109 $self->_set_writer($writer);
110 $self->_clear_response_cb;
115 sub from_psgi_response {
116 my ($self, $psgi_res) = @_;
117 if(ref $psgi_res eq 'ARRAY') {
118 my ($status, $headers, $body) = @$psgi_res;
119 $self->status($status);
120 $self->headers(HTTP::Headers->new(@$headers));
121 if(ref $body eq 'ARRAY') {
122 $self->body(join '', grep defined, @$body);
126 } elsif(ref $psgi_res eq 'CODE') {
128 my $response = shift;
129 my ($status, $headers, $maybe_body) = @$response;
130 $self->status($status);
131 $self->headers(HTTP::Headers->new(@$headers));
133 if(ref $maybe_body eq 'ARRAY') {
134 $self->body(join '', grep defined, @$maybe_body);
136 $self->body($maybe_body);
139 return $self->write_fh;
143 die "You can't set a Catalyst response from that, expect a valid PSGI response";
149 Catalyst::Response - stores output responding to the current client request
156 $res->content_encoding;
157 $res->content_length;
169 This is the Catalyst Response class, which provides methods for responding to
170 the current client request. The appropriate L<Catalyst::Engine> for your environment
171 will turn the Catalyst::Response into a HTTP Response and return it to the client.
175 =head2 $res->body( $text | $fh | $iohandle_object )
177 $c->response->body('Catalyst rocks!');
179 Sets or returns the output (text or binary data). If you are returning a large body,
180 you might want to use a L<IO::Handle> type of object (Something that implements the read method
181 in the same fashion), or a filehandle GLOB. Catalyst
182 will write it piece by piece into the response.
184 =head2 $res->has_body
186 Predicate which returns true when a body has been set.
190 Alias for $res->status.
192 =head2 $res->content_encoding
194 Shortcut for $res->headers->content_encoding.
196 =head2 $res->content_length
198 Shortcut for $res->headers->content_length.
200 =head2 $res->content_type
202 Shortcut for $res->headers->content_type.
204 This value is typically set by your view or plugin. For example,
205 L<Catalyst::Plugin::Static::Simple> will guess the mime type based on the file
206 it found, while L<Catalyst::View::TT> defaults to C<text/html>.
210 Returns a reference to a hash containing cookies to be set. The keys of the
211 hash are the cookies' names, and their corresponding values are hash
212 references used to construct a L<CGI::Simple::Cookie> object.
214 $c->response->cookies->{foo} = { value => '123' };
216 The keys of the hash reference on the right correspond to the L<CGI::Simple::Cookie>
217 parameters of the same name, except they are used without a leading dash.
218 Possible parameters are:
238 Shortcut for $res->headers->header.
242 Returns an L<HTTP::Headers> object, which can be used to set headers.
244 $c->response->headers->header( 'X-Catalyst' => $Catalyst::VERSION );
248 Alias for $res->body.
250 =head2 $res->redirect( $url, $status )
252 Causes the response to redirect to the specified URL. The default status is
255 $c->response->redirect( 'http://slashdot.org' );
256 $c->response->redirect( 'http://slashdot.org', 307 );
258 This is a convenience method that sets the Location header to the
259 redirect destination, and then sets the response status. You will
260 want to C< return > or C<< $c->detach() >> to interrupt the normal
261 processing flow if you want the redirect to occur straight away.
263 B<Note:> do not give a relative URL as $url, i.e: one that is not fully
264 qualified (= C<http://...>, etc.) or that starts with a slash
265 (= C</path/here>). While it may work, it is not guaranteed to do the right
266 thing and is not a standard behaviour. You may opt to use uri_for() or
267 uri_for_action() instead.
275 my $location = shift;
276 my $status = shift || 302;
278 $self->location($location);
279 $self->status($status);
282 return $self->location;
285 =head2 $res->location
287 Sets or returns the HTTP 'Location'.
291 Sets or returns the HTTP status.
293 $c->response->status(404);
295 $res->code is an alias for this, to match HTTP::Response->code.
297 =head2 $res->write( $data )
299 Writes $data to the output stream.
301 =head2 $res->write_fh
303 Returns a PSGI $writer object that has two methods, write and close. You can
304 close over this object for asynchronous and nonblocking applications. For
305 example (assuming you are using a supporting server, like L<Twiggy>
307 package AsyncExample::Controller::Root;
311 BEGIN { extends 'Catalyst::Controller' }
317 $write_fh->write("Finishing: $message\n");
322 sub anyevent :Local :Args(0) {
324 my $cb = $self->prepare_cb($c->res->write_fh);
327 $watcher = AnyEvent->timer(
330 $cb->(scalar localtime);
331 undef $watcher; # cancel circular-ref
335 =head2 $res->print( @data )
337 Prints @data to the output stream, separated by $,. This lets you pass
338 the response object to functions that want to write to an L<IO::Handle>.
340 =head2 $self->finalize_headers($c)
342 Writes headers to response if not already written
344 =head2 from_psgi_response
346 Given a PSGI response (either three element ARRAY reference OR coderef expecting
347 a $responder) set the response from it.
349 Properly supports streaming and delayed response and / or async IO if running
350 under an expected event loop.
354 package MyApp::Web::Controller::Test;
356 use base 'Catalyst::Controller';
357 use Plack::App::Directory;
360 my $app = Plack::App::Directory->new({ root => "/path/to/htdocs" })
363 sub myaction :Local Args {
365 $c->res->from_psgi_response($app->($self->env));
368 Please note this does not attempt to map or nest your PSGI application under
369 the Controller and Action namespace or path.
373 Ensures that the response is flushed and closed at the end of the
386 defined $self->write($data) or return;
389 defined $self->write($,) or return;
390 defined $self->write($_) or return;
392 defined $self->write($\) or return;
399 Catalyst Contributors, see Catalyst.pm
403 This library is free software. You can redistribute it and/or modify
404 it under the same terms as Perl itself.
408 __PACKAGE__->meta->make_immutable;