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=a73be05424caf1bbc3714eb65db3b2a105ed54c8;hpb=ee75330f0e7b909f7c80f3d4c0dea33f6af392ee;p=catagits%2FCatalyst-Controller-WrapCGI.git diff --git a/lib/Catalyst/Controller/CGIBin.pm b/lib/Catalyst/Controller/CGIBin.pm index a73be05..20755aa 100644 --- a/lib/Catalyst/Controller/CGIBin.pm +++ b/lib/Catalyst/Controller/CGIBin.pm @@ -1,29 +1,29 @@ package Catalyst::Controller::CGIBin; -use strict; -use warnings; +use Moose; +use mro 'c3'; -use Class::C3; -use URI::Escape; -use File::Slurp 'slurp'; -use File::Find::Rule (); -use Cwd; -use Catalyst::Exception (); -use File::Spec::Functions 'splitdir'; +extends 'Catalyst::Controller::WrapCGI'; -use parent 'Catalyst::Controller::WrapCGI'; +use File::Find::Rule (); +use File::Spec::Functions qw/splitdir abs2rel/; +use IPC::Open3; +use Symbol 'gensym'; +use List::MoreUtils 'any'; +use IO::File (); +use File::Temp 'tempfile'; +use File::pushd; +use CGI::Compile; + +use namespace::clean -except => 'meta'; =head1 NAME Catalyst::Controller::CGIBin - Serve CGIs from root/cgi-bin -=head1 VERSION - -Version 0.001 - =cut -our $VERSION = '0.001'; +our $VERSION = '0.030'; =head1 SYNOPSIS @@ -33,15 +33,15 @@ 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: + 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 @@ -52,59 +52,113 @@ In your .conf: =head1 DESCRIPTION -Dispatches to executable CGI files in root/cgi-bin for /cgi-bin/ paths. +Dispatches to CGI files in root/cgi-bin for /cgi-bin/ paths. -CGI paths are converted into action names using cgi_action (below.) +Unlike L this module does _NOT_ stat and recompile the CGI +for every invocation. This may be supported in the future if there's interest. -A path such as C will get the private path -C, for controller Foo, with the Cs converted to C<_>s -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. +CGI paths are converted into action names using L. Inherits from L, 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. + +=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_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 $cwd = getcwd; - - my $cgi_bin = $app->path_to('root', 'cgi-bin'); - - chdir $cgi_bin || - Catalyst::Exception->throw( - message => 'You have no root/cgi-bin directory' - ); + 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->executable->file->in(".")) { + 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; + next if $cgi_path =~ /\.swp\z/; + + my $path = join '/' => splitdir($cgi_path); + my $action_name = $self->cgi_action($path); + my $reverse = $namespace ? "$namespace/$action_name" : $action_name; + + 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); - my $code = do { no warnings; eval 'sub { '.slurp($file).' }' }; - if (!$@) { - $cgi = $code; + if ($self->is_perl_cgi($file)) { # syntax check passed $type = 'Perl'; + $cgi = $self->wrap_perl_cgi($file, $action_name); } else { - $cgi = sub { system "$cgi_bin/$file" }; $type = 'Non-Perl'; - undef $@; + $cgi = $self->wrap_nonperl_cgi($file, $action_name); } - $app->log->info("Registering root/cgi_bin/$file as a $type CGI.") + $app->log->info("Registering root/cgi-bin/$cgi_path as a $type CGI.") if $app->debug; - my $action_name = $self->cgi_action($file); - my $path = join '/' => splitdir($file); - my $reverse = $namespace ? "$namespace/$action_name" : $action_name; - my $attrs = { Path => [ "cgi-bin/$path" ], Args => [ 0 ] }; - - $code = sub { + my $code = sub { my ($controller, $context) = @_; $controller->cgi_to_response($context, $cgi) }; @@ -121,14 +175,24 @@ sub register_actions { $app->dispatcher->register($app, $action); } - chdir $cwd; - $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 such as C and returns the action name it is registered as. @@ -138,15 +202,141 @@ the action name it is registered as. sub cgi_action { my ($self, $cgi) = @_; - my $action_name = 'CGI_' . join '_' => splitdir($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; } -=head1 AUTHOR +=head2 cgi_path + +C<< $self->cgi_path($cgi) >> + +Takes a path to a CGI from C such as C and returns +the public path it should be registered under. + +The default is to prefix with C<$cgi_root_path/>, using the C +config setting, above. + +=cut + +sub cgi_path { + my ($self, $cgi) = @_; + + my $root = $self->cgi_root_path; + $root =~ s{/*$}{}; + return "$root/$cgi"; +} -Rafael Kitover, C<< >> +=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 +L. + +=cut + +sub is_perl_cgi { + my ($self, $cgi) = @_; + + my (undef, $tempfile) = tempfile; + + my $pid = fork; + die "Cannot fork: $!" unless defined $pid; + + 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; + open STDOUT, '>&', \*NULL; + open STDERR, '>&', \*NULL; + close STDIN; + + eval { $self->wrap_perl_cgi($cgi, '__DUMMY__') }; + + IO::File->new(">$tempfile")->print($@); + + exit; +} + +=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) using L. + +C<$action_name> is the generated name for the action representing the CGI file +from C. + +This is similar to how L works, but will only work for +well-written CGIs. Otherwise, you may have to override this method to do +something more involved (see L.) + +Scripts with C<__DATA__> sections now work too, as well as scripts that call +C. + +=cut + +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) >> + +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 something like: + + sub { system $path } + +=cut + +sub wrap_nonperl_cgi { + my ($self, $cgi, $action_name) = @_; + + 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; + +=head1 SEE ALSO + +L, L, +L, L, L, L =head1 BUGS @@ -180,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. @@ -190,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: