use strict;
use warnings;
-use Class::C3;
-use URI::Escape;
+use MRO::Compat;
+use mro 'c3';
use File::Slurp 'slurp';
use File::Find::Rule ();
use Catalyst::Exception ();
use Symbol 'gensym';
use List::MoreUtils 'any';
use IO::File ();
+use Carp;
+use namespace::clean -except => 'meta';
use parent 'Catalyst::Controller::WrapCGI';
=head1 VERSION
-Version 0.001
+Version 0.007
=cut
-our $VERSION = '0.001';
+our $VERSION = '0.007';
=head1 SYNOPSIS
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.
-
Inherits from L<Catalyst::Controller::WrapCGI>, see the documentation for that
module for configuration information.
next if any { $_ eq '.svn' } splitdir $cgi_path;
+ 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 ], Args => [ 0 ] };
+
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)
}
$self->next::method($app, @_);
+
+# Tell Static::Simple to ignore the cgi-bin dir.
+ if (!any{ $_ eq 'cgi-bin' } @{ $app->config->{static}{ignore_dirs}||[] }) {
+ push @{ $app->config->{static}{ignore_dirs} }, 'cgi-bin';
+ }
}
=head1 METHODS
-=head2 $self->cgi_action($cgi_path)
+=head2 $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->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 C<cgi-bin/$cgi>.
+
+=cut
+
+sub cgi_path {
+ my ($self, $cgi) = @_;
+ return "cgi-bin/$cgi";
+}
+
=head2 $self->is_perl_cgi($path)
Tries to figure out whether the CGI is Perl or not.
my $shebang = IO::File->new($cgi)->getline;
- return 0 if $shebang !~ /perl/ || $cgi !~ /\.pl\z/;
+ return 0 if $shebang !~ /perl/ && $cgi !~ /\.pl\z/;
my $taint_check = $shebang =~ /-T/ ? '-T' : '';
$? >> 8 == 0
}
-=head2 $self->wrap_perl_cgi($path)
+=head2 $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.
+
=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 $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 }
=cut
sub wrap_nonperl_cgi {
- my ($self, $cgi) = @_;
+ my ($self, $cgi, $action_name) = @_;
sub { system $cgi }
}
projects / catagits/Catalyst-Controller-WrapCGI.git / blobdiff