1 package Catalyst::Engine::CGI;
4 extends 'Catalyst::Engine';
6 has _header_buf => (is => 'rw', clearer => '_clear_header_buf', predicate => '_has_header_buf');
10 Catalyst::Engine::CGI - The CGI Engine
14 A script using the Catalyst::Engine::CGI module might look like:
19 use lib '/path/to/MyApp/lib';
24 The application module (C<MyApp>) would use C<Catalyst>, which loads the
25 appropriate engine module.
29 This is the Catalyst engine specialized for the CGI environment.
31 =head1 OVERLOADED METHODS
33 This class overloads some methods from C<Catalyst::Engine>.
35 =head2 $self->finalize_headers($c)
39 sub finalize_headers {
40 my ( $self, $c ) = @_;
42 $c->response->header( Status => $c->response->status );
44 $self->_header_buf($c->response->headers->as_string("\015\012") . "\015\012");
47 =head2 $self->prepare_connection($c)
51 sub prepare_connection {
52 my ( $self, $c ) = @_;
53 local (*ENV) = $self->env || \%ENV;
55 my $request = $c->request;
56 $request->address( $ENV{REMOTE_ADDR} );
60 unless ( ref($c)->config->{using_frontend_proxy} ) {
61 last PROXY_CHECK if $ENV{REMOTE_ADDR} ne '127.0.0.1';
62 last PROXY_CHECK if ref($c)->config->{ignore_frontend_proxy};
64 last PROXY_CHECK unless $ENV{HTTP_X_FORWARDED_FOR};
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]+)$/;
69 $request->address($ip);
70 if ( defined $ENV{HTTP_X_FORWARDED_PORT} ) {
71 $ENV{SERVER_PORT} = $ENV{HTTP_X_FORWARDED_PORT};
75 $request->hostname( $ENV{REMOTE_HOST} ) if exists $ENV{REMOTE_HOST};
76 $request->protocol( $ENV{SERVER_PROTOCOL} );
77 $request->user( $ENV{REMOTE_USER} ); # XXX: Deprecated. See Catalyst::Request for removal information
78 $request->remote_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 ) {
88 binmode(STDOUT); # Ensure we are sending bytes.
91 =head2 $self->prepare_headers($c)
96 my ( $self, $c ) = @_;
97 local (*ENV) = $self->env || \%ENV;
98 my $headers = $c->request->headers;
99 # Read headers from %ENV
100 foreach my $header ( keys %ENV ) {
101 next unless $header =~ /^(?:HTTP|CONTENT|COOKIE)/i;
102 ( my $field = $header ) =~ s/^HTTPS?_//;
103 $headers->header( $field => $ENV{$header} );
107 =head2 $self->prepare_path($c)
112 my ( $self, $c ) = @_;
113 local (*ENV) = $self->env || \%ENV;
115 my $scheme = $c->request->secure ? 'https' : 'http';
116 my $host = $ENV{HTTP_HOST} || $ENV{SERVER_NAME};
117 my $port = $ENV{SERVER_PORT} || 80;
119 if ( exists $ENV{REDIRECT_URL} ) {
120 $base_path = $ENV{REDIRECT_URL};
121 $base_path =~ s/$ENV{PATH_INFO}$//;
124 $base_path = $ENV{SCRIPT_NAME} || '/';
127 # If we are running as a backend proxy, get the true hostname
130 unless ( ref($c)->config->{using_frontend_proxy} ) {
131 last PROXY_CHECK if $host !~ /localhost|127.0.0.1/;
132 last PROXY_CHECK if ref($c)->config->{ignore_frontend_proxy};
134 last PROXY_CHECK unless $ENV{HTTP_X_FORWARDED_HOST};
136 $host = $ENV{HTTP_X_FORWARDED_HOST};
138 # backend could be on any port, so
139 # assume frontend is on the default port
140 $port = $c->request->secure ? 443 : 80;
141 if ( $ENV{HTTP_X_FORWARDED_PORT} ) {
142 $port = $ENV{HTTP_X_FORWARDED_PORT};
146 # set the request URI
147 my $path = $base_path . ( $ENV{PATH_INFO} || '' );
150 # Using URI directly is way too slow, so we construct the URLs manually
151 my $uri_class = "URI::$scheme";
153 # HTTP_HOST will include the port even if it's 80/443
154 $host =~ s/:(?:80|443)$//;
156 if ( $port !~ /^(?:80|443)$/ && $host !~ /:/ ) {
161 $path =~ s/([^$URI::uric])/$URI::Escape::escapes{$1}/go;
162 $path =~ s/\?/%3F/g; # STUPID STUPID SPECIAL CASE
164 my $query = $ENV{QUERY_STRING} ? '?' . $ENV{QUERY_STRING} : '';
165 my $uri = $scheme . '://' . $host . '/' . $path . $query;
167 $c->request->uri( bless \$uri, $uri_class );
170 # base must end in a slash
171 $base_path .= '/' unless $base_path =~ m{/$};
173 my $base_uri = $scheme . '://' . $host . $base_path;
175 $c->request->base( bless \$base_uri, $uri_class );
178 =head2 $self->prepare_query_parameters($c)
182 around prepare_query_parameters => sub {
184 my ( $self, $c ) = @_;
185 local (*ENV) = $self->env || \%ENV;
187 if ( $ENV{QUERY_STRING} ) {
188 $self->$orig( $c, $ENV{QUERY_STRING} );
192 =head2 $self->prepare_request($c, (env => \%env))
196 sub prepare_request {
197 my ( $self, $c, %args ) = @_;
200 $self->env( $args{env} );
204 =head2 $self->prepare_write($c)
206 Enable autoflush on the output handle for CGI-based engines.
210 around prepare_write => sub {
211 *STDOUT->autoflush(1);
215 =head2 $self->write($c, $buffer)
217 Writes the buffer to the client.
221 around write => sub {
223 my ( $self, $c, $buffer ) = @_;
225 # Prepend the headers if they have not yet been sent
226 if ( $self->_has_header_buf ) {
227 $buffer = $self->_clear_header_buf . $buffer;
230 return $self->$orig( $c, $buffer );
233 =head2 $self->read_chunk($c, $buffer, $length)
237 sub read_chunk { shift; shift; *STDIN->sysread(@_); }
243 sub run { shift; shift->handle_request( env => \%ENV ) }
247 L<Catalyst>, L<Catalyst::Engine>
251 Catalyst Contributors, see Catalyst.pm
255 This library is free software. You can redistribute it and/or modify it under
256 the same terms as Perl itself.