X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FCatalyst%2FController%2FCGIBin.pm;h=48eaae086698303263630bf72f76de4a4824f277;hb=2e6f9c85d869a3fd48134c5990ed654ad272fd12;hp=773d52e48f061cc376a8d7a7e61cdbffddf6195f;hpb=fbaba9ddb929f1437ddaec1f24019f38beb99c75;p=catagits%2FCatalyst-Controller-WrapCGI.git diff --git a/lib/Catalyst/Controller/CGIBin.pm b/lib/Catalyst/Controller/CGIBin.pm index 773d52e..48eaae0 100644 --- a/lib/Catalyst/Controller/CGIBin.pm +++ b/lib/Catalyst/Controller/CGIBin.pm @@ -1,10 +1,10 @@ package Catalyst::Controller::CGIBin; -use strict; -use warnings; - -use MRO::Compat; +use Moose; use mro 'c3'; + +extends 'Catalyst::Controller::WrapCGI'; + use File::Slurp 'slurp'; use File::Find::Rule (); use Catalyst::Exception (); @@ -14,21 +14,20 @@ use Symbol 'gensym'; use List::MoreUtils 'any'; use IO::File (); use Carp; + use namespace::clean -except => 'meta'; -use parent 'Catalyst::Controller::WrapCGI'; - =head1 NAME Catalyst::Controller::CGIBin - Serve CGIs from root/cgi-bin =head1 VERSION -Version 0.007 +Version 0.020 =cut -our $VERSION = '0.007'; +our $VERSION = '0.020'; =head1 SYNOPSIS @@ -38,15 +37,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 @@ -60,19 +55,35 @@ In your .conf: Dispatches to CGI files in root/cgi-bin for /cgi-bin/ paths. Unlike L this module does _NOT_ stat and recompile the CGI -for every invocation. If this is something you need, let me know. +for every invocation. This may be supported in the future if there's interest. -CGI paths are converted into action names using cgi_action (below.) +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 $cgi_bin = $app->path_to('root', 'cgi-bin'); + 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); @@ -82,12 +93,13 @@ sub register_actions { 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 ], Args => [ 0 ] }; + my $attrs = { Path => [ $public_path ] }; my ($cgi, $type); @@ -121,15 +133,22 @@ sub register_actions { $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'; +# 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) +=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. See L for a discussion on how @@ -155,29 +174,34 @@ sub cgi_action { $action_name } -=head2 $self->cgi_path($cgi) +=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 C. +The default is to prefix with C<$cgi_root_path/>, using the C +config setting, above. =cut sub cgi_path { my ($self, $cgi) = @_; - return "cgi-bin/$cgi"; + + my $root = $self->cgi_root_path; + $root =~ s{/*$}{}; + return "$root/$cgi"; } -=head2 $self->is_perl_cgi($path) +=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 -wrap_perl_cgi (below.) - -If it's not doing what you expect, you might want to override it, and let me -know as well! +L. =cut @@ -198,7 +222,9 @@ sub is_perl_cgi { $? >> 8 == 0 } -=head2 $self->wrap_perl_cgi($path, $action_name) +=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.) @@ -210,7 +236,8 @@ 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. +Scripts with C<__DATA__> sections now work too, as well as scripts that call +C. =cut @@ -259,7 +286,9 @@ sub wrap_perl_cgi { $coderef } -=head2 $self->wrap_nonperl_cgi($path, $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. @@ -277,6 +306,8 @@ sub wrap_nonperl_cgi { sub { system $cgi } } +__PACKAGE__->meta->make_immutable; + =head1 SEE ALSO L, L, @@ -286,6 +317,10 @@ L, L, L Rafael Kitover, C<< >> +=head1 CONTRIBUTORS + +Hans Dieter Pearcey, C<< >> + =head1 BUGS Please report any bugs or feature requests to C