1 package Catalyst::Engine;
4 with 'MooseX::Emulate::Class::Accessor::Fast';
6 use CGI::Simple::Cookie;
7 use Data::Dump qw/dump/;
8 use Errno 'EWOULDBLOCK';
13 use Moose::Util::TypeConstraints;
15 use Plack::Middleware::Conditional;
16 use Plack::Middleware::ReverseProxy;
18 use namespace::clean -except => 'meta';
20 has env => (is => 'ro', writer => '_set_env', clearer => '_clear_env');
22 # input position and length
23 has read_length => (is => 'rw');
24 has read_position => (is => 'rw');
26 has _prepared_write => (is => 'rw');
31 writer => '_set_response_cb',
32 clearer => '_clear_response_cb',
37 isa => duck_type([qw(write close)]),
38 writer => '_set_writer',
39 clearer => '_clear_writer',
42 # Amount of data to read from input on each pass
43 our $CHUNKSIZE = 64 * 1024;
47 Catalyst::Engine - The Catalyst Engine
58 =head2 $self->finalize_body($c)
60 Finalize body. Prints the response output.
65 my ( $self, $c ) = @_;
66 my $body = $c->response->body;
67 no warnings 'uninitialized';
68 if ( blessed($body) && $body->can('read') or ref($body) eq 'GLOB' ) {
71 $got = read $body, my ($buffer), $CHUNKSIZE;
72 $got = 0 unless $self->write( $c, $buffer );
78 $self->write( $c, $body );
81 $self->_writer->close;
88 =head2 $self->finalize_cookies($c)
90 Create CGI::Simple::Cookie objects from $c->res->cookies, and set them as
95 sub finalize_cookies {
96 my ( $self, $c ) = @_;
99 my $response = $c->response;
101 foreach my $name (keys %{ $response->cookies }) {
103 my $val = $response->cookies->{$name};
108 : CGI::Simple::Cookie->new(
110 -value => $val->{value},
111 -expires => $val->{expires},
112 -domain => $val->{domain},
113 -path => $val->{path},
114 -secure => $val->{secure} || 0,
115 -httponly => $val->{httponly} || 0,
119 push @cookies, $cookie->as_string;
122 for my $cookie (@cookies) {
123 $response->headers->push_header( 'Set-Cookie' => $cookie );
127 =head2 $self->finalize_error($c)
129 Output an appropriate error message. Called if there's an error in $c
130 after the dispatch has finished. Will output debug messages if Catalyst
131 is in debug mode, or a `please come back later` message otherwise.
135 sub _dump_error_page_element {
136 my ($self, $i, $element) = @_;
137 my ($name, $val) = @{ $element };
139 # This is fugly, but the metaclass is _HUGE_ and demands waaay too much
140 # scrolling. Suggestions for more pleasant ways to do this welcome.
141 local $val->{'__MOP__'} = "Stringified: "
142 . $val->{'__MOP__'} if ref $val eq 'HASH' && exists $val->{'__MOP__'};
144 my $text = encode_entities( dump( $val ));
145 sprintf <<"EOF", $name, $text;
146 <h2><a href="#" onclick="toggleDump('dump_$i'); return false">%s</a></h2>
148 <pre wrap="">%s</pre>
154 my ( $self, $c ) = @_;
156 $c->res->content_type('text/html; charset=utf-8');
157 my $name = ref($c)->config->{name} || join(' ', split('::', ref $c));
159 my ( $title, $error, $infos );
163 $error = join '', map {
164 '<p><code class="error">'
165 . encode_entities($_)
168 $error ||= 'No output';
169 $error = qq{<pre wrap="">$error</pre>};
170 $title = $name = "$name on Catalyst $Catalyst::VERSION";
171 $name = "<h1>$name</h1>";
173 # Don't show context in the dump
174 $c->req->_clear_context;
175 $c->res->_clear_context;
177 # Don't show body parser in the dump
178 $c->req->_clear_body;
182 for my $dump ( $c->dump_these ) {
183 push @infos, $self->_dump_error_page_element($i, $dump);
186 $infos = join "\n", @infos;
193 (en) Please come back later
194 (fr) SVP veuillez revenir plus tard
195 (de) Bitte versuchen sie es spaeter nocheinmal
196 (at) Konnten's bitt'schoen spaeter nochmal reinschauen
197 (no) Vennligst prov igjen senere
198 (dk) Venligst prov igen senere
199 (pl) Prosze sprobowac pozniej
200 (pt) Por favor volte mais tarde
201 (ru) Попробуйте еще раз позже
202 (ua) Спробуйте ще раз пізніше
207 $c->res->body( <<"" );
208 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
209 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
210 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
212 <meta http-equiv="Content-Language" content="en" />
213 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
214 <title>$title</title>
215 <script type="text/javascript">
217 function toggleDump (dumpElement) {
218 var e = document.getElementById( dumpElement );
219 if (e.style.display == "none") {
220 e.style.display = "";
223 e.style.display = "none";
228 <style type="text/css">
230 font-family: "Bitstream Vera Sans", "Trebuchet MS", Verdana,
231 Tahoma, Arial, helvetica, sans-serif;
233 background-color: #eee;
237 :link, :link:hover, :visited, :visited:hover {
242 background-color: #ccc;
243 border: 1px solid #aaa;
248 background-color: #cce;
249 border: 1px solid #755;
255 background-color: #eee;
256 border: 1px solid #575;
262 background-color: #cce;
263 border: 1px solid #557;
272 div.name h1, div.error p {
280 text-decoration: underline;
286 /* from http://users.tkk.fi/~tkarvine/linux/doc/pre-wrap/pre-wrap-css3-mozilla-opera-ie.html */
287 /* Browser specific (not valid) styles to make preformatted text wrap */
289 white-space: pre-wrap; /* css-3 */
290 white-space: -moz-pre-wrap; /* Mozilla, since 1999 */
291 white-space: -pre-wrap; /* Opera 4-6 */
292 white-space: -o-pre-wrap; /* Opera 7 */
293 word-wrap: break-word; /* Internet Explorer 5.5+ */
299 <div class="error">$error</div>
300 <div class="infos">$infos</div>
301 <div class="name">$name</div>
307 # Trick IE. Old versions of IE would display their own error page instead
308 # of ours if we'd give it less than 512 bytes.
309 $c->res->{body} .= ( ' ' x 512 );
312 $c->res->status(500);
315 =head2 $self->finalize_headers($c)
317 Abstract method, allows engines to write headers to response
321 sub finalize_headers {
322 my ($self, $ctx) = @_;
325 $ctx->response->headers->scan(sub { push @headers, @_ });
327 $self->_set_writer($self->_response_cb->([ $ctx->response->status, \@headers ]));
328 $self->_clear_response_cb;
333 =head2 $self->finalize_read($c)
337 sub finalize_read { }
339 =head2 $self->finalize_uploads($c)
341 Clean up after uploads, deleting temp files.
345 sub finalize_uploads {
346 my ( $self, $c ) = @_;
348 # N.B. This code is theoretically entirely unneeded due to ->cleanup(1)
349 # on the HTTP::Body object.
350 my $request = $c->request;
351 foreach my $key (keys %{ $request->uploads }) {
352 my $upload = $request->uploads->{$key};
353 unlink grep { -e $_ } map { $_->tempname }
354 (ref $upload eq 'ARRAY' ? @{$upload} : ($upload));
359 =head2 $self->prepare_body($c)
361 sets up the L<Catalyst::Request> object body using L<HTTP::Body>
366 my ( $self, $c ) = @_;
368 my $appclass = ref($c) || $c;
369 if ( my $length = $self->read_length ) {
370 my $request = $c->request;
371 unless ( $request->_body ) {
372 my $type = $request->header('Content-Type');
373 $request->_body(HTTP::Body->new( $type, $length ));
374 $request->_body->cleanup(1); # Make extra sure!
375 $request->_body->tmpdir( $appclass->config->{uploadtmp} )
376 if exists $appclass->config->{uploadtmp};
379 # Check for definedness as you could read '0'
380 while ( defined ( my $buffer = $self->read($c) ) ) {
381 $c->prepare_body_chunk($buffer);
384 # paranoia against wrong Content-Length header
385 my $remaining = $length - $self->read_position;
386 if ( $remaining > 0 ) {
387 $self->finalize_read($c);
388 Catalyst::Exception->throw(
389 "Wrong Content-Length value: $length" );
393 # Defined but will cause all body code to be skipped
394 $c->request->_body(0);
398 =head2 $self->prepare_body_chunk($c)
400 Add a chunk to the request body.
404 sub prepare_body_chunk {
405 my ( $self, $c, $chunk ) = @_;
407 $c->request->_body->add($chunk);
410 =head2 $self->prepare_body_parameters($c)
412 Sets up parameters from body.
416 sub prepare_body_parameters {
417 my ( $self, $c ) = @_;
419 return unless $c->request->_body;
421 $c->request->body_parameters( $c->request->_body->param );
424 =head2 $self->prepare_connection($c)
426 Abstract method implemented in engines.
430 sub prepare_connection {
431 my ($self, $ctx) = @_;
433 my $env = $self->env;
434 my $request = $ctx->request;
436 $request->address( $env->{REMOTE_ADDR} );
437 $request->hostname( $env->{REMOTE_HOST} )
438 if exists $env->{REMOTE_HOST};
439 $request->protocol( $env->{SERVER_PROTOCOL} );
440 $request->remote_user( $env->{REMOTE_USER} );
441 $request->method( $env->{REQUEST_METHOD} );
442 $request->secure( $env->{'psgi.url_scheme'} eq 'https' ? 1 : 0 );
447 =head2 $self->prepare_cookies($c)
449 Parse cookies from header. Sets a L<CGI::Simple::Cookie> object.
453 sub prepare_cookies {
454 my ( $self, $c ) = @_;
456 if ( my $header = $c->request->header('Cookie') ) {
457 $c->req->cookies( { CGI::Simple::Cookie->parse($header) } );
461 =head2 $self->prepare_headers($c)
465 sub prepare_headers {
466 my ($self, $ctx) = @_;
468 my $env = $self->env;
469 my $headers = $ctx->request->headers;
471 for my $header (keys %{ $env }) {
472 next unless $header =~ /^(HTTP|CONTENT|COOKIE)/i;
473 (my $field = $header) =~ s/^HTTPS?_//;
475 $headers->header($field => $env->{$header});
479 =head2 $self->prepare_parameters($c)
481 sets up parameters from query and post parameters.
485 sub prepare_parameters {
486 my ( $self, $c ) = @_;
488 my $request = $c->request;
489 my $parameters = $request->parameters;
490 my $body_parameters = $request->body_parameters;
491 my $query_parameters = $request->query_parameters;
492 # We copy, no references
493 foreach my $name (keys %$query_parameters) {
494 my $param = $query_parameters->{$name};
495 $parameters->{$name} = ref $param eq 'ARRAY' ? [ @$param ] : $param;
498 # Merge query and body parameters
499 foreach my $name (keys %$body_parameters) {
500 my $param = $body_parameters->{$name};
501 my @values = ref $param eq 'ARRAY' ? @$param : ($param);
502 if ( my $existing = $parameters->{$name} ) {
503 unshift(@values, (ref $existing eq 'ARRAY' ? @$existing : $existing));
505 $parameters->{$name} = @values > 1 ? \@values : $values[0];
509 =head2 $self->prepare_path($c)
511 abstract method, implemented by engines.
516 my ($self, $ctx) = @_;
518 my $env = $self->env;
520 my $scheme = $ctx->request->secure ? 'https' : 'http';
521 my $host = $env->{HTTP_HOST} || $env->{SERVER_NAME};
522 my $port = $env->{SERVER_PORT} || 80;
523 my $base_path = $env->{SCRIPT_NAME} || "/";
525 # set the request URI
527 if (!$ctx->config->{use_request_uri_for_path}) {
528 $path = $base_path . $env->{PATH_INFO};
530 $path =~ s/([^$URI::uric])/$URI::Escape::escapes{$1}/go;
531 $path =~ s/\?/%3F/g; # STUPID STUPID SPECIAL CASE
534 my $req_uri = $env->{REQUEST_URI};
535 $req_uri =~ s/\?.*$//;
540 # Using URI directly is way too slow, so we construct the URLs manually
541 my $uri_class = "URI::$scheme";
543 # HTTP_HOST will include the port even if it's 80/443
544 $host =~ s/:(?:80|443)$//;
546 if ($port !~ /^(?:80|443)$/ && $host !~ /:/) {
550 my $query = $env->{QUERY_STRING} ? '?' . $env->{QUERY_STRING} : '';
551 my $uri = $scheme . '://' . $host . '/' . $path . $query;
553 $ctx->request->uri( (bless \$uri, $uri_class)->canonical );
556 # base must end in a slash
557 $base_path .= '/' unless $base_path =~ m{/$};
559 my $base_uri = $scheme . '://' . $host . $base_path;
561 $ctx->request->base( bless \$base_uri, $uri_class );
566 =head2 $self->prepare_request($c)
568 =head2 $self->prepare_query_parameters($c)
570 process the query string and extract query parameters.
574 sub prepare_query_parameters {
577 my $query_string = exists $self->env->{QUERY_STRING}
578 ? $self->env->{QUERY_STRING}
581 # Check for keywords (no = signs)
582 # (yes, index() is faster than a regex :))
583 if ( index( $query_string, '=' ) < 0 ) {
584 $c->request->query_keywords( $self->unescape_uri($query_string) );
590 # replace semi-colons
591 $query_string =~ s/;/&/g;
593 my @params = grep { length $_ } split /&/, $query_string;
595 for my $item ( @params ) {
598 = map { $self->unescape_uri($_) }
599 split( /=/, $item, 2 );
601 $param = $self->unescape_uri($item) unless defined $param;
603 if ( exists $query{$param} ) {
604 if ( ref $query{$param} ) {
605 push @{ $query{$param} }, $value;
608 $query{$param} = [ $query{$param}, $value ];
612 $query{$param} = $value;
616 $c->request->query_parameters( \%query );
619 =head2 $self->prepare_read($c)
621 prepare to read from the engine.
626 my ( $self, $c ) = @_;
628 # Initialize the read position
629 $self->read_position(0);
631 # Initialize the amount of data we think we need to read
632 $self->read_length( $c->request->header('Content-Length') || 0 );
635 =head2 $self->prepare_request(@arguments)
637 Populate the context object from the request object.
641 sub prepare_request {
642 my ($self, $ctx, %args) = @_;
643 $self->_set_env($args{env});
646 =head2 $self->prepare_uploads($c)
650 sub prepare_uploads {
651 my ( $self, $c ) = @_;
653 my $request = $c->request;
654 return unless $request->_body;
656 my $uploads = $request->_body->upload;
657 my $parameters = $request->parameters;
658 foreach my $name (keys %$uploads) {
659 my $files = $uploads->{$name};
661 for my $upload (ref $files eq 'ARRAY' ? @$files : ($files)) {
662 my $headers = HTTP::Headers->new( %{ $upload->{headers} } );
663 my $u = Catalyst::Request::Upload->new
665 size => $upload->{size},
666 type => scalar $headers->content_type,
668 tempname => $upload->{tempname},
669 filename => $upload->{filename},
673 $request->uploads->{$name} = @uploads > 1 ? \@uploads : $uploads[0];
675 # support access to the filename as a normal param
676 my @filenames = map { $_->{filename} } @uploads;
677 # append, if there's already params with this name
678 if (exists $parameters->{$name}) {
679 if (ref $parameters->{$name} eq 'ARRAY') {
680 push @{ $parameters->{$name} }, @filenames;
683 $parameters->{$name} = [ $parameters->{$name}, @filenames ];
687 $parameters->{$name} = @filenames > 1 ? \@filenames : $filenames[0];
692 =head2 $self->prepare_write($c)
694 Abstract method. Implemented by the engines.
698 sub prepare_write { }
700 =head2 $self->read($c, [$maxlength])
702 Reads from the input stream by calling C<< $self->read_chunk >>.
704 Maintains the read_length and read_position counters as data is read.
709 my ( $self, $c, $maxlength ) = @_;
711 my $remaining = $self->read_length - $self->read_position;
712 $maxlength ||= $CHUNKSIZE;
714 # Are we done reading?
715 if ( $remaining <= 0 ) {
716 $self->finalize_read($c);
720 my $readlen = ( $remaining > $maxlength ) ? $maxlength : $remaining;
721 my $rc = $self->read_chunk( $c, my $buffer, $readlen );
723 if (0 == $rc) { # Nothing more to read even though Content-Length
724 # said there should be.
725 $self->finalize_read;
728 $self->read_position( $self->read_position + $rc );
732 Catalyst::Exception->throw(
733 message => "Unknown error reading input: $!" );
737 =head2 $self->read_chunk($c, $buffer, $length)
739 Each engine implements read_chunk as its preferred way of reading a chunk
740 of data. Returns the number of bytes read. A return of 0 indicates that
741 there is no more data to be read.
746 my ($self, $ctx) = (shift, shift);
747 return $self->env->{'psgi.input'}->read(@_);
750 =head2 $self->read_length
752 The length of input data to be read. This is obtained from the Content-Length
755 =head2 $self->read_position
757 The amount of input data that has already been read.
759 =head2 $self->run($app, $server)
761 Start the engine. Builds a PSGI application and calls the
762 run method on the server passed in..
767 my ($self, $app, @args) = @_;
768 my $server = pop @args if blessed $args[-1];
769 $server ||= Plack::Loader->auto(); # We're not being called from a script,
770 # so auto detect what backend to run on.
771 # This does *NOT* cover mod_perl.
772 # FIXME - Do something sensible with the options we're passed
773 my $psgi = $self->build_psgi_app($app, @args);
777 =head2 build_psgi_app ($app, @args)
779 Builds and returns a PSGI application closure, wrapping it in the reverse proxy
780 middleware if the using_frontend_proxy config setting is set.
785 my ($self, $app, @args) = @_;
792 $self->_set_response_cb($respond);
793 $app->handle_request(env => $env);
797 $psgi_app = Plack::Middleware::Conditional->wrap(
801 return if $app->config->{ignore_frontend_proxy};
802 return $env->{REMOTE_ADDR} eq '127.0.0.1' || $app->config->{using_frontend_proxy};
804 builder => sub { Plack::Middleware::ReverseProxy->wrap($_[0]) },
810 =head2 $self->write($c, $buffer)
812 Writes the buffer to the client.
817 my ( $self, $c, $buffer ) = @_;
819 unless ( $self->_prepared_write ) {
820 $self->prepare_write($c);
821 $self->_prepared_write(1);
824 return 0 if !defined $buffer;
826 my $len = length($buffer);
827 $self->_writer->write($buffer);
832 =head2 $self->unescape_uri($uri)
834 Unescapes a given URI using the most efficient method available. Engines such
835 as Apache may implement this using Apache's C-based modules, for example.
840 my ( $self, $str ) = @_;
842 $str =~ s/(?:%([0-9A-Fa-f]{2})|\+)/defined $1 ? chr(hex($1)) : ' '/eg;
847 =head2 $self->finalize_output
849 <obsolete>, see finalize_body
853 Hash containing environment variables including many special variables inserted
854 by WWW server - like SERVER_*, REMOTE_*, HTTP_* ...
856 Before accessing environment variables consider whether the same information is
857 not directly available via Catalyst objects $c->request, $c->engine ...
859 BEWARE: If you really need to access some environment variable from your Catalyst
860 application you should use $c->engine->env->{VARNAME} instead of $ENV{VARNAME},
861 as in some enviroments the %ENV hash does not contain what you would expect.
865 Catalyst Contributors, see Catalyst.pm
869 This library is free software. You can redistribute it and/or modify it under
870 the same terms as Perl itself.