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