Commit | Line | Data |
21a20b7e |
1 | package Catalyst::Controller::CGIBin; |
2 | |
9cd47364 |
3 | use Moose; |
1ce18a56 |
4 | use mro 'c3'; |
9cd47364 |
5 | |
6 | extends 'Catalyst::Controller::WrapCGI'; |
7 | |
21a20b7e |
8 | use File::Slurp 'slurp'; |
9 | use File::Find::Rule (); |
21a20b7e |
10 | use Catalyst::Exception (); |
c264816e |
11 | use File::Spec::Functions qw/splitdir abs2rel/; |
12 | use IPC::Open3; |
13 | use Symbol 'gensym'; |
14 | use List::MoreUtils 'any'; |
15 | use IO::File (); |
1ce18a56 |
16 | use Carp; |
e889d526 |
17 | use File::Temp 'tempfile'; |
16db0bfc |
18 | |
2340af9d |
19 | use namespace::clean -except => 'meta'; |
21a20b7e |
20 | |
21a20b7e |
21 | =head1 NAME |
22 | |
23 | Catalyst::Controller::CGIBin - Serve CGIs from root/cgi-bin |
24 | |
25 | =head1 VERSION |
26 | |
e889d526 |
27 | Version 0.021 |
21a20b7e |
28 | |
29 | =cut |
30 | |
e889d526 |
31 | our $VERSION = '0.021'; |
21a20b7e |
32 | |
33 | =head1 SYNOPSIS |
34 | |
35 | In your controller: |
36 | |
37 | package MyApp::Controller::Foo; |
38 | |
39 | use parent qw/Catalyst::Controller::CGIBin/; |
40 | |
21a20b7e |
41 | In your .conf: |
42 | |
43 | <Controller::Foo> |
9cd47364 |
44 | cgi_root_path cgi-bin |
f410f043 |
45 | cgi_dir cgi-bin |
21a20b7e |
46 | <CGI> |
47 | username_field username # used for REMOTE_USER env var |
48 | pass_env PERL5LIB |
49 | pass_env PATH |
50 | pass_env /^MYAPP_/ |
51 | </CGI> |
52 | </Controller::Foo> |
53 | |
54 | =head1 DESCRIPTION |
55 | |
c264816e |
56 | Dispatches to CGI files in root/cgi-bin for /cgi-bin/ paths. |
57 | |
58 | Unlike L<ModPerl::Registry> this module does _NOT_ stat and recompile the CGI |
f410f043 |
59 | for every invocation. This may be supported in the future if there's interest. |
21a20b7e |
60 | |
f410f043 |
61 | CGI paths are converted into action names using L</cgi_action>. |
ee75330f |
62 | |
21a20b7e |
63 | Inherits from L<Catalyst::Controller::WrapCGI>, see the documentation for that |
f410f043 |
64 | module for other configuration information. |
65 | |
66 | =head1 CONFIG PARAMS |
67 | |
68 | =head2 cgi_root_path |
69 | |
184837e7 |
70 | The global URI path prefix for CGIs, defaults to C<cgi-bin>. |
f410f043 |
71 | |
72 | =head2 cgi_dir |
73 | |
74 | Path from which to read CGI files. Can be relative to C<$MYAPP_HOME/root> or |
75 | absolute. Defaults to C<$MYAPP_HOME/root/cgi-bin>. |
21a20b7e |
76 | |
77 | =cut |
78 | |
9cd47364 |
79 | has cgi_root_path => (is => 'ro', isa => 'Str', default => 'cgi-bin'); |
f410f043 |
80 | has cgi_dir => (is => 'ro', isa => 'Str', default => 'cgi-bin'); |
9cd47364 |
81 | |
21a20b7e |
82 | sub register_actions { |
ee75330f |
83 | my ($self, $app) = @_; |
21a20b7e |
84 | |
f410f043 |
85 | my $cgi_bin = File::Spec->file_name_is_absolute($self->cgi_dir) ? |
86 | $self->cgi_dir |
87 | : $app->path_to('root', $self->cgi_dir); |
21a20b7e |
88 | |
ee75330f |
89 | my $namespace = $self->action_namespace($app); |
21a20b7e |
90 | |
91 | my $class = ref $self || $self; |
92 | |
c264816e |
93 | for my $file (File::Find::Rule->file->in($cgi_bin)) { |
94 | my $cgi_path = abs2rel($file, $cgi_bin); |
95 | |
96 | next if any { $_ eq '.svn' } splitdir $cgi_path; |
f410f043 |
97 | next if $cgi_path =~ /\.swp\z/; |
c264816e |
98 | |
12d29ebf |
99 | my $path = join '/' => splitdir($cgi_path); |
100 | my $action_name = $self->cgi_action($path); |
9cc2dd4c |
101 | my $public_path = $self->cgi_path($path); |
12d29ebf |
102 | my $reverse = $namespace ? "$namespace/$action_name" : $action_name; |
f410f043 |
103 | my $attrs = { Path => [ $public_path ] }; |
12d29ebf |
104 | |
21a20b7e |
105 | my ($cgi, $type); |
21a20b7e |
106 | |
c264816e |
107 | if ($self->is_perl_cgi($file)) { # syntax check passed |
21a20b7e |
108 | $type = 'Perl'; |
12d29ebf |
109 | $cgi = $self->wrap_perl_cgi($file, $action_name); |
21a20b7e |
110 | } else { |
21a20b7e |
111 | $type = 'Non-Perl'; |
12d29ebf |
112 | $cgi = $self->wrap_nonperl_cgi($file, $action_name); |
21a20b7e |
113 | } |
114 | |
c264816e |
115 | $app->log->info("Registering root/cgi-bin/$cgi_path as a $type CGI.") |
ee75330f |
116 | if $app->debug; |
21a20b7e |
117 | |
c264816e |
118 | my $code = sub { |
21a20b7e |
119 | my ($controller, $context) = @_; |
120 | $controller->cgi_to_response($context, $cgi) |
121 | }; |
122 | |
123 | my $action = $self->create_action( |
124 | name => $action_name, |
125 | code => $code, |
126 | reverse => $reverse, |
127 | namespace => $namespace, |
128 | class => $class, |
129 | attributes => $attrs |
130 | ); |
131 | |
ee75330f |
132 | $app->dispatcher->register($app, $action); |
21a20b7e |
133 | } |
134 | |
ee75330f |
135 | $self->next::method($app, @_); |
2340af9d |
136 | |
f410f043 |
137 | # Tell Static::Simple to ignore cgi_dir |
138 | if ($cgi_bin =~ /^@{[ $app->path_to('root') ]}/) { |
139 | my $rel = File::Spec->abs2rel($cgi_bin, $app->path_to('root')); |
140 | |
141 | if (!any { $_ eq $rel } |
142 | @{ $app->config->{static}{ignore_dirs}||[] }) { |
143 | push @{ $app->config->{static}{ignore_dirs} }, $rel; |
144 | } |
2340af9d |
145 | } |
21a20b7e |
146 | } |
147 | |
148 | =head1 METHODS |
149 | |
f410f043 |
150 | =head2 cgi_action |
151 | |
b9548267 |
152 | C<< $self->cgi_action($cgi) >> |
21a20b7e |
153 | |
154 | Takes a path to a CGI from C<root/cgi-bin> such as C<foo/bar.cgi> and returns |
c264816e |
155 | the action name it is registered as. See L</DESCRIPTION> for a discussion on how |
156 | CGI actions are named. |
21a20b7e |
157 | |
fbaba9dd |
158 | A path such as C<root/cgi-bin/hlagh/bar.cgi> will get the private path |
159 | C<foo/CGI_hlagh__bar_cgi>, for controller Foo, with the C</>s converted to C<__> |
160 | and prepended with C<CGI_>, as well as all non-word characters converted to |
161 | C<_>s. This is because L<Catalyst> action names can't have non-word characters |
162 | in them. |
163 | |
164 | This means that C<foo/bar.cgi> and C<foo__bar.cgi> for example will both map to |
165 | the action C<CGI_foo__bar_cgi> so B<DON'T DO THAT>. |
166 | |
21a20b7e |
167 | =cut |
168 | |
169 | sub cgi_action { |
170 | my ($self, $cgi) = @_; |
171 | |
fbaba9dd |
172 | my $action_name = 'CGI_' . join '__' => split '/' => $cgi; |
21a20b7e |
173 | $action_name =~ s/\W/_/g; |
174 | |
175 | $action_name |
176 | } |
177 | |
f410f043 |
178 | =head2 cgi_path |
179 | |
b9548267 |
180 | C<< $self->cgi_path($cgi) >> |
9cc2dd4c |
181 | |
182 | Takes a path to a CGI from C<root/cgi-bin> such as C<foo/bar.cgi> and returns |
183 | the public path it should be registered under. |
184 | |
184837e7 |
185 | The default is to prefix with C<$cgi_root_path/>, using the C<cgi_root_path> |
186 | config setting, above. |
9cc2dd4c |
187 | |
188 | =cut |
189 | |
190 | sub cgi_path { |
191 | my ($self, $cgi) = @_; |
9cd47364 |
192 | |
193 | my $root = $self->cgi_root_path; |
194 | $root =~ s{/*$}{}; |
195 | return "$root/$cgi"; |
9cc2dd4c |
196 | } |
197 | |
f410f043 |
198 | =head2 is_perl_cgi |
199 | |
b9548267 |
200 | C<< $self->is_perl_cgi($path) >> |
c264816e |
201 | |
202 | Tries to figure out whether the CGI is Perl or not. |
203 | |
204 | If it's Perl, it will be inlined into a sub instead of being forked off, see |
f410f043 |
205 | L</wrap_perl_cgi>. |
c264816e |
206 | |
207 | =cut |
208 | |
209 | sub is_perl_cgi { |
210 | my ($self, $cgi) = @_; |
211 | |
e889d526 |
212 | my (undef, $tempfile) = tempfile; |
c264816e |
213 | |
e889d526 |
214 | my $pid = fork; |
215 | die "Cannot fork: $!" unless defined $pid; |
c264816e |
216 | |
e889d526 |
217 | if ($pid) { |
218 | waitpid $pid, 0; |
219 | my $errors = IO::File->new($tempfile)->getline; |
220 | unlink $tempfile; |
221 | return $errors ? 0 : 1; |
222 | } |
c264816e |
223 | |
e889d526 |
224 | # child |
225 | local *NULL; |
c264816e |
226 | open NULL, '>', File::Spec->devnull; |
e889d526 |
227 | open STDOUT, '>&', \*NULL; |
228 | open STDERR, '>&', \*NULL; |
229 | close STDIN; |
c264816e |
230 | |
efa4a434 |
231 | eval { $self->wrap_perl_cgi($cgi, '__DUMMY__') }; |
232 | |
e889d526 |
233 | IO::File->new(">$tempfile")->print($@); |
efa4a434 |
234 | |
e889d526 |
235 | exit; |
c264816e |
236 | } |
237 | |
f410f043 |
238 | =head2 wrap_perl_cgi |
239 | |
b9548267 |
240 | C<< $self->wrap_perl_cgi($path, $action_name) >> |
c264816e |
241 | |
242 | Takes the path to a Perl CGI and returns a coderef suitable for passing to |
243 | cgi_to_response (from L<Catalyst::Controller::WrapCGI>.) |
244 | |
fbaba9dd |
245 | C<$action_name> is the generated name for the action representing the CGI file |
246 | from C<cgi_action>. |
c264816e |
247 | |
248 | This is similar to how L<ModPerl::Registry> works, but will only work for |
249 | well-written CGIs. Otherwise, you may have to override this method to do |
250 | something more involved (see L<ModPerl::PerlRun>.) |
251 | |
f410f043 |
252 | Scripts with C<__DATA__> sections now work too, as well as scripts that call |
253 | C<exit()>. |
fbaba9dd |
254 | |
c264816e |
255 | =cut |
256 | |
257 | sub wrap_perl_cgi { |
12d29ebf |
258 | my ($self, $cgi, $action_name) = @_; |
259 | |
1ce18a56 |
260 | my $code = slurp $cgi; |
261 | |
fbaba9dd |
262 | $code =~ s/^__DATA__(?:\r?\n|\r\n?)(.*)//ms; |
1ce18a56 |
263 | my $data = $1; |
264 | |
265 | my $coderef = do { |
12d29ebf |
266 | no warnings; |
bdb35995 |
267 | # catch exit() and turn it into (effectively) a return |
268 | # we *must* eval STRING because the code needs to be compiled with the |
269 | # overridden CORE::GLOBAL::exit in view |
270 | # |
271 | # set $0 to the name of the cgi file in case it's used there |
12d29ebf |
272 | eval ' |
bdb35995 |
273 | my $cgi_exited = "EXIT\n"; |
274 | BEGIN { *CORE::GLOBAL::exit = sub (;$) { |
275 | die [ $cgi_exited, $_[0] || 0 ]; |
276 | } } |
12d29ebf |
277 | package Catalyst::Controller::CGIBin::_CGIs_::'.$action_name.'; |
1ce18a56 |
278 | sub {' |
279 | . 'local *DATA;' |
280 | . q{open DATA, '<', \$data;} |
bdb35995 |
281 | . qq{local \$0 = "\Q$cgi\E";} |
282 | . q/my $rv = eval {/ |
1ce18a56 |
283 | . $code |
bdb35995 |
284 | . q/};/ |
285 | . q{ |
286 | return $rv unless $@; |
287 | die $@ if $@ and not ( |
288 | ref($@) eq 'ARRAY' and |
289 | $@->[0] eq $cgi_exited |
290 | ); |
291 | die "exited nonzero: $@->[1]" if $@->[1] != 0; |
292 | return $rv; |
293 | } |
1ce18a56 |
294 | . '}'; |
295 | }; |
296 | |
297 | croak __PACKAGE__ . ": Could not compile $cgi to coderef: $@" if $@; |
298 | |
299 | $coderef |
c264816e |
300 | } |
301 | |
f410f043 |
302 | =head2 wrap_nonperl_cgi |
303 | |
b9548267 |
304 | C<< $self->wrap_nonperl_cgi($path, $action_name) >> |
c264816e |
305 | |
306 | Takes the path to a non-Perl CGI and returns a coderef for executing it. |
307 | |
12d29ebf |
308 | C<$action_name> is the generated name for the action representing the CGI file. |
309 | |
c264816e |
310 | By default returns: |
311 | |
312 | sub { system $path } |
313 | |
314 | =cut |
315 | |
316 | sub wrap_nonperl_cgi { |
12d29ebf |
317 | my ($self, $cgi, $action_name) = @_; |
c264816e |
318 | |
319 | sub { system $cgi } |
320 | } |
321 | |
f410f043 |
322 | __PACKAGE__->meta->make_immutable; |
323 | |
c264816e |
324 | =head1 SEE ALSO |
325 | |
326 | L<Catalyst::Controller::WrapCGI>, L<CatalystX::GlobalContext>, |
327 | L<Catalyst::Controller>, L<CGI>, L<Catalyst> |
328 | |
21a20b7e |
329 | =head1 BUGS |
330 | |
331 | Please report any bugs or feature requests to C<bug-catalyst-controller-wrapcgi at |
332 | rt.cpan.org>, or through the web interface at |
333 | L<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Catalyst-Controller-WrapCGI>. |
334 | I will be notified, and then you'll automatically be notified of progress on |
335 | your bug as I make changes. |
336 | |
337 | =head1 SUPPORT |
338 | |
339 | More information at: |
340 | |
341 | =over 4 |
342 | |
343 | =item * RT: CPAN's request tracker |
344 | |
345 | L<http://rt.cpan.org/NoAuth/Bugs.html?Dist=Catalyst-Controller-WrapCGI> |
346 | |
347 | =item * AnnoCPAN: Annotated CPAN documentation |
348 | |
349 | L<http://annocpan.org/dist/Catalyst-Controller-WrapCGI> |
350 | |
351 | =item * CPAN Ratings |
352 | |
353 | L<http://cpanratings.perl.org/d/Catalyst-Controller-WrapCGI> |
354 | |
355 | =item * Search CPAN |
356 | |
357 | L<http://search.cpan.org/dist/Catalyst-Controller-WrapCGI> |
358 | |
359 | =back |
360 | |
efa4a434 |
361 | =head1 AUTHOR |
362 | |
363 | See L<Catalyst::Controller::WrapCGI/AUTHOR> and |
364 | L<Catalyst::Controller::WrapCGI/CONTRIBUTORS>. |
365 | |
21a20b7e |
366 | =head1 COPYRIGHT & LICENSE |
367 | |
efa4a434 |
368 | Copyright (c) 2008-2009 L<Catalyst::Controller::WrapCGI/AUTHOR> and |
369 | L<Catalyst::Controller::WrapCGI/CONTRIBUTORS>. |
21a20b7e |
370 | |
371 | This program is free software; you can redistribute it and/or modify it |
372 | under the same terms as Perl itself. |
373 | |
374 | =cut |
375 | |
376 | 1; # End of Catalyst::Controller::CGIBin |
377 | |
378 | # vim: expandtab shiftwidth=4 ts=4 tw=80: |