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