fix AUTHOR pod sections, new 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 2cdab0b..a9446db 100644 (file)
--- a/lib/Catalyst/Controller/WrapCGI.pm
+++ b/lib/Catalyst/Controller/WrapCGI.pm
@@ -20,11 +20,11 @@ Catalyst::Controller::WrapCGI - Run CGIs in Catalyst
 
 =head1 VERSION
 
-Version 0.0034
+Version 0.020
 
 =cut
 
-our $VERSION = '0.0034';
+our $VERSION = '0.020';
 
 =head1 SYNOPSIS
 
@@ -52,7 +52,7 @@ In your .conf, configure which environment variables to pass:
             pass_env PERL5LIB
             pass_env PATH
             pass_env /^MYAPP_/
-            kill_env MOD_PERL
+            kill_env MYAPP_BAD
         </CGI>
     </Controller::Foo>
 
@@ -66,6 +66,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 +107,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 +137,17 @@ 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
 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.
 
@@ -203,15 +207,20 @@ 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,
               ($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
             );
 
   {
@@ -313,6 +322,26 @@ sub _filtered_env {
 
 __PACKAGE__->meta->make_immutable;
 
+=head1 DIRECT SOCKET/NPH SCRIPTS
+
+This currently won't work:
+
+    #!/usr/bin/perl
+
+    use CGI ':standard';
+
+    $| = 1;
+
+    print header;
+
+    for (0..1000) {
+        print $_, br, "\n";
+        sleep 1;
+    }
+
+because the coderef is executed synchronously with C<STDOUT> pointing to a temp
+file.
+
 =head1 ACKNOWLEDGEMENTS
 
 Original development sponsored by L<http://www.altinity.com/>
@@ -322,13 +351,11 @@ 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:
+=head1 AUTHOR
 
 Matt S. Trout, C<< <mst at shadowcat.co.uk> >>
 
-Contributors:
+=head1 CONTRIBUTORS
 
 Rafael Kitover C<< <rkitover at cpan.org> >>