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;
88 if(blessed($body) && $body->can('read') or ref($body) eq 'GLOB') {
89 # Body is a filehandle like thingy. We can jusrt send this along
90 # to plack without changing it.
92 # Looks like for backcompat reasons we need to be able to deal
93 # with stringyfiable objects.
94 $body = "$body" if blessed($body); # Assume there's some sort of overloading..
101 $res->_response_cb->([ $res->status, \@headers, $body]);
102 $res->_clear_response_cb;
105 ## Now, if there's no response callback anymore, that means someone has
106 ## called ->write in order to stream 'some stuff along the way'. I think
107 ## for backcompat we still need to handle a ->body. I guess I could see
108 ## someone calling ->write to presend some stuff, and then doing the rest
109 ## via ->body, like in a template.
111 ## We'll just use the old, existing code for this (or most of it)
113 if(my $body = $res->body) {
114 no warnings 'uninitialized';
115 if ( blessed($body) && $body->can('read') or ref($body) eq 'GLOB' ) {
117 ## In this case we have no choice and will fall back on the old
118 ## manual streaming stuff.
122 $got = read $body, my ($buffer), $CHUNKSIZE;
123 $got = 0 unless $self->write($c, $buffer );
129 $self->write($c, $body );
133 $res->_writer->close;
140 =head2 $self->finalize_cookies($c)
142 Create CGI::Simple::Cookie objects from $c->res->cookies, and set them as
147 sub finalize_cookies {
148 my ( $self, $c ) = @_;
151 my $response = $c->response;
153 foreach my $name (keys %{ $response->cookies }) {
155 my $val = $response->cookies->{$name};
160 : CGI::Simple::Cookie->new(
162 -value => $val->{value},
163 -expires => $val->{expires},
164 -domain => $val->{domain},
165 -path => $val->{path},
166 -secure => $val->{secure} || 0,
167 -httponly => $val->{httponly} || 0,
170 if (!defined $cookie) {
171 $c->log->warn("undef passed in '$name' cookie value - not setting cookie")
176 push @cookies, $cookie->as_string;
179 for my $cookie (@cookies) {
180 $response->headers->push_header( 'Set-Cookie' => $cookie );
184 =head2 $self->finalize_error($c)
186 Output an appropriate error message. Called if there's an error in $c
187 after the dispatch has finished. Will output debug messages if Catalyst
188 is in debug mode, or a `please come back later` message otherwise.
192 sub _dump_error_page_element {
193 my ($self, $i, $element) = @_;
194 my ($name, $val) = @{ $element };
196 # This is fugly, but the metaclass is _HUGE_ and demands waaay too much
197 # scrolling. Suggestions for more pleasant ways to do this welcome.
198 local $val->{'__MOP__'} = "Stringified: "
199 . $val->{'__MOP__'} if ref $val eq 'HASH' && exists $val->{'__MOP__'};
201 my $text = encode_entities( dump( $val ));
202 sprintf <<"EOF", $name, $text;
203 <h2><a href="#" onclick="toggleDump('dump_$i'); return false">%s</a></h2>
205 <pre wrap="">%s</pre>
211 my ( $self, $c ) = @_;
213 $c->res->content_type('text/html; charset=utf-8');
214 my $name = ref($c)->config->{name} || join(' ', split('::', ref $c));
216 # Prevent Catalyst::Plugin::Unicode::Encoding from running.
217 # This is a little nasty, but it's the best way to be clean whether or
218 # not the user has an encoding plugin.
220 if ($c->can('encoding')) {
224 my ( $title, $error, $infos );
228 $error = join '', map {
229 '<p><code class="error">'
230 . encode_entities($_)
233 $error ||= 'No output';
234 $error = qq{<pre wrap="">$error</pre>};
235 $title = $name = "$name on Catalyst $Catalyst::VERSION";
236 $name = "<h1>$name</h1>";
238 # Don't show context in the dump
239 $c->res->_clear_context;
241 # Don't show body parser in the dump
242 $c->req->_clear_body;
246 for my $dump ( $c->dump_these ) {
247 push @infos, $self->_dump_error_page_element($i, $dump);
250 $infos = join "\n", @infos;
257 (en) Please come back later
258 (fr) SVP veuillez revenir plus tard
259 (de) Bitte versuchen sie es spaeter nocheinmal
260 (at) Konnten's bitt'schoen spaeter nochmal reinschauen
261 (no) Vennligst prov igjen senere
262 (dk) Venligst prov igen senere
263 (pl) Prosze sprobowac pozniej
264 (pt) Por favor volte mais tarde
265 (ru) Попробуйте еще раз позже
266 (ua) Спробуйте ще раз пізніше
271 $c->res->body( <<"" );
272 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
273 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
274 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
276 <meta http-equiv="Content-Language" content="en" />
277 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
278 <title>$title</title>
279 <script type="text/javascript">
281 function toggleDump (dumpElement) {
282 var e = document.getElementById( dumpElement );
283 if (e.style.display == "none") {
284 e.style.display = "";
287 e.style.display = "none";
292 <style type="text/css">
294 font-family: "Bitstream Vera Sans", "Trebuchet MS", Verdana,
295 Tahoma, Arial, helvetica, sans-serif;
297 background-color: #eee;
301 :link, :link:hover, :visited, :visited:hover {
306 background-color: #ccc;
307 border: 1px solid #aaa;
312 background-color: #cce;
313 border: 1px solid #755;
319 background-color: #eee;
320 border: 1px solid #575;
326 background-color: #cce;
327 border: 1px solid #557;
336 div.name h1, div.error p {
344 text-decoration: underline;
350 /* from http://users.tkk.fi/~tkarvine/linux/doc/pre-wrap/pre-wrap-css3-mozilla-opera-ie.html */
351 /* Browser specific (not valid) styles to make preformatted text wrap */
353 white-space: pre-wrap; /* css-3 */
354 white-space: -moz-pre-wrap; /* Mozilla, since 1999 */
355 white-space: -pre-wrap; /* Opera 4-6 */
356 white-space: -o-pre-wrap; /* Opera 7 */
357 word-wrap: break-word; /* Internet Explorer 5.5+ */
363 <div class="error">$error</div>
364 <div class="infos">$infos</div>
365 <div class="name">$name</div>
370 # Trick IE. Old versions of IE would display their own error page instead
371 # of ours if we'd give it less than 512 bytes.
372 $c->res->{body} .= ( ' ' x 512 );
374 $c->res->{body} = Encode::encode("UTF-8", $c->res->{body});
377 $c->res->status(500);
380 =head2 $self->finalize_headers($c)
382 Allows engines to write headers to response
386 sub finalize_headers {
387 my ($self, $ctx) = @_;
389 $ctx->finalize_headers unless $ctx->response->finalized_headers;
393 =head2 $self->finalize_uploads($c)
395 Clean up after uploads, deleting temp files.
399 sub finalize_uploads {
400 my ( $self, $c ) = @_;
402 # N.B. This code is theoretically entirely unneeded due to ->cleanup(1)
403 # on the HTTP::Body object.
404 my $request = $c->request;
405 foreach my $key (keys %{ $request->uploads }) {
406 my $upload = $request->uploads->{$key};
407 unlink grep { -e $_ } map { $_->tempname }
408 (ref $upload eq 'ARRAY' ? @{$upload} : ($upload));
413 =head2 $self->prepare_body($c)
415 sets up the L<Catalyst::Request> object body using L<HTTP::Body>
420 my ( $self, $c ) = @_;
422 $c->request->prepare_body;
425 =head2 $self->prepare_body_chunk($c)
427 Add a chunk to the request body.
431 # XXX - Can this be deleted?
432 sub prepare_body_chunk {
433 my ( $self, $c, $chunk ) = @_;
435 $c->request->prepare_body_chunk($chunk);
438 =head2 $self->prepare_body_parameters($c)
440 Sets up parameters from body.
444 sub prepare_body_parameters {
445 my ( $self, $c ) = @_;
447 $c->request->prepare_body_parameters;
450 =head2 $self->prepare_parameters($c)
452 Sets up parameters from query and post parameters.
453 If parameters have already been set up will clear
454 existing parameters and set up again.
458 sub prepare_parameters {
459 my ( $self, $c ) = @_;
461 $c->request->_clear_parameters;
462 return $c->request->parameters;
465 =head2 $self->prepare_path($c)
467 abstract method, implemented by engines.
472 my ($self, $ctx) = @_;
474 my $env = $ctx->request->env;
476 my $scheme = $ctx->request->secure ? 'https' : 'http';
477 my $host = $env->{HTTP_HOST} || $env->{SERVER_NAME};
478 my $port = $env->{SERVER_PORT} || 80;
479 my $base_path = $env->{SCRIPT_NAME} || "/";
481 # set the request URI
483 if (!$ctx->config->{use_request_uri_for_path}) {
484 my $path_info = $env->{PATH_INFO};
485 if ( exists $env->{REDIRECT_URL} ) {
486 $base_path = $env->{REDIRECT_URL};
487 $base_path =~ s/\Q$path_info\E$//;
489 $path = $base_path . $path_info;
491 $path =~ s/([^$URI::uric])/$URI::Escape::escapes{$1}/go;
492 $path =~ s/\?/%3F/g; # STUPID STUPID SPECIAL CASE
495 my $req_uri = $env->{REQUEST_URI};
496 $req_uri =~ s/\?.*$//;
501 # Using URI directly is way too slow, so we construct the URLs manually
502 my $uri_class = "URI::$scheme";
504 # HTTP_HOST will include the port even if it's 80/443
505 $host =~ s/:(?:80|443)$//;
507 if ($port !~ /^(?:80|443)$/ && $host !~ /:/) {
511 my $query = $env->{QUERY_STRING} ? '?' . $env->{QUERY_STRING} : '';
512 my $uri = $scheme . '://' . $host . '/' . $path . $query;
514 $ctx->request->uri( (bless \$uri, $uri_class)->canonical );
517 # base must end in a slash
518 $base_path .= '/' unless $base_path =~ m{/$};
520 my $base_uri = $scheme . '://' . $host . $base_path;
522 $ctx->request->base( bless \$base_uri, $uri_class );
527 =head2 $self->prepare_request($c)
529 =head2 $self->prepare_query_parameters($c)
531 process the query string and extract query parameters.
535 sub prepare_query_parameters {
537 my $env = $c->request->env;
539 if(my $query_obj = $env->{'plack.request.query'}) {
540 $c->request->query_parameters(
541 $c->request->_use_hash_multivalue ?
543 $query_obj->as_hashref_mixed);
547 my $query_string = exists $env->{QUERY_STRING}
548 ? $env->{QUERY_STRING}
551 # Check for keywords (no = signs)
552 # (yes, index() is faster than a regex :))
553 if ( index( $query_string, '=' ) < 0 ) {
554 $c->request->query_keywords($self->unescape_uri($query_string));
560 # replace semi-colons
561 $query_string =~ s/;/&/g;
563 my @params = grep { length $_ } split /&/, $query_string;
565 for my $item ( @params ) {
568 = map { $self->unescape_uri($_) }
569 split( /=/, $item, 2 );
571 $param = $self->unescape_uri($item) unless defined $param;
573 if ( exists $query{$param} ) {
574 if ( ref $query{$param} ) {
575 push @{ $query{$param} }, $value;
578 $query{$param} = [ $query{$param}, $value ];
582 $query{$param} = $value;
586 $c->request->query_parameters(
587 $c->request->_use_hash_multivalue ?
588 Hash::MultiValue->from_mixed(\%query) :
592 =head2 $self->prepare_read($c)
594 Prepare to read by initializing the Content-Length from headers.
599 my ( $self, $c ) = @_;
601 # Initialize the amount of data we think we need to read
602 $c->request->_read_length;
605 =head2 $self->prepare_request(@arguments)
607 Populate the context object from the request object.
611 sub prepare_request {
612 my ($self, $ctx, %args) = @_;
613 $ctx->log->psgienv($args{env}) if $ctx->log->can('psgienv');
614 $ctx->request->_set_env($args{env});
615 $self->_set_env($args{env}); # Nasty back compat!
616 $ctx->response->_set_response_cb($args{response_cb});
619 =head2 $self->prepare_uploads($c)
623 sub prepare_uploads {
624 my ( $self, $c ) = @_;
626 my $request = $c->request;
627 return unless $request->_body;
629 my $uploads = $request->_body->upload;
630 my $parameters = $request->parameters;
631 foreach my $name (keys %$uploads) {
632 my $files = $uploads->{$name};
634 for my $upload (ref $files eq 'ARRAY' ? @$files : ($files)) {
635 my $headers = HTTP::Headers->new( %{ $upload->{headers} } );
636 my $u = Catalyst::Request::Upload->new
638 size => $upload->{size},
639 type => scalar $headers->content_type,
641 tempname => $upload->{tempname},
642 filename => $upload->{filename},
646 $request->uploads->{$name} = @uploads > 1 ? \@uploads : $uploads[0];
648 # support access to the filename as a normal param
649 my @filenames = map { $_->{filename} } @uploads;
650 # append, if there's already params with this name
651 if (exists $parameters->{$name}) {
652 if (ref $parameters->{$name} eq 'ARRAY') {
653 push @{ $parameters->{$name} }, @filenames;
656 $parameters->{$name} = [ $parameters->{$name}, @filenames ];
660 $parameters->{$name} = @filenames > 1 ? \@filenames : $filenames[0];
665 =head2 $self->write($c, $buffer)
667 Writes the buffer to the client.
672 my ( $self, $c, $buffer ) = @_;
674 $c->response->write($buffer);
677 =head2 $self->read($c, [$maxlength])
679 Reads from the input stream by calling C<< $self->read_chunk >>.
681 Maintains the read_length and read_position counters as data is read.
686 my ( $self, $c, $maxlength ) = @_;
688 $c->request->read($maxlength);
691 =head2 $self->read_chunk($c, \$buffer, $length)
693 Each engine implements read_chunk as its preferred way of reading a chunk
694 of data. Returns the number of bytes read. A return of 0 indicates that
695 there is no more data to be read.
700 my ($self, $ctx) = (shift, shift);
701 return $ctx->request->read_chunk(@_);
704 =head2 $self->run($app, $server)
706 Start the engine. Builds a PSGI application and calls the
707 run method on the server passed in, which then causes the
708 engine to loop, handling requests..
713 my ($self, $app, $psgi, @args) = @_;
714 # @args left here rather than just a $options, $server for back compat with the
715 # old style scripts which send a few args, then a hashref
717 # They should never actually be used in the normal case as the Plack engine is
718 # passed in got all the 'standard' args via the loader in the script already.
720 # FIXME - we should stash the options in an attribute so that custom args
721 # like Gitalist's --git_dir are possible to get from the app without stupid tricks.
722 my $server = pop @args if (scalar @args && blessed $args[-1]);
723 my $options = pop @args if (scalar @args && ref($args[-1]) eq 'HASH');
724 # Back compat hack for applications with old (non Catalyst::Script) scripts to work in FCGI.
725 if (scalar @args && !ref($args[0])) {
726 if (my $listen = shift @args) {
727 $options->{listen} ||= [$listen];
731 $server = Catalyst::EngineLoader->new(application_name => ref($self))->auto(%$options);
732 # We're not being called from a script, so auto detect what backend to
733 # run on. This should never happen, as mod_perl never calls ->run,
734 # instead the $app->handle method is called per request.
735 $app->log->warn("Not supplied a Plack engine, falling back to engine auto-loader (are your scripts ancient?)")
737 $app->run_options($options);
738 $server->run($psgi, $options);
741 =head2 build_psgi_app ($app, @args)
743 Builds and returns a PSGI application closure. (Raw, not wrapped in middleware)
748 my ($self, $app, @args) = @_;
755 confess("Did not get a response callback for writer, cannot continue") unless $respond;
756 $app->handle_request(env => $env, response_cb => $respond);
761 =head2 $self->unescape_uri($uri)
763 Unescapes a given URI using the most efficient method available. Engines such
764 as Apache may implement this using Apache's C-based modules, for example.
769 my ( $self, $str ) = @_;
771 $str =~ s/(?:%([0-9A-Fa-f]{2})|\+)/defined $1 ? chr(hex($1)) : ' '/eg;
776 =head2 $self->finalize_output
778 <obsolete>, see finalize_body
782 Hash containing environment variables including many special variables inserted
783 by WWW server - like SERVER_*, REMOTE_*, HTTP_* ...
785 Before accessing environment variables consider whether the same information is
786 not directly available via Catalyst objects $c->request, $c->engine ...
788 BEWARE: If you really need to access some environment variable from your Catalyst
789 application you should use $c->engine->env->{VARNAME} instead of $ENV{VARNAME},
790 as in some environments the %ENV hash does not contain what you would expect.
794 Catalyst Contributors, see Catalyst.pm
798 This library is free software. You can redistribute it and/or modify it under
799 the same terms as Perl itself.
803 __PACKAGE__->meta->make_immutable;