package Catalyst::Dispatcher;
use strict;
-use base 'Class::Data::Inheritable';
+use base 'Class::Accessor::Fast';
+use Catalyst::Exception;
use Catalyst::Utils;
-use Text::ASCIITable;
+use Catalyst::Action;
+use Catalyst::ActionContainer;
+use Catalyst::DispatchType::Default;
+use Catalyst::DispatchType::Index;
+use Text::SimpleTable;
use Tree::Simple;
use Tree::Simple::Visitor::FindByPath;
-__PACKAGE__->mk_classdata($_) for qw/actions tree/;
+# Stringify to class
+use overload '""' => sub { return ref shift }, fallback => 1;
+
+__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 $c->dispatch
-
-Dispatch request to actions.
+=head2 $self->detach( $c, $command [, \@arguments ] )
=cut
-sub dispatch {
- my $c = shift;
- 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]->[0] );
- }
- }
-
- my $default = $action eq 'default' ? $namespace : undef;
- my $results = $c->get_action( $action, $default, $default ? 1 : 0 );
- $namespace ||= '/';
-
- if ( @{$results} ) {
-
- # Execute last begin
- $c->state(1);
- if ( my $begin = @{ $c->get_action( 'begin', $namespace, 1 ) }[-1] ) {
- $c->execute( @{ $begin->[0] } );
- return if scalar @{ $c->error };
- }
+sub detach {
+ my ( $self, $c, $command, @args ) = @_;
+ $c->forward( $command, @args ) if $command;
+ die $Catalyst::DETACH;
+}
- # Execute the auto chain
- my $autorun = 0;
- for my $auto ( @{ $c->get_action( 'auto', $namespace, 1 ) } ) {
- $autorun++;
- $c->execute( @{ $auto->[0] } );
- return if scalar @{ $c->error };
- last unless $c->state;
- }
+=head2 $self->dispatch($c)
- # Execute the action or last default
- my $mkay = $autorun ? $c->state ? 1 : 0 : 1;
- if ( ( my $action = $c->req->action ) && $mkay ) {
- if ( my $result = @{ $c->get_action( $action, $default, 1 ) }[-1] )
- {
- $c->execute( @{ $result->[0] } );
- }
- }
+=cut
- # Execute last end
- if ( my $end = @{ $c->get_action( 'end', $namespace, 1 ) }[-1] ) {
- $c->execute( @{ $end->[0] } );
- return if scalar @{ $c->error };
- }
+sub dispatch {
+ my ( $self, $c ) = @_;
+ if ( $c->action ) {
+ $c->forward( join( '/', '', $c->action->namespace, '_DISPATCH' ) );
}
else {
}
}
-=item $c->forward($command)
-
-Forward processing to a private action or a method from a class.
-If you define a class without method it will default to process().
-
- $c->forward('/foo');
- $c->forward('index');
- $c->forward(qw/MyApp::Model::CDBI::Foo do_stuff/);
- $c->forward('MyApp::View::TT');
+=head2 $self->forward( $c, $command [, \@arguments ] )
=cut
sub forward {
+ my $self = shift;
my $c = shift;
my $command = shift;
return 0;
}
- my $caller = caller(0);
- my $namespace = '/';
-
- if ( $command =~ /^\// ) {
- $command =~ /^\/(.*)\/(\w+)$/;
- $namespace = $1 || '/';
- $command = $2 || $command;
- $command =~ s/^\///;
+ my $local_args = 0;
+ my $arguments = $c->req->args;
+ if ( ref( $_[-1] ) eq 'ARRAY' ) {
+ $arguments = pop(@_);
+ $local_args = 1;
}
- else { $namespace = Catalyst::Utils::class2prefix($caller) || '/' }
+ my $result;
- my $results = $c->get_action( $command, $namespace );
+ unless ( ref $command ) {
+ my $command_copy = $command;
- unless ( @{$results} ) {
- my $class = $command || '';
- my $path = $class . '.pm';
- $path =~ s/::/\//g;
+ unless ( $command_copy =~ s/^\/// ) {
+ my $namespace = $c->stack->[-1]->namespace;
+ $command_copy = "${namespace}/${command}";
+ }
- unless ( $INC{$path} ) {
- my $error =
- qq/Couldn't forward to "$class". Invalid or not loaded./;
- $c->error($error);
- $c->log->debug($error) if $c->debug;
- return 0;
+ 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 );
+ }
+ }
+ }
+
+ unless ($result) {
- unless ( UNIVERSAL::isa( $class, 'Catalyst::Base' ) ) {
+ my $class = ref($command)
+ || ref( $c->component($command) )
+ || $c->component($command);
+ my $method = shift || 'process';
+
+ unless ($class) {
my $error =
- qq/Can't forward to "$class". Class is not a Catalyst component./;
+qq/Couldn't forward to command "$command". Invalid action or component./;
$c->error($error);
$c->log->debug($error) if $c->debug;
return 0;
}
- my $method = shift || 'process';
-
if ( my $code = $class->can($method) ) {
- $c->actions->{reverse}->{"$code"} = "$class->$method";
- $results = [ [ [ $class, $code ] ] ];
+ my $action = $self->method_action_class->new(
+ {
+ name => $method,
+ code => $code,
+ reverse => "$class->$method",
+ class => $class,
+ namespace => Catalyst::Utils::class2prefix(
+ $class, $c->config->{case_sensitive}
+ ),
+ }
+ );
+ $result = $action;
}
else {
}
- for my $result ( @{$results} ) {
- $c->execute( @{ $result->[0] } );
- 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 $c->get_action( $action, $namespace, $inherit )
-
-Get an action in a given namespace.
+=head2 $self->prepare_action($c)
=cut
-sub get_action {
- my ( $c, $action, $namespace, $inherit ) = @_;
- return [] unless $action;
- $namespace ||= '';
- $inherit ||= 0;
+sub prepare_action {
+ my ( $self, $c ) = @_;
+ my $path = $c->req->path;
+ my @path = split /\//, $c->req->path;
+ $c->req->args( \my @args );
- if ($namespace) {
- $namespace = '' if $namespace eq '/';
- my $parent = $c->tree;
- my @results;
+ unshift( @path, '' ); # Root action
- if ($inherit) {
- my $result = $c->actions->{private}->{ $parent->getUID }->{$action};
- push @results, [$result] if $result;
- my $visitor = Tree::Simple::Visitor::FindByPath->new;
+ DESCEND: while (@path) {
+ $path = join '/', @path;
+ $path =~ s#^/##;
- for my $part ( split '/', $namespace ) {
- $visitor->setSearchPath($part);
- $parent->accept($visitor);
- my $child = $visitor->getResult;
- my $uid = $child->getUID if $child;
- my $match = $c->actions->{private}->{$uid}->{$action} if $uid;
- push @results, [$match] if $match;
- $parent = $child if $child;
- }
+ $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 );
}
- else {
+ # 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;
+ }
- 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 = $c->actions->{private}->{$uid}->{$action}
- if $uid;
- push @results, [$match] if $match;
- }
+ $c->log->debug( 'Path is "' . $c->req->match . '"' )
+ if ( $c->debug && $c->req->match );
- else {
- my $result =
- $c->actions->{private}->{ $parent->getUID }->{$action};
- push @results, [$result] if $result;
- }
+ $c->log->debug( 'Arguments are "' . join( '/', @args ) . '"' )
+ if ( $c->debug && @args );
+}
- }
- return \@results;
- }
+=head2 $self->get_action( $action, $namespace )
- elsif ( my $p = $c->actions->{plain}->{$action} ) { return [ [$p] ] }
- elsif ( my $r = $c->actions->{regex}->{$action} ) { return [ [$r] ] }
+=cut
- else {
+sub get_action {
+ my ( $self, $name, $namespace ) = @_;
+ return unless $name;
+ $namespace ||= '';
+ $namespace = '' if $namespace eq '/';
- for my $i ( 0 .. $#{ $c->actions->{compiled} } ) {
- my $name = $c->actions->{compiled}->[$i]->[0];
- my $regex = $c->actions->{compiled}->[$i]->[1];
+ my @match = $self->get_containers($namespace);
- if ( my @snippets = ( $action =~ $regex ) ) {
- return [ [ $c->actions->{regex}->{$name}, $name, \@snippets ] ];
- }
+ return unless @match;
- }
+ if ( my $action = $match[-1]->get_action($name) ) {
+ return $action if $action->namespace eq $namespace;
}
- return [];
}
-=item $c->set_action( $action, $code, $namespace, $attrs )
-
-Set an action in a given namespace.
+=head2 $self->get_actions( $c, $action, $namespace )
=cut
-sub set_action {
- my ( $c, $method, $code, $namespace, $attrs ) = @_;
+sub get_actions {
+ my ( $self, $c, $action, $namespace ) = @_;
+ return [] unless $action;
+ $namespace ||= '';
+ $namespace = '' if $namespace eq '/';
- my $prefix = Catalyst::Utils::class2prefix($namespace) || '';
- my %flags;
+ my @match = $self->get_containers($namespace);
- for my $attr ( @{$attrs} ) {
- if ( $attr =~ /^(Local|Relative)$/ ) { $flags{local}++ }
- elsif ( $attr =~ /^(Global|Absolute)$/ ) { $flags{global}++ }
- elsif ( $attr =~ /^Path\(\s*(.+)\s*\)$/i ) { $flags{path} = $1 }
- elsif ( $attr =~ /^Private$/i ) { $flags{private}++ }
- elsif ( $attr =~ /^(Regex|Regexp)\(\s*(.+)\s*\)$/i ) {
- $flags{regex} = $2;
- }
- }
+ return map { $_->get_action($action) } @match;
+}
- if ( $flags{private} && ( keys %flags > 1 ) ) {
- $c->log->debug( 'Bad action definition "'
- . join( ' ', @{$attrs} )
- . qq/" for "$namespace->$method"/ )
- if $c->debug;
- return;
- }
- return unless keys %flags;
+=head2 $self->get_containers( $namespace )
- my $parent = $c->tree;
- my $visitor = Tree::Simple::Visitor::FindByPath->new;
+=cut
- for my $part ( split '/', $prefix ) {
- $visitor->setSearchPath($part);
- $parent->accept($visitor);
- my $child = $visitor->getResult;
+sub get_containers {
+ my ( $self, $namespace ) = @_;
- unless ($child) {
- $child = $parent->addChild( Tree::Simple->new($part) );
- $visitor->setSearchPath($part);
- $parent->accept($visitor);
- $child = $visitor->getResult;
- }
+ # If the namespace is / just return the root ActionContainer
- $parent = $child;
- }
+ return ( $self->tree->getNodeValue )
+ if ( !$namespace || ( $namespace eq '/' ) );
- my $uid = $parent->getUID;
- $c->actions->{private}->{$uid}->{$method} = [ $namespace, $code ];
- my $forward = $prefix ? "$prefix/$method" : $method;
+ # Use a visitor to recurse down the tree finding the ActionContainers
+ # for each namespace in the chain.
- if ( $flags{path} ) {
- $flags{path} =~ s/^\w+//;
- $flags{path} =~ s/\w+$//;
- if ( $flags{path} =~ /^'(.*)'$/ ) { $flags{path} = $1 }
- if ( $flags{path} =~ /^"(.*)"$/ ) { $flags{path} = $1 }
+ 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;
+ }
}
- if ( $flags{regex} ) {
- $flags{regex} =~ s/^\w+//;
- $flags{regex} =~ s/\w+$//;
- if ( $flags{regex} =~ /^'(.*)'$/ ) { $flags{regex} = $1 }
- if ( $flags{regex} =~ /^"(.*)"$/ ) { $flags{regex} = $1 }
- }
+ return map { $_->getNodeValue } @match;
+}
+
+=head2 $self->register( $c, $action )
- my $reverse = $prefix ? "$prefix/$method" : $method;
+=cut
- if ( $flags{local} || $flags{global} || $flags{path} ) {
- my $path = $flags{path} || $method;
- my $absolute = 0;
+sub register {
+ my ( $self, $c, $action ) = @_;
- if ( $path =~ /^\/(.+)/ ) {
- $path = $1;
- $absolute = 1;
- }
+ my $registered = $self->registered_dispatch_types;
- $absolute = 1 if $flags{global};
- my $name = $absolute ? $path : $prefix ? "$prefix/$path" : $path;
- $c->actions->{plain}->{$name} = [ $namespace, $code ];
+ 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 ( my $regex = $flags{regex} ) {
- push @{ $c->actions->{compiled} }, [ $regex, qr#$regex# ];
- $c->actions->{regex}->{$regex} = [ $namespace, $code ];
+ # 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 );
}
- $c->actions->{reverse}->{"$code"} = $reverse;
-}
+ return unless $reg + $priv;
-=item $class->setup_actions($component)
+ my $namespace = $action->namespace;
+ my $parent = $self->tree;
+ my $visitor = Tree::Simple::Visitor::FindByPath->new;
-Setup actions for a component.
+ if ($namespace) {
+ for my $part ( split '/', $namespace ) {
+ $visitor->setSearchPath($part);
+ $parent->accept($visitor);
+ my $child = $visitor->getResult;
-=cut
+ unless ($child) {
-sub setup_actions {
- my ( $self, $comps ) = @_;
-
- # These are the core structures
- $self->actions(
- {
- plain => {},
- private => {},
- regex => {},
- compiled => [],
- reverse => {}
- }
- );
+ # Create a new tree node and an ActionContainer to form
+ # its value.
- # We use a tree
- $self->tree( Tree::Simple->new( 0, Tree::Simple->ROOT ) );
-
- for my $comp (@$comps) {
- $comp = ref $comp || $comp;
-
- 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}++;
- }
+ 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 $namespace ( keys %namespaces ) {
+ $parent = $child;
+ }
+ }
- for my $sym ( values %{ $namespace . '::' } ) {
+ # Set the method value
+ $parent->getNodeValue->actions->{ $action->name } = $action;
+}
- if ( *{$sym}{CODE} && *{$sym}{CODE} == $code ) {
+=head2 $self->setup_actions( $class, $component )
- $name = *{$sym}{NAME};
- $self->set_action( $name, $code, $comp, $attrs );
- last;
- }
+=cut
- }
+sub setup_actions {
+ 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;
}
- my $actions = $self->actions;
- my $privates = Text::ASCIITable->new;
- $privates->setCols( 'Private', 'Class' );
- $privates->setColWidth( 'Private', 36, 1 );
- $privates->setColWidth( 'Class', 37, 1 );
+ return unless $c->debug;
+
+ 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 ( $class, $code ) = @{ $actions->{private}->{$uid}->{$action} };
- $privates->addRow( "$prefix$action", $class );
+ 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, '' );
- $self->log->debug( 'Loaded private actions', $privates->draw )
- if ( @{ $privates->{tbl_rows} } && $self->debug );
-
- 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 ( $class, $code ) = @{ $actions->{plain}->{$plain} };
- my $reverse = $self->actions->{reverse}->{$code};
- $reverse = $reverse ? "/$reverse" : $code;
- $publics->addRow( "/$plain", $reverse );
- }
-
- $self->log->debug( 'Loaded public actions', $publics->draw )
- if ( @{ $publics->{tbl_rows} } && $self->debug );
-
- my $regexes = Text::ASCIITable->new;
- $regexes->setCols( 'Regex', 'Private' );
- $regexes->setColWidth( 'Regex', 36, 1 );
- $regexes->setColWidth( 'Private', 37, 1 );
+ $c->log->debug( "Loaded Private actions:\n" . $privates->draw )
+ if ($has_private);
- for my $regex ( sort keys %{ $actions->{regex} } ) {
- my ( $class, $code ) = @{ $actions->{regex}->{$regex} };
- my $reverse = $self->actions->{reverse}->{$code};
- $reverse = $reverse ? "/$reverse" : $code;
- $regexes->addRow( $regex, $reverse );
- }
-
- $self->log->debug( 'Loaded regex actions', $regexes->draw )
- if ( @{ $regexes->{tbl_rows} } && $self->debug );
+ # 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