package Catalyst::Dispatcher;
-use strict;
-use base 'Class::Data::Inheritable';
-use Memoize;
-use Text::ASCIITable;
+use Moose;
+use Class::MOP;
+with 'MooseX::Emulate::Class::Accessor::Fast';
+
+use Catalyst::Exception;
+use Catalyst::Utils;
+use Catalyst::Action;
+use Catalyst::ActionContainer;
+use Catalyst::DispatchType::Default;
+use Catalyst::DispatchType::Index;
+use Catalyst::Utils;
+use Text::SimpleTable;
use Tree::Simple;
use Tree::Simple::Visitor::FindByPath;
-__PACKAGE__->mk_classdata($_) for qw/actions tree/;
+# 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.
-__PACKAGE__->actions(
- { plain => {}, private => {}, regex => {}, compiled => [], reverse => {} }
-);
-__PACKAGE__->tree( Tree::Simple->new( 0, Tree::Simple->ROOT ) );
+# Preload these action types
+our @PRELOAD = qw/Index Path Regex/;
-memoize('_class2prefix');
+# Postload these action types
+our @POSTLOAD = qw/Default/;
+
+# Note - see back-compat methods at end of file.
+has _tree => (is => 'rw');
+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 { {} });
+has preload_dispatch_types => (is => 'rw', required => 1, lazy => 1, default => sub { [@PRELOAD] });
+
+has postload_dispatch_types => (is => 'rw', required => 1, lazy => 1, default => sub { [@POSTLOAD] });
+
+# Wrap accessors so you can assign a list and it will capture a list ref.
+around qw/preload_dispatch_types postload_dispatch_types/ => sub {
+ my $orig = shift;
+ my $self = shift;
+ return $self->$orig([@_]) if (scalar @_ && ref $_[0] ne 'ARRAY');
+ return $self->$orig(@_);
+};
+
+no Moose;
=head1 NAME
-Catalyst::Dispatch - The Catalyst Dispatcher
+Catalyst::Dispatcher - The Catalyst Dispatcher
=head1 SYNOPSIS
=head1 DESCRIPTION
-=head1 METHODS
+This is the class that maps public urls to actions in your Catalyst
+application based on the attributes you set.
-=over 4
+=head1 METHODS
-=item $c->dispatch
+=head2 new
-Dispatch request to actions.
+Construct a new dispatcher.
=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 = _class2prefix( $result->[0]->[0]->[0] );
- }
- }
- my $default = $action eq 'default' ? $namespace : undef;
- my $results = $c->get_action( $action, $default );
- $namespace ||= '/';
- if ( @{$results} ) {
-
- # Execute last begin
- $c->state(1);
- if ( my $begin = @{ $c->get_action( 'begin', $namespace ) }[-1] ) {
- $c->execute( @{ $begin->[0] } );
- return if scalar @{ $c->error };
- }
+sub BUILD {
+ my ($self, $params) = @_;
- # Execute the auto chain
- my $auto = 0;
- for my $auto ( @{ $c->get_action( 'auto', $namespace ) } ) {
- $c->execute( @{ $auto->[0] } );
- return if scalar @{ $c->error };
- last unless $c->state;
- $auto++;
- }
+ my $container =
+ Catalyst::ActionContainer->new( { part => '/', actions => {} } );
- # Execute the action or last default
- my $mkay = $auto ? $c->state ? 1 : 0 : 1;
- if ( ( my $action = $c->req->action ) && $mkay ) {
- if ( my $result = @{ $c->get_action( $action, $default ) }[-1] ) {
- $c->execute( @{ $result->[0] } );
- }
- }
+ $self->_tree( Tree::Simple->new( $container, Tree::Simple->ROOT ) );
+}
- # Execute last end
- if ( my $end = @{ $c->get_action( 'end', $namespace ) }[-1] ) {
- $c->execute( @{ $end->[0] } );
- return if scalar @{ $c->error };
- }
+=head2 $self->preload_dispatch_types
+
+An arrayref of pre-loaded dispatchtype classes
+
+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:
+
+ +My::Dispatch::Type
+
+=head2 $self->postload_dispatch_types
+
+An arrayref of post-loaded dispatchtype classes
+
+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:
+
+ +My::Dispatch::Type
+
+=head2 $self->dispatch($c)
+
+Delegate the dispatch to the action that matched the url, or return a
+message about unknown resource
+
+=cut
+
+sub dispatch {
+ my ( $self, $c ) = @_;
+ if ( my $action = $c->action ) {
+ $c->forward( join( '/', '', $action->namespace, '_DISPATCH' ) );
}
else {
my $path = $c->req->path;
}
}
-=item $c->forward($command)
+# $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.
-Forward processing to a private action or a method from a class.
-If you define a class without method it will default to process().
+sub _command2action {
+ my ( $self, $c, $command, @extra_params ) = @_;
- $c->forward('/foo');
- $c->forward('index');
- $c->forward(qw/MyApp::Model::CDBI::Foo do_stuff/);
- $c->forward('MyApp::View::TT');
+ unless ($command) {
+ $c->log->debug('Nothing to go to') if $c->debug;
+ return 0;
+ }
+
+ my (@args, @captures);
+
+ if ( ref( $extra_params[-2] ) eq 'ARRAY' ) {
+ @captures = @{ pop @extra_params };
+ }
+
+ 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 $action;
+
+ # 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 );
+ }
+
+ # go to a component ( "MyApp::*::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 );
+ }
+
+ return $action, \@args, \@captures;
+}
+
+=head2 $self->visit( $c, $command [, \@arguments ] )
+
+Documented in L<Catalyst>
=cut
-sub forward {
- my $c = shift;
- my $command = shift;
- unless ($command) {
- $c->log->debug('Nothing to forward to') if $c->debug;
- return 0;
+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./;
}
- my $caller = caller(0);
- my $namespace = '/';
- if ( $command =~ /^\// ) {
- $command =~ /^(.*)\/(\w+)$/;
- $namespace = $1 || '/';
- $namespace = s/^\/// if $namespace ne '/';
- $command = $2;
+ elsif (!defined $action->namespace) {
+ $error .= qq/Action has no namespace: cannot $opname() to a plain /
+ .qq/method or component, must be a :Action or some sort./
}
- else { $namespace = _class2prefix($caller) || '/' }
- my $results = $c->get_action( $command, $namespace );
- unless ( @{$results} ) {
- my $class = $command || '';
- if ( $class =~ /[^\w\:]/ ) {
- my $error = qq/Couldn't forward to "$class"/;
- $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 ] ] ];
- }
- else {
- my $error = qq/Couldn't forward to "$class"/;
- $c->error($error);
- $c->log->debug($error)
- if $c->debug;
- return 0;
- }
+ elsif (!$action->class->can('_DISPATCH')) {
+ $error .= qq/Action cannot _DISPATCH. /
+ .qq/Did you try to $opname() a non-controller action?/;
+ }
+ else {
+ $error = q();
+ }
+
+ if($error) {
+ $c->error($error);
+ $c->log->debug($error) if $c->debug;
+ return 0;
}
- for my $result ( @{$results} ) {
- $c->execute( @{ $result->[0] } );
- return if scalar @{ $c->error };
- last unless $c->state;
+
+ $action = $self->expand_action($action);
+
+ 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', @_);
+ die $Catalyst::GO;
+}
+
+=head2 $self->forward( $c, $command [, \@arguments ] )
+
+Documented in L<Catalyst>
+
+=cut
+
+sub forward {
+ my $self = shift;
+ $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;
}
+
+ no warnings 'recursion';
+
+ local $c->request->{arguments} = $args;
+ $action->dispatch( $c );
+
return $c->state;
}
-=item $c->get_action( $action, $namespace )
+=head2 $self->detach( $c, $command [, \@arguments ] )
-Get an action in a given namespace.
+Documented in L<Catalyst>
=cut
-sub get_action {
- my ( $c, $action, $namespace ) = @_;
- return [] unless $action;
- $namespace ||= '';
- if ($namespace) {
- $namespace = '' if $namespace eq '/';
- my $parent = $c->tree;
- my @results;
- my %allowed = ( begin => 1, auto => 1, default => 1, end => 1 );
- if ( $allowed{$action} ) {
- my $result = $c->actions->{private}->{ $parent->getUID }->{$action};
- push @results, [$result] if $result;
- my $visitor = Tree::Simple::Visitor::FindByPath->new;
- 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;
- }
+sub detach {
+ my ( $self, $c, $command, @args ) = @_;
+ $self->_do_forward(detach => $c, $command, @args ) if $command;
+ die $Catalyst::DETACH;
+}
+
+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 {
- 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;
- }
- else {
- my $result =
- $c->actions->{private}->{ $parent->getUID }->{$action};
- push @results, [$result] if $result;
- }
+ return
+ unless $path
+ ; # if a match on the global namespace failed then the whole lookup failed
}
- return \@results;
+
+ unshift @extra_args, $tail;
}
- elsif ( my $p = $c->actions->{plain}->{$action} ) { return [ [$p] ] }
- elsif ( my $r = $c->actions->{regex}->{$action} ) { return [ [$r] ] }
- else {
- for my $i ( 0 .. $#{ $c->actions->{compiled} } ) {
- my $name = $c->actions->{compiled}->[$i]->[0];
- my $regex = $c->actions->{compiled}->[$i]->[1];
- if ( $action =~ $regex ) {
- my @snippets;
- for my $i ( 1 .. 9 ) {
- no strict 'refs';
- last unless ${$i};
- push @snippets, ${$i};
- }
- return [ [ $c->actions->{regex}->{$name}, $name, \@snippets ] ];
+}
+
+sub _find_component_class {
+ my ( $self, $c, $component ) = @_;
+
+ return ref($component)
+ || ref( $c->component($component) )
+ || $c->component($component);
+}
+
+sub _invoke_as_component {
+ my ( $self, $c, $component, $method ) = @_;
+
+ my $class = $self->_find_component_class( $c, $component ) || return 0;
+
+ if ( my $code = $class->can($method) ) {
+ return $self->_method_action_class->new(
+ {
+ name => $method,
+ code => $code,
+ reverse => "$class->$method",
+ class => $class,
+ namespace => Catalyst::Utils::class2prefix(
+ $class, $c->config->{case_sensitive}
+ ),
}
- }
+ );
+ }
+ 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 [];
}
-=item $c->set_action( $action, $code, $namespace, $attrs )
+=head2 $self->prepare_action($c)
-Set an action in a given namespace.
+Find an dispatch type that matches $c->req->path, and set args from it.
=cut
-sub set_action {
- my ( $c, $method, $code, $namespace, $attrs ) = @_;
+sub prepare_action {
+ my ( $self, $c ) = @_;
+ my $req = $c->req;
+ my $path = $req->path;
+ my @path = split /\//, $req->path;
+ $req->args( \my @args );
- my $prefix = _class2prefix($namespace) || '';
- my %flags;
+ unshift( @path, '' ); # Root action
- for my $attr ( @{$attrs} ) {
- if ( $attr =~ /^(Local|Relative)$/ ) { $flags{local}++ }
- elsif ( $attr =~ /^(Global|Absolute)$/ ) { $flags{global}++ }
- elsif ( $attr =~ /^Path\((.+)\)$/i ) { $flags{path} = $1 }
- elsif ( $attr =~ /^Private$/i ) { $flags{private}++ }
- elsif ( $attr =~ /^(Regex|Regexp)\((.+)\)$/i ) { $flags{regex} = $2 }
- }
+ DESCEND: while (@path) {
+ $path = join '/', @path;
+ $path =~ s#^/##;
- 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 = $c->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) );
- $visitor->setSearchPath($part);
- $parent->accept($visitor);
- $child = $visitor->getResult;
+ $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 );
}
- $parent = $child;
+
+ # 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;
}
- my $uid = $parent->getUID;
- $c->actions->{private}->{$uid}->{$method} = [ $namespace, $code ];
- my $forward = $prefix ? "$prefix/$method" : $method;
-
- if ( $flags{path} ) {
- $flags{path} =~ s/^\w+//;
- $flags{path} =~ s/\w+$//;
- if ( $flags{path} =~ /^'(.*)'$/ ) { $flags{path} = $1 }
- if ( $flags{path} =~ /^"(.*)"$/ ) { $flags{path} = $1 }
+
+ 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 );
+}
+
+=head2 $self->get_action( $action, $namespace )
+
+returns a named action from a given namespace.
+
+=cut
+
+sub get_action {
+ my ( $self, $name, $namespace ) = @_;
+ return unless $name;
+
+ $namespace = join( "/", grep { length } split '/', ( defined $namespace ? $namespace : "" ) );
+
+ return $self->_action_hash->{"${namespace}/${name}"};
+}
+
+=head2 $self->get_action_by_path( $path );
+
+Returns the named action by its full path.
+
+=cut
+
+sub get_action_by_path {
+ my ( $self, $path ) = @_;
+ $path =~ s/^\///;
+ $path = "/$path" unless $path =~ /\//;
+ $self->_action_hash->{$path};
+}
+
+=head2 $self->get_actions( $c, $action, $namespace )
+
+=cut
+
+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;
+}
+
+=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 '/';
+
+ my @containers;
+
+ if ( length $namespace ) {
+ do {
+ push @containers, $self->_container_hash->{$namespace};
+ } while ( $namespace =~ s#/[^/]+$## );
}
- if ( $flags{regex} ) {
- $flags{regex} =~ s/^\w+//;
- $flags{regex} =~ s/\w+$//;
- if ( $flags{regex} =~ /^'(.*)'$/ ) { $flags{regex} = $1 }
- if ( $flags{regex} =~ /^"(.*)"$/ ) { $flags{regex} = $1 }
+
+ return reverse grep { defined } @containers, $self->_container_hash->{''};
+
+ #return (split '/', $namespace); # isnt this more clear?
+ my @parts = split '/', $namespace;
+}
+
+=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.
+
+=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;
+}
+
+=head2 expand_action
- my $reverse = $prefix ? "$prefix/$method" : $method;
+expand an action into a full representation of the dispatch.
+mostly useful for chained, other actions will just return a
+single action.
- if ( $flags{local} || $flags{global} || $flags{path} ) {
- my $path = $flags{path} || $method;
- my $absolute = 0;
- if ( $path =~ /^\/(.+)/ ) {
- $path = $1;
- $absolute = 1;
+=cut
+
+sub expand_action {
+ my ($self, $action) = @_;
+
+ foreach my $dispatch_type (@{ $self->_dispatch_types }) {
+ my $expanded = $dispatch_type->expand_action($action);
+ return $expanded if $expanded;
+ }
+
+ return $action;
+}
+
+=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 register {
+ my ( $self, $c, $action ) = @_;
+
+ my $registered = $self->_registered_dispatch_types;
+
+ #my $priv = 0; #seems to be unused
+ 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;
}
- $absolute = 1 if $flags{global};
- my $name = $absolute ? $path : $prefix ? "$prefix/$path" : $path;
- $c->actions->{plain}->{$name} = [ $namespace, $code ];
}
- 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.
+ foreach my $type ( @{ $self->_dispatch_types } ) {
+ $type->register( $c, $action );
+ }
+
+ my $namespace = $action->namespace;
+ my $name = $action->name;
+
+ my $container = $self->_find_or_create_action_container($namespace);
+
+ # Set the method value
+ $container->add_action($action);
+
+ $self->_action_hash->{"$namespace/$name"} = $action;
+ $self->_container_hash->{$namespace} = $container;
+}
+
+sub _find_or_create_action_container {
+ my ( $self, $namespace ) = @_;
+
+ my $tree ||= $self->_tree;
+
+ return $tree->getNodeValue unless $namespace;
+
+ my @namespace = split '/', $namespace;
+ return $self->_find_or_create_namespace_node( $tree, @namespace )
+ ->getNodeValue;
+}
+
+sub _find_or_create_namespace_node {
+ my ( $self, $parent, $part, @namespace ) = @_;
+
+ return $parent unless $part;
+
+ my $child =
+ ( grep { $_->getNodeValue->part eq $part } $parent->getAllChildren )[0];
+
+ unless ($child) {
+ my $container = Catalyst::ActionContainer->new($part);
+ $parent->addChild( $child = Tree::Simple->new($container) );
}
- $c->actions->{reverse}->{"$code"} = $reverse;
+ $self->_find_or_create_namespace_node( $child, @namespace );
}
-=item $class->setup_actions($component)
+=head2 $self->setup_actions( $class, $context )
-Setup actions for a component.
+Loads all of the preload dispatch types, registers their actions and then
+loads all of the postload dispatch types, and iterates over the tree of
+actions, displaying the debug information if appropriate.
=cut
sub setup_actions {
- my ( $self, $comps ) = @_;
- for my $comp (@$comps) {
- $comp = ref $comp || $comp;
- for my $action ( @{ $comp->_cache } ) {
- 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};
- $self->set_action( $name, $code, $comp, $attrs );
- last;
- }
- }
- }
- }
+ 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');
}
- my $actions = $self->actions;
- my $privates = Text::ASCIITable->new;
- $privates->setCols( 'Private', 'Class' );
- $privates->setColWidth( 'Private', 36, 1 );
- $privates->setColWidth( 'Class', 37, 1 );
+
+ $self->_load_dispatch_types( @{ $self->postload_dispatch_types } );
+
+ return unless $c->debug;
+ $self->_display_action_tables($c);
+}
+
+sub _display_action_tables {
+ my ($self, $c) = @_;
+
+ my $column_width = Catalyst::Utils::term_width() - 20 - 36 - 12;
+ my $privates = Text::SimpleTable->new(
+ [ 20, 'Private' ], [ 36, 'Class' ], [ $column_width, '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, 37 );
+ 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 );
- 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 );
+
+ $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) {
+ my $class =
+ ( $type =~ /^\+(.*)$/ ) ? $1 : "Catalyst::DispatchType::${type}";
+
+ eval { Class::MOP::load_class($class) };
+ Catalyst::Exception->throw( message => qq/Couldn't load "$class"/ )
+ if $@;
+ push @{ $self->_dispatch_types }, $class->new;
+
+ push @loaded, $class;
}
- $self->log->debug( 'Loaded regex actions', $regexes->draw )
- if ( @{ $regexes->{tbl_rows} } && $self->debug );
+
+ return @loaded;
}
-sub _prefix {
- my ( $class, $name ) = @_;
- my $prefix = _class2prefix($class);
- $name = "$prefix/$name" if $prefix;
- return $name;
+# Dont document this until someone else is happy with beaviour. Ash 2009/03/16
+sub dispatch_type {
+ my ($self, $name) = @_;
+
+ unless ($name =~ s/^\+//) {
+ $name = "Catalyst::DispatchType::" . $name;
+ }
+
+ for (@{ $self->_dispatch_types }) {
+ return $_ if ref($_) eq $name;
+ }
+ return undef;
}
-sub _class2prefix {
- my $class = shift || '';
- my $prefix;
- if ( $class =~ /^.*::([MVC]|Model|View|Controller)?::(.*)$/ ) {
- $prefix = lc $2;
- $prefix =~ s/\:\:/\//g;
+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..
+
+# However we can't really take them away until there is a sane API for
+# building actions and configuring / introspecting the dispatcher.
+# In 5.90, we should build that infrastructure, port the plugins which
+# use it, and then take the crap below away.
+# 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
+ dispatch_types
+ 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 = blessed(shift);
+ $package_hash{$class}++ || do {
+ warn("Class $class is calling the deprecated method Catalyst::Dispatcher::$public_method_name,\n"
+ . "this will be removed in Catalyst 5.9X");
+ };
+ });
}
- return $prefix;
}
+# End 5.70 backwards compatibility hacks.
+
+no Moose;
+__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