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 $avail_width = Catalyst::Utils::term_width() - 9;
51 my $col1_width = ($avail_width * .50) < 35 ? 35 : int($avail_width * .50);
52 my $col2_width = $avail_width - $col1_width;
53 my $re = Text::SimpleTable->new(
54 [ $col1_width, 'Regex' ], [ $col2_width, 'Private' ]
56 for my $regex ( @{ $self->_compiled } ) {
57 my $action = $regex->{action};
58 $re->row( $regex->{path}, "/$action" );
60 $c->log->debug( "Loaded Regex actions:\n" . $re->draw . "\n" )
61 if ( @{ $self->_compiled } );
64 =head2 $self->match( $c, $path )
66 Checks path against every compiled regex, and offers the action for any regex
67 which matches a chance to match the request. If it succeeds, sets action,
68 match and captures on $c->req and returns 1. If not, returns 0 without
74 my ( $self, $c, $path ) = @_;
76 return if $self->SUPER::match( $c, $path );
78 # Check path against plain text first
80 foreach my $compiled ( @{ $self->_compiled } ) {
81 if ( my @captures = ( $path =~ $compiled->{re} ) ) {
82 next unless $compiled->{action}->match($c);
83 $c->req->action( $compiled->{path} );
84 $c->req->match($path);
85 $c->req->captures( \@captures );
86 $c->action( $compiled->{action} );
87 $c->namespace( $compiled->{action}->namespace );
95 =head2 $self->register( $c, $action )
97 Registers one or more regex actions for an action object.
98 Also registers them as literal paths.
100 Returns 1 if any regexps were registered.
105 my ( $self, $c, $action ) = @_;
106 my $attrs = $action->attributes;
107 my @register = @{ $attrs->{'Regex'} || [] };
109 foreach my $r (@register) {
110 $self->register_path( $c, $r, $action );
111 $self->register_regex( $c, $r, $action );
114 return 1 if @register;
118 =head2 $self->register_regex($c, $re, $action)
120 Register an individual regex on the action. Usually called from the
126 my ( $self, $c, $re, $action ) = @_;
128 @{ $self->_compiled }, # and compiled regex for us
137 =head2 $self->uri_for_action($action, $captures)
139 returns a URI for this action if it can find a regex attributes that contains
140 the correct number of () captures. Note that this may function incorrectly
141 in the case of nested captures - if your regex does (...(..))..(..) you'll
142 need to pass the first and third captures only.
147 my ( $self, $action, $captures ) = @_;
149 if (my $regexes = $action->attributes->{Regex}) {
150 REGEX: foreach my $orig (@$regexes) {
154 $re =~ s/\\([^\\])/$1/g;
156 my @captures = @$captures;
157 while (my ($front, $rest) = split(/\(/, $re, 2)) {
158 last unless defined $rest;
160 Text::Balanced::extract_bracketed("(${rest}", '(');
161 next REGEX unless @captures;
162 $final .= $front.shift(@captures);
165 next REGEX if @captures;
174 Catalyst Contributors, see Catalyst.pm
178 This library is free software. You can redistribute it and/or modify it under
179 the same terms as Perl itself.
183 __PACKAGE__->meta->make_immutable;