Commit | Line | Data |
fc7ec1d9 |
1 | package Catalyst::Engine::CGI; |
2 | |
7fa2c9c1 |
3 | use Moose; |
4 | extends 'Catalyst::Engine'; |
e2fd5b5f |
5 | |
02570318 |
6 | has _header_buf => (is => 'rw', clearer => '_clear_header_buf', predicate => '_has_header_buf'); |
84528885 |
7 | |
fc7ec1d9 |
8 | =head1 NAME |
9 | |
10 | Catalyst::Engine::CGI - The CGI Engine |
11 | |
12 | =head1 SYNOPSIS |
13 | |
23f9d934 |
14 | A script using the Catalyst::Engine::CGI module might look like: |
15 | |
9a33da6a |
16 | #!/usr/bin/perl -w |
17 | |
18 | use strict; |
19 | use lib '/path/to/MyApp/lib'; |
20 | use MyApp; |
21 | |
22 | MyApp->run; |
23 | |
23f9d934 |
24 | The application module (C<MyApp>) would use C<Catalyst>, which loads the |
25 | appropriate engine module. |
fc7ec1d9 |
26 | |
27 | =head1 DESCRIPTION |
28 | |
fbcc39ad |
29 | This is the Catalyst engine specialized for the CGI environment. |
e2fd5b5f |
30 | |
23f9d934 |
31 | =head1 OVERLOADED METHODS |
fc7ec1d9 |
32 | |
fbcc39ad |
33 | This class overloads some methods from C<Catalyst::Engine>. |
fc7ec1d9 |
34 | |
b5ecfcf0 |
35 | =head2 $self->finalize_headers($c) |
fc7ec1d9 |
36 | |
37 | =cut |
38 | |
fbcc39ad |
39 | sub finalize_headers { |
40 | my ( $self, $c ) = @_; |
06e1b616 |
41 | |
fbcc39ad |
42 | $c->response->header( Status => $c->response->status ); |
06e1b616 |
43 | |
02570318 |
44 | $self->_header_buf($c->response->headers->as_string("\015\012") . "\015\012"); |
fc7ec1d9 |
45 | } |
46 | |
b5ecfcf0 |
47 | =head2 $self->prepare_connection($c) |
fc7ec1d9 |
48 | |
49 | =cut |
50 | |
fbcc39ad |
51 | sub prepare_connection { |
52 | my ( $self, $c ) = @_; |
b5ecfcf0 |
53 | local (*ENV) = $self->env || \%ENV; |
4f5ebacd |
54 | |
7fa2c9c1 |
55 | my $request = $c->request; |
56 | $request->address( $ENV{REMOTE_ADDR} ); |
4f5ebacd |
57 | |
58 | PROXY_CHECK: |
fbcc39ad |
59 | { |
df960201 |
60 | unless ( ref($c)->config->{using_frontend_proxy} ) { |
fbcc39ad |
61 | last PROXY_CHECK if $ENV{REMOTE_ADDR} ne '127.0.0.1'; |
df960201 |
62 | last PROXY_CHECK if ref($c)->config->{ignore_frontend_proxy}; |
5b387dfc |
63 | } |
fbcc39ad |
64 | last PROXY_CHECK unless $ENV{HTTP_X_FORWARDED_FOR}; |
4f5ebacd |
65 | |
fbcc39ad |
66 | # If we are running as a backend server, the user will always appear |
67 | # as 127.0.0.1. Select the most recent upstream IP (last in the list) |
68 | my ($ip) = $ENV{HTTP_X_FORWARDED_FOR} =~ /([^,\s]+)$/; |
7fa2c9c1 |
69 | $request->address($ip); |
64d1c3cd |
70 | if ( defined $ENV{HTTP_X_FORWARDED_PORT} ) { |
71 | $ENV{SERVER_PORT} = $ENV{HTTP_X_FORWARDED_PORT}; |
72 | } |
fc7ec1d9 |
73 | } |
08cf3dd6 |
74 | |
8fc0d39e |
75 | $request->hostname( $ENV{REMOTE_HOST} ) if exists $ENV{REMOTE_HOST}; |
7fa2c9c1 |
76 | $request->protocol( $ENV{SERVER_PROTOCOL} ); |
8026359e |
77 | $request->user( $ENV{REMOTE_USER} ); # XXX: Deprecated. See Catalyst::Request for removal information |
78 | $request->remote_user( $ENV{REMOTE_USER} ); |
7fa2c9c1 |
79 | $request->method( $ENV{REQUEST_METHOD} ); |
fbcc39ad |
80 | |
81 | if ( $ENV{HTTPS} && uc( $ENV{HTTPS} ) eq 'ON' ) { |
7fa2c9c1 |
82 | $request->secure(1); |
5b387dfc |
83 | } |
bfde09a2 |
84 | |
fbcc39ad |
85 | if ( $ENV{SERVER_PORT} == 443 ) { |
7fa2c9c1 |
86 | $request->secure(1); |
fbcc39ad |
87 | } |
afdffc63 |
88 | binmode(STDOUT); # Ensure we are sending bytes. |
fc7ec1d9 |
89 | } |
90 | |
b5ecfcf0 |
91 | =head2 $self->prepare_headers($c) |
fc7ec1d9 |
92 | |
93 | =cut |
94 | |
fbcc39ad |
95 | sub prepare_headers { |
96 | my ( $self, $c ) = @_; |
b5ecfcf0 |
97 | local (*ENV) = $self->env || \%ENV; |
7fa2c9c1 |
98 | my $headers = $c->request->headers; |
fbcc39ad |
99 | # Read headers from %ENV |
c82ed742 |
100 | foreach my $header ( keys %ENV ) { |
fbcc39ad |
101 | next unless $header =~ /^(?:HTTP|CONTENT|COOKIE)/i; |
102 | ( my $field = $header ) =~ s/^HTTPS?_//; |
7fa2c9c1 |
103 | $headers->header( $field => $ENV{$header} ); |
fbcc39ad |
104 | } |
105 | } |
316bf0f0 |
106 | |
b5ecfcf0 |
107 | =head2 $self->prepare_path($c) |
316bf0f0 |
108 | |
fbcc39ad |
109 | =cut |
316bf0f0 |
110 | |
eb3abf96 |
111 | # Please don't touch this method without adding tests in |
112 | # t/aggregate/unit_core_engine_cgi-prepare_path.t |
fbcc39ad |
113 | sub prepare_path { |
114 | my ( $self, $c ) = @_; |
b5ecfcf0 |
115 | local (*ENV) = $self->env || \%ENV; |
fbcc39ad |
116 | |
4f5ebacd |
117 | my $scheme = $c->request->secure ? 'https' : 'http'; |
294f78ca |
118 | my $host = $ENV{HTTP_HOST} || $ENV{SERVER_NAME}; |
119 | my $port = $ENV{SERVER_PORT} || 80; |
8bf285ed |
120 | my $script_name = $ENV{SCRIPT_NAME}; |
121 | $script_name =~ s/([^$URI::uric])/$URI::Escape::escapes{$1}/go if $script_name; |
122 | |
0bcb98c7 |
123 | my $base_path; |
124 | if ( exists $ENV{REDIRECT_URL} ) { |
125 | $base_path = $ENV{REDIRECT_URL}; |
126 | $base_path =~ s/$ENV{PATH_INFO}$//; |
127 | } |
128 | else { |
8bf285ed |
129 | $base_path = $script_name || '/'; |
0bcb98c7 |
130 | } |
4f5ebacd |
131 | |
fbcc39ad |
132 | # If we are running as a backend proxy, get the true hostname |
4f5ebacd |
133 | PROXY_CHECK: |
fbcc39ad |
134 | { |
df960201 |
135 | unless ( ref($c)->config->{using_frontend_proxy} ) { |
fbcc39ad |
136 | last PROXY_CHECK if $host !~ /localhost|127.0.0.1/; |
df960201 |
137 | last PROXY_CHECK if ref($c)->config->{ignore_frontend_proxy}; |
316bf0f0 |
138 | } |
fbcc39ad |
139 | last PROXY_CHECK unless $ENV{HTTP_X_FORWARDED_HOST}; |
316bf0f0 |
140 | |
fbcc39ad |
141 | $host = $ENV{HTTP_X_FORWARDED_HOST}; |
4f5ebacd |
142 | |
143 | # backend could be on any port, so |
fbcc39ad |
144 | # assume frontend is on the default port |
145 | $port = $c->request->secure ? 443 : 80; |
64d1c3cd |
146 | if ( $ENV{HTTP_X_FORWARDED_PORT} ) { |
147 | $port = $ENV{HTTP_X_FORWARDED_PORT}; |
148 | } |
316bf0f0 |
149 | } |
150 | |
8bf285ed |
151 | # RFC 3875: "Unlike a URI path, the PATH_INFO is not URL-encoded, |
152 | # and cannot contain path-segment parameters." This means PATH_INFO |
153 | # is always decoded, and the script can't distinguish / vs %2F. |
154 | # See https://issues.apache.org/bugzilla/show_bug.cgi?id=35256 |
155 | # Here we try to resurrect the original encoded URI from REQUEST_URI. |
156 | my $path_info = $ENV{PATH_INFO}; |
157 | if (my $req_uri = $ENV{REQUEST_URI}) { |
eb3abf96 |
158 | $req_uri =~ s/^\Q$base_path\E//; |
8bf285ed |
159 | $req_uri =~ s/\?.*$//; |
b760ac3d |
160 | if ($req_uri) { |
161 | # Note that if REQUEST_URI doesn't start with a /, then the user |
162 | # is probably using mod_rewrite or something to rewrite requests |
163 | # into a sub-path of their application.. |
164 | # This means that REQUEST_URI needs information from PATH_INFO |
165 | # prepending to it to be useful, otherwise the sub path which is |
166 | # being redirected to becomes the app base address which is |
167 | # incorrect. |
168 | if (substr($req_uri, 0, 1) ne '/') { |
169 | my ($match) = $req_uri =~ m|^([^/]+)|; |
6e5e5aaf |
170 | my ($path_info_part) = $path_info =~ m|^(.*?\Q$match\E)|; |
b760ac3d |
171 | substr($req_uri, 0, length($match), $path_info_part); |
172 | } |
173 | $path_info = $req_uri; |
174 | } |
8bf285ed |
175 | } |
176 | |
8d3c800b |
177 | # set the request URI |
8bf285ed |
178 | my $path = $base_path . ( $path_info || '' ); |
fbcc39ad |
179 | $path =~ s{^/+}{}; |
b0ad47c1 |
180 | |
933ba403 |
181 | # Using URI directly is way too slow, so we construct the URLs manually |
182 | my $uri_class = "URI::$scheme"; |
b0ad47c1 |
183 | |
de19de2e |
184 | # HTTP_HOST will include the port even if it's 80/443 |
185 | $host =~ s/:(?:80|443)$//; |
b0ad47c1 |
186 | |
de19de2e |
187 | if ( $port !~ /^(?:80|443)$/ && $host !~ /:/ ) { |
933ba403 |
188 | $host .= ":$port"; |
189 | } |
b0ad47c1 |
190 | |
933ba403 |
191 | # Escape the path |
192 | $path =~ s/([^$URI::uric])/$URI::Escape::escapes{$1}/go; |
193 | $path =~ s/\?/%3F/g; # STUPID STUPID SPECIAL CASE |
b0ad47c1 |
194 | |
933ba403 |
195 | my $query = $ENV{QUERY_STRING} ? '?' . $ENV{QUERY_STRING} : ''; |
196 | my $uri = $scheme . '://' . $host . '/' . $path . $query; |
197 | |
198 | $c->request->uri( bless \$uri, $uri_class ); |
199 | |
8d3c800b |
200 | # set the base URI |
201 | # base must end in a slash |
202 | $base_path .= '/' unless $base_path =~ m{/$}; |
b0ad47c1 |
203 | |
8d3c800b |
204 | my $base_uri = $scheme . '://' . $host . $base_path; |
205 | |
206 | $c->request->base( bless \$base_uri, $uri_class ); |
e7c0c583 |
207 | } |
fc7ec1d9 |
208 | |
b5ecfcf0 |
209 | =head2 $self->prepare_query_parameters($c) |
fc7ec1d9 |
210 | |
211 | =cut |
212 | |
4090e3bb |
213 | around prepare_query_parameters => sub { |
214 | my $orig = shift; |
fbcc39ad |
215 | my ( $self, $c ) = @_; |
b5ecfcf0 |
216 | local (*ENV) = $self->env || \%ENV; |
217 | |
f8109766 |
218 | if ( $ENV{QUERY_STRING} ) { |
4090e3bb |
219 | $self->$orig( $c, $ENV{QUERY_STRING} ); |
f8109766 |
220 | } |
4090e3bb |
221 | }; |
e7c0c583 |
222 | |
b5ecfcf0 |
223 | =head2 $self->prepare_request($c, (env => \%env)) |
84528885 |
224 | |
225 | =cut |
226 | |
227 | sub prepare_request { |
228 | my ( $self, $c, %args ) = @_; |
229 | |
230 | if ( $args{env} ) { |
b5ecfcf0 |
231 | $self->env( $args{env} ); |
84528885 |
232 | } |
233 | } |
234 | |
b5ecfcf0 |
235 | =head2 $self->prepare_write($c) |
bfde09a2 |
236 | |
fbcc39ad |
237 | Enable autoflush on the output handle for CGI-based engines. |
bfde09a2 |
238 | |
fbcc39ad |
239 | =cut |
e7c0c583 |
240 | |
4090e3bb |
241 | around prepare_write => sub { |
4f5ebacd |
242 | *STDOUT->autoflush(1); |
4090e3bb |
243 | return shift->(@_); |
244 | }; |
e7c0c583 |
245 | |
e512dd24 |
246 | =head2 $self->write($c, $buffer) |
247 | |
248 | Writes the buffer to the client. |
249 | |
250 | =cut |
251 | |
4090e3bb |
252 | around write => sub { |
253 | my $orig = shift; |
e512dd24 |
254 | my ( $self, $c, $buffer ) = @_; |
255 | |
256 | # Prepend the headers if they have not yet been sent |
02570318 |
257 | if ( $self->_has_header_buf ) { |
258 | $buffer = $self->_clear_header_buf . $buffer; |
e512dd24 |
259 | } |
7fa2c9c1 |
260 | |
4090e3bb |
261 | return $self->$orig( $c, $buffer ); |
262 | }; |
e512dd24 |
263 | |
b5ecfcf0 |
264 | =head2 $self->read_chunk($c, $buffer, $length) |
e7c0c583 |
265 | |
fbcc39ad |
266 | =cut |
e7c0c583 |
267 | |
4f5ebacd |
268 | sub read_chunk { shift; shift; *STDIN->sysread(@_); } |
e7c0c583 |
269 | |
b5ecfcf0 |
270 | =head2 $self->run |
bfde09a2 |
271 | |
fbcc39ad |
272 | =cut |
bfde09a2 |
273 | |
0c913601 |
274 | sub run { shift; shift->handle_request( env => \%ENV ) } |
fc7ec1d9 |
275 | |
fc7ec1d9 |
276 | =head1 SEE ALSO |
277 | |
2f381252 |
278 | L<Catalyst>, L<Catalyst::Engine> |
fbcc39ad |
279 | |
280 | =head1 AUTHORS |
281 | |
2f381252 |
282 | Catalyst Contributors, see Catalyst.pm |
fc7ec1d9 |
283 | |
284 | =head1 COPYRIGHT |
285 | |
536bee89 |
286 | This library is free software. You can redistribute it and/or modify it under |
fc7ec1d9 |
287 | the same terms as Perl itself. |
288 | |
289 | =cut |
4090e3bb |
290 | no Moose; |
fc7ec1d9 |
291 | |
292 | 1; |