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=1e1e4bfbeeb8d6174b6650753a7b44031c141a64;hb=12982f8623b4a3520146d4f52c5705d2b8a3b5ab;hpb=824a5eb06f0e83845f000a33124482be89c2291f diff --git a/lib/Catalyst/Response.pm b/lib/Catalyst/Response.pm index 1e1e4bf..0ef4c52 100644 --- a/lib/Catalyst/Response.pm +++ b/lib/Catalyst/Response.pm @@ -2,9 +2,77 @@ package Catalyst::Response; use Moose; use HTTP::Headers; +use Moose::Util::TypeConstraints; +use namespace::autoclean; +use Scalar::Util 'blessed'; +use Catalyst::Response::Writer; 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 { + 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; + 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) } @@ -23,15 +91,72 @@ has headers => ( has _context => ( is => 'rw', weak_ref => 1, - handles => ['write'], clearer => '_clear_context', ); +has encoding => (is=>'ro'); + +before [qw(status headers content_encoding content_length content_type header)] => sub { + my $self = shift; + + $self->_context->log->warn( + "Useless setting a header value after finalize_headers called." . + " Not what you want." ) + if ( $self->finalized_headers && @_ ); +}; + sub output { shift->body(@_) } sub code { shift->status(@_) } -no Moose; +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; + + $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); + + return $len; +} + +sub finalize_headers { + my ($self) = @_; + return; +} + +sub from_psgi_response { + my ($self, $psgi_res) = @_; + if(blessed($psgi_res) && $psgi_res->can('as_psgi')) { + $psgi_res = $psgi_res->as_psgi; + } + 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 @@ -70,6 +195,93 @@ you might want to use a L type of object (Something that implements 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. + +Please note that the object needs to implement C, not just +C. + +Starting from version 5.90060, when using an L object, you +may want to use L, to delegate the +actual serving to the frontend server. To do so, you need to pass to +C an IO object with a C method. This can be achieved in +two ways. + +Either using L: + + my $fh = IO::File->new($file, 'r'); + Plack::Util::set_io_path($fh, $file); + +Or using L + + my $fh = IO::File::WithPath->new($file, 'r'); + +And then passing the filehandle to body and setting headers, if needed. + + $c->response->body($fh); + $c->response->headers->content_type('text/plain'); + $c->response->headers->content_length(-s $file); + $c->response->headers->last_modified((stat($file))[9]); + +L can be loaded in the application so: + + __PACKAGE__->config( + psgi_middleware => [ + 'XSendfile', + # other middlewares here... + ], + ); + +B that loading the middleware without configuring the +webserver to set the request header C to a supported +type (C for nginx, C for Apache and +Lighttpd), could lead to the disclosure of private paths to malicious +clients setting that header. + +Nginx needs the additional X-Accel-Mapping header to be set in the +webserver configuration, so the middleware will replace the absolute +path of the IO object with the internal nginx path. This is also +useful to prevent a buggy app to server random files from the +filesystem, as it's an internal redirect. + +An nginx configuration for FastCGI could look so: + + server { + server_name example.com; + root /my/app/root; + location /private/repo/ { + internal; + alias /my/app/repo/; + } + location /private/staging/ { + internal; + alias /my/app/staging/; + } + location @proxy { + include /etc/nginx/fastcgi_params; + fastcgi_param SCRIPT_NAME ''; + fastcgi_param PATH_INFO $fastcgi_script_name; + fastcgi_param HTTP_X_SENDFILE_TYPE X-Accel-Redirect; + fastcgi_param HTTP_X_ACCEL_MAPPING /my/app=/private; + fastcgi_pass unix:/my/app/run/app.sock; + } + } + +In the example above, passing filehandles with a local path matching +/my/app/staging or /my/app/repo will be served by nginx. Passing paths +with other locations will lead to an internal server error. + +Setting the body to a filehandle without the C method bypasses +the middleware completely. + +For Apache and Lighttpd, the mapping doesn't apply and setting the +X-Sendfile-Type is enough. + =head2 $res->has_body Predicate which returns true when a body has been set. @@ -155,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 { @@ -164,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); } @@ -185,17 +407,119 @@ $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). -=head2 meta +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). -Provided by Moose +If there is an encoding set, we encode each line of the response (the default +encoding is UTF-8). + +=head2 $res->write_fh + +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; + + 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 + }); + } + +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 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. + +If passed an object, will expect that object to do a method C. + +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 print {