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', 'encode', 'decode';
14 use Plack::Request::Upload;
16 use namespace::clean -except => 'meta';
19 # Amount of data to read from input on each pass
20 our $CHUNKSIZE = 64 * 1024;
22 # XXX - this is only here for compat, do not use!
23 has env => ( is => 'rw', writer => '_set_env' , weak_ref=>1);
24 my $WARN_ABOUT_ENV = 0;
26 my ($orig, $self, @args) = @_;
28 warn "env as a writer is deprecated, you probably need to upgrade Catalyst::Engine::PSGI"
29 unless $WARN_ABOUT_ENV++;
30 return $self->_set_env(@args);
35 # XXX - Only here for Engine::PSGI compat
36 sub prepare_connection {
37 my ($self, $ctx) = @_;
38 $ctx->request->prepare_connection;
43 Catalyst::Engine - The Catalyst Engine
54 =head2 $self->finalize_body($c)
56 Finalize body. Prints the response output as blocking stream if it looks like
57 a filehandle, otherwise write it out all in one go. If there is no body in
58 the response, we assume you are handling it 'manually', such as for nonblocking
59 style or asynchronous streaming responses. You do this by calling L</write>
60 several times (which sends HTTP headers if needed) or you close over
61 C<< $response->write_fh >>.
63 See L<Catalyst::Response/write> and L<Catalyst::Response/write_fh> for more.
68 my ( $self, $c ) = @_;
69 my $res = $c->response; # We use this all over
71 ## If we've asked for the write 'filehandle' that means the application is
72 ## doing something custom and is expected to close the response
73 return if $res->_has_write_fh;
75 my $body = $res->body; # save some typing
76 if($res->_has_response_cb) {
77 ## we have not called the response callback yet, so we are safe to send
78 ## the whole body to PSGI
81 $res->headers->scan(sub { push @headers, @_ });
83 # We need to figure out what kind of body we have and normalize it to something
86 # Handle objects first
88 if($body->can('getline')) {
89 # Body is an IO handle that meets the PSGI spec. Nothing to normalize
90 } elsif($body->can('read')) {
92 # In the past, Catalyst only looked for ->read not ->getline. It is very possible
93 # that one might have an object that respected read but did not have getline.
94 # As a result, we need to handle this case for backcompat.
96 # We will just do the old loop for now. In a future version of Catalyst this support
97 # will be removed and one will have to rewrite their custom object or use
98 # Plack::Middleware::AdaptFilehandleRead. In anycase support for this is officially
99 # deprecated and described as such as of 5.90060
103 $got = read $body, my ($buffer), $CHUNKSIZE;
104 $got = 0 unless $self->write($c, $buffer );
110 # Looks like for backcompat reasons we need to be able to deal
111 # with stringyfiable objects.
115 if( (ref($body) eq 'GLOB') or (ref($body) eq 'ARRAY')) {
116 # Again, PSGI can just accept this, no transform needed. We don't officially
117 # document the body as arrayref at this time (and there's not specific test
118 # cases. we support it because it simplifies some plack compatibility logic
119 # and we might make it official at some point.
121 $c->log->error("${\ref($body)} is not a valid value for Response->body");
125 # Body is defined and not an object or reference. We assume a simple value
126 # 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 after calling ->write. We'd prefer not to
163 # support this, but I can see some use cases with the way most of the
164 # views work. Since body has already been encoded, we need to do
165 # an 'unencoded_write' here.
166 $self->unencoded_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,
205 -samesite => $val->{samesite},
208 if (!defined $cookie) {
209 $c->log->warn("undef passed in '$name' cookie value - not setting cookie")
214 push @cookies, $cookie->as_string;
217 for my $cookie (@cookies) {
218 $response->headers->push_header( 'Set-Cookie' => $cookie );
222 =head2 $self->finalize_error($c)
224 Output an appropriate error message. Called if there's an error in $c
225 after the dispatch has finished. Will output debug messages if Catalyst
226 is in debug mode, or a `please come back later` message otherwise.
230 sub _dump_error_page_element {
231 my ($self, $i, $element) = @_;
232 my ($name, $val) = @{ $element };
234 # This is fugly, but the metaclass is _HUGE_ and demands waaay too much
235 # scrolling. Suggestions for more pleasant ways to do this welcome.
236 local $val->{'__MOP__'} = "Stringified: "
237 . $val->{'__MOP__'} if ref $val eq 'HASH' && exists $val->{'__MOP__'};
239 my $text = encode_entities( dump( $val ));
240 sprintf <<"EOF", $name, $text;
241 <h2><a href="#" onclick="toggleDump('dump_$i'); return false">%s</a></h2>
243 <pre wrap="">%s</pre>
249 my ( $self, $c ) = @_;
251 $c->res->content_type('text/html; charset=utf-8');
252 my $name = ref($c)->config->{name} || join(' ', split('::', ref $c));
254 # Prevent Catalyst::Plugin::Unicode::Encoding from running.
255 # This is a little nasty, but it's the best way to be clean whether or
256 # not the user has an encoding plugin.
258 if ($c->can('encoding')) {
262 my ( $title, $error, $infos );
266 $error = join '', map {
267 '<p><code class="error">'
268 . encode_entities($_)
271 $error ||= 'No output';
272 $error = qq{<pre wrap="">$error</pre>};
273 $title = $name = "$name on Catalyst $Catalyst::VERSION";
274 $name = "<h1>$name</h1>";
276 # Don't show context in the dump
277 $c->res->_clear_context;
279 # Don't show body parser in the dump
280 $c->req->_clear_body;
284 for my $dump ( $c->dump_these ) {
285 push @infos, $self->_dump_error_page_element($i, $dump);
288 $infos = join "\n", @infos;
295 (en) Please come back later
296 (fr) SVP veuillez revenir plus tard
297 (de) Bitte versuchen sie es spaeter nocheinmal
298 (at) Konnten's bitt'schoen spaeter nochmal reinschauen
299 (no) Vennligst prov igjen senere
300 (dk) Venligst prov igen senere
301 (pl) Prosze sprobowac pozniej
302 (pt) Por favor volte mais tarde
303 (ru) Попробуйте еще раз позже
304 (ua) Спробуйте ще раз пізніше
305 (it) Per favore riprova più tardi
310 $c->res->body( <<"" );
311 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
312 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
313 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
315 <meta http-equiv="Content-Language" content="en" />
316 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
317 <title>$title</title>
318 <script type="text/javascript">
320 function toggleDump (dumpElement) {
321 var e = document.getElementById( dumpElement );
322 if (e.style.display == "none") {
323 e.style.display = "";
326 e.style.display = "none";
331 <style type="text/css">
333 font-family: "Bitstream Vera Sans", "Trebuchet MS", Verdana,
334 Tahoma, Arial, helvetica, sans-serif;
336 background-color: #eee;
340 :link, :link:hover, :visited, :visited:hover {
345 background-color: #ccc;
346 border: 1px solid #aaa;
351 background-color: #cce;
352 border: 1px solid #755;
358 background-color: #eee;
359 border: 1px solid #575;
365 background-color: #cce;
366 border: 1px solid #557;
375 div.name h1, div.error p {
383 text-decoration: underline;
389 /* from http://users.tkk.fi/~tkarvine/linux/doc/pre-wrap/pre-wrap-css3-mozilla-opera-ie.html */
390 /* Browser specific (not valid) styles to make preformatted text wrap */
392 white-space: pre-wrap; /* css-3 */
393 white-space: -moz-pre-wrap; /* Mozilla, since 1999 */
394 white-space: -pre-wrap; /* Opera 4-6 */
395 white-space: -o-pre-wrap; /* Opera 7 */
396 word-wrap: break-word; /* Internet Explorer 5.5+ */
402 <div class="error">$error</div>
403 <div class="infos">$infos</div>
404 <div class="name">$name</div>
409 # Trick IE. Old versions of IE would display their own error page instead
410 # of ours if we'd give it less than 512 bytes.
411 $c->res->{body} .= ( ' ' x 512 );
413 $c->res->{body} = Encode::encode("UTF-8", $c->res->{body});
416 $c->res->status(500);
419 =head2 $self->finalize_headers($c)
421 Allows engines to write headers to response
425 sub finalize_headers {
426 my ($self, $ctx) = @_;
428 $ctx->finalize_headers unless $ctx->response->finalized_headers;
432 =head2 $self->finalize_uploads($c)
434 Clean up after uploads, deleting temp files.
438 sub finalize_uploads {
439 my ( $self, $c ) = @_;
441 # N.B. This code is theoretically entirely unneeded due to ->cleanup(1)
442 # on the HTTP::Body object.
443 my $request = $c->request;
444 foreach my $key (keys %{ $request->uploads }) {
445 my $upload = $request->uploads->{$key};
446 unlink grep { -e $_ } map { $_->tempname }
447 (ref $upload eq 'ARRAY' ? @{$upload} : ($upload));
452 =head2 $self->prepare_body($c)
454 sets up the L<Catalyst::Request> object body using L<HTTP::Body>
459 my ( $self, $c ) = @_;
461 $c->request->prepare_body;
464 =head2 $self->prepare_body_chunk($c)
466 Add a chunk to the request body.
470 # XXX - Can this be deleted?
471 sub prepare_body_chunk {
472 my ( $self, $c, $chunk ) = @_;
474 $c->request->prepare_body_chunk($chunk);
477 =head2 $self->prepare_body_parameters($c)
479 Sets up parameters from body.
483 sub prepare_body_parameters {
484 my ( $self, $c ) = @_;
486 $c->request->prepare_body_parameters;
489 =head2 $self->prepare_parameters($c)
491 Sets up parameters from query and post parameters.
492 If parameters have already been set up will clear
493 existing parameters and set up again.
497 sub prepare_parameters {
498 my ( $self, $c ) = @_;
500 $c->request->_clear_parameters;
501 return $c->request->parameters;
504 =head2 $self->prepare_path($c)
506 abstract method, implemented by engines.
511 my ($self, $ctx) = @_;
513 my $env = $ctx->request->env;
515 my $scheme = $ctx->request->secure ? 'https' : 'http';
516 my $host = $env->{HTTP_HOST} || $env->{SERVER_NAME};
517 my $port = $env->{SERVER_PORT} || 80;
518 my $base_path = $env->{SCRIPT_NAME} || "/";
520 # set the request URI
522 if (!$ctx->config->{use_request_uri_for_path}) {
523 my $path_info = $env->{PATH_INFO};
524 if ( exists $env->{REDIRECT_URL} ) {
525 $base_path = $env->{REDIRECT_URL};
526 $base_path =~ s/\Q$path_info\E$//;
528 $path = $base_path . $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 {
576 my $env = $c->request->env;
577 my $do_not_decode_query = $c->config->{do_not_decode_query};
580 if(my $new = $c->config->{default_query_encoding}) {
581 $old_encoding = $c->encoding;
585 my $check = $c->config->{do_not_check_query_encoding} ? undef :$c->_encode_check;
588 return $str if $do_not_decode_query;
589 return $c->_handle_param_unicode_decoding($str, $check);
592 my $query_string = exists $env->{QUERY_STRING}
593 ? $env->{QUERY_STRING}
596 $query_string =~ s/\A[&;]+//;
598 my @unsplit_pairs = split /[&;]+/, $query_string;
599 my $p = Hash::MultiValue->new();
601 my $is_first_pair = 1;
602 for my $pair (@unsplit_pairs) {
604 = map { defined $_ ? $decoder->($self->unescape_uri($_)) : $_ }
605 ( split /=/, $pair, 2 )[0,1]; # slice forces two elements
607 if ($is_first_pair) {
608 # If the first pair has no equal sign, then it means the isindex
610 $c->request->query_keywords($name) unless defined $value;
615 $p->add( $name => $value );
619 $c->encoding($old_encoding) if $old_encoding;
620 $c->request->query_parameters( $c->request->_use_hash_multivalue ? $p : $p->mixed );
623 =head2 $self->prepare_read($c)
625 Prepare to read by initializing the Content-Length from headers.
630 my ( $self, $c ) = @_;
632 # Initialize the amount of data we think we need to read
633 $c->request->_read_length;
636 =head2 $self->prepare_request(@arguments)
638 Populate the context object from the request object.
642 sub prepare_request {
643 my ($self, $ctx, %args) = @_;
644 $ctx->log->psgienv($args{env}) if $ctx->log->can('psgienv');
645 $ctx->request->_set_env($args{env});
646 $self->_set_env($args{env}); # Nasty back compat!
647 $ctx->response->_set_response_cb($args{response_cb});
650 =head2 $self->prepare_uploads($c)
654 sub prepare_uploads {
655 my ( $self, $c ) = @_;
657 my $request = $c->request;
658 return unless $request->_body;
660 my $enc = $c->encoding;
661 my $uploads = $request->_body->upload;
662 my $parameters = $request->parameters;
663 foreach my $name (keys %$uploads) {
664 my $files = $uploads->{$name};
665 $name = $c->_handle_unicode_decoding($name) if $enc;
667 for my $upload (ref $files eq 'ARRAY' ? @$files : ($files)) {
668 my $headers = HTTP::Headers->new( %{ $upload->{headers} } );
669 my $filename = $upload->{filename};
670 $filename = $c->_handle_unicode_decoding($filename) if $enc;
672 my $u = Catalyst::Request::Upload->new
674 size => $upload->{size},
675 type => scalar $headers->content_type,
676 charset => scalar $headers->content_type_charset,
678 tempname => $upload->{tempname},
679 filename => $filename,
683 $request->uploads->{$name} = @uploads > 1 ? \@uploads : $uploads[0];
685 # support access to the filename as a normal param
686 my @filenames = map { $_->{filename} } @uploads;
687 # append, if there's already params with this name
688 if (exists $parameters->{$name}) {
689 if (ref $parameters->{$name} eq 'ARRAY') {
690 push @{ $parameters->{$name} }, @filenames;
693 $parameters->{$name} = [ $parameters->{$name}, @filenames ];
697 $parameters->{$name} = @filenames > 1 ? \@filenames : $filenames[0];
702 =head2 $self->write($c, $buffer)
704 Writes the buffer to the client.
709 my ( $self, $c, $buffer ) = @_;
711 $c->response->write($buffer);
714 =head2 $self->unencoded_write($c, $buffer)
716 Writes the buffer to the client without encoding. Necessary for
717 already encoded buffers. Used when a $c->write has been done
718 followed by $c->res->body.
722 sub unencoded_write {
723 my ( $self, $c, $buffer ) = @_;
725 $c->response->unencoded_write($buffer);
728 =head2 $self->read($c, [$maxlength])
730 Reads from the input stream by calling C<< $self->read_chunk >>.
732 Maintains the read_length and read_position counters as data is read.
737 my ( $self, $c, $maxlength ) = @_;
739 $c->request->read($maxlength);
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->read_chunk(@_);
755 =head2 $self->run($app, $server)
757 Start the engine. Builds a PSGI application and calls the
758 run method on the server passed in, which then causes the
759 engine to loop, handling requests..
764 my ($self, $app, $psgi, @args) = @_;
765 # @args left here rather than just a $options, $server for back compat with the
766 # old style scripts which send a few args, then a hashref
768 # They should never actually be used in the normal case as the Plack engine is
769 # passed in got all the 'standard' args via the loader in the script already.
771 # FIXME - we should stash the options in an attribute so that custom args
772 # like Gitalist's --git_dir are possible to get from the app without stupid tricks.
773 my $server = pop @args if (scalar @args && blessed $args[-1]);
774 my $options = pop @args if (scalar @args && ref($args[-1]) eq 'HASH');
775 # Back compat hack for applications with old (non Catalyst::Script) scripts to work in FCGI.
776 if (scalar @args && !ref($args[0])) {
777 if (my $listen = shift @args) {
778 $options->{listen} ||= [$listen];
782 $server = Catalyst::EngineLoader->new(application_name => ref($self))->auto(%$options);
783 # We're not being called from a script, so auto detect what backend to
784 # run on. This should never happen, as mod_perl never calls ->run,
785 # instead the $app->handle method is called per request.
786 $app->log->warn("Not supplied a Plack engine, falling back to engine auto-loader (are your scripts ancient?)")
788 $app->run_options($options);
789 $server->run($psgi, $options);
792 =head2 build_psgi_app ($app, @args)
794 Builds and returns a PSGI application closure. (Raw, not wrapped in middleware)
799 my ($self, $app, @args) = @_;
806 confess("Did not get a response callback for writer, cannot continue") unless $respond;
807 $app->handle_request(env => $env, response_cb => $respond);
812 =head2 $self->unescape_uri($uri)
814 Unescapes a given URI using the most efficient method available. Engines such
815 as Apache may implement this using Apache's C-based modules, for example.
820 my ( $self, $str ) = @_;
822 $str =~ s/(?:%([0-9A-Fa-f]{2})|\+)/defined $1 ? chr(hex($1)) : ' '/eg;
827 =head2 $self->finalize_output
829 <obsolete>, see finalize_body
833 Hash containing environment variables including many special variables inserted
834 by WWW server - like SERVER_*, REMOTE_*, HTTP_* ...
836 Before accessing environment variables consider whether the same information is
837 not directly available via Catalyst objects $c->request, $c->engine ...
839 BEWARE: If you really need to access some environment variable from your Catalyst
840 application you should use $c->engine->env->{VARNAME} instead of $ENV{VARNAME},
841 as in some environments the %ENV hash does not contain what you would expect.
845 Catalyst Contributors, see Catalyst.pm
849 This library is free software. You can redistribute it and/or modify it under
850 the same terms as Perl itself.
854 __PACKAGE__->meta->make_immutable;