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.0033';
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>.
71 C<< $your_controller->{CGI}{pass_env} >> should be an array of environment variables
72 or regular expressions to pass through to your CGIs. Entries surrounded by C</>
73 characters are considered regular expressions.
75 C<< $your_controller->{CGI}{kill_env} >> should be an array of environment
76 variables or regular expressions to remove from the environment before passing
77 it to your CGIs. Entries surrounded by C</> characters are considered regular
80 Default is to pass the whole of C<%ENV>, except for C<MOD_PERL> and
81 C<CONTENT_TYPE> (that is, the default C<kill_env> is C<[ qw(MOD_PERL
84 C<< $your_controller->{CGI}{username_field} >> should be the field for your user's name, which will be
85 read from C<< $c->user->obj >>. Defaults to 'username'.
87 See L</SYNOPSIS> for an example.
91 # Hack-around because Catalyst::Engine::HTTP goes and changes
92 # them to be the remote socket, and FCGI.pm does even dumber things.
94 open my $REAL_STDIN, "<&=".fileno(*STDIN);
95 open my $REAL_STDOUT, ">>&=".fileno(*STDOUT);
99 =head2 cgi_to_response
101 C<<$self->cgi_to_response($c, $coderef)>>
103 Does the magic of running $coderef in a CGI environment, and populating the
104 appropriate parts of your Catalyst context with the results.
110 sub cgi_to_response {
111 my ($self, $c, $script) = @_;
113 my $res = $self->wrap_cgi($c, $script);
115 # if the CGI doesn't set the response code but sets location they were
116 # probably trying to redirect so set 302 for them
118 my $location = $res->headers->header('Location');
120 if (defined $location && length $location && $res->code == 200) {
121 $c->res->status(302);
123 $c->res->status($res->code);
125 $c->res->body($res->content);
126 $c->res->headers($res->headers);
131 C<<$self->wrap_cgi($c, $coderef)>>
133 Runs $coderef in a CGI environment using L<HTTP::Request::AsCGI>, returns an
136 The CGI environment is set up based on $c.
138 The environment variables to pass on are taken from the configuration for your
139 Controller, see L</SYNOPSIS> for an example. If you don't supply a list of
140 environment variables to pass, the whole of %ENV is used.
142 Used by L</cgi_to_response>, which is probably what you want to use as well.
147 my ($self, $c, $call) = @_;
148 my $req = HTTP::Request->new(
149 map { $c->req->$_ } qw/method uri headers/
151 my $body = $c->req->body;
152 my $body_content = '';
154 $req->content_type($c->req->content_type); # set this now so we can override
156 if ($body) { # Slurp from body filehandle
157 local $/; $body_content = <$body>;
159 my $body_params = $c->req->body_parameters;
161 if (my %uploads = %{ $c->req->uploads }) {
162 my $post = POST 'http://localhost/',
163 Content_Type => 'form-data',
167 my $upl = $uploads{$_};
171 Content => $upl->slurp,
172 'Content-Type' => $upl->type || 'application/octet-stream',
174 $_ => $upl->headers->header($_)
175 ), grep !/^Content-(?:Type|Disposition)$/,
176 $upl->headers->header_field_names
180 $body_content = $post->content;
181 $req->content_type($post->header('Content-Type'));
182 } elsif (%$body_params) {
183 my $encoder = URI->new;
184 $encoder->query_form(%$body_params);
185 $body_content = $encoder->query;
186 $req->content_type('application/x-www-form-urlencoded');
190 my $filtered_env = $self->_filtered_env(\%ENV);
192 $req->content($body_content);
193 $req->content_length(length($body_content));
195 my $username_field = $self->{CGI}{username_field} || 'username';
197 my $username = (($c->can('user_exists') && $c->user_exists)
198 ? eval { $c->user->obj->$username_field }
201 my $path_info = '/'.join '/' => map uri_escape_utf8($_), @{ $c->req->args };
203 my $env = HTTP::Request::AsCGI->new(
205 ($username ? (REMOTE_USER => $username) : ()),
207 PATH_INFO => $path_info,
208 FILEPATH_INFO => '/'.$c->action.$path_info, # eww
209 SCRIPT_NAME => $c->uri_for($c->action)->path
213 local *STDIN = $REAL_STDIN; # restore the real ones so the filenos
214 local *STDOUT = $REAL_STDOUT; # are 0 and 1 for the env setup
216 my $old = select($REAL_STDOUT); # in case somebody just calls 'print'
227 Catalyst::Exception->throw(
228 message => "CGI invocation failed: $saved_error"
232 return $env->response;
236 my ($self, $env) = @_;
239 my $pass_env = $self->{CGI}{pass_env};
240 $pass_env = [] if not defined $pass_env;
241 $pass_env = [ $pass_env ] unless ref $pass_env;
243 my $kill_env = $self->{CGI}{kill_env};
244 $kill_env = [ 'MOD_PERL', 'CONTENT_TYPE' ] unless defined $kill_env;
245 $kill_env = [ $kill_env ] unless ref $kill_env;
251 push @ok, grep /$re/, keys %$env;
260 for my $k (@$kill_env) {
261 if ($k =~ m!^/(.*)/\z!) {
263 @ok = grep { ! /$re/ } @ok;
265 @ok = grep { $_ ne $k } @ok;
268 return { map {; $_ => $env->{$_} } @ok };
271 __PACKAGE__->meta->make_immutable;
273 =head1 ACKNOWLEDGEMENTS
275 Original development sponsored by L<http://www.altinity.com/>
279 L<Catalyst::Controller::CGIBin>, L<CatalystX::GlobalContext>,
280 L<Catalyst::Controller>, L<CGI>, L<Catalyst>
284 Originally written by:
286 Matt S. Trout, C<< <mst at shadowcat.co.uk> >>
290 Rafael Kitover C<< <rkitover at cpan.org> >>
292 Hans Dieter Pearcey C<< <hdp at cpan.org> >>
296 Please report any bugs or feature requests to C<bug-catalyst-controller-wrapcgi
297 at rt.cpan.org>, or through the web interface at
298 L<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Catalyst-Controller-WrapCGI>.
299 I will be notified, and then you'll automatically be notified of progress on
300 your bug as I make changes.
308 =item * RT: CPAN's request tracker
310 L<http://rt.cpan.org/NoAuth/Bugs.html?Dist=Catalyst-Controller-WrapCGI>
312 =item * AnnoCPAN: Annotated CPAN documentation
314 L<http://annocpan.org/dist/Catalyst-Controller-WrapCGI>
318 L<http://cpanratings.perl.org/d/Catalyst-Controller-WrapCGI>
322 L<http://search.cpan.org/dist/Catalyst-Controller-WrapCGI>
326 =head1 COPYRIGHT & LICENSE
328 Copyright (c) 2008 Matt S. Trout
330 This program is free software; you can redistribute it and/or modify it
331 under the same terms as Perl itself.
335 1; # End of Catalyst::Controller::WrapCGI
337 # vim: expandtab shiftwidth=2 ts=2 tw=80: