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