update Plack usage
[catagits/Web-Simple.git] / lib / Web / Dispatch / Parser.pm
CommitLineData
d63bcdae 1package Web::Dispatch::Parser;
920d6222 2
a5917caa 3sub DEBUG () { 0 }
4
5BEGIN {
d63bcdae 6 if ($ENV{WEB_DISPATCH_PARSER_DEBUG}) {
a5917caa 7 no warnings 'redefine';
8 *DEBUG = sub () { 1 }
9 }
10}
11
d63bcdae 12use Sub::Quote;
13use Web::Dispatch::Predicates;
14use Moo;
15
16has _cache => (
17 is => 'lazy', default => quote_sub q{ {} }
18);
a5917caa 19
d63bcdae 20sub diag { if (DEBUG) { warn $_[0] } }
920d6222 21
22sub _blam {
23 my ($self, $error) = @_;
a4ec359d 24 my $hat = (' ' x (pos||0)).'^';
920d6222 25 die "Error parsing dispatch specification: ${error}\n
26${_}
27${hat} here\n";
28}
29
d63bcdae 30sub parse {
920d6222 31 my ($self, $spec) = @_;
69aaa28a 32 $spec =~ s/\s+//g; # whitespace is not valid
d63bcdae 33 return $self->_cache->{$spec} ||= $self->_parse_spec($spec);
c6ea9542 34}
35
36sub _parse_spec {
b0420ad6 37 my ($self, $spec, $nested) = @_;
c6ea9542 38 for ($_[1]) {
920d6222 39 my @match;
920d6222 40 PARSE: { do {
c6ea9542 41 push @match, $self->_parse_spec_section($_)
920d6222 42 or $self->_blam("Unable to work out what the next section is");
b0420ad6 43 if (/\G\)/gc) {
44 $self->_blam("Found closing ) with no opening (") unless $nested;
45 last PARSE;
46 }
920d6222 47 last PARSE if (pos == length);
c6ea9542 48 $match[-1] = $self->_parse_spec_combinator($_, $match[-1])
49 or $self->_blam('No valid combinator - expected + or |');
920d6222 50 } until (pos == length) }; # accept trailing whitespace
b0420ad6 51 if ($nested and pos == length) {
a4ec359d 52 pos = $nested - 1;
b0420ad6 53 $self->_blam("No closing ) found for opening (");
54 }
920d6222 55 return $match[0] if (@match == 1);
d63bcdae 56 return match_and(@match);
920d6222 57 }
58}
59
9b9866ae 60sub _parse_spec_combinator {
61 my ($self, $spec, $match) = @_;
62 for ($_[1]) {
63
64 /\G\+/gc and
65 return $match;
66
67 /\G\|/gc and
68 return do {
69 my @match = $match;
70 PARSE: { do {
71 push @match, $self->_parse_spec_section($_)
72 or $self->_blam("Unable to work out what the next section is");
73 last PARSE if (pos == length);
74 last PARSE unless /\G\|/gc; # give up when next thing isn't |
75 } until (pos == length) }; # accept trailing whitespace
d63bcdae 76 return match_or(@match);
9b9866ae 77 };
78 }
79 return;
80}
81
920d6222 82sub _parse_spec_section {
83 my ($self) = @_;
84 for ($_[1]) {
85
86 # GET POST PUT HEAD ...
87
88 /\G([A-Z]+)/gc and
e954644c 89 return match_method($1);
920d6222 90
91 # /...
92
93 /\G(?=\/)/gc and
94 return $self->_url_path_match($_);
95
c6ea9542 96 # .* and .html
97
98 /\G\.(\*|\w+)/gc and
e954644c 99 return match_extension($1);
b0420ad6 100
2ee4ab06 101 # (...)
b0420ad6 102
103 /\G\(/gc and
104 return $self->_parse_spec($_, pos);
2ee4ab06 105
106 # !something
107
108 /\G!/gc and
ce573717 109 return match_not($self->_parse_spec_section($_));
920d6222 110
9b9866ae 111 # ?<param spec>
112 /\G\?/gc and
113 return $self->_parse_param_handler($_, 'query');
53d47b78 114
115 # %<param spec>
116 /\G\%/gc and
117 return $self->_parse_param_handler($_, 'body');
c6ea9542 118 }
9b9866ae 119 return; # () will trigger the blam in our caller
c6ea9542 120}
121
920d6222 122sub _url_path_match {
123 my ($self) = @_;
920d6222 124 for ($_[1]) {
125 my @path;
e7dd1c4b 126 my $end = '';
15e679c1 127 my $keep_dot;
da8429c9 128 PATH: while (/\G\//gc) {
129 /\G\.\.\./gc
130 and do {
e7dd1c4b 131 $end = '(/.*)';
da8429c9 132 last PATH;
133 };
920d6222 134 push @path, $self->_url_path_segment_match($_)
135 or $self->_blam("Couldn't parse path match segment");
15e679c1 136 /\G\.\*/gc
137 and do {
138 $keep_dot = 1;
139 last PATH;
140 };
920d6222 141 }
15e679c1 142 if (@path && !$end && !$keep_dot) {
4ed4fb42 143 length and $_ .= '(?:\.\w+)?' for $path[-1];
144 }
e7dd1c4b 145 my $re = '^('.join('/','',@path).')'.$end.'$';
da8429c9 146 $re = qr/$re/;
e7dd1c4b 147 if ($end) {
148 return match_path_strip($re);
149 } else {
d63bcdae 150 return match_path($re);
da8429c9 151 }
920d6222 152 }
153 return;
154}
155
156sub _url_path_segment_match {
157 my ($self) = @_;
158 for ($_[1]) {
159 # trailing / -> require / on end of URL
6c0f599a 160 /\G(?:(?=[+|\)])|$)/gc and
e7dd1c4b 161 return '';
920d6222 162 # word chars only -> exact path part match
1c4f4b78 163 /\G([\w\-]+)/gc and
920d6222 164 return "\Q$1";
28f3dfd5 165 # ** -> capture unlimited path parts
166 /\G\*\*/gc and
167 return '(.*?[^/])';
920d6222 168 # * -> capture path part
169 /\G\*/gc and
4ed4fb42 170 return '([^/]+?)';
920d6222 171 }
172 return ();
173}
174
9b9866ae 175sub _parse_param_handler {
176 my ($self, $spec, $type) = @_;
177
9b9866ae 178 for ($_[1]) {
eb9e0e25 179 my (@required, @single, %multi, $star, $multistar, %positional, $have_kw);
052bdd54 180 my %spec;
eb9e0e25 181 my $pos_idx = 0;
9b9866ae 182 PARAM: { do {
183
eb9e0e25 184 # ?:foo or ?@:foo
9b9866ae 185
eb9e0e25 186 my $is_kw = /\G\:/gc;
9b9866ae 187
188 # ?@foo or ?@*
189
eb9e0e25 190 my $multi = /\G\@/gc;
9b9866ae 191
192 # @* or *
193
a5917caa 194 if (/\G\*/gc) {
9b9866ae 195
eb9e0e25 196 $self->_blam("* is always named; no need to supply :") if $is_kw;
197
052bdd54 198 if ($star) {
199 $self->_blam("Can only use one * or \@* in a parameter match");
a5917caa 200 }
052bdd54 201
202 $spec{star} = { multi => $multi };
9b9866ae 203 } else {
204
205 # @foo= or foo= or @foo~ or foo~
6c0f599a 206
9b9866ae 207 /\G(\w+)/gc or $self->_blam('Expected parameter name');
208
209 my $name = $1;
210
211 # check for = or ~ on the end
212
213 /\G\=/gc
052bdd54 214 ? push(@{$spec{required}||=[]}, $name)
9b9866ae 215 : (/\G\~/gc or $self->_blam('Expected = or ~ after parameter name'));
216
eb9e0e25 217 # record positional or keyword
218
052bdd54 219 push @{$spec{$is_kw ? 'named' : 'positional'}||=[]},
220 { name => $name, multi => $multi };
9b9866ae 221 }
222 } while (/\G\&/gc) }
223
b6bf9ed3 224 return Web::Dispatch::Predicates->can("match_${type}")->(\%spec);
9b9866ae 225 }
226}
227
920d6222 2281;