1 package Catalyst::Engine;
4 use base 'Class::Accessor::Fast';
5 use CGI::Simple::Cookie;
6 use Data::Dump qw/dump/;
13 # input position and length
14 __PACKAGE__->mk_accessors(qw/read_position read_length/);
17 use overload '""' => sub { return ref shift }, fallback => 1;
19 # Amount of data to read from input on each pass
20 our $CHUNKSIZE = 64 * 1024;
24 Catalyst::Engine - The Catalyst Engine
35 =head2 $self->finalize_body($c)
37 Finalize body. Prints the response output.
42 my ( $self, $c ) = @_;
43 my $body = $c->response->body;
44 no warnings 'uninitialized';
45 if ( Scalar::Util::blessed($body) && $body->can('read') or ref($body) eq 'GLOB' ) {
46 while ( !eof $body ) {
47 read $body, my ($buffer), $CHUNKSIZE;
48 last unless $self->write( $c, $buffer );
53 $self->write( $c, $body );
57 =head2 $self->finalize_cookies($c)
59 Create CGI::Simple::Cookie objects from $c->res->cookies, and set them as
64 sub finalize_cookies {
65 my ( $self, $c ) = @_;
69 foreach my $name ( keys %{ $c->response->cookies } ) {
71 my $val = $c->response->cookies->{$name};
74 Scalar::Util::blessed($val)
76 : CGI::Simple::Cookie->new(
78 -value => $val->{value},
79 -expires => $val->{expires},
80 -domain => $val->{domain},
81 -path => $val->{path},
82 -secure => $val->{secure} || 0
86 push @cookies, $cookie->as_string;
89 for my $cookie (@cookies) {
90 $c->res->headers->push_header( 'Set-Cookie' => $cookie );
94 =head2 $self->finalize_error($c)
96 Output an apropriate error message, called if there's an error in $c
97 after the dispatch has finished. Will output debug messages if Catalyst
98 is in debug mode, or a `please come back later` message otherwise.
103 my ( $self, $c ) = @_;
105 $c->res->content_type('text/html; charset=utf-8');
106 my $name = $c->config->{name} || join(' ', split('::', ref $c));
108 my ( $title, $error, $infos );
112 $error = join '', map {
113 '<p><code class="error">'
114 . encode_entities($_)
117 $error ||= 'No output';
118 $error = qq{<pre wrap="">$error</pre>};
119 $title = $name = "$name on Catalyst $Catalyst::VERSION";
120 $name = "<h1>$name</h1>";
122 # Don't show context in the dump
123 delete $c->req->{_context};
124 delete $c->res->{_context};
126 # Don't show body parser in the dump
127 delete $c->req->{_body};
129 # Don't show response header state in dump
130 delete $c->res->{_finalized_headers};
134 for my $dump ( $c->dump_these ) {
135 my $name = $dump->[0];
136 my $value = encode_entities( dump( $dump->[1] ));
137 push @infos, sprintf <<"EOF", $name, $value;
138 <h2><a href="#" onclick="toggleDump('dump_$i'); return false">%s</a></h2>
140 <pre wrap="">%s</pre>
145 $infos = join "\n", @infos;
152 (en) Please come back later
153 (fr) SVP veuillez revenir plus tard
154 (de) Bitte versuchen sie es spaeter nocheinmal
155 (at) Konnten's bitt'schoen spaeter nochmal reinschauen
156 (no) Vennligst prov igjen senere
157 (dk) Venligst prov igen senere
158 (pl) Prosze sprobowac pozniej
163 $c->res->body( <<"" );
164 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
165 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
166 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
168 <meta http-equiv="Content-Language" content="en" />
169 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
170 <title>$title</title>
171 <script type="text/javascript">
173 function toggleDump (dumpElement) {
174 var e = document.getElementById( dumpElement );
175 if (e.style.display == "none") {
176 e.style.display = "";
179 e.style.display = "none";
184 <style type="text/css">
186 font-family: "Bitstream Vera Sans", "Trebuchet MS", Verdana,
187 Tahoma, Arial, helvetica, sans-serif;
189 background-color: #eee;
193 :link, :link:hover, :visited, :visited:hover {
198 background-color: #ccc;
199 border: 1px solid #aaa;
204 background-color: #cce;
205 border: 1px solid #755;
211 background-color: #eee;
212 border: 1px solid #575;
218 background-color: #cce;
219 border: 1px solid #557;
228 div.name h1, div.error p {
236 text-decoration: underline;
242 /* from http://users.tkk.fi/~tkarvine/linux/doc/pre-wrap/pre-wrap-css3-mozilla-opera-ie.html */
243 /* Browser specific (not valid) styles to make preformatted text wrap */
245 white-space: pre-wrap; /* css-3 */
246 white-space: -moz-pre-wrap; /* Mozilla, since 1999 */
247 white-space: -pre-wrap; /* Opera 4-6 */
248 white-space: -o-pre-wrap; /* Opera 7 */
249 word-wrap: break-word; /* Internet Explorer 5.5+ */
255 <div class="error">$error</div>
256 <div class="infos">$infos</div>
257 <div class="name">$name</div>
264 $c->res->{body} .= ( ' ' x 512 );
267 $c->res->status(500);
270 =head2 $self->finalize_headers($c)
272 Abstract method, allows engines to write headers to response
276 sub finalize_headers { }
278 =head2 $self->finalize_read($c)
282 sub finalize_read { }
284 =head2 $self->finalize_uploads($c)
286 Clean up after uploads, deleting temp files.
290 sub finalize_uploads {
291 my ( $self, $c ) = @_;
293 if ( keys %{ $c->request->uploads } ) {
294 for my $key ( keys %{ $c->request->uploads } ) {
295 my $upload = $c->request->uploads->{$key};
296 unlink map { $_->tempname }
297 grep { -e $_->tempname }
298 ref $upload eq 'ARRAY' ? @{$upload} : ($upload);
303 =head2 $self->prepare_body($c)
305 sets up the L<Catalyst::Request> object body using L<HTTP::Body>
310 my ( $self, $c ) = @_;
312 if ( my $length = $self->read_length ) {
313 unless ( $c->request->{_body} ) {
314 my $type = $c->request->header('Content-Type');
315 $c->request->{_body} = HTTP::Body->new( $type, $length );
316 $c->request->{_body}->{tmpdir} = $c->config->{uploadtmp}
317 if exists $c->config->{uploadtmp};
320 while ( my $buffer = $self->read($c) ) {
321 $c->prepare_body_chunk($buffer);
324 # paranoia against wrong Content-Length header
325 my $remaining = $length - $self->read_position;
326 if ( $remaining > 0 ) {
327 $self->finalize_read($c);
328 Catalyst::Exception->throw(
329 "Wrong Content-Length value: $length" );
333 # Defined but will cause all body code to be skipped
334 $c->request->{_body} = 0;
338 =head2 $self->prepare_body_chunk($c)
340 Add a chunk to the request body.
344 sub prepare_body_chunk {
345 my ( $self, $c, $chunk ) = @_;
347 $c->request->{_body}->add($chunk);
350 =head2 $self->prepare_body_parameters($c)
352 Sets up parameters from body.
356 sub prepare_body_parameters {
357 my ( $self, $c ) = @_;
359 return unless $c->request->{_body};
361 $c->request->body_parameters( $c->request->{_body}->param );
364 =head2 $self->prepare_connection($c)
366 Abstract method implemented in engines.
370 sub prepare_connection { }
372 =head2 $self->prepare_cookies($c)
374 Parse cookies from header. Sets a L<CGI::Simple::Cookie> object.
378 sub prepare_cookies {
379 my ( $self, $c ) = @_;
381 if ( my $header = $c->request->header('Cookie') ) {
382 $c->req->cookies( { CGI::Simple::Cookie->parse($header) } );
386 =head2 $self->prepare_headers($c)
390 sub prepare_headers { }
392 =head2 $self->prepare_parameters($c)
394 sets up parameters from query and post parameters.
398 sub prepare_parameters {
399 my ( $self, $c ) = @_;
401 # We copy, no references
402 foreach my $name ( keys %{ $c->request->query_parameters } ) {
403 my $param = $c->request->query_parameters->{$name};
404 $param = ref $param eq 'ARRAY' ? [ @{$param} ] : $param;
405 $c->request->parameters->{$name} = $param;
408 # Merge query and body parameters
409 foreach my $name ( keys %{ $c->request->body_parameters } ) {
410 my $param = $c->request->body_parameters->{$name};
411 $param = ref $param eq 'ARRAY' ? [ @{$param} ] : $param;
412 if ( my $old_param = $c->request->parameters->{$name} ) {
413 if ( ref $old_param eq 'ARRAY' ) {
414 push @{ $c->request->parameters->{$name} },
415 ref $param eq 'ARRAY' ? @$param : $param;
417 else { $c->request->parameters->{$name} = [ $old_param, $param ] }
419 else { $c->request->parameters->{$name} = $param }
423 =head2 $self->prepare_path($c)
425 abstract method, implemented by engines.
431 =head2 $self->prepare_request($c)
433 =head2 $self->prepare_query_parameters($c)
435 process the query string and extract query parameters.
439 sub prepare_query_parameters {
440 my ( $self, $c, $query_string ) = @_;
442 # Check for keywords (no = signs)
443 # (yes, index() is faster than a regex :))
444 if ( index( $query_string, '=' ) < 0 ) {
445 $c->request->query_keywords( $self->unescape_uri($query_string) );
451 # replace semi-colons
452 $query_string =~ s/;/&/g;
454 my @params = split /&/, $query_string;
456 for my $item ( @params ) {
459 = map { $self->unescape_uri($_) }
462 $param = $self->unescape_uri($item) unless defined $param;
464 if ( exists $query{$param} ) {
465 if ( ref $query{$param} ) {
466 push @{ $query{$param} }, $value;
469 $query{$param} = [ $query{$param}, $value ];
473 $query{$param} = $value;
477 $c->request->query_parameters( \%query );
480 =head2 $self->prepare_read($c)
482 prepare to read from the engine.
487 my ( $self, $c ) = @_;
489 # Initialize the read position
490 $self->read_position(0);
492 # Initialize the amount of data we think we need to read
493 $self->read_length( $c->request->header('Content-Length') || 0 );
496 =head2 $self->prepare_request(@arguments)
498 Populate the context object from the request object.
502 sub prepare_request { }
504 =head2 $self->prepare_uploads($c)
508 sub prepare_uploads {
509 my ( $self, $c ) = @_;
511 return unless $c->request->{_body};
513 my $uploads = $c->request->{_body}->upload;
514 for my $name ( keys %$uploads ) {
515 my $files = $uploads->{$name};
516 $files = ref $files eq 'ARRAY' ? $files : [$files];
518 for my $upload (@$files) {
519 my $u = Catalyst::Request::Upload->new;
520 $u->headers( HTTP::Headers->new( %{ $upload->{headers} } ) );
521 $u->type( $u->headers->content_type );
522 $u->tempname( $upload->{tempname} );
523 $u->size( $upload->{size} );
524 $u->filename( $upload->{filename} );
527 $c->request->uploads->{$name} = @uploads > 1 ? \@uploads : $uploads[0];
529 # support access to the filename as a normal param
530 my @filenames = map { $_->{filename} } @uploads;
531 # append, if there's already params with this name
532 if (exists $c->request->parameters->{$name}) {
533 if (ref $c->request->parameters->{$name} eq 'ARRAY') {
534 push @{ $c->request->parameters->{$name} }, @filenames;
537 $c->request->parameters->{$name} =
538 [ $c->request->parameters->{$name}, @filenames ];
542 $c->request->parameters->{$name} =
543 @filenames > 1 ? \@filenames : $filenames[0];
548 =head2 $self->prepare_write($c)
550 Abstract method. Implemented by the engines.
554 sub prepare_write { }
556 =head2 $self->read($c, [$maxlength])
561 my ( $self, $c, $maxlength ) = @_;
563 my $remaining = $self->read_length - $self->read_position;
564 $maxlength ||= $CHUNKSIZE;
566 # Are we done reading?
567 if ( $remaining <= 0 ) {
568 $self->finalize_read($c);
572 my $readlen = ( $remaining > $maxlength ) ? $maxlength : $remaining;
573 my $rc = $self->read_chunk( $c, my $buffer, $readlen );
575 $self->read_position( $self->read_position + $rc );
579 Catalyst::Exception->throw(
580 message => "Unknown error reading input: $!" );
584 =head2 $self->read_chunk($c, $buffer, $length)
586 Each engine inplements read_chunk as its preferred way of reading a chunk
593 =head2 $self->read_length
595 The length of input data to be read. This is obtained from the Content-Length
598 =head2 $self->read_position
600 The amount of input data that has already been read.
602 =head2 $self->run($c)
604 Start the engine. Implemented by the various engine classes.
610 =head2 $self->write($c, $buffer)
612 Writes the buffer to the client. Can only be called once for a request.
617 my ( $self, $c, $buffer ) = @_;
619 unless ( $self->{_prepared_write} ) {
620 $self->prepare_write($c);
621 $self->{_prepared_write} = 1;
624 print STDOUT $buffer;
627 =head2 $self->unescape_uri($uri)
629 Unescapes a given URI using the most efficient method available. Engines such
630 as Apache may implement this using Apache's C-based modules, for example.
635 my ( $self, $str ) = @_;
637 $str =~ s/%([0-9A-Fa-f]{2})/chr(hex($1))/eg;
643 =head2 $self->finalize_output
645 <obsolete>, see finalize_body
649 Sebastian Riedel, <sri@cpan.org>
651 Andy Grundman, <andy@hybridized.org>
655 This program is free software, you can redistribute it and/or modify it under
656 the same terms as Perl itself.