1 package Catalyst::Controller::CGIBin;
4 use Moose::Util::TypeConstraints;
7 extends 'Catalyst::Controller::WrapCGI';
9 use File::Find::Rule ();
10 use File::Spec::Functions qw/splitdir abs2rel/;
13 use List::MoreUtils 'any';
15 use File::Temp 'tempfile';
19 use namespace::clean -except => 'meta';
23 Catalyst::Controller::CGIBin - Serve CGIs from root/cgi-bin
27 our $VERSION = '0.030';
33 package MyApp::Controller::Foo;
35 use parent qw/Catalyst::Controller::CGIBin/;
42 cgi_chain_root /optional/private/path/to/Chained/root
43 cgi_file_pattern *.cgi
45 cgi_file_pattern /\.pl\z/
47 username_field username # used for REMOTE_USER env var
56 Dispatches to CGI files in root/cgi-bin for /cgi-bin/ paths.
58 Unlike L<ModPerl::Registry> this module does _NOT_ stat and recompile the CGI
59 for every invocation. This may be supported in the future if there's interest.
61 CGI paths are converted into action names using L</cgi_action>.
63 Inherits from L<Catalyst::Controller::WrapCGI>, see the documentation for that
64 module for other configuration information.
70 The global URI path prefix for CGIs, defaults to C<cgi-bin>.
74 By default L<Path|Catalyst::DispatchType::Path> actions are created for CGIs,
75 but if you specify this option, the actions will be created as
76 L<Chained|Catalyst::DispatchType::Chained> end-points, chaining off the
77 specified private path.
79 If this option is used, the L</cgi_root_path> option is ignored. The root path
80 will be determined by your chain.
82 The L<PathPart|Catalyst::DispatchType::Chained/PathPart> of the action will be
83 the path to the CGI file.
87 Path from which to read CGI files. Can be relative to C<$MYAPP_HOME/root> or
88 absolute. Defaults to C<$MYAPP_HOME/root/cgi-bin>.
90 =head2 cgi_file_pattern
92 By default all files in L</cgi_dir> will be loaded as CGIs, however, with this
93 option you can specify either a glob or a regex to match the names of files you
96 Can be an array of globs/regexes as well.
100 { my $stringified = subtype as 'Str';
105 has cgi_root_path => (is => 'ro', coerce => 1, isa => $stringified, default => 'cgi-bin' );
106 has cgi_chain_root => (is => 'ro', isa => 'Str');
107 has cgi_dir => (is => 'ro', coerce => 1, isa => $stringified, default => 'cgi-bin');
108 has cgi_file_pattern => (is => 'rw', default => sub { ['*'] });
112 sub register_actions {
113 my ($self, $app) = @_;
116 if( File::Spec->file_name_is_absolute($self->cgi_dir) ) {
117 $cgi_bin = $self->cgi_dir;
118 } elsif( File::Spec->file_name_is_absolute( $app->config->{root} ) ) {
119 $cgi_bin = File::Spec->catdir( $app->config->{root}, $self->cgi_dir );
121 $cgi_bin = $app->path_to( $app->config->{root}, $self->cgi_dir);
124 my $namespace = $self->action_namespace($app);
126 my $class = ref $self || $self;
128 my $patterns = $self->cgi_file_pattern;
129 $patterns = [ $patterns ] if not ref $patterns;
130 for my $pat (@$patterns) {
131 if ($pat =~ m{^/(.*)/\z}) {
135 $self->cgi_file_pattern($patterns);
137 for my $file (File::Find::Rule->file->name(@$patterns)->in($cgi_bin)) {
138 my $cgi_path = abs2rel($file, $cgi_bin);
140 next if any { $_ eq '.svn' } splitdir $cgi_path;
141 next if $cgi_path =~ /\.swp\z/;
143 my $path = join '/' => splitdir($cgi_path);
144 my $action_name = $self->cgi_action($path);
145 my $reverse = $namespace ? "$namespace/$action_name" : $action_name;
148 if (my $chain_root = $self->cgi_chain_root) {
149 { Chained => [ $chain_root ], PathPart => [ $path ], Args => [] };
152 { Path => [ $self->cgi_path($path) ] };
158 if ($self->is_perl_cgi($file)) { # syntax check passed
160 $cgi = $self->wrap_perl_cgi($file, $action_name);
163 $cgi = $self->wrap_nonperl_cgi($file, $action_name);
166 $app->log->info("Registering root/cgi-bin/$cgi_path as a $type CGI.")
170 my ($controller, $context) = @_;
171 $controller->cgi_to_response($context, $cgi)
174 my $action = $self->create_action(
175 name => $action_name,
178 namespace => $namespace,
183 $app->dispatcher->register($app, $action);
186 $self->next::method($app, @_);
188 # Tell Static::Simple to ignore cgi_dir
189 if ($cgi_bin =~ /^@{[ $app->path_to('root') ]}/) {
190 my $rel = File::Spec->abs2rel($cgi_bin, $app->path_to('root'));
192 if (!any { $_ eq $rel }
193 @{ $app->config->{static}{ignore_dirs}||[] }) {
194 push @{ $app->config->{static}{ignore_dirs} }, $rel;
203 C<< $self->cgi_action($cgi) >>
205 Takes a path to a CGI from C<root/cgi-bin> such as C<foo/bar.cgi> and returns
206 the action name it is registered as.
211 my ($self, $cgi) = @_;
213 my $action_name = 'CGI_' . $cgi;
214 $action_name =~ s/([^A-Za-z0-9_])/sprintf("_%2x", unpack("C", $1))/eg;
221 C<< $self->cgi_path($cgi) >>
223 Takes a path to a CGI from C<root/cgi-bin> such as C<foo/bar.cgi> and returns
224 the public path it should be registered under.
226 The default is to prefix with C<$cgi_root_path/>, using the C<cgi_root_path>
227 config setting, above.
232 my ($self, $cgi) = @_;
234 my $root = $self->cgi_root_path;
241 C<< $self->is_perl_cgi($path) >>
243 Tries to figure out whether the CGI is Perl or not.
245 If it's Perl, it will be inlined into a sub instead of being forked off, see
251 my ($self, $cgi) = @_;
253 my (undef, $tempfile) = tempfile;
256 die "Cannot fork: $!" unless defined $pid;
260 my $errors = IO::File->new($tempfile)->getline;
262 return $errors ? 0 : 1;
267 open NULL, '>', File::Spec->devnull;
268 open STDOUT, '>&', \*NULL;
269 open STDERR, '>&', \*NULL;
272 eval { $self->wrap_perl_cgi($cgi, '__DUMMY__') };
274 IO::File->new(">$tempfile")->print($@);
281 C<< $self->wrap_perl_cgi($path, $action_name) >>
283 Takes the path to a Perl CGI and returns a coderef suitable for passing to
284 cgi_to_response (from L<Catalyst::Controller::WrapCGI>) using L<CGI::Compile>.
286 C<$action_name> is the generated name for the action representing the CGI file
289 This is similar to how L<ModPerl::Registry> works, but will only work for
290 well-written CGIs. Otherwise, you may have to override this method to do
291 something more involved (see L<ModPerl::PerlRun>.)
293 Scripts with C<__DATA__> sections now work too, as well as scripts that call
299 my ($self, $cgi, $action_name) = @_;
301 return CGI::Compile->compile($cgi,
302 "Catalyst::Controller::CGIBin::_CGIs_::$action_name");
305 =head2 wrap_nonperl_cgi
307 C<< $self->wrap_nonperl_cgi($path, $action_name) >>
309 Takes the path to a non-Perl CGI and returns a coderef for executing it.
311 C<$action_name> is the generated name for the action representing the CGI file.
313 By default returns something like:
319 sub wrap_nonperl_cgi {
320 my ($self, $cgi, $action_name) = @_;
326 die "failed to execute CGI '$cgi': $!";
329 die sprintf "CGI '$cgi' died with signal %d, %s coredump",
330 ($? & 127), ($? & 128) ? 'with' : 'without';
333 my $exit_code = $? >> 8;
335 return 0 if $exit_code == 0;
337 die "CGI '$cgi' exited non-zero with: $exit_code";
342 __PACKAGE__->meta->make_immutable;
346 L<Catalyst::Controller::WrapCGI>, L<CatalystX::GlobalContext>,
347 L<Catalyst::Controller>, L<CGI>, L<CGI::Compile>, L<Catalyst>
351 Please report any bugs or feature requests to C<bug-catalyst-controller-wrapcgi at
352 rt.cpan.org>, or through the web interface at
353 L<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Catalyst-Controller-WrapCGI>.
354 I will be notified, and then you'll automatically be notified of progress on
355 your bug as I make changes.
363 =item * RT: CPAN's request tracker
365 L<http://rt.cpan.org/NoAuth/Bugs.html?Dist=Catalyst-Controller-WrapCGI>
367 =item * AnnoCPAN: Annotated CPAN documentation
369 L<http://annocpan.org/dist/Catalyst-Controller-WrapCGI>
373 L<http://cpanratings.perl.org/d/Catalyst-Controller-WrapCGI>
377 L<http://search.cpan.org/dist/Catalyst-Controller-WrapCGI>
383 See L<Catalyst::Controller::WrapCGI/AUTHOR> and
384 L<Catalyst::Controller::WrapCGI/CONTRIBUTORS>.
386 =head1 COPYRIGHT & LICENSE
388 Copyright (c) 2008-2009 L<Catalyst::Controller::WrapCGI/AUTHOR> and
389 L<Catalyst::Controller::WrapCGI/CONTRIBUTORS>.
391 This program is free software; you can redistribute it and/or modify it
392 under the same terms as Perl itself.
396 1; # End of Catalyst::Controller::CGIBin
397 # vim:et sw=4 sts=4 tw=0: