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 = 4096;
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)
283 my ( $self, $c ) = @_;
285 undef $self->{_prepared_read};
288 =head2 $self->finalize_uploads($c)
290 Clean up after uploads, deleting temp files.
294 sub finalize_uploads {
295 my ( $self, $c ) = @_;
297 if ( keys %{ $c->request->uploads } ) {
298 for my $key ( keys %{ $c->request->uploads } ) {
299 my $upload = $c->request->uploads->{$key};
300 unlink map { $_->tempname }
301 grep { -e $_->tempname }
302 ref $upload eq 'ARRAY' ? @{$upload} : ($upload);
307 =head2 $self->prepare_body($c)
309 sets up the L<Catalyst::Request> object body using L<HTTP::Body>
314 my ( $self, $c ) = @_;
316 $self->read_length( $c->request->header('Content-Length') || 0 );
317 my $type = $c->request->header('Content-Type');
319 unless ( $c->request->{_body} ) {
320 $c->request->{_body} = HTTP::Body->new( $type, $self->read_length );
321 $c->request->{_body}->{tmpdir} = $c->config->{uploadtmp}
322 if exists $c->config->{uploadtmp};
325 if ( $self->read_length > 0 ) {
326 while ( my $buffer = $self->read($c) ) {
327 $c->prepare_body_chunk($buffer);
330 # paranoia against wrong Content-Length header
331 my $remaining = $self->read_length - $self->read_position;
332 if ( $remaining > 0 ) {
333 $self->finalize_read($c);
334 Catalyst::Exception->throw(
335 "Wrong Content-Length value: " . $self->read_length );
340 =head2 $self->prepare_body_chunk($c)
342 Add a chunk to the request body.
346 sub prepare_body_chunk {
347 my ( $self, $c, $chunk ) = @_;
349 $c->request->{_body}->add($chunk);
352 =head2 $self->prepare_body_parameters($c)
354 Sets up parameters from body.
358 sub prepare_body_parameters {
359 my ( $self, $c ) = @_;
360 $c->request->body_parameters( $c->request->{_body}->param );
363 =head2 $self->prepare_connection($c)
365 Abstract method implemented in engines.
369 sub prepare_connection { }
371 =head2 $self->prepare_cookies($c)
373 Parse cookies from header. Sets a L<CGI::Simple::Cookie> object.
377 sub prepare_cookies {
378 my ( $self, $c ) = @_;
380 if ( my $header = $c->request->header('Cookie') ) {
381 $c->req->cookies( { CGI::Simple::Cookie->parse($header) } );
385 =head2 $self->prepare_headers($c)
389 sub prepare_headers { }
391 =head2 $self->prepare_parameters($c)
393 sets up parameters from query and post parameters.
397 sub prepare_parameters {
398 my ( $self, $c ) = @_;
400 # We copy, no references
401 foreach my $name ( keys %{ $c->request->query_parameters } ) {
402 my $param = $c->request->query_parameters->{$name};
403 $param = ref $param eq 'ARRAY' ? [ @{$param} ] : $param;
404 $c->request->parameters->{$name} = $param;
407 # Merge query and body parameters
408 foreach my $name ( keys %{ $c->request->body_parameters } ) {
409 my $param = $c->request->body_parameters->{$name};
410 $param = ref $param eq 'ARRAY' ? [ @{$param} ] : $param;
411 if ( my $old_param = $c->request->parameters->{$name} ) {
412 if ( ref $old_param eq 'ARRAY' ) {
413 push @{ $c->request->parameters->{$name} },
414 ref $param eq 'ARRAY' ? @$param : $param;
416 else { $c->request->parameters->{$name} = [ $old_param, $param ] }
418 else { $c->request->parameters->{$name} = $param }
422 =head2 $self->prepare_path($c)
424 abstract method, implemented by engines.
430 =head2 $self->prepare_request($c)
432 =head2 $self->prepare_query_parameters($c)
434 process the query string and extract query parameters.
438 sub prepare_query_parameters {
439 my ( $self, $c, $query_string ) = @_;
441 # replace semi-colons
442 $query_string =~ s/;/&/g;
444 my $u = URI->new( '', 'http' );
445 $u->query($query_string);
446 for my $key ( $u->query_param ) {
447 my @vals = $u->query_param($key);
448 $c->request->query_parameters->{$key} = @vals > 1 ? [@vals] : $vals[0];
452 =head2 $self->prepare_read($c)
454 prepare to read from the engine.
459 my ( $self, $c ) = @_;
461 # Reset the read position
462 $self->read_position(0);
465 =head2 $self->prepare_request(@arguments)
467 Populate the context object from the request object.
471 sub prepare_request { }
473 =head2 $self->prepare_uploads($c)
477 sub prepare_uploads {
478 my ( $self, $c ) = @_;
479 my $uploads = $c->request->{_body}->upload;
480 for my $name ( keys %$uploads ) {
481 my $files = $uploads->{$name};
482 $files = ref $files eq 'ARRAY' ? $files : [$files];
484 for my $upload (@$files) {
485 my $u = Catalyst::Request::Upload->new;
486 $u->headers( HTTP::Headers->new( %{ $upload->{headers} } ) );
487 $u->type( $u->headers->content_type );
488 $u->tempname( $upload->{tempname} );
489 $u->size( $upload->{size} );
490 $u->filename( $upload->{filename} );
493 $c->request->uploads->{$name} = @uploads > 1 ? \@uploads : $uploads[0];
495 # support access to the filename as a normal param
496 my @filenames = map { $_->{filename} } @uploads;
497 $c->request->parameters->{$name} =
498 @filenames > 1 ? \@filenames : $filenames[0];
502 =head2 $self->prepare_write($c)
504 Abstract method. Implemented by the engines.
508 sub prepare_write { }
510 =head2 $self->read($c, [$maxlength])
515 my ( $self, $c, $maxlength ) = @_;
517 unless ( $self->{_prepared_read} ) {
518 $self->prepare_read($c);
519 $self->{_prepared_read} = 1;
522 my $remaining = $self->read_length - $self->read_position;
523 $maxlength ||= $CHUNKSIZE;
525 # Are we done reading?
526 if ( $remaining <= 0 ) {
527 $self->finalize_read($c);
531 my $readlen = ( $remaining > $maxlength ) ? $maxlength : $remaining;
532 my $rc = $self->read_chunk( $c, my $buffer, $readlen );
534 $self->read_position( $self->read_position + $rc );
538 Catalyst::Exception->throw(
539 message => "Unknown error reading input: $!" );
543 =head2 $self->read_chunk($c, $buffer, $length)
545 Each engine inplements read_chunk as its preferred way of reading a chunk
552 =head2 $self->read_length
554 The length of input data to be read. This is obtained from the Content-Length
557 =head2 $self->read_position
559 The amount of input data that has already been read.
561 =head2 $self->run($c)
563 Start the engine. Implemented by the various engine classes.
569 =head2 $self->write($c, $buffer)
571 Writes the buffer to the client. Can only be called once for a request.
576 my ( $self, $c, $buffer ) = @_;
578 unless ( $self->{_prepared_write} ) {
579 $self->prepare_write($c);
580 $self->{_prepared_write} = 1;
583 print STDOUT $buffer;
587 =head2 $self->finalize_output
589 <obsolete>, see finalize_body
593 Sebastian Riedel, <sri@cpan.org>
595 Andy Grundman, <andy@hybridized.org>
599 This program is free software, you can redistribute it and/or modify it under
600 the same terms as Perl itself.