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;
# 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
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 ( ( my $action = $c->req->action ) && $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 {
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}";
}
if ( my $code = $c->components->{$class}->can($method) ) {
my $action = Catalyst::Action->new(
{
+ name => $method,
code => $code,
reverse => "$class->$method",
+ class => $class,
namespace => $class,
- prefix => $class,
}
);
$results = [ [$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
- $c->req->match($path);
- $c->action($result->[0]);
- $c->namespace($result->[0]->prefix);
- last;
- }
- unshift @args, pop @path;
- }
+ # Check out dispatch types to see if any will handle the path at
+ # this level
- unless ( $c->req->action ) {
- my $result = @{$c->get_action('default', $c->req->path, 1) || []}[-1];
- if ($result) {
- $c->action( $result->[0] );
- $c->namespace( $c->req->path );
- $c->req->action('default');
- $c->req->match('');
+ 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;
}
$c->log->debug( 'Arguments are "' . join( '/', @args ) . '"' )
my ( $self, $c, $action, $namespace, $inherit ) = @_;
return [] unless $action;
$namespace ||= '';
- $inherit ||= 0;
-
- if ($namespace) {
-
- my @match = $self->get_containers( $namespace );
-
- my @results;
-
- foreach my $child ($inherit ? @match: $match[-1]) {
- my $node = $child->actions;
- push(@results, [ $node->{$action} ]) if defined $node->{$action};
- }
- return \@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
+ ];
}
-
- elsif ( my $p = $self->actions->{plain}->{$action} ) { return [ [$p] ] }
- elsif ( my $r = $self->actions->{regex}->{$action} ) { return [ [$r] ] }
-
else {
+ my $node = $match[-1]->actions; # Only bother looking at the last one
- for my $i ( 0 .. $#{ $self->actions->{compiled} } ) {
- my $name = $self->actions->{compiled}->[$i]->[0];
- my $regex = $self->actions->{compiled}->[$i]->[1];
-
- if ( my @snippets = ( $action =~ $regex ) ) {
- return [
- [ $self->actions->{regex}->{$name}, $name, \@snippets ] ];
- }
-
+ if ( defined $node->{$action}
+ && ( $node->{$action}->namespace eq $namespace ) )
+ {
+ return [ [ $node->{$action} ] ];
+ }
+ else {
+ return [];
}
}
- return [];
}
=item $self->get_containers( $namespace )
# 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,
# 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 %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;
- 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(
{
- code => $code,
- reverse => $reverse,
- namespace => $namespace,
- prefix => $prefix,
+ name => $method,
+ code => $code,
+ reverse => $reverse,
+ namespace => $namespace,
+ class => $class,
+ attributes => \%attributes,
}
);
# Set the method value
$parent->getNodeValue->actions->{$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};
- }
-
- 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 );
}
}
=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
- 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');
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 );
$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
projects / catagits/Catalyst-Runtime.git / blobdiff