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