X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=catagits%2FCatalyst-Runtime.git;a=blobdiff_plain;f=lib%2FCatalyst%2FResponse.pm;h=1db56668f4b736ffbc2695dba43f17f485e4ff7a;hp=3203b2d1af9562be086ab54b54127a101c71aca4;hb=c368f69e3b35bea9adeb69c128fcf176b7a539e4;hpb=ae29b412955743885e80350085167b54b69672da diff --git a/lib/Catalyst/Response.pm b/lib/Catalyst/Response.pm index 3203b2d..1db5666 100644 --- a/lib/Catalyst/Response.pm +++ b/lib/Catalyst/Response.pm @@ -2,16 +2,62 @@ package Catalyst::Response; use Moose; use HTTP::Headers; +use Moose::Util::TypeConstraints; +use namespace::autoclean; with 'MooseX::Emulate::Class::Accessor::Fast'; +has _response_cb => ( + is => 'ro', + isa => 'CodeRef', + writer => '_set_response_cb', + clearer => '_clear_response_cb', + predicate => '_has_response_cb', +); + +subtype 'Catalyst::Engine::Types::Writer', + as duck_type([qw(write close)]); + +has _writer => ( + is => 'ro', + isa => 'Catalyst::Engine::Types::Writer', + writer => '_set_writer', + clearer => '_clear_writer', + predicate => '_has_writer', +); + +has write_fh => ( + is=>'ro', + predicate=>'has_write_fh', + lazy=>1, + builder=>'_build_write_fh', +); + +sub _build_write_fh { + my $self = shift; + $self->_context->finalize_headers unless + $self->finalized_headers; + $self->_writer; +}; + +sub DEMOLISH { + my $self = shift; + return if $self->has_write_fh; + if($self->_has_writer) { + $self->_writer->close + } +} + has cookies => (is => 'rw', default => sub { {} }); -has body => (is => 'rw', default => '', lazy => 1, predicate => 'has_body'); +has body => (is => 'rw', default => undef); +sub has_body { defined($_[0]->body) } + has location => (is => 'rw'); has status => (is => 'rw', default => 200); has finalized_headers => (is => 'rw', default => 0); has headers => ( is => 'rw', + isa => 'HTTP::Headers', handles => [qw(content_encoding content_length content_type header)], default => sub { HTTP::Headers->new() }, required => 1, @@ -20,13 +66,51 @@ has headers => ( has _context => ( is => 'rw', weak_ref => 1, - handles => ['write'], clearer => '_clear_context', ); sub output { shift->body(@_) } -no Moose; +sub code { shift->status(@_) } + +sub write { + my ( $self, $buffer ) = @_; + + # Finalize headers if someone manually writes output + $self->_context->finalize_headers unless $self->finalized_headers; + + $buffer = q[] unless defined $buffer; + + my $len = length($buffer); + $self->_writer->write($buffer); + + return $len; +} + +sub finalize_headers { + my ($self) = @_; + + # This is a less-than-pretty hack to avoid breaking the old + # Catalyst::Engine::PSGI. 5.9 Catalyst::Engine sets a response_cb and + # expects us to pass headers to it here, whereas Catalyst::Enngine::PSGI + # just pulls the headers out of $ctx->response in its run method and never + # sets response_cb. So take the lack of a response_cb as a sign that we + # don't need to set the headers. + + return unless $self->_has_response_cb; + + # If we already have a writer, we already did this, so don't do it again + return if $self->_has_writer; + + my @headers; + $self->headers->scan(sub { push @headers, @_ }); + + my $writer = $self->_response_cb->([ $self->status, \@headers ]); + $self->_set_writer($writer); + $self->_clear_response_cb; + + return; +} =head1 NAME @@ -36,6 +120,7 @@ Catalyst::Response - stores output responding to the current client request $res = $c->response; $res->body; + $res->code; $res->content_encoding; $res->content_length; $res->content_type; @@ -55,7 +140,7 @@ will turn the Catalyst::Response into a HTTP Response and return it to the clien =head1 METHODS -=head2 $res->body(<$text|$fh|$iohandle_object) +=head2 $res->body( $text | $fh | $iohandle_object ) $c->response->body('Catalyst rocks!'); @@ -68,6 +153,10 @@ will write it piece by piece into the response. Predicate which returns true when a body has been set. +=head2 $res->code + +Alias for $res->status. + =head2 $res->content_encoding Shortcut for $res->headers->content_encoding. @@ -88,15 +177,15 @@ it found, while L defaults to C. Returns a reference to a hash containing cookies to be set. The keys of the hash are the cookies' names, and their corresponding values are hash -references used to construct a L object. +references used to construct a L object. $c->response->cookies->{foo} = { value => '123' }; -The keys of the hash reference on the right correspond to the L +The keys of the hash reference on the right correspond to the L parameters of the same name, except they are used without a leading dash. Possible parameters are: -=over +=over =item value @@ -108,6 +197,8 @@ Possible parameters are: =item secure +=item httponly + =back =head2 $res->header @@ -134,9 +225,15 @@ C<302>. This is a convenience method that sets the Location header to the redirect destination, and then sets the response status. You will -want to C< return; > or C< $c->detach() > to interrupt the normal +want to C< return > or C<< $c->detach() >> to interrupt the normal processing flow if you want the redirect to occur straight away. +B do not give a relative URL as $url, i.e: one that is not fully +qualified (= C, etc.) or that starts with a slash +(= C). While it may work, it is not guaranteed to do the right +thing and is not a standard behaviour. You may opt to use uri_for() or +uri_for_action() instead. + =cut sub redirect { @@ -162,20 +259,65 @@ Sets or returns the HTTP 'Location'. Sets or returns the HTTP status. $c->response->status(404); - + +$res->code is an alias for this, to match HTTP::Response->code. + =head2 $res->write( $data ) Writes $data to the output stream. -=head2 meta +=head2 $res->write_fh -Provided by Moose +Returns a PSGI $writer object that has two methods, write and close. You can +close over this object for asynchronous and nonblocking applications. For +example (assuming you are using a supporting server, like L + + package AsyncExample::Controller::Root; + + use Moose; + + BEGIN { extends 'Catalyst::Controller' } + + sub prepare_cb { + my $write_fh = pop; + return sub { + my $message = shift; + $write_fh->write("Finishing: $message\n"); + $write_fh->close; + }; + } + + sub anyevent :Local :Args(0) { + my ($self, $c) = @_; + my $cb = $self->prepare_cb($c->res->write_fh); + + my $watcher; + $watcher = AnyEvent->timer( + after => 5, + cb => sub { + $cb->(scalar localtime); + undef $watcher; # cancel circular-ref + }); + } =head2 $res->print( @data ) Prints @data to the output stream, separated by $,. This lets you pass the response object to functions that want to write to an L. +=head2 $self->finalize_headers($c) + +Writes headers to response if not already written + +=head2 DEMOLISH + +Ensures that the response is flushed and closed at the end of the +request. + +=head2 meta + +Provided by Moose + =cut sub print { @@ -188,7 +330,8 @@ sub print { defined $self->write($,) or return; defined $self->write($_) or return; } - + defined $self->write($\) or return; + return 1; } @@ -198,7 +341,7 @@ Catalyst Contributors, see Catalyst.pm =head1 COPYRIGHT -This program is free software, you can redistribute it and/or modify +This library is free software. You can redistribute it and/or modify it under the same terms as Perl itself. =cut