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=e1297483f57e82cb0113901394473dcc8e837a1c;hp=d5c2aebedf4a88322de81512059b681e1b0afde0;hb=6b23994966a2a66b90986a51e7e1d71f62d90f44;hpb=61cfdd57906b53df9ebfdecfc3481ffa14e74390 diff --git a/lib/Catalyst/Dispatcher.pm b/lib/Catalyst/Dispatcher.pm index d5c2aeb..e129748 100644 --- a/lib/Catalyst/Dispatcher.pm +++ b/lib/Catalyst/Dispatcher.pm @@ -1,25 +1,26 @@ package Catalyst::Dispatcher; use strict; -use base 'Class::Data::Inheritable'; -use Memoize; +use base 'Class::Accessor::Fast'; +use Catalyst::Exception; +use Catalyst::Utils; +use Catalyst::Action; +use Catalyst::ActionContainer; +use Catalyst::DispatchType::Path; +use Catalyst::DispatchType::Regex; +use Catalyst::DispatchType::Default; use Text::ASCIITable; -use Text::ASCIITable::Wrap 'wrap'; 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__->actions( - { plain => {}, private => {}, regex => {}, compiled => [], reverse => {} } -); -__PACKAGE__->tree( Tree::Simple->new( 0, Tree::Simple->ROOT ) ); - -memoize('_class2prefix'); +__PACKAGE__->mk_accessors(qw/actions tree dispatch_types/); =head1 NAME -Catalyst::Dispatch - The Catalyst Dispatcher +Catalyst::Dispatcher - The Catalyst Dispatcher =head1 SYNOPSIS @@ -31,58 +32,77 @@ See L. =over 4 -=item $c->dispatch +=item $self->detach( $c, $command [, \@arguments ] ) + +=cut + +sub detach { + my ( $self, $c, $command, @args ) = @_; + $c->forward( $command, @args ) if $command; + die $Catalyst::DETACH; +} -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 = _class2prefix( $result->[0]->[0]->[0] ); + my ( $self, $c ) = @_; + + if ( $c->action ) { + + my @containers = $self->get_containers( $c->namespace ); + my %actions; + foreach my $name (qw/begin auto end/) { + + # Go down the container list representing each part of the + # current namespace inheritance tree, grabbing the actions hash + # of the ActionContainer object and looking for actions of the + # appropriate name registered to the namespace + + $actions{$name} = [ + map { $_->{$name} } + grep { exists $_->{$name} } + map { $_->actions } + @containers + ]; } - } - my $default = $action eq 'default' ? $namespace : undef; - my $results = $c->get_action( $action, $default ); - $namespace ||= '/'; - if ( @{$results} ) { + + # Errors break the normal flow and the end action is instantly run + my $error = 0; # Execute last begin $c->state(1); - if ( my $begin = @{ $c->get_action( 'begin', $namespace ) }[-1] ) { - $c->execute( @{ $begin->[0] } ); - return if scalar @{ $c->error }; + if ( my $begin = @{ $actions{begin} }[-1] ) { + $begin->execute($c); + $error++ if scalar @{ $c->error }; } # Execute the auto chain - my $auto = 0; - for my $auto ( @{ $c->get_action( 'auto', $namespace ) } ) { - $c->execute( @{ $auto->[0] } ); - return if scalar @{ $c->error }; + my $autorun = 0; + for my $auto ( @{ $actions{auto} } ) { + last if $error; + $autorun++; + $auto->execute($c); + $error++ if scalar @{ $c->error }; last unless $c->state; - $auto++; } # Execute the action or last default - my $mkay = $auto ? $c->state ? 1 : 0 : 1; - if ( ( my $action = $c->req->action ) && $mkay ) { - if ( my $result = @{ $c->get_action( $action, $default ) }[-1] ) { - $c->execute( @{ $result->[0] } ); + my $mkay = $autorun ? $c->state ? 1 : 0 : 1; + if ( $mkay ) { + unless ($error) { + $c->action->execute($c); + $error++ if scalar @{ $c->error }; } } # Execute last end - if ( my $end = @{ $c->get_action( 'end', $namespace ) }[-1] ) { - $c->execute( @{ $end->[0] } ); - return if scalar @{ $c->error }; + if ( my $end = @{ $actions{end} }[-1] ) { + $end->execute($c); } } + else { my $path = $c->req->path; my $error = $path @@ -93,228 +113,307 @@ sub dispatch { } } -=item $c->forward($command) - -Forward processing to a private action or a method from a class. -If you define a class without method it will default to process(). - - $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; + unless ($command) { $c->log->debug('Nothing to forward to') if $c->debug; return 0; } - my $caller = caller(0); - my $namespace = '/'; - if ( $command =~ /^\// ) { - $command =~ /^(.*)\/(\w+)$/; - $namespace = $1 || '/'; - $command = $2; + + # Relative forwards from detach + my $caller = ( caller(1) )[0]->isa('Catalyst::Dispatcher') + && ( ( caller(2) )[3] =~ /::detach$/ ) ? caller(3) : caller(1); + + my $arguments = ( ref( $_[-1] ) eq 'ARRAY' ) ? pop(@_) : $c->req->args; + + my $results = []; + + my $command_copy = $command; + + unless ( $command_copy =~ s/^\/// ) { + my $namespace = + Catalyst::Utils::class2prefix( $caller, $c->config->{case_sensitive} ) || ''; + $command_copy = "${namespace}/${command}"; + } + + unless ( $command_copy =~ /\// ) { + $results = $c->get_action( $command_copy, '/' ); } - else { $namespace = _class2prefix($caller) || '/' } - my $results = $c->get_action( $command, $namespace ); + 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} ) { - my $class = $command; - if ( $class =~ /[^\w\:]/ ) { - my $error = qq/Couldn't forward to "$class"/; + + unless ( $c->components->{$command} ) { + 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 $class = $command; my $method = shift || 'process'; - if ( my $code = $class->can($method) ) { - $c->actions->{reverse}->{"$code"} = "$class->$method"; - $results = [ [ [ $class, $code ] ] ]; + + if ( my $code = $c->components->{$class}->can($method) ) { + my $action = Catalyst::Action->new( + { + name => $method, + code => $code, + reverse => "$class->$method", + namespace => $class, + prefix => $class, + } + ); + $results = [ [$action] ]; } + else { - my $error = qq/Couldn't forward to "$class->$method"/; + my $error = + qq/Couldn't forward to "$class". Does not implement "$method"/; $c->error($error); $c->log->debug($error) if $c->debug; return 0; } + } + + 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; } + return $c->state; } -=item $c->get_action( $action, $namespace ) +=item $self->prepare_action($c) + +=cut + +sub prepare_action { + my ( $self, $c ) = @_; + my $path = $c->req->path; + my @path = split /\//, $c->req->path; + $c->req->args( \my @args ); + + DESCEND: while (@path) { + $path = join '/', @path; + + foreach my $type (@{$self->dispatch_types}) { + last DESCEND if $type->prepare_action($c, $path); + } + + unshift @args, pop @path; + } + + $c->log->debug( 'Arguments are "' . join( '/', @args ) . '"' ) + if ( $c->debug && @args ); +} -Get an action in a given namespace. +=item $self->get_action( $c, $action, $namespace, $inherit ) =cut sub get_action { - my ( $c, $action, $namespace ) = @_; + my ( $self, $c, $action, $namespace, $inherit ) = @_; return [] unless $action; $namespace ||= ''; + $inherit ||= 0; + if ($namespace) { - $namespace = '' if $namespace eq '/'; - my $parent = $c->tree; + + my @match = $self->get_containers( $namespace ); + my @results; - my %allowed = ( begin => 1, auto => 1, default => 1, end => 1 ); - if ( $allowed{$action} ) { - my $result = $c->actions->{private}->{ $parent->getUID }->{$action}; - push @results, [$result] if $result; - my $visitor = Tree::Simple::Visitor::FindByPath->new; - 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; - $parent = $child if $child; - } - } - else { - 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; - } - else { - my $result = - $c->actions->{private}->{ $parent->getUID }->{$action}; - push @results, [$result] if $result; - } + + foreach my $child ($inherit ? @match: $match[-1]) { + my $node = $child->actions; + push(@results, [ $node->{$action} ]) if defined $node->{$action}; } return \@results; } - elsif ( my $p = $c->actions->{plain}->{$action} ) { return [ [$p] ] } - elsif ( my $r = $c->actions->{regex}->{$action} ) { return [ [$r] ] } - else { - for my $i ( 0 .. $#{ $c->actions->{compiled} } ) { - my $name = $c->actions->{compiled}->[$i]->[0]; - my $regex = $c->actions->{compiled}->[$i]->[1]; - if ( $action =~ $regex ) { - my @snippets; - for my $i ( 1 .. 9 ) { - no strict 'refs'; - last unless ${$i}; - push @snippets, ${$i}; - } - return [ [ $c->actions->{regex}->{$name}, $name, \@snippets ] ]; - } - } - } + return []; } -=item $c->set_action( $action, $code, $namespace, $attrs ) +=item $self->get_containers( $namespace ) + +=cut + +sub get_containers { + my ( $self, $namespace ) = @_; + + # If the namespace is / just return the root ActionContainer + + return ($self->tree->getNodeValue) if $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 map { $_->getNodeValue } @match; +} -Set an action in a given namespace. +=item $self->set_action( $c, $action, $code, $namespace, $attrs ) =cut sub set_action { - my ( $c, $method, $code, $namespace, $attrs ) = @_; + my ( $self, $c, $method, $code, $namespace, $attrs ) = @_; - my $prefix = _class2prefix($namespace) || ''; - my %flags; + my $prefix = + Catalyst::Utils::class2prefix( $namespace, $c->config->{case_sensitive} ) + || ''; + my %attributes; for my $attr ( @{$attrs} ) { - if ( $attr =~ /^(Local|Relative)$/ ) { $flags{local}++ } - elsif ( $attr =~ /^(Global|Absolute)$/ ) { $flags{global}++ } - elsif ( $attr =~ /^Path\((.+)\)$/i ) { $flags{path} = $1 } - elsif ( $attr =~ /^Private$/i ) { $flags{private}++ } - elsif ( $attr =~ /^(Regex|Regexp)\((.+)\)$/i ) { $flags{regex} = $2 } + if ( my ($key, $value) = ($attr =~ /^(.*?)(?:\(\s*(.+)\s*\))?$/) ) { + 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"/ ) 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 ($prefix) { + for my $part ( split '/', $prefix ) { $visitor->setSearchPath($part); $parent->accept($visitor); - $child = $visitor->getResult; + 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; + } + + $parent = $child; } - $parent = $child; - } - my $uid = $parent->getUID; - $c->actions->{private}->{$uid}->{$method} = [ $namespace, $code ]; - my $forward = $prefix ? "$prefix/$method" : $method; - - if ( $flags{path} ) { - $flags{path} =~ s/^\w+//; - $flags{path} =~ s/\w+$//; - if ( $flags{path} =~ /^'(.*)'$/ ) { $flags{path} = $1 } - if ( $flags{path} =~ /^"(.*)"$/ ) { $flags{path} = $1 } - } - if ( $flags{regex} ) { - $flags{regex} =~ s/^\w+//; - $flags{regex} =~ s/\w+$//; - if ( $flags{regex} =~ /^'(.*)'$/ ) { $flags{regex} = $1 } - if ( $flags{regex} =~ /^"(.*)"$/ ) { $flags{regex} = $1 } } my $reverse = $prefix ? "$prefix/$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, + prefix => $prefix, + attributes => \%attributes, } - $absolute = 1 if $flags{global}; - my $name = $absolute ? $path : $prefix ? "$prefix/$path" : $path; - $c->actions->{plain}->{$name} = [ $namespace, $code ]; - } - if ( my $regex = $flags{regex} ) { - push @{ $c->actions->{compiled} }, [ $regex, qr#$regex# ]; - $c->actions->{regex}->{$regex} = [ $namespace, $code ]; - } + ); - $c->actions->{reverse}->{"$code"} = $reverse; -} + # Set the method value + $parent->getNodeValue->actions->{$method} = $action; -=item $class->setup_actions($component) + foreach my $type ( @{ $self->dispatch_types } ) { + $type->register_action($c, $action); + } +} -Setup actions for a component. +=item $self->setup_actions( $class, $component ) =cut sub setup_actions { - my ( $self, $comps ) = @_; - for my $comp (@$comps) { - $comp = ref $comp || $comp; - for my $action ( @{ $comp->_cache } ) { + my ( $self, $class ) = @_; + + # These are the core structures + $self->actions( + { + plain => {}, + private => {}, + regex => {}, + compiled => [] + } + ); + + $self->dispatch_types([ + map { "Catalyst::DispatchType::$_"->new } + qw/Path Regex Default/ ]); + + # We use a tree + my $container = Catalyst::ActionContainer->new( + { part => '/', actions => {} } ); + $self->tree( Tree::Simple->new( $container, Tree::Simple->ROOT ) ); + + for my $comp ( keys %{ $class->components } ) { + + # We only setup components that inherit from Catalyst::Base + next unless $comp->isa('Catalyst::Base'); + + for my $action ( @{ Catalyst::Utils::reflect_actions($comp) } ) { my ( $code, $attrs ) = @{$action}; my $name = ''; no strict 'refs'; my @cache = ( $comp, @{"$comp\::ISA"} ); my %namespaces; + while ( my $namespace = shift @cache ) { $namespaces{$namespace}++; for my $isa ( @{"$comp\::ISA"} ) { @@ -323,78 +422,77 @@ sub setup_actions { $namespaces{$isa}++; } } + for my $namespace ( keys %namespaces ) { + for my $sym ( values %{ $namespace . '::' } ) { + if ( *{$sym}{CODE} && *{$sym}{CODE} == $code ) { + $name = *{$sym}{NAME}; - $self->set_action( $name, $code, $comp, $attrs ); + $class->set_action( $name, $code, $comp, $attrs ); last; } + } + } + } + } + + return unless $class->debug; + my $actions = $self->actions; my $privates = Text::ASCIITable->new; $privates->setCols( 'Private', 'Class' ); $privates->setColWidth( 'Private', 36, 1 ); $privates->setColWidth( 'Class', 37, 1 ); + my $walker = sub { 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( wrap( "$prefix$action", 36 ), - wrap( $class, 37 ) ); + my $node = $parent->getNodeValue->actions; + + for my $action ( keys %{ $node } ) { + my $action_obj = $node->{$action}; + $privates->addRow( "$prefix$action", $action_obj->namespace ); } + $walker->( $walker, $_, $prefix ) for $parent->getAllChildren; }; + $walker->( $walker, $self->tree, '' ); - $self->log->debug( 'Loaded private actions', $privates->draw ) - if ( @{ $privates->{tbl_rows} } && $self->debug ); + $class->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( wrap( "/$plain", 36 ), wrap( $reverse, 37 ) ); + my $action = $actions->{plain}->{$plain}; + $publics->addRow( "/$plain", "/$action" ); } - $self->log->debug( 'Loaded public actions', $publics->draw ) - if ( @{ $publics->{tbl_rows} } && $self->debug ); + + $class->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( wrap( $regex, 36 ), wrap( $reverse, 37 ) ); + my $action = $actions->{regex}->{$regex}; + $regexes->addRow( $regex, "/$action" ); } - $self->log->debug( 'Loaded regex actions', $regexes->draw ) - if ( @{ $regexes->{tbl_rows} } && $self->debug ); -} -sub _prefix { - my ( $class, $name ) = @_; - my $prefix = _class2prefix($class); - $name = "$prefix/$name" if $prefix; - return $name; -} - -sub _class2prefix { - my $class = shift || ''; - my $prefix; - if ( $class =~ /^.*::([MVC]|Model|View|Controller)?::(.*)$/ ) { - $prefix = lc $2; - $prefix =~ s/\:\:/\//g; - } - return $prefix; + $class->log->debug( "Loaded regex actions:\n" . $regexes->draw ) + if ( @{ $regexes->{tbl_rows} } ); } =back