package Catalyst::Dispatcher;
-use strict;
-use base 'Class::Accessor::Fast';
+use Moose;
+use Class::MOP;
+with 'MooseX::Emulate::Class::Accessor::Fast';
+
use Catalyst::Exception;
use Catalyst::Utils;
use Catalyst::Action;
use Catalyst::ActionContainer;
-use Text::ASCIITable;
+use Catalyst::DispatchType::Default;
+use Catalyst::DispatchType::Index;
+use Catalyst::Utils;
+use Text::SimpleTable;
use Tree::Simple;
use Tree::Simple::Visitor::FindByPath;
-# Stringify to class
-use overload '""' => sub { return ref shift }, fallback => 1;
+use namespace::clean -except => 'meta';
+
+# Refactoring note:
+# do these belong as package vars or should we build these via a builder method?
+# See Catalyst-Plugin-Server for them being added to, which should be much less ugly.
+
+# Preload these action types
+our @PRELOAD = qw/Index Path Regex/;
-__PACKAGE__->mk_accessors(qw/actions tree/);
+# Postload these action types
+our @POSTLOAD = qw/Default/;
+
+# Note - see back-compat methods at end of file.
+has _tree => (is => 'rw', builder => '_build__tree');
+has dispatch_types => (is => 'rw', default => sub { [] }, required => 1, lazy => 1);
+has _registered_dispatch_types => (is => 'rw', default => sub { {} }, required => 1, lazy => 1);
+has _method_action_class => (is => 'rw', default => 'Catalyst::Action');
+has _action_hash => (is => 'rw', required => 1, lazy => 1, default => sub { {} });
+has _container_hash => (is => 'rw', required => 1, lazy => 1, default => sub { {} });
+
+my %dispatch_types = ( pre => \@PRELOAD, post => \@POSTLOAD );
+foreach my $type (keys %dispatch_types) {
+ has $type . "load_dispatch_types" => (
+ is => 'rw', required => 1, lazy => 1, default => sub { $dispatch_types{$type} },
+ traits => ['MooseX::Emulate::Class::Accessor::Fast::Meta::Role::Attribute'], # List assignment is CAF style
+ );
+}
=head1 NAME
=head1 DESCRIPTION
+This is the class that maps public urls to actions in your Catalyst
+application based on the attributes you set.
+
=head1 METHODS
-=over 4
+=head2 new
-=item $self->detach( $c, $command [, \@arguments ] )
+Construct a new dispatcher.
=cut
-sub detach {
- my ( $self, $c, $command, @args ) = @_;
- $c->forward( $command, @args ) if $command;
- die $Catalyst::DETACH;
+sub _build__tree {
+ my ($self) = @_;
+
+ my $container =
+ Catalyst::ActionContainer->new( { part => '/', actions => {} } );
+
+ return Tree::Simple->new($container, Tree::Simple->ROOT);
}
-=item $self->dispatch($c)
+=head2 $self->preload_dispatch_types
-=cut
+An arrayref of pre-loaded dispatchtype classes
-sub dispatch {
- my ( $self, $c ) = @_;
+Entries are considered to be available as C<Catalyst::DispatchType::CLASS>
+To use a custom class outside the regular C<Catalyst> namespace, prefix
+it with a C<+>, like so:
- if ( $c->action ) {
+ +My::Dispatch::Type
- my @containers = $self->get_containers( $c->namespace );
- my %actions;
- foreach my $name (qw/begin auto end/) {
+=head2 $self->postload_dispatch_types
- # 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
+An arrayref of post-loaded dispatchtype classes
- $actions{$name} = [
- map { $_->{$name} }
- grep { exists $_->{$name} }
- map { $_->actions }
- @containers
- ];
- }
+Entries are considered to be available as C<Catalyst::DispatchType::CLASS>
+To use a custom class outside the regular C<Catalyst> namespace, prefix
+it with a C<+>, like so:
- # Errors break the normal flow and the end action is instantly run
- my $error = 0;
+ +My::Dispatch::Type
- # Execute last begin
- $c->state(1);
- if ( my $begin = @{ $actions{begin} }[-1] ) {
- $begin->execute($c);
- $error++ if scalar @{ $c->error };
- }
+=head2 $self->dispatch($c)
- # 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;
- }
+Delegate the dispatch to the action that matched the url, or return a
+message about unknown resource
- # 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 };
- }
- }
+=cut
- # Execute last end
- if ( my $end = @{ $actions{end} }[-1] ) {
- $end->execute($c);
- }
+sub dispatch {
+ my ( $self, $c ) = @_;
+ if ( my $action = $c->action ) {
+ $c->forward( join( '/', '', $action->namespace, '_DISPATCH' ) );
}
-
else {
my $path = $c->req->path;
my $error = $path
}
}
-=item $self->forward( $c, $command [, \@arguments ] )
-
-=cut
+# $self->_command2action( $c, $command [, \@arguments ] )
+# $self->_command2action( $c, $command [, \@captures, \@arguments ] )
+# Search for an action, from the command and returns C<($action, $args, $captures)> on
+# success. Returns C<(0)> on error.
-sub forward {
- my $self = shift;
- my $c = shift;
- my $command = shift;
+sub _command2action {
+ my ( $self, $c, $command, @extra_params ) = @_;
unless ($command) {
- $c->log->debug('Nothing to forward to') if $c->debug;
+ $c->log->debug('Nothing to go to') if $c->debug;
return 0;
}
- # Relative forwards from detach
- my $caller = ( caller(1) )[0]->isa('Catalyst::Dispatcher')
- && ( ( caller(2) )[3] =~ /::detach$/ ) ? caller(3) : caller(1);
+ my (@args, @captures);
+
+ if ( ref( $extra_params[-2] ) eq 'ARRAY' ) {
+ @captures = @{ splice @extra_params, -2, 1 };
+ }
- my $arguments = ( ref( $_[-1] ) eq 'ARRAY' ) ? pop(@_) : $c->req->args;
+ if ( ref( $extra_params[-1] ) eq 'ARRAY' ) {
+ @args = @{ pop @extra_params }
+ } else {
+ # this is a copy, it may take some abuse from
+ # ->_invoke_as_path if the path had trailing parts
+ @args = @{ $c->request->arguments };
+ }
- my $results = [];
+ my $action;
- my $command_copy = $command;
+ # go to a string path ("/foo/bar/gorch")
+ # or action object
+ if (blessed($command) && $command->isa('Catalyst::Action')) {
+ $action = $command;
+ }
+ else {
+ $action = $self->_invoke_as_path( $c, "$command", \@args );
+ }
- unless ( $command_copy =~ s/^\/// ) {
- my $namespace =
- Catalyst::Utils::class2prefix( $caller, $c->config->{case_sensitive} ) || '';
- $command_copy = "${namespace}/${command}";
+ # go to a component ( "View::Foo" or $c->component("...")
+ # - a path or an object)
+ unless ($action) {
+ my $method = @extra_params ? $extra_params[0] : "process";
+ $action = $self->_invoke_as_component( $c, $command, $method );
}
- unless ( $command_copy =~ /\// ) {
- $results = $c->get_action( $command_copy, '/' );
+ return $action, \@args, \@captures;
+}
+
+=head2 $self->visit( $c, $command [, \@arguments ] )
+
+Documented in L<Catalyst>
+
+=cut
+
+sub visit {
+ my $self = shift;
+ $self->_do_visit('visit', @_);
+}
+
+sub _do_visit {
+ my $self = shift;
+ my $opname = shift;
+ my ( $c, $command ) = @_;
+ my ( $action, $args, $captures ) = $self->_command2action(@_);
+ my $error = qq/Couldn't $opname("$command"): /;
+
+ if (!$action) {
+ $error .= qq/Couldn't $opname to command "$command": /
+ .qq/Invalid action or component./;
+ }
+ elsif (!defined $action->namespace) {
+ $error .= qq/Action has no namespace: cannot $opname() to a plain /
+ .qq/method or component, must be an :Action of some sort./
+ }
+ elsif (!$action->class->can('_DISPATCH')) {
+ $error .= qq/Action cannot _DISPATCH. /
+ .qq/Did you try to $opname() a non-controller action?/;
}
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;
- }
- unshift( @extra_args, $tail );
- }
+ $error = q();
+ }
+
+ if($error) {
+ $c->error($error);
+ $c->log->debug($error) if $c->debug;
+ return 0;
}
- unless ( @{$results} ) {
+ $action = $self->expand_action($action);
- unless ( $c->components->{$command} ) {
- my $error =
-qq/Couldn't forward to command "$command". Invalid action or component./;
- $c->error($error);
- $c->log->debug($error) if $c->debug;
- return 0;
- }
+ local $c->request->{arguments} = $args;
+ local $c->request->{captures} = $captures;
+ local $c->{namespace} = $action->{'namespace'};
+ local $c->{action} = $action;
+
+ $self->dispatch($c);
+}
+
+=head2 $self->go( $c, $command [, \@arguments ] )
+
+Documented in L<Catalyst>
+
+=cut
+
+sub go {
+ my $self = shift;
+ $self->_do_visit('go', @_);
+ Catalyst::Exception::Go->throw;
+}
+
+=head2 $self->forward( $c, $command [, \@arguments ] )
+
+Documented in L<Catalyst>
+
+=cut
+
+sub forward {
+ my $self = shift;
+ no warnings 'recursion';
+ $self->_do_forward(forward => @_);
+}
+
+sub _do_forward {
+ my $self = shift;
+ my $opname = shift;
+ my ( $c, $command ) = @_;
+ my ( $action, $args, $captures ) = $self->_command2action(@_);
+
+ if (!$action) {
+ my $error .= qq/Couldn't $opname to command "$command": /
+ .qq/Invalid action or component./;
+ $c->error($error);
+ $c->log->debug($error) if $c->debug;
+ return 0;
+ }
- my $class = $command;
- my $method = shift || 'process';
-
- if ( my $code = $c->components->{$class}->can($method) ) {
- my $action = Catalyst::Action->new(
- {
- code => $code,
- reverse => "$class->$method",
- namespace => $class,
- prefix => $class,
- }
- );
- $results = [ [$action] ];
- }
+ local $c->request->{arguments} = $args;
+ no warnings 'recursion';
+ $action->dispatch( $c );
+
+ return $c->state;
+}
+
+=head2 $self->detach( $c, $command [, \@arguments ] )
+
+Documented in L<Catalyst>
+
+=cut
+
+sub detach {
+ my ( $self, $c, $command, @args ) = @_;
+ $self->_do_forward(detach => $c, $command, @args ) if $command;
+ Catalyst::Exception::Detach->throw;
+}
+
+sub _action_rel2abs {
+ my ( $self, $c, $path ) = @_;
+
+ unless ( $path =~ m#^/# ) {
+ my $namespace = $c->stack->[-1]->namespace;
+ $path = "$namespace/$path";
+ }
+
+ $path =~ s#^/##;
+ return $path;
+}
+
+sub _invoke_as_path {
+ my ( $self, $c, $rel_path, $args ) = @_;
+
+ my $path = $self->_action_rel2abs( $c, $rel_path );
+
+ my ( $tail, @extra_args );
+ while ( ( $path, $tail ) = ( $path =~ m#^(?:(.*)/)?(\w+)?$# ) )
+ { # allow $path to be empty
+ if ( my $action = $c->get_action( $tail, $path ) ) {
+ push @$args, @extra_args;
+ return $action;
+ }
else {
- my $error =
- qq/Couldn't forward to "$class". Does not implement "$method"/;
- $c->error($error);
- $c->log->debug($error)
- if $c->debug;
- return 0;
+ return
+ unless $path
+ ; # if a match on the global namespace failed then the whole lookup failed
}
+ unshift @extra_args, $tail;
}
+}
- local $c->request->{arguments} = [ @{$arguments} ];
+sub _find_component {
+ my ( $self, $c, $component ) = @_;
+
+ # fugly, why doesn't ->component('MyApp') work?
+ return $c if ($component eq blessed($c));
+
+ return blessed($component)
+ ? $component
+ : $c->component($component);
+}
- for my $result ( @{$results} ) {
- $result->[0]->execute($c);
- return if scalar @{ $c->error };
- last unless $c->state;
+sub _invoke_as_component {
+ my ( $self, $c, $component_or_class, $method ) = @_;
+
+ my $component = $self->_find_component($c, $component_or_class);
+ my $component_class = blessed $component || return 0;
+
+ if (my $code = $component_class->can('action_for')) {
+ my $possible_action = $component->$code($method);
+ return $possible_action if $possible_action;
}
- return $c->state;
+ if ( my $code = $component_class->can($method) ) {
+ return $self->_method_action_class->new(
+ {
+ name => $method,
+ code => $code,
+ reverse => "$component_class->$method",
+ class => $component_class,
+ namespace => Catalyst::Utils::class2prefix(
+ $component_class, ref($c)->config->{case_sensitive}
+ ),
+ }
+ );
+ }
+ else {
+ my $error =
+ qq/Couldn't forward to "$component_class". Does not implement "$method"/;
+ $c->error($error);
+ $c->log->debug($error)
+ if $c->debug;
+ return 0;
+ }
}
-=item $self->prepare_action($c)
+=head2 $self->prepare_action($c)
+
+Find an dispatch type that matches $c->req->path, and set args from it.
=cut
sub prepare_action {
my ( $self, $c ) = @_;
- my $path = $c->req->path;
- my @path = split /\//, $c->req->path;
- $c->req->args( \my @args );
+ my $req = $c->req;
+ my $path = $req->path;
+ my @path = split /\//, $req->path;
+ $req->args( \my @args );
+
+ unshift( @path, '' ); # Root action
- while (@path) {
+ 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;
- }
+ # Check out dispatch types to see if any will handle the path at
+ # this level
- $c->req->match($path);
- $c->action($result->[0]);
- $c->namespace($result->[0]->prefix);
- last;
+ foreach my $type ( @{ $self->dispatch_types } ) {
+ last DESCEND if $type->match( $c, $path );
}
- unshift @args, pop @path;
- }
- 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('');
- }
+ # 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;
}
+ s/%([0-9A-Fa-f]{2})/chr(hex($1))/eg for grep { defined } @{$req->captures||[]};
+
+ $c->log->debug( 'Path is "' . $req->match . '"' )
+ if ( $c->debug && defined $req->match && length $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 )
+
+returns a named action from a given namespace.
=cut
sub get_action {
- my ( $self, $c, $action, $namespace, $inherit ) = @_;
- return [] unless $action;
- $namespace ||= '';
- $inherit ||= 0;
+ my ( $self, $name, $namespace ) = @_;
+ return unless $name;
- if ($namespace) {
+ $namespace = join( "/", grep { length } split '/', ( defined $namespace ? $namespace : "" ) );
- my @match = $self->get_containers( $namespace );
+ return $self->_action_hash->{"${namespace}/${name}"};
+}
- my @results;
+=head2 $self->get_action_by_path( $path );
- foreach my $child ($inherit ? @match: $match[-1]) {
- my $node = $child->actions;
- push(@results, [ $node->{$action} ]) if defined $node->{$action};
- }
- return \@results;
- }
+Returns the named action by its full private path.
- elsif ( my $p = $self->actions->{plain}->{$action} ) { return [ [$p] ] }
- elsif ( my $r = $self->actions->{regex}->{$action} ) { return [ [$r] ] }
+=cut
- else {
+sub get_action_by_path {
+ my ( $self, $path ) = @_;
+ $path =~ s/^\///;
+ $path = "/$path" unless $path =~ /\//;
+ $self->_action_hash->{$path};
+}
- for my $i ( 0 .. $#{ $self->actions->{compiled} } ) {
- my $name = $self->actions->{compiled}->[$i]->[0];
- my $regex = $self->actions->{compiled}->[$i]->[1];
+=head2 $self->get_actions( $c, $action, $namespace )
- if ( my @snippets = ( $action =~ $regex ) ) {
- return [
- [ $self->actions->{regex}->{$name}, $name, \@snippets ] ];
- }
+=cut
- }
- }
- return [];
+sub get_actions {
+ my ( $self, $c, $action, $namespace ) = @_;
+ return [] unless $action;
+
+ $namespace = join( "/", grep { length } split '/', $namespace || "" );
+
+ my @match = $self->get_containers($namespace);
+
+ return map { $_->get_action($action) } @match;
}
-=item $self->get_containers( $namespace )
+=head2 $self->get_containers( $namespace )
+
+Return all the action containers for a given namespace, inclusive
=cut
sub get_containers {
my ( $self, $namespace ) = @_;
+ $namespace ||= '';
+ $namespace = '' if $namespace eq '/';
- # If the namespace is / just return the root ActionContainer
+ my @containers;
- return ($self->tree->getNodeValue) if $namespace eq '/';
+ if ( length $namespace ) {
+ do {
+ push @containers, $self->_container_hash->{$namespace};
+ } while ( $namespace =~ s#/[^/]+$## );
+ }
+
+ return reverse grep { defined } @containers, $self->_container_hash->{''};
+}
+
+=head2 $self->uri_for_action($action, \@captures)
+
+Takes a Catalyst::Action object and action parameters and returns a URI
+part such that if $c->req->path were this URI part, this action would be
+dispatched to with $c->req->captures set to the supplied arrayref.
+
+If the action object is not available for external dispatch or the dispatcher
+cannot determine an appropriate URI, this method will return undef.
- # Use a visitor to recurse down the tree finding the ActionContainers
- # for each namespace in the chain.
+=cut
+
+sub uri_for_action {
+ my ( $self, $action, $captures) = @_;
+ $captures ||= [];
+ foreach my $dispatch_type ( @{ $self->dispatch_types } ) {
+ my $uri = $dispatch_type->uri_for_action( $action, $captures );
+ return( $uri eq '' ? '/' : $uri )
+ if defined($uri);
+ }
+ return undef;
+}
- my $visitor = Tree::Simple::Visitor::FindByPath->new;
- my @path = split('/', $namespace);
- $visitor->setSearchPath( @path );
- $self->tree->accept($visitor);
+=head2 expand_action
- my @match = $visitor->getResults;
- @match = ($self->tree) unless @match;
+expand an action into a full representation of the dispatch.
+mostly useful for chained, other actions will just return a
+single action.
- if (!defined $visitor->getResult) {
+=cut
- # 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.
+sub expand_action {
+ my ($self, $action) = @_;
- my $extra = $path[(scalar @match) - 1];
- last unless $extra;
- $visitor->setSearchPath($extra);
- $match[-1]->accept($visitor);
- push(@match, $visitor->getResult) if defined $visitor->getResult;
+ foreach my $dispatch_type (@{ $self->dispatch_types }) {
+ my $expanded = $dispatch_type->expand_action($action);
+ return $expanded if $expanded;
}
- return map { $_->getNodeValue } @match;
+ return $action;
}
-=item $self->set_action( $c, $action, $code, $namespace, $attrs )
+=head2 $self->register( $c, $action )
+
+Make sure all required dispatch types for this action are loaded, then
+pass the action to our dispatch types so they can register it if required.
+Also, set up the tree with the action containers.
=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;
+ foreach my $key ( keys %{ $action->attributes } ) {
+ next if $key eq 'Private';
+ my $class = "Catalyst::DispatchType::$key";
+ unless ( $registered->{$class} ) {
+ # FIXME - Some error checking and re-throwing needed here, as
+ # we eat exceptions loading dispatch types.
+ eval { Class::MOP::load_class($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;
- }
- return unless keys %flags;
-
- my $parent = $self->tree;
- my $visitor = Tree::Simple::Visitor::FindByPath->new;
-
- if ($prefix) {
- for my $part ( split '/', $prefix ) {
- $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 => {} });
- $child = $parent->addChild( Tree::Simple->new($container) );
- $visitor->setSearchPath($part);
- $parent->accept($visitor);
- $child = $visitor->getResult;
- }
-
- $parent = $child;
+ my @dtypes = @{ $self->dispatch_types };
+ my @normal_dtypes;
+ my @low_precedence_dtypes;
+
+ for my $type ( @dtypes ) {
+ if ($type->_is_low_precedence) {
+ push @low_precedence_dtypes, $type;
+ } else {
+ push @normal_dtypes, $type;
}
}
- my $reverse = $prefix ? "$prefix/$method" : $method;
+ # Pass the action to our dispatch types so they can register it if reqd.
+ my $was_registered = 0;
+ foreach my $type ( @normal_dtypes ) {
+ $was_registered = 1 if $type->register( $c, $action );
+ }
- my $action = Catalyst::Action->new(
- {
- code => $code,
- reverse => $reverse,
- namespace => $namespace,
- prefix => $prefix,
+ if (not $was_registered) {
+ foreach my $type ( @low_precedence_dtypes ) {
+ $type->register( $c, $action );
}
- );
+ }
- # Set the method value
- $parent->getNodeValue->actions->{$method} = $action;
+ my $namespace = $action->namespace;
+ my $name = $action->name;
- 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 $container = $self->_find_or_create_action_container($namespace);
- 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;
+ # Set the method value
+ $container->add_action($action);
+
+ $self->_action_hash->{"$namespace/$name"} = $action;
+ $self->_container_hash->{$namespace} = $container;
+}
- if ( $flags{local} || $flags{global} ) {
- push( @{ $flags{path} }, $prefix ? "/$prefix/$method" : "/$method" )
- if $flags{local};
+sub _find_or_create_action_container {
+ my ( $self, $namespace ) = @_;
- push( @{ $flags{path} }, "/$method" ) if $flags{global};
- }
+ my $tree ||= $self->_tree;
- for my $path ( @{ $flags{path} } ) {
- if ( $path =~ /^\// ) { $path =~ s/^\/// }
- else { $path = $prefix ? "$prefix/$path" : $path }
- $self->actions->{plain}->{$path} = $action;
- }
+ return $tree->getNodeValue unless $namespace;
- for my $regex ( @{ $flags{regex} } ) {
- push @{ $self->actions->{compiled} }, [ $regex, qr#$regex# ];
- $self->actions->{regex}->{$regex} = $action;
- }
+ my @namespace = split '/', $namespace;
+ return $self->_find_or_create_namespace_node( $tree, @namespace )
+ ->getNodeValue;
}
-=item $self->setup_actions( $class, $component )
-
-=cut
+sub _find_or_create_namespace_node {
+ my ( $self, $parent, $part, @namespace ) = @_;
-sub setup_actions {
- my ( $self, $class ) = @_;
-
- # These are the core structures
- $self->actions(
- {
- plain => {},
- private => {},
- regex => {},
- compiled => []
- }
- );
+ return $parent unless $part;
- # We use a tree
- 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}++;
- }
- }
+ my $child =
+ ( grep { $_->getNodeValue->part eq $part } $parent->getAllChildren )[0];
- for my $namespace ( keys %namespaces ) {
+ unless ($child) {
+ my $container = Catalyst::ActionContainer->new($part);
+ $parent->addChild( $child = Tree::Simple->new($container) );
+ }
- for my $sym ( values %{ $namespace . '::' } ) {
+ $self->_find_or_create_namespace_node( $child, @namespace );
+}
- if ( *{$sym}{CODE} && *{$sym}{CODE} == $code ) {
+=head2 $self->setup_actions( $class, $context )
- $name = *{$sym}{NAME};
- $class->set_action( $name, $code, $comp, $attrs );
- last;
- }
+Loads all of the pre-load dispatch types, registers their actions and then
+loads all of the post-load dispatch types, and iterates over the tree of
+actions, displaying the debug information if appropriate.
- }
+=cut
- }
+sub setup_actions {
+ my ( $self, $c ) = @_;
- }
+ my @classes =
+ $self->_load_dispatch_types( @{ $self->preload_dispatch_types } );
+ @{ $self->_registered_dispatch_types }{@classes} = (1) x @classes;
+ foreach my $comp ( values %{ $c->components } ) {
+ $comp->register_actions($c) if $comp->can('register_actions');
}
- return unless $class->debug;
+ $self->_load_dispatch_types( @{ $self->postload_dispatch_types } );
- 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;
+ $self->_display_action_tables($c);
+}
+
+sub _display_action_tables {
+ my ($self, $c) = @_;
+
+ my $avail_width = Catalyst::Utils::term_width() - 12;
+ my $col1_width = ($avail_width * .25) < 20 ? 20 : int($avail_width * .25);
+ my $col2_width = ($avail_width * .50) < 36 ? 36 : int($avail_width * .50);
+ my $col3_width = $avail_width - $col1_width - $col2_width;
+ my $privates = Text::SimpleTable->new(
+ [ $col1_width, 'Private' ], [ $col2_width, 'Class' ], [ $col3_width, '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} } );
+ $walker->( $walker, $self->_tree, '' );
+ $c->log->debug( "Loaded Private actions:\n" . $privates->draw . "\n" )
+ if $has_private;
+
+ # List all public actions
+ $_->list($c) for @{ $self->dispatch_types };
+}
+
+sub _load_dispatch_types {
+ my ( $self, @types ) = @_;
+
+ my @loaded;
+ # Preload action types
+ for my $type (@types) {
+ # first param is undef because we cannot get the appclass
+ my $class = Catalyst::Utils::resolve_namespace(undef, 'Catalyst::DispatchType', $type);
- my $publics = Text::ASCIITable->new;
- $publics->setCols( 'Public', 'Private' );
- $publics->setColWidth( 'Public', 36, 1 );
- $publics->setColWidth( 'Private', 37, 1 );
+ eval { Class::MOP::load_class($class) };
+ Catalyst::Exception->throw( message => qq/Couldn't load "$class"/ )
+ if $@;
+ push @{ $self->dispatch_types }, $class->new;
- for my $plain ( sort keys %{ $actions->{plain} } ) {
- my $action = $actions->{plain}->{$plain};
- $publics->addRow( "/$plain", "/$action" );
+ push @loaded, $class;
}
- $class->log->debug( "Loaded public actions:\n" . $publics->draw )
- if ( @{ $publics->{tbl_rows} } );
+ return @loaded;
+}
+
+=head2 $self->dispatch_type( $type )
+
+Get the DispatchType object of the relevant type, i.e. passing C<$type> of
+C<Chained> would return a L<Catalyst::DispatchType::Chained> object (assuming
+of course it's being used.)
+
+=cut
+
+sub dispatch_type {
+ my ($self, $name) = @_;
- my $regexes = Text::ASCIITable->new;
- $regexes->setCols( 'Regex', 'Private' );
- $regexes->setColWidth( 'Regex', 36, 1 );
- $regexes->setColWidth( 'Private', 37, 1 );
+ # first param is undef because we cannot get the appclass
+ $name = Catalyst::Utils::resolve_namespace(undef, 'Catalyst::DispatchType', $name);
- for my $regex ( sort keys %{ $actions->{regex} } ) {
- my $action = $actions->{regex}->{$regex};
- $regexes->addRow( $regex, "/$action" );
+ for (@{ $self->dispatch_types }) {
+ return $_ if ref($_) eq $name;
}
+ return undef;
+}
- $class->log->debug( "Loaded regex actions:\n" . $regexes->draw )
- if ( @{ $regexes->{tbl_rows} } );
+use Moose;
+
+# 5.70 backwards compatibility hacks.
+
+# Various plugins (e.g. Plugin::Server and Plugin::Authorization::ACL)
+# need the methods here which *should* be private..
+
+# You should be able to use get_actions or get_containers appropriately
+# instead of relying on these methods which expose implementation details
+# of the dispatcher..
+#
+# IRC backlog included below, please come ask if this doesn't work for you.
+#
+# <@t0m> 5.80, the state of. There are things in the dispatcher which have
+# been deprecated, that we yell at anyone for using, which there isn't
+# a good alternative for yet..
+# <@mst> er, get_actions/get_containers provides that doesn't it?
+# <@mst> DispatchTypes are loaded on demand anyway
+# <@t0m> I'm thinking of things like _tree which is aliased to 'tree' with
+# warnings otherwise shit breaks.. We're issuing warnings about the
+# correct set of things which you shouldn't be calling..
+# <@mst> right
+# <@mst> basically, I don't see there's a need for a replacement for anything
+# <@mst> it was never a good idea to call ->tree
+# <@mst> nothingmuch was the only one who did AFAIK
+# <@mst> and he admitted it was a hack ;)
+
+# See also t/lib/TestApp/Plugin/AddDispatchTypes.pm
+
+# Alias _method_name to method_name, add a before modifier to warn..
+foreach my $public_method_name (qw/
+ tree
+ registered_dispatch_types
+ method_action_class
+ action_hash
+ container_hash
+ /) {
+ my $private_method_name = '_' . $public_method_name;
+ my $meta = __PACKAGE__->meta; # Calling meta method here fine as we happen at compile time.
+ $meta->add_method($public_method_name, $meta->get_method($private_method_name));
+ {
+ my %package_hash; # Only warn once per method, per package. These are infrequent enough that
+ # I haven't provided a way to disable them, patches welcome.
+ $meta->add_before_method_modifier($public_method_name, sub {
+ my $class = caller(2);
+ chomp($class);
+ $package_hash{$class}++ || do {
+ warn("Class $class is calling the deprecated method\n"
+ . " Catalyst::Dispatcher::$public_method_name,\n"
+ . " this will be removed in Catalyst 5.9\n");
+ };
+ });
+ }
}
+# End 5.70 backwards compatibility hacks.
+
+__PACKAGE__->meta->make_immutable;
+
+=head2 meta
-=back
+Provided by Moose
-=head1 AUTHOR
+=head1 AUTHORS
-Sebastian Riedel, C<sri@cpan.org>
+Catalyst Contributors, see Catalyst.pm
=head1 COPYRIGHT
-This program is free software, you can redistribute it and/or modify it under
+This library is free software. You can redistribute it and/or modify it under
the same terms as Perl itself.
=cut