1 package Catalyst::Controller::CGIBin;
6 extends 'Catalyst::Controller::WrapCGI';
8 use File::Slurp 'slurp';
9 use File::Find::Rule ();
10 use Catalyst::Exception ();
11 use File::Spec::Functions qw/splitdir abs2rel/;
14 use List::MoreUtils 'any';
18 use namespace::clean -except => 'meta';
22 Catalyst::Controller::CGIBin - Serve CGIs from root/cgi-bin
30 our $VERSION = '0.018';
36 package MyApp::Controller::Foo;
38 use parent qw/Catalyst::Controller::CGIBin/;
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 Path from which to read CGI files. Can be relative to C<$MYAPP_HOME/root> or
74 absolute. Defaults to C<$MYAPP_HOME/root/cgi-bin>.
78 has cgi_root_path => (is => 'ro', isa => 'Str', default => 'cgi-bin');
79 has cgi_dir => (is => 'ro', isa => 'Str', default => 'cgi-bin');
81 sub register_actions {
82 my ($self, $app) = @_;
84 my $cgi_bin = File::Spec->file_name_is_absolute($self->cgi_dir) ?
86 : $app->path_to('root', $self->cgi_dir);
88 my $namespace = $self->action_namespace($app);
90 my $class = ref $self || $self;
92 for my $file (File::Find::Rule->file->in($cgi_bin)) {
93 my $cgi_path = abs2rel($file, $cgi_bin);
95 next if any { $_ eq '.svn' } splitdir $cgi_path;
96 next if $cgi_path =~ /\.swp\z/;
98 my $path = join '/' => splitdir($cgi_path);
99 my $action_name = $self->cgi_action($path);
100 my $public_path = $self->cgi_path($path);
101 my $reverse = $namespace ? "$namespace/$action_name" : $action_name;
102 my $attrs = { Path => [ $public_path ] };
106 if ($self->is_perl_cgi($file)) { # syntax check passed
108 $cgi = $self->wrap_perl_cgi($file, $action_name);
111 $cgi = $self->wrap_nonperl_cgi($file, $action_name);
114 $app->log->info("Registering root/cgi-bin/$cgi_path as a $type CGI.")
118 my ($controller, $context) = @_;
119 $controller->cgi_to_response($context, $cgi)
122 my $action = $self->create_action(
123 name => $action_name,
126 namespace => $namespace,
131 $app->dispatcher->register($app, $action);
134 $self->next::method($app, @_);
136 # Tell Static::Simple to ignore cgi_dir
137 if ($cgi_bin =~ /^@{[ $app->path_to('root') ]}/) {
138 my $rel = File::Spec->abs2rel($cgi_bin, $app->path_to('root'));
140 if (!any { $_ eq $rel }
141 @{ $app->config->{static}{ignore_dirs}||[] }) {
142 push @{ $app->config->{static}{ignore_dirs} }, $rel;
151 C<< $self->cgi_action($cgi) >>
153 Takes a path to a CGI from C<root/cgi-bin> such as C<foo/bar.cgi> and returns
154 the action name it is registered as. See L</DESCRIPTION> for a discussion on how
155 CGI actions are named.
157 A path such as C<root/cgi-bin/hlagh/bar.cgi> will get the private path
158 C<foo/CGI_hlagh__bar_cgi>, for controller Foo, with the C</>s converted to C<__>
159 and prepended with C<CGI_>, as well as all non-word characters converted to
160 C<_>s. This is because L<Catalyst> action names can't have non-word characters
163 This means that C<foo/bar.cgi> and C<foo__bar.cgi> for example will both map to
164 the action C<CGI_foo__bar_cgi> so B<DON'T DO THAT>.
169 my ($self, $cgi) = @_;
171 my $action_name = 'CGI_' . join '__' => split '/' => $cgi;
172 $action_name =~ s/\W/_/g;
179 C<< $self->cgi_path($cgi) >>
181 Takes a path to a CGI from C<root/cgi-bin> such as C<foo/bar.cgi> and returns
182 the public path it should be registered under.
184 The default is to prefix with C<$cgi_root_path/>, using the C<cgi_root_path>
185 config setting, above.
190 my ($self, $cgi) = @_;
192 my $root = $self->cgi_root_path;
199 C<< $self->is_perl_cgi($path) >>
201 Tries to figure out whether the CGI is Perl or not.
203 If it's Perl, it will be inlined into a sub instead of being forked off, see
209 my ($self, $cgi) = @_;
211 my $shebang = IO::File->new($cgi)->getline;
213 return 0 if $shebang !~ /perl/ && $cgi !~ /\.pl\z/;
215 my $taint_check = $shebang =~ /-T/ ? '-T' : '';
217 open NULL, '>', File::Spec->devnull;
218 my $pid = open3(gensym, '&>NULL', '&>NULL', "$^X $taint_check -c $cgi");
227 C<< $self->wrap_perl_cgi($path, $action_name) >>
229 Takes the path to a Perl CGI and returns a coderef suitable for passing to
230 cgi_to_response (from L<Catalyst::Controller::WrapCGI>.)
232 C<$action_name> is the generated name for the action representing the CGI file
235 This is similar to how L<ModPerl::Registry> works, but will only work for
236 well-written CGIs. Otherwise, you may have to override this method to do
237 something more involved (see L<ModPerl::PerlRun>.)
239 Scripts with C<__DATA__> sections now work too, as well as scripts that call
245 my ($self, $cgi, $action_name) = @_;
247 my $code = slurp $cgi;
249 $code =~ s/^__DATA__(?:\r?\n|\r\n?)(.*)//ms;
254 # catch exit() and turn it into (effectively) a return
255 # we *must* eval STRING because the code needs to be compiled with the
256 # overridden CORE::GLOBAL::exit in view
258 # set $0 to the name of the cgi file in case it's used there
260 my $cgi_exited = "EXIT\n";
261 BEGIN { *CORE::GLOBAL::exit = sub (;$) {
262 die [ $cgi_exited, $_[0] || 0 ];
264 package Catalyst::Controller::CGIBin::_CGIs_::'.$action_name.';
267 . q{open DATA, '<', \$data;}
268 . qq{local \$0 = "\Q$cgi\E";}
273 return $rv unless $@;
274 die $@ if $@ and not (
275 ref($@) eq 'ARRAY' and
276 $@->[0] eq $cgi_exited
278 die "exited nonzero: $@->[1]" if $@->[1] != 0;
284 croak __PACKAGE__ . ": Could not compile $cgi to coderef: $@" if $@;
289 =head2 wrap_nonperl_cgi
291 C<< $self->wrap_nonperl_cgi($path, $action_name) >>
293 Takes the path to a non-Perl CGI and returns a coderef for executing it.
295 C<$action_name> is the generated name for the action representing the CGI file.
303 sub wrap_nonperl_cgi {
304 my ($self, $cgi, $action_name) = @_;
309 __PACKAGE__->meta->make_immutable;
313 L<Catalyst::Controller::WrapCGI>, L<CatalystX::GlobalContext>,
314 L<Catalyst::Controller>, L<CGI>, L<Catalyst>
318 Rafael Kitover, C<< <rkitover at cpan.org> >>
320 Hans Dieter Pearcey, C<< <hdp at cpan.org> >>
324 Please report any bugs or feature requests to C<bug-catalyst-controller-wrapcgi at
325 rt.cpan.org>, or through the web interface at
326 L<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Catalyst-Controller-WrapCGI>.
327 I will be notified, and then you'll automatically be notified of progress on
328 your bug as I make changes.
336 =item * RT: CPAN's request tracker
338 L<http://rt.cpan.org/NoAuth/Bugs.html?Dist=Catalyst-Controller-WrapCGI>
340 =item * AnnoCPAN: Annotated CPAN documentation
342 L<http://annocpan.org/dist/Catalyst-Controller-WrapCGI>
346 L<http://cpanratings.perl.org/d/Catalyst-Controller-WrapCGI>
350 L<http://search.cpan.org/dist/Catalyst-Controller-WrapCGI>
354 =head1 COPYRIGHT & LICENSE
356 Copyright (c) 2008 Rafael Kitover
358 This program is free software; you can redistribute it and/or modify it
359 under the same terms as Perl itself.
363 1; # End of Catalyst::Controller::CGIBin
365 # vim: expandtab shiftwidth=4 ts=4 tw=80: