1 package Catalyst::Engine::CGI;
5 extends 'Catalyst::Engine';
7 has env => (is => 'rw');
13 Catalyst::Engine::CGI - The CGI Engine
17 A script using the Catalyst::Engine::CGI module might look like:
22 use lib '/path/to/MyApp/lib';
27 The application module (C<MyApp>) would use C<Catalyst>, which loads the
28 appropriate engine module.
32 This is the Catalyst engine specialized for the CGI environment.
34 =head1 OVERLOADED METHODS
36 This class overloads some methods from C<Catalyst::Engine>.
38 =head2 $self->finalize_headers($c)
42 sub finalize_headers {
43 my ( $self, $c ) = @_;
45 $c->response->header( Status => $c->response->status );
48 = $c->response->headers->as_string("\015\012") . "\015\012";
51 =head2 $self->prepare_connection($c)
55 sub prepare_connection {
56 my ( $self, $c ) = @_;
57 local (*ENV) = $self->env || \%ENV;
59 my $request = $c->request;
60 $request->address( $ENV{REMOTE_ADDR} );
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};
68 last PROXY_CHECK unless $ENV{HTTP_X_FORWARDED_FOR};
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]+)$/;
73 $request->address($ip);
76 $request->hostname( $ENV{REMOTE_HOST} );
77 $request->protocol( $ENV{SERVER_PROTOCOL} );
78 $request->user( $ENV{REMOTE_USER} );
79 $request->method( $ENV{REQUEST_METHOD} );
81 if ( $ENV{HTTPS} && uc( $ENV{HTTPS} ) eq 'ON' ) {
85 if ( $ENV{SERVER_PORT} == 443 ) {
90 =head2 $self->prepare_headers($c)
95 my ( $self, $c ) = @_;
96 local (*ENV) = $self->env || \%ENV;
97 my $headers = $c->request->headers;
98 # Read headers from %ENV
99 foreach my $header ( keys %ENV ) {
100 next unless $header =~ /^(?:HTTP|CONTENT|COOKIE)/i;
101 ( my $field = $header ) =~ s/^HTTPS?_//;
102 $headers->header( $field => $ENV{$header} );
106 =head2 $self->prepare_path($c)
111 my ( $self, $c ) = @_;
112 local (*ENV) = $self->env || \%ENV;
114 my $scheme = $c->request->secure ? 'https' : 'http';
115 my $host = $ENV{HTTP_HOST} || $ENV{SERVER_NAME};
116 my $port = $ENV{SERVER_PORT} || 80;
118 if ( exists $ENV{REDIRECT_URL} ) {
119 $base_path = $ENV{REDIRECT_URL};
120 $base_path =~ s/$ENV{PATH_INFO}$//;
123 $base_path = $ENV{SCRIPT_NAME} || '/';
126 # If we are running as a backend proxy, get the true hostname
129 unless ( $c->config->{using_frontend_proxy} ) {
130 last PROXY_CHECK if $host !~ /localhost|127.0.0.1/;
131 last PROXY_CHECK if $c->config->{ignore_frontend_proxy};
133 last PROXY_CHECK unless $ENV{HTTP_X_FORWARDED_HOST};
135 $host = $ENV{HTTP_X_FORWARDED_HOST};
137 # backend could be on any port, so
138 # assume frontend is on the default port
139 $port = $c->request->secure ? 443 : 80;
142 # set the request URI
143 my $path = $base_path . ( $ENV{PATH_INFO} || '' );
146 # Using URI directly is way too slow, so we construct the URLs manually
147 my $uri_class = "URI::$scheme";
149 # HTTP_HOST will include the port even if it's 80/443
150 $host =~ s/:(?:80|443)$//;
152 if ( $port !~ /^(?:80|443)$/ && $host !~ /:/ ) {
157 $path =~ s/([^$URI::uric])/$URI::Escape::escapes{$1}/go;
158 $path =~ s/\?/%3F/g; # STUPID STUPID SPECIAL CASE
160 my $query = $ENV{QUERY_STRING} ? '?' . $ENV{QUERY_STRING} : '';
161 my $uri = $scheme . '://' . $host . '/' . $path . $query;
163 $c->request->uri( bless \$uri, $uri_class );
166 # base must end in a slash
167 $base_path .= '/' unless $base_path =~ m{/$};
169 my $base_uri = $scheme . '://' . $host . $base_path;
171 $c->request->base( bless \$base_uri, $uri_class );
174 =head2 $self->prepare_query_parameters($c)
178 sub prepare_query_parameters {
179 my ( $self, $c ) = @_;
180 local (*ENV) = $self->env || \%ENV;
182 if ( $ENV{QUERY_STRING} ) {
183 $self->next::method( $c, $ENV{QUERY_STRING} );
187 =head2 $self->prepare_request($c, (env => \%env))
191 sub prepare_request {
192 my ( $self, $c, %args ) = @_;
195 $self->env( $args{env} );
199 =head2 $self->prepare_write($c)
201 Enable autoflush on the output handle for CGI-based engines.
206 *STDOUT->autoflush(1);
207 return shift->next::method(@_);
210 =head2 $self->write($c, $buffer)
212 Writes the buffer to the client.
217 my ( $self, $c, $buffer ) = @_;
219 # Prepend the headers if they have not yet been sent
220 if ( my $headers = delete $self->{_header_buf} ) {
221 $buffer = $headers . $buffer;
224 return $self->next::method( $c, $buffer );
227 =head2 $self->read_chunk($c, $buffer, $length)
231 sub read_chunk { shift; shift; *STDIN->sysread(@_); }
237 sub run { shift; shift->handle_request(@_) }
241 L<Catalyst> L<Catalyst::Engine>.
245 Sebastian Riedel, <sri@cpan.org>
247 Christian Hansen, <ch@ngmedia.com>
249 Andy Grundman, <andy@hybridized.org>
253 This program is free software, you can redistribute it and/or modify it under
254 the same terms as Perl itself.