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=5fc33c0d1345135ffde317b01644b747e1d471ca;hp=e1297483f57e82cb0113901394473dcc8e837a1c;hb=684d10edf63074f94667d437db01d30b8d13cefc;hpb=6b23994966a2a66b90986a51e7e1d71f62d90f44 diff --git a/lib/Catalyst/Dispatcher.pm b/lib/Catalyst/Dispatcher.pm index e129748..5fc33c0 100644 --- a/lib/Catalyst/Dispatcher.pm +++ b/lib/Catalyst/Dispatcher.pm @@ -6,17 +6,25 @@ 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 Text::ASCIITable; +use Catalyst::DispatchType::Index; +use Text::SimpleTable; use Tree::Simple; 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 registered_dispatch_types + method_action_class action_container_class/ +); + +# Preload these action types +our @PRELOAD = qw/Path Regex/; + +# Postload these action types +our @POSTLOAD = qw/Index Default/; =head1 NAME @@ -50,57 +58,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 { @@ -127,42 +85,42 @@ sub forward { return 0; } - # Relative forwards from detach - my $caller = ( caller(1) )[0]->isa('Catalyst::Dispatcher') - && ( ( caller(2) )[3] =~ /::detach$/ ) ? caller(3) : caller(1); - my $arguments = ( ref( $_[-1] ) eq 'ARRAY' ) ? pop(@_) : $c->req->args; - my $results = []; + my $result; - my $command_copy = $command; + unless ( ref $command ) { + my $command_copy = $command; - unless ( $command_copy =~ s/^\/// ) { - my $namespace = - Catalyst::Utils::class2prefix( $caller, $c->config->{case_sensitive} ) || ''; - $command_copy = "${namespace}/${command}"; - } + unless ( $command_copy =~ s/^\/// ) { + my $namespace = $c->namespace; + $command_copy = "${namespace}/${command}"; + } - unless ( $command_copy =~ /\// ) { - $results = $c->get_action( $command_copy, '/' ); - } - else { - my @extra_args; - DESCEND: while ( $command_copy =~ s/^(.*)\/(\w+)$/$1/ ) { - my $tail = $2; - $results = $c->get_action( $tail, $1 ); - if ( @{$results} ) { - $command = $tail; - push( @{$arguments}, @extra_args ); - last DESCEND; + unless ( $command_copy =~ /\// ) { + $result = $c->get_action( $command_copy, '/' ); + } + else { + my @extra_args; + DESCEND: while ( $command_copy =~ s/^(.*)\/(\w+)$/$1/ ) { + my $tail = $2; + $result = $c->get_action( $tail, $1 ); + if ($result) { + $command = $tail; + push( @{$arguments}, @extra_args ); + last DESCEND; + } + unshift( @extra_args, $tail ); } - unshift( @extra_args, $tail ); } } - unless ( @{$results} ) { + unless ($result) { + + my $class = ref($command) || ref( $c->component($command) ); + my $method = shift || 'process'; - unless ( $c->components->{$command} ) { + unless ($class) { my $error = qq/Couldn't forward to command "$command". Invalid action or component./; $c->error($error); @@ -170,20 +128,17 @@ qq/Couldn't forward to command "$command". Invalid action or component./; return 0; } - my $class = $command; - my $method = shift || 'process'; - - if ( my $code = $c->components->{$class}->can($method) ) { - my $action = Catalyst::Action->new( + if ( my $code = $class->can($method) ) { + my $action = $self->method_action_class->new( { name => $method, code => $code, reverse => "$class->$method", + class => $class, namespace => $class, - prefix => $class, } ); - $results = [ [$action] ]; + $result = $action; } else { @@ -199,11 +154,7 @@ qq/Couldn't forward to command "$command". Invalid action or component./; local $c->request->{arguments} = [ @{$arguments} ]; - for my $result ( @{$results} ) { - $result->[0]->execute($c); - return if scalar @{ $c->error }; - last unless $c->state; - } + $result->execute($c); return $c->state; } @@ -218,13 +169,22 @@ 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; - foreach my $type (@{$self->dispatch_types}) { - last DESCEND if $type->prepare_action($c, $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->match( $c, $path ); } + # If not, move the last part path to args + unshift @args, pop @path; } @@ -232,30 +192,38 @@ sub prepare_action { if ( $c->debug && @args ); } -=item $self->get_action( $c, $action, $namespace, $inherit ) +=item $self->get_action( $action, $namespace ) =cut sub get_action { - my ( $self, $c, $action, $namespace, $inherit ) = @_; - return [] unless $action; + my ( $self, $name, $namespace ) = @_; + return unless $name; $namespace ||= ''; - $inherit ||= 0; - - if ($namespace) { + $namespace = '' if $namespace eq '/'; - my @match = $self->get_containers( $namespace ); + my @match = $self->get_containers($namespace); - my @results; + return unless @match; - foreach my $child ($inherit ? @match: $match[-1]) { - my $node = $child->actions; - push(@results, [ $node->{$action} ]) if defined $node->{$action}; - } - return \@results; + if ( my $action = $match[-1]->get_action($name) ) { + return $action if $action->namespace eq $namespace; } +} - return []; +=item $self->get_actions( $c, $action, $namespace ) + +=cut + +sub get_actions { + my ( $self, $c, $action, $namespace ) = @_; + return [] unless $action; + $namespace ||= ''; + $namespace = '' if $namespace eq '/'; + + my @match = $self->get_containers($namespace); + + return map { $_->get_action($action) } @match; } =item $self->get_containers( $namespace ) @@ -267,20 +235,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, @@ -289,90 +258,64 @@ 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]; - last unless $extra; - $visitor->setSearchPath($extra); - $match[-1]->accept($visitor); - push(@match, $visitor->getResult) if defined $visitor->getResult; + if ( my $extra = $path[ ( scalar @match ) - 1 ] ) { + $visitor->setSearchPath($extra); + $match[-1]->accept($visitor); + push( @match, $visitor->getResult ) if defined $visitor->getResult; + } } return map { $_->getNodeValue } @match; } -=item $self->set_action( $c, $action, $code, $namespace, $attrs ) - -=cut - -sub set_action { - my ( $self, $c, $method, $code, $namespace, $attrs ) = @_; +sub register { + my ( $self, $c, $action ) = @_; - my $prefix = - Catalyst::Utils::class2prefix( $namespace, $c->config->{case_sensitive} ) - || ''; - my %attributes; + my $namespace = $action->namespace; + my $parent = $self->tree; + my $visitor = Tree::Simple::Visitor::FindByPath->new; - for my $attr ( @{$attrs} ) { - if ( my ($key, $value) = ($attr =~ /^(.*?)(?:\(\s*(.+)\s*\))?$/) ) { - if ( defined $value ) { - ($value =~ s/^'(.*)'$/$1/) || ($value =~ s/^"(.*)"/$1/); - } - push(@{$attributes{$key}}, $value); - } - } - - if ( $attributes{Private} && ( keys %attributes > 1 ) ) { - $c->log->debug( 'Bad action definition "' - . join( ' ', @{$attrs} ) - . qq/" for "$namespace->$method"/ ) - if $c->debug; - return; - } - return unless keys %attributes; - - 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; + # Set the method value + $parent->getNodeValue->actions->{ $action->name } = $action; - my $action = Catalyst::Action->new( - { - name => $method, - code => $code, - reverse => $reverse, - namespace => $namespace, - prefix => $prefix, - attributes => \%attributes, - } - ); + my $registered = $self->registered_dispatch_types; - # Set the method value - $parent->getNodeValue->actions->{$method} = $action; + foreach my $key ( keys %{ $action->attributes } ) { + my $class = "Catalyst::DispatchType::$key"; + unless ( $registered->{$class} ) { + eval "require $class"; + push( @{ $self->dispatch_types }, $class->new ) unless $@; + $registered->{$class} = 1; + } + } + # 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 ); } } @@ -381,118 +324,74 @@ sub set_action { =cut sub setup_actions { - my ( $self, $class ) = @_; - - # These are the core structures - $self->actions( - { - plain => {}, - private => {}, - regex => {}, - compiled => [] - } - ); + my ( $self, $c ) = @_; - $self->dispatch_types([ - map { "Catalyst::DispatchType::$_"->new } - qw/Path Regex Default/ ]); + $self->dispatch_types( [] ); + $self->registered_dispatch_types( {} ); + $self->method_action_class('Catalyst::Action'); + $self->action_container_class('Catalyst::ActionContainer'); + + # 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; + $self->registered_dispatch_types->{$class} = 1; + } # 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 } ) { - - # We only setup components that inherit from Catalyst::Base - next unless $comp->isa('Catalyst::Base'); - - for my $action ( @{ Catalyst::Utils::reflect_actions($comp) } ) { - 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}; - $class->set_action( $name, $code, $comp, $attrs ); - last; - } - - } - - } - - } + foreach my $comp ( values %{ $c->components } ) { + $comp->register_actions($c) if $comp->can('register_actions'); + } + # 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 ); - $privates->setColWidth( 'Class', 37, 1 ); + my $privates = Text::SimpleTable->new( + [ 24, 'Private' ], + [ 23, 'Class' ], + [ 23, 'Method' ] + ); + my $has_private = 0; my $walker = sub { my ( $walker, $parent, $prefix ) = @_; $prefix .= $parent->getNodeValue || ''; $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->row( "$prefix$action", $action_obj->class, $action ); + $has_private = 1; } $walker->( $walker, $_, $prefix ) for $parent->getAllChildren; }; $walker->( $walker, $self->tree, '' ); - $class->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" ); - } + $c->log->debug( "Loaded Private actions:\n" . $privates->draw ) + if ($has_private); - $class->log->debug( "Loaded regex actions:\n" . $regexes->draw ) - if ( @{ $regexes->{tbl_rows} } ); + # List all public actions + $_->list($c) for @{ $self->dispatch_types }; } =back @@ -500,6 +399,7 @@ sub setup_actions { =head1 AUTHOR Sebastian Riedel, C +Matt S Trout, C =head1 COPYRIGHT