package Catalyst::Controller::WrapCGI;
+use 5.008_001;
use Moose;
use mro 'c3';
Catalyst::Controller::WrapCGI - Run CGIs in Catalyst
-=head1 VERSION
-
-Version 0.0033
-
=cut
-our $VERSION = '0.0033';
+our $VERSION = '0.029';
=head1 SYNOPSIS
pass_env PERL5LIB
pass_env PATH
pass_env /^MYAPP_/
- kill_env MOD_PERL
+ kill_env MYAPP_BAD
</CGI>
</Controller::Foo>
If you just want to run CGIs from files, see L<Catalyst::Controller::CGIBin>.
+C<REMOTE_USER> will be set to C<< $c->user->obj->$username_field >> if
+available, or to C<< $c->req->remote_user >> otherwise.
+
=head1 CONFIGURATION
+=head2 pass_env
+
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.
+=head2 kill_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> and
-C<CONTENT_TYPE> (that is, the default C<kill_env> is C<[ qw(MOD_PERL
-CONTENT_TYPE) ]>.
+Default is to pass the whole of C<%ENV>, except for entries listed in
+L</FILTERED ENVIRONMENT> below.
-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'.
+=head2 username_field
+
+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.
=head2 cgi_to_response
-C<<$self->cgi_to_response($c, $coderef)>>
+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.
=head2 wrap_cgi
-C<<$self->wrap_cgi($c, $coderef)>>
+C<< $self->wrap_cgi($c, $coderef) >>
-Runs $coderef in a CGI environment using L<HTTP::Request::AsCGI>, returns an
+Runs C<$coderef> in a CGI environment using L<HTTP::Request::AsCGI>, returns an
L<HTTP::Response>.
-The CGI environment is set up based on $c.
+The CGI environment is set up based on C<$c>.
The environment variables to pass on are taken from the configuration for your
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.
+environment variables to pass, the whole of %ENV is used (with exceptions listed
+in L</FILTERED ENVIRONMENT>.
Used by L</cgi_to_response>, which is probably what you want to use as well.
undef,
$upl->filename,
Content => $upl->slurp,
- 'Content-Type' => $upl->type || 'application/octet-stream',
- map (
- $_ => $upl->headers->header($_)
- ), grep !/^Content-(?:Type|Disposition)$/,
- $upl->headers->header_field_names
+ map {
+ my $header = $_;
+ map { $header => $_ } $upl->headers->header($header)
+ } $upl->headers->header_field_names
]
} keys %uploads
];
}
}
- my $filtered_env = $self->_filtered_env(\%ENV);
-
$req->content($body_content);
$req->content_length(length($body_content));
? eval { $c->user->obj->$username_field }
: '');
- my $path_info = '/'.join '/' => map uri_escape_utf8($_), @{ $c->req->args };
+ $username ||= $c->req->remote_user if $c->req->can('remote_user');
+
+ my $path_info = '/'.join '/' => map {
+ utf8::is_utf8($_) ? uri_escape_utf8($_) : uri_escape($_)
+ } @{ $c->req->args };
my $env = HTTP::Request::AsCGI->new(
$req,
($username ? (REMOTE_USER => $username) : ()),
- %$filtered_env,
PATH_INFO => $path_info,
- FILEPATH_INFO => '/'.$c->action.$path_info, # eww
- SCRIPT_NAME => $c->uri_for($c->action)->path
+# eww, this is likely broken:
+ FILEPATH_INFO => '/'.$c->action.$path_info,
+ SCRIPT_NAME => $c->uri_for($c->action, $c->req->captures)->path
);
{
my $saved_error;
+ local %ENV = %{ $self->_filtered_env(\%ENV) };
+
$env->setup;
eval { $call->() };
$saved_error = $@;
return $env->response;
}
+=head1 FILTERED ENVIRONMENT
+
+If you don't use the L</pass_env> option to restrict which environment variables
+are passed in, the default is to pass the whole of C<%ENV> except the variables
+listed below.
+
+ MOD_PERL
+ SERVER_SOFTWARE
+ SERVER_NAME
+ GATEWAY_INTERFACE
+ SERVER_PROTOCOL
+ SERVER_PORT
+ REQUEST_METHOD
+ PATH_INFO
+ PATH_TRANSLATED
+ SCRIPT_NAME
+ QUERY_STRING
+ REMOTE_HOST
+ REMOTE_ADDR
+ AUTH_TYPE
+ REMOTE_USER
+ REMOTE_IDENT
+ CONTENT_TYPE
+ CONTENT_LENGTH
+ HTTP_ACCEPT
+ HTTP_USER_AGENT
+
+C<%ENV> can be further trimmed using L</kill_env>.
+
+=cut
+
+my $DEFAULT_KILL_ENV = [qw/
+ MOD_PERL SERVER_SOFTWARE SERVER_NAME GATEWAY_INTERFACE SERVER_PROTOCOL
+ SERVER_PORT REQUEST_METHOD PATH_INFO PATH_TRANSLATED SCRIPT_NAME QUERY_STRING
+ REMOTE_HOST REMOTE_ADDR AUTH_TYPE REMOTE_USER REMOTE_IDENT CONTENT_TYPE
+ CONTENT_LENGTH HTTP_ACCEPT HTTP_USER_AGENT
+/];
+
sub _filtered_env {
my ($self, $env) = @_;
my @ok;
$pass_env = [ $pass_env ] unless ref $pass_env;
my $kill_env = $self->{CGI}{kill_env};
- $kill_env = [ 'MOD_PERL', 'CONTENT_TYPE' ] unless defined $kill_env;
+ $kill_env = $DEFAULT_KILL_ENV unless defined $kill_env;
$kill_env = [ $kill_env ] unless ref $kill_env;
if (@$pass_env) {
__PACKAGE__->meta->make_immutable;
-=head1 ACKNOWLEDGEMENTS
+=head1 DIRECT SOCKET/NPH SCRIPTS
-Original development sponsored by L<http://www.altinity.com/>
+This currently won't work:
-=head1 SEE ALSO
+ #!/usr/bin/perl
-L<Catalyst::Controller::CGIBin>, L<CatalystX::GlobalContext>,
-L<Catalyst::Controller>, L<CGI>, L<Catalyst>
+ use CGI ':standard';
-=head1 AUTHORS
+ $| = 1;
-Originally written by:
+ print header;
-Matt S. Trout, C<< <mst at shadowcat.co.uk> >>
+ for (0..1000) {
+ print $_, br, "\n";
+ sleep 1;
+ }
-Contributors:
+because the coderef is executed synchronously with C<STDOUT> pointing to a temp
+file.
-Rafael Kitover C<< <rkitover at cpan.org> >>
+=head1 ACKNOWLEDGEMENTS
-Hans Dieter Pearcey C<< <hdp at cpan.org> >>
+Original development sponsored by L<http://www.altinity.com/>
+
+=head1 SEE ALSO
+
+L<Catalyst::Controller::CGIBin>, L<CatalystX::GlobalContext>,
+L<Catalyst::Controller>, L<CGI>, L<Catalyst>
=head1 BUGS
=back
+=head1 AUTHOR
+
+Matt S. Trout C<< <mst at shadowcat.co.uk> >>
+
+=head1 CONTRIBUTORS
+
+Rafael Kitover C<< <rkitover at cpan.org> >>
+
+Hans Dieter Pearcey C<< <hdp at cpan.org> >>
+
+Some code stolen from Tatsuhiko Miyagawa's L<CGI::Compile>.
+
=head1 COPYRIGHT & LICENSE
-Copyright (c) 2008 Matt S. Trout
+Copyright (c) 2008-2009 L<Catalyst::Controller::WrapCGI/AUTHOR> and
+L<Catalyst::Controller::WrapCGI/CONTRIBUTORS>.
This program is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.
projects / catagits/Catalyst-Controller-WrapCGI.git / blobdiff