1 package Catalyst::Controller::CGIBin;
6 extends 'Catalyst::Controller::WrapCGI';
8 use File::Find::Rule ();
9 use File::Spec::Functions qw/splitdir abs2rel/;
12 use List::MoreUtils 'any';
14 use File::Temp 'tempfile';
18 use namespace::clean -except => 'meta';
22 Catalyst::Controller::CGIBin - Serve CGIs from root/cgi-bin
26 our $VERSION = '0.029';
32 package MyApp::Controller::Foo;
34 use parent qw/Catalyst::Controller::CGIBin/;
41 cgi_chain_root /optional/private/path/to/Chained/root
42 cgi_file_pattern *.cgi
44 cgi_file_pattern /\.pl\z/
46 username_field username # used for REMOTE_USER env var
55 Dispatches to CGI files in root/cgi-bin for /cgi-bin/ paths.
57 Unlike L<ModPerl::Registry> this module does _NOT_ stat and recompile the CGI
58 for every invocation. This may be supported in the future if there's interest.
60 CGI paths are converted into action names using L</cgi_action>.
62 Inherits from L<Catalyst::Controller::WrapCGI>, see the documentation for that
63 module for other configuration information.
69 The global URI path prefix for CGIs, defaults to C<cgi-bin>.
73 By default L<Path|Catalyst::DispatchType::Path> actions are created for CGIs,
74 but if you specify this option, the actions will be created as
75 L<Chained|Catalyst::DispatchType::Chained> end-points, chaining off the
76 specified private path.
78 If this option is used, the L</cgi_root_path> option is ignored. The root path
79 will be determined by your chain.
81 The L<PathPart|Catalyst::DispatchType::Chained/PathPart> of the action will be
82 the path to the CGI file.
86 Path from which to read CGI files. Can be relative to C<$MYAPP_HOME/root> or
87 absolute. Defaults to C<$MYAPP_HOME/root/cgi-bin>.
89 =head2 cgi_file_pattern
91 By default all files in L</cgi_dir> will be loaded as CGIs, however, with this
92 option you can specify either a glob or a regex to match the names of files you
95 Can be an array of globs/regexes as well.
99 has cgi_root_path => (is => 'ro', isa => 'Str', default => 'cgi-bin');
100 has cgi_chain_root => (is => 'ro', isa => 'Str');
101 has cgi_dir => (is => 'ro', isa => 'Str', default => 'cgi-bin');
102 has cgi_file_pattern => (is => 'rw', default => sub { ['*'] });
104 sub register_actions {
105 my ($self, $app) = @_;
107 my $cgi_bin = File::Spec->file_name_is_absolute($self->cgi_dir) ?
109 : $app->path_to('root', $self->cgi_dir);
111 my $namespace = $self->action_namespace($app);
113 my $class = ref $self || $self;
115 my $patterns = $self->cgi_file_pattern;
116 $patterns = [ $patterns ] if not ref $patterns;
117 for my $pat (@$patterns) {
118 if ($pat =~ m{^/(.*)/\z}) {
122 $self->cgi_file_pattern($patterns);
124 for my $file (File::Find::Rule->file->name(@$patterns)->in($cgi_bin)) {
125 my $cgi_path = abs2rel($file, $cgi_bin);
127 next if any { $_ eq '.svn' } splitdir $cgi_path;
128 next if $cgi_path =~ /\.swp\z/;
130 my $path = join '/' => splitdir($cgi_path);
131 my $action_name = $self->cgi_action($path);
132 my $reverse = $namespace ? "$namespace/$action_name" : $action_name;
135 if (my $chain_root = $self->cgi_chain_root) {
136 { Chained => [ $chain_root ], PathPart => [ $path ], Args => [] };
139 { Path => [ $self->cgi_path($path) ] };
145 if ($self->is_perl_cgi($file)) { # syntax check passed
147 $cgi = $self->wrap_perl_cgi($file, $action_name);
150 $cgi = $self->wrap_nonperl_cgi($file, $action_name);
153 $app->log->info("Registering root/cgi-bin/$cgi_path as a $type CGI.")
157 my ($controller, $context) = @_;
158 $controller->cgi_to_response($context, $cgi)
161 my $action = $self->create_action(
162 name => $action_name,
165 namespace => $namespace,
170 $app->dispatcher->register($app, $action);
173 $self->next::method($app, @_);
175 # Tell Static::Simple to ignore cgi_dir
176 if ($cgi_bin =~ /^@{[ $app->path_to('root') ]}/) {
177 my $rel = File::Spec->abs2rel($cgi_bin, $app->path_to('root'));
179 if (!any { $_ eq $rel }
180 @{ $app->config->{static}{ignore_dirs}||[] }) {
181 push @{ $app->config->{static}{ignore_dirs} }, $rel;
190 C<< $self->cgi_action($cgi) >>
192 Takes a path to a CGI from C<root/cgi-bin> such as C<foo/bar.cgi> and returns
193 the action name it is registered as.
198 my ($self, $cgi) = @_;
200 my $action_name = 'CGI_' . $cgi;
201 $action_name =~ s/([^A-Za-z0-9_])/sprintf("_%2x", unpack("C", $1))/eg;
208 C<< $self->cgi_path($cgi) >>
210 Takes a path to a CGI from C<root/cgi-bin> such as C<foo/bar.cgi> and returns
211 the public path it should be registered under.
213 The default is to prefix with C<$cgi_root_path/>, using the C<cgi_root_path>
214 config setting, above.
219 my ($self, $cgi) = @_;
221 my $root = $self->cgi_root_path;
228 C<< $self->is_perl_cgi($path) >>
230 Tries to figure out whether the CGI is Perl or not.
232 If it's Perl, it will be inlined into a sub instead of being forked off, see
238 my ($self, $cgi) = @_;
240 my (undef, $tempfile) = tempfile;
243 die "Cannot fork: $!" unless defined $pid;
247 my $errors = IO::File->new($tempfile)->getline;
249 return $errors ? 0 : 1;
254 open NULL, '>', File::Spec->devnull;
255 open STDOUT, '>&', \*NULL;
256 open STDERR, '>&', \*NULL;
259 eval { $self->wrap_perl_cgi($cgi, '__DUMMY__') };
261 IO::File->new(">$tempfile")->print($@);
268 C<< $self->wrap_perl_cgi($path, $action_name) >>
270 Takes the path to a Perl CGI and returns a coderef suitable for passing to
271 cgi_to_response (from L<Catalyst::Controller::WrapCGI>) using L<CGI::Compile>.
273 C<$action_name> is the generated name for the action representing the CGI file
276 This is similar to how L<ModPerl::Registry> works, but will only work for
277 well-written CGIs. Otherwise, you may have to override this method to do
278 something more involved (see L<ModPerl::PerlRun>.)
280 Scripts with C<__DATA__> sections now work too, as well as scripts that call
286 my ($self, $cgi, $action_name) = @_;
288 return CGI::Compile->compile($cgi,
289 "Catalyst::Controller::CGIBin::_CGIs_::$action_name");
292 =head2 wrap_nonperl_cgi
294 C<< $self->wrap_nonperl_cgi($path, $action_name) >>
296 Takes the path to a non-Perl CGI and returns a coderef for executing it.
298 C<$action_name> is the generated name for the action representing the CGI file.
300 By default returns something like:
306 sub wrap_nonperl_cgi {
307 my ($self, $cgi, $action_name) = @_;
313 die "failed to execute CGI '$cgi': $!";
316 die sprintf "CGI '$cgi' died with signal %d, %s coredump",
317 ($? & 127), ($? & 128) ? 'with' : 'without';
320 my $exit_code = $? >> 8;
322 return 0 if $exit_code == 0;
324 die "CGI '$cgi' exited non-zero with: $exit_code";
329 __PACKAGE__->meta->make_immutable;
333 L<Catalyst::Controller::WrapCGI>, L<CatalystX::GlobalContext>,
334 L<Catalyst::Controller>, L<CGI>, L<CGI::Compile>, L<Catalyst>
338 Please report any bugs or feature requests to C<bug-catalyst-controller-wrapcgi at
339 rt.cpan.org>, or through the web interface at
340 L<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Catalyst-Controller-WrapCGI>.
341 I will be notified, and then you'll automatically be notified of progress on
342 your bug as I make changes.
350 =item * RT: CPAN's request tracker
352 L<http://rt.cpan.org/NoAuth/Bugs.html?Dist=Catalyst-Controller-WrapCGI>
354 =item * AnnoCPAN: Annotated CPAN documentation
356 L<http://annocpan.org/dist/Catalyst-Controller-WrapCGI>
360 L<http://cpanratings.perl.org/d/Catalyst-Controller-WrapCGI>
364 L<http://search.cpan.org/dist/Catalyst-Controller-WrapCGI>
370 See L<Catalyst::Controller::WrapCGI/AUTHOR> and
371 L<Catalyst::Controller::WrapCGI/CONTRIBUTORS>.
373 =head1 COPYRIGHT & LICENSE
375 Copyright (c) 2008-2009 L<Catalyst::Controller::WrapCGI/AUTHOR> and
376 L<Catalyst::Controller::WrapCGI/CONTRIBUTORS>.
378 This program is free software; you can redistribute it and/or modify it
379 under the same terms as Perl itself.
383 1; # End of Catalyst::Controller::CGIBin
384 # vim:et sw=4 sts=4 tw=0: