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;
18 use namespace::clean -except => 'meta';
20 # Amount of data to read from input on each pass
21 our $CHUNKSIZE = 64 * 1024;
23 # XXX - this is only here for compat, do not use!
24 has env => ( is => 'rw', writer => '_set_env' );
25 my $WARN_ABOUT_ENV = 0;
27 my ($orig, $self, @args) = @_;
29 warn "env as a writer is deprecated, you probably need to upgrade Catalyst::Engine::PSGI"
30 unless $WARN_ABOUT_ENV++;
31 return $self->_set_env(@args);
36 # XXX - Only here for Engine::PSGI compat
37 sub prepare_connection {
38 my ($self, $ctx) = @_;
39 $ctx->request->prepare_connection;
44 Catalyst::Engine - The Catalyst Engine
55 =head2 $self->finalize_body($c)
57 Finalize body. Prints the response output.
62 my ( $self, $c ) = @_;
63 my $body = $c->response->body;
64 no warnings 'uninitialized';
65 if ( blessed($body) && $body->can('read') or ref($body) eq 'GLOB' ) {
68 $got = read $body, my ($buffer), $CHUNKSIZE;
69 $got = 0 unless $self->write( $c, $buffer );
75 $self->write( $c, $body );
78 my $res = $c->response;
85 =head2 $self->finalize_cookies($c)
87 Create CGI::Simple::Cookie objects from $c->res->cookies, and set them as
92 sub finalize_cookies {
93 my ( $self, $c ) = @_;
96 my $response = $c->response;
98 foreach my $name (keys %{ $response->cookies }) {
100 my $val = $response->cookies->{$name};
105 : CGI::Simple::Cookie->new(
107 -value => $val->{value},
108 -expires => $val->{expires},
109 -domain => $val->{domain},
110 -path => $val->{path},
111 -secure => $val->{secure} || 0,
112 -httponly => $val->{httponly} || 0,
115 if (!defined $cookie) {
116 $c->log->warn("undef passed in '$name' cookie value - not setting cookie")
121 push @cookies, $cookie->as_string;
124 for my $cookie (@cookies) {
125 $response->headers->push_header( 'Set-Cookie' => $cookie );
129 =head2 $self->finalize_error($c)
131 Output an appropriate error message. Called if there's an error in $c
132 after the dispatch has finished. Will output debug messages if Catalyst
133 is in debug mode, or a `please come back later` message otherwise.
137 sub _dump_error_page_element {
138 my ($self, $i, $element) = @_;
139 my ($name, $val) = @{ $element };
141 # This is fugly, but the metaclass is _HUGE_ and demands waaay too much
142 # scrolling. Suggestions for more pleasant ways to do this welcome.
143 local $val->{'__MOP__'} = "Stringified: "
144 . $val->{'__MOP__'} if ref $val eq 'HASH' && exists $val->{'__MOP__'};
146 my $text = encode_entities( dump( $val ));
147 sprintf <<"EOF", $name, $text;
148 <h2><a href="#" onclick="toggleDump('dump_$i'); return false">%s</a></h2>
150 <pre wrap="">%s</pre>
156 my ( $self, $c ) = @_;
158 $c->res->content_type('text/html; charset=utf-8');
159 my $name = ref($c)->config->{name} || join(' ', split('::', ref $c));
161 # Prevent Catalyst::Plugin::Unicode::Encoding from running.
162 # This is a little nasty, but it's the best way to be clean whether or
163 # not the user has an encoding plugin.
165 if ($c->can('encoding')) {
169 my ( $title, $error, $infos );
173 $error = join '', map {
174 '<p><code class="error">'
175 . encode_entities($_)
178 $error ||= 'No output';
179 $error = qq{<pre wrap="">$error</pre>};
180 $title = $name = "$name on Catalyst $Catalyst::VERSION";
181 $name = "<h1>$name</h1>";
183 # Don't show body parser in the dump
184 $c->req->_clear_body;
188 for my $dump ( $c->dump_these ) {
189 push @infos, $self->_dump_error_page_element($i, $dump);
192 $infos = join "\n", @infos;
199 (en) Please come back later
200 (fr) SVP veuillez revenir plus tard
201 (de) Bitte versuchen sie es spaeter nocheinmal
202 (at) Konnten's bitt'schoen spaeter nochmal reinschauen
203 (no) Vennligst prov igjen senere
204 (dk) Venligst prov igen senere
205 (pl) Prosze sprobowac pozniej
206 (pt) Por favor volte mais tarde
207 (ru) Попробуйте еще раз позже
208 (ua) Спробуйте ще раз пізніше
213 $c->res->body( <<"" );
214 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
215 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
216 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
218 <meta http-equiv="Content-Language" content="en" />
219 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
220 <title>$title</title>
221 <script type="text/javascript">
223 function toggleDump (dumpElement) {
224 var e = document.getElementById( dumpElement );
225 if (e.style.display == "none") {
226 e.style.display = "";
229 e.style.display = "none";
234 <style type="text/css">
236 font-family: "Bitstream Vera Sans", "Trebuchet MS", Verdana,
237 Tahoma, Arial, helvetica, sans-serif;
239 background-color: #eee;
243 :link, :link:hover, :visited, :visited:hover {
248 background-color: #ccc;
249 border: 1px solid #aaa;
254 background-color: #cce;
255 border: 1px solid #755;
261 background-color: #eee;
262 border: 1px solid #575;
268 background-color: #cce;
269 border: 1px solid #557;
278 div.name h1, div.error p {
286 text-decoration: underline;
292 /* from http://users.tkk.fi/~tkarvine/linux/doc/pre-wrap/pre-wrap-css3-mozilla-opera-ie.html */
293 /* Browser specific (not valid) styles to make preformatted text wrap */
295 white-space: pre-wrap; /* css-3 */
296 white-space: -moz-pre-wrap; /* Mozilla, since 1999 */
297 white-space: -pre-wrap; /* Opera 4-6 */
298 white-space: -o-pre-wrap; /* Opera 7 */
299 word-wrap: break-word; /* Internet Explorer 5.5+ */
305 <div class="error">$error</div>
306 <div class="infos">$infos</div>
307 <div class="name">$name</div>
312 # Trick IE. Old versions of IE would display their own error page instead
313 # of ours if we'd give it less than 512 bytes.
314 $c->res->{body} .= ( ' ' x 512 );
316 $c->res->{body} = Encode::encode("UTF-8", $c->res->{body});
319 $c->res->status(500);
322 =head2 $self->finalize_headers($c)
324 Allows engines to write headers to response
328 sub finalize_headers {
329 my ($self, $ctx) = @_;
331 $ctx->response->finalize_headers;
335 =head2 $self->finalize_uploads($c)
337 Clean up after uploads, deleting temp files.
341 sub finalize_uploads {
342 my ( $self, $c ) = @_;
344 # N.B. This code is theoretically entirely unneeded due to ->cleanup(1)
345 # on the HTTP::Body object.
346 my $request = $c->request;
347 foreach my $key (keys %{ $request->uploads }) {
348 my $upload = $request->uploads->{$key};
349 unlink grep { -e $_ } map { $_->tempname }
350 (ref $upload eq 'ARRAY' ? @{$upload} : ($upload));
355 =head2 $self->prepare_body($c)
357 sets up the L<Catalyst::Request> object body using L<HTTP::Body>
362 my ( $self, $c ) = @_;
364 $c->request->prepare_body;
367 =head2 $self->prepare_body_chunk($c)
369 Add a chunk to the request body.
373 # XXX - Can this be deleted?
374 sub prepare_body_chunk {
375 my ( $self, $c, $chunk ) = @_;
377 $c->request->prepare_body_chunk($chunk);
380 =head2 $self->prepare_body_parameters($c)
382 Sets up parameters from body.
386 sub prepare_body_parameters {
387 my ( $self, $c ) = @_;
389 $c->request->prepare_body_parameters;
392 =head2 $self->prepare_parameters($c)
394 sets up parameters from query and post parameters.
398 sub prepare_parameters {
399 my ( $self, $c ) = @_;
401 $c->request->parameters;
404 =head2 $self->prepare_path($c)
406 abstract method, implemented by engines.
411 my ($self, $ctx) = @_;
413 my $env = $ctx->request->env;
415 my $scheme = $ctx->request->secure ? 'https' : 'http';
416 my $host = $env->{HTTP_HOST} || $env->{SERVER_NAME};
417 my $port = $env->{SERVER_PORT} || 80;
418 my $base_path = $env->{SCRIPT_NAME} || "/";
420 # set the request URI
422 if (!$ctx->config->{use_request_uri_for_path}) {
423 my $path_info = $env->{PATH_INFO};
424 if ( exists $env->{REDIRECT_URL} ) {
425 $base_path = $env->{REDIRECT_URL};
426 $base_path =~ s/\Q$path_info\E$//;
428 $path = $base_path . $path_info;
430 $path =~ s/([^$URI::uric])/$URI::Escape::escapes{$1}/go;
431 $path =~ s/\?/%3F/g; # STUPID STUPID SPECIAL CASE
434 my $req_uri = $env->{REQUEST_URI};
435 $req_uri =~ s/\?.*$//;
440 # Using URI directly is way too slow, so we construct the URLs manually
441 my $uri_class = "URI::$scheme";
443 # HTTP_HOST will include the port even if it's 80/443
444 $host =~ s/:(?:80|443)$//;
446 if ($port !~ /^(?:80|443)$/ && $host !~ /:/) {
450 my $query = $env->{QUERY_STRING} ? '?' . $env->{QUERY_STRING} : '';
451 my $uri = $scheme . '://' . $host . '/' . $path . $query;
453 $ctx->request->uri( (bless \$uri, $uri_class)->canonical );
456 # base must end in a slash
457 $base_path .= '/' unless $base_path =~ m{/$};
459 my $base_uri = $scheme . '://' . $host . $base_path;
461 $ctx->request->base( bless \$base_uri, $uri_class );
466 =head2 $self->prepare_request($c)
468 =head2 $self->prepare_query_parameters($c)
470 process the query string and extract query parameters.
474 sub prepare_query_parameters {
477 my $env = $c->request->env;
478 my $query_string = exists $env->{QUERY_STRING}
479 ? $env->{QUERY_STRING}
482 # Check for keywords (no = signs)
483 # (yes, index() is faster than a regex :))
484 if ( index( $query_string, '=' ) < 0 ) {
485 $c->request->query_keywords( $self->unescape_uri($query_string) );
491 # replace semi-colons
492 $query_string =~ s/;/&/g;
494 my @params = grep { length $_ } split /&/, $query_string;
496 for my $item ( @params ) {
499 = map { $self->unescape_uri($_) }
500 split( /=/, $item, 2 );
502 $param = $self->unescape_uri($item) unless defined $param;
504 if ( exists $query{$param} ) {
505 if ( ref $query{$param} ) {
506 push @{ $query{$param} }, $value;
509 $query{$param} = [ $query{$param}, $value ];
513 $query{$param} = $value;
516 $c->request->query_parameters( \%query );
519 =head2 $self->prepare_read($c)
521 Prepare to read by initializing the Content-Length from headers.
526 my ( $self, $c ) = @_;
528 # Initialize the amount of data we think we need to read
529 $c->request->_read_length;
532 =head2 $self->prepare_request(@arguments)
534 Populate the context object from the request object.
538 sub prepare_request {
539 my ($self, $ctx, %args) = @_;
540 $ctx->request->_set_env($args{env});
541 $self->_set_env($args{env}); # Nasty back compat!
542 $ctx->response->_set_response_cb($args{response_cb});
545 =head2 $self->prepare_uploads($c)
549 sub prepare_uploads {
550 my ( $self, $c ) = @_;
552 my $request = $c->request;
553 return unless $request->_body;
555 my $uploads = $request->_body->upload;
556 my $parameters = $request->parameters;
557 foreach my $name (keys %$uploads) {
558 my $files = $uploads->{$name};
560 for my $upload (ref $files eq 'ARRAY' ? @$files : ($files)) {
561 my $headers = HTTP::Headers->new( %{ $upload->{headers} } );
562 my $u = Catalyst::Request::Upload->new
564 size => $upload->{size},
565 type => scalar $headers->content_type,
567 tempname => $upload->{tempname},
568 filename => $upload->{filename},
572 $request->uploads->{$name} = @uploads > 1 ? \@uploads : $uploads[0];
574 # support access to the filename as a normal param
575 my @filenames = map { $_->{filename} } @uploads;
576 # append, if there's already params with this name
577 if (exists $parameters->{$name}) {
578 if (ref $parameters->{$name} eq 'ARRAY') {
579 push @{ $parameters->{$name} }, @filenames;
582 $parameters->{$name} = [ $parameters->{$name}, @filenames ];
586 $parameters->{$name} = @filenames > 1 ? \@filenames : $filenames[0];
591 =head2 $self->write($c, $buffer)
593 Writes the buffer to the client.
598 my ( $self, $c, $buffer ) = @_;
600 $c->response->write($buffer);
603 =head2 $self->read($c, [$maxlength])
605 Reads from the input stream by calling C<< $self->read_chunk >>.
607 Maintains the read_length and read_position counters as data is read.
612 my ( $self, $c, $maxlength ) = @_;
614 $c->request->read($maxlength);
617 =head2 $self->read_chunk($c, \$buffer, $length)
619 Each engine implements read_chunk as its preferred way of reading a chunk
620 of data. Returns the number of bytes read. A return of 0 indicates that
621 there is no more data to be read.
626 my ($self, $ctx) = (shift, shift);
627 return $ctx->request->read_chunk(@_);
630 =head2 $self->run($app, $server)
632 Start the engine. Builds a PSGI application and calls the
633 run method on the server passed in, which then causes the
634 engine to loop, handling requests..
639 my ($self, $app, $psgi, @args) = @_;
640 # @args left here rather than just a $options, $server for back compat with the
641 # old style scripts which send a few args, then a hashref
643 # They should never actually be used in the normal case as the Plack engine is
644 # passed in got all the 'standard' args via the loader in the script already.
646 # FIXME - we should stash the options in an attribute so that custom args
647 # like Gitalist's --git_dir are possible to get from the app without stupid tricks.
648 my $server = pop @args if (scalar @args && blessed $args[-1]);
649 my $options = pop @args if (scalar @args && ref($args[-1]) eq 'HASH');
650 # Back compat hack for applications with old (non Catalyst::Script) scripts to work in FCGI.
651 if (scalar @args && !ref($args[0])) {
652 if (my $listen = shift @args) {
653 $options->{listen} ||= [$listen];
657 $server = Catalyst::EngineLoader->new(application_name => ref($self))->auto(%$options);
658 # We're not being called from a script, so auto detect what backend to
659 # run on. This should never happen, as mod_perl never calls ->run,
660 # instead the $app->handle method is called per request.
661 $app->log->warn("Not supplied a Plack engine, falling back to engine auto-loader (are your scripts ancient?)")
663 $app->run_options($options);
664 $server->run($psgi, $options);
667 =head2 build_psgi_app ($app, @args)
669 Builds and returns a PSGI application closure. (Raw, not wrapped in middleware)
674 my ($self, $app, @args) = @_;
681 $app->handle_request(env => $env, response_cb => $respond);
686 =head2 $self->unescape_uri($uri)
688 Unescapes a given URI using the most efficient method available. Engines such
689 as Apache may implement this using Apache's C-based modules, for example.
694 my ( $self, $str ) = @_;
696 $str =~ s/(?:%([0-9A-Fa-f]{2})|\+)/defined $1 ? chr(hex($1)) : ' '/eg;
701 =head2 $self->finalize_output
703 <obsolete>, see finalize_body
707 Hash containing environment variables including many special variables inserted
708 by WWW server - like SERVER_*, REMOTE_*, HTTP_* ...
710 Before accessing environment variables consider whether the same information is
711 not directly available via Catalyst objects $c->request, $c->engine ...
713 BEWARE: If you really need to access some environment variable from your Catalyst
714 application you should use $c->engine->env->{VARNAME} instead of $ENV{VARNAME},
715 as in some environments the %ENV hash does not contain what you would expect.
719 Catalyst Contributors, see Catalyst.pm
723 This library is free software. You can redistribute it and/or modify it under
724 the same terms as Perl itself.