X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=catagits%2FCatalyst-Runtime.git;a=blobdiff_plain;f=lib%2FCatalyst%2FDispatchType%2FRegex.pm;h=0d6da04b2f05bef060b5c84ae47a0b4cd19618cd;hp=a1224c594212cc4f65701bcf84de698af6c15381;hb=48d435ba6a0925260fd58c8c18ff425e99708eae;hpb=11bd4e3eaa29685c44318041381621e79c4a5f44 diff --git a/lib/Catalyst/DispatchType/Regex.pm b/lib/Catalyst/DispatchType/Regex.pm index a1224c5..0d6da04 100644 --- a/lib/Catalyst/DispatchType/Regex.pm +++ b/lib/Catalyst/DispatchType/Regex.pm @@ -1,8 +1,20 @@ package Catalyst::DispatchType::Regex; -use strict; -use base qw/Catalyst::DispatchType::Path/; -use Text::ASCIITable; +use Moose; +extends 'Catalyst::DispatchType::Path'; + +use Text::SimpleTable; +use Catalyst::Utils; +use Text::Balanced (); + +has _compiled => ( + is => 'rw', + isa => 'ArrayRef', + required => 1, + default => sub{ [] }, + ); + +no Moose; =head1 NAME @@ -10,34 +22,51 @@ Catalyst::DispatchType::Regex - Regex DispatchType =head1 SYNOPSIS -See L. +See L. =head1 DESCRIPTION -=head1 METHODS +Dispatch type managing path-matching behaviour using regexes. 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) + +Output a table of all regex actions, and their private equivalent. =cut sub list { my ( $self, $c ) = @_; - my $re = Text::ASCIITable->new; - $re->setCols( 'Regex', 'Private' ); - $re->setColWidth( 'Regex', 36, 1 ); - $re->setColWidth( 'Private', 37, 1 ); - for my $regex ( @{ $self->{compiled} } ) { - my $compiled = $regex->{re}; - my $action = $regex->{action}; - $re->addRow( $compiled, "/$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 $re = Text::SimpleTable->new( + [ $col1_width, 'Regex' ], [ $col2_width, 'Private' ] + ); + for my $regex ( @{ $self->_compiled } ) { + my $action = $regex->{action}; + $re->row( $regex->{path}, "/$action" ); } - $c->log->debug( "Loaded Regex actions:\n" . $re->draw ) - if ( @{ $re->{tbl_rows} } ); + $c->log->debug( "Loaded Regex actions:\n" . $re->draw . "\n" ) + if ( @{ $self->_compiled } ); } -=item $self->match( $c, $path ) +=head2 $self->match( $c, $path ) + +Checks path against every compiled regex, and offers the action for any regex +which matches a chance to match the request. If it succeeds, sets action, +match and captures on $c->req and returns 1. If not, returns 0 without +altering $c. =cut @@ -48,11 +77,12 @@ sub match { # Check path against plain text first - foreach my $compiled ( @{ $self->{compiled} || [] } ) { - if ( my @snippets = ( $path =~ $compiled->{re} ) ) { + foreach my $compiled ( @{ $self->_compiled } ) { + if ( my @captures = ( $path =~ $compiled->{re} ) ) { + next unless $compiled->{action}->match($c); $c->req->action( $compiled->{path} ); $c->req->match($path); - $c->req->snippets( \@snippets ); + $c->req->captures( \@captures ); $c->action( $compiled->{action} ); $c->namespace( $compiled->{action}->namespace ); return 1; @@ -62,39 +92,93 @@ sub match { return 0; } -=item $self->register( $c, $action ) +=head2 $self->register( $c, $action ) + +Registers one or more regex actions for an action object. +Also registers them as literal paths. + +Returns 1 if any regexps were registered. =cut sub register { my ( $self, $c, $action ) = @_; - my $attrs = $action->attributes; - my @register = map { @{ $_ || [] } } @{$attrs}{ 'Regex', 'Regexp' }; + my $attrs = $action->attributes; + my @register = @{ $attrs->{'Regex'} || [] }; + foreach my $r (@register) { - $self->{paths}{$r} = $action; # Register path for superclass - push( - @{ $self->{compiled} }, # and compiled regex for us - { - re => qr#$r#, - action => $action, - path => $r, - } - ); + $self->register_path( $c, $r, $action ); + $self->register_regex( $c, $r, $action ); } + + return 1 if @register; + return 0; } -=back +=head2 $self->register_regex($c, $re, $action) -=head1 AUTHOR +Register an individual regex on the action. Usually called from the +register method. -Matt S Trout -Sebastian Riedel, C +=cut + +sub register_regex { + my ( $self, $c, $re, $action ) = @_; + push( + @{ $self->_compiled }, # and compiled regex for us + { + re => qr#$re#, + action => $action, + path => $re, + } + ); +} + +=head2 $self->uri_for_action($action, $captures) + +returns a URI for this action if it can find a regex attributes that contains +the correct number of () captures. Note that this may function incorrectly +in the case of nested captures - if your regex does (...(..))..(..) you'll +need to pass the first and third captures only. + +=cut + +sub uri_for_action { + my ( $self, $action, $captures ) = @_; + + if (my $regexes = $action->attributes->{Regex}) { + REGEX: foreach my $orig (@$regexes) { + my $re = "$orig"; + $re =~ s/^\^//; + $re =~ s/\$$//; + my $final = '/'; + my @captures = @$captures; + while (my ($front, $rest) = split(/\(/, $re, 2)) { + last unless defined $rest; + ($rest, $re) = + Text::Balanced::extract_bracketed("(${rest}", '('); + next REGEX unless @captures; + $final .= $front.shift(@captures); + } + $final .= $re; + next REGEX if @captures; + return $final; + } + } + 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;