X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FCatalyst%2FController%2FCGIBin.pm;h=20755aa430a18584bdeeda314183b075232d5543;hb=d501f45e86dabe1c138f0c145f955607e7f2a488;hp=e0ca62c1c84ffe5ad74e74bac107c1b3db78e33a;hpb=63283669a7954f748cbf54305094f2570390f325;p=catagits%2FCatalyst-Controller-WrapCGI.git diff --git a/lib/Catalyst/Controller/CGIBin.pm b/lib/Catalyst/Controller/CGIBin.pm index e0ca62c..20755aa 100644 --- a/lib/Catalyst/Controller/CGIBin.pm +++ b/lib/Catalyst/Controller/CGIBin.pm @@ -5,15 +5,15 @@ 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 List::MoreUtils 'any'; use IO::File (); -use Carp; +use File::Temp 'tempfile'; +use File::pushd; +use CGI::Compile; use namespace::clean -except => 'meta'; @@ -21,13 +21,9 @@ use namespace::clean -except => 'meta'; Catalyst::Controller::CGIBin - Serve CGIs from root/cgi-bin -=head1 VERSION - -Version 0.018 - =cut -our $VERSION = '0.018'; +our $VERSION = '0.030'; =head1 SYNOPSIS @@ -40,8 +36,12 @@ In your controller: In your .conf: - 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/ username_field username # used for REMOTE_USER env var pass_env PERL5LIB @@ -68,28 +68,65 @@ module for other configuration information. The global URI path prefix for CGIs, defaults to C. +=head2 cgi_chain_root + +By default L actions are created for CGIs, +but if you specify this option, the actions will be created as +L end-points, chaining off the +specified private path. + +If this option is used, the L option is ignored. The root path +will be determined by your chain. + +The L 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 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'); +has cgi_root_path => (is => 'ro', isa => 'Str', default => 'cgi-bin'); +has cgi_chain_root => (is => 'ro', isa => 'Str'); +has cgi_dir => (is => 'ro', isa => 'Str', 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; @@ -97,9 +134,16 @@ sub register_actions { 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); @@ -151,27 +195,17 @@ sub register_actions { C<< $self->cgi_action($cgi) >> Takes a path to a CGI from C such as C and returns -the action name it is registered as. See L for a discussion on how -CGI actions are named. - -A path such as C will get the private path -C, for controller Foo, with the Cs converted to C<__> -and prepended with C, as well as all non-word characters converted to -C<_>s. This is because L action names can't have non-word characters -in them. - -This means that C and C for example will both map to -the action C so B. +the action name it is registered as. =cut sub cgi_action { my ($self, $cgi) = @_; - my $action_name = 'CGI_' . join '__' => split '/' => $cgi; - $action_name =~ s/\W/_/g; + my $action_name = 'CGI_' . $cgi; + $action_name =~ s/([^A-Za-z0-9_])/sprintf("_%2x", unpack("C", $1))/eg; - $action_name + return $action_name; } =head2 cgi_path @@ -208,18 +242,30 @@ L. sub is_perl_cgi { my ($self, $cgi) = @_; - my $shebang = IO::File->new($cgi)->getline; + my (undef, $tempfile) = tempfile; - return 0 if $shebang !~ /perl/ && $cgi !~ /\.pl\z/; + my $pid = fork; + die "Cannot fork: $!" unless defined $pid; - my $taint_check = $shebang =~ /-T/ ? '-T' : ''; + if ($pid) { + waitpid $pid, 0; + my $errors = IO::File->new($tempfile)->getline; + unlink $tempfile; + return $errors ? 0 : 1; + } + # child + local *NULL; open NULL, '>', File::Spec->devnull; - my $pid = open3(gensym, '&>NULL', '&>NULL', "$^X $taint_check -c $cgi"); - close NULL; - waitpid $pid, 0; + open STDOUT, '>&', \*NULL; + open STDERR, '>&', \*NULL; + close STDIN; - $? >> 8 == 0 + eval { $self->wrap_perl_cgi($cgi, '__DUMMY__') }; + + IO::File->new(">$tempfile")->print($@); + + exit; } =head2 wrap_perl_cgi @@ -227,7 +273,7 @@ sub is_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.) +cgi_to_response (from L) using L. C<$action_name> is the generated name for the action representing the CGI file from C. @@ -244,46 +290,8 @@ C. sub wrap_perl_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 + return CGI::Compile->compile($cgi, + "Catalyst::Controller::CGIBin::_CGIs_::$action_name"); } =head2 wrap_nonperl_cgi @@ -294,7 +302,7 @@ 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: +By default returns something like: sub { system $path } @@ -303,7 +311,24 @@ By default returns: 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; @@ -311,13 +336,7 @@ __PACKAGE__->meta->make_immutable; =head1 SEE ALSO L, L, -L, L, L - -=head1 AUTHORS - -Rafael Kitover, C<< >> - -Hans Dieter Pearcey, C<< >> +L, L, L, L =head1 BUGS @@ -351,9 +370,15 @@ L =back +=head1 AUTHOR + +See L and +L. + =head1 COPYRIGHT & LICENSE -Copyright (c) 2008 Rafael Kitover +Copyright (c) 2008-2009 L and +L. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself. @@ -361,5 +386,4 @@ under the same terms as Perl itself. =cut 1; # End of Catalyst::Controller::CGIBin - -# vim: expandtab shiftwidth=4 ts=4 tw=80: +# vim:et sw=4 sts=4 tw=0: