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=5def763c1ce5844404d6f3ed9d7c6bb0a8974275;hp=cb019340dfe65c23342ab3c859eea8db7945232d;hb=b0bb11ec8c056e043e87cd7733125ffc9d9bcfb0;hpb=9dad4705cff1744cea885e0b5c6c3f3cfa8890de diff --git a/lib/Catalyst/Dispatcher.pm b/lib/Catalyst/Dispatcher.pm index cb01934..5def763 100644 --- a/lib/Catalyst/Dispatcher.pm +++ b/lib/Catalyst/Dispatcher.pm @@ -1,14 +1,27 @@ package Catalyst::Dispatcher; use strict; -use base 'Class::Data::Inheritable'; +use base 'Class::Accessor::Fast'; use Catalyst::Exception; use Catalyst::Utils; +use Catalyst::Action; +use Catalyst::ActionContainer; +use Catalyst::DispatchType::Default; +use Catalyst::DispatchType::Index; use Text::ASCIITable; use Tree::Simple; use Tree::Simple::Visitor::FindByPath; -__PACKAGE__->mk_classdata($_) for qw/actions tree/; +# Stringify to class +use overload '""' => sub { return ref shift }, fallback => 1; + +__PACKAGE__->mk_accessors(qw/tree dispatch_types/); + +# Preload these action types +our @PRELOAD = qw/Path Regex/; + +# Postload these action types +our @POSTLOAD = qw/Index Default/; =head1 NAME @@ -24,76 +37,28 @@ See L. =over 4 -=item $c->detach( $command [, \@arguments ] ) - -Like C but doesn't return. +=item $self->detach( $c, $command [, \@arguments ] ) =cut sub detach { - my ( $c, $command, @args ) = @_; + my ( $self, $c, $command, @args ) = @_; $c->forward( $command, @args ) if $command; - # die with DETACH signal, which will be caught in dispatching. - die $Catalyst::Engine::DETACH; + die $Catalyst::DETACH; } -=item $c->dispatch - -Dispatch request to actions. +=item $self->dispatch($c) =cut sub dispatch { - my $c = shift; - my $action = $c->req->action; - my $namespace = ''; - $namespace = ( join( '/', @{ $c->req->args } ) || '/' ) - if $action eq 'default'; - - unless ($namespace) { - if ( my $result = $c->get_action($action) ) { - $namespace = Catalyst::Utils::class2prefix( $result->[0]->[0]->[0], - $c->config->{case_sensitive} ); - } - } - - my $default = $action eq 'default' ? $namespace : undef; - my $results = $c->get_action( $action, $default, $default ? 1 : 0 ); - $namespace ||= '/'; + my ( $self, $c ) = @_; - if ( @{$results} ) { - - # Execute last begin - $c->state(1); - if ( my $begin = @{ $c->get_action( 'begin', $namespace, 1 ) }[-1] ) { - $c->execute( @{ $begin->[0] } ); - return if scalar @{ $c->error }; - } - - # Execute the auto chain - my $autorun = 0; - for my $auto ( @{ $c->get_action( 'auto', $namespace, 1 ) } ) { - $autorun++; - $c->execute( @{ $auto->[0] } ); - return if scalar @{ $c->error }; - last unless $c->state; - } - - # Execute the action or last default - my $mkay = $autorun ? $c->state ? 1 : 0 : 1; - if ( ( my $action = $c->req->action ) && $mkay ) { - if ( my $result = @{ $c->get_action( $action, $default, 1 ) }[-1] ) - { - $c->execute( @{ $result->[0] } ); - } - } + if ( $c->action ) { + $c->forward( join( '/', '', $c->namespace, '_DISPATCH' ) ); + } - # Execute last end - if ( my $end = @{ $c->get_action( 'end', $namespace, 1 ) }[-1] ) { - $c->execute( @{ $end->[0] } ); - return if scalar @{ $c->error }; - } - } else { + else { my $path = $c->req->path; my $error = $path ? qq/Unknown resource "$path"/ @@ -103,22 +68,12 @@ sub dispatch { } } -=item $c->forward( $command [, \@arguments ] ) - -Forward processing to a private action or a method from a class. -If you define a class without method it will default to process(). -also takes an optional arrayref containing arguments to be passed -to the new function. $c->req->args will be reset upon returning -from the function. - - $c->forward('/foo'); - $c->forward('index'); - $c->forward(qw/MyApp::Model::CDBI::Foo do_stuff/); - $c->forward('MyApp::View::TT'); +=item $self->forward( $c, $command [, \@arguments ] ) =cut sub forward { + my $self = shift; my $c = shift; my $command = shift; @@ -128,30 +83,42 @@ sub forward { } # Relative forwards from detach - my $caller = ( caller(0) )[0]->isa('Catalyst::Dispatcher') - && ( ( caller(1) )[3] =~ /::detach$/ ) ? caller(1) : caller(0); + my $caller = ( caller(1) )[0]->isa('Catalyst::Dispatcher') + && ( ( caller(2) )[3] =~ /::detach$/ ) ? caller(3) : caller(1); - my $namespace = '/'; my $arguments = ( ref( $_[-1] ) eq 'ARRAY' ) ? pop(@_) : $c->req->args; - if ( $command =~ /^\// ) { - $command =~ /^\/(.*)\/(\w+)$/; - $namespace = $1 || '/'; - $command = $2 || $command; - $command =~ s/^\///; - } + my $results = []; - else { - $namespace = + my $command_copy = $command; + + unless ( $command_copy =~ s/^\/// ) { + my $namespace = Catalyst::Utils::class2prefix( $caller, $c->config->{case_sensitive} ) - || '/'; + || ''; + $command_copy = "${namespace}/${command}"; } - my $results = $c->get_action( $command, $namespace ); + unless ( $command_copy =~ /\// ) { + $results = $c->get_action( $command_copy, '/' ); + } + else { + my @extra_args; + DESCEND: while ( $command_copy =~ s/^(.*)\/(\w+)$/$1/ ) { + my $tail = $2; + $results = $c->get_action( $tail, $1 ); + if ( @{$results} ) { + $command = $tail; + push( @{$arguments}, @extra_args ); + last DESCEND; + } + unshift( @extra_args, $tail ); + } + } unless ( @{$results} ) { - unless ( defined( $c->components->{$command} ) ) { + unless ( $c->components->{$command} ) { my $error = qq/Couldn't forward to command "$command". Invalid action or component./; $c->error($error); @@ -163,9 +130,19 @@ qq/Couldn't forward to command "$command". Invalid action or component./; my $method = shift || 'process'; if ( my $code = $c->components->{$class}->can($method) ) { - $c->actions->{reverse}->{"$code"} = "$class->$method"; - $results = [ [ [ $class, $code ] ] ]; - } else { + my $action = Catalyst::Action->new( + { + name => $method, + code => $code, + reverse => "$class->$method", + class => $class, + namespace => $class, + } + ); + $results = [ [$action] ]; + } + + else { my $error = qq/Couldn't forward to "$class". Does not implement "$method"/; $c->error($error); @@ -179,7 +156,7 @@ qq/Couldn't forward to command "$command". Invalid action or component./; local $c->request->{arguments} = [ @{$arguments} ]; for my $result ( @{$results} ) { - $c->execute( @{ $result->[0] } ); + $result->[0]->execute($c); return if scalar @{ $c->error }; last unless $c->state; } @@ -187,204 +164,234 @@ qq/Couldn't forward to command "$command". Invalid action or component./; return $c->state; } -=item $c->get_action( $action, $namespace, $inherit ) - -Get an action in a given namespace. +=item $self->prepare_action($c) =cut -sub get_action { - my ( $c, $action, $namespace, $inherit ) = @_; - return [] unless $action; - $namespace ||= ''; - $inherit ||= 0; +sub prepare_action { + my ( $self, $c ) = @_; + my $path = $c->req->path; + my @path = split /\//, $c->req->path; + $c->req->args( \my @args ); - if ($namespace) { - $namespace = '' if $namespace eq '/'; - my $parent = $c->tree; - my @results; + push( @path, '/' ) unless @path; # Root action - if ($inherit) { - my $result = $c->actions->{private}->{ $parent->getUID }->{$action}; - push @results, [$result] if $result; - my $visitor = Tree::Simple::Visitor::FindByPath->new; + DESCEND: while (@path) { + $path = join '/', @path; - SEARCH: - for my $part ( split '/', $namespace ) { - $visitor->setSearchPath($part); - $parent->accept($visitor); - my $child = $visitor->getResult; - my $uid = $child->getUID if $child; - my $match = $c->actions->{private}->{$uid}->{$action} if $uid; - push @results, [$match] if $match; - if ($child) { - $parent = $child; - } - else { - last SEARCH; - } - } + $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 } ) { + last DESCEND if $type->match( $c, $path ); } - else { + # If not, move the last part path to args - if ($namespace) { - my $visitor = Tree::Simple::Visitor::FindByPath->new; - $visitor->setSearchPath( split '/', $namespace ); - $parent->accept($visitor); - my $child = $visitor->getResult; - my $uid = $child->getUID if $child; - my $match = $c->actions->{private}->{$uid}->{$action} - if $uid; - push @results, [$match] if $match; - } + unshift @args, pop @path; + } - else { - my $result = - $c->actions->{private}->{ $parent->getUID }->{$action}; - push @results, [$result] if $result; - } + $c->log->debug( 'Arguments are "' . join( '/', @args ) . '"' ) + if ( $c->debug && @args ); +} + +=item $self->get_action( $c, $action, $namespace, $inherit ) +=cut + +sub get_action { + my ( $self, $c, $action, $namespace, $inherit ) = @_; + return [] unless $action; + $namespace ||= ''; + $namespace = '' if $namespace eq '/'; + $inherit ||= 0; + + my @match = $self->get_containers($namespace); + + if ($inherit) { # Return [ [ $act_obj ], ... ] for valid containers + return [ + map { [ $_->{$action} ] } # Make [ $action_obj ] + grep { defined $_->{$action} } # If it exists in the container + map { $_->actions } # Get action hash for container + @match + ]; + } + else { + my $node = $match[-1]->actions; # Only bother looking at the last one + + if ( defined $node->{$action} + && ( $node->{$action}->namespace eq $namespace ) ) + { + return [ [ $node->{$action} ] ]; + } + else { + return []; } - return \@results; } +} - elsif ( my $p = $c->actions->{plain}->{$action} ) { return [ [$p] ] } - elsif ( my $r = $c->actions->{regex}->{$action} ) { return [ [$r] ] } +=item $self->get_containers( $namespace ) - else { +=cut - for my $i ( 0 .. $#{ $c->actions->{compiled} } ) { - my $name = $c->actions->{compiled}->[$i]->[0]; - my $regex = $c->actions->{compiled}->[$i]->[1]; +sub get_containers { + my ( $self, $namespace ) = @_; - if ( my @snippets = ( $action =~ $regex ) ) { - return [ [ $c->actions->{regex}->{$name}, $name, \@snippets ] ]; - } + # If the namespace is / just return the root ActionContainer - } + return ( $self->tree->getNodeValue ) + if ( !$namespace || ( $namespace eq '/' ) ); + + # Use a visitor to recurse down the tree finding the ActionContainers + # for each namespace in the chain. + + my $visitor = Tree::Simple::Visitor::FindByPath->new; + my @path = split( '/', $namespace ); + $visitor->setSearchPath(@path); + $self->tree->accept($visitor); + + my @match = $visitor->getResults; + @match = ( $self->tree ) unless @match; + + if ( !defined $visitor->getResult ) { + + # 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. + + my $extra = $path[ ( scalar @match ) - 1 ]; + last unless $extra; + $visitor->setSearchPath($extra); + $match[-1]->accept($visitor); + push( @match, $visitor->getResult ) if defined $visitor->getResult; } - return []; -} -=item $c->set_action( $action, $code, $namespace, $attrs ) + return map { $_->getNodeValue } @match; +} -Set an action in a given namespace. +=item $self->set_action( $c, $action, $code, $class, $attrs ) =cut sub set_action { - my ( $c, $method, $code, $namespace, $attrs ) = @_; + my ( $self, $c, $method, $code, $class, $attrs ) = @_; - my $prefix = - Catalyst::Utils::class2prefix( $namespace, $c->config->{case_sensitive} ) + my $namespace = + Catalyst::Utils::class2prefix( $class, $c->config->{case_sensitive} ) || ''; - my %flags; + my %attributes; for my $attr ( @{$attrs} ) { - if ( $attr =~ /^(Local|Relative)$/ ) { $flags{local}++ } - elsif ( $attr =~ /^(Global|Absolute)$/ ) { $flags{global}++ } - elsif ( $attr =~ /^Path\(\s*(.+)\s*\)$/i ) { $flags{path} = $1 } - elsif ( $attr =~ /^Private$/i ) { $flags{private}++ } - elsif ( $attr =~ /^(Regex|Regexp)\(\s*(.+)\s*\)$/i ) { - $flags{regex} = $2; + + # Parse out :Foo(bar) into Foo => bar etc (and arrayify) + + my %initialized; + $initialized{ ref $_ }++ for @{ $self->dispatch_types }; + + if ( my ( $key, $value ) = ( $attr =~ /^(.*?)(?:\(\s*(.+)\s*\))?$/ ) ) { + + # Initialize types + my $class = "Catalyst::DispatchType::$key"; + unless ( $initialized{$class} ) { + eval "require $class"; + push( @{ $self->dispatch_types }, $class->new ) unless $@; + $initialized{$class}++; + } + + if ( defined $value ) { + ( $value =~ s/^'(.*)'$/$1/ ) || ( $value =~ s/^"(.*)"/$1/ ); + } + push( @{ $attributes{$key} }, $value ); } } - if ( $flags{private} && ( keys %flags > 1 ) ) { + if ( $attributes{Private} && ( keys %attributes > 1 ) ) { $c->log->debug( 'Bad action definition "' . join( ' ', @{$attrs} ) - . qq/" for "$namespace->$method"/ ) + . qq/" for "$class->$method"/ ) if $c->debug; return; } - return unless keys %flags; + return unless keys %attributes; - my $parent = $c->tree; + my $parent = $self->tree; my $visitor = Tree::Simple::Visitor::FindByPath->new; - for my $part ( split '/', $prefix ) { - $visitor->setSearchPath($part); - $parent->accept($visitor); - my $child = $visitor->getResult; - - unless ($child) { - $child = $parent->addChild( Tree::Simple->new($part) ); + if ($namespace) { + for my $part ( split '/', $namespace ) { $visitor->setSearchPath($part); $parent->accept($visitor); - $child = $visitor->getResult; - } + my $child = $visitor->getResult; - $parent = $child; - } + unless ($child) { - my $uid = $parent->getUID; - $c->actions->{private}->{$uid}->{$method} = [ $namespace, $code ]; - my $forward = $prefix ? "$prefix/$method" : $method; + # Create a new tree node and an ActionContainer to form + # its value. - if ( $flags{path} ) { - $flags{path} =~ s/^\w+//; - $flags{path} =~ s/\w+$//; - if ( $flags{path} =~ /^\s*'(.*)'\s*$/ ) { $flags{path} = $1 } - if ( $flags{path} =~ /^\s*"(.*)"\s*$/ ) { $flags{path} = $1 } - } + my $container = + Catalyst::ActionContainer->new( + { part => $part, actions => {} } ); + $child = $parent->addChild( Tree::Simple->new($container) ); + $visitor->setSearchPath($part); + $parent->accept($visitor); + $child = $visitor->getResult; + } - if ( $flags{regex} ) { - $flags{regex} =~ s/^\w+//; - $flags{regex} =~ s/\w+$//; - if ( $flags{regex} =~ /^\s*'(.*)'\s*$/ ) { $flags{regex} = $1 } - if ( $flags{regex} =~ /^\s*"(.*)"\s*$/ ) { $flags{regex} = $1 } + $parent = $child; + } } - my $reverse = $prefix ? "$prefix/$method" : $method; + my $reverse = $namespace ? "$namespace/$method" : $method; - if ( $flags{local} || $flags{global} || $flags{path} ) { - my $path = $flags{path} || $method; - my $absolute = 0; - - if ( $path =~ /^\/(.+)/ ) { - $path = $1; - $absolute = 1; + my $action = Catalyst::Action->new( + { + name => $method, + code => $code, + reverse => $reverse, + namespace => $namespace, + class => $class, + attributes => \%attributes, } + ); - $absolute = 1 if $flags{global}; - my $name = $absolute ? $path : $prefix ? "$prefix/$path" : $path; - $c->actions->{plain}->{$name} = [ $namespace, $code ]; - } + # Set the method value + $parent->getNodeValue->actions->{$method} = $action; - if ( my $regex = $flags{regex} ) { - push @{ $c->actions->{compiled} }, [ $regex, qr#$regex# ]; - $c->actions->{regex}->{$regex} = [ $namespace, $code ]; + # Pass the action to our dispatch types so they can register it if reqd. + foreach my $type ( @{ $self->dispatch_types } ) { + $type->register( $c, $action ); } - - $c->actions->{reverse}->{"$code"} = $reverse; } -=item $class->setup_actions($component) - -Setup actions for a component. +=item $self->setup_actions( $class, $component ) =cut sub setup_actions { - my $self = shift; + my ( $self, $c ) = @_; - # These are the core structures - $self->actions( - { - plain => {}, - private => {}, - regex => {}, - compiled => [], - reverse => {} - } - ); + $self->dispatch_types( [] ); + + # 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; + } # We use a tree - $self->tree( Tree::Simple->new( 0, Tree::Simple->ROOT ) ); + my $container = + Catalyst::ActionContainer->new( { part => '/', actions => {} } ); + $self->tree( Tree::Simple->new( $container, Tree::Simple->ROOT ) ); - for my $comp ( keys %{ $self->components } ) { + for my $comp ( keys %{ $c->components } ) { # We only setup components that inherit from Catalyst::Base next unless $comp->isa('Catalyst::Base'); @@ -394,39 +401,40 @@ sub setup_actions { my $name = ''; no strict 'refs'; my @cache = ( $comp, @{"$comp\::ISA"} ); - my %namespaces; + my %classes; - while ( my $namespace = shift @cache ) { - $namespaces{$namespace}++; - for my $isa ( @{"$comp\::ISA"} ) { - next if $namespaces{$isa}; + while ( my $class = shift @cache ) { + $classes{$class}++; + for my $isa ( @{"$class\::ISA"} ) { + next if $classes{$isa}; push @cache, $isa; - $namespaces{$isa}++; + $classes{$isa}++; } } - for my $namespace ( keys %namespaces ) { - - for my $sym ( values %{ $namespace . '::' } ) { - + for my $class ( keys %classes ) { + for my $sym ( values %{ $class . '::' } ) { if ( *{$sym}{CODE} && *{$sym}{CODE} == $code ) { - $name = *{$sym}{NAME}; - $self->set_action( $name, $code, $comp, $attrs ); + $self->set_action( $c, $name, $code, $comp, $attrs ); last; } - } - } - } + } + # 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; } - return unless $self->debug; + return unless $c->debug; - my $actions = $self->actions; my $privates = Text::ASCIITable->new; $privates->setCols( 'Private', 'Class' ); $privates->setColWidth( 'Private', 36, 1 ); @@ -436,49 +444,25 @@ sub setup_actions { my ( $walker, $parent, $prefix ) = @_; $prefix .= $parent->getNodeValue || ''; $prefix .= '/' unless $prefix =~ /\/$/; - my $uid = $parent->getUID; - - for my $action ( keys %{ $actions->{private}->{$uid} } ) { - my ( $class, $code ) = @{ $actions->{private}->{$uid}->{$action} }; - $privates->addRow( "$prefix$action", $class ); + my $node = $parent->getNodeValue->actions; + + for my $action ( keys %{$node} ) { + my $action_obj = $node->{$action}; + next + if ( ( $action =~ /^_.*/ ) + && ( !$c->config->{show_internal_actions} ) ); + $privates->addRow( "$prefix$action", $action_obj->class ); } $walker->( $walker, $_, $prefix ) for $parent->getAllChildren; }; $walker->( $walker, $self->tree, '' ); - $self->log->debug( "Loaded private actions:\n" . $privates->draw ) + $c->log->debug( "Loaded Private actions:\n" . $privates->draw ) if ( @{ $privates->{tbl_rows} } ); - my $publics = Text::ASCIITable->new; - $publics->setCols( 'Public', 'Private' ); - $publics->setColWidth( 'Public', 36, 1 ); - $publics->setColWidth( 'Private', 37, 1 ); - - for my $plain ( sort keys %{ $actions->{plain} } ) { - my ( $class, $code ) = @{ $actions->{plain}->{$plain} }; - my $reverse = $self->actions->{reverse}->{$code}; - $reverse = $reverse ? "/$reverse" : $code; - $publics->addRow( "/$plain", $reverse ); - } - - $self->log->debug( "Loaded public actions:\n" . $publics->draw ) - if ( @{ $publics->{tbl_rows} } ); - - my $regexes = Text::ASCIITable->new; - $regexes->setCols( 'Regex', 'Private' ); - $regexes->setColWidth( 'Regex', 36, 1 ); - $regexes->setColWidth( 'Private', 37, 1 ); - - for my $regex ( sort keys %{ $actions->{regex} } ) { - my ( $class, $code ) = @{ $actions->{regex}->{$regex} }; - my $reverse = $self->actions->{reverse}->{$code}; - $reverse = $reverse ? "/$reverse" : $code; - $regexes->addRow( $regex, $reverse ); - } - - $self->log->debug( "Loaded regex actions:\n" . $regexes->draw ) - if ( @{ $regexes->{tbl_rows} } ); + # List all public actions + $_->list($c) for @{ $self->dispatch_types }; } =back