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=acf0f3a4be00107193bb730094f16ed517c40602;hp=81603d5701ab35b255c79594cd70c6955e0bb40c;hb=0ca510f0aa1cabe138d81897d38111d7b772449c;hpb=11bd4e3eaa29685c44318041381621e79c4a5f44 diff --git a/lib/Catalyst/DispatchType/Path.pm b/lib/Catalyst/DispatchType/Path.pm index 81603d5..acf0f3a 100644 --- a/lib/Catalyst/DispatchType/Path.pm +++ b/lib/Catalyst/DispatchType/Path.pm @@ -1,8 +1,21 @@ package Catalyst::DispatchType::Path; -use strict; -use base qw/Catalyst::DispatchType/; -use Text::ASCIITable; +use Moose; +extends 'Catalyst::DispatchType'; + +use Text::SimpleTable; +use Catalyst::Utils; +use URI; +use Encode 2.21 'decode_utf8'; + +has _paths => ( + is => 'rw', + isa => 'HashRef', + required => 1, + default => sub { +{} }, + ); + +no Moose; =head1 NAME @@ -10,40 +23,70 @@ Catalyst::DispatchType::Path - Path DispatchType =head1 SYNOPSIS -See L. +See L. =head1 DESCRIPTION -=head1 METHODS +Dispatch type managing full path matching behaviour. For more information on +dispatch types, see: =over 4 -=item $self->list($c) +=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 $paths = Text::ASCIITable->new; - $paths->setCols( 'Path', 'Private' ); - $paths->setColWidth( 'Path', 36, 1 ); - $paths->setColWidth( 'Private', 37, 1 ); - for my $path ( sort keys %{ $self->{paths} } ) { - my $action = $self->{paths}->{$path}; - $paths->addRow( "/$path", "/$action" ); + my $avail_width = Catalyst::Utils::term_width() - 9; + my $col1_width = ($avail_width * .50) < 35 ? 35 : int($avail_width * .50); + my $col2_width = $avail_width - $col1_width; + my $paths = Text::SimpleTable->new( + [ $col1_width, 'Path' ], [ $col2_width, 'Private' ] + ); + foreach my $path ( sort keys %{ $self->_paths } ) { + foreach my $action ( @{ $self->_paths->{$path} } ) { + my $args = $action->attributes->{Args}->[0]; + my $parts = defined($args) ? '/*' x $args : '/...'; + + my $display_path = "/$path/$parts"; + $display_path =~ s{/{1,}}{/}g; + $display_path =~ s/%([0-9A-Fa-f]{2})/chr(hex($1))/eg; # deconvert urlencoded for pretty view + $display_path = decode_utf8 $display_path; # URI does encoding + $paths->row( $display_path, "/$action" ); + } } - $c->log->debug( "Loaded Path actions:\n" . $paths->draw ) - if ( @{ $paths->{tbl_rows} } ); + $c->log->debug( "Loaded Path actions:\n" . $paths->draw . "\n" ) + if ( keys %{ $self->_paths } ); } -=item $self->match( $c, $path ) +=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 ) = @_; - if ( my $action = $self->{paths}->{$path} ) { + $path = '/' if !defined $path || !length $path; + + my @actions = @{ $self->_paths->{$path} || [] }; + + foreach my $action ( @actions ) { + next unless $action->match($c); $c->req->action($path); $c->req->match($path); $c->action($action); @@ -54,51 +97,77 @@ sub match { return 0; } -=item $self->register( $c, $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; + my @register = @{ $action->attributes->{Path} || [] }; - foreach my $r ( @{ $attrs->{Path} || [] } ) { - unless ( $r =~ m!^/! ) { # It's a relative path - $r = $action->namespace . "/$r"; - } - push( @register, $r ); - } + $self->register_path( $c, $_, $action ) for @register; - if ( $attrs->{Global} || $attrs->{Absolute} ) { - push( @register, $action->name ); # Register sub name against root - } + return 1 if @register; + return 0; +} - if ( $attrs->{Local} || $attrs->{Relative} ) { - push( @register, join( '/', $action->namespace, $action->name ) ); +=head2 $self->register_path($c, $path, $action) - # Register sub name as a relative path - } +Registers an action at a given path. - foreach my $r (@register) { - $r =~ s!^/!!; - $self->{paths}{$r} = $action; - } +=cut + +sub register_path { + my ( $self, $c, $path, $action ) = @_; + $path =~ s!^/!!; + $path = '/' unless length $path; + $path = URI->new($path)->canonical; + $path =~ s{(?<=[^/])/+\z}{}; + + $self->_paths->{$path} = [ + sort { $a->compare($b) } ($action, @{ $self->_paths->{$path} || [] }) + ]; + + return 1; } -=back +=head2 $self->uri_for_action($action, $captures) -=head1 AUTHOR +get a URI part for an action; always returns undef is $captures is set +since Path actions don't have captures -Matt S Trout -Sebastian Riedel, C +=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 program is free software, you can redistribute it and/or modify it under +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;