X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FCatalyst%2FDispatcher.pm;h=961ce150aa64372982c786c5ffc3ce658c144881;hb=8505565b33db11c9c5059225b5fbb7cd7d79eb94;hp=851a3b0bec281a0f01d350ad83614ed2100d662b;hpb=158c88c0db581dcee202cd854c77186590c2992c;p=catagits%2FCatalyst-Runtime.git diff --git a/lib/Catalyst/Dispatcher.pm b/lib/Catalyst/Dispatcher.pm index 851a3b0..961ce15 100644 --- a/lib/Catalyst/Dispatcher.pm +++ b/lib/Catalyst/Dispatcher.pm @@ -8,20 +8,25 @@ use Catalyst::Action; use Catalyst::ActionContainer; use Catalyst::DispatchType::Default; use Catalyst::DispatchType::Index; -use Text::ASCIITable; +use Text::SimpleTable; use Tree::Simple; use Tree::Simple::Visitor::FindByPath; # Stringify to class use overload '""' => sub { return ref shift }, fallback => 1; -__PACKAGE__->mk_accessors(qw/tree dispatch_types registered_dispatch_types/); +__PACKAGE__->mk_accessors( + qw/tree dispatch_types registered_dispatch_types + 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 @@ -33,11 +38,52 @@ See L. =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 +To use a custom class outside the regular C namespace, prefix +it with a C<+>, like so: + + +My::Dispatch::Type -=item $self->detach( $c, $command [, \@arguments ] ) +=head2 $self->postload_dispatch_types + +An arrayref of post-loaded dispatchtype classes + +Entries are considered to be available as C +To use a custom class outside the regular C namespace, prefix +it with a C<+>, like so: + + +My::Dispatch::Type + +=head2 $self->detach( $c, $command [, \@arguments ] ) + +Documented in L =cut @@ -47,15 +93,18 @@ sub detach { 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' ) ); + $c->forward( join( '/', '', $c->action->namespace, '_DISPATCH' ) ); } else { @@ -68,7 +117,9 @@ sub dispatch { } } -=item $self->forward( $c, $command [, \@arguments ] ) +=head2 $self->forward( $c, $command [, \@arguments ] ) + +Documented in L =cut @@ -82,37 +133,50 @@ sub forward { 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 $command_copy = $command; + unless ( ref $command ) { + my $command_copy = $command; - unless ( $command_copy =~ s/^\/// ) { - my $namespace = $c->namespace; - $command_copy = "${namespace}/${command}"; - } + unless ( $command_copy =~ s/^\/// ) { + my $namespace = $c->stack->[-1]->namespace; + $command_copy = "${namespace}/${command}"; + } - 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; + 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) { + $local_args = 1; + $command = $tail; + unshift( @{$arguments}, @extra_args ); + last DESCEND; + } + unshift( @extra_args, $tail ); } - unshift( @extra_args, $tail ); } } - unless ( $result ) { + unless ($result) { + + my $class = ref($command) + || ref( $c->component($command) ) + || $c->component($command); + my $method = shift || 'process'; - unless ( $c->components->{$command} ) { + unless ($class) { my $error = qq/Couldn't forward to command "$command". Invalid action or component./; $c->error($error); @@ -120,17 +184,16 @@ qq/Couldn't forward to command "$command". Invalid action or component./; return 0; } - my $class = $command; - my $method = shift || 'process'; - - if ( my $code = $c->components->{$class}->can($method) ) { - my $action = Catalyst::Action->new( + if ( my $code = $class->can($method) ) { + my $action = $self->method_action_class->new( { name => $method, code => $code, reverse => "$class->$method", class => $class, - namespace => $class, + namespace => Catalyst::Utils::class2prefix( + $class, $c->config->{case_sensitive} + ), } ); $result = $action; @@ -147,15 +210,18 @@ qq/Couldn't forward to command "$command". Invalid action or component./; } - local $c->request->{arguments} = [ @{$arguments} ]; - local $c->{namespace} = $result->namespace; - - $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 @@ -165,12 +231,13 @@ sub prepare_action { 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 @@ -180,20 +247,26 @@ sub prepare_action { } # 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( $c, $action, $namespace ) +=head2 $self->get_action( $action, $namespace ) + +returns a named action from a given namespace. =cut sub get_action { - my ( $self, $c, $name, $namespace ) = @_; + my ( $self, $name, $namespace ) = @_; return unless $name; $namespace ||= ''; $namespace = '' if $namespace eq '/'; @@ -202,13 +275,12 @@ sub get_action { return unless @match; - if ( my $action = $match[-1]->get_action( $c, $name ) ) - { + if ( my $action = $match[-1]->get_action($name) ) { return $action if $action->namespace eq $namespace; } } -=item $self->get_actions( $c, $action, $namespace ) +=head2 $self->get_actions( $c, $action, $namespace ) =cut @@ -220,10 +292,12 @@ sub get_actions { my @match = $self->get_containers($namespace); - return map { $_->get_action($c, $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 @@ -255,68 +329,96 @@ sub get_containers { # should catch any failures - or short-circuit this if this *is* a # bug in the visitor and gets fixed. - my $extra = $path[ ( scalar @match ) - 1 ]; - last unless $extra; - $visitor->setSearchPath($extra); - $match[-1]->accept($visitor); - push( @match, $visitor->getResult ) if defined $visitor->getResult; + if ( my $extra = $path[ ( scalar @match ) - 1 ] ) { + $visitor->setSearchPath($extra); + $match[-1]->accept($visitor); + push( @match, $visitor->getResult ) if defined $visitor->getResult; + } } return map { $_->getNodeValue } @match; } -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; - foreach my $key (keys %{$action->attributes}) { - my $class = "Catalyst::DispatchType::$key"; - unless ( $registered->{$class} ) { - eval "require $class"; - push( @{ $self->dispatch_types }, $class->new ) unless $@; - $registered->{$class} = 1; - } + my $priv = 0; + foreach my $key ( keys %{ $action->attributes } ) { + $priv++ if $key eq 'Private'; + my $class = "Catalyst::DispatchType::$key"; + unless ( $registered->{$class} ) { + eval "require $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 } ) { - $type->register( $c, $action ); + $reg++ if $type->register( $c, $action ); } + + return unless $reg + $priv; + + my $namespace = $action->namespace; + 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 ) = @_; + + my $tree ||= $self->tree; + my $visitor ||= Tree::Simple::Visitor::FindByPath->new; + + + return $tree unless $namespace; + + my @namespace = split '/', $namespace; + return $self->_find_or_create_namespace_node( $tree, $visitor, @namespace ); +} + +sub _find_or_create_namespace_node { + my ( $self, $parent, $visitor, $part, @namespace ) = @_; + + return $parent unless $part; + + $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; + } + + $self->_find_or_create_namespace_node( $child, $visitor, @namespace ); } -=item $self->setup_actions( $class, $component ) +=head2 $self->setup_actions( $class, $context ) + =cut @@ -325,44 +427,33 @@ sub setup_actions { $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; - } + 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 ) ); - $c->register_actions( $c ); - - foreach my $comp ( values %{$c->components} ) { - $comp->register_actions( $c ) if $comp->can('register_actions'); + 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->do_load_dispatch_types( @{ $self->postload_dispatch_types } ); return unless $c->debug; - my $privates = Text::ASCIITable->new; - $privates->setCols( 'Private', 'Class' ); - $privates->setColWidth( 'Private', 36, 1 ); - $privates->setColWidth( 'Class', 37, 1 ); + my $privates = Text::SimpleTable->new( + [ 20, 'Private' ], + [ 38, 'Class' ], + [ 12, 'Method' ] + ); + my $has_private = 0; my $walker = sub { my ( $walker, $parent, $prefix ) = @_; $prefix .= $parent->getNodeValue || ''; @@ -374,7 +465,8 @@ sub setup_actions { next if ( ( $action =~ /^_.*/ ) && ( !$c->config->{show_internal_actions} ) ); - $privates->addRow( "$prefix$action", $action_obj->class ); + $privates->row( "$prefix$action", $action_obj->class, $action ); + $has_private = 1; } $walker->( $walker, $_, $prefix ) for $parent->getAllChildren; @@ -382,13 +474,31 @@ sub setup_actions { $walker->( $walker, $self->tree, '' ); $c->log->debug( "Loaded Private actions:\n" . $privates->draw ) - if ( @{ $privates->{tbl_rows} } ); + if ($has_private); # List all public actions $_->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