/usr/share/perl5/Mojolicious/Routes/Pattern.pm is in libmojolicious-perl 5.54+dfsg-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 | package Mojolicious::Routes::Pattern;
use Mojo::Base -base;
has [qw(constraints defaults)] => sub { {} };
has [qw(format_regex pattern regex)];
has placeholder_start => ':';
has [qw(placeholders tree)] => sub { [] };
has quote_end => ')';
has quote_start => '(';
has relaxed_start => '#';
has wildcard_start => '*';
sub match {
my ($self, $path, $detect) = @_;
my $captures = $self->match_partial(\$path, $detect);
return !$path || $path eq '/' ? $captures : undef;
}
sub match_partial {
my ($self, $pathref, $detect) = @_;
# Compile on demand
$self->_compile unless $self->{regex};
$self->_compile_format if $detect && !$self->{format_regex};
# Match
return undef unless my @captures = $$pathref =~ $self->regex;
$$pathref = ${^POSTMATCH};
# Merge captures
my $captures = {%{$self->defaults}};
for my $placeholder (@{$self->placeholders}) {
last unless @captures;
my $capture = shift @captures;
$captures->{$placeholder} = $capture if defined $capture;
}
# Format
return $captures unless $detect && (my $regex = $self->format_regex);
return undef unless $$pathref =~ $regex;
$captures->{format} = $1 if defined $1;
$$pathref = '';
return $captures;
}
sub new { @_ > 1 ? shift->SUPER::new->parse(@_) : shift->SUPER::new }
sub parse {
my $self = shift;
my $pattern = @_ % 2 ? (shift // '/') : '/';
$pattern =~ s!^/*|/+!/!g;
return $self->constraints({@_}) if $pattern eq '/';
$pattern =~ s!/$!!;
return $self->constraints({@_})->_tokenize($pattern);
}
sub render {
my ($self, $values, $endpoint) = @_;
# Placeholders can only be optional without a format
my $optional = !(my $format = $values->{format});
my $str = '';
for my $token (reverse @{$self->tree}) {
my ($op, $value) = @$token;
my $fragment = '';
# Text
if ($op eq 'text') { ($fragment, $optional) = ($value, 0) }
# Slash
elsif ($op eq 'slash') { $fragment = '/' unless $optional }
# Placeholder
else {
my $default = $self->defaults->{$value};
$fragment = $values->{$value} // $default // '';
if (!defined $default || ($default ne $fragment)) { $optional = 0 }
elsif ($optional) { $fragment = '' }
}
$str = "$fragment$str";
}
# Format can be optional
return $endpoint && $format ? "$str.$format" : $str;
}
sub _compile {
my $self = shift;
my $placeholders = $self->placeholders;
my $constraints = $self->constraints;
my $defaults = $self->defaults;
my $block = my $regex = '';
my $optional = 1;
for my $token (reverse @{$self->tree}) {
my ($op, $value) = @$token;
my $fragment = '';
# Text
if ($op eq 'text') { ($fragment, $optional) = (quotemeta $value, 0) }
# Slash
elsif ($op eq 'slash') {
$regex = ($optional ? "(?:/$block)?" : "/$block") . $regex;
($block, $optional) = ('', 1);
next;
}
# Placeholder
else {
unshift @$placeholders, $value;
# Placeholder
if ($op eq 'placeholder') { $fragment = '([^/\.]+)' }
# Relaxed
elsif ($op eq 'relaxed') { $fragment = '([^/]+)' }
# Wildcard
else { $fragment = '(.+)' }
# Custom regex
if (my $c = $constraints->{$value}) { $fragment = _compile_req($c) }
# Optional placeholder
exists $defaults->{$value} ? ($fragment .= '?') : ($optional = 0);
}
$block = "$fragment$block";
}
# Not rooted with a slash
$regex = "$block$regex" if $block;
$self->regex(qr/^$regex/ps);
}
sub _compile_format {
my $self = shift;
# Default regex
my $format = $self->constraints->{format};
return $self->format_regex(qr!^/?(?:\.([^/]+))?$!) unless defined $format;
# No regex
return undef unless $format;
# Compile custom regex
my $regex = '\.' . _compile_req($format);
$regex = "(?:$regex)?" if $self->defaults->{format};
$self->format_regex(qr!^/?$regex$!);
}
sub _compile_req {
my $req = shift;
return "($req)" if ref $req ne 'ARRAY';
return '(' . join('|', map {quotemeta} reverse sort @$req) . ')';
}
sub _tokenize {
my ($self, $pattern) = @_;
my $quote_end = $self->quote_end;
my $quote_start = $self->quote_start;
my $placeholder = $self->placeholder_start;
my $relaxed = $self->relaxed_start;
my $wildcard = $self->wildcard_start;
my (@tree, $inside, $quoted);
for my $char (split '', $pattern) {
# Quote start
if ($char eq $quote_start) {
push @tree, ['placeholder', ''];
($inside, $quoted) = (1, 1);
}
# Placeholder start
elsif ($char eq $placeholder) {
push @tree, ['placeholder', ''] unless $inside++;
}
# Relaxed or wildcard start (upgrade when quoted)
elsif ($char eq $relaxed || $char eq $wildcard) {
push @tree, ['placeholder', ''] unless $quoted;
$tree[-1][0] = $char eq $relaxed ? 'relaxed' : 'wildcard';
$inside = 1;
}
# Quote end
elsif ($char eq $quote_end) { ($inside, $quoted) = (0, 0) }
# Slash (first slash is text for optimizations)
elsif ($char eq '/') {
push @tree, @tree ? ['slash'] : ['text', '/'];
$inside = 0;
}
# Placeholder, relaxed or wildcard
elsif ($inside) { $tree[-1][-1] .= $char }
# Text (optimize text followed by slash followed by text)
elsif ($tree[-1][0] eq 'text') { $tree[-1][-1] .= $char }
elsif ($tree[-2] && $tree[-2][0] eq 'text' && $tree[-1][0] eq 'slash') {
pop @tree && ($tree[-1][-1] .= "/$char");
}
else { push @tree, ['text', $char] }
}
return $self->pattern($pattern)->tree(\@tree);
}
1;
=encoding utf8
=head1 NAME
Mojolicious::Routes::Pattern - Routes pattern engine
=head1 SYNOPSIS
use Mojolicious::Routes::Pattern;
# Create pattern
my $pattern = Mojolicious::Routes::Pattern->new('/test/:name');
# Match routes
my $captures = $pattern->match('/test/sebastian');
say $captures->{name};
=head1 DESCRIPTION
L<Mojolicious::Routes::Pattern> is the core of L<Mojolicious::Routes>.
=head1 ATTRIBUTES
L<Mojolicious::Routes::Pattern> implements the following attributes.
=head2 constraints
my $constraints = $pattern->constraints;
$pattern = $pattern->constraints({foo => qr/\w+/});
Regular expression constraints.
=head2 defaults
my $defaults = $pattern->defaults;
$pattern = $pattern->defaults({foo => 'bar'});
Default parameters.
=head2 format_regex
my $regex = $pattern->format_regex;
$pattern = $pattern->format_regex($regex);
Compiled regular expression for format matching.
=head2 pattern
my $raw = $pattern->pattern;
$pattern = $pattern->pattern('/(foo)/(bar)');
Raw unparsed pattern.
=head2 placeholder_start
my $start = $pattern->placeholder_start;
$pattern = $pattern->placeholder_start(':');
Character indicating a placeholder, defaults to C<:>.
=head2 placeholders
my $placeholders = $pattern->placeholders;
$pattern = $pattern->placeholders(['foo', 'bar']);
Placeholder names.
=head2 quote_end
my $end = $pattern->quote_end;
$pattern = $pattern->quote_end(']');
Character indicating the end of a quoted placeholder, defaults to C<)>.
=head2 quote_start
my $start = $pattern->quote_start;
$pattern = $pattern->quote_start('[');
Character indicating the start of a quoted placeholder, defaults to C<(>.
=head2 regex
my $regex = $pattern->regex;
$pattern = $pattern->regex($regex);
Pattern in compiled regular expression form.
=head2 relaxed_start
my $start = $pattern->relaxed_start;
$pattern = $pattern->relaxed_start('*');
Character indicating a relaxed placeholder, defaults to C<#>.
=head2 tree
my $tree = $pattern->tree;
$pattern = $pattern->tree([['text', '/foo']]);
Pattern in parsed form. Note that this structure should only be used very
carefully since it is very dynamic.
=head2 wildcard_start
my $start = $pattern->wildcard_start;
$pattern = $pattern->wildcard_start('*');
Character indicating the start of a wildcard placeholder, defaults to C<*>.
=head1 METHODS
L<Mojolicious::Routes::Pattern> inherits all methods from L<Mojo::Base> and
implements the following new ones.
=head2 match
my $captures = $pattern->match('/foo/bar');
my $captures = $pattern->match('/foo/bar', 1);
Match pattern against entire path, format detection is disabled by default.
=head2 match_partial
my $captures = $pattern->match_partial(\$path);
my $captures = $pattern->match_partial(\$path, 1);
Match pattern against path and remove matching parts, format detection is
disabled by default.
=head2 new
my $pattern = Mojolicious::Routes::Pattern->new('/:action');
my $pattern
= Mojolicious::Routes::Pattern->new('/:action', action => qr/\w+/);
my $pattern = Mojolicious::Routes::Pattern->new(format => 0);
Construct a new L<Mojolicious::Routes::Pattern> object and L</"parse"> pattern
if necessary.
=head2 parse
$pattern = $pattern->parse('/:action');
$pattern = $pattern->parse('/:action', action => qr/\w+/);
$pattern = $pattern->parse(format => 0);
Parse pattern.
=head2 render
my $path = $pattern->render({action => 'foo'});
my $path = $pattern->render({action => 'foo'}, 1);
Render pattern into a path with parameters, format rendering is disabled by
default.
=head1 SEE ALSO
L<Mojolicious>, L<Mojolicious::Guides>, L<http://mojolicio.us>.
=cut
|