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;
27 Catalyst::Engine - The Catalyst Engine
38 =head2 $self->finalize_body($c)
40 Finalize body. Prints the response output as blocking stream if it looks like
41 a filehandle, otherwise write it out all in one go. If there is no body in
42 the response, we assume you are handling it 'manually', such as for nonblocking
43 style or asynchronous streaming responses. You do this by calling L</write>
44 several times (which sends HTTP headers if needed) or you close over
45 C<< $response->write_fh >>.
47 See L<Catalyst::Response/write> and L<Catalyst::Response/write_fh> for more.
52 my ( $self, $c ) = @_;
53 my $res = $c->response; # We use this all over
55 ## If we've asked for the write 'filehandle' that means the application is
56 ## doing something custom and is expected to close the response
57 return if $res->_has_write_fh;
59 my $body = $res->body; # save some typing
60 if($res->_has_response_cb) {
61 ## we have not called the response callback yet, so we are safe to send
62 ## the whole body to PSGI
65 $res->headers->scan(sub { push @headers, @_ });
67 # We need to figure out what kind of body we have and normalize it to something
70 # Handle objects first
72 if($body->can('getline')) {
73 # Body is an IO handle that meets the PSGI spec. Nothing to normalize
74 } elsif($body->can('read')) {
76 # In the past, Catalyst only looked for ->read not ->getline. It is very possible
77 # that one might have an object that respected read but did not have getline.
78 # As a result, we need to handle this case for backcompat.
80 # We will just do the old loop for now. In a future version of Catalyst this support
81 # will be removed and one will have to rewrite their custom object or use
82 # Plack::Middleware::AdaptFilehandleRead. In anycase support for this is officially
83 # deprecated and described as such as of 5.90060
87 $got = read $body, my ($buffer), $CHUNKSIZE;
88 $got = 0 unless $self->write($c, $buffer );
94 # Looks like for backcompat reasons we need to be able to deal
95 # with stringyfiable objects.
99 if( (ref($body) eq 'GLOB') or (ref($body) eq 'ARRAY')) {
100 # Again, PSGI can just accept this, no transform needed. We don't officially
101 # document the body as arrayref at this time (and there's not specific test
102 # cases. we support it because it simplifies some plack compatibility logic
103 # and we might make it official at some point.
105 $c->log->error("${\ref($body)} is not a valid value for Response->body");
109 # Body is defined and not an object or reference. We assume a simple value
110 # and wrap it in an array for PSGI
118 $res->_response_cb->([ $res->status, \@headers, $body]);
119 $res->_clear_response_cb;
122 ## Now, if there's no response callback anymore, that means someone has
123 ## called ->write in order to stream 'some stuff along the way'. I think
124 ## for backcompat we still need to handle a ->body. I guess I could see
125 ## someone calling ->write to presend some stuff, and then doing the rest
126 ## via ->body, like in a template.
128 ## We'll just use the old, existing code for this (or most of it)
130 if(my $body = $res->body) {
132 if ( blessed($body) && $body->can('read') or ref($body) eq 'GLOB' ) {
134 ## In this case we have no choice and will fall back on the old
135 ## manual streaming stuff. Not optimal. This is deprecated as of 5.900560+
139 $got = read $body, my ($buffer), $CHUNKSIZE;
140 $got = 0 unless $self->write($c, $buffer );
147 # Case where body was set afgter calling ->write. We'd prefer not to
148 # support this, but I can see some use cases with the way most of the
151 $self->write($c, $body );
155 $res->_writer->close;
162 =head2 $self->finalize_cookies($c)
164 Create CGI::Simple::Cookie objects from $c->res->cookies, and set them as
169 sub finalize_cookies {
170 my ( $self, $c ) = @_;
173 my $response = $c->response;
175 foreach my $name (keys %{ $response->cookies }) {
177 my $val = $response->cookies->{$name};
182 : CGI::Simple::Cookie->new(
184 -value => $val->{value},
185 -expires => $val->{expires},
186 -domain => $val->{domain},
187 -path => $val->{path},
188 -secure => $val->{secure} || 0,
189 -httponly => $val->{httponly} || 0,
192 if (!defined $cookie) {
193 $c->log->warn("undef passed in '$name' cookie value - not setting cookie")
198 push @cookies, $cookie->as_string;
201 for my $cookie (@cookies) {
202 $response->headers->push_header( 'Set-Cookie' => $cookie );
206 =head2 $self->finalize_error($c)
208 Output an appropriate error message. Called if there's an error in $c
209 after the dispatch has finished. Will output debug messages if Catalyst
210 is in debug mode, or a `please come back later` message otherwise.
214 sub _dump_error_page_element {
215 my ($self, $i, $element) = @_;
216 my ($name, $val) = @{ $element };
218 # This is fugly, but the metaclass is _HUGE_ and demands waaay too much
219 # scrolling. Suggestions for more pleasant ways to do this welcome.
220 local $val->{'__MOP__'} = "Stringified: "
221 . $val->{'__MOP__'} if ref $val eq 'HASH' && exists $val->{'__MOP__'};
223 my $text = encode_entities( dump( $val ));
224 sprintf <<"EOF", $name, $text;
225 <h2><a href="#" onclick="toggleDump('dump_$i'); return false">%s</a></h2>
227 <pre wrap="">%s</pre>
233 my ( $self, $c ) = @_;
235 $c->res->content_type('text/html; charset=utf-8');
236 my $name = ref($c)->config->{name} || join(' ', split('::', ref $c));
238 # Prevent Catalyst::Plugin::Unicode::Encoding from running.
239 # This is a little nasty, but it's the best way to be clean whether or
240 # not the user has an encoding plugin.
242 if ($c->can('encoding')) {
246 my ( $title, $error, $infos );
250 $error = join '', map {
251 '<p><code class="error">'
252 . encode_entities($_)
255 $error ||= 'No output';
256 $error = qq{<pre wrap="">$error</pre>};
257 $title = $name = "$name on Catalyst $Catalyst::VERSION";
258 $name = "<h1>$name</h1>";
260 # Don't show context in the dump
261 $c->res->_clear_context;
263 # Don't show body parser in the dump
264 $c->req->_clear_body;
268 for my $dump ( $c->dump_these ) {
269 push @infos, $self->_dump_error_page_element($i, $dump);
272 $infos = join "\n", @infos;
279 (en) Please come back later
280 (fr) SVP veuillez revenir plus tard
281 (de) Bitte versuchen sie es spaeter nocheinmal
282 (at) Konnten's bitt'schoen spaeter nochmal reinschauen
283 (no) Vennligst prov igjen senere
284 (dk) Venligst prov igen senere
285 (pl) Prosze sprobowac pozniej
286 (pt) Por favor volte mais tarde
287 (ru) Попробуйте еще раз позже
288 (ua) Спробуйте ще раз пізніше
289 (it) Per favore riprova più tardi
294 $c->res->body( <<"" );
295 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
296 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
297 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
299 <meta http-equiv="Content-Language" content="en" />
300 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
301 <title>$title</title>
302 <script type="text/javascript">
304 function toggleDump (dumpElement) {
305 var e = document.getElementById( dumpElement );
306 if (e.style.display == "none") {
307 e.style.display = "";
310 e.style.display = "none";
315 <style type="text/css">
317 font-family: "Bitstream Vera Sans", "Trebuchet MS", Verdana,
318 Tahoma, Arial, helvetica, sans-serif;
320 background-color: #eee;
324 :link, :link:hover, :visited, :visited:hover {
329 background-color: #ccc;
330 border: 1px solid #aaa;
335 background-color: #cce;
336 border: 1px solid #755;
342 background-color: #eee;
343 border: 1px solid #575;
349 background-color: #cce;
350 border: 1px solid #557;
359 div.name h1, div.error p {
367 text-decoration: underline;
373 /* from http://users.tkk.fi/~tkarvine/linux/doc/pre-wrap/pre-wrap-css3-mozilla-opera-ie.html */
374 /* Browser specific (not valid) styles to make preformatted text wrap */
376 white-space: pre-wrap; /* css-3 */
377 white-space: -moz-pre-wrap; /* Mozilla, since 1999 */
378 white-space: -pre-wrap; /* Opera 4-6 */
379 white-space: -o-pre-wrap; /* Opera 7 */
380 word-wrap: break-word; /* Internet Explorer 5.5+ */
386 <div class="error">$error</div>
387 <div class="infos">$infos</div>
388 <div class="name">$name</div>
393 # Trick IE. Old versions of IE would display their own error page instead
394 # of ours if we'd give it less than 512 bytes.
395 $c->res->{body} .= ( ' ' x 512 );
397 $c->res->{body} = Encode::encode("UTF-8", $c->res->{body});
400 $c->res->status(500);
403 =head2 $self->finalize_headers($c)
405 Allows engines to write headers to response
409 sub finalize_headers {
410 my ($self, $ctx) = @_;
412 $ctx->finalize_headers unless $ctx->response->finalized_headers;
416 =head2 $self->finalize_uploads($c)
418 Clean up after uploads, deleting temp files.
422 sub finalize_uploads {
423 my ( $self, $c ) = @_;
425 # N.B. This code is theoretically entirely unneeded due to ->cleanup(1)
426 # on the HTTP::Body object.
427 my $request = $c->request;
428 foreach my $key (keys %{ $request->uploads }) {
429 my $upload = $request->uploads->{$key};
430 unlink grep { -e $_ } map { $_->tempname }
431 (ref $upload eq 'ARRAY' ? @{$upload} : ($upload));
436 =head2 $self->prepare_body($c)
438 sets up the L<Catalyst::Request> object body using L<HTTP::Body>
443 my ( $self, $c ) = @_;
445 $c->request->prepare_body;
448 =head2 $self->prepare_body_chunk($c)
450 Add a chunk to the request body.
454 # XXX - Can this be deleted?
455 sub prepare_body_chunk {
456 my ( $self, $c, $chunk ) = @_;
458 $c->request->prepare_body_chunk($chunk);
461 =head2 $self->prepare_body_parameters($c)
463 Sets up parameters from body.
467 sub prepare_body_parameters {
468 my ( $self, $c ) = @_;
470 $c->request->prepare_body_parameters;
473 =head2 $self->prepare_parameters($c)
475 Sets up parameters from query and post parameters.
476 If parameters have already been set up will clear
477 existing parameters and set up again.
481 sub prepare_parameters {
482 my ( $self, $c ) = @_;
484 $c->request->_clear_parameters;
485 return $c->request->parameters;
488 =head2 $self->prepare_path($c)
490 abstract method, implemented by engines.
495 my ($self, $ctx) = @_;
497 my $env = $ctx->request->env;
499 my $scheme = $ctx->request->secure ? 'https' : 'http';
500 my $host = $env->{HTTP_HOST} || $env->{SERVER_NAME};
501 my $port = $env->{SERVER_PORT} || 80;
502 my $base_path = $env->{SCRIPT_NAME} || "/";
504 # set the request URI
506 if (!$ctx->config->{use_request_uri_for_path}) {
507 my $path_info = $env->{PATH_INFO};
508 if ( exists $env->{REDIRECT_URL} ) {
509 $base_path = $env->{REDIRECT_URL};
510 $base_path =~ s/\Q$path_info\E$//;
512 $path = $base_path . $path_info;
514 $path =~ s/([^$URI::uric])/$URI::Escape::escapes{$1}/go;
515 $path =~ s/\?/%3F/g; # STUPID STUPID SPECIAL CASE
518 my $req_uri = $env->{REQUEST_URI};
519 $req_uri =~ s/\?.*$//;
524 # Using URI directly is way too slow, so we construct the URLs manually
525 my $uri_class = "URI::$scheme";
527 # HTTP_HOST will include the port even if it's 80/443
528 $host =~ s/:(?:80|443)$//;
530 if ($port !~ /^(?:80|443)$/ && $host !~ /:/) {
534 my $query = $env->{QUERY_STRING} ? '?' . $env->{QUERY_STRING} : '';
535 my $uri = $scheme . '://' . $host . '/' . $path . $query;
537 $ctx->request->uri( (bless \$uri, $uri_class)->canonical );
540 # base must end in a slash
541 $base_path .= '/' unless $base_path =~ m{/$};
543 my $base_uri = $scheme . '://' . $host . $base_path;
545 $ctx->request->base( bless \$base_uri, $uri_class );
550 =head2 $self->prepare_request($c)
552 =head2 $self->prepare_query_parameters($c)
554 process the query string and extract query parameters.
558 sub prepare_query_parameters {
560 my $env = $c->request->env;
562 if(my $query_obj = $env->{'plack.request.query'}) {
563 $c->request->query_parameters(
564 $c->request->_use_hash_multivalue ?
566 $query_obj->as_hashref_mixed);
570 my $query_string = exists $env->{QUERY_STRING}
571 ? $env->{QUERY_STRING}
574 # Check for keywords (no = signs)
575 # (yes, index() is faster than a regex :))
576 if ( index( $query_string, '=' ) < 0 ) {
577 $c->request->query_keywords($self->unescape_uri($query_string));
583 # replace semi-colons
584 $query_string =~ s/;/&/g;
586 my @params = grep { length $_ } split /&/, $query_string;
588 for my $item ( @params ) {
591 = map { $self->unescape_uri($_) }
592 split( /=/, $item, 2 );
594 $param = $self->unescape_uri($item) unless defined $param;
596 if ( exists $query{$param} ) {
597 if ( ref $query{$param} ) {
598 push @{ $query{$param} }, $value;
601 $query{$param} = [ $query{$param}, $value ];
605 $query{$param} = $value;
609 $c->request->query_parameters(
610 $c->request->_use_hash_multivalue ?
611 Hash::MultiValue->from_mixed(\%query) :
615 =head2 $self->prepare_read($c)
617 Prepare to read by initializing the Content-Length from headers.
622 my ( $self, $c ) = @_;
624 # Initialize the amount of data we think we need to read
625 $c->request->_read_length;
628 =head2 $self->prepare_request(@arguments)
630 Populate the context object from the request object.
634 sub prepare_request {
635 my ($self, $ctx, %args) = @_;
636 $ctx->log->psgienv($args{env}) if $ctx->log->can('psgienv');
637 $ctx->request->_set_env($args{env});
638 $ctx->response->_set_response_cb($args{response_cb});
641 =head2 $self->prepare_uploads($c)
645 sub prepare_uploads {
646 my ( $self, $c ) = @_;
648 my $request = $c->request;
649 return unless $request->_body;
651 my $uploads = $request->_body->upload;
652 my $parameters = $request->parameters;
653 foreach my $name (keys %$uploads) {
654 my $files = $uploads->{$name};
656 for my $upload (ref $files eq 'ARRAY' ? @$files : ($files)) {
657 my $headers = HTTP::Headers->new( %{ $upload->{headers} } );
658 my $u = Catalyst::Request::Upload->new
660 size => $upload->{size},
661 type => scalar $headers->content_type,
663 tempname => $upload->{tempname},
664 filename => $upload->{filename},
668 $request->uploads->{$name} = @uploads > 1 ? \@uploads : $uploads[0];
670 # support access to the filename as a normal param
671 my @filenames = map { $_->{filename} } @uploads;
672 # append, if there's already params with this name
673 if (exists $parameters->{$name}) {
674 if (ref $parameters->{$name} eq 'ARRAY') {
675 push @{ $parameters->{$name} }, @filenames;
678 $parameters->{$name} = [ $parameters->{$name}, @filenames ];
682 $parameters->{$name} = @filenames > 1 ? \@filenames : $filenames[0];
687 =head2 $self->write($c, $buffer)
689 Writes the buffer to the client.
694 my ( $self, $c, $buffer ) = @_;
696 $c->response->write($buffer);
699 =head2 $self->read($c, [$maxlength])
701 Reads from the input stream by calling C<< $self->read_chunk >>.
703 Maintains the read_length and read_position counters as data is read.
708 my ( $self, $c, $maxlength ) = @_;
710 $c->request->read($maxlength);
713 =head2 $self->read_chunk($c, \$buffer, $length)
715 Each engine implements read_chunk as its preferred way of reading a chunk
716 of data. Returns the number of bytes read. A return of 0 indicates that
717 there is no more data to be read.
722 my ($self, $ctx) = (shift, shift);
723 return $ctx->request->read_chunk(@_);
726 =head2 $self->run($app, $server)
728 Start the engine. Builds a PSGI application and calls the
729 run method on the server passed in, which then causes the
730 engine to loop, handling requests..
735 my ($self, $app, $psgi, @args) = @_;
736 # @args left here rather than just a $options, $server for back compat with the
737 # old style scripts which send a few args, then a hashref
739 # They should never actually be used in the normal case as the Plack engine is
740 # passed in got all the 'standard' args via the loader in the script already.
742 # FIXME - we should stash the options in an attribute so that custom args
743 # like Gitalist's --git_dir are possible to get from the app without stupid tricks.
744 my $server = pop @args if (scalar @args && blessed $args[-1]);
745 my $options = pop @args if (scalar @args && ref($args[-1]) eq 'HASH');
746 # Back compat hack for applications with old (non Catalyst::Script) scripts to work in FCGI.
747 if (scalar @args && !ref($args[0])) {
748 if (my $listen = shift @args) {
749 $options->{listen} ||= [$listen];
753 $server = Catalyst::EngineLoader->new(application_name => ref($self))->auto(%$options);
754 # We're not being called from a script, so auto detect what backend to
755 # run on. This should never happen, as mod_perl never calls ->run,
756 # instead the $app->handle method is called per request.
757 $app->log->warn("Not supplied a Plack engine, falling back to engine auto-loader (are your scripts ancient?)")
759 $app->run_options($options);
760 $server->run($psgi, $options);
763 =head2 build_psgi_app ($app, @args)
765 Builds and returns a PSGI application closure. (Raw, not wrapped in middleware)
770 my ($self, $app, @args) = @_;
777 confess("Did not get a response callback for writer, cannot continue") unless $respond;
778 $app->handle_request(env => $env, response_cb => $respond);
783 =head2 $self->unescape_uri($uri)
785 Unescapes a given URI using the most efficient method available. Engines such
786 as Apache may implement this using Apache's C-based modules, for example.
791 my ( $self, $str ) = @_;
793 $str =~ s/(?:%([0-9A-Fa-f]{2})|\+)/defined $1 ? chr(hex($1)) : ' '/eg;
798 =head2 $self->finalize_output
800 <obsolete>, see finalize_body
804 Hash containing environment variables including many special variables inserted
805 by WWW server - like SERVER_*, REMOTE_*, HTTP_* ...
807 Before accessing environment variables consider whether the same information is
808 not directly available via Catalyst objects $c->request, $c->engine ...
810 BEWARE: If you really need to access some environment variable from your Catalyst
811 application you should use $c->engine->env->{VARNAME} instead of $ENV{VARNAME},
812 as in some environments the %ENV hash does not contain what you would expect.
816 Catalyst Contributors, see Catalyst.pm
820 This library is free software. You can redistribute it and/or modify it under
821 the same terms as Perl itself.
825 __PACKAGE__->meta->make_immutable;