__PACKAGE__->mk_accessors(
qw/tree dispatch_types registered_dispatch_types
- method_action_class action_container_class/
+ method_action_class action_container_class
+ preload_dispatch_types postload_dispatch_types
+ /
);
# 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/;
=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 new {
+ my $self = shift;
+ my $class = ref($self) || $self;
+
+ my $obj = $class->SUPER::new(@_);
+
+ # set the default pre- and and postloads
+ $obj->preload_dispatch_types( \@PRELOAD );
+ $obj->postload_dispatch_types( \@POSTLOAD );
+ return $obj;
+}
+
+=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:
-=item $self->detach( $c, $command [, \@arguments ] )
+ +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->action->namespace, '_DISPATCH' ) );
}
}
}
-=item $self->forward( $c, $command [, \@arguments ] )
+=head2 $self->forward( $c, $command [, \@arguments ] )
+
+Documented in L<Catalyst>
=cut
return 0;
}
- my $arguments = ( ref( $_[-1] ) eq 'ARRAY' ) ? pop(@_) : $c->req->args;
+ my $local_args = 0;
+ my $arguments = $c->req->args;
+ if ( ref( $_[-1] ) eq 'ARRAY' ) {
+ $arguments = pop(@_);
+ $local_args = 1;
+ }
my $result;
my $tail = $2;
$result = $c->get_action( $tail, $1 );
if ($result) {
- $command = $tail;
- push( @{$arguments}, @extra_args );
+ $local_args = 1;
+ $command = $tail;
+ unshift( @{$arguments}, @extra_args );
last DESCEND;
}
unshift( @extra_args, $tail );
unless ($result) {
- my $class = ref($command) || ref( $c->component($command) );
- my $method = shift || 'process';
+ my $class = ref($command)
+ || ref( $c->component($command) )
+ || $c->component($command);
+ my $method = shift || 'process';
unless ($class) {
my $error =
}
- local $c->request->{arguments} = [ @{$arguments} ];
-
- $result->execute($c);
+ if ($local_args) {
+ local $c->request->{arguments} = [ @{$arguments} ];
+ $result->execute($c);
+ }
+ else { $result->execute($c) }
return $c->state;
}
-=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
my @path = split /\//, $c->req->path;
$c->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
}
# 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;
}
+ $c->log->debug( 'Path is "' . $c->req->match . '"' )
+ if ( $c->debug && $c->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
}
}
-=item $self->get_actions( $c, $action, $namespace )
+=head2 $self->get_actions( $c, $action, $namespace )
=cut
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
return map { $_->getNodeValue } @match;
}
-=item $self->register( $c, $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
return unless $reg + $priv;
my $namespace = $action->namespace;
- my $parent = $self->tree;
- my $visitor = Tree::Simple::Visitor::FindByPath->new;
+ my $node = $self->find_or_create_namespace_node( $namespace );
+
+ # Set the method value
+ $node->getNodeValue->actions->{ $action->name } = $action;
+}
+
+sub find_or_create_namespace_node {
+ my ( $self, $namespace, $parent, $visitor ) = @_;
+
+ $parent ||= $self->tree;
+ $visitor ||= Tree::Simple::Visitor::FindByPath->new;
if ($namespace) {
for my $part ( split '/', $namespace ) {
}
}
- # Set the method value
- $parent->getNodeValue->actions->{ $action->name } = $action;
+ return $parent;
}
-=item $self->setup_actions( $class, $component )
+=head2 $self->setup_actions( $class, $context )
+
=cut
$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;
- }
+ my @classes =
+ $self->do_load_dispatch_types( @{ $self->preload_dispatch_types } );
+ @{ $self->registered_dispatch_types }{@classes} = (1) x @classes;
- # We use a tree
+ # Create the root node of the tree
my $container =
Catalyst::ActionContainer->new( { part => '/', actions => {} } );
$self->tree( Tree::Simple->new( $container, Tree::Simple->ROOT ) );
$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->do_load_dispatch_types( @{ $self->postload_dispatch_types } );
return unless $c->debug;
my $privates = Text::SimpleTable->new(
- [ 24, 'Private' ],
- [ 23, 'Class' ],
- [ 23, 'Method' ]
+ [ 20, 'Private' ],
+ [ 38, 'Class' ],
+ [ 12, 'Method' ]
);
my $has_private = 0;
$_->list($c) for @{ $self->dispatch_types };
}
-=back
+sub do_load_dispatch_types {
+ 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 $@;
+ push @{ $self->dispatch_types }, $class->new;
+
+ push @loaded, $class;
+ }
+
+ return @loaded;
+}
=head1 AUTHOR
projects / catagits/Catalyst-Runtime.git / blobdiff