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';
12 use Catalyst::EngineLoader;
13 use Encode 2.21 'decode_utf8';
14 use Plack::Request::Upload;
16 use namespace::clean -except => 'meta';
18 # Amount of data to read from input on each pass
19 our $CHUNKSIZE = 64 * 1024;
21 # XXX - this is only here for compat, do not use!
22 has env => ( is => 'rw', writer => '_set_env' , weak_ref=>1);
23 my $WARN_ABOUT_ENV = 0;
25 my ($orig, $self, @args) = @_;
27 warn "env as a writer is deprecated, you probably need to upgrade Catalyst::Engine::PSGI"
28 unless $WARN_ABOUT_ENV++;
29 return $self->_set_env(@args);
34 # XXX - Only here for Engine::PSGI compat
35 sub prepare_connection {
36 my ($self, $ctx) = @_;
37 $ctx->request->prepare_connection;
42 Catalyst::Engine - The Catalyst Engine
53 =head2 $self->finalize_body($c)
55 Finalize body. Prints the response output as blocking stream if it looks like
56 a filehandle, otherwise write it out all in one go. If there is no body in
57 the response, we assume you are handling it 'manually', such as for nonblocking
58 style or asynchronous streaming responses. You do this by calling L</write>
59 several times (which sends HTTP headers if needed) or you close over
60 C<< $response->write_fh >>.
62 See L<Catalyst::Response/write> and L<Catalyst::Response/write_fh> for more.
67 my ( $self, $c ) = @_;
68 my $res = $c->response; # We use this all over
70 ## If we've asked for the write 'filehandle' that means the application is
71 ## doing something custom and is expected to close the response
72 return if $res->_has_write_fh;
74 my $body = $res->body; # save some typing
75 if($res->_has_response_cb) {
76 ## we have not called the response callback yet, so we are safe to send
77 ## the whole body to PSGI
80 $res->headers->scan(sub { push @headers, @_ });
82 # We need to figure out what kind of body we have and normalize it to something
85 # Handle objects first
87 if($body->can('getline')) {
88 # Body is an IO handle that meets the PSGI spec. Nothing to normalize
89 } elsif($body->can('read')) {
91 # In the past, Catalyst only looked for ->read not ->getline. It is very possible
92 # that one might have an object that respected read but did not have getline.
93 # As a result, we need to handle this case for backcompat.
95 # We will just do the old loop for now. In a future version of Catalyst this support
96 # will be removed and one will have to rewrite their custom object or use
97 # Plack::Middleware::AdaptFilehandleRead. In anycase support for this is officially
98 # deprecated and described as such as of 5.90060
102 $got = read $body, my ($buffer), $CHUNKSIZE;
103 $got = 0 unless $self->write($c, $buffer );
109 # Looks like for backcompat reasons we need to be able to deal
110 # with stringyfiable objects.
114 if( (ref($body) eq 'GLOB') or (ref($body) eq 'ARRAY')) {
115 # Again, PSGI can just accept this, no transform needed. We don't officially
116 # document the body as arrayref at this time (and there's not specific test
117 # cases. we support it because it simplifies some plack compatibility logic
118 # and we might make it official at some point.
120 $c->log->error("${\ref($body)} is not a valid value for Response->body");
124 # Body is defined and not an object or reference. We assume a simple value
125 # and wrap it in an array for PSGI
133 $res->_response_cb->([ $res->status, \@headers, $body]);
134 $res->_clear_response_cb;
137 ## Now, if there's no response callback anymore, that means someone has
138 ## called ->write in order to stream 'some stuff along the way'. I think
139 ## for backcompat we still need to handle a ->body. I guess I could see
140 ## someone calling ->write to presend some stuff, and then doing the rest
141 ## via ->body, like in a template.
143 ## We'll just use the old, existing code for this (or most of it)
145 if(my $body = $res->body) {
147 if ( blessed($body) && $body->can('read') or ref($body) eq 'GLOB' ) {
149 ## In this case we have no choice and will fall back on the old
150 ## manual streaming stuff. Not optimal. This is deprecated as of 5.900560+
154 $got = read $body, my ($buffer), $CHUNKSIZE;
155 $got = 0 unless $self->write($c, $buffer );
162 # Case where body was set afgter calling ->write. We'd prefer not to
163 # support this, but I can see some use cases with the way most of the
166 $self->write($c, $body );
170 $res->_writer->close;
177 =head2 $self->finalize_cookies($c)
179 Create CGI::Simple::Cookie objects from $c->res->cookies, and set them as
184 sub finalize_cookies {
185 my ( $self, $c ) = @_;
188 my $response = $c->response;
190 foreach my $name (keys %{ $response->cookies }) {
192 my $val = $response->cookies->{$name};
197 : CGI::Simple::Cookie->new(
199 -value => $val->{value},
200 -expires => $val->{expires},
201 -domain => $val->{domain},
202 -path => $val->{path},
203 -secure => $val->{secure} || 0,
204 -httponly => $val->{httponly} || 0,
207 if (!defined $cookie) {
208 $c->log->warn("undef passed in '$name' cookie value - not setting cookie")
213 push @cookies, $cookie->as_string;
216 for my $cookie (@cookies) {
217 $response->headers->push_header( 'Set-Cookie' => $cookie );
221 =head2 $self->finalize_error($c)
223 Output an appropriate error message. Called if there's an error in $c
224 after the dispatch has finished. Will output debug messages if Catalyst
225 is in debug mode, or a `please come back later` message otherwise.
229 sub _dump_error_page_element {
230 my ($self, $i, $element) = @_;
231 my ($name, $val) = @{ $element };
233 # This is fugly, but the metaclass is _HUGE_ and demands waaay too much
234 # scrolling. Suggestions for more pleasant ways to do this welcome.
235 local $val->{'__MOP__'} = "Stringified: "
236 . $val->{'__MOP__'} if ref $val eq 'HASH' && exists $val->{'__MOP__'};
238 my $text = encode_entities( dump( $val ));
239 sprintf <<"EOF", $name, $text;
240 <h2><a href="#" onclick="toggleDump('dump_$i'); return false">%s</a></h2>
242 <pre wrap="">%s</pre>
248 my ( $self, $c ) = @_;
250 $c->res->content_type('text/html; charset=utf-8');
251 my $name = ref($c)->config->{name} || join(' ', split('::', ref $c));
253 # Prevent Catalyst::Plugin::Unicode::Encoding from running.
254 # This is a little nasty, but it's the best way to be clean whether or
255 # not the user has an encoding plugin.
257 if ($c->can('encoding')) {
261 my ( $title, $error, $infos );
265 $error = join '', map {
266 '<p><code class="error">'
267 . encode_entities($_)
270 $error ||= 'No output';
271 $error = qq{<pre wrap="">$error</pre>};
272 $title = $name = "$name on Catalyst $Catalyst::VERSION";
273 $name = "<h1>$name</h1>";
275 # Don't show context in the dump
276 $c->res->_clear_context;
278 # Don't show body parser in the dump
279 $c->req->_clear_body;
283 for my $dump ( $c->dump_these ) {
284 push @infos, $self->_dump_error_page_element($i, $dump);
287 $infos = join "\n", @infos;
294 (en) Please come back later
295 (fr) SVP veuillez revenir plus tard
296 (de) Bitte versuchen sie es spaeter nocheinmal
297 (at) Konnten's bitt'schoen spaeter nochmal reinschauen
298 (no) Vennligst prov igjen senere
299 (dk) Venligst prov igen senere
300 (pl) Prosze sprobowac pozniej
301 (pt) Por favor volte mais tarde
302 (ru) Попробуйте еще раз позже
303 (ua) Спробуйте ще раз пізніше
304 (it) Per favore riprova più tardi
309 $c->res->body( <<"" );
310 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
311 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
312 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
314 <meta http-equiv="Content-Language" content="en" />
315 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
316 <title>$title</title>
317 <script type="text/javascript">
319 function toggleDump (dumpElement) {
320 var e = document.getElementById( dumpElement );
321 if (e.style.display == "none") {
322 e.style.display = "";
325 e.style.display = "none";
330 <style type="text/css">
332 font-family: "Bitstream Vera Sans", "Trebuchet MS", Verdana,
333 Tahoma, Arial, helvetica, sans-serif;
335 background-color: #eee;
339 :link, :link:hover, :visited, :visited:hover {
344 background-color: #ccc;
345 border: 1px solid #aaa;
350 background-color: #cce;
351 border: 1px solid #755;
357 background-color: #eee;
358 border: 1px solid #575;
364 background-color: #cce;
365 border: 1px solid #557;
374 div.name h1, div.error p {
382 text-decoration: underline;
388 /* from http://users.tkk.fi/~tkarvine/linux/doc/pre-wrap/pre-wrap-css3-mozilla-opera-ie.html */
389 /* Browser specific (not valid) styles to make preformatted text wrap */
391 white-space: pre-wrap; /* css-3 */
392 white-space: -moz-pre-wrap; /* Mozilla, since 1999 */
393 white-space: -pre-wrap; /* Opera 4-6 */
394 white-space: -o-pre-wrap; /* Opera 7 */
395 word-wrap: break-word; /* Internet Explorer 5.5+ */
401 <div class="error">$error</div>
402 <div class="infos">$infos</div>
403 <div class="name">$name</div>
408 # Trick IE. Old versions of IE would display their own error page instead
409 # of ours if we'd give it less than 512 bytes.
410 $c->res->{body} .= ( ' ' x 512 );
412 $c->res->{body} = Encode::encode("UTF-8", $c->res->{body});
415 $c->res->status(500);
418 =head2 $self->finalize_headers($c)
420 Allows engines to write headers to response
424 sub finalize_headers {
425 my ($self, $ctx) = @_;
427 $ctx->finalize_headers unless $ctx->response->finalized_headers;
431 =head2 $self->finalize_uploads($c)
433 Clean up after uploads, deleting temp files.
437 sub finalize_uploads {
438 my ( $self, $c ) = @_;
440 # N.B. This code is theoretically entirely unneeded due to ->cleanup(1)
441 # on the HTTP::Body object.
442 my $request = $c->request;
443 foreach my $key (keys %{ $request->uploads }) {
444 my $upload = $request->uploads->{$key};
445 unlink grep { -e $_ } map { $_->tempname }
446 (ref $upload eq 'ARRAY' ? @{$upload} : ($upload));
451 =head2 $self->prepare_body($c)
453 sets up the L<Catalyst::Request> object body using L<HTTP::Body>
458 my ( $self, $c ) = @_;
460 $c->request->prepare_body;
463 =head2 $self->prepare_body_chunk($c)
465 Add a chunk to the request body.
469 # XXX - Can this be deleted?
470 sub prepare_body_chunk {
471 my ( $self, $c, $chunk ) = @_;
473 $c->request->prepare_body_chunk($chunk);
476 =head2 $self->prepare_body_parameters($c)
478 Sets up parameters from body.
482 sub prepare_body_parameters {
483 my ( $self, $c ) = @_;
485 $c->request->prepare_body_parameters;
488 =head2 $self->prepare_parameters($c)
490 Sets up parameters from query and post parameters.
491 If parameters have already been set up will clear
492 existing parameters and set up again.
496 sub prepare_parameters {
497 my ( $self, $c ) = @_;
499 $c->request->_clear_parameters;
500 return $c->request->parameters;
503 =head2 $self->prepare_path($c)
505 abstract method, implemented by engines.
510 my ($self, $ctx) = @_;
512 my $env = $ctx->request->env;
514 my $scheme = $ctx->request->secure ? 'https' : 'http';
515 my $host = $env->{HTTP_HOST} || $env->{SERVER_NAME};
516 my $port = $env->{SERVER_PORT} || 80;
517 my $base_path = $env->{SCRIPT_NAME} || "/";
519 # set the request URI
521 if (!$ctx->config->{use_request_uri_for_path}) {
522 my $path_info = $env->{PATH_INFO};
523 if ( exists $env->{REDIRECT_URL} ) {
524 $base_path = $env->{REDIRECT_URL};
525 $base_path =~ s/\Q$path_info\E$//;
527 $path = $base_path . $path_info;
529 $path =~ s/([^$URI::uric])/$URI::Escape::escapes{$1}/go;
530 $path =~ s/\?/%3F/g; # STUPID STUPID SPECIAL CASE
533 my $req_uri = $env->{REQUEST_URI};
534 $req_uri =~ s/\?.*$//;
539 # Using URI directly is way too slow, so we construct the URLs manually
540 my $uri_class = "URI::$scheme";
542 # HTTP_HOST will include the port even if it's 80/443
543 $host =~ s/:(?:80|443)$//;
545 if ($port !~ /^(?:80|443)$/ && $host !~ /:/) {
549 my $query = $env->{QUERY_STRING} ? '?' . $env->{QUERY_STRING} : '';
550 my $uri = $scheme . '://' . $host . '/' . $path . $query;
552 $ctx->request->uri( (bless \$uri, $uri_class)->canonical );
555 # base must end in a slash
556 $base_path .= '/' unless $base_path =~ m{/$};
558 my $base_uri = $scheme . '://' . $host . $base_path;
560 $ctx->request->base( bless \$base_uri, $uri_class );
565 =head2 $self->prepare_request($c)
567 =head2 $self->prepare_query_parameters($c)
569 process the query string and extract query parameters.
573 sub prepare_query_parameters {
575 my $env = $c->request->env;
577 if(my $query_obj = $env->{'plack.request.query'}) {
578 $c->request->query_parameters(
579 $c->request->_use_hash_multivalue ?
581 $query_obj->as_hashref_mixed);
585 my $query_string = exists $env->{QUERY_STRING}
586 ? $env->{QUERY_STRING}
589 # Check for keywords (no = signs)
590 # (yes, index() is faster than a regex :))
591 if ( index( $query_string, '=' ) < 0 ) {
592 my $keywords = $self->unescape_uri($query_string);
593 $keywords = decode_utf8 $keywords;
594 $c->request->query_keywords($keywords);
600 # replace semi-colons
601 $query_string =~ s/;/&/g;
603 my @params = grep { length $_ } split /&/, $query_string;
605 for my $item ( @params ) {
608 = map { decode_utf8($self->unescape_uri($_)) }
609 split( /=/, $item, 2 );
611 unless(defined $param) {
612 $param = $self->unescape_uri($item);
613 $param = decode_utf8 $param;
616 if ( exists $query{$param} ) {
617 if ( ref $query{$param} ) {
618 push @{ $query{$param} }, $value;
621 $query{$param} = [ $query{$param}, $value ];
625 $query{$param} = $value;
629 $c->request->query_parameters(
630 $c->request->_use_hash_multivalue ?
631 Hash::MultiValue->from_mixed(\%query) :
635 =head2 $self->prepare_read($c)
637 Prepare to read by initializing the Content-Length from headers.
642 my ( $self, $c ) = @_;
644 # Initialize the amount of data we think we need to read
645 $c->request->_read_length;
648 =head2 $self->prepare_request(@arguments)
650 Populate the context object from the request object.
654 sub prepare_request {
655 my ($self, $ctx, %args) = @_;
656 $ctx->log->psgienv($args{env}) if $ctx->log->can('psgienv');
657 $ctx->request->_set_env($args{env});
658 $self->_set_env($args{env}); # Nasty back compat!
659 $ctx->response->_set_response_cb($args{response_cb});
662 =head2 $self->prepare_uploads($c)
666 sub prepare_uploads {
667 my ( $self, $c ) = @_;
669 my $request = $c->request;
670 return unless $request->_body;
672 my $enc = $c->encoding;
673 my $uploads = $request->_body->upload;
674 my $parameters = $request->parameters;
675 foreach my $name (keys %$uploads) {
676 $name = $c->_handle_unicode_decoding($name) if $enc;
677 my $files = $uploads->{$name};
679 for my $upload (ref $files eq 'ARRAY' ? @$files : ($files)) {
680 my $headers = HTTP::Headers->new( %{ $upload->{headers} } );
681 my $filename = $upload->{filename};
682 $filename = $c->_handle_unicode_decoding($filename) if $enc;
684 my $u = Catalyst::Request::Upload->new
686 size => $upload->{size},
687 type => scalar $headers->content_type,
689 tempname => $upload->{tempname},
690 filename => $filename,
694 $request->uploads->{$name} = @uploads > 1 ? \@uploads : $uploads[0];
696 # support access to the filename as a normal param
697 my @filenames = map { $_->{filename} } @uploads;
698 # append, if there's already params with this name
699 if (exists $parameters->{$name}) {
700 if (ref $parameters->{$name} eq 'ARRAY') {
701 push @{ $parameters->{$name} }, @filenames;
704 $parameters->{$name} = [ $parameters->{$name}, @filenames ];
708 $parameters->{$name} = @filenames > 1 ? \@filenames : $filenames[0];
713 =head2 $self->write($c, $buffer)
715 Writes the buffer to the client.
720 my ( $self, $c, $buffer ) = @_;
722 $c->response->write($buffer);
725 =head2 $self->read($c, [$maxlength])
727 Reads from the input stream by calling C<< $self->read_chunk >>.
729 Maintains the read_length and read_position counters as data is read.
734 my ( $self, $c, $maxlength ) = @_;
736 $c->request->read($maxlength);
739 =head2 $self->read_chunk($c, \$buffer, $length)
741 Each engine implements read_chunk as its preferred way of reading a chunk
742 of data. Returns the number of bytes read. A return of 0 indicates that
743 there is no more data to be read.
748 my ($self, $ctx) = (shift, shift);
749 return $ctx->request->read_chunk(@_);
752 =head2 $self->run($app, $server)
754 Start the engine. Builds a PSGI application and calls the
755 run method on the server passed in, which then causes the
756 engine to loop, handling requests..
761 my ($self, $app, $psgi, @args) = @_;
762 # @args left here rather than just a $options, $server for back compat with the
763 # old style scripts which send a few args, then a hashref
765 # They should never actually be used in the normal case as the Plack engine is
766 # passed in got all the 'standard' args via the loader in the script already.
768 # FIXME - we should stash the options in an attribute so that custom args
769 # like Gitalist's --git_dir are possible to get from the app without stupid tricks.
770 my $server = pop @args if (scalar @args && blessed $args[-1]);
771 my $options = pop @args if (scalar @args && ref($args[-1]) eq 'HASH');
772 # Back compat hack for applications with old (non Catalyst::Script) scripts to work in FCGI.
773 if (scalar @args && !ref($args[0])) {
774 if (my $listen = shift @args) {
775 $options->{listen} ||= [$listen];
779 $server = Catalyst::EngineLoader->new(application_name => ref($self))->auto(%$options);
780 # We're not being called from a script, so auto detect what backend to
781 # run on. This should never happen, as mod_perl never calls ->run,
782 # instead the $app->handle method is called per request.
783 $app->log->warn("Not supplied a Plack engine, falling back to engine auto-loader (are your scripts ancient?)")
785 $app->run_options($options);
786 $server->run($psgi, $options);
789 =head2 build_psgi_app ($app, @args)
791 Builds and returns a PSGI application closure. (Raw, not wrapped in middleware)
796 my ($self, $app, @args) = @_;
803 confess("Did not get a response callback for writer, cannot continue") unless $respond;
804 $app->handle_request(env => $env, response_cb => $respond);
809 =head2 $self->unescape_uri($uri)
811 Unescapes a given URI using the most efficient method available. Engines such
812 as Apache may implement this using Apache's C-based modules, for example.
817 my ( $self, $str ) = @_;
819 $str =~ s/(?:%([0-9A-Fa-f]{2})|\+)/defined $1 ? chr(hex($1)) : ' '/eg;
824 =head2 $self->finalize_output
826 <obsolete>, see finalize_body
830 Hash containing environment variables including many special variables inserted
831 by WWW server - like SERVER_*, REMOTE_*, HTTP_* ...
833 Before accessing environment variables consider whether the same information is
834 not directly available via Catalyst objects $c->request, $c->engine ...
836 BEWARE: If you really need to access some environment variable from your Catalyst
837 application you should use $c->engine->env->{VARNAME} instead of $ENV{VARNAME},
838 as in some environments the %ENV hash does not contain what you would expect.
842 Catalyst Contributors, see Catalyst.pm
846 This library is free software. You can redistribute it and/or modify it under
847 the same terms as Perl itself.
851 __PACKAGE__->meta->make_immutable;