X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FCatalyst%2FController%2FCGIBin.pm;h=48eaae086698303263630bf72f76de4a4824f277;hb=2e6f9c85d869a3fd48134c5990ed654ad272fd12;hp=c43b70e49a25a04c73003c0121f4d6b56b1dbb55;hpb=2369e5a42fcc6df4a949b9db7e05e2d875f9423b;p=catagits%2FCatalyst-Controller-WrapCGI.git

diff --git a/lib/Catalyst/Controller/CGIBin.pm b/lib/Catalyst/Controller/CGIBin.pm
index c43b70e..48eaae0 100644
--- a/lib/Catalyst/Controller/CGIBin.pm
+++ b/lib/Catalyst/Controller/CGIBin.pm
@@ -1,10 +1,10 @@
 package Catalyst::Controller::CGIBin;
 
-use strict;
-use warnings;
+use Moose;
+use mro 'c3';
+
+extends 'Catalyst::Controller::WrapCGI';
 
-use Class::C3;
-use URI::Escape;
 use File::Slurp 'slurp';
 use File::Find::Rule ();
 use Catalyst::Exception ();
@@ -13,8 +13,9 @@ use IPC::Open3;
 use Symbol 'gensym';
 use List::MoreUtils 'any';
 use IO::File ();
-
-use parent 'Catalyst::Controller::WrapCGI';
+use Carp;
+ 
+use namespace::clean -except => 'meta';
 
 =head1 NAME
 
@@ -22,11 +23,11 @@ Catalyst::Controller::CGIBin - Serve CGIs from root/cgi-bin
 
 =head1 VERSION
 
-Version 0.002
+Version 0.020
 
 =cut
 
-our $VERSION = '0.002';
+our $VERSION = '0.020';
 
 =head1 SYNOPSIS
 
@@ -36,15 +37,11 @@ In your controller:
 
     use parent qw/Catalyst::Controller::CGIBin/;
 
-    # example of a forward to /cgi-bin/hlagh/mtfnpy.cgi
-    sub dongs : Local Args(0) {
-        my ($self, $c) = @_;
-        $c->forward($self->cgi_action('hlagh/mtfnpy.cgi'));
-    }
-
 In your .conf:
 
     <Controller::Foo>
+        cgi_root_path cgi-bin
+        cgi_dir       cgi-bin
         <CGI>
             username_field username # used for REMOTE_USER env var
             pass_env PERL5LIB
@@ -58,25 +55,35 @@ In your .conf:
 Dispatches to CGI files in root/cgi-bin for /cgi-bin/ paths.
 
 Unlike L<ModPerl::Registry> this module does _NOT_ stat and recompile the CGI
-for every invocation. If this is something you need, let me know.
+for every invocation. This may be supported in the future if there's interest.
 
-CGI paths are converted into action names using cgi_action (below.)
-
-A path such as C<root/cgi-bin/hlagh/bar.cgi> will get the private path
-C<foo/CGI_hlagh_bar_cgi>, for controller Foo, with the C</>s converted to C<_>s
-and prepended with C<CGI_>, as well as all non-word characters converted to
-C<_>s. This is because L<Catalyst> action names can't have non-word characters
-in them.
+CGI paths are converted into action names using L</cgi_action>.
 
 Inherits from L<Catalyst::Controller::WrapCGI>, see the documentation for that
-module for configuration information.
+module for other configuration information.
+
+=head1 CONFIG PARAMS
+
+=head2 cgi_root_path
+
+The global URI path prefix for CGIs, defaults to C<cgi-bin>.
+
+=head2 cgi_dir
+
+Path from which to read CGI files. Can be relative to C<$MYAPP_HOME/root> or
+absolute.  Defaults to C<$MYAPP_HOME/root/cgi-bin>.
 
 =cut
 
