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=94e5290f012a124f59e248f7d115dae0d11fe8f9;hb=b0bb11ec8c056e043e87cd7733125ffc9d9bcfb0;hpb=749472d6839708f3c04912c0ed39ce6141d4d500 diff --git a/lib/Catalyst/Dispatcher.pm b/lib/Catalyst/Dispatcher.pm index 94e5290..5def763 100644 --- a/lib/Catalyst/Dispatcher.pm +++ b/lib/Catalyst/Dispatcher.pm @@ -5,6 +5,9 @@ use base 'Class::Accessor::Fast'; use Catalyst::Exception; use Catalyst::Utils; use Catalyst::Action; +use Catalyst::ActionContainer; +use Catalyst::DispatchType::Default; +use Catalyst::DispatchType::Index; use Text::ASCIITable; use Tree::Simple; use Tree::Simple::Visitor::FindByPath; @@ -12,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/); +__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 @@ -44,62 +53,9 @@ sub detach { sub dispatch { my ( $self, $c ) = @_; - 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 = - Catalyst::Utils::class2prefix( $result->[0]->[0]->namespace, - $c->config->{case_sensitive} ); - } - } - - my $default = $action eq 'default' ? $namespace : undef; - my $results = $c->get_action( $action, $default, $default ? 1 : 0 ); - $namespace ||= '/'; - - if ( @{$results} ) { - - # Errors break the normal flow and the end action is instantly run - my $error = 0; - - # Execute last begin - $c->state(1); - if ( my $begin = @{ $c->get_action( 'begin', $namespace, 1 ) }[-1] ) { - $begin->[0]->execute($c); - $error++ if scalar @{ $c->error }; - } - - # Execute the auto chain - my $autorun = 0; - for my $auto ( @{ $c->get_action( 'auto', $namespace, 1 ) } ) { - last if $error; - $autorun++; - $auto->[0]->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 ( ( my $action = $c->req->action ) && $mkay ) { - unless ($error) { - if ( my $result = - @{ $c->get_action( $action, $default, 1 ) }[-1] ) - { - $result->[0]->execute($c); - $error++ if scalar @{ $c->error }; - } - } - } - # Execute last end - if ( my $end = @{ $c->get_action( 'end', $namespace, 1 ) }[-1] ) { - $end->[0]->execute($c); - } + if ( $c->action ) { + $c->forward( join( '/', '', $c->namespace, '_DISPATCH' ) ); } else { @@ -130,37 +86,34 @@ sub forward { my $caller = ( caller(1) )[0]->isa('Catalyst::Dispatcher') && ( ( caller(2) )[3] =~ /::detach$/ ) ? caller(3) : caller(1); - my $namespace = '/'; my $arguments = ( ref( $_[-1] ) eq 'ARRAY' ) ? pop(@_) : $c->req->args; my $results = []; - if ( $command =~ /^\// ) { - if ( $command =~ /^\/(\w+)$/ ) { - $results = $c->get_action( $1, $namespace ); - } - else { - my $command_copy = $command; - my @extra_args; - DESCEND: while ( $command_copy =~ s/^\/(.*)\/(\w+)$/\/$1/ ) { - my $tail = $2; - if ( $results = $c->get_action( $tail, $1 ) ) { - $command = $tail; - $namespace = $command_copy; - push( @{$arguments}, @extra_args ); - last DESCEND; - } - unshift( @extra_args, $tail ); - } - } - $command =~ s/^\///; + 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 =~ /\// ) { + $results = $c->get_action( $command_copy, '/' ); + } else { - $namespace = - Catalyst::Utils::class2prefix( $caller, $c->config->{case_sensitive} ) - || '/'; - $results = $c->get_action( $command, $namespace ); + 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; + } + unshift( @extra_args, $tail ); + } } unless ( @{$results} ) { @@ -179,8 +132,10 @@ qq/Couldn't forward to command "$command". Invalid action or component./; if ( my $code = $c->components->{$class}->can($method) ) { my $action = Catalyst::Action->new( { + name => $method, code => $code, reverse => "$class->$method", + class => $class, namespace => $class, } ); @@ -219,38 +174,23 @@ sub prepare_action { my @path = split /\//, $c->req->path; $c->req->args( \my @args ); - while (@path) { + push( @path, '/' ) unless @path; # Root action + + DESCEND: 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; - } + $path = '' if $path eq '/'; # Root action + + # Check out dispatch types to see if any will handle the path at + # this level - $c->req->match($path); - last; + foreach my $type ( @{ $self->dispatch_types } ) { + last DESCEND if $type->match( $c, $path ); } - unshift @args, pop @path; - } - unless ( $c->req->action ) { - $c->req->action('default'); - $c->req->match(''); + # If not, move the last part path to args + + unshift @args, pop @path; } $c->log->debug( 'Arguments are "' . join( '/', @args ) . '"' ) @@ -265,180 +205,166 @@ sub get_action { my ( $self, $c, $action, $namespace, $inherit ) = @_; return [] unless $action; $namespace ||= ''; - $inherit ||= 0; - - if ($namespace) { - $namespace = '' if $namespace eq '/'; - my $parent = $self->tree; - my @results; - - if ($inherit) { - my $result = - $self->actions->{private}->{ $parent->getUID }->{$action}; - push @results, [$result] if $result; - my $visitor = Tree::Simple::Visitor::FindByPath->new; - - SEARCH: - for my $part ( split '/', $namespace ) { - $visitor->setSearchPath($part); - $parent->accept($visitor); - my $child = $visitor->getResult; - my $uid = $child->getUID if $child; - my $match = $self->actions->{private}->{$uid}->{$action} - if $uid; - push @results, [$match] if $match; - if ($child) { - $parent = $child; - } - else { - last SEARCH; - } - } + $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 + if ( defined $node->{$action} + && ( $node->{$action}->namespace eq $namespace ) ) + { + return [ [ $node->{$action} ] ]; } - else { - - if ($namespace) { - my $visitor = Tree::Simple::Visitor::FindByPath->new; - $visitor->setSearchPath( split '/', $namespace ); - $parent->accept($visitor); - my $child = $visitor->getResult; - my $uid = $child->getUID if $child; - my $match = $self->actions->{private}->{$uid}->{$action} - if $uid; - push @results, [$match] if $match; - } - - else { - my $result = - $self->actions->{private}->{ $parent->getUID }->{$action}; - push @results, [$result] if $result; - } - + return []; } - return \@results; } +} - elsif ( my $p = $self->actions->{plain}->{$action} ) { return [ [$p] ] } - elsif ( my $r = $self->actions->{regex}->{$action} ) { return [ [$r] ] } +=item $self->get_containers( $namespace ) - else { +=cut - for my $i ( 0 .. $#{ $self->actions->{compiled} } ) { - my $name = $self->actions->{compiled}->[$i]->[0]; - my $regex = $self->actions->{compiled}->[$i]->[1]; +sub get_containers { + my ( $self, $namespace ) = @_; - if ( my @snippets = ( $action =~ $regex ) ) { - return [ - [ $self->actions->{regex}->{$name}, $name, \@snippets ] ]; - } + # If the namespace is / just return the root ActionContainer - } + 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); + $self->tree->accept($visitor); + + my @match = $visitor->getResults; + @match = ( $self->tree ) unless @match; + + 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, + # not the foo and foo/bar nodes as it should. This does another + # single-level search to see if that's the case, and the 'last unless' + # 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; } - return []; + + 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 %flags; + my %attributes; for my $attr ( @{$attrs} ) { - if ( $attr =~ /^(Local|Relative)$/ ) { $flags{local}++ } - elsif ( $attr =~ /^(Global|Absolute)$/ ) { $flags{global}++ } - elsif ( $attr =~ /^Path\(\s*(.+)\s*\)$/i ) { - push @{ $flags{path} }, $1; - } - elsif ( $attr =~ /^Private$/i ) { $flags{private}++ } - elsif ( $attr =~ /^(Regex|Regexp)\(\s*(.+)\s*\)$/i ) { - push @{ $flags{regex} }, $2; + + # Parse out :Foo(bar) into Foo => bar etc (and arrayify) + + 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/ ); + } + push( @{ $attributes{$key} }, $value ); } } - if ( $flags{private} && ( keys %flags > 1 ) ) { + 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; } - return unless keys %flags; + return unless keys %attributes; my $parent = $self->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) ); + if ($namespace) { + for my $part ( split '/', $namespace ) { $visitor->setSearchPath($part); $parent->accept($visitor); - $child = $visitor->getResult; - } + my $child = $visitor->getResult; - $parent = $child; + unless ($child) { + + # Create a new tree node and an ActionContainer to form + # its value. + + 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( { - code => $code, - reverse => $reverse, - namespace => $namespace, + name => $method, + code => $code, + reverse => $reverse, + namespace => $namespace, + class => $class, + attributes => \%attributes, } ); - my $uid = $parent->getUID; - $self->actions->{private}->{$uid}->{$method} = $action; - - my @path; - for my $path ( @{ $flags{path} } ) { - $path =~ s/^\w+//; - $path =~ s/\w+$//; - if ( $path =~ /^\s*'(.*)'\s*$/ ) { $path = $1 } - if ( $path =~ /^\s*"(.*)"\s*$/ ) { $path = $1 } - push @path, $path; - } - $flags{path} = \@path; - - my @regex; - for my $regex ( @{ $flags{regex} } ) { - $regex =~ s/^\w+//; - $regex =~ s/\w+$//; - if ( $regex =~ /^\s*'(.*)'\s*$/ ) { $regex = $1 } - if ( $regex =~ /^\s*"(.*)"\s*$/ ) { $regex = $1 } - push @regex, $regex; - } - $flags{regex} = \@regex; - - if ( $flags{local} || $flags{global} ) { - push( @{ $flags{path} }, $prefix ? "/$prefix/$method" : "/$method" ) - if $flags{local}; - - push( @{ $flags{path} }, "/$method" ) if $flags{global}; - } + # Set the method value + $parent->getNodeValue->actions->{$method} = $action; - for my $path ( @{ $flags{path} } ) { - if ( $path =~ /^\// ) { $path =~ s/^\/// } - else { $path = $prefix ? "$prefix/$path" : $path } - $self->actions->{plain}->{$path} = $action; - } - - for my $regex ( @{ $flags{regex} } ) { - push @{ $self->actions->{compiled} }, [ $regex, qr#$regex# ]; - $self->actions->{regex}->{$regex} = $action; + # Pass the action to our dispatch types so they can register it if reqd. + foreach my $type ( @{ $self->dispatch_types } ) { + $type->register( $c, $action ); } } @@ -447,22 +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( [] ); + + # 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 - $self->tree( Tree::Simple->new( 0, Tree::Simple->ROOT ) ); + 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'); @@ -472,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 ); @@ -514,45 +444,25 @@ sub setup_actions { my ( $walker, $parent, $prefix ) = @_; $prefix .= $parent->getNodeValue || ''; $prefix .= '/' unless $prefix =~ /\/$/; - my $uid = $parent->getUID; - - for my $action ( keys %{ $actions->{private}->{$uid} } ) { - my $action_obj = $actions->{private}->{$uid}->{$action}; - $privates->addRow( "$prefix$action", $action_obj->namespace ); + my $node = $parent->getNodeValue->actions; + + for my $action ( keys %{$node} ) { + my $action_obj = $node->{$action}; + 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