X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=catagits%2FCatalyst-Runtime.git;a=blobdiff_plain;f=lib%2FCatalyst%2FDispatcher.pm;h=5def763c1ce5844404d6f3ed9d7c6bb0a8974275;hp=32a60a0a8c38e573a5746feafa336fef500cf8cd;hb=b0bb11ec8c056e043e87cd7733125ffc9d9bcfb0;hpb=22f3a8dd32e5940d87a1d21642fa39c7813bc921 diff --git a/lib/Catalyst/Dispatcher.pm b/lib/Catalyst/Dispatcher.pm index 32a60a0..5def763 100644 --- a/lib/Catalyst/Dispatcher.pm +++ b/lib/Catalyst/Dispatcher.pm @@ -6,9 +6,8 @@ use Catalyst::Exception; use Catalyst::Utils; use Catalyst::Action; use Catalyst::ActionContainer; -use Catalyst::DispatchType::Path; -use Catalyst::DispatchType::Regex; use Catalyst::DispatchType::Default; +use Catalyst::DispatchType::Index; use Text::ASCIITable; use Tree::Simple; use Tree::Simple::Visitor::FindByPath; @@ -16,7 +15,13 @@ use Tree::Simple::Visitor::FindByPath; # Stringify to class use overload '""' => sub { return ref shift }, fallback => 1; -__PACKAGE__->mk_accessors(qw/actions tree dispatch_types/); +__PACKAGE__->mk_accessors(qw/tree dispatch_types/); + +# Preload these action types +our @PRELOAD = qw/Path Regex/; + +# Postload these action types +our @POSTLOAD = qw/Index Default/; =head1 NAME @@ -50,57 +55,7 @@ sub dispatch { my ( $self, $c ) = @_; if ( $c->action ) { - - my @containers = $self->get_containers( $c->namespace ); - my %actions; - foreach my $name (qw/begin auto end/) { - - # Go down the container list representing each part of the - # current namespace inheritance tree, grabbing the actions hash - # of the ActionContainer object and looking for actions of the - # appropriate name registered to the namespace - - $actions{$name} = [ - map { $_->{$name} } - grep { exists $_->{$name} } - map { $_->actions } - @containers - ]; - } - - # Errors break the normal flow and the end action is instantly run - my $error = 0; - - # Execute last begin - $c->state(1); - if ( my $begin = @{ $actions{begin} }[-1] ) { - $begin->execute($c); - $error++ if scalar @{ $c->error }; - } - - # Execute the auto chain - my $autorun = 0; - for my $auto ( @{ $actions{auto} } ) { - last if $error; - $autorun++; - $auto->execute($c); - $error++ if scalar @{ $c->error }; - last unless $c->state; - } - - # Execute the action or last default - my $mkay = $autorun ? $c->state ? 1 : 0 : 1; - if ( $mkay ) { - unless ($error) { - $c->action->execute($c); - $error++ if scalar @{ $c->error }; - } - } - - # Execute last end - if ( my $end = @{ $actions{end} }[-1] ) { - $end->execute($c); - } + $c->forward( join( '/', '', $c->namespace, '_DISPATCH' ) ); } else { @@ -139,7 +94,8 @@ sub forward { unless ( $command_copy =~ s/^\/// ) { my $namespace = - Catalyst::Utils::class2prefix( $caller, $c->config->{case_sensitive} ) || ''; + Catalyst::Utils::class2prefix( $caller, $c->config->{case_sensitive} ) + || ''; $command_copy = "${namespace}/${command}"; } @@ -179,8 +135,8 @@ qq/Couldn't forward to command "$command". Invalid action or component./; name => $method, code => $code, reverse => "$class->$method", + class => $class, namespace => $class, - prefix => $class, } ); $results = [ [$action] ]; @@ -218,14 +174,18 @@ sub prepare_action { my @path = split /\//, $c->req->path; $c->req->args( \my @args ); + push( @path, '/' ) unless @path; # Root action + DESCEND: while (@path) { $path = join '/', @path; + $path = '' if $path eq '/'; # Root action + # Check out dispatch types to see if any will handle the path at # this level - foreach my $type (@{$self->dispatch_types}) { - last DESCEND if $type->prepare_action($c, $path); + foreach my $type ( @{ $self->dispatch_types } ) { + last DESCEND if $type->match( $c, $path ); } # If not, move the last part path to args @@ -245,22 +205,31 @@ sub get_action { my ( $self, $c, $action, $namespace, $inherit ) = @_; return [] unless $action; $namespace ||= ''; - $inherit ||= 0; - - if ($namespace) { - - my @match = $self->get_containers( $namespace ); - - my @results; + $namespace = '' if $namespace eq '/'; + $inherit ||= 0; + + my @match = $self->get_containers($namespace); + + if ($inherit) { # Return [ [ $act_obj ], ... ] for valid containers + return [ + map { [ $_->{$action} ] } # Make [ $action_obj ] + grep { defined $_->{$action} } # If it exists in the container + map { $_->actions } # Get action hash for container + @match + ]; + } + else { + my $node = $match[-1]->actions; # Only bother looking at the last one - foreach my $child ($inherit ? @match: $match[-1]) { - my $node = $child->actions; - push(@results, [ $node->{$action} ]) if defined $node->{$action}; + if ( defined $node->{$action} + && ( $node->{$action}->namespace eq $namespace ) ) + { + return [ [ $node->{$action} ] ]; + } + else { + return []; } - return \@results; } - - return []; } =item $self->get_containers( $namespace ) @@ -272,20 +241,21 @@ sub get_containers { # If the namespace is / just return the root ActionContainer - return ($self->tree->getNodeValue) if $namespace eq '/'; + return ( $self->tree->getNodeValue ) + if ( !$namespace || ( $namespace eq '/' ) ); # Use a visitor to recurse down the tree finding the ActionContainers # for each namespace in the chain. my $visitor = Tree::Simple::Visitor::FindByPath->new; - my @path = split('/', $namespace); - $visitor->setSearchPath( @path ); + my @path = split( '/', $namespace ); + $visitor->setSearchPath(@path); $self->tree->accept($visitor); my @match = $visitor->getResults; - @match = ($self->tree) unless @match; + @match = ( $self->tree ) unless @match; - if (!defined $visitor->getResult) { + if ( !defined $visitor->getResult ) { # If we don't manage to match, the visitor doesn't return the last # node is matched, so foo/bar/baz would only find the 'foo' node, @@ -294,25 +264,25 @@ sub get_containers { # should catch any failures - or short-circuit this if this *is* a # bug in the visitor and gets fixed. - my $extra = $path[(scalar @match) - 1]; + my $extra = $path[ ( scalar @match ) - 1 ]; last unless $extra; $visitor->setSearchPath($extra); $match[-1]->accept($visitor); - push(@match, $visitor->getResult) if defined $visitor->getResult; + push( @match, $visitor->getResult ) if defined $visitor->getResult; } return map { $_->getNodeValue } @match; } -=item $self->set_action( $c, $action, $code, $namespace, $attrs ) +=item $self->set_action( $c, $action, $code, $class, $attrs ) =cut sub set_action { - my ( $self, $c, $method, $code, $namespace, $attrs ) = @_; + my ( $self, $c, $method, $code, $class, $attrs ) = @_; - my $prefix = - Catalyst::Utils::class2prefix( $namespace, $c->config->{case_sensitive} ) + my $namespace = + Catalyst::Utils::class2prefix( $class, $c->config->{case_sensitive} ) || ''; my %attributes; @@ -320,18 +290,30 @@ sub set_action { # Parse out :Foo(bar) into Foo => bar etc (and arrayify) - if ( my ($key, $value) = ($attr =~ /^(.*?)(?:\(\s*(.+)\s*\))?$/) ) { + my %initialized; + $initialized{ ref $_ }++ for @{ $self->dispatch_types }; + + if ( my ( $key, $value ) = ( $attr =~ /^(.*?)(?:\(\s*(.+)\s*\))?$/ ) ) { + + # Initialize types + my $class = "Catalyst::DispatchType::$key"; + unless ( $initialized{$class} ) { + eval "require $class"; + push( @{ $self->dispatch_types }, $class->new ) unless $@; + $initialized{$class}++; + } + if ( defined $value ) { - ($value =~ s/^'(.*)'$/$1/) || ($value =~ s/^"(.*)"/$1/); + ( $value =~ s/^'(.*)'$/$1/ ) || ( $value =~ s/^"(.*)"/$1/ ); } - push(@{$attributes{$key}}, $value); + push( @{ $attributes{$key} }, $value ); } } if ( $attributes{Private} && ( keys %attributes > 1 ) ) { $c->log->debug( 'Bad action definition "' . join( ' ', @{$attrs} ) - . qq/" for "$namespace->$method"/ ) + . qq/" for "$class->$method"/ ) if $c->debug; return; } @@ -340,30 +322,31 @@ sub set_action { my $parent = $self->tree; my $visitor = Tree::Simple::Visitor::FindByPath->new; - if ($prefix) { - for my $part ( split '/', $prefix ) { + if ($namespace) { + for my $part ( split '/', $namespace ) { $visitor->setSearchPath($part); $parent->accept($visitor); my $child = $visitor->getResult; - + unless ($child) { # Create a new tree node and an ActionContainer to form # its value. - my $container = Catalyst::ActionContainer->new( - { part => $part, actions => {} }); + my $container = + Catalyst::ActionContainer->new( + { part => $part, actions => {} } ); $child = $parent->addChild( Tree::Simple->new($container) ); $visitor->setSearchPath($part); $parent->accept($visitor); $child = $visitor->getResult; } - + $parent = $child; } } - my $reverse = $prefix ? "$prefix/$method" : $method; + my $reverse = $namespace ? "$namespace/$method" : $method; my $action = Catalyst::Action->new( { @@ -371,7 +354,7 @@ sub set_action { code => $code, reverse => $reverse, namespace => $namespace, - prefix => $prefix, + class => $class, attributes => \%attributes, } ); @@ -381,7 +364,7 @@ sub set_action { # Pass the action to our dispatch types so they can register it if reqd. foreach my $type ( @{ $self->dispatch_types } ) { - $type->register_action($c, $action); + $type->register( $c, $action ); } } @@ -390,28 +373,25 @@ sub set_action { =cut sub setup_actions { - my ( $self, $class ) = @_; + my ( $self, $c ) = @_; - # These are the core structures - $self->actions( - { - plain => {}, - private => {}, - regex => {}, - compiled => [] - } - ); + $self->dispatch_types( [] ); - $self->dispatch_types([ - map { "Catalyst::DispatchType::$_"->new } - qw/Path Regex Default/ ]); + # Preload action types + for my $type (@PRELOAD) { + my $class = "Catalyst::DispatchType::$type"; + eval "require $class"; + Catalyst::Exception->throw( message => qq/Couldn't load "$class"/ ) + if $@; + push @{ $self->dispatch_types }, $class->new; + } # We use a tree - my $container = Catalyst::ActionContainer->new( - { part => '/', actions => {} } ); + my $container = + Catalyst::ActionContainer->new( { part => '/', actions => {} } ); $self->tree( Tree::Simple->new( $container, Tree::Simple->ROOT ) ); - for my $comp ( keys %{ $class->components } ) { + for my $comp ( keys %{ $c->components } ) { # We only setup components that inherit from Catalyst::Base next unless $comp->isa('Catalyst::Base'); @@ -421,39 +401,40 @@ sub setup_actions { my $name = ''; no strict 'refs'; my @cache = ( $comp, @{"$comp\::ISA"} ); - my %namespaces; + my %classes; - while ( my $namespace = shift @cache ) { - $namespaces{$namespace}++; - for my $isa ( @{"$comp\::ISA"} ) { - next if $namespaces{$isa}; + while ( my $class = shift @cache ) { + $classes{$class}++; + for my $isa ( @{"$class\::ISA"} ) { + next if $classes{$isa}; push @cache, $isa; - $namespaces{$isa}++; + $classes{$isa}++; } } - for my $namespace ( keys %namespaces ) { - - for my $sym ( values %{ $namespace . '::' } ) { - + for my $class ( keys %classes ) { + for my $sym ( values %{ $class . '::' } ) { if ( *{$sym}{CODE} && *{$sym}{CODE} == $code ) { - $name = *{$sym}{NAME}; - $class->set_action( $name, $code, $comp, $attrs ); + $self->set_action( $c, $name, $code, $comp, $attrs ); last; } - } - } - } + } + # Postload action types + for my $type (@POSTLOAD) { + my $class = "Catalyst::DispatchType::$type"; + eval "require $class"; + Catalyst::Exception->throw( message => qq/Couldn't load "$class"/ ) + if $@; + push @{ $self->dispatch_types }, $class->new; } - return unless $class->debug; + return unless $c->debug; - my $actions = $self->actions; my $privates = Text::ASCIITable->new; $privates->setCols( 'Private', 'Class' ); $privates->setColWidth( 'Private', 36, 1 ); @@ -465,43 +446,23 @@ sub setup_actions { $prefix .= '/' unless $prefix =~ /\/$/; my $node = $parent->getNodeValue->actions; - for my $action ( keys %{ $node } ) { + for my $action ( keys %{$node} ) { my $action_obj = $node->{$action}; - $privates->addRow( "$prefix$action", $action_obj->namespace ); + next + if ( ( $action =~ /^_.*/ ) + && ( !$c->config->{show_internal_actions} ) ); + $privates->addRow( "$prefix$action", $action_obj->class ); } $walker->( $walker, $_, $prefix ) for $parent->getAllChildren; }; $walker->( $walker, $self->tree, '' ); - $class->log->debug( "Loaded private actions:\n" . $privates->draw ) + $c->log->debug( "Loaded Private actions:\n" . $privates->draw ) if ( @{ $privates->{tbl_rows} } ); - my $publics = Text::ASCIITable->new; - $publics->setCols( 'Public', 'Private' ); - $publics->setColWidth( 'Public', 36, 1 ); - $publics->setColWidth( 'Private', 37, 1 ); - - for my $plain ( sort keys %{ $actions->{plain} } ) { - my $action = $actions->{plain}->{$plain}; - $publics->addRow( "/$plain", "/$action" ); - } - - $class->log->debug( "Loaded public actions:\n" . $publics->draw ) - if ( @{ $publics->{tbl_rows} } ); - - my $regexes = Text::ASCIITable->new; - $regexes->setCols( 'Regex', 'Private' ); - $regexes->setColWidth( 'Regex', 36, 1 ); - $regexes->setColWidth( 'Private', 37, 1 ); - - for my $regex ( sort keys %{ $actions->{regex} } ) { - my $action = $actions->{regex}->{$regex}; - $regexes->addRow( $regex, "/$action" ); - } - - $class->log->debug( "Loaded regex actions:\n" . $regexes->draw ) - if ( @{ $regexes->{tbl_rows} } ); + # List all public actions + $_->list($c) for @{ $self->dispatch_types }; } =back