package Catalyst::Controller::CGIBin;
use Moose;
+use Moose::Util::TypeConstraints;
use mro 'c3';
extends 'Catalyst::Controller::WrapCGI';
-use File::Slurp 'slurp';
use File::Find::Rule ();
-use Catalyst::Exception ();
use File::Spec::Functions qw/splitdir abs2rel/;
use IPC::Open3;
use Symbol 'gensym';
use IO::File ();
use File::Temp 'tempfile';
use File::pushd;
-#use CGI::Compile;
-
+use CGI::Compile;
+
use namespace::clean -except => 'meta';
=head1 NAME
Catalyst::Controller::CGIBin - Serve CGIs from root/cgi-bin
-=head1 VERSION
-
-Version 0.024
-
=cut
-our $VERSION = '0.024';
+our $VERSION = '0.031';
=head1 SYNOPSIS
In your .conf:
<Controller::Foo>
- cgi_root_path cgi-bin
- cgi_dir cgi-bin
+ cgi_root_path cgi-bin
+ cgi_dir cgi-bin
+ cgi_chain_root /optional/private/path/to/Chained/root
+ cgi_file_pattern *.cgi
+ # or regex
+ cgi_file_pattern /\.pl\z/
<CGI>
username_field username # used for REMOTE_USER env var
pass_env PERL5LIB
The global URI path prefix for CGIs, defaults to C<cgi-bin>.
+=head2 cgi_chain_root
+
+By default L<Path|Catalyst::DispatchType::Path> actions are created for CGIs,
+but if you specify this option, the actions will be created as
+L<Chained|Catalyst::DispatchType::Chained> end-points, chaining off the
+specified private path.
+
+If this option is used, the L</cgi_root_path> option is ignored. The root path
+will be determined by your chain.
+
+The L<PathPart|Catalyst::DispatchType::Chained/PathPart> of the action will be
+the path to the CGI file.
+
=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>.
+=head2 cgi_file_pattern
+
+By default all files in L</cgi_dir> will be loaded as CGIs, however, with this
+option you can specify either a glob or a regex to match the names of files you
+want to be loaded.
+
+Can be an array of globs/regexes as well.
+
=cut
-has cgi_root_path => (is => 'ro', isa => 'Str', default => 'cgi-bin');
-has cgi_dir => (is => 'ro', isa => 'Str', default => 'cgi-bin');
+{ my $stringified = subtype as 'Str';
+ coerce $stringified,
+ from 'Object',
+ via { "$_" };
+
+ has cgi_root_path => (is => 'ro', coerce => 1, isa => $stringified, default => 'cgi-bin' );
+ has cgi_chain_root => (is => 'ro', isa => 'Str');
+ has cgi_dir => (is => 'ro', coerce => 1, isa => $stringified, default => 'cgi-bin');
+ has cgi_file_pattern => (is => 'rw', default => sub { ['*'] });
+
+}
sub register_actions {
my ($self, $app) = @_;
- my $cgi_bin = File::Spec->file_name_is_absolute($self->cgi_dir) ?
- $self->cgi_dir
- : $app->path_to('root', $self->cgi_dir);
+ my $cgi_bin;
+ if( File::Spec->file_name_is_absolute($self->cgi_dir) ) {
+ $cgi_bin = $self->cgi_dir;
+ } elsif( File::Spec->file_name_is_absolute( $app->config->{root} ) ) {
+ $cgi_bin = File::Spec->catdir( $app->config->{root}, $self->cgi_dir );
+ } else {
+ $cgi_bin = $app->path_to( $app->config->{root}, $self->cgi_dir);
+ }
my $namespace = $self->action_namespace($app);
my $class = ref $self || $self;
- for my $file (File::Find::Rule->file->in($cgi_bin)) {
+ my $patterns = $self->cgi_file_pattern;
+ $patterns = [ $patterns ] if not ref $patterns;
+ for my $pat (@$patterns) {
+ if ($pat =~ m{^/(.*)/\z}) {
+ $pat = qr/$1/;
+ }
+ }
+ $self->cgi_file_pattern($patterns);
+
+ for my $file (File::Find::Rule->file->name(@$patterns)->in($cgi_bin)) {
my $cgi_path = abs2rel($file, $cgi_bin);
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 ] };
+
+ my $attrs = do {
+ if (my $chain_root = $self->cgi_chain_root) {
+ { Chained => [ $chain_root ], PathPart => [ $path ], Args => [] };
+ }
+ else {
+ { Path => [ $self->cgi_path($path) ] };
+ }
+ };
my ($cgi, $type);
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>.)
+cgi_to_response (from L<Catalyst::Controller::WrapCGI>) using L<CGI::Compile>.
C<$action_name> is the generated name for the action representing the CGI file
from C<cgi_action>.
sub wrap_perl_cgi {
my ($self, $cgi, $action_name) = @_;
- my $code = slurp $cgi;
- my $dir = File::Basename::dirname($cgi);
-
- $code =~ s/^__DATA__\n(.*)//ms;
- my $data = $1;
-
- my $orig_exit = \*CORE::GLOBAL::exit;
- my %orig_sig = %SIG;
-
- 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
- my $source = '
- my $cgi_exited = "EXIT\n";
- BEGIN { *CORE::GLOBAL::exit = sub (;$) {
- die [ $cgi_exited, $_[0] || 0 ];
- } }
- package Catalyst::Controller::CGIBin::_CGIs_::'.$action_name.';
- sub {'."\n"
- . 'local *DATA;'."\n"
- . q{open DATA, '<', \$data;}."\n"
- . qq{local \$0 = '$cgi';}."\n"
- . "my \$_dir = File::pushd::pushd '$dir';"."\n"
- . "CGI::initialize_globals() "."\n"
- . " if defined &CGI::initialize_globals;"."\n"
- . q/my $rv = eval {/."\n"
- . 'local %SIG;'."\n"
- . "#line 1 $cgi"."\n"
- . $code."\n"
- . 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;
- }
- . '}';
- eval $source;
- };
-
- # clean up
- *CORE::GLOBAL::exit = $orig_exit;
- %SIG = %orig_sig;
-
- die "Could not compile $cgi to coderef: $@" if $@;
-
- return $coderef;
+ return CGI::Compile->compile($cgi,
+ "Catalyst::Controller::CGIBin::_CGIs_::$action_name");
}
-# Once CGI::Compile is updated, we can use this:
-
-#sub wrap_perl_cgi {
-# my ($self, $cgi, $action_name) = @_;
-#
-# return CGI::Compile->compile($cgi,
-# "Catalyst::Controller::CGIBin::_CGIs_::$action_name");
-#}
-
=head2 wrap_nonperl_cgi
C<< $self->wrap_nonperl_cgi($path, $action_name) >>
C<$action_name> is the generated name for the action representing the CGI file.
-By default returns:
+By default returns something like:
sub { system $path }
sub wrap_nonperl_cgi {
my ($self, $cgi, $action_name) = @_;
- sub { system $cgi }
+ return sub {
+ system $cgi;
+
+ if ($? == -1) {
+ die "failed to execute CGI '$cgi': $!";
+ }
+ elsif ($? & 127) {
+ die sprintf "CGI '$cgi' died with signal %d, %s coredump",
+ ($? & 127), ($? & 128) ? 'with' : 'without';
+ }
+ else {
+ my $exit_code = $? >> 8;
+
+ return 0 if $exit_code == 0;
+
+ die "CGI '$cgi' exited non-zero with: $exit_code";
+ }
+ };
}
__PACKAGE__->meta->make_immutable;
=cut
1; # End of Catalyst::Controller::CGIBin
-
-# vim: expandtab shiftwidth=4 ts=4 tw=80:
+# vim:et sw=4 sts=4 tw=0:
projects / catagits/Catalyst-Controller-WrapCGI.git / blobdiff