Commit | Line | Data |
71e6daf6 |
1 | package Catalyst::Controller::WrapCGI; |
b2a17df2 |
2 | |
9cd47364 |
3 | use Moose; |
4 | use mro 'c3'; |
5 | |
6 | extends 'Catalyst::Controller'; |
b2a17df2 |
7 | |
0d83c5de |
8 | use HTTP::Request::AsCGI (); |
9 | use HTTP::Request (); |
10 | use URI (); |
21a20b7e |
11 | use Catalyst::Exception (); |
f410f043 |
12 | use URI::Escape; |
16db0bfc |
13 | use HTTP::Request::Common; |
f410f043 |
14 | |
15 | use namespace::clean -except => 'meta'; |
32b32c62 |
16 | |
17 | =head1 NAME |
18 | |
19 | Catalyst::Controller::WrapCGI - Run CGIs in Catalyst |
20 | |
21 | =head1 VERSION |
22 | |
83bba9ab |
23 | Version 0.0036 |
32b32c62 |
24 | |
25 | =cut |
26 | |
83bba9ab |
27 | our $VERSION = '0.0036'; |
32b32c62 |
28 | |
29 | =head1 SYNOPSIS |
30 | |
31 | package MyApp::Controller::Foo; |
32 | |
33 | use parent qw/Catalyst::Controller::WrapCGI/; |
12d29ebf |
34 | use CGI (); |
32b32c62 |
35 | |
36 | sub hello : Path('cgi-bin/hello.cgi') { |
37 | my ($self, $c) = @_; |
38 | |
39 | $self->cgi_to_response($c, sub { |
12d29ebf |
40 | my $q = CGI->new; |
41 | print $q->header, $q->start_html('Hello'), |
42 | $q->h1('Catalyst Rocks!'), |
43 | $q->end_html; |
32b32c62 |
44 | }); |
45 | } |
46 | |
457c1d76 |
47 | In your .conf, configure which environment variables to pass: |
48 | |
49 | <Controller::Foo> |
50 | <CGI> |
21a20b7e |
51 | username_field username # used for REMOTE_USER env var |
457c1d76 |
52 | pass_env PERL5LIB |
53 | pass_env PATH |
21a20b7e |
54 | pass_env /^MYAPP_/ |
c4ef0be5 |
55 | kill_env MYAPP_BAD |
457c1d76 |
56 | </CGI> |
57 | </Controller::Foo> |
58 | |
59 | =head1 DESCRIPTION |
60 | |
61 | Allows you to run Perl code in a CGI environment derived from your L<Catalyst> |
62 | context. |
63 | |
12d29ebf |
64 | B<*WARNING*>: do not export L<CGI> functions into a Controller, it will break |
65 | with L<Catalyst> 5.8 onward. |
66 | |
21a20b7e |
67 | If you just want to run CGIs from files, see L<Catalyst::Controller::CGIBin>. |
68 | |
69 | =head1 CONFIGURATION |
70 | |
16bed4c4 |
71 | =head2 pass_env |
72 | |
c212b57b |
73 | C<< $your_controller->{CGI}{pass_env} >> should be an array of environment variables |
21a20b7e |
74 | or regular expressions to pass through to your CGIs. Entries surrounded by C</> |
75 | characters are considered regular expressions. |
76 | |
16bed4c4 |
77 | =head2 kill_env |
78 | |
c212b57b |
79 | C<< $your_controller->{CGI}{kill_env} >> should be an array of environment |
80 | variables or regular expressions to remove from the environment before passing |
81 | it to your CGIs. Entries surrounded by C</> characters are considered regular |
82 | expressions. |
21a20b7e |
83 | |
16bed4c4 |
84 | Default is to pass the whole of C<%ENV>, except for entries listed in |
85 | L</FILTERED ENVIRONMENT> below. |
c212b57b |
86 | |
16bed4c4 |
87 | =head2 username_field |
88 | |
89 | C<< $your_controller->{CGI}{username_field} >> should be the field for your |
90 | user's name, which will be read from C<< $c->user->obj >>. Defaults to |
91 | 'username'. |
21a20b7e |
92 | |
93 | See L</SYNOPSIS> for an example. |
94 | |
32b32c62 |
95 | =cut |
b2a17df2 |
96 | |
97 | # Hack-around because Catalyst::Engine::HTTP goes and changes |
98 | # them to be the remote socket, and FCGI.pm does even dumber things. |
99 | |
32b32c62 |
100 | open my $REAL_STDIN, "<&=".fileno(*STDIN); |
101 | open my $REAL_STDOUT, ">>&=".fileno(*STDOUT); |
102 | |
103 | =head1 METHODS |
104 | |
f410f043 |
105 | =head2 cgi_to_response |
106 | |
107 | C<<$self->cgi_to_response($c, $coderef)>> |
32b32c62 |
108 | |
109 | Does the magic of running $coderef in a CGI environment, and populating the |
110 | appropriate parts of your Catalyst context with the results. |
111 | |
f410f043 |
112 | Calls L</wrap_cgi>. |
457c1d76 |
113 | |
32b32c62 |
114 | =cut |
b2a17df2 |
115 | |
116 | sub cgi_to_response { |
117 | my ($self, $c, $script) = @_; |
0d83c5de |
118 | |
b2a17df2 |
119 | my $res = $self->wrap_cgi($c, $script); |
120 | |
121 | # if the CGI doesn't set the response code but sets location they were |
122 | # probably trying to redirect so set 302 for them |
123 | |
32b32c62 |
124 | my $location = $res->headers->header('Location'); |
125 | |
126 | if (defined $location && length $location && $res->code == 200) { |
b2a17df2 |
127 | $c->res->status(302); |
128 | } else { |
129 | $c->res->status($res->code); |
130 | } |
131 | $c->res->body($res->content); |
132 | $c->res->headers($res->headers); |
133 | } |
134 | |
f410f043 |
135 | =head2 wrap_cgi |
136 | |
137 | C<<$self->wrap_cgi($c, $coderef)>> |
32b32c62 |
138 | |
139 | Runs $coderef in a CGI environment using L<HTTP::Request::AsCGI>, returns an |
140 | L<HTTP::Response>. |
141 | |
142 | The CGI environment is set up based on $c. |
143 | |
457c1d76 |
144 | The environment variables to pass on are taken from the configuration for your |
145 | Controller, see L</SYNOPSIS> for an example. If you don't supply a list of |
146 | environment variables to pass, the whole of %ENV is used. |
147 | |
f410f043 |
148 | Used by L</cgi_to_response>, which is probably what you want to use as well. |
32b32c62 |
149 | |
150 | =cut |
151 | |
b2a17df2 |
152 | sub wrap_cgi { |
153 | my ($self, $c, $call) = @_; |
154 | my $req = HTTP::Request->new( |
155 | map { $c->req->$_ } qw/method uri headers/ |
156 | ); |
157 | my $body = $c->req->body; |
158 | my $body_content = ''; |
159 | |
160 | $req->content_type($c->req->content_type); # set this now so we can override |
161 | |
162 | if ($body) { # Slurp from body filehandle |
163 | local $/; $body_content = <$body>; |
164 | } else { |
165 | my $body_params = $c->req->body_parameters; |
16db0bfc |
166 | |
167 | if (my %uploads = %{ $c->req->uploads }) { |
168 | my $post = POST 'http://localhost/', |
169 | Content_Type => 'form-data', |
170 | Content => [ |
171 | %$body_params, |
172 | map { |
173 | my $upl = $uploads{$_}; |
174 | $_ => [ |
175 | undef, |
176 | $upl->filename, |
177 | Content => $upl->slurp, |
01c35d4e |
178 | map { |
179 | my $header = $_; |
180 | map { $header => $_ } $upl->headers->header($header) |
181 | } $upl->headers->header_field_names |
16db0bfc |
182 | ] |
183 | } keys %uploads |
184 | ]; |
185 | $body_content = $post->content; |
186 | $req->content_type($post->header('Content-Type')); |
187 | } elsif (%$body_params) { |
32b32c62 |
188 | my $encoder = URI->new; |
189 | $encoder->query_form(%$body_params); |
190 | $body_content = $encoder->query; |
b2a17df2 |
191 | $req->content_type('application/x-www-form-urlencoded'); |
192 | } |
193 | } |
194 | |
c212b57b |
195 | my $filtered_env = $self->_filtered_env(\%ENV); |
457c1d76 |
196 | |
b2a17df2 |
197 | $req->content($body_content); |
198 | $req->content_length(length($body_content)); |
21a20b7e |
199 | |
200 | my $username_field = $self->{CGI}{username_field} || 'username'; |
201 | |
202 | my $username = (($c->can('user_exists') && $c->user_exists) |
203 | ? eval { $c->user->obj->$username_field } |
b2a17df2 |
204 | : ''); |
0d83c5de |
205 | |
83bba9ab |
206 | my $path_info = '/'.join '/' => map { |
207 | utf8::is_utf8($_) ? uri_escape_utf8($_) : uri_escape($_) |
208 | } @{ $c->req->args }; |
0d83c5de |
209 | |
b2a17df2 |
210 | my $env = HTTP::Request::AsCGI->new( |
211 | $req, |
21a20b7e |
212 | ($username ? (REMOTE_USER => $username) : ()), |
c212b57b |
213 | %$filtered_env, |
f410f043 |
214 | PATH_INFO => $path_info, |
c4ef0be5 |
215 | # eww, this is likely broken: |
216 | FILEPATH_INFO => '/'.$c->action.$path_info, |
f410f043 |
217 | SCRIPT_NAME => $c->uri_for($c->action)->path |
b2a17df2 |
218 | ); |
219 | |
220 | { |
32b32c62 |
221 | local *STDIN = $REAL_STDIN; # restore the real ones so the filenos |
222 | local *STDOUT = $REAL_STDOUT; # are 0 and 1 for the env setup |
b2a17df2 |
223 | |
32b32c62 |
224 | my $old = select($REAL_STDOUT); # in case somebody just calls 'print' |
b2a17df2 |
225 | |
226 | my $saved_error; |
227 | |
228 | $env->setup; |
229 | eval { $call->() }; |
230 | $saved_error = $@; |
231 | $env->restore; |
232 | |
233 | select($old); |
234 | |
21a20b7e |
235 | Catalyst::Exception->throw( |
236 | message => "CGI invocation failed: $saved_error" |
237 | ) if $saved_error; |
b2a17df2 |
238 | } |
239 | |
240 | return $env->response; |
241 | } |
242 | |
16bed4c4 |
243 | =head1 FILTERED ENVIRONMENT |
244 | |
245 | If you don't use the L</pass_env> option to restrict which environment variables |
246 | are passed in, the default is to pass the whole of C<%ENV> except the variables |
247 | listed below. |
248 | |
249 | MOD_PERL |
250 | SERVER_SOFTWARE |
251 | SERVER_NAME |
252 | GATEWAY_INTERFACE |
253 | SERVER_PROTOCOL |
254 | SERVER_PORT |
255 | REQUEST_METHOD |
256 | PATH_INFO |
257 | PATH_TRANSLATED |
258 | SCRIPT_NAME |
259 | QUERY_STRING |
260 | REMOTE_HOST |
261 | REMOTE_ADDR |
262 | AUTH_TYPE |
263 | REMOTE_USER |
264 | REMOTE_IDENT |
265 | CONTENT_TYPE |
266 | CONTENT_LENGTH |
267 | HTTP_ACCEPT |
268 | HTTP_USER_AGENT |
269 | |
270 | C<%ENV> can be further trimmed using L</kill_env>. |
271 | |
272 | =cut |
273 | |
274 | my $DEFAULT_KILL_ENV = [qw/ |
275 | MOD_PERL SERVER_SOFTWARE SERVER_NAME GATEWAY_INTERFACE SERVER_PROTOCOL |
276 | SERVER_PORT REQUEST_METHOD PATH_INFO PATH_TRANSLATED SCRIPT_NAME QUERY_STRING |
277 | REMOTE_HOST REMOTE_ADDR AUTH_TYPE REMOTE_USER REMOTE_IDENT CONTENT_TYPE |
278 | CONTENT_LENGTH HTTP_ACCEPT HTTP_USER_AGENT |
279 | /]; |
280 | |
0d83c5de |
281 | sub _filtered_env { |
282 | my ($self, $env) = @_; |
283 | my @ok; |
284 | |
285 | my $pass_env = $self->{CGI}{pass_env}; |
286 | $pass_env = [] if not defined $pass_env; |
287 | $pass_env = [ $pass_env ] unless ref $pass_env; |
288 | |
289 | my $kill_env = $self->{CGI}{kill_env}; |
16bed4c4 |
290 | $kill_env = $DEFAULT_KILL_ENV unless defined $kill_env; |
0d83c5de |
291 | $kill_env = [ $kill_env ] unless ref $kill_env; |
292 | |
293 | if (@$pass_env) { |
294 | for (@$pass_env) { |
295 | if (m!^/(.*)/\z!) { |
296 | my $re = qr/$1/; |
297 | push @ok, grep /$re/, keys %$env; |
298 | } else { |
299 | push @ok, $_; |
300 | } |
301 | } |
302 | } else { |
303 | @ok = keys %$env; |
304 | } |
305 | |
306 | for my $k (@$kill_env) { |
307 | if ($k =~ m!^/(.*)/\z!) { |
308 | my $re = qr/$1/; |
309 | @ok = grep { ! /$re/ } @ok; |
310 | } else { |
311 | @ok = grep { $_ ne $k } @ok; |
312 | } |
313 | } |
314 | return { map {; $_ => $env->{$_} } @ok }; |
315 | } |
316 | |
f410f043 |
317 | __PACKAGE__->meta->make_immutable; |
0d83c5de |
318 | |
c4ef0be5 |
319 | =head1 DIRECT SOCKET/NPH SCRIPTS |
320 | |
321 | This currently won't work: |
322 | |
323 | #!/usr/bin/perl |
324 | |
325 | use CGI ':standard'; |
326 | |
327 | $| = 1; |
328 | |
329 | print header; |
330 | |
331 | for (0..1000) { |
332 | print $_, br, "\n"; |
83bba9ab |
333 | sleep 1; |
c4ef0be5 |
334 | } |
335 | |
336 | because the coderef is executed synchronously with C<STDOUT> pointing to a temp |
337 | file. |
338 | |
32b32c62 |
339 | =head1 ACKNOWLEDGEMENTS |
340 | |
341 | Original development sponsored by L<http://www.altinity.com/> |
342 | |
457c1d76 |
343 | =head1 SEE ALSO |
344 | |
21a20b7e |
345 | L<Catalyst::Controller::CGIBin>, L<CatalystX::GlobalContext>, |
457c1d76 |
346 | L<Catalyst::Controller>, L<CGI>, L<Catalyst> |
347 | |
0d83c5de |
348 | =head1 AUTHORS |
349 | |
350 | Originally written by: |
32b32c62 |
351 | |
352 | Matt S. Trout, C<< <mst at shadowcat.co.uk> >> |
353 | |
0d83c5de |
354 | Contributors: |
355 | |
356 | Rafael Kitover C<< <rkitover at cpan.org> >> |
357 | |
358 | Hans Dieter Pearcey C<< <hdp at cpan.org> >> |
359 | |
32b32c62 |
360 | =head1 BUGS |
361 | |
362 | Please report any bugs or feature requests to C<bug-catalyst-controller-wrapcgi |
363 | at rt.cpan.org>, or through the web interface at |
364 | L<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Catalyst-Controller-WrapCGI>. |
365 | I will be notified, and then you'll automatically be notified of progress on |
366 | your bug as I make changes. |
367 | |
368 | =head1 SUPPORT |
369 | |
370 | More information at: |
371 | |
372 | =over 4 |
373 | |
374 | =item * RT: CPAN's request tracker |
375 | |
376 | L<http://rt.cpan.org/NoAuth/Bugs.html?Dist=Catalyst-Controller-WrapCGI> |
377 | |
378 | =item * AnnoCPAN: Annotated CPAN documentation |
379 | |
380 | L<http://annocpan.org/dist/Catalyst-Controller-WrapCGI> |
381 | |
382 | =item * CPAN Ratings |
383 | |
384 | L<http://cpanratings.perl.org/d/Catalyst-Controller-WrapCGI> |
385 | |
386 | =item * Search CPAN |
387 | |
388 | L<http://search.cpan.org/dist/Catalyst-Controller-WrapCGI> |
389 | |
390 | =back |
391 | |
392 | =head1 COPYRIGHT & LICENSE |
393 | |
394 | Copyright (c) 2008 Matt S. Trout |
395 | |
396 | This program is free software; you can redistribute it and/or modify it |
397 | under the same terms as Perl itself. |
398 | |
399 | =cut |
400 | |
401 | 1; # End of Catalyst::Controller::WrapCGI |
402 | |
21a20b7e |
403 | # vim: expandtab shiftwidth=2 ts=2 tw=80: |