package Catalyst::Engine;
use strict;
-use base qw/Class::Data::Inheritable Class::Accessor::Fast/;
-use UNIVERSAL::require;
+use base 'Class::Accessor::Fast';
use CGI::Cookie;
use Data::Dumper;
use HTML::Entities;
+use HTTP::Body;
use HTTP::Headers;
-use Memoize;
-use Time::HiRes qw/gettimeofday tv_interval/;
-use Text::ASCIITable;
-use Tree::Simple;
-use Tree::Simple::Visitor::FindByPath;
-use Catalyst::Request;
-use Catalyst::Response;
+use URI::QueryParam;
-require Module::Pluggable::Fast;
+# input position and length
+__PACKAGE__->mk_accessors(qw/read_position read_length/);
-$Data::Dumper::Terse = 1;
+# Stringify to class
+use overload '""' => sub { return ref shift }, fallback => 1;
-__PACKAGE__->mk_classdata($_) for qw/actions components tree/;
-__PACKAGE__->mk_accessors(qw/request response state/);
-
-__PACKAGE__->actions(
- { plain => {}, private => {}, regex => {}, compiled => [], reverse => {} }
-);
-__PACKAGE__->tree( Tree::Simple->new( 0, Tree::Simple->ROOT ) );
-
-*comp = \&component;
-*req = \&request;
-*res = \&response;
-
-our $COUNT = 1;
-our $START = time;
-
-memoize('_class2prefix');
+# Amount of data to read from input on each pass
+our $CHUNKSIZE = 4096;
=head1 NAME
=head1 METHODS
-=over 4
-
-=item $c->benchmark($coderef)
-
-Takes a coderef with arguments and returns elapsed time as float.
-
- my ( $elapsed, $status ) = $c->benchmark( sub { return 1 } );
- $c->log->info( sprintf "Processing took %f seconds", $elapsed );
-
-=cut
-
-sub benchmark {
- my $c = shift;
- my $code = shift;
- my $time = [gettimeofday];
- my @return = &$code(@_);
- my $elapsed = tv_interval $time;
- return wantarray ? ( $elapsed, @return ) : $elapsed;
-}
-
-=item $c->comp($name)
-
-=item $c->component($name)
-
-Get a component object by name.
-
- $c->comp('MyApp::Model::MyModel')->do_stuff;
-
-Regex search for a component.
-
- $c->comp('mymodel')->do_stuff;
-
-=cut
-
-sub component {
- my ( $c, $name ) = @_;
- if ( my $component = $c->components->{$name} ) {
- return $component;
- }
- else {
- for my $component ( keys %{ $c->components } ) {
- return $c->components->{$component} if $component =~ /$name/i;
- }
- }
-}
-
-=item $c->error
-
-=item $c->error($error, ...)
-
-=item $c->error($arrayref)
-
-Returns an arrayref containing error messages.
-
- my @error = @{ $c->error };
-
-Add a new error.
-
- $c->error('Something bad happened');
-
-=cut
+=head2 $self->finalize_output
-sub error {
- my $c = shift;
- my $error = ref $_[0] eq 'ARRAY' ? $_[0] : [@_];
- push @{ $c->{error} }, @$error;
- return $c->{error};
-}
+<obsolete>, see finalize_body
-=item $c->execute($class, $coderef)
+=head2 $self->finalize_body($c)
-Execute a coderef in given class and catch exceptions.
-Errors are available via $c->error.
+Finalize body. Prints the response output.
=cut
-sub execute {
- my ( $c, $class, $code ) = @_;
- $class = $c->comp($class) || $class;
- $c->state(0);
- my $callsub = ( caller(1) )[3];
- eval {
- if ( $c->debug )
- {
- my $action = $c->actions->{reverse}->{"$code"};
- $action = "/$action" unless $action =~ /\-\>/;
- $action = "-> $action" if $callsub =~ /forward$/;
- my ( $elapsed, @state ) =
- $c->benchmark( $code, $class, $c, @{ $c->req->args } );
- push @{ $c->{stats} }, [ $action, sprintf( '%fs', $elapsed ) ];
- $c->state(@state);
+sub finalize_body {
+ my ( $self, $c ) = @_;
+ if ( ref $c->response->body && $c->response->body->can('read') ) {
+ while ( !$c->response->body->eof() ) {
+ $c->response->body->read( my $buffer, $CHUNKSIZE );
+ last unless $self->write( $c, $buffer );
}
- else { $c->state( &$code( $class, $c, @{ $c->req->args } ) ) }
- };
- if ( my $error = $@ ) {
- chomp $error;
- $error = qq/Caught exception "$error"/;
- $c->log->error($error);
- $c->error($error) if $c->debug;
- $c->state(0);
- }
- return $c->state;
-}
-
-=item $c->finalize
-
-Finalize request.
-
-=cut
-
-sub finalize {
- my $c = shift;
-
- $c->finalize_cookies;
-
- if ( my $location = $c->response->redirect ) {
- $c->log->debug(qq/Redirecting to "$location"/) if $c->debug;
- $c->response->header( Location => $location );
- $c->response->status(302) if $c->response->status !~ /3\d\d$/;
+ $c->response->body->close();
}
-
- if ( $#{ $c->error } >= 0 ) {
- $c->finalize_error;
- }
-
- if ( !$c->response->output && $c->response->status !~ /^(1|3)\d\d$/ ) {
- $c->finalize_error;
- }
-
- if ( $c->response->output && !$c->response->content_length ) {
- use bytes; # play safe with a utf8 aware perl
- $c->response->content_length( length $c->response->output );
+ else {
+ $self->write( $c, $c->response->body );
}
-
- my $status = $c->finalize_headers;
- $c->finalize_output;
- return $status;
}
-=item $c->finalize_cookies
-
-Finalize cookies.
+=head2 $self->finalize_cookies($c)
=cut
sub finalize_cookies {
- my $c = shift;
+ my ( $self, $c ) = @_;
+ my @cookies;
while ( my ( $name, $cookie ) = each %{ $c->response->cookies } ) {
+
my $cookie = CGI::Cookie->new(
-name => $name,
-value => $cookie->{value},
-secure => $cookie->{secure} || 0
);
- $c->res->headers->push_header( 'Set-Cookie' => $cookie->as_string );
+ push @cookies, $cookie->as_string;
}
-}
-=item $c->finalize_error
+ for my $cookie (@cookies) {
+ $c->res->headers->push_header( 'Set-Cookie' => $cookie );
+ }
+}
-Finalize error.
+=head2 $self->finalize_error($c)
=cut
sub finalize_error {
- my $c = shift;
+ my ( $self, $c ) = @_;
- $c->res->headers->content_type('text/html');
+ $c->res->content_type('text/html; charset=utf-8');
my $name = $c->config->{name} || 'Catalyst Application';
my ( $title, $error, $infos );
if ( $c->debug ) {
- $error = join '<br/>', @{ $c->error };
+
+ # For pretty dumps
+ local $Data::Dumper::Terse = 1;
+ $error = join '', map {
+ '<p><code class="error">'
+ . encode_entities($_)
+ . '</code></p>'
+ } @{ $c->error };
$error ||= 'No output';
+ $error = qq{<pre wrap="">$error</pre>};
$title = $name = "$name on Catalyst $Catalyst::VERSION";
+ $name = "<h1>$name</h1>";
+
+ # Don't show context in the dump
+ delete $c->req->{_context};
+ delete $c->res->{_context};
+
+ # Don't show body parser in the dump
+ delete $c->req->{_body};
+
+ # Don't show response header state in dump
+ delete $c->res->{_finalized_headers};
+
my $req = encode_entities Dumper $c->req;
my $res = encode_entities Dumper $c->res;
my $stash = encode_entities Dumper $c->stash;
- $infos = <<"";
-<br/>
-<b><u>Request</u></b><br/>
-<pre>$req</pre>
-<b><u>Response</u></b><br/>
-<pre>$res</pre>
-<b><u>Stash</u></b><br/>
-<pre>$stash</pre>
+ my @infos;
+ my $i = 0;
+ for my $dump ( $c->dump_these ) {
+ my $name = $dump->[0];
+ my $value = encode_entities( Dumper $dump->[1] );
+ push @infos, sprintf <<"EOF", $name, $value;
+<h2><a href="#" onclick="toggleDump('dump_$i'); return false">%s</a></h2>
+<div id="dump_$i">
+ <pre wrap="">%s</pre>
+</div>
+EOF
+ $i++;
+ }
+ $infos = join "\n", @infos;
}
else {
$title = $name;
<pre>
(en) Please come back later
(de) Bitte versuchen sie es spaeter nocheinmal
-(nl) Gelieve te komen later terug
+(at) Konnten's bitt'schoen spaeter nochmal reinschauen
(no) Vennligst prov igjen senere
-(fr) Veuillez revenir plus tard
-(es) Vuelto por favor mas adelante
-(pt) Voltado por favor mais tarde
-(it) Ritornato prego piĆ¹ successivamente
+(dk) Venligst prov igen senere
+(pl) Prosze sprobowac pozniej
</pre>
$name = '';
}
- $c->res->output( <<"" );
-<html>
+ $c->res->body( <<"" );
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
+ <meta http-equiv="Content-Language" content="en" />
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>$title</title>
+ <script type="text/javascript">
+ <!--
+ function toggleDump (dumpElement) {
+ var e = document.getElementById( dumpElement );
+ if (e.style.display == "none") {
+ e.style.display = "";
+ }
+ else {
+ e.style.display = "none";
+ }
+ }
+ -->
+ </script>
<style type="text/css">
body {
font-family: "Bitstream Vera Sans", "Trebuchet MS", Verdana,
margin: 0px;
padding: 0px;
}
+ :link, :link:hover, :visited, :visited:hover {
+ color: #ddd;
+ }
div.box {
+ position: relative;
background-color: #ccc;
border: 1px solid #aaa;
padding: 4px;
margin: 4px;
-moz-border-radius: 10px;
}
+ code.error {
+ display: block;
+ margin: 1em 0;
+ overflow: auto;
+ }
+ div.name h1, div.error p {
+ margin: 0;
+ }
+ h2 {
+ margin-top: 0;
+ margin-bottom: 10px;
+ font-size: medium;
+ font-weight: bold;
+ text-decoration: underline;
+ }
+ h1 {
+ font-size: medium;
+ font-weight: normal;
+ }
+ /* from http://users.tkk.fi/~tkarvine/linux/doc/pre-wrap/pre-wrap-css3-mozilla-opera-ie.html */
+ /* Browser specific (not valid) styles to make preformatted text wrap */
+ pre {
+ white-space: pre-wrap; /* css-3 */
+ white-space: -moz-pre-wrap; /* Mozilla, since 1999 */
+ white-space: -pre-wrap; /* Opera 4-6 */
+ white-space: -o-pre-wrap; /* Opera 7 */
+ word-wrap: break-word; /* Internet Explorer 5.5+ */
+ }
</style>
</head>
<body>
</body>
</html>
-}
-=item $c->finalize_headers
+ # Trick IE
+ $c->res->{body} .= ( ' ' x 512 );
+
+ # Return 500
+ $c->res->status(500);
+}
-Finalize headers.
+=head2 $self->finalize_headers($c)
=cut
sub finalize_headers { }
-=item $c->finalize_output
-
-Finalize output.
+=head2 $self->finalize_read($c)
=cut
-sub finalize_output { }
-
-=item $c->forward($command)
+sub finalize_read {
+ my ( $self, $c ) = @_;
-Forward processing to a private action or a method from a class.
-If you define a class without method it will default to process().
+ undef $self->{_prepared_read};
+}
- $c->forward('/foo');
- $c->forward('index');
- $c->forward(qw/MyApp::Model::CDBI::Foo do_stuff/);
- $c->forward('MyApp::View::TT');
+=head2 $self->finalize_uploads($c)
=cut
-sub forward {
- my $c = shift;
- my $command = shift;
- unless ($command) {
- $c->log->debug('Nothing to forward to') if $c->debug;
- return 0;
- }
- my $caller = caller(0);
- my $namespace = '/';
- if ( $command =~ /^\// ) {
- $command =~ /^(.*)\/(\w+)$/;
- $namespace = $1 || '/';
- $command = $2;
- }
- else { $namespace = _class2prefix($caller) || '/' }
- my $results = $c->get_action( $command, $namespace );
- unless ( @{$results} ) {
- my $class = $command;
- if ( $class =~ /[^\w\:]/ ) {
- $c->log->debug(qq/Couldn't forward to "$class"/) if $c->debug;
- return 0;
- }
- my $method = shift || 'process';
- if ( my $code = $class->can($method) ) {
- $c->actions->{reverse}->{"$code"} = "$class->$method";
- $results = [ [ [ $class, $code ] ] ];
- }
- else {
- $c->log->debug(qq/Couldn't forward to "$class->$method"/)
- if $c->debug;
- return 0;
+sub finalize_uploads {
+ my ( $self, $c ) = @_;
+
+ if ( keys %{ $c->request->uploads } ) {
+ for my $key ( keys %{ $c->request->uploads } ) {
+ my $upload = $c->request->uploads->{$key};
+ unlink map { $_->tempname }
+ grep { -e $_->tempname }
+ ref $upload eq 'ARRAY' ? @{$upload} : ($upload);
}
}
- for my $result ( @{$results} ) {
- $c->state( $c->execute( @{ $result->[0] } ) );
- }
- return $c->state;
}
-=item $c->get_action( $action, $namespace )
-
-Get an action in a given namespace.
+=head2 $self->prepare_body($c)
=cut
-sub get_action {
- my ( $c, $action, $namespace ) = @_;
- return [] unless $action;
- $namespace ||= '';
- if ($namespace) {
- $namespace = '' if $namespace eq '/';
- my $parent = $c->tree;
- my @results;
- my $result = $c->actions->{private}->{ $parent->getUID }->{$action};
- push @results, [$result] if $result;
- my $visitor = Tree::Simple::Visitor::FindByPath->new;
- for my $part ( split '/', $namespace ) {
- $visitor->setSearchPath($part);
- $parent->accept($visitor);
- my $child = $visitor->getResult;
- my $uid = $child->getUID if $child;
- my $match = $c->actions->{private}->{$uid}->{$action} if $uid;
- push @results, [$match] if $match;
- $parent = $child if $child;
- }
- return \@results;
- }
- elsif ( my $p = $c->actions->{plain}->{$action} ) { return [ [$p] ] }
- elsif ( my $r = $c->actions->{regex}->{$action} ) { return [ [$r] ] }
- else {
- for my $i ( 0 .. $#{ $c->actions->{compiled} } ) {
- my $name = $c->actions->{compiled}->[$i]->[0];
- my $regex = $c->actions->{compiled}->[$i]->[1];
- if ( $action =~ $regex ) {
- my @snippets;
- for my $i ( 1 .. 9 ) {
- no strict 'refs';
- last unless ${$i};
- push @snippets, ${$i};
- }
- return [ [ $c->actions->{regex}->{$name}, $name, \@snippets ] ];
- }
- }
- }
- return [];
-}
+sub prepare_body {
+ my ( $self, $c ) = @_;
-=item $c->handler( $class, $r )
+ $self->read_length( $c->request->header('Content-Length') || 0 );
+ my $type = $c->request->header('Content-Type');
-Handles the request.
+ unless ( $c->request->{_body} ) {
+ $c->request->{_body} = HTTP::Body->new( $type, $self->read_length );
+ }
-=cut
+ if ( $self->read_length > 0 ) {
+ while ( my $buffer = $self->read($c) ) {
+ $c->prepare_body_chunk($buffer);
+ }
-sub handler {
- my ( $class, $engine ) = @_;
-
- # Always expect worst case!
- my $status = -1;
- eval {
- my @stats = ();
- my $handler = sub {
- my $c = $class->prepare($engine);
- $c->{stats} = \@stats;
- my $action = $c->req->action;
- my $namespace = '';
- $namespace = ( join( '/', @{ $c->req->args } ) || '/' )
- if $action eq 'default';
- unless ($namespace) {
- if ( my $result = $c->get_action($action) ) {
- $namespace = _class2prefix( $result->[0]->[0]->[0] );
- }
- }
- my $default = $action eq 'default' ? $namespace : undef;
- my $results = $c->get_action( $action, $default );
- $namespace ||= '/';
- if ( @{$results} ) {
- for my $begin ( @{ $c->get_action( 'begin', $namespace ) } ) {
- $c->state( $c->execute( @{ $begin->[0] } ) );
- }
- if ( my $action = $c->req->action ) {
- for my $result (
- @{ $c->get_action( $action, $default ) }[-1] )
- {
- $c->state( $c->execute( @{ $result->[0] } ) );
- last unless $default;
- }
- }
- for my $end ( reverse @{ $c->get_action( 'end', $namespace ) } )
- {
- $c->state( $c->execute( @{ $end->[0] } ) );
- }
- }
- else {
- my $path = $c->req->path;
- my $error = $path
- ? qq/Unknown resource "$path"/
- : "No default action defined";
- $c->log->error($error) if $c->debug;
- $c->error($error);
- }
- return $c->finalize;
- };
- if ( $class->debug ) {
- my $elapsed;
- ( $elapsed, $status ) = $class->benchmark($handler);
- $elapsed = sprintf '%f', $elapsed;
- my $av = sprintf '%.3f', 1 / $elapsed;
- my $t = Text::ASCIITable->new;
- $t->setCols( 'Action', 'Time' );
- $t->setColWidth( 'Action', 64, 1 );
- $t->setColWidth( 'Time', 9, 1 );
-
- for my $stat (@stats) {
- $t->addRow(@$stat);
- }
- $class->log->info( "Request took $elapsed" . "s ($av/s)",
- $t->draw );
+ # paranoia against wrong Content-Length header
+ my $remaining = $self->read_length - $self->read_position;
+ if ($remaining > 0) {
+ $self->finalize_read($c);
+ Catalyst::Exception->throw("Wrong Content-Length value: ". $self->read_length);
}
- else { $status = &$handler }
- };
- if ( my $error = $@ ) {
- chomp $error;
- $class->log->error(qq/Caught exception in engine "$error"/);
}
- $COUNT++;
- return $status;
}
-=item $c->prepare($r)
-
-Turns the engine-specific request( Apache, CGI ... )
-into a Catalyst context .
+=head2 $self->prepare_body_chunk($c)
=cut
-sub prepare {
- my ( $class, $r ) = @_;
- my $c = bless {
- request => Catalyst::Request->new(
- {
- arguments => [],
- cookies => {},
- headers => HTTP::Headers->new,
- parameters => {},
- snippets => [],
- uploads => {}
- }
- ),
- response => Catalyst::Response->new(
- { cookies => {}, headers => HTTP::Headers->new, status => 200 }
- ),
- stash => {},
- state => 0
- }, $class;
- if ( $c->debug ) {
- my $secs = time - $START || 1;
- my $av = sprintf '%.3f', $COUNT / $secs;
- $c->log->debug('**********************************');
- $c->log->debug("* Request $COUNT ($av/s) [$$]");
- $c->log->debug('**********************************');
- $c->res->headers->header( 'X-Catalyst' => $Catalyst::VERSION );
- }
- $c->prepare_request($r);
- $c->prepare_path;
- $c->prepare_headers;
- $c->prepare_cookies;
- $c->prepare_connection;
- my $method = $c->req->method || '';
- my $path = $c->req->path || '';
- my $hostname = $c->req->hostname || '';
- my $address = $c->req->address || '';
- $c->log->debug(qq/"$method" request for "$path" from $hostname($address)/)
- if $c->debug;
- $c->prepare_action;
- $c->prepare_parameters;
-
- if ( $c->debug && keys %{ $c->req->params } ) {
- my $t = Text::ASCIITable->new;
- $t->setCols( 'Key', 'Value' );
- $t->setColWidth( 'Key', 37, 1 );
- $t->setColWidth( 'Value', 36, 1 );
- for my $key ( keys %{ $c->req->params } ) {
- my $value = $c->req->params->{$key} || '';
- $t->addRow( $key, $value );
- }
- $c->log->debug( 'Parameters are', $t->draw );
- }
- $c->prepare_uploads;
- return $c;
-}
+sub prepare_body_chunk {
+ my ( $self, $c, $chunk ) = @_;
-=item $c->prepare_action
+ $c->request->{_body}->add($chunk);
+}
-Prepare action.
+=head2 $self->prepare_body_parameters($c)
=cut
-sub prepare_action {
- my $c = shift;
- my $path = $c->req->path;
- my @path = split /\//, $c->req->path;
- $c->req->args( \my @args );
- while (@path) {
- $path = join '/', @path;
- if ( my $result = ${ $c->get_action($path) }[0] ) {
-
- # It's a regex
- if ($#$result) {
- my $match = $result->[1];
- my @snippets = @{ $result->[2] };
- $c->log->debug(
- qq/Requested action is "$path" and matched "$match"/)
- if $c->debug;
- $c->log->debug(
- 'Snippets are "' . join( ' ', @snippets ) . '"' )
- if ( $c->debug && @snippets );
- $c->req->action($match);
- $c->req->snippets( \@snippets );
- }
- else {
- $c->req->action($path);
- $c->log->debug(qq/Requested action is "$path"/) if $c->debug;
- }
- $c->req->match($path);
- last;
- }
- unshift @args, pop @path;
- }
- unless ( $c->req->action ) {
- $c->req->action('default');
- $c->req->match('');
- }
- $c->log->debug( 'Arguments are "' . join( '/', @args ) . '"' )
- if ( $c->debug && @args );
+sub prepare_body_parameters {
+ my ( $self, $c ) = @_;
+ $c->request->body_parameters( $c->request->{_body}->param );
}
-=item $c->prepare_connection
-
-Prepare connection.
+=head2 $self->prepare_connection($c)
=cut
sub prepare_connection { }
-=item $c->prepare_cookies
-
-Prepare cookies.
+=head2 $self->prepare_cookies($c)
=cut
sub prepare_cookies {
- my $c = shift;
+ my ( $self, $c ) = @_;
if ( my $header = $c->request->header('Cookie') ) {
$c->req->cookies( { CGI::Cookie->parse($header) } );
}
}
-=item $c->prepare_headers
-
-Prepare headers.
+=head2 $self->prepare_headers($c)
=cut
sub prepare_headers { }
-=item $c->prepare_parameters
-
-Prepare parameters.
+=head2 $self->prepare_parameters($c)
=cut
-sub prepare_parameters { }
+sub prepare_parameters {
+ my ( $self, $c ) = @_;
-=item $c->prepare_path
+ # We copy, no references
+ while ( my ( $name, $param ) = each %{ $c->request->query_parameters } ) {
+ $param = ref $param eq 'ARRAY' ? [ @{$param} ] : $param;
+ $c->request->parameters->{$name} = $param;
+ }
+
+ # Merge query and body parameters
+ while ( my ( $name, $param ) = each %{ $c->request->body_parameters } ) {
+ $param = ref $param eq 'ARRAY' ? [ @{$param} ] : $param;
+ if ( my $old_param = $c->request->parameters->{$name} ) {
+ if ( ref $old_param eq 'ARRAY' ) {
+ push @{ $c->request->parameters->{$name} },
+ ref $param eq 'ARRAY' ? @$param : $param;
+ }
+ else { $c->request->parameters->{$name} = [ $old_param, $param ] }
+ }
+ else { $c->request->parameters->{$name} = $param }
+ }
+}
-Prepare path and base.
+=head2 $self->prepare_path($c)
=cut
sub prepare_path { }
-=item $c->prepare_request
+=head2 $self->prepare_request($c)
-Prepare the engine request.
+=head2 $self->prepare_query_parameters($c)
=cut
-sub prepare_request { }
+sub prepare_query_parameters {
+ my ( $self, $c, $query_string ) = @_;
-=item $c->prepare_uploads
+ # replace semi-colons
+ $query_string =~ s/;/&/g;
-Prepare uploads.
+ my $u = URI->new( '', 'http' );
+ $u->query($query_string);
+ for my $key ( $u->query_param ) {
+ my @vals = $u->query_param($key);
+ $c->request->query_parameters->{$key} = @vals > 1 ? [@vals] : $vals[0];
+ }
+}
+
+=head2 $self->prepare_read($c)
=cut
-sub prepare_uploads { }
+sub prepare_read {
+ my ( $self, $c ) = @_;
-=item $c->run
+ # Reset the read position
+ $self->read_position(0);
+}
-Starts the engine.
+=head2 $self->prepare_request(@arguments)
=cut
-sub run { }
-
-=item $c->request
-
-=item $c->req
+sub prepare_request { }
-Returns a C<Catalyst::Request> object.
+=head2 $self->prepare_uploads($c)
- my $req = $c->req;
+=cut
-=item $c->response
+sub prepare_uploads {
+ my ( $self, $c ) = @_;
+ my $uploads = $c->request->{_body}->upload;
+ for my $name ( keys %$uploads ) {
+ my $files = $uploads->{$name};
+ $files = ref $files eq 'ARRAY' ? $files : [$files];
+ my @uploads;
+ for my $upload (@$files) {
+ my $u = Catalyst::Request::Upload->new;
+ $u->headers( HTTP::Headers->new( %{ $upload->{headers} } ) );
+ $u->type( $u->headers->content_type );
+ $u->tempname( $upload->{tempname} );
+ $u->size( $upload->{size} );
+ $u->filename( $upload->{filename} );
+ push @uploads, $u;
+ }
+ $c->request->uploads->{$name} = @uploads > 1 ? \@uploads : $uploads[0];
-=item $c->res
+ # support access to the filename as a normal param
+ my @filenames = map { $_->{filename} } @uploads;
+ $c->request->parameters->{$name} =
+ @filenames > 1 ? \@filenames : $filenames[0];
+ }
+}
-Returns a C<Catalyst::Response> object.
+=head2 $self->prepare_write($c)
- my $res = $c->res;
+=cut
-=item $c->set_action( $action, $code, $namespace, $attrs )
+sub prepare_write { }
-Set an action in a given namespace.
+=head2 $self->read($c, [$maxlength])
=cut
-sub set_action {
- my ( $c, $method, $code, $namespace, $attrs ) = @_;
+sub read {
+ my ( $self, $c, $maxlength ) = @_;
- my $prefix = _class2prefix($namespace) || '';
- my %flags;
-
- for my $attr ( @{$attrs} ) {
- if ( $attr =~ /^(Local|Relative)$/ ) { $flags{local}++ }
- elsif ( $attr =~ /^(Global|Absolute)$/ ) { $flags{global}++ }
- elsif ( $attr =~ /^Path\((.+)\)$/i ) { $flags{path} = $1 }
- elsif ( $attr =~ /^Private$/i ) { $flags{private}++ }
- elsif ( $attr =~ /^(Regex|Regexp)\((.+)\)$/i ) { $flags{regex} = $2 }
+ unless ( $self->{_prepared_read} ) {
+ $self->prepare_read($c);
+ $self->{_prepared_read} = 1;
}
- return unless keys %flags;
-
- my $parent = $c->tree;
- my $visitor = Tree::Simple::Visitor::FindByPath->new;
- for my $part ( split '/', $prefix ) {
- $visitor->setSearchPath($part);
- $parent->accept($visitor);
- my $child = $visitor->getResult;
- unless ($child) {
- $child = $parent->addChild( Tree::Simple->new($part) );
- $visitor->setSearchPath($part);
- $parent->accept($visitor);
- $child = $visitor->getResult;
- }
- $parent = $child;
- }
- my $uid = $parent->getUID;
- $c->actions->{private}->{$uid}->{$method} = [ $namespace, $code ];
- my $forward = $prefix ? "$prefix/$method" : $method;
-
- if ( $flags{path} ) {
- $flags{path} =~ s/^\w+//;
- $flags{path} =~ s/\w+$//;
- if ( $flags{path} =~ /^'(.*)'$/ ) { $flags{path} = $1 }
- if ( $flags{path} =~ /^"(.*)"$/ ) { $flags{path} = $1 }
- }
- if ( $flags{regex} ) {
- $flags{regex} =~ s/^\w+//;
- $flags{regex} =~ s/\w+$//;
- if ( $flags{regex} =~ /^'(.*)'$/ ) { $flags{regex} = $1 }
- if ( $flags{regex} =~ /^"(.*)"$/ ) { $flags{regex} = $1 }
- }
+ my $remaining = $self->read_length - $self->read_position;
+ $maxlength ||= $CHUNKSIZE;
- my $reverse = $prefix ? "$prefix/$method" : $method;
+ # Are we done reading?
+ if ( $remaining <= 0 ) {
+ $self->finalize_read($c);
+ return;
+ }
- if ( $flags{local} || $flags{global} || $flags{path} ) {
- my $path = $flags{path} || $method;
- my $absolute = 0;
- if ( $path =~ /^\/(.+)/ ) {
- $path = $1;
- $absolute = 1;
- }
- $absolute = 1 if $flags{global};
- my $name = $absolute ? $path : "$prefix/$path";
- $c->actions->{plain}->{$name} = [ $namespace, $code ];
+ my $readlen = ( $remaining > $maxlength ) ? $maxlength : $remaining;
+ my $rc = $self->read_chunk( $c, my $buffer, $readlen );
+ if ( defined $rc ) {
+ $self->read_position( $self->read_position + $rc );
+ return $buffer;
}
- if ( my $regex = $flags{regex} ) {
- push @{ $c->actions->{compiled} }, [ $regex, qr#$regex# ];
- $c->actions->{regex}->{$regex} = [ $namespace, $code ];
+ else {
+ Catalyst::Exception->throw(
+ message => "Unknown error reading input: $!" );
}
-
- $c->actions->{reverse}->{"$code"} = $reverse;
}
-=item $class->setup
-
-Setup.
+=head2 $self->read_chunk($c, $buffer, $length)
- MyApp->setup;
+Each engine inplements read_chunk as its preferred way of reading a chunk
+of data.
=cut
-sub setup {
- my $self = shift;
- $self->setup_components;
- if ( $self->debug ) {
- my $name = $self->config->{name} || 'Application';
- $self->log->info("$name powered by Catalyst $Catalyst::VERSION");
- }
-}
-
-=item $class->setup_actions($component)
+sub read_chunk { }
-Setup actions for a component.
+=head2 $self->read_length
-=cut
+The length of input data to be read. This is obtained from the Content-Length
+header.
-sub setup_actions {
- my ( $self, $comp ) = @_;
- $comp = ref $comp || $comp;
- for my $action ( @{ $comp->_cache } ) {
- my ( $code, $attrs ) = @{$action};
- my $name = '';
- no strict 'refs';
- my @cache = ( $comp, @{"$comp\::ISA"} );
- my %namespaces;
- while ( my $namespace = shift @cache ) {
- $namespaces{$namespace}++;
- for my $isa ( @{"$comp\::ISA"} ) {
- next if $namespaces{$isa};
- push @cache, $isa;
- $namespaces{$isa}++;
- }
- }
- for my $namespace ( keys %namespaces ) {
- for my $sym ( values %{ $namespace . '::' } ) {
- if ( *{$sym}{CODE} && *{$sym}{CODE} == $code ) {
- $name = *{$sym}{NAME};
- $self->set_action( $name, $code, $comp, $attrs );
- last;
- }
- }
- }
- }
-}
+=head2 $self->read_position
-=item $class->setup_components
+The amount of input data that has already been read.
-Setup components.
+=head2 $self->run($c)
=cut
-sub setup_components {
- my $self = shift;
-
- # Components
- my $class = ref $self || $self;
- eval <<"";
- package $class;
- import Module::Pluggable::Fast
- name => '_components',
- search => [
- '$class\::Controller', '$class\::C',
- '$class\::Model', '$class\::M',
- '$class\::View', '$class\::V'
- ];
-
- if ( my $error = $@ ) {
- chomp $error;
- $self->log->error(
- qq/Couldn't initialize "Module::Pluggable::Fast", "$error"/);
- }
- $self->setup_actions($self);
- $self->components( {} );
- for my $comp ( $self->_components($self) ) {
- $self->components->{ ref $comp } = $comp;
- $self->setup_actions($comp);
- }
- my $t = Text::ASCIITable->new;
- $t->setCols('Class');
- $t->setColWidth( 'Class', 75, 1 );
- $t->addRow($_) for keys %{ $self->components };
- $self->log->debug( 'Loaded components', $t->draw )
- if ( @{ $t->{tbl_rows} } && $self->debug );
- my $actions = $self->actions;
- my $privates = Text::ASCIITable->new;
- $privates->setCols( 'Action', 'Class', 'Code' );
- $privates->setColWidth( 'Action', 28, 1 );
- $privates->setColWidth( 'Class', 28, 1 );
- $privates->setColWidth( 'Code', 14, 1 );
- my $walker = sub {
- my ( $walker, $parent, $prefix ) = @_;
- $prefix .= $parent->getNodeValue || '';
- $prefix .= '/' unless $prefix =~ /\/$/;
- my $uid = $parent->getUID;
- for my $action ( keys %{ $actions->{private}->{$uid} } ) {
- my ( $class, $code ) = @{ $actions->{private}->{$uid}->{$action} };
- $privates->addRow( "$prefix$action", $class, $code );
- }
- $walker->( $walker, $_, $prefix ) for $parent->getAllChildren;
- };
- $walker->( $walker, $self->tree, '' );
- $self->log->debug( 'Loaded private actions', $privates->draw )
- if ( @{ $privates->{tbl_rows} } && $self->debug );
- my $publics = Text::ASCIITable->new;
- $publics->setCols( 'Action', 'Class', 'Code' );
- $publics->setColWidth( 'Action', 28, 1 );
- $publics->setColWidth( 'Class', 28, 1 );
- $publics->setColWidth( 'Code', 14, 1 );
-
- for my $plain ( sort keys %{ $actions->{plain} } ) {
- my ( $class, $code ) = @{ $actions->{plain}->{$plain} };
- $publics->addRow( "/$plain", $class, $code );
- }
- $self->log->debug( 'Loaded public actions', $publics->draw )
- if ( @{ $publics->{tbl_rows} } && $self->debug );
- my $regexes = Text::ASCIITable->new;
- $regexes->setCols( 'Action', 'Class', 'Code' );
- $regexes->setColWidth( 'Action', 28, 1 );
- $regexes->setColWidth( 'Class', 28, 1 );
- $regexes->setColWidth( 'Code', 14, 1 );
- for my $regex ( sort keys %{ $actions->{regex} } ) {
- my ( $class, $code ) = @{ $actions->{regex}->{$regex} };
- $regexes->addRow( $regex, $class, $code );
- }
- $self->log->debug( 'Loaded regex actions', $regexes->draw )
- if ( @{ $regexes->{tbl_rows} } && $self->debug );
-}
-
-=item $c->stash
-
-Returns a hashref containing all your data.
+sub run { }
- $c->stash->{foo} ||= 'yada';
- print $c->stash->{foo};
+=head2 $self->write($c, $buffer)
=cut
-sub stash {
- my $self = shift;
- if ( $_[0] ) {
- my $stash = $_[1] ? {@_} : $_[0];
- while ( my ( $key, $val ) = each %$stash ) {
- $self->{stash}->{$key} = $val;
- }
- }
- return $self->{stash};
-}
+sub write {
+ my ( $self, $c, $buffer ) = @_;
-sub _prefix {
- my ( $class, $name ) = @_;
- my $prefix = _class2prefix($class);
- $name = "$prefix/$name" if $prefix;
- return $name;
-}
-
-sub _class2prefix {
- my $class = shift || '';
- my $prefix;
- if ( $class =~ /^.*::([MVC]|Model|View|Controller)?::(.*)$/ ) {
- $prefix = lc $2;
- $prefix =~ s/\:\:/\//g;
+ unless ( $self->{_prepared_write} ) {
+ $self->prepare_write($c);
+ $self->{_prepared_write} = 1;
}
- return $prefix;
+
+ print STDOUT $buffer;
}
-=back
+=head1 AUTHORS
-=head1 AUTHOR
+Sebastian Riedel, <sri@cpan.org>
-Sebastian Riedel, C<sri@cpan.org>
+Andy Grundman, <andy@hybridized.org>
=head1 COPYRIGHT