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/
-);
-
+#do these belong as package vars or should we build these via a builder method?
# Preload these action types
-our @PRELOAD = qw/Path Regex/;
+our @PRELOAD = qw/Index Path Regex/;
# Postload these action types
-our @POSTLOAD = qw/Index Default/;
+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
=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
+
+Construct a new dispatcher.
+
+=cut
+
+sub BUILD {
+ my ($self, $params) = @_;
+
+ my $container =
+ Catalyst::ActionContainer->new( { part => '/', actions => {} } );
+
+ $self->_tree( Tree::Simple->new( $container, Tree::Simple->ROOT ) );
+}
+
+=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:
-=item $self->detach( $c, $command [, \@arguments ] )
+ +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->detach( $c, $command [, \@arguments ] )
+
+Documented in L<Catalyst>
=cut
die $Catalyst::DETACH;
}
-=item $self->dispatch($c)
+=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 ) {
- $c->forward( join( '/', '', $c->namespace, '_DISPATCH' ) );
+ if ( my $action = $c->action ) {
+ $c->forward( join( '/', '', $action->namespace, '_DISPATCH' ) );
}
else {
}
}
-=item $self->forward( $c, $command [, \@arguments ] )
+=head2 $self->forward( $c, $command [, \@arguments ] )
+
+Documented in L<Catalyst>
=cut
sub forward {
- my $self = shift;
- my $c = shift;
- my $command = shift;
+ my ( $self, $c, $command, @extra_params ) = @_;
unless ($command) {
$c->log->debug('Nothing to forward to') if $c->debug;
return 0;
}
- my $arguments = ( ref( $_[-1] ) eq 'ARRAY' ) ? pop(@_) : $c->req->args;
+ my @args;
- my $result;
+ 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 };
+ }
- unless ( ref $command ) {
- my $command_copy = $command;
+ my $action;
- unless ( $command_copy =~ s/^\/// ) {
- my $namespace = $c->namespace;
- $command_copy = "${namespace}/${command}";
- }
+ # forward to a string path ("/foo/bar/gorch") or action object which stringifies to that
+ $action = $self->_invoke_as_path( $c, "$command", \@args );
- 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) {
- $command = $tail;
- push( @{$arguments}, @extra_args );
- last DESCEND;
- }
- unshift( @extra_args, $tail );
- }
- }
+ # 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 );
+ }
+
+
+ unless ($action) {
+ my $error =
+ qq/Couldn't forward to command "$command": /
+ . qq/Invalid action or component./;
+ $c->error($error);
+ $c->log->debug($error) if $c->debug;
+ return 0;
}
- unless ($result) {
+ #push @$args, @_;
- my $class = ref($command) || ref( $c->component($command) );
- my $method = shift || 'process';
+ no warnings 'recursion';
- unless ($class) {
- 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;
- }
+ my $orig_args = $c->request->arguments();
+ $c->request->arguments(\@args);
+ $action->dispatch( $c );
+ $c->request->arguments($orig_args);
+
+ return $c->state;
+}
- if ( my $code = $class->can($method) ) {
- my $action = $self->method_action_class->new(
- {
- name => $method,
- code => $code,
- reverse => "$class->$method",
- class => $class,
- namespace => $class,
- }
- );
- $result = $action;
- }
+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_class {
+ my ( $self, $c, $component ) = @_;
- $result->execute($c);
+ return ref($component)
+ || ref( $c->component($component) )
+ || $c->component($component);
+}
- return $c->state;
+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;
+ }
}
-=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 );
- push( @path, '/' ) unless @path; # Root action
+ unshift( @path, '' ); # Root action
DESCEND: while (@path) {
$path = join '/', @path;
+ $path =~ s#^/##;
- $path = '' if $path eq '/'; # Root action
+ $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 } ) {
+ foreach my $type ( @{ $self->_dispatch_types } ) {
last DESCEND if $type->match( $c, $path );
}
# If not, move the last part path to args
-
- unshift @args, pop @path;
+ 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 && $req->match );
+
$c->log->debug( 'Arguments are "' . join( '/', @args ) . '"' )
if ( $c->debug && @args );
}
-=item $self->get_action( $action, $namespace )
+=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 ||= '';
- $namespace = '' if $namespace eq '/';
- my @match = $self->get_containers($namespace);
+ $namespace = join( "/", grep { length } split '/', $namespace || "" );
- return unless @match;
+ return $self->_action_hash->{"${namespace}/${name}"};
+}
- if ( my $action = $match[-1]->get_action( $name ) ) {
- return $action if $action->namespace eq $namespace;
- }
+=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};
}
-=item $self->get_actions( $c, $action, $namespace )
+=head2 $self->get_actions( $c, $action, $namespace )
=cut
sub get_actions {
my ( $self, $c, $action, $namespace ) = @_;
return [] unless $action;
- $namespace ||= '';
- $namespace = '' if $namespace eq '/';
+
+ $namespace = join( "/", grep { length } split '/', $namespace || "" );
my @match = $self->get_containers($namespace);
- return map { $_->get_action( $action ) } @match;
+ 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 || ( $namespace eq '/' ) );
+ if ( length $namespace ) {
+ do {
+ push @containers, $self->_container_hash->{$namespace};
+ } while ( $namespace =~ s#/[^/]+$## );
+ }
- # Use a visitor to recurse down the tree finding the ActionContainers
- # for each namespace in the chain.
+ return reverse grep { defined } @containers, $self->_container_hash->{''};
- my $visitor = Tree::Simple::Visitor::FindByPath->new;
- my @path = split( '/', $namespace );
- $visitor->setSearchPath(@path);
- $self->tree->accept($visitor);
+ #return (split '/', $namespace); # isnt this more clear?
+ my @parts = split '/', $namespace;
+}
- my @match = $visitor->getResults;
- @match = ( $self->tree ) unless @match;
+=head2 $self->uri_for_action($action, \@captures)
- if ( !defined $visitor->getResult ) {
+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 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 the action object is not available for external dispatch or the dispatcher
+cannot determine an appropriate URI, this method will return undef.
- if ( my $extra = $path[ ( scalar @match ) - 1 ] ) {
- $visitor->setSearchPath($extra);
- $match[-1]->accept($visitor);
- push( @match, $visitor->getResult ) if defined $visitor->getResult;
- }
- }
+=cut
- return map { $_->getNodeValue } @match;
+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;
}
-sub register {
- my ( $self, $c, $action ) = @_;
+=head2 $self->register( $c, $action )
- my $namespace = $action->namespace;
- my $parent = $self->tree;
- my $visitor = Tree::Simple::Visitor::FindByPath->new;
-
- if ($namespace) {
- for my $part ( split '/', $namespace ) {
- $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;
- }
+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.
- $parent = $child;
- }
- }
+=cut
- # Set the method value
- $parent->getNodeValue->actions->{ $action->name } = $action;
+sub register {
+ my ( $self, $c, $action ) = @_;
- my $registered = $self->registered_dispatch_types;
+ 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} ) {
- 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.
- foreach my $type ( @{ $self->dispatch_types } ) {
+ 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;
}
-=item $self->setup_actions( $class, $component )
+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) );
+ }
+
+ $self->_find_or_create_namespace_node( $child, @namespace );
+}
+
+=head2 $self->setup_actions( $class, $context )
+
=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 ) );
+ 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');
}
- # 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;
- }
+ $self->_load_dispatch_types( @{ $self->postload_dispatch_types } );
return unless $c->debug;
- my $privates = Text::SimpleTable->new( [ 36, 'Private' ], [ 37, 'Class' ] );
+ my $privates = Text::SimpleTable->new(
+ [ 20, 'Private' ],
+ [ 36, 'Class' ],
+ [ 12, 'Method' ]
+ );
my $has_private = 0;
my $walker = sub {
next
if ( ( $action =~ /^_.*/ )
&& ( !$c->config->{show_internal_actions} ) );
- $privates->row( "$prefix$action", $action_obj->class );
+ $privates->row( "$prefix$action", $action_obj->class, $action );
$has_private = 1;
}
$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 _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;
+ }
+
+ return @loaded;
}
-=back
+no Moose;
+__PACKAGE__->meta->make_immutable;
+
+=head2 meta
+
+Provided by Moose
=head1 AUTHOR
projects / catagits/Catalyst-Runtime.git / blobdiff