1 package Catalyst::DispatchType::Regex;
4 extends 'Catalyst::DispatchType::Path';
21 Catalyst::DispatchType::Regex - Regex DispatchType
25 See L<Catalyst::DispatchType>.
29 Dispatch type managing path-matching behaviour using regexes. For
30 more information on dispatch types, see:
34 =item * L<Catalyst::Manual::Intro> for how they affect application authors
36 =item * L<Catalyst::DispatchType> for implementation information.
42 =head2 $self->list($c)
44 Output a table of all regex actions, and their private equivalent.
49 my ( $self, $c ) = @_;
50 my $column_width = Catalyst::Utils::term_width() - 35 - 9;
51 my $re = Text::SimpleTable->new( [ 35, 'Regex' ], [ $column_width, 'Private' ] );
52 for my $regex ( @{ $self->_compiled } ) {
53 my $action = $regex->{action};
54 $re->row( $regex->{path}, "/$action" );
56 $c->log->debug( "Loaded Regex actions:\n" . $re->draw . "\n" )
57 if ( @{ $self->_compiled } );
60 =head2 $self->match( $c, $path )
62 Checks path against every compiled regex, and offers the action for any regex
63 which matches a chance to match the request. If it succeeds, sets action,
64 match and captures on $c->req and returns 1. If not, returns 0 without
70 my ( $self, $c, $path ) = @_;
72 return if $self->SUPER::match( $c, $path );
74 # Check path against plain text first
76 foreach my $compiled ( @{ $self->_compiled } ) {
77 if ( my @captures = ( $path =~ $compiled->{re} ) ) {
78 next unless $compiled->{action}->match($c);
79 $c->req->action( $compiled->{path} );
80 $c->req->match($path);
81 $c->req->captures( \@captures );
82 $c->action( $compiled->{action} );
83 $c->namespace( $compiled->{action}->namespace );
91 =head2 $self->register( $c, $action )
93 Registers one or more regex actions for an action object.
94 Also registers them as literal paths.
96 Returns 1 if any regexps were registered.
101 my ( $self, $c, $action ) = @_;
102 my $attrs = $action->attributes;
103 my @register = @{ $attrs->{'Regex'} || [] };
105 foreach my $r (@register) {
106 $self->register_path( $c, $r, $action );
107 $self->register_regex( $c, $r, $action );
110 return 1 if @register;
114 =head2 $self->register_regex($c, $re, $action)
116 Register an individual regex on the action. Usually called from the
122 my ( $self, $c, $re, $action ) = @_;
124 @{ $self->_compiled }, # and compiled regex for us
133 =head2 $self->uri_for_action($action, $captures)
135 returns a URI for this action if it can find a regex attributes that contains
136 the correct number of () captures. Note that this may function incorrectly
137 in the case of nested captures - if your regex does (...(..))..(..) you'll
138 need to pass the first and third captures only.
143 my ( $self, $action, $captures ) = @_;
145 if (my $regexes = $action->attributes->{Regex}) {
146 REGEX: foreach my $orig (@$regexes) {
151 my @captures = map { s/([^A-Za-z0-9\-_.!~*'()])/$URI::Escape::escapes{$1}/go; $_; } @$captures;
152 while (my ($front, $rest) = split(/\(/, $re, 2)) {
153 last unless defined $rest;
155 Text::Balanced::extract_bracketed("(${rest}", '(');
156 next REGEX unless @captures;
157 $final .= $front.shift(@captures);
160 next REGEX if @captures;
169 Catalyst Contributors, see Catalyst.pm
173 This library is free software. You can redistribute it and/or modify it under
174 the same terms as Perl itself.
178 __PACKAGE__->meta->make_immutable;