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=d038d9efd3d1b9a4938c999a4602804052f3a329;hp=355039282a93ac279f7f7b4a3e8cfb5b0f3a5406;hb=28928de92c8bfea34d7e995bc92f1bf5632242d6;hpb=812a28c90c5b43bdf5ce87f1b2a688725e552429 diff --git a/lib/Catalyst/Dispatcher.pm b/lib/Catalyst/Dispatcher.pm index 3550392..d038d9e 100644 --- a/lib/Catalyst/Dispatcher.pm +++ b/lib/Catalyst/Dispatcher.pm @@ -1,21 +1,33 @@ package Catalyst::Dispatcher; use strict; -use base 'Class::Data::Inheritable'; +use base 'Class::Accessor::Fast'; +use Catalyst::Exception; use Catalyst::Utils; -use Text::ASCIITable; +use Catalyst::Action; +use Catalyst::ActionContainer; +use Catalyst::DispatchType::Default; +use Catalyst::DispatchType::Index; +use Text::SimpleTable; 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; -# These are the core structures -__PACKAGE__->actions( - { plain => {}, private => {}, regex => {}, compiled => [], reverse => {} } +__PACKAGE__->mk_accessors( + qw/tree dispatch_types registered_dispatch_types + method_action_class action_container_class + preload_dispatch_types postload_dispatch_types + action_hash container_hash + / ); -# We use a tree -__PACKAGE__->tree( Tree::Simple->new( 0, Tree::Simple->ROOT ) ); +# Preload these action types +our @PRELOAD = qw/Index Path Regex/; + +# Postload these action types +our @POSTLOAD = qw/Default/; =head1 NAME @@ -27,65 +39,81 @@ See L. =head1 DESCRIPTION -=head1 METHODS +This is the class that maps public urls to actions in your Catalyst +application based on the attributes you set. -=over 4 +=head1 METHODS -=item $c->dispatch +=head2 new -Dispatch request to actions. +Construct a new dispatcher. =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] ); - } - } +sub new { + my $self = shift; + my $class = ref($self) || $self; - my $default = $action eq 'default' ? $namespace : undef; - my $results = $c->get_action( $action, $default ); - $namespace ||= '/'; + my $obj = $class->SUPER::new(@_); - if ( @{$results} ) { + # set the default pre- and and postloads + $obj->preload_dispatch_types( \@PRELOAD ); + $obj->postload_dispatch_types( \@POSTLOAD ); + $obj->action_hash( {} ); + $obj->container_hash( {} ); - # Execute last begin - $c->state(1); - if ( my $begin = @{ $c->get_action( 'begin', $namespace ) }[-1] ) { - $c->execute( @{ $begin->[0] } ); - return if scalar @{ $c->error }; - } + # Create the root node of the tree + my $container = + Catalyst::ActionContainer->new( { part => '/', actions => {} } ); + $obj->tree( Tree::Simple->new( $container, Tree::Simple->ROOT ) ); - # Execute the auto chain - my $auto = 0; - for my $auto ( @{ $c->get_action( 'auto', $namespace ) } ) { - $c->execute( @{ $auto->[0] } ); - return if scalar @{ $c->error }; - last unless $c->state; - $auto++; - } + return $obj; +} - # 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] } ); - } - } +=head2 $self->preload_dispatch_types - # Execute last end - if ( my $end = @{ $c->get_action( 'end', $namespace ) }[-1] ) { - $c->execute( @{ $end->[0] } ); - return if scalar @{ $c->error }; - } +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 + +=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 + +sub detach { + my ( $self, $c, $command, @args ) = @_; + $c->forward( $command, @args ) if $command; + die $Catalyst::DETACH; +} + +=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' ) ); } else { @@ -98,360 +126,375 @@ 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(). +=head2 $self->forward( $c, $command [, \@arguments ] ) - $c->forward('/foo'); - $c->forward('index'); - $c->forward(qw/MyApp::Model::CDBI::Foo do_stuff/); - $c->forward('MyApp::View::TT'); +Documented in L =cut sub forward { - my $c = shift; - my $command = shift; + my ( $self, $c, $command ) = splice( @_, 0, 3 ); unless ($command) { $c->log->debug('Nothing to forward to') if $c->debug; return 0; } - my $caller = caller(0); - my $namespace = '/'; + my $args = [ @{ $c->request->arguments } ]; - if ( $command =~ /^\// ) { - $command =~ /^\/(.*)\/(\w+)$/; - $namespace = $1 || '/'; - $command = $2 || $command; - $command =~ s/^\///; + @$args = @{ pop @_ } if ( ref( $_[-1] ) eq 'ARRAY' ); + + my $action = $self->_invoke_as_path( $c, $command, $args ) + || $self->_invoke_as_component( $c, $command, shift ); + + unless ($action) { + my $error = + qq/Couldn't forward to command "$command": / + . qq/Invalid action or component./; + $c->error($error); + $c->log->debug($error) if $c->debug; + return 0; } - else { $namespace = Catalyst::Utils::class2prefix($caller) || '/' } + #push @$args, @_; - my $results = $c->get_action( $command, $namespace ); + local $c->request->{arguments} = $args; + $action->execute($c); - unless ( @{$results} ) { - my $class = $command || ''; - my $path = $class . '.pm'; - $path =~ s/::/\//g; + return $c->state; +} - unless ( $INC{$path} ) { - my $error = - qq/Couldn't forward to "$class". Invalid or not loaded./; - $c->error($error); - $c->log->debug($error) if $c->debug; - return 0; - } +sub _action_rel2abs { + my ( $self, $c, $path ) = @_; - unless ( UNIVERSAL::isa( $class, 'Catalyst::Base' ) ) { - my $error = - qq/Can't forward to "$class". Class is not a Catalyst component./; - $c->error($error); - $c->log->debug($error) if $c->debug; - return 0; - } + unless ( $path =~ m#^/# ) { + my $namespace = $c->stack->[-1]->namespace; + $path = "$namespace/$path"; + } + + $path =~ s#^/##; + return $path; +} - my $method = shift || 'process'; +sub _invoke_as_path { + my ( $self, $c, $rel_path, $args ) = @_; - if ( my $code = $class->can($method) ) { - $c->actions->{reverse}->{"$code"} = "$class->$method"; - $results = [ [ [ $class, $code ] ] ]; - } + return if ref $rel_path; # it must be a string + my $path = $self->_action_rel2abs( $c, $rel_path ); + + my ( $tail, @extra_args ); + while ( ( $path, $tail ) = ( $path =~ m#^(?:(.*)/)?(\w+)?$# ) ) + { # allow $path to be empty + if ( my $action = $c->get_action( $tail, $path ) ) { + push @$args, @extra_args; + return $action; + } else { - my $error = - qq/Couldn't forward to "$class". Does not implement "$method"/; - $c->error($error); - $c->log->debug($error) - if $c->debug; - return 0; + return + unless $path + ; # if a match on the global namespace failed then the whole lookup failed } + unshift @extra_args, $tail; } +} + +sub _find_component_class { + my ( $self, $c, $component ) = @_; - for my $result ( @{$results} ) { - $c->execute( @{ $result->[0] } ); - return if scalar @{ $c->error }; - last unless $c->state; + return ref($component) + || ref( $c->component($component) ) + || $c->component($component); +} + +sub _invoke_as_component { + my ( $self, $c, $component, $method ) = @_; + + my $class = $self->_find_component_class( $c, $component ) || return 0; + $method ||= "process"; + + if ( my $code = $class->can($method) ) { + return $self->method_action_class->new( + { + name => $method, + code => $code, + reverse => "$class->$method", + class => $class, + namespace => Catalyst::Utils::class2prefix( + $class, $c->config->{case_sensitive} + ), + } + ); + } + else { + my $error = + qq/Couldn't forward to "$class". Does not implement "$method"/; + $c->error($error); + $c->log->debug($error) + if $c->debug; + return 0; } +} - return $c->state; +=head2 $self->prepare_action($c) + +Find an dispatch type that matches $c->req->path, and set args from it. + +=cut + +sub prepare_action { + my ( $self, $c ) = @_; + my $path = $c->req->path; + my @path = split /\//, $c->req->path; + $c->req->args( \my @args ); + + unshift( @path, '' ); # Root action + + DESCEND: while (@path) { + $path = join '/', @path; + $path =~ s#^/##; + + $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 ); + } + + # If not, move the last part path to args + 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 $c->get_action( $action, $namespace ) +=head2 $self->get_action( $action, $namespace ) -Get an action in a given namespace. +returns a named action from a given namespace. =cut sub get_action { - my ( $c, $action, $namespace ) = @_; - return [] unless $action; - $namespace ||= ''; + my ( $self, $name, $namespace ) = @_; + return unless $name; - if ($namespace) { - $namespace = '' if $namespace eq '/'; - my $parent = $c->tree; - 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; - } + $namespace = join( "/", grep { length } split '/', $namespace || "" ); - } + return $self->action_hash->{"$namespace/$name"}; +} - else { +=head2 $self->get_action_by_path( $path ); - 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; - } +returns the named action by it's full path. - else { - my $result = - $c->actions->{private}->{ $parent->getUID }->{$action}; - push @results, [$result] if $result; - } +=cut - } - return \@results; - } +sub get_action_by_path { + my ( $self, $path ) = @_; + $path = "/$path" unless $path =~ /\//; + $self->action_hash->{$path}; +} - elsif ( my $p = $c->actions->{plain}->{$action} ) { return [ [$p] ] } - elsif ( my $r = $c->actions->{regex}->{$action} ) { return [ [$r] ] } +=head2 $self->get_actions( $c, $action, $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_actions { + my ( $self, $c, $action, $namespace ) = @_; + return [] unless $action; - if ( my @snippets = ( $action =~ $regex ) ) { - return [ [ $c->actions->{regex}->{$name}, $name, \@snippets ] ]; - } + $namespace = join( "/", grep { length } split '/', $namespace || "" ); - } - } - return []; + my @match = $self->get_containers($namespace); + + return map { $_->get_action($action) } @match; } -=item $c->set_action( $action, $code, $namespace, $attrs ) +=head2 $self->get_containers( $namespace ) -Set an action in a given namespace. +Return all the action containers for a given namespace, inclusive =cut -sub set_action { - my ( $c, $method, $code, $namespace, $attrs ) = @_; +sub get_containers { + my ( $self, $namespace ) = @_; + $namespace ||= ''; + $namespace = '' if $namespace eq '/'; - my $prefix = Catalyst::Utils::class2prefix($namespace) || ''; - my %flags; + my @containers; - 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 } - } + do { + push @containers, $self->container_hash->{$namespace}; + } while ( $namespace =~ s#/[^/]+$## ); - if ( $flags{private} && ( keys %flags > 1 ) ) { - $c->log->debug( 'Bad action definition "' - . join( ' ', @{$attrs} ) - . qq/" for "$namespace->$method"/ ) - if $c->debug; - return; - } - return unless keys %flags; + return reverse grep { defined } @containers, $self->container_hash->{''}; - my $parent = $c->tree; - my $visitor = Tree::Simple::Visitor::FindByPath->new; + my @parts = split '/', $namespace; +} - for my $part ( split '/', $prefix ) { - $visitor->setSearchPath($part); - $parent->accept($visitor); - my $child = $visitor->getResult; +=head2 $self->register( $c, $action ) - unless ($child) { - $child = $parent->addChild( Tree::Simple->new($part) ); - $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 + +sub register { + my ( $self, $c, $action ) = @_; - my $uid = $parent->getUID; - $c->actions->{private}->{$uid}->{$method} = [ $namespace, $code ]; - my $forward = $prefix ? "$prefix/$method" : $method; + my $registered = $self->registered_dispatch_types; - if ( $flags{path} ) { - $flags{path} =~ s/^\w+//; - $flags{path} =~ s/\w+$//; - if ( $flags{path} =~ /^'(.*)'$/ ) { $flags{path} = $1 } - if ( $flags{path} =~ /^"(.*)"$/ ) { $flags{path} = $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; + } } - if ( $flags{regex} ) { - $flags{regex} =~ s/^\w+//; - $flags{regex} =~ s/\w+$//; - if ( $flags{regex} =~ /^'(.*)'$/ ) { $flags{regex} = $1 } - if ( $flags{regex} =~ /^"(.*)"$/ ) { $flags{regex} = $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 ); } - my $reverse = $prefix ? "$prefix/$method" : $method; + return unless $reg + $priv; - if ( $flags{local} || $flags{global} || $flags{path} ) { - my $path = $flags{path} || $method; - my $absolute = 0; + my $namespace = $action->namespace; + my $name = $action->name; - if ( $path =~ /^\/(.+)/ ) { - $path = $1; - $absolute = 1; - } + my $container = $self->find_or_create_action_container($namespace); - $absolute = 1 if $flags{global}; - my $name = $absolute ? $path : $prefix ? "$prefix/$path" : $path; - $c->actions->{plain}->{$name} = [ $namespace, $code ]; - } + # Set the method value + $container->add_action($action); - if ( my $regex = $flags{regex} ) { - push @{ $c->actions->{compiled} }, [ $regex, qr#$regex# ]; - $c->actions->{regex}->{$regex} = [ $namespace, $code ]; - } + $self->action_hash->{"$namespace/$name"} = $action; + $self->container_hash->{$namespace} = $container; +} + +sub find_or_create_action_container { + my ( $self, $namespace ) = @_; - $c->actions->{reverse}->{"$code"} = $reverse; + my $tree ||= $self->tree; + + return $tree->getNodeValue unless $namespace; + + my @namespace = split '/', $namespace; + return $self->_find_or_create_namespace_node( $tree, @namespace ) + ->getNodeValue; } -=item $class->setup_actions($component) +sub _find_or_create_namespace_node { + my ( $self, $parent, $part, @namespace ) = @_; -Setup actions for a component. + return $parent unless $part; -=cut + my $child = + ( grep { $_->getNodeValue->part eq $part } $parent->getAllChildren )[0]; -sub setup_actions { - my ( $self, $comps ) = @_; - - for my $comp (@$comps) { - $comp = ref $comp || $comp; - - 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"} ) { - next if $namespaces{$isa}; - push @cache, $isa; - $namespaces{$isa}++; - } - } + unless ($child) { + my $container = Catalyst::ActionContainer->new($part); + $parent->addChild( $child = Tree::Simple->new($container) ); + } - for my $namespace ( keys %namespaces ) { + $self->_find_or_create_namespace_node( $child, @namespace ); +} - for my $sym ( values %{ $namespace . '::' } ) { +=head2 $self->setup_actions( $class, $context ) - if ( *{$sym}{CODE} && *{$sym}{CODE} == $code ) { - $name = *{$sym}{NAME}; - $self->set_action( $name, $code, $comp, $attrs ); - last; - } +=cut - } +sub setup_actions { + my ( $self, $c ) = @_; - } + $self->dispatch_types( [] ); + $self->registered_dispatch_types( {} ); + $self->method_action_class('Catalyst::Action'); + $self->action_container_class('Catalyst::ActionContainer'); - } + my @classes = + $self->do_load_dispatch_types( @{ $self->preload_dispatch_types } ); + @{ $self->registered_dispatch_types }{@classes} = (1) x @classes; + foreach my $comp ( values %{ $c->components } ) { + $comp->register_actions($c) if $comp->can('register_actions'); } - my $actions = $self->actions; - my $privates = Text::ASCIITable->new; - $privates->setCols( 'Private', 'Class' ); - $privates->setColWidth( 'Private', 36, 1 ); - $privates->setColWidth( 'Class', 37, 1 ); + $self->do_load_dispatch_types( @{ $self->postload_dispatch_types } ); + + return unless $c->debug; + 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 || ''; $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->row( "$prefix$action", $action_obj->class, $action ); + $has_private = 1; } $walker->( $walker, $_, $prefix ) for $parent->getAllChildren; }; $walker->( $walker, $self->tree, '' ); - $self->log->debug( 'Loaded private actions', $privates->draw ) - if ( @{ $privates->{tbl_rows} } && $self->debug ); - - 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 ); - } + $c->log->debug( "Loaded Private actions:\n" . $privates->draw ) + if ($has_private); - $self->log->debug( 'Loaded public actions', $publics->draw ) - if ( @{ $publics->{tbl_rows} } && $self->debug ); + # List all public actions + $_->list($c) for @{ $self->dispatch_types }; +} - my $regexes = Text::ASCIITable->new; - $regexes->setCols( 'Regex', 'Private' ); - $regexes->setColWidth( 'Regex', 36, 1 ); - $regexes->setColWidth( 'Private', 37, 1 ); +sub do_load_dispatch_types { + my ( $self, @types ) = @_; - 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 ); + 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; } - $self->log->debug( 'Loaded regex actions', $regexes->draw ) - if ( @{ $regexes->{tbl_rows} } && $self->debug ); + return @loaded; } -=back - =head1 AUTHOR Sebastian Riedel, C +Matt S Trout, C =head1 COPYRIGHT