use Catalyst::Exception;
use Catalyst::Utils;
use Catalyst::Action;
-use Text::ASCIITable;
+use Catalyst::ActionContainer;
+use Catalyst::DispatchType::Default;
+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/);
+__PACKAGE__->mk_accessors(
+ qw/tree dispatch_types registered_dispatch_types
+ method_action_class action_container_class/
+);
+
+# Preload these action types
+our @PRELOAD = qw/Index Path Regex/;
+
+# Postload these action types
+our @POSTLOAD = qw/Default/;
=head1 NAME
=head1 METHODS
-=over 4
-
-=item $self->detach( $c, $command [, \@arguments ] )
+=head2 $self->detach( $c, $command [, \@arguments ] )
=cut
die $Catalyst::DETACH;
}
-=item $self->dispatch($c)
+=head2 $self->dispatch($c)
=cut
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->action->namespace, '_DISPATCH' ) );
}
else {
}
}
-=item $self->forward( $c, $command [, \@arguments ] )
+=head2 $self->forward( $c, $command [, \@arguments ] )
=cut
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 $local_args = 0;
+ my $arguments = $c->req->args;
+ if ( ref( $_[-1] ) eq 'ARRAY' ) {
+ $arguments = pop(@_);
+ $local_args = 1;
+ }
- 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->stack->[-1]->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) {
+ $local_args = 1;
+ $command = $tail;
+ unshift( @{$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) )
+ || $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);
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",
- namespace => $class,
+ class => $class,
+ namespace => Catalyst::Utils::class2prefix(
+ $class, $c->config->{case_sensitive}
+ ),
}
);
- $results = [ [$action] ];
+ $result = $action;
}
else {
}
- local $c->request->{arguments} = [ @{$arguments} ];
-
- for my $result ( @{$results} ) {
- $result->[0]->execute($c);
- return if scalar @{ $c->error };
- last unless $c->state;
+ if ($local_args) {
+ local $c->request->{arguments} = [ @{$arguments} ];
+ $result->execute($c);
}
+ else { $result->execute($c) }
return $c->state;
}
-=item $self->prepare_action($c)
+=head2 $self->prepare_action($c)
=cut
my @path = split /\//, $c->req->path;
$c->req->args( \my @args );
- while (@path) {
+ unshift( @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 );
- }
+ $path =~ s#^/##;
- 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);
- last;
+ # 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 );
}
- unshift @args, pop @path;
- }
- unless ( $c->req->action ) {
- $c->req->action('default');
- $c->req->match('');
+ # If not, move the last part path to args
+ my $arg = pop(@path);
+ $arg =~ s/%([0-9A-Fa-f]{2})/chr(hex($1))/eg;
+ unshift @args, $arg;
}
+ $c->log->debug( 'Path is "' . $c->req->match . '"' )
+ if ( $c->debug && $c->req->match );
+
$c->log->debug( 'Arguments are "' . join( '/', @args ) . '"' )
if ( $c->debug && @args );
}
-=item $self->get_action( $c, $action, $namespace, $inherit )
+=head2 $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;
+ $namespace = '' if $namespace eq '/';
- 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;
-
- #warn "${namespace} ${action}";
- my @path = split(/\//, $namespace);
- $visitor->setSearchPath( @path );
- $parent->accept($visitor);
-
- #warn join(', ', map { $_->getNodeValue } $visitor->getResults);
+ my @match = $self->get_containers($namespace);
- my @match = $visitor->getResults;
- @match = ($parent) unless @match;
+ return unless @match;
- if (!defined $visitor->getResult) {
- 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 $action = $match[-1]->get_action($name) ) {
+ return $action if $action->namespace eq $namespace;
+ }
+}
- foreach my $child (@match) {
- my $node = $self->actions->{private}->{$child->getUID};
- next unless $node;
- push(@results, [ $node->{$action} ]) if defined $node->{$action};
- }
+=head2 $self->get_actions( $c, $action, $namespace )
- #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;
- # }
- # }
+=cut
- }
+sub get_actions {
+ my ( $self, $c, $action, $namespace ) = @_;
+ return [] unless $action;
+ $namespace ||= '';
+ $namespace = '' if $namespace eq '/';
- else {
+ my @match = $self->get_containers($namespace);
- 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;
- }
+ return map { $_->get_action($action) } @match;
+}
- else {
- my $result =
- $self->actions->{private}->{ $parent->getUID }->{$action};
- push @results, [$result] if $result;
- }
+=head2 $self->get_containers( $namespace )
- }
- return \@results;
- }
+=cut
- elsif ( my $p = $self->actions->{plain}->{$action} ) { return [ [$p] ] }
- elsif ( my $r = $self->actions->{regex}->{$action} ) { return [ [$r] ] }
+sub get_containers {
+ my ( $self, $namespace ) = @_;
- else {
+ # If the namespace is / just return the root ActionContainer
- for my $i ( 0 .. $#{ $self->actions->{compiled} } ) {
- my $name = $self->actions->{compiled}->[$i]->[0];
- my $regex = $self->actions->{compiled}->[$i]->[1];
+ return ( $self->tree->getNodeValue )
+ if ( !$namespace || ( $namespace eq '/' ) );
- if ( my @snippets = ( $action =~ $regex ) ) {
- return [
- [ $self->actions->{regex}->{$name}, $name, \@snippets ] ];
- }
+ # 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.
+
+ if ( my $extra = $path[ ( scalar @match ) - 1 ] ) {
+ $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 )
+=head2 $self->register( $c, $action )
=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 %flags;
+ my $registered = $self->registered_dispatch_types;
- 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;
+ my $priv = 0;
+ foreach my $key ( keys %{ $action->attributes } ) {
+ $priv++ if $key eq 'Private';
+ my $class = "Catalyst::DispatchType::$key";
+ unless ( $registered->{$class} ) {
+ eval "require $class";
+ push( @{ $self->dispatch_types }, $class->new ) unless $@;
+ $registered->{$class} = 1;
}
}
- if ( $flags{private} && ( keys %flags > 1 ) ) {
- $c->log->debug( 'Bad action definition "'
- . join( ' ', @{$attrs} )
- . qq/" for "$namespace->$method"/ )
- if $c->debug;
- return;
+ # Pass the action to our dispatch types so they can register it if reqd.
+ my $reg = 0;
+ foreach my $type ( @{ $self->dispatch_types } ) {
+ $reg++ if $type->register( $c, $action );
}
- return unless keys %flags;
- my $parent = $self->tree;
- my $visitor = Tree::Simple::Visitor::FindByPath->new;
+ return unless $reg + $priv;
- for my $part ( split '/', $prefix ) {
- $visitor->setSearchPath($part);
- $parent->accept($visitor);
- my $child = $visitor->getResult;
+ my $namespace = $action->namespace;
+ my $parent = $self->tree;
+ my $visitor = Tree::Simple::Visitor::FindByPath->new;
- 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) {
- my $reverse = $prefix ? "$prefix/$method" : $method;
+ # Create a new tree node and an ActionContainer to form
+ # its value.
- my $action = Catalyst::Action->new(
- {
- code => $code,
- reverse => $reverse,
- namespace => $namespace,
- }
- );
-
- 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};
- }
+ my $container =
+ Catalyst::ActionContainer->new(
+ { part => $part, actions => {} } );
+ $child = $parent->addChild( Tree::Simple->new($container) );
+ $visitor->setSearchPath($part);
+ $parent->accept($visitor);
+ $child = $visitor->getResult;
+ }
- for my $path ( @{ $flags{path} } ) {
- if ( $path =~ /^\// ) { $path =~ s/^\/// }
- else { $path = $prefix ? "$prefix/$path" : $path }
- $self->actions->{plain}->{$path} = $action;
+ $parent = $child;
+ }
}
- for my $regex ( @{ $flags{regex} } ) {
- push @{ $self->actions->{compiled} }, [ $regex, qr#$regex# ];
- $self->actions->{regex}->{$regex} = $action;
- }
+ # Set the method value
+ $parent->getNodeValue->actions->{ $action->name } = $action;
}
-=item $self->setup_actions( $class, $component )
+=head2 $self->setup_actions( $class, $component )
=cut
sub setup_actions {
- my ( $self, $class ) = @_;
-
- # These are the core structures
- $self->actions(
- {
- plain => {},
- private => {},
- regex => {},
- compiled => []
- }
- );
-
- # We use a tree
- $self->tree( Tree::Simple->new( 0, 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;
- }
+ my ( $self, $c ) = @_;
- }
+ $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 => {} } );
+ $self->tree( Tree::Simple->new( $container, Tree::Simple->ROOT ) );
- }
+ 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(
+ [ 20, 'Private' ],
+ [ 38, 'Class' ],
+ [ 12, 'Method' ]
+ );
+ my $has_private = 0;
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 $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->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 );
+ $c->log->debug( "Loaded Private actions:\n" . $privates->draw )
+ if ($has_private);
- 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
-
=head1 AUTHOR
Sebastian Riedel, C<sri@cpan.org>
+Matt S Trout, C<mst@shadowcatsystems.co.uk>
=head1 COPYRIGHT
projects / catagits/Catalyst-Runtime.git / blobdiff