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