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=0ef4c52ddf4ebe626a164e7d4ead178b5611c11f;hp=709f0adac33f369e834fbde445762d2ed47a2eaf;hb=12982f8623b4a3520146d4f52c5705d2b8a3b5ab;hpb=b194746d5368ff5d1b65d667f04991a780e01a1b diff --git a/lib/Catalyst/Response.pm b/lib/Catalyst/Response.pm index 709f0ad..0ef4c52 100644 --- a/lib/Catalyst/Response.pm +++ b/lib/Catalyst/Response.pm @@ -5,6 +5,7 @@ use HTTP::Headers; use Moose::Util::TypeConstraints; use namespace::autoclean; use Scalar::Util 'blessed'; +use Catalyst::Response::Writer; with 'MooseX::Emulate::Class::Accessor::Fast'; @@ -52,7 +53,17 @@ has write_fh => ( builder=>'_build_write_fh', ); -sub _build_write_fh { shift ->_writer } +sub _build_write_fh { + my $writer = $_[0]->_writer; # We need to get the finalize headers side effect... + my $requires_encoding = $_[0]->content_type =~ m/$Catalyst::DEFAULT_ENCODE_CONTENT_TYPE_MATCH/; + my %fields = ( + _writer => $writer, + _encoding => $_[0]->encoding, + _requires_encoding => $requires_encoding, + ); + + return bless \%fields, 'Catalyst::Response::Writer'; +} sub DEMOLISH { my $self = shift; @@ -83,6 +94,8 @@ has _context => ( clearer => '_clear_context', ); +has encoding => (is=>'ro'); + before [qw(status headers content_encoding content_length content_type header)] => sub { my $self = shift; @@ -104,6 +117,9 @@ sub write { $buffer = q[] unless defined $buffer; + $buffer = $self->_context->encoding->encode( $buffer, $self->_context->_encode_check ) + if $self->_context->encoding && $self->content_type =~ /$Catalyst::DEFAULT_ENCODE_CONTENT_TYPE_MATCH/; + my $len = length($buffer); $self->_writer->write($buffer); @@ -351,6 +367,12 @@ qualified (= C, etc.) or that starts with a slash thing and is not a standard behaviour. You may opt to use uri_for() or uri_for_action() instead. +B If $url is an object that does ->as_string (such as L, which is +what you get from ->uri_for) we automatically call that to stringify. This +should ease the common case usage + + return $c->res->redirect( $c->uri_for(...)); + =cut sub redirect { @@ -360,6 +382,10 @@ sub redirect { my $location = shift; my $status = shift || 302; + if(blessed($location) && $location->can('as_string')) { + $location = $location->as_string; + } + $self->location($location); $self->status($status); } @@ -381,13 +407,39 @@ $res->code is an alias for this, to match HTTP::Response->code. =head2 $res->write( $data ) -Writes $data to the output stream. +Writes $data to the output stream. Calling this method will finalize your +headers and send the headers and status code response to the client (so changing +them afterwards is a waste... be sure to set your headers correctly first). + +You may call this as often as you want throughout your response cycle. You may +even set a 'body' afterward. So for example you might write your HTTP headers +and the HEAD section of your document and then set the body from a template +driven from a database. In some cases this can seem to the client as if you had +a faster overall response (but note that unless your server support chunked +body your content is likely to get queued anyway (L and most other +http 1.1 webservers support this). + +If there is an encoding set, we encode each line of the response (the default +encoding is UTF-8). =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 +Returns an instance of L, which is a lightweight +decorator over the PSGI C<$writer> object (see L). + +In addition to proxying the C and C method from the underlying PSGI +writer, this proxy object knows any application wide encoding, and provides a method +C that will properly encode your written lines based upon your +encoding settings. By default in L responses are UTF-8 encoded and this +is the encoding used if you respond via C. If you want to handle +encoding yourself, you can use the C method directly. + +Encoding only applies to content types for which it matters. Currently the following +content types are assumed to need encoding: text (including HTML), xml and javascript. + +We provide access to this object so that you can properly close over it for use in +asynchronous and nonblocking applications. For example (assuming you are using a supporting +server, like L: package AsyncExample::Controller::Root; @@ -417,6 +469,10 @@ example (assuming you are using a supporting server, like L }); } +Like the 'write' method, calling this will finalize headers. Unlike 'write' when you +can this it is assumed you are taking control of the response so the body is never +finalized (there isn't one anyway) and you need to call the close method. + =head2 $res->print( @data ) Prints @data to the output stream, separated by $,. This lets you pass