X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FCatalyst%2FEngine.pm;h=9971412b79ca47aa9193fd64c0aab06d5ad382ca;hb=e4d3065961958258b70ab8f82a4d186a98198659;hp=57e73ee7c6618d2812cb0491c99063ab4f85381a;hpb=61b1e958102e2371a79e07a7e2cdbb371797d202;p=catagits%2FCatalyst-Runtime.git diff --git a/lib/Catalyst/Engine.pm b/lib/Catalyst/Engine.pm index 57e73ee..9971412 100644 --- a/lib/Catalyst/Engine.pm +++ b/lib/Catalyst/Engine.pm @@ -1,33 +1,27 @@ package Catalyst::Engine; use strict; -use base qw/Class::Data::Inheritable Class::Accessor::Fast/; +use base + qw/Class::Data::Inheritable Class::Accessor::Fast Catalyst::Dispatcher/; use UNIVERSAL::require; use CGI::Cookie; use Data::Dumper; use HTML::Entities; use HTTP::Headers; -use Memoize; use Time::HiRes qw/gettimeofday tv_interval/; use Text::ASCIITable; use Text::ASCIITable::Wrap 'wrap'; -use Tree::Simple; -use Tree::Simple::Visitor::FindByPath; use Catalyst::Request; +use Catalyst::Request::Upload; use Catalyst::Response; require Module::Pluggable::Fast; $Data::Dumper::Terse = 1; -__PACKAGE__->mk_classdata($_) for qw/actions components tree/; +__PACKAGE__->mk_classdata('components'); __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; @@ -35,8 +29,6 @@ __PACKAGE__->tree( Tree::Simple->new( 0, Tree::Simple->ROOT ) ); our $COUNT = 1; our $START = time; -memoize('_class2prefix'); - =head1 NAME Catalyst::Engine - The Catalyst Engine @@ -47,9 +39,6 @@ See L. =head1 DESCRIPTION -This is the core of catalyst. The various drivers are subclasses -of this class. - =head1 METHODS =over 4 @@ -74,8 +63,6 @@ sub benchmark { =item $c->comp($name) -Shortcut for $c->component - =item $c->component($name) Get a component object by name. @@ -100,65 +87,6 @@ sub component { } } -=item $c->dispatch - -Dispatch request to actions. - -=cut - -sub dispatch { - my $c = shift; - 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} ) { - - # Execute last begin - $c->state(1); - if ( my $begin = @{ $c->get_action( 'begin', $namespace ) }[-1] ) { - $c->execute( @{ $begin->[0] } ); - return if scalar @{ $c->error }; - } - - # Execute the auto chain - for my $auto ( @{ $c->get_action( 'auto', $namespace ) } ) { - $c->execute( @{ $auto->[0] } ); - return if scalar @{ $c->error }; - last unless $c->state; - } - - # Execute the action or last default - if ( ( my $action = $c->req->action ) && $c->state ) { - if ( my $result = @{ $c->get_action( $action, $default ) }[-1] ) { - $c->execute( @{ $result->[0] } ); - } - } - - # Execute last end - if ( my $end = @{ $c->get_action( 'end', $namespace ) }[-1] ) { - $c->execute( @{ $end->[0] } ); - return if scalar @{ $c->error }; - } - } - 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); - } -} - =item $c->error =item $c->error($error, ...) @@ -223,8 +151,7 @@ sub execute { =item $c->finalize -Finalize request. This function can typically be overloaded with -NEXT by plugins that need to do something at the end of the request. +Finalize request. =cut @@ -236,7 +163,7 @@ sub finalize { 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->status(302) if $c->response->status !~ /^3\d\d$/; } if ( $#{ $c->error } >= 0 ) { @@ -282,8 +209,7 @@ sub finalize_cookies { =item $c->finalize_error -This is the default error screen displayed from finalize. Override -with your own output if you need something special. +Finalize error. =cut @@ -386,7 +312,7 @@ sub finalize_error { =item $c->finalize_headers -Finalize headers. Null action by default. +Finalize headers. =cut @@ -394,129 +320,15 @@ sub finalize_headers { } =item $c->finalize_output -Finalize output. Null action by default +Finalize output. =cut sub finalize_output { } -=item $c->forward($command) - -Forward processing to a private action or a method from a class. -If you define a class without method it will default to process(). - - $c->forward('/foo'); - $c->forward('/controller/action'); - $c->forward('index'); - $c->forward(qw/MyApp::Model::CDBI::Foo do_stuff/); - $c->forward('MyApp::View::TT'); - -=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 $global = $command =~ /^\// ? 0 : 1; - my $namespace = '/'; - if ( $command =~ /^\// ) { - $command =~ /^(.*)\/(\w+)$/; - $namespace = $1 || '/'; - $command = $2; - } - else { $namespace = _class2prefix($caller) || '/' } - my $results = $c->get_action( $command, $namespace, $global ); - 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; - } - } - for my $result ( @{$results} ) { - $c->execute( @{ $result->[0] } ); - return if scalar @{ $c->error }; - last unless $c->state; - } - return $c->state; -} - -=item $c->get_action( $action, $namespace, $global ) - -Get an action in a given namespace. - -=cut - -sub get_action { - my ( $c, $action, $namespace, $global ) = @_; - return [] unless $action; - $namespace ||= ''; - if ($namespace) { - if ($global) { - my @results; - for my $uid ( keys %{ $c->actions->{private} } ) { - if ( my $result = $c->actions->{private}->{$uid}->{$action} ) { - push @results, [$result]; - } - } - return \@results; - } - else { - $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 []; -} - =item $c->handler( $class, $r ) -The main request handler. +Handles the request. =cut @@ -624,7 +436,7 @@ sub prepare { =item $c->prepare_action -Prepare action for processing. +Prepare action. =cut @@ -669,7 +481,7 @@ sub prepare_action { =item $c->prepare_connection -Prepare connection. Null action by default +Prepare connection. =cut @@ -677,7 +489,7 @@ sub prepare_connection { } =item $c->prepare_cookies -Prepare cookies. +Prepare cookies. =cut @@ -691,7 +503,7 @@ sub prepare_cookies { =item $c->prepare_headers -Prepare headers. Null action by default +Prepare headers. =cut @@ -699,7 +511,7 @@ sub prepare_headers { } =item $c->prepare_parameters -Prepare parameters. Null action by default +Prepare parameters. =cut @@ -707,7 +519,7 @@ sub prepare_parameters { } =item $c->prepare_path -Prepare path and base. Null action by default +Prepare path and base. =cut @@ -715,7 +527,7 @@ sub prepare_path { } =item $c->prepare_request -Prepare the engine request. Null action by default +Prepare the engine request. =cut @@ -723,7 +535,7 @@ sub prepare_request { } =item $c->prepare_uploads -Prepare uploads. Null action by default +Prepare uploads. =cut @@ -731,110 +543,31 @@ sub prepare_uploads { } =item $c->run -Starts the engine. Null action by default +Starts the engine. =cut sub run { } -=item $c->req - -Shortcut for $c->request - =item $c->request -Returns a C object. - - my $req = $c->request; +=item $c->req -=item $c->res +Returns a C object. -Shortcut for $c->response + my $req = $c->req; =item $c->response +=item $c->res + Returns a C object. my $res = $c->res; -=item $c->set_action( $action, $code, $namespace, $attrs ) - -Set an action in a given namespace. Used to defined the actions -in the attribute handlers. - -=cut - -sub set_action { - my ( $c, $method, $code, $namespace, $attrs ) = @_; - - 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 } - } - - 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 $reverse = $prefix ? "$prefix/$method" : $method; - - 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 ? "$prefix/$path" : $path; - $c->actions->{plain}->{$name} = [ $namespace, $code ]; - } - if ( my $regex = $flags{regex} ) { - push @{ $c->actions->{compiled} }, [ $regex, qr#$regex# ]; - $c->actions->{regex}->{$regex} = [ $namespace, $code ]; - } - - $c->actions->{reverse}->{"$code"} = $reverse; -} - =item $class->setup -Setup the application. required to initialize actions. +Setup. MyApp->setup; @@ -849,44 +582,9 @@ sub setup { } } -=item $class->setup_actions($component) - -Setup actions for a component. - -=cut - -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; - } - } - } - } -} - =item $class->setup_components -Setup all the components in YourApp::(M|V|C|Model|View|Controller)::* +Setup components. =cut @@ -910,65 +608,13 @@ sub setup_components { $self->log->error( qq/Couldn't initialize "Module::Pluggable::Fast", "$error"/); } - $self->setup_actions($self); $self->components( {} ); + my @comps; for my $comp ( $self->_components($self) ) { $self->components->{ ref $comp } = $comp; - $self->setup_actions($comp); + push @comps, $comp; } - my $t = Text::ASCIITable->new( { hide_HeadRow => 1, hide_HeadLine => 1 } ); - $t->setCols('Class'); - $t->setColWidth( 'Class', 75, 1 ); - $t->addRow( wrap( $_, 75 ) ) 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( 'Private', 'Class', 'Code' ); - $privates->setColWidth( 'Private', 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( - wrap( "$prefix$action", 28 ), - wrap( $class, 28 ), - wrap( $code, 14 ) - ); - } - $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( 'Public', 'Private' ); - $publics->setColWidth( 'Public', 37, 1 ); - $publics->setColWidth( 'Private', 36, 1 ); - - for my $plain ( sort keys %{ $actions->{plain} } ) { - my ( $class, $code ) = @{ $actions->{plain}->{$plain} }; - $publics->addRow( wrap( "/$plain", 37 ), - wrap( $self->actions->{reverse}->{$code} || $code, 36 ) ); - } - $self->log->debug( 'Loaded public actions', $publics->draw ) - if ( @{ $publics->{tbl_rows} } && $self->debug ); - my $regexes = Text::ASCIITable->new; - $regexes->setCols( 'Regex', 'Private' ); - $regexes->setColWidth( 'Regex', 37, 1 ); - $regexes->setColWidth( 'Private', 36, 1 ); - for my $regex ( sort keys %{ $actions->{regex} } ) { - my ( $class, $code ) = @{ $actions->{regex}->{$regex} }; - $regexes->addRow( wrap( $regex, 37 ), - wrap( $self->actions->{reverse}->{$class} || $class, 36 ) ); - } - $self->log->debug( 'Loaded regex actions', $regexes->draw ) - if ( @{ $regexes->{tbl_rows} } && $self->debug ); + $self->setup_actions( [ $self, @comps ] ); } =item $c->state @@ -977,8 +623,7 @@ Contains the return value of the last executed action. =item $c->stash -The stash is a global hash which can be used to pass around data -between your components. +Returns a hashref containing all your data. $c->stash->{foo} ||= 'yada'; print $c->stash->{foo}; @@ -996,41 +641,11 @@ sub stash { return $self->{stash}; } -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; - } - return $prefix; -} - -=back - -=head1 SEE ALSO - -=over 4 - -=item L - Apache Engines for MP1/2 -=item L - CGI Engine -=item L - FastCGI Engine -=item L - Standalone Catalyst Server -=item L - Engine for testing - =back =head1 AUTHOR Sebastian Riedel, C -Marcus Ramberg, C =head1 COPYRIGHT