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>
308 $c->res->{body} .= ( ' ' x 512 );
311 $c->res->status(500);
314 =head2 $self->finalize_headers($c)
316 Abstract method, allows engines to write headers to response
320 sub finalize_headers {
321 my ($self, $ctx) = @_;
324 $ctx->response->headers->scan(sub { push @headers, @_ });
326 $self->_set_writer($self->_response_cb->([ $ctx->response->status, \@headers ]));
327 $self->_clear_response_cb;
332 =head2 $self->finalize_read($c)
336 sub finalize_read { }
338 =head2 $self->finalize_uploads($c)
340 Clean up after uploads, deleting temp files.
344 sub finalize_uploads {
345 my ( $self, $c ) = @_;
347 my $request = $c->request;
348 foreach my $key (keys %{ $request->uploads }) {
349 my $upload = $request->uploads->{$key};
350 unlink grep { -e $_ } map { $_->tempname }
351 (ref $upload eq 'ARRAY' ? @{$upload} : ($upload));
356 =head2 $self->prepare_body($c)
358 sets up the L<Catalyst::Request> object body using L<HTTP::Body>
363 my ( $self, $c ) = @_;
365 my $appclass = ref($c) || $c;
366 if ( my $length = $self->read_length ) {
367 my $request = $c->request;
368 unless ( $request->_body ) {
369 my $type = $request->header('Content-Type');
370 $request->_body(HTTP::Body->new( $type, $length ));
371 $request->_body->tmpdir( $appclass->config->{uploadtmp} )
372 if exists $appclass->config->{uploadtmp};
375 # Check for definedness as you could read '0'
376 while ( defined ( my $buffer = $self->read($c) ) ) {
377 $c->prepare_body_chunk($buffer);
380 # paranoia against wrong Content-Length header
381 my $remaining = $length - $self->read_position;
382 if ( $remaining > 0 ) {
383 $self->finalize_read($c);
384 Catalyst::Exception->throw(
385 "Wrong Content-Length value: $length" );
389 # Defined but will cause all body code to be skipped
390 $c->request->_body(0);
394 =head2 $self->prepare_body_chunk($c)
396 Add a chunk to the request body.
400 sub prepare_body_chunk {
401 my ( $self, $c, $chunk ) = @_;
403 $c->request->_body->add($chunk);
406 =head2 $self->prepare_body_parameters($c)
408 Sets up parameters from body.
412 sub prepare_body_parameters {
413 my ( $self, $c ) = @_;
415 return unless $c->request->_body;
417 $c->request->body_parameters( $c->request->_body->param );
420 =head2 $self->prepare_connection($c)
422 Abstract method implemented in engines.
426 sub prepare_connection {
427 my ($self, $ctx) = @_;
429 my $env = $self->env;
430 my $request = $ctx->request;
432 $request->address( $env->{REMOTE_ADDR} );
433 $request->hostname( $env->{REMOTE_HOST} )
434 if exists $env->{REMOTE_HOST};
435 $request->protocol( $env->{SERVER_PROTOCOL} );
436 $request->remote_user( $env->{REMOTE_USER} );
437 $request->method( $env->{REQUEST_METHOD} );
438 $request->secure( $env->{'psgi.url_scheme'} eq 'https' ? 1 : 0 );
443 =head2 $self->prepare_cookies($c)
445 Parse cookies from header. Sets a L<CGI::Simple::Cookie> object.
449 sub prepare_cookies {
450 my ( $self, $c ) = @_;
452 if ( my $header = $c->request->header('Cookie') ) {
453 $c->req->cookies( { CGI::Simple::Cookie->parse($header) } );
457 =head2 $self->prepare_headers($c)
461 sub prepare_headers {
462 my ($self, $ctx) = @_;
464 my $env = $self->env;
465 my $headers = $ctx->request->headers;
467 for my $header (keys %{ $env }) {
468 next unless $header =~ /^(HTTP|CONTENT|COOKIE)/i;
469 (my $field = $header) =~ s/^HTTPS?_//;
471 $headers->header($field => $env->{$header});
475 =head2 $self->prepare_parameters($c)
477 sets up parameters from query and post parameters.
481 sub prepare_parameters {
482 my ( $self, $c ) = @_;
484 my $request = $c->request;
485 my $parameters = $request->parameters;
486 my $body_parameters = $request->body_parameters;
487 my $query_parameters = $request->query_parameters;
488 # We copy, no references
489 foreach my $name (keys %$query_parameters) {
490 my $param = $query_parameters->{$name};
491 $parameters->{$name} = ref $param eq 'ARRAY' ? [ @$param ] : $param;
494 # Merge query and body parameters
495 foreach my $name (keys %$body_parameters) {
496 my $param = $body_parameters->{$name};
497 my @values = ref $param eq 'ARRAY' ? @$param : ($param);
498 if ( my $existing = $parameters->{$name} ) {
499 unshift(@values, (ref $existing eq 'ARRAY' ? @$existing : $existing));
501 $parameters->{$name} = @values > 1 ? \@values : $values[0];
505 =head2 $self->prepare_path($c)
507 abstract method, implemented by engines.
512 my ($self, $ctx) = @_;
514 my $env = $self->env;
516 my $scheme = $ctx->request->secure ? 'https' : 'http';
517 my $host = $env->{HTTP_HOST} || $env->{SERVER_NAME};
518 my $port = $env->{SERVER_PORT} || 80;
519 my $base_path = $env->{SCRIPT_NAME} || "/";
521 # set the request URI
522 my $req_uri = $env->{REQUEST_URI};
523 $req_uri =~ s/\?.*$//;
527 # Using URI directly is way too slow, so we construct the URLs manually
528 my $uri_class = "URI::$scheme";
530 # HTTP_HOST will include the port even if it's 80/443
531 $host =~ s/:(?:80|443)$//;
533 if ($port !~ /^(?:80|443)$/ && $host !~ /:/) {
537 my $query = $env->{QUERY_STRING} ? '?' . $env->{QUERY_STRING} : '';
538 my $uri = $scheme . '://' . $host . '/' . $path . $query;
540 $ctx->request->uri( (bless \$uri, $uri_class)->canonical );
543 # base must end in a slash
544 $base_path .= '/' unless $base_path =~ m{/$};
546 my $base_uri = $scheme . '://' . $host . $base_path;
548 $ctx->request->base( bless \$base_uri, $uri_class );
553 =head2 $self->prepare_request($c)
555 =head2 $self->prepare_query_parameters($c)
557 process the query string and extract query parameters.
561 sub prepare_query_parameters {
564 my $query_string = exists $self->env->{QUERY_STRING}
565 ? $self->env->{QUERY_STRING}
568 # Check for keywords (no = signs)
569 # (yes, index() is faster than a regex :))
570 if ( index( $query_string, '=' ) < 0 ) {
571 $c->request->query_keywords( $self->unescape_uri($query_string) );
577 # replace semi-colons
578 $query_string =~ s/;/&/g;
580 my @params = grep { length $_ } split /&/, $query_string;
582 for my $item ( @params ) {
585 = map { $self->unescape_uri($_) }
586 split( /=/, $item, 2 );
588 $param = $self->unescape_uri($item) unless defined $param;
590 if ( exists $query{$param} ) {
591 if ( ref $query{$param} ) {
592 push @{ $query{$param} }, $value;
595 $query{$param} = [ $query{$param}, $value ];
599 $query{$param} = $value;
603 $c->request->query_parameters( \%query );
606 =head2 $self->prepare_read($c)
608 prepare to read from the engine.
613 my ( $self, $c ) = @_;
615 # Initialize the read position
616 $self->read_position(0);
618 # Initialize the amount of data we think we need to read
619 $self->read_length( $c->request->header('Content-Length') || 0 );
622 =head2 $self->prepare_request(@arguments)
624 Populate the context object from the request object.
628 sub prepare_request {
629 my ($self, $ctx, %args) = @_;
630 $self->_set_env($args{env});
633 =head2 $self->prepare_uploads($c)
637 sub prepare_uploads {
638 my ( $self, $c ) = @_;
640 my $request = $c->request;
641 return unless $request->_body;
643 my $uploads = $request->_body->upload;
644 my $parameters = $request->parameters;
645 foreach my $name (keys %$uploads) {
646 my $files = $uploads->{$name};
648 for my $upload (ref $files eq 'ARRAY' ? @$files : ($files)) {
649 my $headers = HTTP::Headers->new( %{ $upload->{headers} } );
650 my $u = Catalyst::Request::Upload->new
652 size => $upload->{size},
653 type => $headers->content_type,
655 tempname => $upload->{tempname},
656 filename => $upload->{filename},
660 $request->uploads->{$name} = @uploads > 1 ? \@uploads : $uploads[0];
662 # support access to the filename as a normal param
663 my @filenames = map { $_->{filename} } @uploads;
664 # append, if there's already params with this name
665 if (exists $parameters->{$name}) {
666 if (ref $parameters->{$name} eq 'ARRAY') {
667 push @{ $parameters->{$name} }, @filenames;
670 $parameters->{$name} = [ $parameters->{$name}, @filenames ];
674 $parameters->{$name} = @filenames > 1 ? \@filenames : $filenames[0];
679 =head2 $self->prepare_write($c)
681 Abstract method. Implemented by the engines.
685 sub prepare_write { }
687 =head2 $self->read($c, [$maxlength])
689 Reads from the input stream by calling C<< $self->read_chunk >>.
691 Maintains the read_length and read_position counters as data is read.
696 my ( $self, $c, $maxlength ) = @_;
698 my $remaining = $self->read_length - $self->read_position;
699 $maxlength ||= $CHUNKSIZE;
701 # Are we done reading?
702 if ( $remaining <= 0 ) {
703 $self->finalize_read($c);
707 my $readlen = ( $remaining > $maxlength ) ? $maxlength : $remaining;
708 my $rc = $self->read_chunk( $c, my $buffer, $readlen );
710 if (0 == $rc) { # Nothing more to read even though Content-Length
711 # said there should be.
712 $self->finalize_read;
715 $self->read_position( $self->read_position + $rc );
719 Catalyst::Exception->throw(
720 message => "Unknown error reading input: $!" );
724 =head2 $self->read_chunk($c, $buffer, $length)
726 Each engine implements read_chunk as its preferred way of reading a chunk
727 of data. Returns the number of bytes read. A return of 0 indicates that
728 there is no more data to be read.
733 my ($self, $ctx) = (shift, shift);
734 return $self->env->{'psgi.input'}->read(@_);
737 =head2 $self->read_length
739 The length of input data to be read. This is obtained from the Content-Length
742 =head2 $self->read_position
744 The amount of input data that has already been read.
746 =head2 $self->run($c)
748 Start the engine. Implemented by the various engine classes.
753 my ($self, $app, $server, @args) = @_;
754 # FIXME - Do something sensible with the options we're passed
755 $server->run($self->_build_psgi_app($app, @args));
758 sub _build_psgi_app {
759 my ($self, $app, @args) = @_;
766 $self->_set_response_cb($respond);
767 $app->handle_request(env => $env);
771 $psgi_app = Plack::Middleware::Conditional->wrap(
775 return if $app->config->{ignore_frontend_proxy};
776 return $env->{REMOTE_ADDR} eq '127.0.0.1' || $app->config->{using_frontend_proxy};
778 builder => sub { Plack::Middleware::ReverseProxy->wrap($_[0]) },
784 =head2 $self->write($c, $buffer)
786 Writes the buffer to the client.
791 my ( $self, $c, $buffer ) = @_;
793 unless ( $self->_prepared_write ) {
794 $self->prepare_write($c);
795 $self->_prepared_write(1);
798 return 0 if !defined $buffer;
800 my $len = length($buffer);
801 $self->_writer->write($buffer);
806 =head2 $self->unescape_uri($uri)
808 Unescapes a given URI using the most efficient method available. Engines such
809 as Apache may implement this using Apache's C-based modules, for example.
814 my ( $self, $str ) = @_;
816 $str =~ s/(?:%([0-9A-Fa-f]{2})|\+)/defined $1 ? chr(hex($1)) : ' '/eg;
821 =head2 $self->finalize_output
823 <obsolete>, see finalize_body
827 Hash containing enviroment variables including many special variables inserted
828 by WWW server - like SERVER_*, REMOTE_*, HTTP_* ...
830 Before accesing enviroment variables consider whether the same information is
831 not directly available via Catalyst objects $c->request, $c->engine ...
833 BEWARE: If you really need to access some enviroment variable from your Catalyst
834 application you should use $c->engine->env->{VARNAME} instead of $ENV{VARNAME},
835 as in some enviroments the %ENV hash does not contain what you would expect.
839 Catalyst Contributors, see Catalyst.pm
843 This library is free software. You can redistribute it and/or modify it under
844 the same terms as Perl itself.