1 package Catalyst::Controller::WrapCGI;
6 extends 'Catalyst::Controller';
8 use HTTP::Request::AsCGI ();
11 use Catalyst::Exception ();
13 use HTTP::Request::Common;
15 use namespace::clean -except => 'meta';
19 Catalyst::Controller::WrapCGI - Run CGIs in Catalyst
27 our $VERSION = '0.016';
31 package MyApp::Controller::Foo;
33 use parent qw/Catalyst::Controller::WrapCGI/;
36 sub hello : Path('cgi-bin/hello.cgi') {
39 $self->cgi_to_response($c, sub {
41 print $q->header, $q->start_html('Hello'),
42 $q->h1('Catalyst Rocks!'),
47 In your .conf, configure which environment variables to pass:
51 username_field username # used for REMOTE_USER env var
61 Allows you to run Perl code in a CGI environment derived from your L<Catalyst>
64 B<*WARNING*>: do not export L<CGI> functions into a Controller, it will break
65 with L<Catalyst> 5.8 onward.
67 If you just want to run CGIs from files, see L<Catalyst::Controller::CGIBin>.
69 C<REMOTE_USER> will be set to C<< $c->user->obj->$username_field >> if
70 available, or to C<< $c->req->remote_user >> otherwise.
76 C<< $your_controller->{CGI}{pass_env} >> should be an array of environment variables
77 or regular expressions to pass through to your CGIs. Entries surrounded by C</>
78 characters are considered regular expressions.
82 C<< $your_controller->{CGI}{kill_env} >> should be an array of environment
83 variables or regular expressions to remove from the environment before passing
84 it to your CGIs. Entries surrounded by C</> characters are considered regular
87 Default is to pass the whole of C<%ENV>, except for entries listed in
88 L</FILTERED ENVIRONMENT> below.
92 C<< $your_controller->{CGI}{username_field} >> should be the field for your
93 user's name, which will be read from C<< $c->user->obj >>. Defaults to
96 See L</SYNOPSIS> for an example.
100 # Hack-around because Catalyst::Engine::HTTP goes and changes
101 # them to be the remote socket, and FCGI.pm does even dumber things.
103 open my $REAL_STDIN, "<&=".fileno(*STDIN);
104 open my $REAL_STDOUT, ">>&=".fileno(*STDOUT);
108 =head2 cgi_to_response
110 C<< $self->cgi_to_response($c, $coderef) >>
112 Does the magic of running $coderef in a CGI environment, and populating the
113 appropriate parts of your Catalyst context with the results.
119 sub cgi_to_response {
120 my ($self, $c, $script) = @_;
122 my $res = $self->wrap_cgi($c, $script);
124 # if the CGI doesn't set the response code but sets location they were
125 # probably trying to redirect so set 302 for them
127 my $location = $res->headers->header('Location');
129 if (defined $location && length $location && $res->code == 200) {
130 $c->res->status(302);
132 $c->res->status($res->code);
134 $c->res->body($res->content);
135 $c->res->headers($res->headers);
140 C<< $self->wrap_cgi($c, $coderef) >>
142 Runs $coderef in a CGI environment using L<HTTP::Request::AsCGI>, returns an
145 The CGI environment is set up based on C<$c>.
147 The environment variables to pass on are taken from the configuration for your
148 Controller, see L</SYNOPSIS> for an example. If you don't supply a list of
149 environment variables to pass, the whole of %ENV is used (with exceptions listed
150 in L</FILTERED ENVIRONMENT>.
152 Used by L</cgi_to_response>, which is probably what you want to use as well.
157 my ($self, $c, $call) = @_;
158 my $req = HTTP::Request->new(
159 map { $c->req->$_ } qw/method uri headers/
161 my $body = $c->req->body;
162 my $body_content = '';
164 $req->content_type($c->req->content_type); # set this now so we can override
166 if ($body) { # Slurp from body filehandle
167 local $/; $body_content = <$body>;
169 my $body_params = $c->req->body_parameters;
171 if (my %uploads = %{ $c->req->uploads }) {
172 my $post = POST 'http://localhost/',
173 Content_Type => 'form-data',
177 my $upl = $uploads{$_};
181 Content => $upl->slurp,
184 map { $header => $_ } $upl->headers->header($header)
185 } $upl->headers->header_field_names
189 $body_content = $post->content;
190 $req->content_type($post->header('Content-Type'));
191 } elsif (%$body_params) {
192 my $encoder = URI->new;
193 $encoder->query_form(%$body_params);
194 $body_content = $encoder->query;
195 $req->content_type('application/x-www-form-urlencoded');
199 my $filtered_env = $self->_filtered_env(\%ENV);
201 $req->content($body_content);
202 $req->content_length(length($body_content));
204 my $username_field = $self->{CGI}{username_field} || 'username';
206 my $username = (($c->can('user_exists') && $c->user_exists)
207 ? eval { $c->user->obj->$username_field }
210 $username ||= $c->req->remote_user if $c->req->can('remote_user');
212 my $path_info = '/'.join '/' => map {
213 utf8::is_utf8($_) ? uri_escape_utf8($_) : uri_escape($_)
214 } @{ $c->req->args };
216 my $env = HTTP::Request::AsCGI->new(
218 ($username ? (REMOTE_USER => $username) : ()),
220 PATH_INFO => $path_info,
221 # eww, this is likely broken:
222 FILEPATH_INFO => '/'.$c->action.$path_info,
223 SCRIPT_NAME => $c->uri_for($c->action, $c->req->captures)->path
227 local *STDIN = $REAL_STDIN; # restore the real ones so the filenos
228 local *STDOUT = $REAL_STDOUT; # are 0 and 1 for the env setup
230 my $old = select($REAL_STDOUT); # in case somebody just calls 'print'
241 Catalyst::Exception->throw(
242 message => "CGI invocation failed: $saved_error"
246 return $env->response;
249 =head1 FILTERED ENVIRONMENT
251 If you don't use the L</pass_env> option to restrict which environment variables
252 are passed in, the default is to pass the whole of C<%ENV> except the variables
276 C<%ENV> can be further trimmed using L</kill_env>.
280 my $DEFAULT_KILL_ENV = [qw/
281 MOD_PERL SERVER_SOFTWARE SERVER_NAME GATEWAY_INTERFACE SERVER_PROTOCOL
282 SERVER_PORT REQUEST_METHOD PATH_INFO PATH_TRANSLATED SCRIPT_NAME QUERY_STRING
283 REMOTE_HOST REMOTE_ADDR AUTH_TYPE REMOTE_USER REMOTE_IDENT CONTENT_TYPE
284 CONTENT_LENGTH HTTP_ACCEPT HTTP_USER_AGENT
288 my ($self, $env) = @_;
291 my $pass_env = $self->{CGI}{pass_env};
292 $pass_env = [] if not defined $pass_env;
293 $pass_env = [ $pass_env ] unless ref $pass_env;
295 my $kill_env = $self->{CGI}{kill_env};
296 $kill_env = $DEFAULT_KILL_ENV unless defined $kill_env;
297 $kill_env = [ $kill_env ] unless ref $kill_env;
303 push @ok, grep /$re/, keys %$env;
312 for my $k (@$kill_env) {
313 if ($k =~ m!^/(.*)/\z!) {
315 @ok = grep { ! /$re/ } @ok;
317 @ok = grep { $_ ne $k } @ok;
320 return { map {; $_ => $env->{$_} } @ok };
323 __PACKAGE__->meta->make_immutable;
325 =head1 DIRECT SOCKET/NPH SCRIPTS
327 This currently won't work:
342 because the coderef is executed synchronously with C<STDOUT> pointing to a temp
345 =head1 ACKNOWLEDGEMENTS
347 Original development sponsored by L<http://www.altinity.com/>
351 L<Catalyst::Controller::CGIBin>, L<CatalystX::GlobalContext>,
352 L<Catalyst::Controller>, L<CGI>, L<Catalyst>
356 Originally written by:
358 Matt S. Trout, C<< <mst at shadowcat.co.uk> >>
362 Rafael Kitover C<< <rkitover at cpan.org> >>
364 Hans Dieter Pearcey C<< <hdp at cpan.org> >>
368 Please report any bugs or feature requests to C<bug-catalyst-controller-wrapcgi
369 at rt.cpan.org>, or through the web interface at
370 L<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Catalyst-Controller-WrapCGI>.
371 I will be notified, and then you'll automatically be notified of progress on
372 your bug as I make changes.
380 =item * RT: CPAN's request tracker
382 L<http://rt.cpan.org/NoAuth/Bugs.html?Dist=Catalyst-Controller-WrapCGI>
384 =item * AnnoCPAN: Annotated CPAN documentation
386 L<http://annocpan.org/dist/Catalyst-Controller-WrapCGI>
390 L<http://cpanratings.perl.org/d/Catalyst-Controller-WrapCGI>
394 L<http://search.cpan.org/dist/Catalyst-Controller-WrapCGI>
398 =head1 COPYRIGHT & LICENSE
400 Copyright (c) 2008 Matt S. Trout
402 This program is free software; you can redistribute it and/or modify it
403 under the same terms as Perl itself.
407 1; # End of Catalyst::Controller::WrapCGI
409 # vim: expandtab shiftwidth=2 ts=2 tw=80: