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