Commit | Line | Data |
b2e1304d |
1 | package HTTP::Request::AsCGI; |
f1dd0792 |
2 | # ABSTRACT: Set up a CGI environment from an HTTP::Request |
b2e1304d |
3 | use strict; |
4 | use warnings; |
090cc060 |
5 | use bytes; |
b2e1304d |
6 | use base 'Class::Accessor::Fast'; |
7 | |
362ea9ac |
8 | our $VERSION = '1.1'; |
8596f5a5 |
9 | |
b332ee65 |
10 | use Carp; |
11 | use HTTP::Response; |
12 | use IO::Handle; |
13 | use IO::File; |
bb6e4a92 |
14 | use URI (); |
11454d47 |
15 | use URI::Escape (); |
b2e1304d |
16 | |
5e458489 |
17 | __PACKAGE__->mk_accessors(qw[ environment request stdin stdout stderr ]); |
18 | |
19 | # old typo |
20 | =begin Pod::Coverage |
21 | |
22 | enviroment |
23 | |
24 | =end Pod::Coverage |
25 | |
26 | =cut |
27 | |
28 | *enviroment = \&environment; |
5889d784 |
29 | |
bb6e4a92 |
30 | my %reserved = map { sprintf('%02x', ord($_)) => 1 } split //, $URI::reserved; |
31 | sub _uri_safe_unescape { |
32 | my ($s) = @_; |
8596f5a5 |
33 | $s =~ s/%([a-fA-F0-9]{2})/$reserved{lc($1)} ? "%$1" : pack('C', hex($1))/ge; |
34 | $s |
bb6e4a92 |
35 | } |
36 | |
b2e1304d |
37 | sub new { |
b332ee65 |
38 | my $class = shift; |
39 | my $request = shift; |
26e3d92b |
40 | |
b332ee65 |
41 | unless ( @_ % 2 == 0 && eval { $request->isa('HTTP::Request') } ) { |
42 | croak(qq/usage: $class->new( \$request [, key => value] )/); |
26e3d92b |
43 | } |
44 | |
b332ee65 |
45 | my $self = $class->SUPER::new( { restored => 0, setuped => 0 } ); |
46 | $self->request($request); |
47 | $self->stdin( IO::File->new_tmpfile ); |
48 | $self->stdout( IO::File->new_tmpfile ); |
b2e1304d |
49 | |
30efa07d |
50 | my $host = $request->header('Host'); |
51 | my $uri = $request->uri->clone; |
52 | $uri->scheme('http') unless $uri->scheme; |
53 | $uri->host('localhost') unless $uri->host; |
54 | $uri->port(80) unless $uri->port; |
a3875fc6 |
55 | $uri->host_port($host) unless !$host || ( $host eq $uri->host_port ); |
4e0afe7d |
56 | |
b3996e05 |
57 | # Get it before canonicalized so REQUEST_URI can be as raw as possible |
58 | my $request_uri = $uri->path_query; |
59 | |
ca38286c |
60 | $uri = $uri->canonical; |
30efa07d |
61 | |
5e458489 |
62 | my $environment = { |
b2e1304d |
63 | GATEWAY_INTERFACE => 'CGI/1.1', |
30efa07d |
64 | HTTP_HOST => $uri->host_port, |
a3875fc6 |
65 | HTTPS => ( $uri->scheme eq 'https' ) ? 'ON' : 'OFF', # not in RFC 3875 |
8596f5a5 |
66 | PATH_INFO => $uri->path, |
a3875fc6 |
67 | QUERY_STRING => $uri->query || '', |
68 | SCRIPT_NAME => '/', |
69 | SERVER_NAME => $uri->host, |
70 | SERVER_PORT => $uri->port, |
71 | SERVER_PROTOCOL => $request->protocol || 'HTTP/1.1', |
72 | SERVER_SOFTWARE => "HTTP-Request-AsCGI/$VERSION", |
73 | REMOTE_ADDR => '127.0.0.1', |
74 | REMOTE_HOST => 'localhost', |
75 | REMOTE_PORT => int( rand(64000) + 1000 ), # not in RFC 3875 |
b3996e05 |
76 | REQUEST_URI => $request_uri, # not in RFC 3875 |
b332ee65 |
77 | REQUEST_METHOD => $request->method, |
78 | @_ |
79 | }; |
26e3d92b |
80 | |
4d6b96d8 |
81 | # RFC 3875 says PATH_INFO is not URI-encoded. That's really |
82 | # annoying for applications that you can't tell "%2F" vs "/", but |
83 | # doing the partial decoding then makes it impossible to tell |
84 | # "%252F" vs "%2F". Encoding everything is more compatible to what |
85 | # web servers like Apache or lighttpd do, anyways. |
86 | $environment->{PATH_INFO} = URI::Escape::uri_unescape($environment->{PATH_INFO}); |
8596f5a5 |
87 | |
9c216915 |
88 | foreach my $field ( $request->headers->header_field_names ) { |
b2e1304d |
89 | |
ca38286c |
90 | my $key = uc("HTTP_$field"); |
2aaf55bc |
91 | $key =~ tr/-/_/; |
ca38286c |
92 | $key =~ s/^HTTP_// if $field =~ /^Content-(Length|Type)$/; |
b2e1304d |
93 | |
5e458489 |
94 | unless ( exists $environment->{$key} ) { |
95 | $environment->{$key} = $request->headers->header($field); |
b2e1304d |
96 | } |
97 | } |
98 | |
5e458489 |
99 | unless ( $environment->{SCRIPT_NAME} eq '/' && $environment->{PATH_INFO} ) { |
100 | $environment->{PATH_INFO} =~ s/^\Q$environment->{SCRIPT_NAME}\E/\//; |
101 | $environment->{PATH_INFO} =~ s/^\/+/\//; |
26e3d92b |
102 | } |
103 | |
5e458489 |
104 | $self->environment($environment); |
b332ee65 |
105 | |
106 | return $self; |
26e3d92b |
107 | } |
108 | |
109 | sub setup { |
110 | my $self = shift; |
111 | |
5e458489 |
112 | $self->{restore}->{environment} = {%ENV}; |
26e3d92b |
113 | |
b332ee65 |
114 | binmode( $self->stdin ); |
26e3d92b |
115 | |
b332ee65 |
116 | if ( $self->request->content_length ) { |
26e3d92b |
117 | |
bd90442e |
118 | $self->stdin->print($self->request->content) |
b332ee65 |
119 | or croak("Can't write request content to stdin handle: $!"); |
b2e1304d |
120 | |
bd90442e |
121 | $self->stdin->seek(0, SEEK_SET) |
b332ee65 |
122 | or croak("Can't seek stdin handle: $!"); |
bd90442e |
123 | |
124 | $self->stdin->flush |
125 | or croak("Can't flush stdin handle: $!"); |
b2e1304d |
126 | } |
26e3d92b |
127 | |
b2c02cd0 |
128 | open( $self->{restore}->{stdin}, '<&'. STDIN->fileno ) |
b332ee65 |
129 | or croak("Can't dup stdin: $!"); |
b2e1304d |
130 | |
b2c02cd0 |
131 | open( STDIN, '<&='. $self->stdin->fileno ) |
b332ee65 |
132 | or croak("Can't open stdin: $!"); |
ca38286c |
133 | |
b332ee65 |
134 | binmode( STDIN ); |
26e3d92b |
135 | |
b332ee65 |
136 | if ( $self->stdout ) { |
26e3d92b |
137 | |
b2c02cd0 |
138 | open( $self->{restore}->{stdout}, '>&'. STDOUT->fileno ) |
b332ee65 |
139 | or croak("Can't dup stdout: $!"); |
26e3d92b |
140 | |
b2c02cd0 |
141 | open( STDOUT, '>&='. $self->stdout->fileno ) |
b332ee65 |
142 | or croak("Can't open stdout: $!"); |
76391122 |
143 | |
a3875fc6 |
144 | binmode( $self->stdout ); |
145 | binmode( STDOUT); |
146 | } |
30efa07d |
147 | |
b332ee65 |
148 | if ( $self->stderr ) { |
090cc060 |
149 | |
b2c02cd0 |
150 | open( $self->{restore}->{stderr}, '>&'. STDERR->fileno ) |
b332ee65 |
151 | or croak("Can't dup stderr: $!"); |
441eeb04 |
152 | |
b2c02cd0 |
153 | open( STDERR, '>&='. $self->stderr->fileno ) |
b332ee65 |
154 | or croak("Can't open stderr: $!"); |
26e3d92b |
155 | |
156 | binmode( $self->stderr ); |
157 | binmode( STDERR ); |
158 | } |
b2e1304d |
159 | |
9c216915 |
160 | { |
161 | no warnings 'uninitialized'; |
903274b1 |
162 | %ENV = (%ENV, %{ $self->environment }); |
5889d784 |
163 | } |
164 | |
9c216915 |
165 | if ( $INC{'CGI.pm'} ) { |
166 | CGI::initialize_globals(); |
167 | } |
168 | |
b332ee65 |
169 | $self->{setuped}++; |
9c216915 |
170 | |
171 | return $self; |
5889d784 |
172 | } |
173 | |
780060e5 |
174 | sub response { |
b332ee65 |
175 | my ( $self, $callback ) = @_; |
780060e5 |
176 | |
b332ee65 |
177 | return undef unless $self->stdout; |
780060e5 |
178 | |
b332ee65 |
179 | seek( $self->stdout, 0, SEEK_SET ) |
180 | or croak("Can't seek stdout handle: $!"); |
14f243e8 |
181 | |
b332ee65 |
182 | my $headers; |
183 | while ( my $line = $self->stdout->getline ) { |
184 | $headers .= $line; |
185 | last if $headers =~ /\x0d?\x0a\x0d?\x0a$/; |
780060e5 |
186 | } |
15e50838 |
187 | |
b332ee65 |
188 | unless ( defined $headers ) { |
189 | $headers = "HTTP/1.1 500 Internal Server Error\x0d\x0a"; |
780060e5 |
190 | } |
191 | |
b332ee65 |
192 | unless ( $headers =~ /^HTTP/ ) { |
193 | $headers = "HTTP/1.1 200 OK\x0d\x0a" . $headers; |
4e0afe7d |
194 | } |
decf17dc |
195 | |
b332ee65 |
196 | my $response = HTTP::Response->parse($headers); |
197 | $response->date( time() ) unless $response->date; |
decf17dc |
198 | |
b332ee65 |
199 | my $message = $response->message; |
200 | my $status = $response->header('Status'); |
780060e5 |
201 | |
b332ee65 |
202 | if ( $message && $message =~ /^(.+)\x0d$/ ) { |
203 | $response->message($1); |
780060e5 |
204 | } |
26e3d92b |
205 | |
b332ee65 |
206 | if ( $status && $status =~ /^(\d\d\d)\s?(.+)?$/ ) { |
780060e5 |
207 | |
b332ee65 |
208 | my $code = $1; |
209 | my $message = $2 || HTTP::Status::status_message($code); |
4e0afe7d |
210 | |
b332ee65 |
211 | $response->code($code); |
212 | $response->message($message); |
4e0afe7d |
213 | } |
15e50838 |
214 | |
b332ee65 |
215 | my $length = ( stat( $self->stdout ) )[7] - tell( $self->stdout ); |
780060e5 |
216 | |
b332ee65 |
217 | if ( $response->code == 500 && !$length ) { |
4e0afe7d |
218 | |
b332ee65 |
219 | $response->content( $response->error_as_HTML ); |
220 | $response->content_type('text/html'); |
4e0afe7d |
221 | |
4d6e304a |
222 | return $response; |
780060e5 |
223 | } |
4e0afe7d |
224 | |
b332ee65 |
225 | if ($callback) { |
4d6e304a |
226 | |
b332ee65 |
227 | my $handle = $self->stdout; |
4d6e304a |
228 | |
b332ee65 |
229 | $response->content( sub { |
4e0afe7d |
230 | |
b332ee65 |
231 | if ( $handle->read( my $buffer, 4096 ) ) { |
232 | return $buffer; |
474703e4 |
233 | } |
b332ee65 |
234 | |
235 | return undef; |
236 | }); |
4d6e304a |
237 | } |
b332ee65 |
238 | else { |
4d6e304a |
239 | |
b332ee65 |
240 | my $length = 0; |
4d6e304a |
241 | |
b332ee65 |
242 | while ( $self->stdout->read( my $buffer, 4096 ) ) { |
243 | $length += length($buffer); |
244 | $response->add_content($buffer); |
245 | } |
4e0afe7d |
246 | |
b332ee65 |
247 | if ( $length && !$response->content_length ) { |
248 | $response->content_length($length); |
decf17dc |
249 | } |
780060e5 |
250 | } |
251 | |
780060e5 |
252 | return $response; |
253 | } |
254 | |
b2e1304d |
255 | sub restore { |
256 | my $self = shift; |
4e0afe7d |
257 | |
9c216915 |
258 | { |
259 | no warnings 'uninitialized'; |
5e458489 |
260 | %ENV = %{ $self->{restore}->{environment} }; |
9c216915 |
261 | } |
12852959 |
262 | |
b2c02cd0 |
263 | open( STDIN, '<&'. fileno($self->{restore}->{stdin}) ) |
b332ee65 |
264 | or croak("Can't restore stdin: $!"); |
30efa07d |
265 | |
b332ee65 |
266 | sysseek( $self->stdin, 0, SEEK_SET ) |
267 | or croak("Can't seek stdin: $!"); |
30efa07d |
268 | |
b332ee65 |
269 | if ( $self->{restore}->{stdout} ) { |
26e3d92b |
270 | |
b332ee65 |
271 | STDOUT->flush |
272 | or croak("Can't flush stdout: $!"); |
26e3d92b |
273 | |
b2c02cd0 |
274 | open( STDOUT, '>&'. fileno($self->{restore}->{stdout}) ) |
b332ee65 |
275 | or croak("Can't restore stdout: $!"); |
090cc060 |
276 | |
b332ee65 |
277 | sysseek( $self->stdout, 0, SEEK_SET ) |
278 | or croak("Can't seek stdout: $!"); |
a3875fc6 |
279 | } |
26e3d92b |
280 | |
b332ee65 |
281 | if ( $self->{restore}->{stderr} ) { |
12852959 |
282 | |
b332ee65 |
283 | STDERR->flush |
284 | or croak("Can't flush stderr: $!"); |
30efa07d |
285 | |
b2c02cd0 |
286 | open( STDERR, '>&'. fileno($self->{restore}->{stderr}) ) |
b332ee65 |
287 | or croak("Can't restore stderr: $!"); |
090cc060 |
288 | |
b332ee65 |
289 | sysseek( $self->stderr, 0, SEEK_SET ) |
290 | or croak("Can't seek stderr: $!"); |
6f5fb9a7 |
291 | } |
090cc060 |
292 | |
b332ee65 |
293 | $self->{restored}++; |
9c216915 |
294 | |
295 | return $self; |
b2e1304d |
296 | } |
297 | |
298 | sub DESTROY { |
299 | my $self = shift; |
b332ee65 |
300 | $self->restore if $self->{setuped} && !$self->{restored}; |
b2e1304d |
301 | } |
302 | |
303 | 1; |
304 | |
305 | __END__ |
306 | |
b2e1304d |
307 | =head1 SYNOPSIS |
308 | |
bd7813ac |
309 | use CGI; |
310 | use HTTP::Request; |
311 | use HTTP::Request::AsCGI; |
15e50838 |
312 | |
bd7813ac |
313 | my $request = HTTP::Request->new( GET => 'http://www.host.com/' ); |
314 | my $stdout; |
15e50838 |
315 | |
bd7813ac |
316 | { |
317 | my $c = HTTP::Request::AsCGI->new($request)->setup; |
318 | my $q = CGI->new; |
15e50838 |
319 | |
bd7813ac |
320 | print $q->header, |
321 | $q->start_html('Hello World'), |
322 | $q->h1('Hello World'), |
323 | $q->end_html; |
15e50838 |
324 | |
bd7813ac |
325 | $stdout = $c->stdout; |
15e50838 |
326 | |
5e458489 |
327 | # environment and descriptors will automatically be restored |
2d51e42f |
328 | # when $c is destructed. |
bd7813ac |
329 | } |
15e50838 |
330 | |
bd7813ac |
331 | while ( my $line = $stdout->getline ) { |
332 | print $line; |
333 | } |
15e50838 |
334 | |
b2e1304d |
335 | =head1 DESCRIPTION |
336 | |
9a0e0b26 |
337 | Provides a convenient way of setting up an CGI environment from an HTTP::Request. |
2d51e42f |
338 | |
b2e1304d |
339 | =head1 METHODS |
340 | |
15e50838 |
341 | =over 4 |
14f243e8 |
342 | |
b332ee65 |
343 | =item new ( $request [, key => value ] ) |
14f243e8 |
344 | |
9a0e0b26 |
345 | Constructor. The first argument must be a instance of HTTP::Request, followed |
346 | by optional pairs of environment key and value. |
14f243e8 |
347 | |
5e458489 |
348 | =item environment |
14f243e8 |
349 | |
15e50838 |
350 | Returns a hashref containing the environment that will be used in setup. |
b332ee65 |
351 | Changing the hashref after setup has been called will have no effect. |
14f243e8 |
352 | |
b332ee65 |
353 | =item setup |
9c216915 |
354 | |
9a0e0b26 |
355 | Sets up the environment and descriptors. |
9c216915 |
356 | |
b332ee65 |
357 | =item restore |
9c216915 |
358 | |
5e458489 |
359 | Restores the environment and descriptors. Can only be called after setup. |
9c216915 |
360 | |
b332ee65 |
361 | =item request |
9c216915 |
362 | |
b332ee65 |
363 | Returns the request given to constructor. |
9c216915 |
364 | |
b332ee65 |
365 | =item response |
9c216915 |
366 | |
b332ee65 |
367 | Returns a HTTP::Response. Can only be called after restore. |
9c216915 |
368 | |
b332ee65 |
369 | =item stdin |
9c216915 |
370 | |
b332ee65 |
371 | Accessor for handle that will be used for STDIN, must be a real seekable |
372 | handle with an file descriptor. Defaults to a tempoary IO::File instance. |
14f243e8 |
373 | |
b332ee65 |
374 | =item stdout |
14f243e8 |
375 | |
b332ee65 |
376 | Accessor for handle that will be used for STDOUT, must be a real seekable |
377 | handle with an file descriptor. Defaults to a tempoary IO::File instance. |
9c216915 |
378 | |
b332ee65 |
379 | =item stderr |
14f243e8 |
380 | |
b332ee65 |
381 | Accessor for handle that will be used for STDERR, must be a real seekable |
382 | handle with an file descriptor. |
14f243e8 |
383 | |
384 | =back |
b2e1304d |
385 | |
74fbb9dd |
386 | =head1 SEE ALSO |
387 | |
388 | =over 4 |
389 | |
390 | =item examples directory in this distribution. |
391 | |
392 | =item L<WWW::Mechanize::CGI> |
393 | |
394 | =item L<Test::WWW::Mechanize::CGI> |
395 | |
396 | =back |
397 | |
2d51e42f |
398 | =head1 THANKS TO |
17b370b0 |
399 | |
400 | Thomas L. Shinnick for his valuable win32 testing. |
401 | |
b2e1304d |
402 | =cut |