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