X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=catagits%2FCatalyst-Runtime.git;a=blobdiff_plain;f=lib%2FCatalyst%2FDispatcher.pm;h=e74a49d2e56d1b6dbdb1f6fe3ccdabd10031b466;hp=745f84f713f82d90de05f27f05bc48634c0ac22e;hb=4ab87e274ac0a05f98c10a4cdba467ba4398b0d3;hpb=2c68dfce1dc4c37623e2a8184efe856e38dedc1a diff --git a/lib/Catalyst/Dispatcher.pm b/lib/Catalyst/Dispatcher.pm index 745f84f..e74a49d 100644 --- a/lib/Catalyst/Dispatcher.pm +++ b/lib/Catalyst/Dispatcher.pm @@ -17,14 +17,16 @@ use overload '""' => sub { return ref shift }, fallback => 1; __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 @@ -36,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 +=item 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: -=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 +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 @@ -50,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 { @@ -71,7 +117,9 @@ sub dispatch { } } -=item $self->forward( $c, $command [, \@arguments ] ) +=head2 $self->forward( $c, $command [, \@arguments ] ) + +Documented in L =cut @@ -85,7 +133,12 @@ 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; @@ -93,7 +146,7 @@ sub forward { my $command_copy = $command; unless ( $command_copy =~ s/^\/// ) { - my $namespace = $c->namespace; + my $namespace = $c->stack->[-1]->namespace; $command_copy = "${namespace}/${command}"; } @@ -106,8 +159,9 @@ sub forward { 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 ); @@ -117,9 +171,12 @@ sub forward { unless ($result) { - my $comp; + my $class = ref($command) + || ref( $c->component($command) ) + || $c->component($command); + my $method = shift || 'process'; - unless ( $comp = (ref $command ? $command : $c->component($command)) ) { + unless ($class) { my $error = qq/Couldn't forward to command "$command". Invalid action or component./; $c->error($error); @@ -127,9 +184,6 @@ qq/Couldn't forward to command "$command". Invalid action or component./; return 0; } - my $class = ref $comp; - my $method = shift || 'process'; - if ( my $code = $class->can($method) ) { my $action = $self->method_action_class->new( { @@ -137,7 +191,9 @@ qq/Couldn't forward to command "$command". Invalid action or component./; code => $code, reverse => "$class->$method", class => $class, - namespace => $class, + namespace => Catalyst::Utils::class2prefix( + $class, $c->config->{case_sensitive} + ), } ); $result = $action; @@ -154,14 +210,18 @@ qq/Couldn't forward to command "$command". Invalid action or component./; } - 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 @@ -171,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 @@ -186,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 '/'; @@ -208,12 +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 @@ -225,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 @@ -260,19 +329,48 @@ 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; } +=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 + sub register { my ( $self, $c, $action ) = @_; + my $registered = $self->registered_dispatch_types; + + 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 } ) { + $reg++ if $type->register( $c, $action ); + } + + return unless $reg + $priv; + my $namespace = $action->namespace; my $parent = $self->tree; my $visitor = Tree::Simple::Visitor::FindByPath->new; @@ -303,25 +401,10 @@ sub register { # Set the method value $parent->getNodeValue->actions->{ $action->name } = $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; - } - } - - # Pass the action to our dispatch types so they can register it if reqd. - foreach my $type ( @{ $self->dispatch_types } ) { - $type->register( $c, $action ); - } } -=item $self->setup_actions( $class, $component ) +=head2 $self->setup_actions( $class, $context ) + =cut @@ -334,8 +417,8 @@ sub setup_actions { $self->action_container_class('Catalyst::ActionContainer'); # Preload action types - for my $type (@PRELOAD) { - my $class = "Catalyst::DispatchType::$type"; + for my $type ( @{$self->preload_dispatch_types} ) { + my $class = ($type =~ /^\+(.*)$/) ? $1 : "Catalyst::DispatchType::${type}"; eval "require $class"; Catalyst::Exception->throw( message => qq/Couldn't load "$class"/ ) if $@; @@ -348,15 +431,13 @@ sub setup_actions { 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'); } # Postload action types - for my $type (@POSTLOAD) { - my $class = "Catalyst::DispatchType::$type"; + for my $type ( @{$self->postload_dispatch_types} ) { + my $class = ($type =~ /^\+(.*)$/) ? $1 : "Catalyst::DispatchType::${type}"; eval "require $class"; Catalyst::Exception->throw( message => qq/Couldn't load "$class"/ ) if $@; @@ -365,7 +446,11 @@ sub setup_actions { return unless $c->debug; - my $privates = Text::SimpleTable->new( [ 36, 'Private' ], [ 37, 'Class' ] ); + my $privates = Text::SimpleTable->new( + [ 20, 'Private' ], + [ 38, 'Class' ], + [ 12, 'Method' ] + ); my $has_private = 0; my $walker = sub { @@ -379,7 +464,7 @@ sub setup_actions { 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; } @@ -394,8 +479,6 @@ sub setup_actions { $_->list($c) for @{ $self->dispatch_types }; } -=back - =head1 AUTHOR Sebastian Riedel, C