package Catalyst::Dispatcher;
-use strict;
-use base 'Class::Accessor::Fast';
+use Moose;
+use Class::MOP;
+
use Catalyst::Exception;
use Catalyst::Utils;
use Catalyst::Action;
use Text::SimpleTable;
use Tree::Simple;
use Tree::Simple::Visitor::FindByPath;
+use Scalar::Util ();
-# 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_dispatch_types postload_dispatch_types
- action_hash container_hash
- /
-);
-
+#do these belong as package vars or should we build these via a builder method?
# Preload these action types
our @PRELOAD = qw/Index Path Regex/;
# Postload these action types
our @POSTLOAD = qw/Default/;
+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_container_class => (is => 'rw', default => 'Catalyst::ActionContainer');
+
+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] });
+has _action_hash => (is => 'rw', required => 1, lazy => 1, default => sub { {} });
+has _container_hash => (is => 'rw', required => 1, lazy => 1, default => sub { {} });
+
+no Moose;
+
=head1 NAME
Catalyst::Dispatcher - The Catalyst Dispatcher
=cut
-sub new {
- my $self = shift;
- my $class = ref($self) || $self;
-
- my $obj = $class->SUPER::new(@_);
+sub BUILD {
+ my ($self, $params) = @_;
- # 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;
+ $self->_tree( Tree::Simple->new( $container, Tree::Simple->ROOT ) );
}
=head2 $self->preload_dispatch_types
sub dispatch {
my ( $self, $c ) = @_;
- if ( $c->action ) {
- $c->forward( join( '/', '', $c->action->namespace, '_DISPATCH' ) );
+ if ( my $action = $c->action ) {
+ $c->forward( join( '/', '', $action->namespace, '_DISPATCH' ) );
}
else {
=cut
sub forward {
- my ( $self, $c, $command ) = splice( @_, 0, 3 );
+ my ( $self, $c, $command, @extra_params ) = @_;
unless ($command) {
$c->log->debug('Nothing to forward to') if $c->debug;
return 0;
}
- my $args = [ @{ $c->request->arguments } ];
+ my @args;
- @$args = @{ pop @_ } if ( ref( $_[-1] ) eq 'ARRAY' );
+ 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;
+
+ # forward to a string path ("/foo/bar/gorch") or action object which stringifies to that
+ $action = $self->_invoke_as_path( $c, "$command", \@args );
+
+ # forward 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 );
+ }
- my $action = $self->_invoke_as_path( $c, $command, $args )
- || $self->_invoke_as_component( $c, $command, shift );
unless ($action) {
my $error =
#push @$args, @_;
- local $c->request->{arguments} = $args;
- $action->dispatch( $c );
+ no warnings 'recursion';
+ my $orig_args = $c->request->arguments();
+ $c->request->arguments(\@args);
+ $action->dispatch( $c );
+ $c->request->arguments($orig_args);
+
return $c->state;
}
sub _invoke_as_path {
my ( $self, $c, $rel_path, $args ) = @_;
- return if ref $rel_path; # it must be a string
-
my $path = $self->_action_rel2abs( $c, $rel_path );
my ( $tail, @extra_args );
my ( $self, $c, $component, $method ) = @_;
my $class = $self->_find_component_class( $c, $component ) || return 0;
- $method ||= "process";
if ( my $code = $class->can($method) ) {
- return $self->method_action_class->new(
+ return $self->_method_action_class->new(
{
name => $method,
code => $code,
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
# Check out dispatch types to see if any will handle the path at
# this level
- foreach my $type ( @{ $self->dispatch_types } ) {
+ foreach my $type ( @{ $self->_dispatch_types } ) {
last DESCEND if $type->match( $c, $path );
}
unshift @args, $arg;
}
- $c->log->debug( 'Path is "' . $c->req->match . '"' )
- if ( $c->debug && $c->req->match );
+ 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 && $req->match );
$c->log->debug( 'Arguments are "' . join( '/', @args ) . '"' )
if ( $c->debug && @args );
$namespace = join( "/", grep { length } split '/', $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.
-=cut
+=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->{''};
+ 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 $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;
+ #my $priv = 0; #seems to be unused
foreach my $key ( keys %{ $action->attributes } ) {
- $priv++ if $key eq 'Private';
+ next if $key eq 'Private';
my $class = "Catalyst::DispatchType::$key";
unless ( $registered->{$class} ) {
- eval "require $class";
- push( @{ $self->dispatch_types }, $class->new ) unless $@;
+ #some error checking rethrowing here wouldn't hurt.
+ eval { Class::MOP::load_class($class) };
+ push( @{ $self->_dispatch_types }, $class->new ) unless $@;
$registered->{$class} = 1;
}
}
# 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 );
+ foreach my $type ( @{ $self->_dispatch_types } ) {
+ $type->register( $c, $action );
}
- return unless $reg + $priv;
-
my $namespace = $action->namespace;
my $name = $action->name;
- my $container = $self->find_or_create_action_container($namespace);
+ 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;
+ $self->_action_hash->{"$namespace/$name"} = $action;
+ $self->_container_hash->{$namespace} = $container;
}
-sub find_or_create_action_container {
+sub _find_or_create_action_container {
my ( $self, $namespace ) = @_;
- my $tree ||= $self->tree;
+ my $tree ||= $self->_tree;
return $tree->getNodeValue unless $namespace;
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->do_load_dispatch_types( @{ $self->preload_dispatch_types } );
- @{ $self->registered_dispatch_types }{@classes} = (1) x @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');
}
- $self->do_load_dispatch_types( @{ $self->postload_dispatch_types } );
+ $self->_load_dispatch_types( @{ $self->postload_dispatch_types } );
return unless $c->debug;
$walker->( $walker, $_, $prefix ) for $parent->getAllChildren;
};
- $walker->( $walker, $self->tree, '' );
- $c->log->debug( "Loaded Private actions:\n" . $privates->draw )
- if ($has_private);
+ $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 };
+ $_->list($c) for @{ $self->_dispatch_types };
}
-sub do_load_dispatch_types {
+sub _load_dispatch_types {
my ( $self, @types ) = @_;
my @loaded;
for my $type (@types) {
my $class =
( $type =~ /^\+(.*)$/ ) ? $1 : "Catalyst::DispatchType::${type}";
- eval "require $class";
+
+ eval { Class::MOP::load_class($class) };
Catalyst::Exception->throw( message => qq/Couldn't load "$class"/ )
if $@;
- push @{ $self->dispatch_types }, $class->new;
+ push @{ $self->_dispatch_types }, $class->new;
push @loaded, $class;
}
return @loaded;
}
+no Moose;
+__PACKAGE__->meta->make_immutable;
+
+=head2 meta
+
+Provided by Moose
+
=head1 AUTHOR
Sebastian Riedel, C<sri@cpan.org>
projects / catagits/Catalyst-Runtime.git / blobdiff