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=4d0e85a032c15260dbf5f2f177ffd02f94545dc5;hp=6f8b5c66ea0d5ea75ca7ab677c1669a5d8216bd8;hb=561098d14347a2492a5471fc7c9352ad2e6520bc;hpb=fbcc39ad23f2bbecf5d84c9ba581e6af86fcd460 diff --git a/lib/Catalyst/Response.pm b/lib/Catalyst/Response.pm index 6f8b5c6..4d0e85a 100644 --- a/lib/Catalyst/Response.pm +++ b/lib/Catalyst/Response.pm @@ -1,30 +1,156 @@ package Catalyst::Response; -use strict; -use base 'Class::Accessor::Fast'; +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', #Pointless since we control how this is built + #writer => '_set_writer', Now that its lazy I think this is safe to remove + clearer => '_clear_writer', + predicate => '_has_writer', + lazy => 1, + builder => '_build_writer', +); + +sub _build_writer { + my $self = shift; + + ## These two lines are probably crap now... + $self->_context->finalize_headers unless + $self->finalized_headers; + + my @headers; + $self->headers->scan(sub { push @headers, @_ }); + + my $writer = $self->_response_cb->([ $self->status, \@headers ]); + $self->_clear_response_cb; + + return $writer; +} + +has write_fh => ( + is=>'ro', + predicate=>'_has_write_fh', + lazy=>1, + builder=>'_build_write_fh', +); + +sub _build_write_fh { shift ->_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 => 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, + lazy => 1, +); +has _context => ( + is => 'rw', + weak_ref => 1, + clearer => '_clear_context', +); + +before [qw(status headers content_encoding content_length content_type header)] => sub { + my $self = shift; -__PACKAGE__->mk_accessors(qw/cookies body headers location status/); + $self->_context->log->warn( + "Useless setting a header value after finalize_headers called." . + " Not what you want." ) + if ( $self->finalized_headers && @_ ); +}; -*output = \&body; +sub output { shift->body(@_) } -sub content_encoding { shift->headers->content_encoding(@_) } -sub content_length { shift->headers->content_length(@_) } -sub content_type { shift->headers->content_type(@_) } -sub header { shift->headers->header(@_) } +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) = @_; + return; +} + +sub from_psgi_response { + my ($self, $psgi_res) = @_; + if(ref $psgi_res eq 'ARRAY') { + my ($status, $headers, $body) = @$psgi_res; + $self->status($status); + $self->headers(HTTP::Headers->new(@$headers)); + $self->body($body); + } elsif(ref $psgi_res eq 'CODE') { + $psgi_res->(sub { + my $response = shift; + my ($status, $headers, $maybe_body) = @$response; + $self->status($status); + $self->headers(HTTP::Headers->new(@$headers)); + if(defined $maybe_body) { + $self->body($maybe_body); + } else { + return $self->write_fh; + } + }); + } else { + die "You can't set a Catalyst response from that, expect a valid PSGI response"; + } +} =head1 NAME -Catalyst::Response - Catalyst Response Class +Catalyst::Response - stores output responding to the current client request =head1 SYNOPSIS $res = $c->response; $res->body; + $res->code; $res->content_encoding; $res->content_length; $res->content_type; $res->cookies; - $res->handle; $res->header; $res->headers; $res->output; @@ -32,84 +158,116 @@ Catalyst::Response - Catalyst Response Class $res->status; $res->write; -See also L. - =head1 DESCRIPTION -This is the Catalyst Response class, which provides a set of accessors -to response data. +This is the Catalyst Response class, which provides methods for responding to +the current client request. The appropriate L for your environment +will turn the Catalyst::Response into a HTTP Response and return it to the client. =head1 METHODS -=over 4 - -=item $res->body($text) +=head2 $res->body( $text | $fh | $iohandle_object ) $c->response->body('Catalyst rocks!'); -Contains the final output. +Sets or returns the output (text or binary data). If you are returning a large body, +you might want to use a L type of object (Something that implements the read method +in the same fashion), or a filehandle GLOB. Catalyst +will write it piece by piece into the response. + +When using a L type of object and no content length has been +already set in the response headers Catalyst will make a reasonable attempt +to determine the size of the Handle. Depending on the implementation of your +handle object, setting the content length may fail. If it is at all possible +for you to determine the content length of your handle object, +it is recommended that you set the content length in the response headers +yourself, which will be respected and sent by Catalyst in the response. + +=head2 $res->has_body + +Predicate which returns true when a body has been set. + +=head2 $res->code + +Alias for $res->status. + +=head2 $res->content_encoding -=item $res->content_encoding +Shortcut for $res->headers->content_encoding. -Shortcut to $res->headers->content_encoding +=head2 $res->content_length -=item $res->content_length +Shortcut for $res->headers->content_length. -Shortcut to $res->headers->content_length +=head2 $res->content_type -=item $res->content_type +Shortcut for $res->headers->content_type. -Shortcut to $res->headers->content_type +This value is typically set by your view or plugin. For example, +L will guess the mime type based on the file +it found, while L defaults to C. -=item $res->cookies +=head2 $res->cookies -Returns a reference to a hash containing the cookies to be set. +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. $c->response->cookies->{foo} = { value => '123' }; -=item $res->handle +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: -Response IO handle. +=over -=cut +=item value -sub handle { - my ( $self, $handle ) = @_; - - if ($handle) { - $self->{handle} = $handle; - } - else { - # Finalize headers if someone touches the output handle - if ( $self->{_context} ) { - $self->{_context}->finalize_headers; - } - } - - return $self->{handle}; -} +=item expires + +=item domain + +=item path + +=item secure + +=item httponly + +=back -=item $res->header +=head2 $res->header -Shortcut to $res->headers->header +Shortcut for $res->headers->header. -=item $res->headers +=head2 $res->headers -Returns a L object containing the headers. +Returns an L object, which can be used to set headers. $c->response->headers->header( 'X-Catalyst' => $Catalyst::VERSION ); -=item $res->output +=head2 $res->output -Shortcut to $res->body +Alias for $res->body. -=item $res->redirect( $url, $status ) +=head2 $res->redirect( $url, $status ) -Contains a location to redirect to. +Causes the response to redirect to the specified URL. The default status is +C<302>. $c->response->redirect( 'http://slashdot.org' ); $c->response->redirect( 'http://slashdot.org', 307 ); +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 +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 { @@ -126,32 +284,129 @@ sub redirect { return $self->location; } -=item $res->status +=head2 $res->location + +Sets or returns the HTTP 'Location'. -Contains the HTTP status. +=head2 $res->status + +Sets or returns the HTTP status. $c->response->status(404); - -=item $res->write( $data ) + +$res->code is an alias for this, to match HTTP::Response->code. + +=head2 $res->write( $data ) Writes $data to the output stream. +=head2 $res->write_fh + +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 from_psgi_response + +Given a PSGI response (either three element ARRAY reference OR coderef expecting +a $responder) set the response from it. + +Properly supports streaming and delayed response and / or async IO if running +under an expected event loop. + +Example: + + package MyApp::Web::Controller::Test; + + use base 'Catalyst::Controller'; + use Plack::App::Directory; + + + my $app = Plack::App::Directory->new({ root => "/path/to/htdocs" }) + ->to_app; + + sub myaction :Local Args { + my ($self, $c) = @_; + $c->res->from_psgi_response($app->($c->req->env)); + } + +Please note this does not attempt to map or nest your PSGI application under +the Controller and Action namespace or path. + +=head2 DEMOLISH + +Ensures that the response is flushed and closed at the end of the +request. + +=head2 meta + +Provided by Moose + =cut -sub write { shift->{_context}->write(@_); } +sub print { + my $self = shift; + my $data = shift; -=back + defined $self->write($data) or return; -=head1 AUTHOR + for (@_) { + defined $self->write($,) or return; + defined $self->write($_) or return; + } + defined $self->write($\) or return; + + return 1; +} -Sebastian Riedel, C -Marcus Ramberg, C +=head1 AUTHORS + +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 +__PACKAGE__->meta->make_immutable; + 1;