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 if($res->_has_response_cb) {
79 ## we have not called the response callback yet, so we are safe to send
80 ## the whole body to PSGI
83 $res->headers->scan(sub { push @headers, @_ });
85 ## We need to figure out what kind of body we have...
86 my $body = $res->body;
89 (blessed($body) && $body->can('getline'))
90 or ref($body) eq 'GLOB'
92 # Body is an IO handle that meets the PSGI spec
93 } elsif(blessed($body) && $body->can('read')) {
94 # In the past, Catalyst only looked for read not getline. It is very possible
95 # that one might have an object that respected read but did not have getline.
96 # As a result, we need to handle this case for backcompat.
98 # We will just do the old loop for now but someone could write a proxy
99 # object to wrap getline and proxy read
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.
111 $body = "$body" if blessed($body); # Assume there's some sort of overloading..
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) {
131 no warnings 'uninitialized';
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.
139 $got = read $body, my ($buffer), $CHUNKSIZE;
140 $got = 0 unless $self->write($c, $buffer );
146 $self->write($c, $body );
150 $res->_writer->close;
157 =head2 $self->finalize_cookies($c)
159 Create CGI::Simple::Cookie objects from $c->res->cookies, and set them as
164 sub finalize_cookies {
165 my ( $self, $c ) = @_;
168 my $response = $c->response;
170 foreach my $name (keys %{ $response->cookies }) {
172 my $val = $response->cookies->{$name};
177 : CGI::Simple::Cookie->new(
179 -value => $val->{value},
180 -expires => $val->{expires},
181 -domain => $val->{domain},
182 -path => $val->{path},
183 -secure => $val->{secure} || 0,
184 -httponly => $val->{httponly} || 0,
187 if (!defined $cookie) {
188 $c->log->warn("undef passed in '$name' cookie value - not setting cookie")
193 push @cookies, $cookie->as_string;
196 for my $cookie (@cookies) {
197 $response->headers->push_header( 'Set-Cookie' => $cookie );
201 =head2 $self->finalize_error($c)
203 Output an appropriate error message. Called if there's an error in $c
204 after the dispatch has finished. Will output debug messages if Catalyst
205 is in debug mode, or a `please come back later` message otherwise.
209 sub _dump_error_page_element {
210 my ($self, $i, $element) = @_;
211 my ($name, $val) = @{ $element };
213 # This is fugly, but the metaclass is _HUGE_ and demands waaay too much
214 # scrolling. Suggestions for more pleasant ways to do this welcome.
215 local $val->{'__MOP__'} = "Stringified: "
216 . $val->{'__MOP__'} if ref $val eq 'HASH' && exists $val->{'__MOP__'};
218 my $text = encode_entities( dump( $val ));
219 sprintf <<"EOF", $name, $text;
220 <h2><a href="#" onclick="toggleDump('dump_$i'); return false">%s</a></h2>
222 <pre wrap="">%s</pre>
228 my ( $self, $c ) = @_;
230 $c->res->content_type('text/html; charset=utf-8');
231 my $name = ref($c)->config->{name} || join(' ', split('::', ref $c));
233 # Prevent Catalyst::Plugin::Unicode::Encoding from running.
234 # This is a little nasty, but it's the best way to be clean whether or
235 # not the user has an encoding plugin.
237 if ($c->can('encoding')) {
241 my ( $title, $error, $infos );
245 $error = join '', map {
246 '<p><code class="error">'
247 . encode_entities($_)
250 $error ||= 'No output';
251 $error = qq{<pre wrap="">$error</pre>};
252 $title = $name = "$name on Catalyst $Catalyst::VERSION";
253 $name = "<h1>$name</h1>";
255 # Don't show context in the dump
256 $c->res->_clear_context;
258 # Don't show body parser in the dump
259 $c->req->_clear_body;
263 for my $dump ( $c->dump_these ) {
264 push @infos, $self->_dump_error_page_element($i, $dump);
267 $infos = join "\n", @infos;
274 (en) Please come back later
275 (fr) SVP veuillez revenir plus tard
276 (de) Bitte versuchen sie es spaeter nocheinmal
277 (at) Konnten's bitt'schoen spaeter nochmal reinschauen
278 (no) Vennligst prov igjen senere
279 (dk) Venligst prov igen senere
280 (pl) Prosze sprobowac pozniej
281 (pt) Por favor volte mais tarde
282 (ru) Попробуйте еще раз позже
283 (ua) Спробуйте ще раз пізніше
288 $c->res->body( <<"" );
289 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
290 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
291 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
293 <meta http-equiv="Content-Language" content="en" />
294 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
295 <title>$title</title>
296 <script type="text/javascript">
298 function toggleDump (dumpElement) {
299 var e = document.getElementById( dumpElement );
300 if (e.style.display == "none") {
301 e.style.display = "";
304 e.style.display = "none";
309 <style type="text/css">
311 font-family: "Bitstream Vera Sans", "Trebuchet MS", Verdana,
312 Tahoma, Arial, helvetica, sans-serif;
314 background-color: #eee;
318 :link, :link:hover, :visited, :visited:hover {
323 background-color: #ccc;
324 border: 1px solid #aaa;
329 background-color: #cce;
330 border: 1px solid #755;
336 background-color: #eee;
337 border: 1px solid #575;
343 background-color: #cce;
344 border: 1px solid #557;
353 div.name h1, div.error p {
361 text-decoration: underline;
367 /* from http://users.tkk.fi/~tkarvine/linux/doc/pre-wrap/pre-wrap-css3-mozilla-opera-ie.html */
368 /* Browser specific (not valid) styles to make preformatted text wrap */
370 white-space: pre-wrap; /* css-3 */
371 white-space: -moz-pre-wrap; /* Mozilla, since 1999 */
372 white-space: -pre-wrap; /* Opera 4-6 */
373 white-space: -o-pre-wrap; /* Opera 7 */
374 word-wrap: break-word; /* Internet Explorer 5.5+ */
380 <div class="error">$error</div>
381 <div class="infos">$infos</div>
382 <div class="name">$name</div>
387 # Trick IE. Old versions of IE would display their own error page instead
388 # of ours if we'd give it less than 512 bytes.
389 $c->res->{body} .= ( ' ' x 512 );
391 $c->res->{body} = Encode::encode("UTF-8", $c->res->{body});
394 $c->res->status(500);
397 =head2 $self->finalize_headers($c)
399 Allows engines to write headers to response
403 sub finalize_headers {
404 my ($self, $ctx) = @_;
406 $ctx->finalize_headers unless $ctx->response->finalized_headers;
410 =head2 $self->finalize_uploads($c)
412 Clean up after uploads, deleting temp files.
416 sub finalize_uploads {
417 my ( $self, $c ) = @_;
419 # N.B. This code is theoretically entirely unneeded due to ->cleanup(1)
420 # on the HTTP::Body object.
421 my $request = $c->request;
422 foreach my $key (keys %{ $request->uploads }) {
423 my $upload = $request->uploads->{$key};
424 unlink grep { -e $_ } map { $_->tempname }
425 (ref $upload eq 'ARRAY' ? @{$upload} : ($upload));
430 =head2 $self->prepare_body($c)
432 sets up the L<Catalyst::Request> object body using L<HTTP::Body>
437 my ( $self, $c ) = @_;
439 $c->request->prepare_body;
442 =head2 $self->prepare_body_chunk($c)
444 Add a chunk to the request body.
448 # XXX - Can this be deleted?
449 sub prepare_body_chunk {
450 my ( $self, $c, $chunk ) = @_;
452 $c->request->prepare_body_chunk($chunk);
455 =head2 $self->prepare_body_parameters($c)
457 Sets up parameters from body.
461 sub prepare_body_parameters {
462 my ( $self, $c ) = @_;
464 $c->request->prepare_body_parameters;
467 =head2 $self->prepare_parameters($c)
469 Sets up parameters from query and post parameters.
470 If parameters have already been set up will clear
471 existing parameters and set up again.
475 sub prepare_parameters {
476 my ( $self, $c ) = @_;
478 $c->request->_clear_parameters;
479 return $c->request->parameters;
482 =head2 $self->prepare_path($c)
484 abstract method, implemented by engines.
489 my ($self, $ctx) = @_;
491 my $env = $ctx->request->env;
493 my $scheme = $ctx->request->secure ? 'https' : 'http';
494 my $host = $env->{HTTP_HOST} || $env->{SERVER_NAME};
495 my $port = $env->{SERVER_PORT} || 80;
496 my $base_path = $env->{SCRIPT_NAME} || "/";
498 # set the request URI
500 if (!$ctx->config->{use_request_uri_for_path}) {
501 my $path_info = $env->{PATH_INFO};
502 if ( exists $env->{REDIRECT_URL} ) {
503 $base_path = $env->{REDIRECT_URL};
504 $base_path =~ s/\Q$path_info\E$//;
506 $path = $base_path . $path_info;
508 $path =~ s/([^$URI::uric])/$URI::Escape::escapes{$1}/go;
509 $path =~ s/\?/%3F/g; # STUPID STUPID SPECIAL CASE
512 my $req_uri = $env->{REQUEST_URI};
513 $req_uri =~ s/\?.*$//;
518 # Using URI directly is way too slow, so we construct the URLs manually
519 my $uri_class = "URI::$scheme";
521 # HTTP_HOST will include the port even if it's 80/443
522 $host =~ s/:(?:80|443)$//;
524 if ($port !~ /^(?:80|443)$/ && $host !~ /:/) {
528 my $query = $env->{QUERY_STRING} ? '?' . $env->{QUERY_STRING} : '';
529 my $uri = $scheme . '://' . $host . '/' . $path . $query;
531 $ctx->request->uri( (bless \$uri, $uri_class)->canonical );
534 # base must end in a slash
535 $base_path .= '/' unless $base_path =~ m{/$};
537 my $base_uri = $scheme . '://' . $host . $base_path;
539 $ctx->request->base( bless \$base_uri, $uri_class );
544 =head2 $self->prepare_request($c)
546 =head2 $self->prepare_query_parameters($c)
548 process the query string and extract query parameters.
552 sub prepare_query_parameters {
554 my $env = $c->request->env;
556 if(my $query_obj = $env->{'plack.request.query'}) {
557 $c->request->query_parameters(
558 $c->request->_use_hash_multivalue ?
560 $query_obj->as_hashref_mixed);
564 my $query_string = exists $env->{QUERY_STRING}
565 ? $env->{QUERY_STRING}
568 # Check for keywords (no = signs)
569 # (yes, index() is faster than a regex :))
570 if ( index( $query_string, '=' ) < 0 ) {
571 $c->request->query_keywords($self->unescape_uri($query_string));
577 # replace semi-colons
578 $query_string =~ s/;/&/g;
580 my @params = grep { length $_ } split /&/, $query_string;
582 for my $item ( @params ) {
585 = map { $self->unescape_uri($_) }
586 split( /=/, $item, 2 );
588 $param = $self->unescape_uri($item) unless defined $param;
590 if ( exists $query{$param} ) {
591 if ( ref $query{$param} ) {
592 push @{ $query{$param} }, $value;
595 $query{$param} = [ $query{$param}, $value ];
599 $query{$param} = $value;
603 $c->request->query_parameters(
604 $c->request->_use_hash_multivalue ?
605 Hash::MultiValue->from_mixed(\%query) :
609 =head2 $self->prepare_read($c)
611 Prepare to read by initializing the Content-Length from headers.
616 my ( $self, $c ) = @_;
618 # Initialize the amount of data we think we need to read
619 $c->request->_read_length;
622 =head2 $self->prepare_request(@arguments)
624 Populate the context object from the request object.
628 sub prepare_request {
629 my ($self, $ctx, %args) = @_;
630 $ctx->log->psgienv($args{env}) if $ctx->log->can('psgienv');
631 $ctx->request->_set_env($args{env});
632 $self->_set_env($args{env}); # Nasty back compat!
633 $ctx->response->_set_response_cb($args{response_cb});
636 =head2 $self->prepare_uploads($c)
640 sub prepare_uploads {
641 my ( $self, $c ) = @_;
643 my $request = $c->request;
644 return unless $request->_body;
646 my $uploads = $request->_body->upload;
647 my $parameters = $request->parameters;
648 foreach my $name (keys %$uploads) {
649 my $files = $uploads->{$name};
651 for my $upload (ref $files eq 'ARRAY' ? @$files : ($files)) {
652 my $headers = HTTP::Headers->new( %{ $upload->{headers} } );
653 my $u = Catalyst::Request::Upload->new
655 size => $upload->{size},
656 type => scalar $headers->content_type,
658 tempname => $upload->{tempname},
659 filename => $upload->{filename},
663 $request->uploads->{$name} = @uploads > 1 ? \@uploads : $uploads[0];
665 # support access to the filename as a normal param
666 my @filenames = map { $_->{filename} } @uploads;
667 # append, if there's already params with this name
668 if (exists $parameters->{$name}) {
669 if (ref $parameters->{$name} eq 'ARRAY') {
670 push @{ $parameters->{$name} }, @filenames;
673 $parameters->{$name} = [ $parameters->{$name}, @filenames ];
677 $parameters->{$name} = @filenames > 1 ? \@filenames : $filenames[0];
682 =head2 $self->write($c, $buffer)
684 Writes the buffer to the client.
689 my ( $self, $c, $buffer ) = @_;
691 $c->response->write($buffer);
694 =head2 $self->read($c, [$maxlength])
696 Reads from the input stream by calling C<< $self->read_chunk >>.
698 Maintains the read_length and read_position counters as data is read.
703 my ( $self, $c, $maxlength ) = @_;
705 $c->request->read($maxlength);
708 =head2 $self->read_chunk($c, \$buffer, $length)
710 Each engine implements read_chunk as its preferred way of reading a chunk
711 of data. Returns the number of bytes read. A return of 0 indicates that
712 there is no more data to be read.
717 my ($self, $ctx) = (shift, shift);
718 return $ctx->request->read_chunk(@_);
721 =head2 $self->run($app, $server)
723 Start the engine. Builds a PSGI application and calls the
724 run method on the server passed in, which then causes the
725 engine to loop, handling requests..
730 my ($self, $app, $psgi, @args) = @_;
731 # @args left here rather than just a $options, $server for back compat with the
732 # old style scripts which send a few args, then a hashref
734 # They should never actually be used in the normal case as the Plack engine is
735 # passed in got all the 'standard' args via the loader in the script already.
737 # FIXME - we should stash the options in an attribute so that custom args
738 # like Gitalist's --git_dir are possible to get from the app without stupid tricks.
739 my $server = pop @args if (scalar @args && blessed $args[-1]);
740 my $options = pop @args if (scalar @args && ref($args[-1]) eq 'HASH');
741 # Back compat hack for applications with old (non Catalyst::Script) scripts to work in FCGI.
742 if (scalar @args && !ref($args[0])) {
743 if (my $listen = shift @args) {
744 $options->{listen} ||= [$listen];
748 $server = Catalyst::EngineLoader->new(application_name => ref($self))->auto(%$options);
749 # We're not being called from a script, so auto detect what backend to
750 # run on. This should never happen, as mod_perl never calls ->run,
751 # instead the $app->handle method is called per request.
752 $app->log->warn("Not supplied a Plack engine, falling back to engine auto-loader (are your scripts ancient?)")
754 $app->run_options($options);
755 $server->run($psgi, $options);
758 =head2 build_psgi_app ($app, @args)
760 Builds and returns a PSGI application closure. (Raw, not wrapped in middleware)
765 my ($self, $app, @args) = @_;
772 confess("Did not get a response callback for writer, cannot continue") unless $respond;
773 $app->handle_request(env => $env, response_cb => $respond);
778 =head2 $self->unescape_uri($uri)
780 Unescapes a given URI using the most efficient method available. Engines such
781 as Apache may implement this using Apache's C-based modules, for example.
786 my ( $self, $str ) = @_;
788 $str =~ s/(?:%([0-9A-Fa-f]{2})|\+)/defined $1 ? chr(hex($1)) : ' '/eg;
793 =head2 $self->finalize_output
795 <obsolete>, see finalize_body
799 Hash containing environment variables including many special variables inserted
800 by WWW server - like SERVER_*, REMOTE_*, HTTP_* ...
802 Before accessing environment variables consider whether the same information is
803 not directly available via Catalyst objects $c->request, $c->engine ...
805 BEWARE: If you really need to access some environment variable from your Catalyst
806 application you should use $c->engine->env->{VARNAME} instead of $ENV{VARNAME},
807 as in some environments the %ENV hash does not contain what you would expect.
811 Catalyst Contributors, see Catalyst.pm
815 This library is free software. You can redistribute it and/or modify it under
816 the same terms as Perl itself.
820 __PACKAGE__->meta->make_immutable;