1 package Catalyst::Controller::WrapCGI;
7 extends 'Catalyst::Controller';
9 use HTTP::Request::AsCGI ();
12 use Catalyst::Exception ();
14 use HTTP::Request::Common;
16 use namespace::clean -except => 'meta';
20 Catalyst::Controller::WrapCGI - Run CGIs in Catalyst
28 our $VERSION = '0.023';
32 package MyApp::Controller::Foo;
34 use parent qw/Catalyst::Controller::WrapCGI/;
37 sub hello : Path('cgi-bin/hello.cgi') {
40 $self->cgi_to_response($c, sub {
42 print $q->header, $q->start_html('Hello'),
43 $q->h1('Catalyst Rocks!'),
48 In your .conf, configure which environment variables to pass:
52 username_field username # used for REMOTE_USER env var
62 Allows you to run Perl code in a CGI environment derived from your L<Catalyst>
65 B<*WARNING*>: do not export L<CGI> functions into a Controller, it will break
66 with L<Catalyst> 5.8 onward.
68 If you just want to run CGIs from files, see L<Catalyst::Controller::CGIBin>.
70 C<REMOTE_USER> will be set to C<< $c->user->obj->$username_field >> if
71 available, or to C<< $c->req->remote_user >> otherwise.
77 C<< $your_controller->{CGI}{pass_env} >> should be an array of environment variables
78 or regular expressions to pass through to your CGIs. Entries surrounded by C</>
79 characters are considered regular expressions.
83 C<< $your_controller->{CGI}{kill_env} >> should be an array of environment
84 variables or regular expressions to remove from the environment before passing
85 it to your CGIs. Entries surrounded by C</> characters are considered regular
88 Default is to pass the whole of C<%ENV>, except for entries listed in
89 L</FILTERED ENVIRONMENT> below.
93 C<< $your_controller->{CGI}{username_field} >> should be the field for your
94 user's name, which will be read from C<< $c->user->obj >>. Defaults to
97 See L</SYNOPSIS> for an example.
101 # Hack-around because Catalyst::Engine::HTTP goes and changes
102 # them to be the remote socket, and FCGI.pm does even dumber things.
104 open my $REAL_STDIN, "<&=".fileno(*STDIN);
105 open my $REAL_STDOUT, ">>&=".fileno(*STDOUT);
109 =head2 cgi_to_response
111 C<< $self->cgi_to_response($c, $coderef) >>
113 Does the magic of running $coderef in a CGI environment, and populating the
114 appropriate parts of your Catalyst context with the results.
120 sub cgi_to_response {
121 my ($self, $c, $script) = @_;
123 my $res = $self->wrap_cgi($c, $script);
125 # if the CGI doesn't set the response code but sets location they were
126 # probably trying to redirect so set 302 for them
128 my $location = $res->headers->header('Location');
130 if (defined $location && length $location && $res->code == 200) {
131 $c->res->status(302);
133 $c->res->status($res->code);
135 $c->res->body($res->content);
136 $c->res->headers($res->headers);
141 C<< $self->wrap_cgi($c, $coderef) >>
143 Runs C<$coderef> in a CGI environment using L<HTTP::Request::AsCGI>, returns an
146 C<$coderef> is passed the Controller instance, and C<$c>.
148 The CGI environment is set up based on C<$c>.
150 The environment variables to pass on are taken from the configuration for your
151 Controller, see L</SYNOPSIS> for an example. If you don't supply a list of
152 environment variables to pass, the whole of %ENV is used (with exceptions listed
153 in L</FILTERED ENVIRONMENT>.
155 Used by L</cgi_to_response>, which is probably what you want to use as well.
160 my ($self, $c, $call) = @_;
161 my $req = HTTP::Request->new(
162 map { $c->req->$_ } qw/method uri headers/
164 my $body = $c->req->body;
165 my $body_content = '';
167 $req->content_type($c->req->content_type); # set this now so we can override
169 if ($body) { # Slurp from body filehandle
170 local $/; $body_content = <$body>;
172 my $body_params = $c->req->body_parameters;
174 if (my %uploads = %{ $c->req->uploads }) {
175 my $post = POST 'http://localhost/',
176 Content_Type => 'form-data',
180 my $upl = $uploads{$_};
184 Content => $upl->slurp,
187 map { $header => $_ } $upl->headers->header($header)
188 } $upl->headers->header_field_names
192 $body_content = $post->content;
193 $req->content_type($post->header('Content-Type'));
194 } elsif (%$body_params) {
195 my $encoder = URI->new;
196 $encoder->query_form(%$body_params);
197 $body_content = $encoder->query;
198 $req->content_type('application/x-www-form-urlencoded');
202 my $filtered_env = $self->_filtered_env(\%ENV);
204 $req->content($body_content);
205 $req->content_length(length($body_content));
207 my $username_field = $self->{CGI}{username_field} || 'username';
209 my $username = (($c->can('user_exists') && $c->user_exists)
210 ? eval { $c->user->obj->$username_field }
213 $username ||= $c->req->remote_user if $c->req->can('remote_user');
215 my $path_info = '/'.join '/' => map {
216 utf8::is_utf8($_) ? uri_escape_utf8($_) : uri_escape($_)
217 } @{ $c->req->args };
219 my $env = HTTP::Request::AsCGI->new(
221 ($username ? (REMOTE_USER => $username) : ()),
223 PATH_INFO => $path_info,
224 # eww, this is likely broken:
225 FILEPATH_INFO => '/'.$c->action.$path_info,
226 SCRIPT_NAME => $c->uri_for($c->action, $c->req->captures)->path
230 local *STDIN = $REAL_STDIN; # restore the real ones so the filenos
231 local *STDOUT = $REAL_STDOUT; # are 0 and 1 for the env setup
233 my $old = select($REAL_STDOUT); # in case somebody just calls 'print'
238 eval { $call->($self, $c) };
244 Catalyst::Exception->throw(
245 message => "CGI invocation failed: $saved_error"
249 return $env->response;
252 =head1 FILTERED ENVIRONMENT
254 If you don't use the L</pass_env> option to restrict which environment variables
255 are passed in, the default is to pass the whole of C<%ENV> except the variables
279 C<%ENV> can be further trimmed using L</kill_env>.
283 my $DEFAULT_KILL_ENV = [qw/
284 MOD_PERL SERVER_SOFTWARE SERVER_NAME GATEWAY_INTERFACE SERVER_PROTOCOL
285 SERVER_PORT REQUEST_METHOD PATH_INFO PATH_TRANSLATED SCRIPT_NAME QUERY_STRING
286 REMOTE_HOST REMOTE_ADDR AUTH_TYPE REMOTE_USER REMOTE_IDENT CONTENT_TYPE
287 CONTENT_LENGTH HTTP_ACCEPT HTTP_USER_AGENT
291 my ($self, $env) = @_;
294 my $pass_env = $self->{CGI}{pass_env};
295 $pass_env = [] if not defined $pass_env;
296 $pass_env = [ $pass_env ] unless ref $pass_env;
298 my $kill_env = $self->{CGI}{kill_env};
299 $kill_env = $DEFAULT_KILL_ENV unless defined $kill_env;
300 $kill_env = [ $kill_env ] unless ref $kill_env;
306 push @ok, grep /$re/, keys %$env;
315 for my $k (@$kill_env) {
316 if ($k =~ m!^/(.*)/\z!) {
318 @ok = grep { ! /$re/ } @ok;
320 @ok = grep { $_ ne $k } @ok;
323 return { map {; $_ => $env->{$_} } @ok };
326 __PACKAGE__->meta->make_immutable;
328 =head1 DIRECT SOCKET/NPH SCRIPTS
330 This currently won't work:
345 because the coderef is executed synchronously with C<STDOUT> pointing to a temp
348 =head1 ACKNOWLEDGEMENTS
350 Original development sponsored by L<http://www.altinity.com/>
354 L<Catalyst::Controller::CGIBin>, L<CatalystX::GlobalContext>,
355 L<Catalyst::Controller>, L<CGI>, L<Catalyst>
359 Please report any bugs or feature requests to C<bug-catalyst-controller-wrapcgi
360 at rt.cpan.org>, or through the web interface at
361 L<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Catalyst-Controller-WrapCGI>.
362 I will be notified, and then you'll automatically be notified of progress on
363 your bug as I make changes.
371 =item * RT: CPAN's request tracker
373 L<http://rt.cpan.org/NoAuth/Bugs.html?Dist=Catalyst-Controller-WrapCGI>
375 =item * AnnoCPAN: Annotated CPAN documentation
377 L<http://annocpan.org/dist/Catalyst-Controller-WrapCGI>
381 L<http://cpanratings.perl.org/d/Catalyst-Controller-WrapCGI>
385 L<http://search.cpan.org/dist/Catalyst-Controller-WrapCGI>
391 Matt S. Trout C<< <mst at shadowcat.co.uk> >>
395 Rafael Kitover C<< <rkitover at cpan.org> >>
397 Hans Dieter Pearcey C<< <hdp at cpan.org> >>
399 =head1 COPYRIGHT & LICENSE
401 Copyright (c) 2008-2009 L<Catalyst::Controller::WrapCGI/AUTHOR> and
402 L<Catalyst::Controller::WrapCGI/CONTRIBUTORS>.
404 This program is free software; you can redistribute it and/or modify it
405 under the same terms as Perl itself.
409 1; # End of Catalyst::Controller::WrapCGI
411 # vim: expandtab shiftwidth=2 ts=2 tw=80: