Revision history for Catalyst-Controller-WrapCGI
- - configurable cgi_dir
- - support for PATH_INFO
+0.0030 2009-04-27 05:17:17
+ - configurable cgi_dir (caelum)
+ - support for PATH_INFO and SCRIPT_NAME (caelum)
+ - FILEPATH_INFO (iffy implementation) (caelum)
0.0029 2009-04-26 20:54:28
- Allow more control over public paths to CGIBin actions (hdp)
requires 'Catalyst' => '5.7007';
requires 'parent';
requires 'Task::Weaken';
-requires 'HTTP::Request::AsCGI';
+requires 'HTTP::Request::AsCGI' => '0.7';;
requires 'URI';
requires 'File::Find::Rule';
requires 'List::MoreUtils';
use List::MoreUtils 'any';
use IO::File ();
use Carp;
+
use namespace::clean -except => 'meta';
=head1 NAME
=head1 VERSION
-Version 0.008
+Version 0.009
=cut
-our $VERSION = '0.008';
+our $VERSION = '0.009';
=head1 SYNOPSIS
<Controller::Foo>
cgi_root_path cgi-bin
+ cgi_dir cgi-bin
<CGI>
username_field username # used for REMOTE_USER env var
pass_env PERL5LIB
Dispatches to CGI files in root/cgi-bin for /cgi-bin/ paths.
Unlike L<ModPerl::Registry> 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</cgi_action>.
Inherits from L<Catalyst::Controller::WrapCGI>, 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<cgi-bin/>.
+
+=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);
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);
$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<root/cgi-bin> such as C<foo/bar.cgi> and returns
the action name it is registered as. See L</DESCRIPTION> for a discussion on how
$action_name
}
-=head2 $self->cgi_path($cgi)
+=head2 cgi_path
+
+C<<$self->cgi_path($cgi)>>
Takes a path to a CGI from C<root/cgi-bin> such as C<foo/bar.cgi> and returns
the public path it should be registered under.
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</wrap_perl_cgi>.
=cut
$? >> 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<Catalyst::Controller::WrapCGI>.)
well-written CGIs. Otherwise, you may have to override this method to do
something more involved (see L<ModPerl::PerlRun>.)
-Scripts with C<__DATA__> sections now work too.
+Scripts with C<__DATA__> sections now work too, as well as scripts that call
+C<exit()>.
=cut
$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.
sub { system $cgi }
}
+__PACKAGE__->meta->make_immutable;
+
=head1 SEE ALSO
L<Catalyst::Controller::WrapCGI>, L<CatalystX::GlobalContext>,
use HTTP::Request ();
use URI ();
use Catalyst::Exception ();
+use URI::Escape;
+
+use namespace::clean -except => 'meta';
=head1 NAME
=head1 METHODS
-=head2 $self->cgi_to_response($c, $coderef)
+=head2 cgi_to_response
+
+C<<$self->cgi_to_response($c, $coderef)>>
Does the magic of running $coderef in a CGI environment, and populating the
appropriate parts of your Catalyst context with the results.
-Calls wrap_cgi (below.)
+Calls L</wrap_cgi>.
=cut
$c->res->headers($res->headers);
}
-=head2 $self->wrap_cgi($c, $coderef)
+=head2 wrap_cgi
+
+C<<$self->wrap_cgi($c, $coderef)>>
Runs $coderef in a CGI environment using L<HTTP::Request::AsCGI>, returns an
L<HTTP::Response>.
Controller, see L</SYNOPSIS> for an example. If you don't supply a list of
environment variables to pass, the whole of %ENV is used.
-Used by cgi_to_response (above), which is probably what you want to use as well.
+Used by L</cgi_to_response>, which is probably what you want to use as well.
=cut
? eval { $c->user->obj->$username_field }
: '');
- my $path_info = '/'.join '/' => @{ $c->req->args };
+ my $path_info = '/'.join '/' => map uri_escape_utf8($_), @{ $c->req->args };
my $env = HTTP::Request::AsCGI->new(
$req,
($username ? (REMOTE_USER => $username) : ()),
%$filtered_env,
- PATH_INFO => $path_info
+ PATH_INFO => $path_info,
+ FILEPATH_INFO => '/'.$c->action.$path_info, # eww
+ SCRIPT_NAME => $c->uri_for($c->action)->path
);
{
return { map {; $_ => $env->{$_} } @ok };
}
+__PACKAGE__->meta->make_immutable;
=head1 ACKNOWLEDGEMENTS
use FindBin '$Bin';
use lib "$Bin/lib";
-use Test::More tests => 7;
+use Test::More tests => 8;
use Catalyst::Test 'TestCGIBin';
use HTTP::Request::Common;
is($response->content, "testing\n",
'scripts with __DATA__ sections work');
+$response = request '/my-bin/pathinfo.pl/path/info';
+is($response->content, '/path/info',
+ 'PATH_INFO works');
+
SKIP: {
skip "Can't run shell scripts on non-*nix", 1
if $^O eq 'MSWin32' || $^O eq 'VMS';
use Catalyst::Test 'TestCGIBinRoot';
use HTTP::Request::Common;
-# test default root of "cgi-bin"
+# Test configurable path root and dir
-my $response = request POST '/cgi-bin/path/test.pl', [
+my $response = request POST '/cgi/path/test.pl', [
foo => 'bar',
bar => 'baz'
];
});
}
+sub test_filepath_info : Path('/cgi-bin/test_filepathinfo.cgi') {
+ my ($self, $c) = @_;
+
+ $self->cgi_to_response($c, sub {
+ my $cgi = CGI->new;
+ print $cgi->header;
+ print $ENV{FILEPATH_INFO}
+ });
+}
+
+sub test_script_name : Path('/cgi-bin/test_scriptname.cgi') {
+ my ($self, $c) = @_;
+
+ $self->cgi_to_response($c, sub {
+ my $cgi = CGI->new;
+ print $cgi->header;
+ print $ENV{SCRIPT_NAME}
+ });
+}
+
1;
--- /dev/null
+#!/usr/bin/perl
+
+use strict;
+use warnings;
+
+use CGI ':standard';
+
+print header;
+print $ENV{PATH_INFO};
use Catalyst::Runtime '5.70';
use parent 'Catalyst';
+__PACKAGE__->config({
+ Controller::CGIHandler => {
+ cgi_root_path => 'cgi',
+ cgi_dir => 'cgi'
+ }
+});
+
__PACKAGE__->setup(qw/Static::Simple/);
1;
use FindBin '$Bin';
use lib "$Bin/lib";
-use Test::More tests => 2;
+use Test::More tests => 4;
use Catalyst::Test 'TestApp';
use HTTP::Request::Common;
is($response->content, 'foo:bar bar:baz', 'POST to CGI');
-$response = request '/cgi-bin/test_pathinfo.cgi/path/info';
+$response = request '/cgi-bin/test_pathinfo.cgi/path/%2Finfo';
+is($response->content, '/path//info', 'PATH_INFO is correct');
-is($response->content, '/path/info', 'PATH_INFO is correct');
+$response = request '/cgi-bin/test_filepathinfo.cgi/path/%2Finfo';
+is($response->content, '/test_filepath_info/path//info',
+ 'FILEPATH_INFO is correct (maybe)');
+
+$response = request '/cgi-bin/test_scriptname.cgi/foo/bar';
+is($response->content, '/cgi-bin/test_scriptname.cgi',
+ 'SCRIPT_NAME is correct');
projects / catagits/Catalyst-Controller-WrapCGI.git / commitdiff