+has cgi_root_path => (is => 'ro', isa => 'Str', default => 'cgi-bin');
+has cgi_dir       => (is => 'ro', isa => 'Str', default => 'cgi-bin');
+
 sub register_actions {
     my ($self, $app) = @_;
 
-    my $cgi_bin = $app->path_to('root', 'cgi-bin');
+    my $cgi_bin = File::Spec->file_name_is_absolute($self->cgi_dir) ?
+        $self->cgi_dir
+        : $app->path_to('root', $self->cgi_dir);
 
     my $namespace = $self->action_namespace($app);
 
@@ -86,25 +93,27 @@ sub register_actions {
         my $cgi_path = abs2rel($file, $cgi_bin);
 
         next if any { $_ eq '.svn' } splitdir $cgi_path;
+        next if $cgi_path =~ /\.swp\z/;
+
+        my $path        = join '/' => splitdir($cgi_path);
+        my $action_name = $self->cgi_action($path);
+        my $public_path = $self->cgi_path($path);
+        my $reverse     = $namespace ? "$namespace/$action_name" : $action_name;
+        my $attrs       = { Path => [ $public_path ] };
 
         my ($cgi, $type);
 
         if ($self->is_perl_cgi($file)) { # syntax check passed
             $type = 'Perl';
-            $cgi  = $self->wrap_perl_cgi($file);
+            $cgi  = $self->wrap_perl_cgi($file, $action_name);
         } else {
             $type = 'Non-Perl';
-            $cgi  = $self->wrap_nonperl_cgi($file);
+            $cgi  = $self->wrap_nonperl_cgi($file, $action_name);
         }
 
         $app->log->info("Registering root/cgi-bin/$cgi_path as a $type CGI.")
             if $app->debug;
 
-        my $path        = join '/' => splitdir($cgi_path);
-        my $action_name = $self->cgi_action($path);
-        my $reverse     = $namespace ? "$namespace/$action_name" : $action_name;
-        my $attrs       = { Path => [ "cgi-bin/$path" ], Args => [ 0 ] };
-
         my $code = sub {
             my ($controller, $context) = @_;
             $controller->cgi_to_response($context, $cgi)
@@ -123,36 +132,76 @@ sub register_actions {
     }
 
     $self->next::method($app, @_);
+
+# Tell Static::Simple to ignore cgi_dir
+    if ($cgi_bin =~ /^@{[ $app->path_to('root') ]}/) {
+        my $rel = File::Spec->abs2rel($cgi_bin, $app->path_to('root'));
+
+        if (!any { $_ eq $rel }
+                @{ $app->config->{static}{ignore_dirs}||[] }) {
+            push @{ $app->config->{static}{ignore_dirs} }, $rel;
+        }
+    }
 }
 
 =head1 METHODS
 
-=head2 $self->cgi_action($cgi_path)
+=head2 cgi_action
+
+C<< $self->cgi_action($cgi) >>
 
 Takes a path to a CGI from C<root/cgi-bin> such as C<foo/bar.cgi> and returns
 the action name it is registered as. See L</DESCRIPTION> for a discussion on how
 CGI actions are named.
 
+A path such as C<root/cgi-bin/hlagh/bar.cgi> will get the private path
+C<foo/CGI_hlagh__bar_cgi>, for controller Foo, with the C</>s converted to C<__>
+and prepended with C<CGI_>, as well as all non-word characters converted to
+C<_>s. This is because L<Catalyst> action names can't have non-word characters
+in them.
+
+This means that C<foo/bar.cgi> and C<foo__bar.cgi> for example will both map to
+the action C<CGI_foo__bar_cgi> so B<DON'T DO THAT>.
+
 =cut
 
 sub cgi_action {
     my ($self, $cgi) = @_;
 
-    my $action_name = 'CGI_' . join '_' => split '/' => $cgi;
+    my $action_name = 'CGI_' . join '__' => split '/' => $cgi;
     $action_name    =~ s/\W/_/g;
 
     $action_name
 }
 
-=head2 $self->is_perl_cgi($path)
+=head2 cgi_path
+
+C<< $self->cgi_path($cgi) >>
+
+Takes a path to a CGI from C<root/cgi-bin> such as C<foo/bar.cgi> and returns
+the public path it should be registered under.
+
+The default is to prefix with C<$cgi_root_path/>, using the C<cgi_root_path>
+config setting, above.
+
+=cut
+
+sub cgi_path {
+    my ($self, $cgi) = @_;
+
+    my $root = $self->cgi_root_path;
+    $root =~ s{/*$}{};
+    return "$root/$cgi";
+}
+
+=head2 is_perl_cgi
+
+C<< $self->is_perl_cgi($path) >>
 
 Tries to figure out whether the CGI is Perl or not.
 
 If it's Perl, it will be inlined into a sub instead of being forked off, see
-wrap_perl_cgi (below.)
-
-If it's not doing what you expect, you might want to override it, and let me
-know as well!
+L</wrap_perl_cgi>.
 
 =cut
 
@@ -173,31 +222,78 @@ sub is_perl_cgi {
     $? >> 8 == 0
 }
 
-=head2 $self->wrap_perl_cgi($path)
+=head2 wrap_perl_cgi
+
+C<< $self->wrap_perl_cgi($path, $action_name) >>
 
 Takes the path to a Perl CGI and returns a coderef suitable for passing to
 cgi_to_response (from L<Catalyst::Controller::WrapCGI>.)
 
-By default returns:
-
-    eval 'sub {' . slurp($path) . '}'
+C<$action_name> is the generated name for the action representing the CGI file
+from C<cgi_action>.
 
 This is similar to how L<ModPerl::Registry> works, but will only work for
 well-written CGIs. Otherwise, you may have to override this method to do
 something more involved (see L<ModPerl::PerlRun>.)
 
+Scripts with C<__DATA__> sections now work too, as well as scripts that call
+C<exit()>.
+
 =cut
 
 sub wrap_perl_cgi {
-    my ($self, $cgi) = @_;
-
-    do { no warnings; eval 'sub {' . slurp($cgi) . '}' }
+    my ($self, $cgi, $action_name) = @_;
+
+    my $code = slurp $cgi;
+
+    $code =~ s/^__DATA__(?:\r?\n|\r\n?)(.*)//ms;
+    my $data = $1;
+
+    my $coderef = do {
+        no warnings;
+        # catch exit() and turn it into (effectively) a return
+        # we *must* eval STRING because the code needs to be compiled with the
+        # overridden CORE::GLOBAL::exit in view
+        #
+        # set $0 to the name of the cgi file in case it's used there
+        eval ' 
+            my $cgi_exited = "EXIT\n";
+            BEGIN { *CORE::GLOBAL::exit = sub (;$) {
+                die [ $cgi_exited, $_[0] || 0 ];
+            } }
+            package Catalyst::Controller::CGIBin::_CGIs_::'.$action_name.';
+            sub {'
+                . 'local *DATA;'
+                . q{open DATA, '<', \$data;}
+                . qq{local \$0 = "\Q$cgi\E";}
+                . q/my $rv = eval {/
+                . $code
+                . q/};/
+                . q{
+                    return $rv unless $@;
+                    die $@ if $@ and not (
+                      ref($@) eq 'ARRAY' and
+                      $@->[0] eq $cgi_exited
+                    );
+                    die "exited nonzero: $@->[1]" if $@->[1] != 0;
+                    return $rv;
+                }
+         . '}';
+    };
+
+    croak __PACKAGE__ . ": Could not compile $cgi to coderef: $@" if $@;
+
+    $coderef
 }
 
-=head2 $self->wrap_nonperl_cgi($path)
+=head2 wrap_nonperl_cgi
+
+C<< $self->wrap_nonperl_cgi($path, $action_name) >>
 
 Takes the path to a non-Perl CGI and returns a coderef for executing it.
 
+C<$action_name> is the generated name for the action representing the CGI file.
+
 By default returns:
 
     sub { system $path }
@@ -205,11 +301,13 @@ By default returns:
 =cut
 
 sub wrap_nonperl_cgi {
-    my ($self, $cgi) = @_;
+    my ($self, $cgi, $action_name) = @_;
 
     sub { system $cgi }
 }
 
+__PACKAGE__->meta->make_immutable;
+
 =head1 SEE ALSO
 
 L<Catalyst::Controller::WrapCGI>, L<CatalystX::GlobalContext>,
@@ -219,6 +317,10 @@ L<Catalyst::Controller>, L<CGI>, L<Catalyst>
 
 Rafael Kitover, C<< <rkitover at cpan.org> >>
 
+=head1 CONTRIBUTORS
+
+Hans Dieter Pearcey, C<< <hdp at cpan.org> >>
+
 =head1 BUGS
 
 Please report any bugs or feature requests to C<bug-catalyst-controller-wrapcgi at