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;
117 Catalyst::Response - stores output responding to the current client request
124 $res->content_encoding;
125 $res->content_length;
137 This is the Catalyst Response class, which provides methods for responding to
138 the current client request. The appropriate L<Catalyst::Engine> for your environment
139 will turn the Catalyst::Response into a HTTP Response and return it to the client.
143 =head2 $res->body( $text | $fh | $iohandle_object )
145 $c->response->body('Catalyst rocks!');
147 Sets or returns the output (text or binary data). If you are returning a large body,
148 you might want to use a L<IO::Handle> type of object (Something that implements the read method
149 in the same fashion), or a filehandle GLOB. Catalyst
150 will write it piece by piece into the response.
152 =head2 $res->has_body
154 Predicate which returns true when a body has been set.
158 Alias for $res->status.
160 =head2 $res->content_encoding
162 Shortcut for $res->headers->content_encoding.
164 =head2 $res->content_length
166 Shortcut for $res->headers->content_length.
168 =head2 $res->content_type
170 Shortcut for $res->headers->content_type.
172 This value is typically set by your view or plugin. For example,
173 L<Catalyst::Plugin::Static::Simple> will guess the mime type based on the file
174 it found, while L<Catalyst::View::TT> defaults to C<text/html>.
178 Returns a reference to a hash containing cookies to be set. The keys of the
179 hash are the cookies' names, and their corresponding values are hash
180 references used to construct a L<CGI::Simple::Cookie> object.
182 $c->response->cookies->{foo} = { value => '123' };
184 The keys of the hash reference on the right correspond to the L<CGI::Simple::Cookie>
185 parameters of the same name, except they are used without a leading dash.
186 Possible parameters are:
206 Shortcut for $res->headers->header.
210 Returns an L<HTTP::Headers> object, which can be used to set headers.
212 $c->response->headers->header( 'X-Catalyst' => $Catalyst::VERSION );
216 Alias for $res->body.
218 =head2 $res->redirect( $url, $status )
220 Causes the response to redirect to the specified URL. The default status is
223 $c->response->redirect( 'http://slashdot.org' );
224 $c->response->redirect( 'http://slashdot.org', 307 );
226 This is a convenience method that sets the Location header to the
227 redirect destination, and then sets the response status. You will
228 want to C< return > or C<< $c->detach() >> to interrupt the normal
229 processing flow if you want the redirect to occur straight away.
231 B<Note:> do not give a relative URL as $url, i.e: one that is not fully
232 qualified (= C<http://...>, etc.) or that starts with a slash
233 (= C</path/here>). While it may work, it is not guaranteed to do the right
234 thing and is not a standard behaviour. You may opt to use uri_for() or
235 uri_for_action() instead.
243 my $location = shift;
244 my $status = shift || 302;
246 $self->location($location);
247 $self->status($status);
250 return $self->location;
253 =head2 $res->location
255 Sets or returns the HTTP 'Location'.
259 Sets or returns the HTTP status.
261 $c->response->status(404);
263 $res->code is an alias for this, to match HTTP::Response->code.
265 =head2 $res->write( $data )
267 Writes $data to the output stream.
269 =head2 $res->write_fh
271 Returns a PSGI $writer object that has two methods, write and close. You can
272 close over this object for asynchronous and nonblocking applications. For
273 example (assuming you are using a supporting server, like L<Twiggy>
275 package AsyncExample::Controller::Root;
279 BEGIN { extends 'Catalyst::Controller' }
285 $write_fh->write("Finishing: $message\n");
290 sub anyevent :Local :Args(0) {
292 my $cb = $self->prepare_cb($c->res->write_fh);
295 $watcher = AnyEvent->timer(
298 $cb->(scalar localtime);
299 undef $watcher; # cancel circular-ref
303 =head2 $res->print( @data )
305 Prints @data to the output stream, separated by $,. This lets you pass
306 the response object to functions that want to write to an L<IO::Handle>.
308 =head2 $self->finalize_headers($c)
310 Writes headers to response if not already written
314 Ensures that the response is flushed and closed at the end of the
327 defined $self->write($data) or return;
330 defined $self->write($,) or return;
331 defined $self->write($_) or return;
333 defined $self->write($\) or return;
340 Catalyst Contributors, see Catalyst.pm
344 This library is free software. You can redistribute it and/or modify
345 it under the same terms as Perl itself.
349 __PACKAGE__->meta->make_immutable;