C::C::CGIBin: add root/cgi-bin to $c->config->{static}{ignore_dirs}

[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 3e9d117..71b3592 100644 (file)
--- a/lib/Catalyst/Controller/WrapCGI.pm
+++ b/lib/Catalyst/Controller/WrapCGI.pm
@@ -7,6 +7,7 @@ use parent 'Catalyst::Controller';
 use HTTP::Request::AsCGI;
 use HTTP::Request;
 use URI;
+use Catalyst::Exception ();
 
 =head1 NAME
 
@@ -14,30 +15,64 @@ Catalyst::Controller::WrapCGI - Run CGIs in Catalyst
 
 =head1 VERSION
 
-Version 0.001
+Version 0.0025
 
 =cut
 
-our $VERSION = '0.001';
+our $VERSION = '0.0025';
 
 =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;
         });
     }
 
+In your .conf, configure which environment variables to pass:
+
+    <Controller::Foo>
+        <CGI>
+            username_field username # used for REMOTE_USER env var
+            pass_env PERL5LIB
+            pass_env PATH
+            pass_env /^MYAPP_/
+        </CGI>
+    </Controller::Foo>
+
+=head1 DESCRIPTION
+
+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
+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<{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.
+
 =cut
 
 # Hack-around because Catalyst::Engine::HTTP goes and changes
@@ -53,6 +88,8 @@ open my $REAL_STDOUT, ">>&=".fileno(*STDOUT);
 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.)
+
 =cut
 
 sub cgi_to_response {
@@ -80,7 +117,11 @@ L<HTTP::Response>.
 
 The CGI environment is set up based on $c.
 
-Used by cgi_to_response, which is probably what you want to use as well.
+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.
+
+Used by cgi_to_response (above), which is probably what you want to use as well.
 
 =cut
 
@@ -106,15 +147,35 @@ sub wrap_cgi {
     }
   }
 
+  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;
+
   $req->content($body_content);
   $req->content_length(length($body_content));
-  my $user = (($c->can('user_exists') && $c->user_exists)
-               ? eval { $c->user->obj->username }
+
+  my $username_field = $self->{CGI}{username_field} || 'username';
+
+  my $username = (($c->can('user_exists') && $c->user_exists)
+               ? eval { $c->user->obj->$username_field }
                 : '');
   my $env = HTTP::Request::AsCGI->new(
               $req,
-              REMOTE_USER => $user,
-              %ENV
+              ($username ? (REMOTE_USER => $username) : ()),
+              map { ($_, $ENV{$_}) } @env
             );
 
   {
@@ -132,8 +193,9 @@ sub wrap_cgi {
 
     select($old);
 
-    warn "CGI invoke failed: $saved_error" if $saved_error;
-
+    Catalyst::Exception->throw(
+        message => "CGI invocation failed: $saved_error"
+    ) if $saved_error;
   }
 
   return $env->response;
@@ -143,6 +205,11 @@ sub wrap_cgi {
 
 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 AUTHOR
 
 Matt S. Trout, C<< <mst at shadowcat.co.uk> >>
@@ -190,4 +257,4 @@ under the same terms as Perl itself.
 
 1; # End of Catalyst::Controller::WrapCGI
 
-# vim: expandtab shiftwidth=4 ts=4 tw=80:
+# vim: expandtab shiftwidth=2 ts=2 tw=80: