Commit | Line | Data |
fc7ec1d9 |
1 | package Catalyst::Engine::CGI; |
2 | |
3 | use strict; |
fbcc39ad |
4 | use base 'Catalyst::Engine'; |
5 | use NEXT; |
6 | use URI; |
e2fd5b5f |
7 | |
2d29e3de |
8 | my $uri_proto=URI->new(); |
b5ecfcf0 |
9 | __PACKAGE__->mk_accessors('env'); |
84528885 |
10 | |
fc7ec1d9 |
11 | =head1 NAME |
12 | |
13 | Catalyst::Engine::CGI - The CGI Engine |
14 | |
15 | =head1 SYNOPSIS |
16 | |
23f9d934 |
17 | A script using the Catalyst::Engine::CGI module might look like: |
18 | |
9a33da6a |
19 | #!/usr/bin/perl -w |
20 | |
21 | use strict; |
22 | use lib '/path/to/MyApp/lib'; |
23 | use MyApp; |
24 | |
25 | MyApp->run; |
26 | |
23f9d934 |
27 | The application module (C<MyApp>) would use C<Catalyst>, which loads the |
28 | appropriate engine module. |
fc7ec1d9 |
29 | |
30 | =head1 DESCRIPTION |
31 | |
fbcc39ad |
32 | This is the Catalyst engine specialized for the CGI environment. |
e2fd5b5f |
33 | |
23f9d934 |
34 | =head1 OVERLOADED METHODS |
fc7ec1d9 |
35 | |
fbcc39ad |
36 | This class overloads some methods from C<Catalyst::Engine>. |
fc7ec1d9 |
37 | |
b5ecfcf0 |
38 | =head2 $self->finalize_headers($c) |
fc7ec1d9 |
39 | |
40 | =cut |
41 | |
fbcc39ad |
42 | sub finalize_headers { |
43 | my ( $self, $c ) = @_; |
06e1b616 |
44 | |
fbcc39ad |
45 | $c->response->header( Status => $c->response->status ); |
06e1b616 |
46 | |
00c99324 |
47 | print $c->response->headers->as_string("\015\012"); |
48 | print "\015\012"; |
fc7ec1d9 |
49 | } |
50 | |
b5ecfcf0 |
51 | =head2 $self->prepare_connection($c) |
fc7ec1d9 |
52 | |
53 | =cut |
54 | |
fbcc39ad |
55 | sub prepare_connection { |
56 | my ( $self, $c ) = @_; |
b5ecfcf0 |
57 | local (*ENV) = $self->env || \%ENV; |
4f5ebacd |
58 | |
fbcc39ad |
59 | $c->request->address( $ENV{REMOTE_ADDR} ); |
4f5ebacd |
60 | |
61 | PROXY_CHECK: |
fbcc39ad |
62 | { |
63 | unless ( $c->config->{using_frontend_proxy} ) { |
64 | last PROXY_CHECK if $ENV{REMOTE_ADDR} ne '127.0.0.1'; |
65 | last PROXY_CHECK if $c->config->{ignore_frontend_proxy}; |
5b387dfc |
66 | } |
fbcc39ad |
67 | last PROXY_CHECK unless $ENV{HTTP_X_FORWARDED_FOR}; |
4f5ebacd |
68 | |
fbcc39ad |
69 | # If we are running as a backend server, the user will always appear |
70 | # as 127.0.0.1. Select the most recent upstream IP (last in the list) |
71 | my ($ip) = $ENV{HTTP_X_FORWARDED_FOR} =~ /([^,\s]+)$/; |
4f5ebacd |
72 | $c->request->address($ip); |
fc7ec1d9 |
73 | } |
08cf3dd6 |
74 | |
fbcc39ad |
75 | $c->request->hostname( $ENV{REMOTE_HOST} ); |
76 | $c->request->protocol( $ENV{SERVER_PROTOCOL} ); |
77 | $c->request->user( $ENV{REMOTE_USER} ); |
78 | $c->request->method( $ENV{REQUEST_METHOD} ); |
79 | |
80 | if ( $ENV{HTTPS} && uc( $ENV{HTTPS} ) eq 'ON' ) { |
81 | $c->request->secure(1); |
5b387dfc |
82 | } |
bfde09a2 |
83 | |
fbcc39ad |
84 | if ( $ENV{SERVER_PORT} == 443 ) { |
85 | $c->request->secure(1); |
86 | } |
fc7ec1d9 |
87 | } |
88 | |
b5ecfcf0 |
89 | =head2 $self->prepare_headers($c) |
fc7ec1d9 |
90 | |
91 | =cut |
92 | |
fbcc39ad |
93 | sub prepare_headers { |
94 | my ( $self, $c ) = @_; |
b5ecfcf0 |
95 | local (*ENV) = $self->env || \%ENV; |
316bf0f0 |
96 | |
fbcc39ad |
97 | # Read headers from %ENV |
c82ed742 |
98 | foreach my $header ( keys %ENV ) { |
fbcc39ad |
99 | next unless $header =~ /^(?:HTTP|CONTENT|COOKIE)/i; |
100 | ( my $field = $header ) =~ s/^HTTPS?_//; |
c82ed742 |
101 | $c->req->headers->header( $field => $ENV{$header} ); |
fbcc39ad |
102 | } |
103 | } |
316bf0f0 |
104 | |
b5ecfcf0 |
105 | =head2 $self->prepare_path($c) |
316bf0f0 |
106 | |
fbcc39ad |
107 | =cut |
316bf0f0 |
108 | |
fbcc39ad |
109 | sub prepare_path { |
110 | my ( $self, $c ) = @_; |
b5ecfcf0 |
111 | local (*ENV) = $self->env || \%ENV; |
fbcc39ad |
112 | |
4f5ebacd |
113 | my $scheme = $c->request->secure ? 'https' : 'http'; |
294f78ca |
114 | my $host = $ENV{HTTP_HOST} || $ENV{SERVER_NAME}; |
115 | my $port = $ENV{SERVER_PORT} || 80; |
0bcb98c7 |
116 | my $base_path; |
117 | if ( exists $ENV{REDIRECT_URL} ) { |
118 | $base_path = $ENV{REDIRECT_URL}; |
119 | $base_path =~ s/$ENV{PATH_INFO}$//; |
120 | } |
121 | else { |
122 | $base_path = $ENV{SCRIPT_NAME} || '/'; |
123 | } |
4f5ebacd |
124 | |
fbcc39ad |
125 | # If we are running as a backend proxy, get the true hostname |
4f5ebacd |
126 | PROXY_CHECK: |
fbcc39ad |
127 | { |
128 | unless ( $c->config->{using_frontend_proxy} ) { |
129 | last PROXY_CHECK if $host !~ /localhost|127.0.0.1/; |
130 | last PROXY_CHECK if $c->config->{ignore_frontend_proxy}; |
316bf0f0 |
131 | } |
fbcc39ad |
132 | last PROXY_CHECK unless $ENV{HTTP_X_FORWARDED_HOST}; |
316bf0f0 |
133 | |
fbcc39ad |
134 | $host = $ENV{HTTP_X_FORWARDED_HOST}; |
4f5ebacd |
135 | |
136 | # backend could be on any port, so |
fbcc39ad |
137 | # assume frontend is on the default port |
138 | $port = $c->request->secure ? 443 : 80; |
316bf0f0 |
139 | } |
140 | |
e701c5c6 |
141 | my $path = $base_path . ( $ENV{PATH_INFO} || '' ); |
fbcc39ad |
142 | $path =~ s{^/+}{}; |
4f5ebacd |
143 | |
2d29e3de |
144 | my $uri = $uri_proto->clone; |
4f5ebacd |
145 | $uri->scheme($scheme); |
146 | $uri->host($host); |
147 | $uri->port($port); |
148 | $uri->path($path); |
fbcc39ad |
149 | $uri->query( $ENV{QUERY_STRING} ) if $ENV{QUERY_STRING}; |
4f5ebacd |
150 | |
fbcc39ad |
151 | # sanitize the URI |
152 | $uri = $uri->canonical; |
4f5ebacd |
153 | $c->request->uri($uri); |
fbcc39ad |
154 | |
155 | # set the base URI |
156 | # base must end in a slash |
4f5ebacd |
157 | $base_path .= '/' unless ( $base_path =~ /\/$/ ); |
fbcc39ad |
158 | my $base = $uri->clone; |
4f5ebacd |
159 | $base->path_query($base_path); |
160 | $c->request->base($base); |
e7c0c583 |
161 | } |
fc7ec1d9 |
162 | |
b5ecfcf0 |
163 | =head2 $self->prepare_query_parameters($c) |
fc7ec1d9 |
164 | |
165 | =cut |
166 | |
fbcc39ad |
167 | sub prepare_query_parameters { |
168 | my ( $self, $c ) = @_; |
b5ecfcf0 |
169 | local (*ENV) = $self->env || \%ENV; |
170 | |
f8109766 |
171 | if ( $ENV{QUERY_STRING} ) { |
172 | $self->SUPER::prepare_query_parameters( $c, $ENV{QUERY_STRING} ); |
173 | } |
fbcc39ad |
174 | } |
e7c0c583 |
175 | |
b5ecfcf0 |
176 | =head2 $self->prepare_request($c, (env => \%env)) |
84528885 |
177 | |
178 | =cut |
179 | |
180 | sub prepare_request { |
181 | my ( $self, $c, %args ) = @_; |
182 | |
183 | if ( $args{env} ) { |
b5ecfcf0 |
184 | $self->env( $args{env} ); |
84528885 |
185 | } |
186 | } |
187 | |
b5ecfcf0 |
188 | =head2 $self->prepare_write($c) |
bfde09a2 |
189 | |
fbcc39ad |
190 | Enable autoflush on the output handle for CGI-based engines. |
bfde09a2 |
191 | |
fbcc39ad |
192 | =cut |
e7c0c583 |
193 | |
fbcc39ad |
194 | sub prepare_write { |
195 | my ( $self, $c ) = @_; |
4f5ebacd |
196 | |
fbcc39ad |
197 | # Set the output handle to autoflush |
4f5ebacd |
198 | *STDOUT->autoflush(1); |
199 | |
200 | $self->NEXT::prepare_write($c); |
fbcc39ad |
201 | } |
e7c0c583 |
202 | |
b5ecfcf0 |
203 | =head2 $self->read_chunk($c, $buffer, $length) |
e7c0c583 |
204 | |
fbcc39ad |
205 | =cut |
e7c0c583 |
206 | |
4f5ebacd |
207 | sub read_chunk { shift; shift; *STDIN->sysread(@_); } |
e7c0c583 |
208 | |
b5ecfcf0 |
209 | =head2 $self->run |
bfde09a2 |
210 | |
fbcc39ad |
211 | =cut |
bfde09a2 |
212 | |
fbcc39ad |
213 | sub run { shift; shift->handle_request(@_) } |
fc7ec1d9 |
214 | |
fc7ec1d9 |
215 | =head1 SEE ALSO |
216 | |
fbcc39ad |
217 | L<Catalyst> L<Catalyst::Engine>. |
218 | |
219 | =head1 AUTHORS |
220 | |
221 | Sebastian Riedel, <sri@cpan.org> |
fc7ec1d9 |
222 | |
fbcc39ad |
223 | Christian Hansen, <ch@ngmedia.com> |
fc7ec1d9 |
224 | |
fbcc39ad |
225 | Andy Grundman, <andy@hybridized.org> |
fc7ec1d9 |
226 | |
227 | =head1 COPYRIGHT |
228 | |
229 | This program is free software, you can redistribute it and/or modify it under |
230 | the same terms as Perl itself. |
231 | |
232 | =cut |
233 | |
234 | 1; |