package Catalyst::Controller::WrapCGI;
-use strict;
-use warnings;
-use parent 'Catalyst::Controller';
+use Moose;
+use mro 'c3';
-use HTTP::Request::AsCGI;
-use HTTP::Request;
-use URI;
+extends 'Catalyst::Controller';
+
+use HTTP::Request::AsCGI ();
+use HTTP::Request ();
+use URI ();
use Catalyst::Exception ();
+use URI::Escape;
+
+use namespace::clean -except => 'meta';
=head1 NAME
=head1 VERSION
-Version 0.0021
+Version 0.0032
=cut
-our $VERSION = '0.0021';
+our $VERSION = '0.0032';
=head1 SYNOPSIS
package MyApp::Controller::Foo;
use parent qw/Catalyst::Controller::WrapCGI/;
+ use CGI ();
sub hello : Path('cgi-bin/hello.cgi') {
my ($self, $c) = @_;
$self->cgi_to_response($c, sub {
- use CGI ':standard';
-
- print header, start_html('Hello'),
- h1('Catalyst Rocks!'),
- end_html;
+ my $q = CGI->new;
+ print $q->header, $q->start_html('Hello'),
+ $q->h1('Catalyst Rocks!'),
+ $q->end_html;
});
}
pass_env PERL5LIB
pass_env PATH
pass_env /^MYAPP_/
+ kill_env MOD_PERL
</CGI>
</Controller::Foo>
Allows you to run Perl code in a CGI environment derived from your L<Catalyst>
context.
+B<*WARNING*>: do not export L<CGI> functions into a Controller, it will break
+with L<Catalyst> 5.8 onward.
+
If you just want to run CGIs from files, see L<Catalyst::Controller::CGIBin>.
=head1 CONFIGURATION
-C<$your_controller->{CGI}{pass_env}> should be an array of environment variables
+C<< $your_controller->{CGI}{pass_env} >> should be an array of environment variables
or regular expressions to pass through to your CGIs. Entries surrounded by C</>
characters are considered regular expressions.
-Default is to pass the whole of C<%ENV>.
+C<< $your_controller->{CGI}{kill_env} >> should be an array of environment
+variables or regular expressions to remove from the environment before passing
+it to your CGIs. Entries surrounded by C</> characters are considered regular
+expressions.
+
+Default is to pass the whole of C<%ENV>, except for C<MOD_PERL> (that is, the
+default C<kill_env> is C<[ 'MOD_PERL' ]>.
-C<{CGI}{username_field}> should be the field for your user's name, which will be
-read from C<$c->user->obj>. Defaults to 'username'.
+C<< $your_controller->{CGI}{username_field} >> should be the field for your user's name, which will be
+read from C<< $c->user->obj >>. Defaults to 'username'.
See L</SYNOPSIS> for an example.
=head1 METHODS
-=head2 $self->cgi_to_response($c, $coderef)
+=head2 cgi_to_response
+
+C<<$self->cgi_to_response($c, $coderef)>>
Does the magic of running $coderef in a CGI environment, and populating the
appropriate parts of your Catalyst context with the results.
-Calls wrap_cgi (below.)
+Calls L</wrap_cgi>.
=cut
sub cgi_to_response {
my ($self, $c, $script) = @_;
+
my $res = $self->wrap_cgi($c, $script);
# if the CGI doesn't set the response code but sets location they were
$c->res->headers($res->headers);
}
-=head2 $self->wrap_cgi($c, $coderef)
+=head2 wrap_cgi
+
+C<<$self->wrap_cgi($c, $coderef)>>
Runs $coderef in a CGI environment using L<HTTP::Request::AsCGI>, returns an
L<HTTP::Response>.
Controller, see L</SYNOPSIS> for an example. If you don't supply a list of
environment variables to pass, the whole of %ENV is used.
-Used by cgi_to_response (above), which is probably what you want to use as well.
+Used by L</cgi_to_response>, which is probably what you want to use as well.
=cut
}
}
- my @env;
-
- my $pass_env = $self->{CGI}{pass_env};
- $pass_env = [] if not defined $pass_env;
- $pass_env = [ $pass_env ] unless ref $pass_env;
-
- for (@$pass_env) {
- if (m!^/(.*)/\z!) {
- my $re = qr/$1/;
- push @env, grep /$re/, keys %ENV;
- } else {
- push @env, $_;
- }
- }
-
- @env = keys %ENV unless @env;
+ my $filtered_env = $self->_filtered_env(\%ENV);
$req->content($body_content);
$req->content_length(length($body_content));
my $username = (($c->can('user_exists') && $c->user_exists)
? eval { $c->user->obj->$username_field }
: '');
+
+ my $path_info = '/'.join '/' => map uri_escape_utf8($_), @{ $c->req->args };
+
my $env = HTTP::Request::AsCGI->new(
$req,
($username ? (REMOTE_USER => $username) : ()),
- map { ($_, $ENV{$_}) } @env
+ %$filtered_env,
+ PATH_INFO => $path_info,
+ FILEPATH_INFO => '/'.$c->action.$path_info, # eww
+ SCRIPT_NAME => $c->uri_for($c->action)->path
);
{
return $env->response;
}
+sub _filtered_env {
+ my ($self, $env) = @_;
+ my @ok;
+
+ my $pass_env = $self->{CGI}{pass_env};
+ $pass_env = [] if not defined $pass_env;
+ $pass_env = [ $pass_env ] unless ref $pass_env;
+
+ my $kill_env = $self->{CGI}{kill_env};
+ $kill_env = [ 'MOD_PERL' ] unless defined $kill_env;
+ $kill_env = [ $kill_env ] unless ref $kill_env;
+
+ if (@$pass_env) {
+ for (@$pass_env) {
+ if (m!^/(.*)/\z!) {
+ my $re = qr/$1/;
+ push @ok, grep /$re/, keys %$env;
+ } else {
+ push @ok, $_;
+ }
+ }
+ } else {
+ @ok = keys %$env;
+ }
+
+ for my $k (@$kill_env) {
+ if ($k =~ m!^/(.*)/\z!) {
+ my $re = qr/$1/;
+ @ok = grep { ! /$re/ } @ok;
+ } else {
+ @ok = grep { $_ ne $k } @ok;
+ }
+ }
+ return { map {; $_ => $env->{$_} } @ok };
+}
+
+__PACKAGE__->meta->make_immutable;
+
=head1 ACKNOWLEDGEMENTS
Original development sponsored by L<http://www.altinity.com/>
L<Catalyst::Controller::CGIBin>, L<CatalystX::GlobalContext>,
L<Catalyst::Controller>, L<CGI>, L<Catalyst>
-=head1 AUTHOR
+=head1 AUTHORS
+
+Originally written by:
Matt S. Trout, C<< <mst at shadowcat.co.uk> >>
+Contributors:
+
+Rafael Kitover C<< <rkitover at cpan.org> >>
+
+Hans Dieter Pearcey C<< <hdp at cpan.org> >>
+
=head1 BUGS
Please report any bugs or feature requests to C<bug-catalyst-controller-wrapcgi
projects / catagits/Catalyst-Controller-WrapCGI.git / blobdiff