X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FCatalyst%2FController%2FCGIBin.pm;h=d1760a711481553386be1f42be8ded5fab95754e;hb=5464705b4645ee3f5c5694cbc8e1d9e8f12da983;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..d1760a7 100644 --- a/lib/Catalyst/Controller/CGIBin.pm +++ b/lib/Catalyst/Controller/CGIBin.pm @@ -1,17 +1,22 @@ 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 Cwd; use Catalyst::Exception (); -use File::Spec::Functions 'splitdir'; - -use parent 'Catalyst::Controller::WrapCGI'; +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 namespace::clean -except => 'meta'; =head1 NAME @@ -19,11 +24,11 @@ Catalyst::Controller::CGIBin - Serve CGIs from root/cgi-bin =head1 VERSION -Version 0.001 +Version 0.022 =cut -our $VERSION = '0.001'; +our $VERSION = '0.022'; =head1 SYNOPSIS @@ -33,15 +38,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: + cgi_root_path cgi-bin + cgi_dir cgi-bin username_field username # used for REMOTE_USER env var pass_env PERL5LIB @@ -52,59 +53,69 @@ 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_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 $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 = 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); my $class = ref $self || $self; - for my $file (File::Find::Rule->executable->file->in(".")) { + for my $file (File::Find::Rule->file->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 $public_path = $self->cgi_path($path); + my $reverse = $namespace ? "$namespace/$action_name" : $action_name; + my $attrs = { Path => [ $public_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,32 +132,211 @@ 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. +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. =cut sub cgi_action { my ($self, $cgi) = @_; - my $action_name = 'CGI_' . join '_' => splitdir($cgi); + my $action_name = 'CGI_' . join '__' => split '/' => $cgi; $action_name =~ s/\W/_/g; $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. -Rafael Kitover, C<< >> +=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 +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.) + +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) = @_; + + my $code = slurp $cgi; + + $code =~ s/^__DATA__\n(.*)//ms; + my $data = $1; + + my $orig_exit = \*CORE::GLOBAL::exit; + my $orig_die = $SIG{__DIE__}; + my $orig_warn = $SIG{__WARN__}; + + 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 = "\Q$cgi\E";}."\n" + . q/my $rv = eval {/."\n" + . 'local $SIG{__DIE__} = $SIG{__DIE__} || sub { die @_ };'."\n" + . 'local $SIG{__WARN__} = $SIG{__WARN__} || sub { warn @_ };'."\n" + . $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; + } + . '}'; + eval $source; + }; + + # clean up + *CORE::GLOBAL::exit = $orig_exit; + $SIG{__DIE__} = $orig_die; + $SIG{__WARN__} = $orig_warn; + + croak __PACKAGE__ . ": Could not compile $cgi to coderef: $@" if $@; + + return $coderef +} + +=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 } + +=cut + +sub wrap_nonperl_cgi { + my ($self, $cgi, $action_name) = @_; + + sub { system $cgi } +} + +__PACKAGE__->meta->make_immutable; + +=head1 SEE ALSO + +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.