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;
16 use Plack::Request::Upload;
20 use namespace::clean -except => 'meta';
22 # Amount of data to read from input on each pass
23 our $CHUNKSIZE = 64 * 1024;
25 # XXX - this is only here for compat, do not use!
26 has env => ( is => 'rw', writer => '_set_env' );
27 my $WARN_ABOUT_ENV = 0;
29 my ($orig, $self, @args) = @_;
31 warn "env as a writer is deprecated, you probably need to upgrade Catalyst::Engine::PSGI"
32 unless $WARN_ABOUT_ENV++;
33 return $self->_set_env(@args);
38 # XXX - Only here for Engine::PSGI compat
39 sub prepare_connection {
40 my ($self, $ctx) = @_;
41 $ctx->request->prepare_connection;
46 Catalyst::Engine - The Catalyst Engine
57 =head2 $self->finalize_body($c)
59 Finalize body. Prints the response output as blocking stream if it looks like
60 a filehandle, otherwise write it out all in one go. If there is no body in
61 the response, we assume you are handling it 'manually', such as for nonblocking
62 style or asynchronous streaming responses. You do this by calling L</write>
63 several times (which sends HTTP headers if needed) or you close over
64 C<< $response->write_fh >>.
66 See L<Catalyst::Response/write> and L<Catalyst::Response/write_fh> for more.
71 my ( $self, $c ) = @_;
72 my $res = $c->response; # We use this all over
74 ## If we've asked for the write 'filehandle' that means the application is
75 ## doing something custom and is expected to close the response
76 return if $res->_has_write_fh;
78 my $body = $res->body; # save some typing
79 if($res->_has_response_cb) {
80 ## we have not called the response callback yet, so we are safe to send
81 ## the whole body to PSGI
84 $res->headers->scan(sub { push @headers, @_ });
86 # We need to figure out what kind of body we have and normalize it to something
89 # Handle objects first
91 if($body->can('getline')) {
92 # Body is an IO handle that meets the PSGI spec. Nothing to normalize
93 } elsif($body->can('read')) {
95 # In the past, Catalyst only looked for ->read not ->getline. It is very possible
96 # that one might have an object that respected read but did not have getline.
97 # As a result, we need to handle this case for backcompat.
99 # We will just do the old loop for now. In a future version of Catalyst this support
100 # will be removed and one will have to rewrite their custom object or use
101 # Plack::Middleware::AdaptFilehandleRead. In anycase support for this is officially
102 # deprecated and described as such as of 5.90060
106 $got = read $body, my ($buffer), $CHUNKSIZE;
107 $got = 0 unless $self->write($c, $buffer );
113 # Looks like for backcompat reasons we need to be able to deal
114 # with stringyfiable objects.
118 if( (ref($body) eq 'GLOB') or (ref($body) eq 'ARRAY')) {
119 # Again, PSGI can just accept this, no transform needed. We don't officially
120 # document the body as arrayref at this time (and there's not specific test
121 # cases. we support it because it simplifies some plack compatibility logic
122 # and we might make it official at some point.
124 $c->log->error("${\ref($body)} is not a valid value for Response->body");
128 # Body is defined and not an object or reference. We assume a simple value
129 # and wrap it in an array for PSGI
137 $res->_response_cb->([ $res->status, \@headers, $body]);
138 $res->_clear_response_cb;
141 ## Now, if there's no response callback anymore, that means someone has
142 ## called ->write in order to stream 'some stuff along the way'. I think
143 ## for backcompat we still need to handle a ->body. I guess I could see
144 ## someone calling ->write to presend some stuff, and then doing the rest
145 ## via ->body, like in a template.
147 ## We'll just use the old, existing code for this (or most of it)
149 if(my $body = $res->body) {
151 if ( blessed($body) && $body->can('read') or ref($body) eq 'GLOB' ) {
153 ## In this case we have no choice and will fall back on the old
154 ## manual streaming stuff. Not optimal. This is deprecated as of 5.900560+
158 $got = read $body, my ($buffer), $CHUNKSIZE;
159 $got = 0 unless $self->write($c, $buffer );
166 # Case where body was set afgter calling ->write. We'd prefer not to
167 # support this, but I can see some use cases with the way most of the
170 $self->write($c, $body );
174 $res->_writer->close;
181 =head2 $self->finalize_cookies($c)
183 Create CGI::Simple::Cookie objects from $c->res->cookies, and set them as
188 sub finalize_cookies {
189 my ( $self, $c ) = @_;
192 my $response = $c->response;
194 foreach my $name (keys %{ $response->cookies }) {
196 my $val = $response->cookies->{$name};
201 : CGI::Simple::Cookie->new(
203 -value => $val->{value},
204 -expires => $val->{expires},
205 -domain => $val->{domain},
206 -path => $val->{path},
207 -secure => $val->{secure} || 0,
208 -httponly => $val->{httponly} || 0,
211 if (!defined $cookie) {
212 $c->log->warn("undef passed in '$name' cookie value - not setting cookie")
217 push @cookies, $cookie->as_string;
220 for my $cookie (@cookies) {
221 $response->headers->push_header( 'Set-Cookie' => $cookie );
225 =head2 $self->finalize_error($c)
227 Output an appropriate error message. Called if there's an error in $c
228 after the dispatch has finished. Will output debug messages if Catalyst
229 is in debug mode, or a `please come back later` message otherwise.
233 sub _dump_error_page_element {
234 my ($self, $i, $element) = @_;
235 my ($name, $val) = @{ $element };
237 # This is fugly, but the metaclass is _HUGE_ and demands waaay too much
238 # scrolling. Suggestions for more pleasant ways to do this welcome.
239 local $val->{'__MOP__'} = "Stringified: "
240 . $val->{'__MOP__'} if ref $val eq 'HASH' && exists $val->{'__MOP__'};
242 my $text = encode_entities( dump( $val ));
243 sprintf <<"EOF", $name, $text;
244 <h2><a href="#" onclick="toggleDump('dump_$i'); return false">%s</a></h2>
246 <pre wrap="">%s</pre>
252 my ( $self, $c ) = @_;
254 $c->res->content_type('text/html; charset=utf-8');
255 my $name = ref($c)->config->{name} || join(' ', split('::', ref $c));
257 # Prevent Catalyst::Plugin::Unicode::Encoding from running.
258 # This is a little nasty, but it's the best way to be clean whether or
259 # not the user has an encoding plugin.
261 if ($c->can('encoding')) {
265 my ( $title, $error, $infos );
269 $error = join '', map {
270 '<p><code class="error">'
271 . encode_entities($_)
274 $error ||= 'No output';
275 $error = qq{<pre wrap="">$error</pre>};
276 $title = $name = "$name on Catalyst $Catalyst::VERSION";
277 $name = "<h1>$name</h1>";
279 # Don't show context in the dump
280 $c->res->_clear_context;
282 # Don't show body parser in the dump
283 $c->req->_clear_body;
287 for my $dump ( $c->dump_these ) {
288 push @infos, $self->_dump_error_page_element($i, $dump);
291 $infos = join "\n", @infos;
298 (en) Please come back later
299 (fr) SVP veuillez revenir plus tard
300 (de) Bitte versuchen sie es spaeter nocheinmal
301 (at) Konnten's bitt'schoen spaeter nochmal reinschauen
302 (no) Vennligst prov igjen senere
303 (dk) Venligst prov igen senere
304 (pl) Prosze sprobowac pozniej
305 (pt) Por favor volte mais tarde
306 (ru) Попробуйте еще раз позже
307 (ua) Спробуйте ще раз пізніше
312 $c->res->body( <<"" );
313 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
314 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
315 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
317 <meta http-equiv="Content-Language" content="en" />
318 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
319 <title>$title</title>
320 <script type="text/javascript">
322 function toggleDump (dumpElement) {
323 var e = document.getElementById( dumpElement );
324 if (e.style.display == "none") {
325 e.style.display = "";
328 e.style.display = "none";
333 <style type="text/css">
335 font-family: "Bitstream Vera Sans", "Trebuchet MS", Verdana,
336 Tahoma, Arial, helvetica, sans-serif;
338 background-color: #eee;
342 :link, :link:hover, :visited, :visited:hover {
347 background-color: #ccc;
348 border: 1px solid #aaa;
353 background-color: #cce;
354 border: 1px solid #755;
360 background-color: #eee;
361 border: 1px solid #575;
367 background-color: #cce;
368 border: 1px solid #557;
377 div.name h1, div.error p {
385 text-decoration: underline;
391 /* from http://users.tkk.fi/~tkarvine/linux/doc/pre-wrap/pre-wrap-css3-mozilla-opera-ie.html */
392 /* Browser specific (not valid) styles to make preformatted text wrap */
394 white-space: pre-wrap; /* css-3 */
395 white-space: -moz-pre-wrap; /* Mozilla, since 1999 */
396 white-space: -pre-wrap; /* Opera 4-6 */
397 white-space: -o-pre-wrap; /* Opera 7 */
398 word-wrap: break-word; /* Internet Explorer 5.5+ */
404 <div class="error">$error</div>
405 <div class="infos">$infos</div>
406 <div class="name">$name</div>
411 # Trick IE. Old versions of IE would display their own error page instead
412 # of ours if we'd give it less than 512 bytes.
413 $c->res->{body} .= ( ' ' x 512 );
415 $c->res->{body} = Encode::encode("UTF-8", $c->res->{body});
418 $c->res->status(500);
421 =head2 $self->finalize_headers($c)
423 Allows engines to write headers to response
427 sub finalize_headers {
428 my ($self, $ctx) = @_;
430 $ctx->finalize_headers unless $ctx->response->finalized_headers;
434 =head2 $self->finalize_uploads($c)
436 Clean up after uploads, deleting temp files.
440 sub finalize_uploads {
441 my ( $self, $c ) = @_;
443 # N.B. This code is theoretically entirely unneeded due to ->cleanup(1)
444 # on the HTTP::Body object.
445 my $request = $c->request;
446 foreach my $key (keys %{ $request->uploads }) {
447 my $upload = $request->uploads->{$key};
448 unlink grep { -e $_ } map { $_->tempname }
449 (ref $upload eq 'ARRAY' ? @{$upload} : ($upload));
454 =head2 $self->prepare_body($c)
456 sets up the L<Catalyst::Request> object body using L<HTTP::Body>
461 my ( $self, $c ) = @_;
463 $c->request->prepare_body;
466 =head2 $self->prepare_body_chunk($c)
468 Add a chunk to the request body.
472 # XXX - Can this be deleted?
473 sub prepare_body_chunk {
474 my ( $self, $c, $chunk ) = @_;
476 $c->request->prepare_body_chunk($chunk);
479 =head2 $self->prepare_body_parameters($c)
481 Sets up parameters from body.
485 sub prepare_body_parameters {
486 my ( $self, $c ) = @_;
488 $c->request->prepare_body_parameters;
491 =head2 $self->prepare_parameters($c)
493 Sets up parameters from query and post parameters.
494 If parameters have already been set up will clear
495 existing parameters and set up again.
499 sub prepare_parameters {
500 my ( $self, $c ) = @_;
502 $c->request->_clear_parameters;
503 return $c->request->parameters;
506 =head2 $self->prepare_path($c)
508 abstract method, implemented by engines.
513 my ($self, $ctx) = @_;
515 my $env = $ctx->request->env;
517 my $scheme = $ctx->request->secure ? 'https' : 'http';
518 my $host = $env->{HTTP_HOST} || $env->{SERVER_NAME};
519 my $port = $env->{SERVER_PORT} || 80;
520 my $base_path = $env->{SCRIPT_NAME} || "/";
522 # set the request URI
524 if (!$ctx->config->{use_request_uri_for_path}) {
525 my $path_info = $env->{PATH_INFO};
526 if ( exists $env->{REDIRECT_URL} ) {
527 $base_path = $env->{REDIRECT_URL};
528 $base_path =~ s/\Q$path_info\E$//;
530 $path = $base_path . $path_info;
532 $path =~ s/([^$URI::uric])/$URI::Escape::escapes{$1}/go;
533 $path =~ s/\?/%3F/g; # STUPID STUPID SPECIAL CASE
536 my $req_uri = $env->{REQUEST_URI};
537 $req_uri =~ s/\?.*$//;
542 # Using URI directly is way too slow, so we construct the URLs manually
543 my $uri_class = "URI::$scheme";
545 # HTTP_HOST will include the port even if it's 80/443
546 $host =~ s/:(?:80|443)$//;
548 if ($port !~ /^(?:80|443)$/ && $host !~ /:/) {
552 my $query = $env->{QUERY_STRING} ? '?' . $env->{QUERY_STRING} : '';
553 my $uri = $scheme . '://' . $host . '/' . $path . $query;
555 $ctx->request->uri( (bless \$uri, $uri_class)->canonical );
558 # base must end in a slash
559 $base_path .= '/' unless $base_path =~ m{/$};
561 my $base_uri = $scheme . '://' . $host . $base_path;
563 $ctx->request->base( bless \$base_uri, $uri_class );
568 =head2 $self->prepare_request($c)
570 =head2 $self->prepare_query_parameters($c)
572 process the query string and extract query parameters.
576 sub prepare_query_parameters {
578 my $env = $c->request->env;
580 if(my $query_obj = $env->{'plack.request.query'}) {
581 $c->request->query_parameters(
582 $c->request->_use_hash_multivalue ?
584 $query_obj->as_hashref_mixed);
588 my $query_string = exists $env->{QUERY_STRING}
589 ? $env->{QUERY_STRING}
592 # Check for keywords (no = signs)
593 # (yes, index() is faster than a regex :))
594 if ( index( $query_string, '=' ) < 0 ) {
595 $c->request->query_keywords($self->unescape_uri($query_string));
601 # replace semi-colons
602 $query_string =~ s/;/&/g;
604 my @params = grep { length $_ } split /&/, $query_string;
606 for my $item ( @params ) {
609 = map { $self->unescape_uri($_) }
610 split( /=/, $item, 2 );
612 $param = $self->unescape_uri($item) unless defined $param;
614 if ( exists $query{$param} ) {
615 if ( ref $query{$param} ) {
616 push @{ $query{$param} }, $value;
619 $query{$param} = [ $query{$param}, $value ];
623 $query{$param} = $value;
627 $c->request->query_parameters(
628 $c->request->_use_hash_multivalue ?
629 Hash::MultiValue->from_mixed(\%query) :
633 =head2 $self->prepare_read($c)
635 Prepare to read by initializing the Content-Length from headers.
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->log->psgienv($args{env}) if $ctx->log->can('psgienv');
655 $ctx->request->_set_env($args{env});
656 $self->_set_env($args{env}); # Nasty back compat!
657 $ctx->response->_set_response_cb($args{response_cb});
660 =head2 $self->prepare_uploads($c)
664 sub prepare_uploads {
665 my ( $self, $c ) = @_;
667 my $request = $c->request;
668 return unless $request->_body;
670 my $uploads = $request->_body->upload;
671 my $parameters = $request->parameters;
672 foreach my $name (keys %$uploads) {
673 my $files = $uploads->{$name};
675 for my $upload (ref $files eq 'ARRAY' ? @$files : ($files)) {
676 my $headers = HTTP::Headers->new( %{ $upload->{headers} } );
677 my $u = Catalyst::Request::Upload->new
679 size => $upload->{size},
680 type => scalar $headers->content_type,
682 tempname => $upload->{tempname},
683 filename => $upload->{filename},
687 $request->uploads->{$name} = @uploads > 1 ? \@uploads : $uploads[0];
689 # support access to the filename as a normal param
690 my @filenames = map { $_->{filename} } @uploads;
691 # append, if there's already params with this name
692 if (exists $parameters->{$name}) {
693 if (ref $parameters->{$name} eq 'ARRAY') {
694 push @{ $parameters->{$name} }, @filenames;
697 $parameters->{$name} = [ $parameters->{$name}, @filenames ];
701 $parameters->{$name} = @filenames > 1 ? \@filenames : $filenames[0];
706 =head2 $self->write($c, $buffer)
708 Writes the buffer to the client.
713 my ( $self, $c, $buffer ) = @_;
715 $c->response->write($buffer);
718 =head2 $self->read($c, [$maxlength])
720 Reads from the input stream by calling C<< $self->read_chunk >>.
722 Maintains the read_length and read_position counters as data is read.
727 my ( $self, $c, $maxlength ) = @_;
729 $c->request->read($maxlength);
732 =head2 $self->read_chunk($c, \$buffer, $length)
734 Each engine implements read_chunk as its preferred way of reading a chunk
735 of data. Returns the number of bytes read. A return of 0 indicates that
736 there is no more data to be read.
741 my ($self, $ctx) = (shift, shift);
742 return $ctx->request->read_chunk(@_);
745 =head2 $self->run($app, $server)
747 Start the engine. Builds a PSGI application and calls the
748 run method on the server passed in, which then causes the
749 engine to loop, handling requests..
754 my ($self, $app, $psgi, @args) = @_;
755 # @args left here rather than just a $options, $server for back compat with the
756 # old style scripts which send a few args, then a hashref
758 # They should never actually be used in the normal case as the Plack engine is
759 # passed in got all the 'standard' args via the loader in the script already.
761 # FIXME - we should stash the options in an attribute so that custom args
762 # like Gitalist's --git_dir are possible to get from the app without stupid tricks.
763 my $server = pop @args if (scalar @args && blessed $args[-1]);
764 my $options = pop @args if (scalar @args && ref($args[-1]) eq 'HASH');
765 # Back compat hack for applications with old (non Catalyst::Script) scripts to work in FCGI.
766 if (scalar @args && !ref($args[0])) {
767 if (my $listen = shift @args) {
768 $options->{listen} ||= [$listen];
772 $server = Catalyst::EngineLoader->new(application_name => ref($self))->auto(%$options);
773 # We're not being called from a script, so auto detect what backend to
774 # run on. This should never happen, as mod_perl never calls ->run,
775 # instead the $app->handle method is called per request.
776 $app->log->warn("Not supplied a Plack engine, falling back to engine auto-loader (are your scripts ancient?)")
778 $app->run_options($options);
779 $server->run($psgi, $options);
782 =head2 build_psgi_app ($app, @args)
784 Builds and returns a PSGI application closure. (Raw, not wrapped in middleware)
789 my ($self, $app, @args) = @_;
796 confess("Did not get a response callback for writer, cannot continue") unless $respond;
797 $app->handle_request(env => $env, response_cb => $respond);
802 =head2 $self->unescape_uri($uri)
804 Unescapes a given URI using the most efficient method available. Engines such
805 as Apache may implement this using Apache's C-based modules, for example.
810 my ( $self, $str ) = @_;
812 $str =~ s/(?:%([0-9A-Fa-f]{2})|\+)/defined $1 ? chr(hex($1)) : ' '/eg;
817 =head2 $self->finalize_output
819 <obsolete>, see finalize_body
823 Hash containing environment variables including many special variables inserted
824 by WWW server - like SERVER_*, REMOTE_*, HTTP_* ...
826 Before accessing environment variables consider whether the same information is
827 not directly available via Catalyst objects $c->request, $c->engine ...
829 BEWARE: If you really need to access some environment variable from your Catalyst
830 application you should use $c->engine->env->{VARNAME} instead of $ENV{VARNAME},
831 as in some environments the %ENV hash does not contain what you would expect.
835 Catalyst Contributors, see Catalyst.pm
839 This library is free software. You can redistribute it and/or modify it under
840 the same terms as Perl itself.
844 __PACKAGE__->meta->make_immutable;