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)
111 # Please don't touch this method without adding tests in
112 # t/aggregate/unit_core_engine_cgi-prepare_path.t
114 my ( $self, $c ) = @_;
115 local (*ENV) = $self->env || \%ENV;
117 my $scheme = $c->request->secure ? 'https' : 'http';
118 my $host = $ENV{HTTP_HOST} || $ENV{SERVER_NAME};
119 my $port = $ENV{SERVER_PORT} || 80;
120 my $script_name = $ENV{SCRIPT_NAME};
121 $script_name =~ s/([^$URI::uric])/$URI::Escape::escapes{$1}/go if $script_name;
124 if ( exists $ENV{REDIRECT_URL} ) {
125 $base_path = $ENV{REDIRECT_URL};
126 $base_path =~ s/\Q$ENV{PATH_INFO}\E$//;
129 $base_path = $script_name || '/';
132 # If we are running as a backend proxy, get the true hostname
135 unless ( ref($c)->config->{using_frontend_proxy} ) {
136 last PROXY_CHECK if $host !~ /localhost|127.0.0.1/;
137 last PROXY_CHECK if ref($c)->config->{ignore_frontend_proxy};
139 last PROXY_CHECK unless $ENV{HTTP_X_FORWARDED_HOST};
141 $host = $ENV{HTTP_X_FORWARDED_HOST};
143 # backend could be on any port, so
144 # assume frontend is on the default port
145 $port = $c->request->secure ? 443 : 80;
146 if ( $ENV{HTTP_X_FORWARDED_PORT} ) {
147 $port = $ENV{HTTP_X_FORWARDED_PORT};
151 # RFC 3875: "Unlike a URI path, the PATH_INFO is not URL-encoded,
152 # and cannot contain path-segment parameters." This means PATH_INFO
153 # is always decoded, and the script can't distinguish / vs %2F.
154 # See https://issues.apache.org/bugzilla/show_bug.cgi?id=35256
155 # Here we try to resurrect the original encoded URI from REQUEST_URI.
156 my $path_info = $ENV{PATH_INFO};
157 if ($c->config->{rfc3875_paths}) {
158 if (my $req_uri = $ENV{REQUEST_URI}) {
159 $req_uri =~ s/^\Q$base_path\E//;
160 $req_uri =~ s/\?.*$//;
162 # Note that if REQUEST_URI doesn't start with a /, then the user
163 # is probably using mod_rewrite or something to rewrite requests
164 # into a sub-path of their application..
165 # This means that REQUEST_URI needs information from PATH_INFO
166 # prepending to it to be useful, otherwise the sub path which is
167 # being redirected to becomes the app base address which is
169 if (substr($req_uri, 0, 1) ne '/') {
170 my ($match) = $req_uri =~ m|^([^/]+)|;
171 my ($path_info_part) = $path_info =~ m|^(.*?\Q$match\E)|;
172 substr($req_uri, 0, length($match), $path_info_part)
175 $path_info = $req_uri;
180 # set the request URI
181 my $path = $base_path . ( $path_info || '' );
184 # Using URI directly is way too slow, so we construct the URLs manually
185 my $uri_class = "URI::$scheme";
187 # HTTP_HOST will include the port even if it's 80/443
188 $host =~ s/:(?:80|443)$//;
190 if ( $port !~ /^(?:80|443)$/ && $host !~ /:/ ) {
195 $path =~ s/([^$URI::uric])/$URI::Escape::escapes{$1}/go;
196 $path =~ s/\?/%3F/g; # STUPID STUPID SPECIAL CASE
198 my $query = $ENV{QUERY_STRING} ? '?' . $ENV{QUERY_STRING} : '';
199 my $uri = $scheme . '://' . $host . '/' . $path . $query;
201 $c->request->uri( bless(\$uri, $uri_class)->canonical );
204 # base must end in a slash
205 $base_path .= '/' unless $base_path =~ m{/$};
207 my $base_uri = $scheme . '://' . $host . $base_path;
209 $c->request->base( bless \$base_uri, $uri_class );
212 =head2 $self->prepare_query_parameters($c)
216 around prepare_query_parameters => sub {
218 my ( $self, $c ) = @_;
219 local (*ENV) = $self->env || \%ENV;
221 if ( $ENV{QUERY_STRING} ) {
222 $self->$orig( $c, $ENV{QUERY_STRING} );
226 =head2 $self->prepare_request($c, (env => \%env))
230 sub prepare_request {
231 my ( $self, $c, %args ) = @_;
234 $self->env( $args{env} );
238 =head2 $self->prepare_write($c)
240 Enable autoflush on the output handle for CGI-based engines.
244 around prepare_write => sub {
245 *STDOUT->autoflush(1);
249 =head2 $self->write($c, $buffer)
251 Writes the buffer to the client.
255 around write => sub {
257 my ( $self, $c, $buffer ) = @_;
259 # Prepend the headers if they have not yet been sent
260 if ( $self->_has_header_buf ) {
261 $buffer = $self->_clear_header_buf . $buffer;
264 return $self->$orig( $c, $buffer );
267 =head2 $self->read_chunk($c, $buffer, $length)
271 sub read_chunk { shift; shift; *STDIN->sysread(@_); }
277 sub run { shift; shift->handle_request( env => \%ENV ) }
281 L<Catalyst>, L<Catalyst::Engine>
285 Catalyst Contributors, see Catalyst.pm
289 This library is free software. You can redistribute it and/or modify it under
290 the same terms as Perl itself.