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 Catalyst::DispatchType::Default;
use Catalyst::DispatchType::Index;
+use Catalyst::Utils;
use Text::SimpleTable;
use Tree::Simple;
use Tree::Simple::Visitor::FindByPath;
-use Scalar::Util ();
+use Class::Load qw(load_class try_load_class);
+use Encode 2.21 'decode_utf8';
-# Stringify to class
-use overload '""' => sub { return ref shift }, fallback => 1;
+use namespace::clean -except => 'meta';
-__PACKAGE__->mk_accessors(
- qw/tree dispatch_types registered_dispatch_types
- method_action_class action_container_class
- preload_dispatch_types postload_dispatch_types
- action_hash container_hash
- /
-);
+# 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/;
+our @PRELOAD = qw/Index Path/;
# 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
Catalyst::Dispatcher - The Catalyst Dispatcher
=head1 METHODS
-=head2 new
+=head2 new
Construct a new dispatcher.
=cut
-sub new {
- my $self = shift;
- my $class = ref($self) || $self;
-
- my $obj = $class->SUPER::new(@_);
+sub _build__tree {
+ my ($self) = @_;
- # set the default pre- and and postloads
- $obj->preload_dispatch_types( \@PRELOAD );
- $obj->postload_dispatch_types( \@POSTLOAD );
- $obj->action_hash( {} );
- $obj->container_hash( {} );
+ my $container =
+ Catalyst::ActionContainer->new( { part => '/', actions => {} } );
- # Create the root node of the tree
- my $container =
- Catalyst::ActionContainer->new( { part => '/', actions => {} } );
- $obj->tree( Tree::Simple->new( $container, Tree::Simple->ROOT ) );
-
- return $obj;
+ return Tree::Simple->new($container, Tree::Simple->ROOT);
}
=head2 $self->preload_dispatch_types
+My::Dispatch::Type
-=head2 $self->detach( $c, $command [, \@arguments ] )
-
-Documented in L<Catalyst>
-
-=cut
-
-sub detach {
- my ( $self, $c, $command, @args ) = @_;
- $c->forward( $command, @args ) if $command;
- die $Catalyst::DETACH;
-}
-
=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 ( $c->action ) {
-use Data::Dumper; warn Dumper( $c->action, $c->action->namespace );
- $c->forward( join( '/', '', $c->action->namespace, '_DISPATCH' ) );
+ if ( my $action = $c->action ) {
+ $c->forward( join( '/', '', $action->namespace, '_DISPATCH' ) );
}
-
else {
my $path = $c->req->path;
+ $path =~ s/%([0-9A-Fa-f]{2})/chr(hex($1))/eg;
+ $path = decode_utf8($path);
+
my $error = $path
? qq/Unknown resource "$path"/
: "No default action defined";
}
# $self->_command2action( $c, $command [, \@arguments ] )
-# Search for an action, from the command and returns C<($action, $args)> on
+# $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 _command2action {
return 0;
}
- my @args;
-
+ my (@args, @captures);
+
+ if ( ref( $extra_params[-2] ) eq 'ARRAY' ) {
+ @captures = @{ splice @extra_params, -2, 1 };
+ }
+
if ( ref( $extra_params[-1] ) eq 'ARRAY' ) {
@args = @{ pop @extra_params }
} else {
my $action;
# go to a string path ("/foo/bar/gorch")
- # or action object which stringifies to that
- $action = $self->_invoke_as_path( $c, "$command", \@args );
+ # 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("...")
+ # 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 );
}
- return $action, \@args;
+ return $action, \@args, \@captures;
}
-=head2 $self->go( $c, $command [, \@arguments ] )
+=head2 $self->visit( $c, $command [, \@arguments ] )
Documented in L<Catalyst>
=cut
-sub go {
+sub visit {
my $self = shift;
+ $self->_do_visit('visit', @_);
+}
+
+sub _do_visit {
+ my $self = shift;
+ my $opname = shift;
my ( $c, $command ) = @_;
- my ( $action, $args ) = $self->_command2action(@_);
+ my ( $action, $args, $captures ) = $self->_command2action(@_);
+ my $error = qq/Couldn't $opname("$command"): /;
- unless ($action) {
- my $error =
- qq/Couldn't go to command "$command": /
- . qq/Invalid action or component./;
+ 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 {
+ $error = q();
+ }
+
+ if($error) {
$c->error($error);
$c->log->debug($error) if $c->debug;
return 0;
}
+ $action = $self->expand_action($action);
+
local $c->request->{arguments} = $args;
- $c->namespace($action->namespace);
- $c->action($action);
+ 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>
- die $Catalyst::GO;
+=cut
+
+sub go {
+ my $self = shift;
+ $self->_do_visit('go', @_);
+ Catalyst::Exception::Go->throw;
}
=head2 $self->forward( $c, $command [, \@arguments ] )
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 ) = $self->_command2action(@_);
+ my ( $action, $args, $captures ) = $self->_command2action(@_);
- unless ($action) {
- my $error =
- qq/Couldn't forward to command "$command": /
- . qq/Invalid action or component./;
+ 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;
}
+
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 ) = @_;
}
}
-sub _find_component_class {
+sub _find_component {
my ( $self, $c, $component ) = @_;
- return ref($component)
- || ref( $c->component($component) )
- || $c->component($component);
+ # fugly, why doesn't ->component('MyApp') work?
+ return $c if ($component eq blessed($c));
+
+ return blessed($component)
+ ? $component
+ : $c->component($component);
}
sub _invoke_as_component {
- my ( $self, $c, $component, $method ) = @_;
+ my ( $self, $c, $component_or_class, $method ) = @_;
- my $class = $self->_find_component_class( $c, $component ) || return 0;
+ 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;
+ }
- if ( my $code = $class->can($method) ) {
- return $self->method_action_class->new(
+ if ( my $code = $component_class->can($method) ) {
+ return $self->_method_action_class->new(
{
name => $method,
code => $code,
- reverse => "$class->$method",
- class => $class,
+ reverse => "$component_class->$method",
+ class => $component_class,
namespace => Catalyst::Utils::class2prefix(
- $class, $c->config->{case_sensitive}
+ $component_class, ref($c)->config->{case_sensitive}
),
}
);
}
else {
my $error =
- qq/Couldn't forward to "$class". Does not implement "$method"/;
+ qq/Couldn't forward to "$component_class". Does not implement "$method"/;
$c->error($error);
$c->log->debug($error)
if $c->debug;
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
DESCEND: while (@path) {
$path = join '/', @path;
- $path =~ s#^/##;
-
- $path = '' if $path eq '/'; # Root action
+ $path =~ s#^/+##;
# Check out dispatch types to see if any will handle the path at
# this level
unshift @args, $arg;
}
- s/%([0-9A-Fa-f]{2})/chr(hex($1))/eg for grep { defined } @{$c->req->captures||[]};
+ s/%([0-9A-Fa-f]{2})/chr(hex($1))/eg for grep { defined } @{$req->captures||[]};
- $c->log->debug( 'Path is "' . $c->req->match . '"' )
- if ( $c->debug && length $c->req->match );
+ if($c->debug && defined $req->match && length $req->match) {
+ my $match = $req->match;
+ $match =~ s/%([0-9A-Fa-f]{2})/chr(hex($1))/eg;
+ $match = decode_utf8($match);
+ $c->log->debug( 'Path is "' . $match . '"' )
+ }
- $c->log->debug( 'Arguments are "' . join( '/', @args ) . '"' )
+ $c->log->debug( 'Arguments are "' . join( '/', map { decode_utf8 $_ } @args ) . '"' )
if ( $c->debug && @args );
}
$namespace = join( "/", grep { length } split '/', ( defined $namespace ? $namespace : "" ) );
- return $self->action_hash->{"$namespace/$name"};
+ return $self->_action_hash->{"${namespace}/${name}"};
}
-=head2 $self->get_action_by_path( $path );
-
-Returns the named action by its full path.
+=head2 $self->get_action_by_path( $path );
-=cut
+Returns the named action by its full private path.
+
+=cut
sub get_action_by_path {
my ( $self, $path ) = @_;
$path =~ s/^\///;
$path = "/$path" unless $path =~ /\//;
- $self->action_hash->{$path};
+ $self->_action_hash->{$path};
}
=head2 $self->get_actions( $c, $action, $namespace )
if ( length $namespace ) {
do {
- push @containers, $self->container_hash->{$namespace};
+ push @containers, $self->_container_hash->{$namespace};
} while ( $namespace =~ s#/[^/]+$## );
}
- return reverse grep { defined } @containers, $self->container_hash->{''};
-
- my @parts = split '/', $namespace;
+ return reverse grep { defined } @containers, $self->_container_hash->{''};
}
=head2 $self->uri_for_action($action, \@captures)
return undef;
}
+=head2 expand_action
+
+expand an action into a full representation of the dispatch.
+mostly useful for chained, other actions will just return a
+single action.
+
+=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
sub register {
my ( $self, $c, $action ) = @_;
- my $registered = $self->registered_dispatch_types;
+ my $registered = $self->_registered_dispatch_types;
- my $priv = 0;
foreach my $key ( keys %{ $action->attributes } ) {
next if $key eq 'Private';
my $class = "Catalyst::DispatchType::$key";
unless ( $registered->{$class} ) {
- eval "require $class";
- push( @{ $self->dispatch_types }, $class->new ) unless $@;
+ # FIXME - Some error checking and re-throwing needed here, as
+ # we eat exceptions loading dispatch types.
+ # see also try_load_class
+ eval { load_class($class) };
+ my $load_failed = $@;
+ $self->_check_deprecated_dispatch_type( $key, $load_failed );
+ push( @{ $self->dispatch_types }, $class->new ) unless $load_failed;
$registered->{$class} = 1;
}
}
+ 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;
+ }
+ }
+
# 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 $was_registered = 0;
+ foreach my $type ( @normal_dtypes ) {
+ $was_registered = 1 if $type->register( $c, $action );
+ }
+
+ if (not $was_registered) {
+ foreach my $type ( @low_precedence_dtypes ) {
+ $type->register( $c, $action );
+ }
}
my $namespace = $action->namespace;
# Set the method value
$container->add_action($action);
- $self->action_hash->{"$namespace/$name"} = $action;
- $self->container_hash->{$namespace} = $container;
+ $self->_action_hash->{"$namespace/$name"} = $action;
+ $self->_container_hash->{$namespace} = $container;
}
sub _find_or_create_action_container {
my ( $self, $namespace ) = @_;
- my $tree ||= $self->tree;
+ my $tree ||= $self->_tree;
return $tree->getNodeValue unless $namespace;
=head2 $self->setup_actions( $class, $context )
+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 ) = @_;
- $self->dispatch_types( [] );
- $self->registered_dispatch_types( {} );
- $self->method_action_class('Catalyst::Action');
- $self->action_container_class('Catalyst::ActionContainer');
-
my @classes =
$self->_load_dispatch_types( @{ $self->preload_dispatch_types } );
- @{ $self->registered_dispatch_types }{@classes} = (1) x @classes;
+ @{ $self->_registered_dispatch_types }{@classes} = (1) x @classes;
foreach my $comp ( values %{ $c->components } ) {
$comp->register_actions($c) if $comp->can('register_actions');
$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 $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(
- [ 20, 'Private' ],
- [ 36, 'Class' ],
- [ 12, 'Method' ]
+ [ $col1_width, 'Private' ], [ $col2_width, 'Class' ], [ $col3_width, 'Method' ]
);
my $has_private = 0;
$walker->( $walker, $_, $prefix ) for $parent->getAllChildren;
};
- $walker->( $walker, $self->tree, '' );
+ $walker->( $walker, $self->_tree, '' );
$c->log->debug( "Loaded Private actions:\n" . $privates->draw . "\n" )
if $has_private;
my ( $self, @types ) = @_;
my @loaded;
-
# Preload action types
for my $type (@types) {
- my $class =
- ( $type =~ /^\+(.*)$/ ) ? $1 : "Catalyst::DispatchType::${type}";
- eval "require $class";
- Catalyst::Exception->throw( message => qq/Couldn't load "$class"/ )
- if $@;
+ # first param is undef because we cannot get the appclass
+ my $class = Catalyst::Utils::resolve_namespace(undef, 'Catalyst::DispatchType', $type);
+
+ my ($success, $error) = try_load_class($class);
+ Catalyst::Exception->throw( message => $error ) if not $success;
push @{ $self->dispatch_types }, $class->new;
push @loaded, $class;
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) = @_;
+
+ # first param is undef because we cannot get the appclass
+ $name = Catalyst::Utils::resolve_namespace(undef, 'Catalyst::DispatchType', $name);
+
+ for (@{ $self->dispatch_types }) {
+ return $_ if ref($_) eq $name;
+ }
+ return undef;
+}
+
+sub _check_deprecated_dispatch_type {
+ my ($self, $key, $load_failed) = @_;
+
+ return unless $key =~ /^(Local)?Regexp?/;
+
+ # TODO: Should these throw an exception rather than just warning?
+ if ($load_failed) {
+ warn( "Attempt to use deprecated $key dispatch type.\n"
+ . " Use Chained methods or install the standalone\n"
+ . " Catalyst::DispatchType::Regex if necessary.\n" );
+ } elsif ( !defined $Catalyst::DispatchType::Regex::VERSION
+ || $Catalyst::DispatchType::Regex::VERSION le '5.90020' ) {
+ # We loaded the old core version of the Regex module this will break
+ warn( "The $key DispatchType has been removed from Catalyst core.\n"
+ . " An old version of the core Catalyst::DispatchType::Regex\n"
+ . " has been loaded and will likely fail. Please remove\n"
+ . " $INC{'Catalyst/DispatchType/Regex.pm'}\n"
+ . " and use Chained methods or install the standalone\n"
+ . " Catalyst::DispatchType::Regex if necessary.\n" );
+ }
+}
+
+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
+
+Provided by Moose
+
=head1 AUTHORS
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
projects / catagits/Catalyst-Runtime.git / blobdiff