steal some code from CGI::Compile, release

[catagits/Catalyst-Controller-WrapCGI.git] / lib / Catalyst / Controller / WrapCGI.pm

diff --git a/lib/Catalyst/Controller/WrapCGI.pm b/lib/Catalyst/Controller/WrapCGI.pm
index 7ca93f6..5c6dfe7 100644 (file)
--- a/lib/Catalyst/Controller/WrapCGI.pm
+++ b/lib/Catalyst/Controller/WrapCGI.pm
@@ -1,5 +1,6 @@
 package Catalyst::Controller::WrapCGI;
 
+use 5.008_001;
 use Moose;
 use mro 'c3';
 
@@ -20,11 +21,11 @@ Catalyst::Controller::WrapCGI - Run CGIs in Catalyst
 
 =head1 VERSION
 
-Version 0.0035
+Version 0.023
 
 =cut
 
-our $VERSION = '0.0035';
+our $VERSION = '0.023';
 
 =head1 SYNOPSIS
 
@@ -66,6 +67,9 @@ with L<Catalyst> 5.8 onward.
 
 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
@@ -104,7 +108,7 @@ open my $REAL_STDOUT, ">>&=".fileno(*STDOUT);
 
 =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.
@@ -134,16 +138,19 @@ sub cgi_to_response {
 
 =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.
+C<$coderef> is passed the Controller instance, and C<$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.
 
@@ -203,7 +210,11 @@ sub wrap_cgi {
                ? 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,
@@ -212,7 +223,7 @@ sub wrap_cgi {
               PATH_INFO => $path_info,
 # eww, this is likely broken:
               FILEPATH_INFO => '/'.$c->action.$path_info,
-              SCRIPT_NAME => $c->uri_for($c->action)->path
+              SCRIPT_NAME => $c->uri_for($c->action, $c->req->captures)->path
             );
 
   {
@@ -224,7 +235,7 @@ sub wrap_cgi {
     my $saved_error;
 
     $env->setup;
-    eval { $call->() };
+    eval { $call->($self, $c) };
     $saved_error = $@;
     $env->restore;
 
@@ -328,6 +339,7 @@ This currently won't work:
 
     for (0..1000) {
         print $_, br, "\n";
+        sleep 1;
     }
 
 because the coderef is executed synchronously with C<STDOUT> pointing to a temp
@@ -342,18 +354,6 @@ Original development sponsored by L<http://www.altinity.com/>
 L<Catalyst::Controller::CGIBin>, L<CatalystX::GlobalContext>,
 L<Catalyst::Controller>, L<CGI>, L<Catalyst>
 
-=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
@@ -386,9 +386,20 @@ L<http://search.cpan.org/dist/Catalyst-Controller-WrapCGI>
 
 =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> >>
+
 =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.