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';
14 use Catalyst::EngineLoader;
18 use namespace::clean -except => 'meta';
20 # Amount of data to read from input on each pass
21 our $CHUNKSIZE = 64 * 1024;
23 # XXX - this is only here for compat, do not use!
24 has env => ( is => 'rw', writer => '_set_env' );
25 my $WARN_ABOUT_ENV = 0;
27 my ($orig, $self, @args) = @_;
29 warn "env as a writer is deprecated, you probably need to upgrade Catalyst::Engine::PSGI"
30 unless $WARN_ABOUT_ENV++;
31 return $self->_set_env(@args);
38 Catalyst::Engine - The Catalyst Engine
49 =head2 $self->finalize_body($c)
51 Finalize body. Prints the response output.
56 my ( $self, $c ) = @_;
57 my $body = $c->response->body;
58 no warnings 'uninitialized';
59 if ( blessed($body) && $body->can('read') or ref($body) eq 'GLOB' ) {
62 $got = read $body, my ($buffer), $CHUNKSIZE;
63 $got = 0 unless $self->write( $c, $buffer );
69 $self->write( $c, $body );
72 my $res = $c->response;
79 =head2 $self->finalize_cookies($c)
81 Create CGI::Simple::Cookie objects from $c->res->cookies, and set them as
86 sub finalize_cookies {
87 my ( $self, $c ) = @_;
90 my $response = $c->response;
92 foreach my $name (keys %{ $response->cookies }) {
94 my $val = $response->cookies->{$name};
99 : CGI::Simple::Cookie->new(
101 -value => $val->{value},
102 -expires => $val->{expires},
103 -domain => $val->{domain},
104 -path => $val->{path},
105 -secure => $val->{secure} || 0,
106 -httponly => $val->{httponly} || 0,
109 if (!defined $cookie) {
110 $c->log->warn("undef passed in '$name' cookie value - not setting cookie")
115 push @cookies, $cookie->as_string;
118 for my $cookie (@cookies) {
119 $response->headers->push_header( 'Set-Cookie' => $cookie );
123 =head2 $self->finalize_error($c)
125 Output an appropriate error message. Called if there's an error in $c
126 after the dispatch has finished. Will output debug messages if Catalyst
127 is in debug mode, or a `please come back later` message otherwise.
131 sub _dump_error_page_element {
132 my ($self, $i, $element) = @_;
133 my ($name, $val) = @{ $element };
135 # This is fugly, but the metaclass is _HUGE_ and demands waaay too much
136 # scrolling. Suggestions for more pleasant ways to do this welcome.
137 local $val->{'__MOP__'} = "Stringified: "
138 . $val->{'__MOP__'} if ref $val eq 'HASH' && exists $val->{'__MOP__'};
140 my $text = encode_entities( dump( $val ));
141 sprintf <<"EOF", $name, $text;
142 <h2><a href="#" onclick="toggleDump('dump_$i'); return false">%s</a></h2>
144 <pre wrap="">%s</pre>
150 my ( $self, $c ) = @_;
152 $c->res->content_type('text/html; charset=utf-8');
153 my $name = ref($c)->config->{name} || join(' ', split('::', ref $c));
155 # Prevent Catalyst::Plugin::Unicode::Encoding from running.
156 # This is a little nasty, but it's the best way to be clean whether or
157 # not the user has an encoding plugin.
159 if ($c->can('encoding')) {
163 my ( $title, $error, $infos );
167 $error = join '', map {
168 '<p><code class="error">'
169 . encode_entities($_)
172 $error ||= 'No output';
173 $error = qq{<pre wrap="">$error</pre>};
174 $title = $name = "$name on Catalyst $Catalyst::VERSION";
175 $name = "<h1>$name</h1>";
177 # Don't show context in the dump
178 $c->req->_clear_context;
179 $c->res->_clear_context;
181 # Don't show body parser in the dump
182 $c->req->_clear_body;
186 for my $dump ( $c->dump_these ) {
187 push @infos, $self->_dump_error_page_element($i, $dump);
190 $infos = join "\n", @infos;
197 (en) Please come back later
198 (fr) SVP veuillez revenir plus tard
199 (de) Bitte versuchen sie es spaeter nocheinmal
200 (at) Konnten's bitt'schoen spaeter nochmal reinschauen
201 (no) Vennligst prov igjen senere
202 (dk) Venligst prov igen senere
203 (pl) Prosze sprobowac pozniej
204 (pt) Por favor volte mais tarde
205 (ru) Попробуйте еще раз позже
206 (ua) Спробуйте ще раз пізніше
211 $c->res->body( <<"" );
212 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
213 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
214 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
216 <meta http-equiv="Content-Language" content="en" />
217 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
218 <title>$title</title>
219 <script type="text/javascript">
221 function toggleDump (dumpElement) {
222 var e = document.getElementById( dumpElement );
223 if (e.style.display == "none") {
224 e.style.display = "";
227 e.style.display = "none";
232 <style type="text/css">
234 font-family: "Bitstream Vera Sans", "Trebuchet MS", Verdana,
235 Tahoma, Arial, helvetica, sans-serif;
237 background-color: #eee;
241 :link, :link:hover, :visited, :visited:hover {
246 background-color: #ccc;
247 border: 1px solid #aaa;
252 background-color: #cce;
253 border: 1px solid #755;
259 background-color: #eee;
260 border: 1px solid #575;
266 background-color: #cce;
267 border: 1px solid #557;
276 div.name h1, div.error p {
284 text-decoration: underline;
290 /* from http://users.tkk.fi/~tkarvine/linux/doc/pre-wrap/pre-wrap-css3-mozilla-opera-ie.html */
291 /* Browser specific (not valid) styles to make preformatted text wrap */
293 white-space: pre-wrap; /* css-3 */
294 white-space: -moz-pre-wrap; /* Mozilla, since 1999 */
295 white-space: -pre-wrap; /* Opera 4-6 */
296 white-space: -o-pre-wrap; /* Opera 7 */
297 word-wrap: break-word; /* Internet Explorer 5.5+ */
303 <div class="error">$error</div>
304 <div class="infos">$infos</div>
305 <div class="name">$name</div>
310 # Trick IE. Old versions of IE would display their own error page instead
311 # of ours if we'd give it less than 512 bytes.
312 $c->res->{body} .= ( ' ' x 512 );
314 $c->res->{body} = Encode::encode("UTF-8", $c->res->{body});
317 $c->res->status(500);
320 =head2 $self->finalize_headers($c)
322 Abstract method, allows engines to write headers to response
326 sub finalize_headers {
327 my ($self, $ctx) = @_;
329 # This is a less-than-pretty hack to avoid breaking the old
330 # Catalyst::Engine::PSGI. 5.9 Catalyst::Engine sets a response_cb and
331 # expects us to pass headers to it here, whereas Catalyst::Enngine::PSGI
332 # just pulls the headers out of $ctx->response in its run method and never
333 # sets response_cb. So take the lack of a response_cb as a sign that we
334 # don't need to set the headers.
336 return unless ($ctx->response->_has_response_cb);
339 $ctx->response->headers->scan(sub { push @headers, @_ });
341 my $writer = $ctx->response->_response_cb->([ $ctx->response->status, \@headers ]);
342 $ctx->response->_set_writer($writer);
343 $ctx->response->_clear_response_cb;
348 =head2 $self->finalize_uploads($c)
350 Clean up after uploads, deleting temp files.
354 sub finalize_uploads {
355 my ( $self, $c ) = @_;
357 # N.B. This code is theoretically entirely unneeded due to ->cleanup(1)
358 # on the HTTP::Body object.
359 my $request = $c->request;
360 foreach my $key (keys %{ $request->uploads }) {
361 my $upload = $request->uploads->{$key};
362 unlink grep { -e $_ } map { $_->tempname }
363 (ref $upload eq 'ARRAY' ? @{$upload} : ($upload));
368 =head2 $self->prepare_body($c)
370 sets up the L<Catalyst::Request> object body using L<HTTP::Body>
375 my ( $self, $c ) = @_;
377 my $appclass = ref($c) || $c;
378 my $request = $c->request;
379 if ( my $length = $request->_read_length ) {
380 unless ( $request->_body ) {
381 my $type = $request->header('Content-Type');
382 $request->_body(HTTP::Body->new( $type, $length ));
383 $request->_body->cleanup(1); # Make extra sure!
384 $request->_body->tmpdir( $appclass->config->{uploadtmp} )
385 if exists $appclass->config->{uploadtmp};
388 # Check for definedness as you could read '0'
389 while ( defined ( my $buffer = $self->read($c) ) ) {
390 $c->prepare_body_chunk($buffer);
393 # paranoia against wrong Content-Length header
394 my $remaining = $length - $c->request->_read_position;
395 if ( $remaining > 0 ) {
396 Catalyst::Exception->throw(
397 "Wrong Content-Length value: $length" );
401 # Defined but will cause all body code to be skipped
402 $c->request->_body(0);
406 =head2 $self->prepare_body_chunk($c)
408 Add a chunk to the request body.
412 sub prepare_body_chunk {
413 my ( $self, $c, $chunk ) = @_;
415 $c->request->_body->add($chunk);
418 =head2 $self->prepare_body_parameters($c)
420 Sets up parameters from body.
424 sub prepare_body_parameters {
425 my ( $self, $c ) = @_;
427 return unless $c->request->_body;
429 $c->request->body_parameters( $c->request->_body->param );
432 =head2 $self->prepare_connection($c)
434 Abstract method implemented in engines.
438 sub prepare_connection {
439 my ($self, $ctx) = @_;
441 my $request = $ctx->request;
442 my $env = $ctx->request->env;
444 $request->address( $env->{REMOTE_ADDR} );
445 $request->hostname( $env->{REMOTE_HOST} )
446 if exists $env->{REMOTE_HOST};
447 $request->protocol( $env->{SERVER_PROTOCOL} );
448 $request->remote_user( $env->{REMOTE_USER} );
449 $request->method( $env->{REQUEST_METHOD} );
450 $request->secure( $env->{'psgi.url_scheme'} eq 'https' ? 1 : 0 );
455 =head2 $self->prepare_cookies($c)
457 Parse cookies from header. Sets a L<CGI::Simple::Cookie> object.
461 sub prepare_cookies {
462 my ( $self, $c ) = @_;
464 if ( my $header = $c->request->header('Cookie') ) {
465 $c->req->cookies( { CGI::Simple::Cookie->parse($header) } );
469 =head2 $self->prepare_headers($c)
473 sub prepare_headers {
474 my ($self, $ctx) = @_;
476 my $env = $ctx->request->env;
477 my $headers = $ctx->request->headers;
479 for my $header (keys %{ $env }) {
480 next unless $header =~ /^(HTTP|CONTENT|COOKIE)/i;
481 (my $field = $header) =~ s/^HTTPS?_//;
483 $headers->header($field => $env->{$header});
487 =head2 $self->prepare_parameters($c)
489 sets up parameters from query and post parameters.
493 sub prepare_parameters {
494 my ( $self, $c ) = @_;
496 my $request = $c->request;
497 my $parameters = $request->parameters;
498 my $body_parameters = $request->body_parameters;
499 my $query_parameters = $request->query_parameters;
500 # We copy, no references
501 foreach my $name (keys %$query_parameters) {
502 my $param = $query_parameters->{$name};
503 $parameters->{$name} = ref $param eq 'ARRAY' ? [ @$param ] : $param;
506 # Merge query and body parameters
507 foreach my $name (keys %$body_parameters) {
508 my $param = $body_parameters->{$name};
509 my @values = ref $param eq 'ARRAY' ? @$param : ($param);
510 if ( my $existing = $parameters->{$name} ) {
511 unshift(@values, (ref $existing eq 'ARRAY' ? @$existing : $existing));
513 $parameters->{$name} = @values > 1 ? \@values : $values[0];
517 =head2 $self->prepare_path($c)
519 abstract method, implemented by engines.
524 my ($self, $ctx) = @_;
526 my $env = $ctx->request->env;
528 my $scheme = $ctx->request->secure ? 'https' : 'http';
529 my $host = $env->{HTTP_HOST} || $env->{SERVER_NAME};
530 my $port = $env->{SERVER_PORT} || 80;
531 my $base_path = $env->{SCRIPT_NAME} || "/";
533 # set the request URI
535 if (!$ctx->config->{use_request_uri_for_path}) {
536 my $path_info = $env->{PATH_INFO};
537 if ( exists $env->{REDIRECT_URL} ) {
538 $base_path = $env->{REDIRECT_URL};
539 $base_path =~ s/\Q$path_info\E$//;
541 $path = $base_path . $path_info;
543 $path =~ s/([^$URI::uric])/$URI::Escape::escapes{$1}/go;
544 $path =~ s/\?/%3F/g; # STUPID STUPID SPECIAL CASE
547 my $req_uri = $env->{REQUEST_URI};
548 $req_uri =~ s/\?.*$//;
553 # Using URI directly is way too slow, so we construct the URLs manually
554 my $uri_class = "URI::$scheme";
556 # HTTP_HOST will include the port even if it's 80/443
557 $host =~ s/:(?:80|443)$//;
559 if ($port !~ /^(?:80|443)$/ && $host !~ /:/) {
563 my $query = $env->{QUERY_STRING} ? '?' . $env->{QUERY_STRING} : '';
564 my $uri = $scheme . '://' . $host . '/' . $path . $query;
566 $ctx->request->uri( (bless \$uri, $uri_class)->canonical );
569 # base must end in a slash
570 $base_path .= '/' unless $base_path =~ m{/$};
572 my $base_uri = $scheme . '://' . $host . $base_path;
574 $ctx->request->base( bless \$base_uri, $uri_class );
579 =head2 $self->prepare_request($c)
581 =head2 $self->prepare_query_parameters($c)
583 process the query string and extract query parameters.
587 sub prepare_query_parameters {
590 my $env = $c->request->env;
591 my $query_string = exists $env->{QUERY_STRING}
592 ? $env->{QUERY_STRING}
595 # Check for keywords (no = signs)
596 # (yes, index() is faster than a regex :))
597 if ( index( $query_string, '=' ) < 0 ) {
598 $c->request->query_keywords( $self->unescape_uri($query_string) );
604 # replace semi-colons
605 $query_string =~ s/;/&/g;
607 my @params = grep { length $_ } split /&/, $query_string;
609 for my $item ( @params ) {
612 = map { $self->unescape_uri($_) }
613 split( /=/, $item, 2 );
615 $param = $self->unescape_uri($item) unless defined $param;
617 if ( exists $query{$param} ) {
618 if ( ref $query{$param} ) {
619 push @{ $query{$param} }, $value;
622 $query{$param} = [ $query{$param}, $value ];
626 $query{$param} = $value;
630 $c->request->query_parameters( \%query );
633 =head2 $self->prepare_read($c)
635 prepare to read from the engine.
640 my ( $self, $c ) = @_;
642 # Initialize the amount of data we think we need to read
643 $c->request->_read_length;
646 =head2 $self->prepare_request(@arguments)
648 Populate the context object from the request object.
652 sub prepare_request {
653 my ($self, $ctx, %args) = @_;
654 $ctx->request->_set_env($args{env});
655 $self->_set_env($args{env}); # Nasty back compat!
656 $ctx->response->_set_response_cb($args{response_cb});
659 =head2 $self->prepare_uploads($c)
663 sub prepare_uploads {
664 my ( $self, $c ) = @_;
666 my $request = $c->request;
667 return unless $request->_body;
669 my $uploads = $request->_body->upload;
670 my $parameters = $request->parameters;
671 foreach my $name (keys %$uploads) {
672 my $files = $uploads->{$name};
674 for my $upload (ref $files eq 'ARRAY' ? @$files : ($files)) {
675 my $headers = HTTP::Headers->new( %{ $upload->{headers} } );
676 my $u = Catalyst::Request::Upload->new
678 size => $upload->{size},
679 type => scalar $headers->content_type,
681 tempname => $upload->{tempname},
682 filename => $upload->{filename},
686 $request->uploads->{$name} = @uploads > 1 ? \@uploads : $uploads[0];
688 # support access to the filename as a normal param
689 my @filenames = map { $_->{filename} } @uploads;
690 # append, if there's already params with this name
691 if (exists $parameters->{$name}) {
692 if (ref $parameters->{$name} eq 'ARRAY') {
693 push @{ $parameters->{$name} }, @filenames;
696 $parameters->{$name} = [ $parameters->{$name}, @filenames ];
700 $parameters->{$name} = @filenames > 1 ? \@filenames : $filenames[0];
705 =head2 $self->read($c, [$maxlength])
707 Reads from the input stream by calling C<< $self->read_chunk >>.
709 Maintains the read_length and read_position counters as data is read.
714 my ( $self, $c, $maxlength ) = @_;
716 my $request = $c->request;
717 my $remaining = $request->_read_length - $request->_read_position;
718 $maxlength ||= $CHUNKSIZE;
720 # Are we done reading?
721 if ( $remaining <= 0 ) {
725 my $readlen = ( $remaining > $maxlength ) ? $maxlength : $remaining;
726 my $rc = $self->read_chunk( $c, my $buffer, $readlen );
728 if (0 == $rc) { # Nothing more to read even though Content-Length
729 # said there should be.
732 my $request = $c->request;
733 $request->_read_position( $request->_read_position + $rc );
737 Catalyst::Exception->throw(
738 message => "Unknown error reading input: $!" );
742 =head2 $self->read_chunk($c, $buffer, $length)
744 Each engine implements read_chunk as its preferred way of reading a chunk
745 of data. Returns the number of bytes read. A return of 0 indicates that
746 there is no more data to be read.
751 my ($self, $ctx) = (shift, shift);
752 return $ctx->request->env->{'psgi.input'}->read(@_);
755 =head2 $self->read_length
757 The length of input data to be read. This is obtained from the Content-Length
760 =head2 $self->read_position
762 The amount of input data that has already been read.
764 =head2 $self->run($app, $server)
766 Start the engine. Builds a PSGI application and calls the
767 run method on the server passed in, which then causes the
768 engine to loop, handling requests..
773 my ($self, $app, $psgi, @args) = @_;
774 # @args left here rather than just a $options, $server for back compat with the
775 # old style scripts which send a few args, then a hashref
777 # They should never actually be used in the normal case as the Plack engine is
778 # passed in got all the 'standard' args via the loader in the script already.
780 # FIXME - we should stash the options in an attribute so that custom args
781 # like Gitalist's --git_dir are possible to get from the app without stupid tricks.
782 my $server = pop @args if (scalar @args && blessed $args[-1]);
783 my $options = pop @args if (scalar @args && ref($args[-1]) eq 'HASH');
784 # Back compat hack for applications with old (non Catalyst::Script) scripts to work in FCGI.
785 if (scalar @args && !ref($args[0])) {
786 if (my $listen = shift @args) {
787 $options->{listen} ||= [$listen];
791 $server = Catalyst::EngineLoader->new(application_name => ref($self))->auto(%$options);
792 # We're not being called from a script, so auto detect what backend to
793 # run on. This should never happen, as mod_perl never calls ->run,
794 # instead the $app->handle method is called per request.
795 $app->log->warn("Not supplied a Plack engine, falling back to engine auto-loader (are your scripts ancient?)")
797 $app->run_options($options);
798 $server->run($psgi, $options);
801 =head2 build_psgi_app ($app, @args)
803 Builds and returns a PSGI application closure, wrapping it in the reverse proxy
804 middleware if the using_frontend_proxy config setting is set.
809 my ($self, $app, @args) = @_;
816 $app->handle_request(env => $env, response_cb => $respond);
821 =head2 $self->write($c, $buffer)
823 Writes the buffer to the client.
828 my ( $self, $c, $buffer ) = @_;
830 my $response = $c->response;
832 $buffer = q[] unless defined $buffer;
834 my $len = length($buffer);
835 $c->res->_writer->write($buffer);
840 =head2 $self->unescape_uri($uri)
842 Unescapes a given URI using the most efficient method available. Engines such
843 as Apache may implement this using Apache's C-based modules, for example.
848 my ( $self, $str ) = @_;
850 $str =~ s/(?:%([0-9A-Fa-f]{2})|\+)/defined $1 ? chr(hex($1)) : ' '/eg;
855 =head2 $self->finalize_output
857 <obsolete>, see finalize_body
861 Hash containing environment variables including many special variables inserted
862 by WWW server - like SERVER_*, REMOTE_*, HTTP_* ...
864 Before accessing environment variables consider whether the same information is
865 not directly available via Catalyst objects $c->request, $c->engine ...
867 BEWARE: If you really need to access some environment variable from your Catalyst
868 application you should use $c->engine->env->{VARNAME} instead of $ENV{VARNAME},
869 as in some environments the %ENV hash does not contain what you would expect.
873 Catalyst Contributors, see Catalyst.pm
877 This library is free software. You can redistribute it and/or modify it under
878 the same terms as Perl itself.