X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=catagits%2FCatalyst-Runtime.git;a=blobdiff_plain;f=lib%2FCatalyst%2FDispatchType%2FPath.pm;h=50fbf84a9e0dcaa31b8e1979ae6ea1c6772ab0d9;hp=f51387c3002a81caf35c8e56e421038100c49c6e;hb=05b47f2e6357bc7f1622e6b2cf730ad5bbeb993f;hpb=6b23994966a2a66b90986a51e7e1d71f62d90f44 diff --git a/lib/Catalyst/DispatchType/Path.pm b/lib/Catalyst/DispatchType/Path.pm index f51387c..50fbf84 100644 --- a/lib/Catalyst/DispatchType/Path.pm +++ b/lib/Catalyst/DispatchType/Path.pm @@ -1,45 +1,161 @@ package Catalyst::DispatchType::Path; -use strict; -use base qw/Catalyst::DispatchType/; +use Moose; +extends 'Catalyst::DispatchType'; -sub prepare_action { - my ($self, $c, $path) = @_; +use Text::SimpleTable; +use Catalyst::Utils; +use URI; - if ( my $action = $self->{paths}->{$path} ) { +has _paths => ( + is => 'rw', + isa => 'HashRef', + required => 1, + default => sub { +{} }, + ); + +no Moose; + +=head1 NAME + +Catalyst::DispatchType::Path - Path DispatchType + +=head1 SYNOPSIS + +See L. + +=head1 DESCRIPTION + +Dispatch type managing full path matching behaviour. For more information on +dispatch types, see: + +=over 4 + +=item * L for how they affect application authors + +=item * L for implementation information. + +=back + +=head1 METHODS + +=head2 $self->list($c) + +Debug output for Path dispatch points + +=cut + +sub list { + my ( $self, $c ) = @_; + my $column_width = Catalyst::Utils::term_width() - 35 - 9; + my $paths = Text::SimpleTable->new( + [ 35, 'Path' ], [ $column_width, 'Private' ] + ); + foreach my $path ( sort keys %{ $self->_paths } ) { + my $display_path = $path eq '/' ? $path : "/$path"; + foreach my $action ( @{ $self->_paths->{$path} } ) { + $paths->row( $display_path, "/$action" ); + } + } + $c->log->debug( "Loaded Path actions:\n" . $paths->draw . "\n" ) + if ( keys %{ $self->_paths } ); +} + +=head2 $self->match( $c, $path ) + +For each action registered to this exact path, offers the action a chance to +match the path (in the order in which they were registered). Succeeds on the +first action that matches, if any; if not, returns 0. + +=cut + +sub match { + my ( $self, $c, $path ) = @_; + + $path = '/' if !defined $path || !length $path; + + foreach my $action ( @{ $self->_paths->{$path} || [] } ) { + next unless $action->match($c); $c->req->action($path); $c->req->match($path); $c->action($action); - $c->namespace($action->prefix); + $c->namespace( $action->namespace ); return 1; } return 0; } -sub register_action { +=head2 $self->register( $c, $action ) + +Calls register_path for every Path attribute for the given $action. + +=cut + +sub register { my ( $self, $c, $action ) = @_; - my $attrs = $action->attributes; - my @register; - foreach my $r (@{$attrs->{Path} || []}) { - unless ($r =~ m!^/!) { - $r = $action->prefix."/$r"; - } - push(@register, $r); - } - if ($attrs->{Global} || $attrs->{Absolute}) { - push(@register, $action->name); - } + my @register = @{ $action->attributes->{Path} || [] }; - if ($attrs->{Local} || $attrs->{Relative}) { - push(@register, join('/', $action->prefix, $action->name)); - } + $self->register_path( $c, $_, $action ) for @register; + + return 1 if @register; + return 0; +} + +=head2 $self->register_path($c, $path, $action) + +Registers an action at a given path. + +=cut + +sub register_path { + my ( $self, $c, $path, $action ) = @_; + $path =~ s!^/!!; + $path = '/' unless length $path; + $path = URI->new($path)->canonical; + + unshift( @{ $self->_paths->{$path} ||= [] }, $action); + + $self->_paths->{$path} = [ sort @{ $self->_paths->{$path} } ]; - foreach my $r (@register) { - $r =~ s!^/!!; - $self->{paths}{$r} = $action; + return 1; +} + +=head2 $self->uri_for_action($action, $captures) + +get a URI part for an action; always returns undef is $captures is set +since Path actions don't have captures + +=cut + +sub uri_for_action { + my ( $self, $action, $captures ) = @_; + + return undef if @$captures; + + if (my $paths = $action->attributes->{Path}) { + my $path = $paths->[0]; + $path = '/' unless length($path); + $path = "/${path}" unless ($path =~ m/^\//); + $path = URI->new($path)->canonical; + return $path; + } else { + return undef; } } +=head1 AUTHORS + +Catalyst Contributors, see Catalyst.pm + +=head1 COPYRIGHT + +This library is free software. You can redistribute it and/or modify it under +the same terms as Perl itself. + +=cut + +__PACKAGE__->meta->make_immutable; + 1;