ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/AnyEvent-HTTP/HTTP.pm
(Generate patch)

Comparing AnyEvent-HTTP/HTTP.pm (file contents):
Revision 1.13 by root, Thu Jun 5 16:43:45 2008 UTC vs.
Revision 1.42 by root, Mon Jul 6 00:08:16 2009 UTC

3AnyEvent::HTTP - simple but non-blocking HTTP/HTTPS client 3AnyEvent::HTTP - simple but non-blocking HTTP/HTTPS client
4 4
5=head1 SYNOPSIS 5=head1 SYNOPSIS
6 6
7 use AnyEvent::HTTP; 7 use AnyEvent::HTTP;
8
9 http_get "http://www.nethype.de/", sub { print $_[1] };
10
11 # ... do something else here
8 12
9=head1 DESCRIPTION 13=head1 DESCRIPTION
10 14
11This module is an L<AnyEvent> user, you need to make sure that you use and 15This module is an L<AnyEvent> user, you need to make sure that you use and
12run a supported event loop. 16run a supported event loop.
35package AnyEvent::HTTP; 39package AnyEvent::HTTP;
36 40
37use strict; 41use strict;
38no warnings; 42no warnings;
39 43
40use Carp; 44use Errno ();
41 45
42use AnyEvent (); 46use AnyEvent 4.452 ();
43use AnyEvent::Util (); 47use AnyEvent::Util ();
44use AnyEvent::Socket (); 48use AnyEvent::Socket ();
45use AnyEvent::Handle (); 49use AnyEvent::Handle ();
46 50
47use base Exporter::; 51use base Exporter::;
48 52
49our $VERSION = '1.0'; 53our $VERSION = '1.12';
50 54
51our @EXPORT = qw(http_get http_request); 55our @EXPORT = qw(http_get http_post http_head http_request);
52 56
53our $USERAGENT = "Mozilla/5.0 (compatible; AnyEvent::HTTP/$VERSION; +http://software.schmorp.de/pkg/AnyEvent)"; 57our $USERAGENT = "Mozilla/5.0 (compatible; U; AnyEvent-HTTP/$VERSION; +http://software.schmorp.de/pkg/AnyEvent)";
54our $MAX_RECURSE = 10; 58our $MAX_RECURSE = 10;
55our $MAX_PERSISTENT = 8; 59our $MAX_PERSISTENT = 8;
56our $PERSISTENT_TIMEOUT = 2; 60our $PERSISTENT_TIMEOUT = 2;
57our $TIMEOUT = 300; 61our $TIMEOUT = 300;
58 62
59# changing these is evil 63# changing these is evil
60our $MAX_PERSISTENT_PER_HOST = 2; 64our $MAX_PERSISTENT_PER_HOST = 2;
61our $MAX_PER_HOST = 4; 65our $MAX_PER_HOST = 4;
62 66
63our $PROXY; 67our $PROXY;
68our $ACTIVE = 0;
64 69
65my %KA_COUNT; # number of open keep-alive connections per host 70my %KA_COUNT; # number of open keep-alive connections per host
66my %CO_SLOT; # number of open connections, and wait queue, per host 71my %CO_SLOT; # number of open connections, and wait queue, per host
67 72
68=item http_get $url, key => value..., $cb->($data, $headers) 73=item http_get $url, key => value..., $cb->($data, $headers)
69 74
70Executes an HTTP-GET request. See the http_request function for details on 75Executes an HTTP-GET request. See the http_request function for details on
71additional parameters. 76additional parameters and the return value.
72 77
73=item http_head $url, key => value..., $cb->($data, $headers) 78=item http_head $url, key => value..., $cb->($data, $headers)
74 79
75Executes an HTTP-HEAD request. See the http_request function for details on 80Executes an HTTP-HEAD request. See the http_request function for details
76additional parameters. 81on additional parameters and the return value.
77 82
78=item http_post $url, $body, key => value..., $cb->($data, $headers) 83=item http_post $url, $body, key => value..., $cb->($data, $headers)
79 84
80Executes an HTTP-POST request with a request body of C<$bod>. See the 85Executes an HTTP-POST request with a request body of C<$body>. See the
81http_request function for details on additional parameters. 86http_request function for details on additional parameters and the return
87value.
82 88
83=item http_request $method => $url, key => value..., $cb->($data, $headers) 89=item http_request $method => $url, key => value..., $cb->($data, $headers)
84 90
85Executes a HTTP request of type C<$method> (e.g. C<GET>, C<POST>). The URL 91Executes a HTTP request of type C<$method> (e.g. C<GET>, C<POST>). The URL
86must be an absolute http or https URL. 92must be an absolute http or https URL.
87 93
94When called in void context, nothing is returned. In other contexts,
95C<http_request> returns a "cancellation guard" - you have to keep the
96object at least alive until the callback get called. If the object gets
97destroyed before the callbakc is called, the request will be cancelled.
98
88The callback will be called with the response data as first argument 99The callback will be called with the response body data as first argument
89(or C<undef> if it wasn't available due to errors), and a hash-ref with 100(or C<undef> if an error occured), and a hash-ref with response headers as
90response headers as second argument. 101second argument.
91 102
92All the headers in that hash are lowercased. In addition to the response 103All the headers in that hash are lowercased. In addition to the response
93headers, the three "pseudo-headers" C<HTTPVersion>, C<Status> and 104headers, the "pseudo-headers" C<HTTPVersion>, C<Status> and C<Reason>
94C<Reason> contain the three parts of the HTTP Status-Line of the same 105contain the three parts of the HTTP Status-Line of the same name. The
106pseudo-header C<URL> contains the original URL (which can differ from the
107requested URL when following redirects).
108
95name. If the server sends a header multiple lines, then their contents 109If the server sends a header multiple times, then their contents will be
96will be joined together with C<\x00>. 110joined together with a comma (C<,>), as per the HTTP spec.
97 111
98If an internal error occurs, such as not being able to resolve a hostname, 112If an internal error occurs, such as not being able to resolve a hostname,
99then C<$data> will be C<undef>, C<< $headers->{Status} >> will be C<599> 113then C<$data> will be C<undef>, C<< $headers->{Status} >> will be C<59x>
100and the C<Reason> pseudo-header will contain an error message. 114(usually C<599>) and the C<Reason> pseudo-header will contain an error
115message.
101 116
102A typical callback might look like this: 117A typical callback might look like this:
103 118
104 sub { 119 sub {
105 my ($body, $hdr) = @_; 120 my ($body, $hdr) = @_;
151based on the original netscape specification. 166based on the original netscape specification.
152 167
153The C<$hash_ref> must be an (initially empty) hash reference which will 168The C<$hash_ref> must be an (initially empty) hash reference which will
154get updated automatically. It is possible to save the cookie_jar to 169get updated automatically. It is possible to save the cookie_jar to
155persistent storage with something like JSON or Storable, but this is not 170persistent storage with something like JSON or Storable, but this is not
156recommended, as expire times are currently being ignored. 171recommended, as expiry times are currently being ignored.
157 172
158Note that this cookie implementation is not of very high quality, nor 173Note that this cookie implementation is not of very high quality, nor
159meant to be complete. If you want complete cookie management you have to 174meant to be complete. If you want complete cookie management you have to
160do that on your own. C<cookie_jar> is meant as a quick fix to get some 175do that on your own. C<cookie_jar> is meant as a quick fix to get some
161cookie-using sites working. Cookies are a privacy disaster, do not use 176cookie-using sites working. Cookies are a privacy disaster, do not use
162them unless required to. 177them unless required to.
178
179=item tls_ctx => $scheme | $tls_ctx
180
181Specifies the AnyEvent::TLS context to be used for https connections. This
182parameter follows the same rules as the C<tls_ctx> parameter to
183L<AnyEvent::Handle>, but additionally, the two strings C<low> or
184C<high> can be specified, which give you a predefined low-security (no
185verification, highest compatibility) and high-security (CA and common-name
186verification) TLS context.
187
188The default for this option is C<low>, which could be interpreted as "give
189me the page, no matter what".
190
191=item on_header => $callback->($headers)
192
193When specified, this callback will be called with the header hash as soon
194as headers have been successfully received from the remote server (not on
195locally-generated errors).
196
197It has to return either true (in which case AnyEvent::HTTP will continue),
198or false, in which case AnyEvent::HTTP will cancel the download (and call
199the finish callback with an error code of C<598>).
200
201This callback is useful, among other things, to quickly reject unwanted
202content, which, if it is supposed to be rare, can be faster than first
203doing a C<HEAD> request.
204
205Example: cancel the request unless the content-type is "text/html".
206
207 on_header => sub {
208 $_[0]{"content-type"} =~ /^text\/html\s*(?:;|$)/
209 },
210
211=item on_body => $callback->($partial_body, $headers)
212
213When specified, all body data will be passed to this callback instead of
214to the completion callback. The completion callback will get the empty
215string instead of the body data.
216
217It has to return either true (in which case AnyEvent::HTTP will continue),
218or false, in which case AnyEvent::HTTP will cancel the download (and call
219the completion callback with an error code of C<598>).
220
221This callback is useful when the data is too large to be held in memory
222(so the callback writes it to a file) or when only some information should
223be extracted, or when the body should be processed incrementally.
224
225It is usually preferred over doing your own body handling via
226C<want_body_handle>.
227
228=item want_body_handle => $enable
229
230When enabled (default is disabled), the behaviour of AnyEvent::HTTP
231changes considerably: after parsing the headers, and instead of
232downloading the body (if any), the completion callback will be
233called. Instead of the C<$body> argument containing the body data, the
234callback will receive the L<AnyEvent::Handle> object associated with the
235connection. In error cases, C<undef> will be passed. When there is no body
236(e.g. status C<304>), the empty string will be passed.
237
238The handle object might or might not be in TLS mode, might be connected to
239a proxy, be a persistent connection etc., and configured in unspecified
240ways. The user is responsible for this handle (it will not be used by this
241module anymore).
242
243This is useful with some push-type services, where, after the initial
244headers, an interactive protocol is used (typical example would be the
245push-style twitter API which starts a JSON/XML stream).
246
247If you think you need this, first have a look at C<on_body>, to see if
248that doesn'T solve your problem in a better way.
163 249
164=back 250=back
165 251
166Example: make a simple HTTP GET request for http://www.nethype.de/ 252Example: make a simple HTTP GET request for http://www.nethype.de/
167 253
181 use Data::Dumper; 267 use Data::Dumper;
182 print Dumper $hdr; 268 print Dumper $hdr;
183 } 269 }
184 ; 270 ;
185 271
272Example: make another simple HTTP GET request, but immediately try to
273cancel it.
274
275 my $request = http_request GET => "http://www.nethype.de/", sub {
276 my ($body, $hdr) = @_;
277 print "$body\n";
278 };
279
280 undef $request;
281
186=cut 282=cut
187 283
188sub _slot_schedule; 284sub _slot_schedule;
189sub _slot_schedule($) { 285sub _slot_schedule($) {
190 my $host = shift; 286 my $host = shift;
191 287
192 while ($CO_SLOT{$host}[0] < $MAX_PER_HOST) { 288 while ($CO_SLOT{$host}[0] < $MAX_PER_HOST) {
193 if (my $cb = shift @{ $CO_SLOT{$host}[1] }) { 289 if (my $cb = shift @{ $CO_SLOT{$host}[1] }) {
194 # somebody wants that slot 290 # somebody wants that slot
195 ++$CO_SLOT{$host}[0]; 291 ++$CO_SLOT{$host}[0];
292 ++$ACTIVE;
196 293
197 $cb->(AnyEvent::Util::guard { 294 $cb->(AnyEvent::Util::guard {
295 --$ACTIVE;
198 --$CO_SLOT{$host}[0]; 296 --$CO_SLOT{$host}[0];
199 _slot_schedule $host; 297 _slot_schedule $host;
200 }); 298 });
201 } else { 299 } else {
202 # nobody wants the slot, maybe we can forget about it 300 # nobody wants the slot, maybe we can forget about it
211 push @{ $CO_SLOT{$_[0]}[1] }, $_[1]; 309 push @{ $CO_SLOT{$_[0]}[1] }, $_[1];
212 310
213 _slot_schedule $_[0]; 311 _slot_schedule $_[0];
214} 312}
215 313
314our $qr_nl = qr<\015?\012>;
315our $qr_nlnl = qr<\015?\012\015?\012>;
316
317our $TLS_CTX_LOW = { cache => 1, sslv2 => 1 };
318our $TLS_CTX_HIGH = { cache => 1, verify => 1, verify_peername => "https" };
319
216sub http_request($$$;@) { 320sub http_request($$@) {
217 my $cb = pop; 321 my $cb = pop;
218 my ($method, $url, %arg) = @_; 322 my ($method, $url, %arg) = @_;
219 323
220 my %hdr; 324 my %hdr;
325
326 $arg{tls_ctx} = $TLS_CTX_LOW if $arg{tls_ctx} eq "low" || !exists $arg{tls_ctx};
327 $arg{tls_ctx} = $TLS_CTX_HIGH if $arg{tls_ctx} eq "high";
221 328
222 $method = uc $method; 329 $method = uc $method;
223 330
224 if (my $hdr = $arg{headers}) { 331 if (my $hdr = $arg{headers}) {
225 while (my ($k, $v) = each %$hdr) { 332 while (my ($k, $v) = each %$hdr) {
226 $hdr{lc $k} = $v; 333 $hdr{lc $k} = $v;
227 } 334 }
228 } 335 }
229 336
230 my $recurse = exists $arg{recurse} ? $arg{recurse} : $MAX_RECURSE; 337 my $recurse = exists $arg{recurse} ? delete $arg{recurse} : $MAX_RECURSE;
231 338
232 return $cb->(undef, { Status => 599, Reason => "recursion limit reached" }) 339 return $cb->(undef, { Status => 599, Reason => "Too many redirections", URL => $url })
233 if $recurse < 0; 340 if $recurse < 0;
234 341
235 my $proxy = $arg{proxy} || $PROXY; 342 my $proxy = $arg{proxy} || $PROXY;
236 my $timeout = $arg{timeout} || $TIMEOUT; 343 my $timeout = $arg{timeout} || $TIMEOUT;
237 344
238 $hdr{"user-agent"} ||= $USERAGENT;
239
240 my ($scheme, $authority, $upath, $query, $fragment) = 345 my ($uscheme, $uauthority, $upath, $query, $fragment) =
241 $url =~ m|(?:([^:/?#]+):)?(?://([^/?#]*))?([^?#]*)(?:\?([^#]*))?(?:#(.*))?|; 346 $url =~ m|(?:([^:/?#]+):)?(?://([^/?#]*))?([^?#]*)(?:\?([^#]*))?(?:#(.*))?|;
242 347
243 $scheme = lc $scheme; 348 $uscheme = lc $uscheme;
244 349
245 my $uport = $scheme eq "http" ? 80 350 my $uport = $uscheme eq "http" ? 80
246 : $scheme eq "https" ? 443 351 : $uscheme eq "https" ? 443
247 : return $cb->(undef, { Status => 599, Reason => "only http and https URL schemes supported" }); 352 : return $cb->(undef, { Status => 599, Reason => "Only http and https URL schemes supported", URL => $url });
248 353
249 $hdr{referer} ||= "$scheme://$authority$upath"; # leave out fragment and query string, just a heuristic
250
251 $authority =~ /^(?: .*\@ )? ([^\@:]+) (?: : (\d+) )?$/x 354 $uauthority =~ /^(?: .*\@ )? ([^\@:]+) (?: : (\d+) )?$/x
252 or return $cb->(undef, { Status => 599, Reason => "unparsable URL" }); 355 or return $cb->(undef, { Status => 599, Reason => "Unparsable URL", URL => $url });
253 356
254 my $uhost = $1; 357 my $uhost = $1;
255 $uport = $2 if defined $2; 358 $uport = $2 if defined $2;
256 359
257 $uhost =~ s/^\[(.*)\]$/$1/; 360 $uhost =~ s/^\[(.*)\]$/$1/;
259 362
260 $upath =~ s%^/?%/%; 363 $upath =~ s%^/?%/%;
261 364
262 # cookie processing 365 # cookie processing
263 if (my $jar = $arg{cookie_jar}) { 366 if (my $jar = $arg{cookie_jar}) {
264 %$jar = () if $jar->{version} < 1; 367 %$jar = () if $jar->{version} != 1;
265 368
266 my @cookie; 369 my @cookie;
267 370
268 while (my ($chost, $v) = each %$jar) { 371 while (my ($chost, $v) = each %$jar) {
372 if ($chost =~ /^\./) {
269 next unless $chost eq substr $uhost, -length $chost; 373 next unless $chost eq substr $uhost, -length $chost;
270 next unless $chost =~ /^\./; 374 } elsif ($chost =~ /\./) {
375 next unless $chost eq $uhost;
376 } else {
377 next;
378 }
271 379
272 while (my ($cpath, $v) = each %$v) { 380 while (my ($cpath, $v) = each %$v) {
273 next unless $cpath eq substr $upath, 0, length $cpath; 381 next unless $cpath eq substr $upath, 0, length $cpath;
274 382
275 while (my ($k, $v) = each %$v) { 383 while (my ($k, $v) = each %$v) {
276 next if $scheme ne "https" && exists $v->{secure}; 384 next if $uscheme ne "https" && exists $v->{secure};
385 my $value = $v->{value};
386 $value =~ s/([\\"])/\\$1/g;
277 push @cookie, "$k=$v->{value}"; 387 push @cookie, "$k=\"$value\"";
278 } 388 }
279 } 389 }
280 } 390 }
281 391
282 $hdr{cookie} = join "; ", @cookie 392 $hdr{cookie} = join "; ", @cookie
283 if @cookie; 393 if @cookie;
284 } 394 }
285 395
286 my ($rhost, $rport, $rpath); # request host, port, path 396 my ($rhost, $rport, $rscheme, $rpath); # request host, port, path
287 397
288 if ($proxy) { 398 if ($proxy) {
289 ($rhost, $rport, $scheme) = @$proxy; 399 ($rpath, $rhost, $rport, $rscheme) = ($url, @$proxy);
290 $rpath = $url; 400
401 # don't support https requests over https-proxy transport,
402 # can't be done with tls as spec'ed, unless you double-encrypt.
403 $rscheme = "http" if $uscheme eq "https" && $rscheme eq "https";
291 } else { 404 } else {
292 ($rhost, $rport, $rpath) = ($uhost, $uport, $upath); 405 ($rhost, $rport, $rscheme, $rpath) = ($uhost, $uport, $uscheme, $upath);
293 $hdr{host} = $uhost;
294 } 406 }
295 407
408 $hdr{"user-agent"} ||= $USERAGENT;
409 $hdr{referer} ||= "$uscheme://$uauthority$upath"; # leave out fragment and query string, just a heuristic
410
411 $hdr{host} = "$uhost:$uport";
296 $hdr{"content-length"} = length $arg{body}; 412 $hdr{"content-length"} = length $arg{body};
297 413
298 my %state = (connect_guard => 1); 414 my %state = (connect_guard => 1);
299 415
300 _get_slot $uhost, sub { 416 _get_slot $uhost, sub {
302 418
303 return unless $state{connect_guard}; 419 return unless $state{connect_guard};
304 420
305 $state{connect_guard} = AnyEvent::Socket::tcp_connect $rhost, $rport, sub { 421 $state{connect_guard} = AnyEvent::Socket::tcp_connect $rhost, $rport, sub {
306 $state{fh} = shift 422 $state{fh} = shift
307 or return $cb->(undef, { Status => 599, Reason => "$!" }); 423 or return (%state = (), $cb->(undef, { Status => 599, Reason => "$!", URL => $url }));
424 pop; # free memory, save a tree
308 425
309 delete $state{connect_guard}; # reduce memory usage, save a tree 426 return unless delete $state{connect_guard};
310 427
311 # get handle 428 # get handle
312 $state{handle} = new AnyEvent::Handle 429 $state{handle} = new AnyEvent::Handle
313 fh => $state{fh}, 430 fh => $state{fh},
314 ($scheme eq "https" ? (tls => "connect") : ()); 431 timeout => $timeout,
432 peername => $rhost,
433 tls_ctx => $arg{tls_ctx};
315 434
316 # limit the number of persistent connections 435 # limit the number of persistent connections
436 # keepalive not yet supported
317 if ($KA_COUNT{$_[1]} < $MAX_PERSISTENT_PER_HOST) { 437 if ($KA_COUNT{$_[1]} < $MAX_PERSISTENT_PER_HOST) {
318 ++$KA_COUNT{$_[1]}; 438 ++$KA_COUNT{$_[1]};
319 $state{handle}{ka_count_guard} = AnyEvent::Util::guard { --$KA_COUNT{$_[1]} }; 439 $state{handle}{ka_count_guard} = AnyEvent::Util::guard {
440 --$KA_COUNT{$_[1]}
441 };
320 $hdr{connection} = "keep-alive"; 442 $hdr{connection} = "keep-alive";
321 delete $hdr{connection}; # keep-alive not yet supported
322 } else { 443 } else {
323 delete $hdr{connection}; 444 delete $hdr{connection};
324 } 445 }
325 446
326 # (re-)configure handle 447 # (re-)configure handle
327 $state{handle}->timeout ($timeout);
328 $state{handle}->on_error (sub { 448 $state{handle}->on_error (sub {
329 %state = (); 449 %state = ();
330 $cb->(undef, { Status => 599, Reason => "$!" }); 450 $cb->(undef, { Status => 599, Reason => $_[2], URL => $url });
331 }); 451 });
332 $state{handle}->on_eof (sub { 452 $state{handle}->on_eof (sub {
333 %state = (); 453 %state = ();
334 $cb->(undef, { Status => 599, Reason => "unexpected end-of-file" }); 454 $cb->(undef, { Status => 599, Reason => "Unexpected end-of-file", URL => $url });
335 }); 455 });
336 456
457 $state{handle}->starttls ("connect") if $rscheme eq "https";
458
459 # handle actual, non-tunneled, request
460 my $handle_actual_request = sub {
461 $state{handle}->starttls ("connect") if $uscheme eq "https" && !exists $state{handle}{tls};
462
337 # send request 463 # send request
338 $state{handle}->push_write ( 464 $state{handle}->push_write (
339 "$method $rpath HTTP/1.0\015\012" 465 "$method $rpath HTTP/1.0\015\012"
340 . (join "", map "$_: $hdr{$_}\015\012", keys %hdr) 466 . (join "", map "\u$_: $hdr{$_}\015\012", keys %hdr)
341 . "\015\012" 467 . "\015\012"
342 . (delete $arg{body}) 468 . (delete $arg{body})
343 );
344
345 %hdr = (); # reduce memory usage, save a kitten
346
347 # status line
348 $state{handle}->push_read (line => qr/\015?\012/, sub {
349 $_[1] =~ /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) \s+ ([^\015\012]+)/ix
350 or return (%state = (), $cb->(undef, { Status => 599, Reason => "invalid server response ($_[1])" }));
351
352 my %hdr = ( # response headers
353 HTTPVersion => "\x00$1",
354 Status => "\x00$2",
355 Reason => "\x00$3",
356 ); 469 );
357 470
471 %hdr = (); # reduce memory usage, save a kitten
472
473 # status line
474 $state{handle}->push_read (line => $qr_nl, sub {
475 $_[1] =~ /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\015\012]*) )?/ix
476 or return (%state = (), $cb->(undef, { Status => 599, Reason => "Invalid server response ($_[1])", URL => $url }));
477
478 my %hdr = ( # response headers
479 HTTPVersion => ",$1",
480 Status => ",$2",
481 Reason => ",$3",
482 URL => ",$url"
483 );
484
358 # headers, could be optimized a bit 485 # headers, could be optimized a bit
359 $state{handle}->unshift_read (line => qr/\015?\012\015?\012/, sub { 486 $state{handle}->unshift_read (line => $qr_nlnl, sub {
360 for ("$_[1]\012") { 487 for ("$_[1]\012") {
361 # we support spaces in field names, as lotus domino 488 y/\015//d; # weed out any \015, as they show up in the weirdest of places.
362 # creates them. 489
490 # things seen, not parsed:
491 # p3pP="NON CUR OTPi OUR NOR UNI"
492
363 $hdr{lc $1} .= "\x00$2" 493 $hdr{lc $1} .= ",$2"
364 while /\G 494 while /\G
365 ([^:\000-\037]+): 495 ([^:\000-\037]+):
366 [\011\040]* 496 [\011\040]*
367 ((?: [^\015\012]+ | \015?\012[\011\040] )*) 497 ((?: [^\012]+ | \012[\011\040] )*)
368 \015?\012 498 \012
369 /gxc; 499 /gxc;
370 500
371 /\G$/ 501 /\G$/
372 or return (%state = (), $cb->(undef, { Status => 599, Reason => "garbled response headers" })); 502 or return (%state = (), $cb->(undef, { Status => 599, Reason => "Garbled response headers", URL => $url }));
373 } 503 }
374 504
375 substr $_, 0, 1, "" 505 substr $_, 0, 1, ""
376 for values %hdr; 506 for values %hdr;
377 507
378 my $finish = sub { 508 # redirect handling
379 %state = (); 509 # microsoft and other shitheads don't give a shit for following standards,
510 # try to support some common forms of broken Location headers.
511 if ($hdr{location} !~ /^(?: $ | [^:\/?\#]+ : )/x) {
512 $hdr{location} =~ s/^\.\/+//;
380 513
381 # set-cookie processing 514 my $url = "$rscheme://$uhost:$uport";
382 if ($arg{cookie_jar} && exists $hdr{"set-cookie"}) {
383 for (split /\x00/, $hdr{"set-cookie"}) {
384 my ($cookie, @arg) = split /;\s*/;
385 my ($name, $value) = split /=/, $cookie, 2;
386 my %kv = (value => $value, map { split /=/, $_, 2 } @arg);
387
388 my $cdom = (delete $kv{domain}) || $uhost;
389 my $cpath = (delete $kv{path}) || "/";
390
391 $cdom =~ s/^.?/./; # make sure it starts with a "."
392 515
393 next if $cdom =~ /\.$/; 516 unless ($hdr{location} =~ s/^\///) {
394 517 $url .= $upath;
395 # this is not rfc-like and not netscape-like. go figure. 518 $url =~ s/\/[^\/]*$//;
396 my $ndots = $cdom =~ y/.//; 519 }
397 next if $ndots < ($cdom =~ /\.[^.][^.]\.[^.][^.]$/ ? 3 : 2); 520
398 521 $hdr{location} = "$url/$hdr{location}";
522 }
523
524 my $redirect;
525
526 if ($recurse) {
527 if ($hdr{Status} =~ /^30[12]$/ && $method ne "POST") {
528 # apparently, mozilla et al. just change POST to GET here
529 # more research is needed before we do the same
399 # store it 530 $redirect = 1;
400 $arg{cookie_jar}{version} = 1; 531 } elsif ($hdr{Status} == 303) {
401 $arg{cookie_jar}{$cdom}{$cpath}{$name} = \%kv; 532 # even http/1.1 is unclear on how to mutate the method
533 $method = "GET" unless $method eq "HEAD";
534 $redirect = 1;
535 } elsif ($hdr{Status} == 307 && $method =~ /^(?:GET|HEAD)$/) {
536 $redirect = 1;
402 } 537 }
403 } 538 }
404 539
405 if ($_[1]{Status} =~ /^30[12]$/ && $recurse) { 540 my $finish = sub {
406 # microsoft and other assholes don't give a shit for following standards, 541 $state{handle}->destroy if $state{handle};
407 # try to support a common form of broken Location header. 542 %state = ();
408 $_[1]{location} =~ s%^/%$scheme://$uhost:$uport/%;
409 543
544 # set-cookie processing
545 if ($arg{cookie_jar}) {
546 for ($_[1]{"set-cookie"}) {
547 # parse NAME=VALUE
548 my @kv;
549
550 while (/\G\s* ([^=;,[:space:]]+) \s*=\s* (?: "((?:[^\\"]+|\\.)*)" | ([^=;,[:space:]]*) )/gcxs) {
551 my $name = $1;
552 my $value = $3;
553
554 unless ($value) {
555 $value = $2;
556 $value =~ s/\\(.)/$1/gs;
557 }
558
559 push @kv, $name => $value;
560
561 last unless /\G\s*;/gc;
562 }
563
564 last unless @kv;
565
566 my $name = shift @kv;
567 my %kv = (value => shift @kv, @kv);
568
569 my $cdom;
570 my $cpath = (delete $kv{path}) || "/";
571
572 if (exists $kv{domain}) {
573 $cdom = delete $kv{domain};
574
575 $cdom =~ s/^\.?/./; # make sure it starts with a "."
576
577 next if $cdom =~ /\.$/;
578
579 # this is not rfc-like and not netscape-like. go figure.
580 my $ndots = $cdom =~ y/.//;
581 next if $ndots < ($cdom =~ /\.[^.][^.]\.[^.][^.]$/ ? 3 : 2);
582 } else {
583 $cdom = $uhost;
584 }
585
586 # store it
587 $arg{cookie_jar}{version} = 1;
588 $arg{cookie_jar}{$cdom}{$cpath}{$name} = \%kv;
589
590 redo if /\G\s*,/gc;
591 }
592 }
593
594 if ($redirect) {
595 # we ignore any errors, as it is very common to receive
596 # Content-Length != 0 but no actual body
597 # we also access %hdr, as $_[1] might be an erro
410 http_request ($method, $_[1]{location}, %arg, recurse => $recurse - 1, $cb); 598 http_request ($method => $hdr{location}, %arg, recurse => $recurse - 1, $cb);
599 } else {
600 $cb->($_[0], $_[1]);
601 }
602 };
603
604 my $len = $hdr{"content-length"};
605
606 if (!$redirect && $arg{on_header} && !$arg{on_header}(\%hdr)) {
607 $finish->(undef, { Status => 598, Reason => "Request cancelled by on_header", URL => $url });
608 } elsif (
609 $hdr{Status} =~ /^(?:1..|[23]04)$/
610 or $method eq "HEAD"
611 or (defined $len && !$len)
612 ) {
613 # no body
614 $finish->("", \%hdr);
411 } else { 615 } else {
412 $cb->($_[0], $_[1]); 616 # body handling, four different code paths
617 # for want_body_handle, on_body (2x), normal (2x)
618 # we might read too much here, but it does not matter yet (no pers. connections)
619 if (!$redirect && $arg{want_body_handle}) {
620 $_[0]->on_eof (undef);
621 $_[0]->on_error (undef);
622 $_[0]->on_read (undef);
623
624 $finish->(delete $state{handle}, \%hdr);
625
626 } elsif ($arg{on_body}) {
627 $_[0]->on_error (sub { $finish->(undef, { Status => 599, Reason => $_[2], URL => $url }) });
628 if ($len) {
629 $_[0]->on_eof (undef);
630 $_[0]->on_read (sub {
631 $len -= length $_[0]{rbuf};
632
633 $arg{on_body}(delete $_[0]{rbuf}, \%hdr)
634 or $finish->(undef, { Status => 598, Reason => "Request cancelled by on_body", URL => $url });
635
636 $len > 0
637 or $finish->("", \%hdr);
638 });
639 } else {
640 $_[0]->on_eof (sub {
641 $finish->("", \%hdr);
642 });
643 $_[0]->on_read (sub {
644 $arg{on_body}(delete $_[0]{rbuf}, \%hdr)
645 or $finish->(undef, { Status => 598, Reason => "Request cancelled by on_body", URL => $url });
646 });
647 }
648 } else {
649 $_[0]->on_eof (undef);
650
651 if ($len) {
652 $_[0]->on_error (sub { $finish->(undef, { Status => 599, Reason => $_[2], URL => $url }) });
653 $_[0]->on_read (sub {
654 $finish->((substr delete $_[0]{rbuf}, 0, $len, ""), \%hdr)
655 if $len <= length $_[0]{rbuf};
656 });
657 } else {
658 $_[0]->on_error (sub {
659 $! == Errno::EPIPE
660 ? $finish->(delete $_[0]{rbuf}, \%hdr)
661 : $finish->(undef, { Status => 599, Reason => $_[2], URL => $url });
662 });
663 $_[0]->on_read (sub { });
664 }
665 }
413 } 666 }
414 }; 667 });
668 });
669 };
415 670
416 if ($hdr{Status} =~ /^(?:1..|204|304)$/ or $method eq "HEAD") { 671 # now handle proxy-CONNECT method
417 $finish->(undef, \%hdr); 672 if ($proxy && $uscheme eq "https") {
673 # oh dear, we have to wrap it into a connect request
674
675 # maybe re-use $uauthority with patched port?
676 $state{handle}->push_write ("CONNECT $uhost:$uport HTTP/1.0\015\012Host: $uhost\015\012\015\012");
677 $state{handle}->push_read (line => $qr_nlnl, sub {
678 $_[1] =~ /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\015\012]*) )?/ix
679 or return (%state = (), $cb->(undef, { Status => 599, Reason => "Invalid proxy connect response ($_[1])", URL => $url }));
680
681 if ($2 == 200) {
682 $rpath = $upath;
683 &$handle_actual_request;
418 } else { 684 } else {
419 if (exists $hdr{"content-length"}) { 685 %state = ();
420 $_[0]->unshift_read (chunk => $hdr{"content-length"}, sub { 686 $cb->(undef, { Status => $2, Reason => $3, URL => $url });
421 # could cache persistent connection now
422 if ($hdr{connection} =~ /\bkeep-alive\b/i) {
423 # but we don't, due to misdesigns, this is annoyingly complex
424 };
425
426 $finish->($_[1], \%hdr);
427 });
428 } else {
429 # too bad, need to read until we get an error or EOF,
430 # no way to detect winged data.
431 $_[0]->on_error (sub {
432 $finish->($_[0]{rbuf}, \%hdr);
433 });
434 $_[0]->on_eof (undef);
435 $_[0]->on_read (sub { });
436 }
437 } 687 }
438 }); 688 });
689 } else {
690 &$handle_actual_request;
439 }); 691 }
692
440 }, sub { 693 }, sub {
441 $timeout 694 $timeout
442 }; 695 };
443 }; 696 };
444 697
445 defined wantarray && AnyEvent::Util::guard { %state = () } 698 defined wantarray && AnyEvent::Util::guard { %state = () }
446} 699}
447 700
448sub http_get($$;@) { 701sub http_get($@) {
449 unshift @_, "GET"; 702 unshift @_, "GET";
450 &http_request 703 &http_request
451} 704}
452 705
453sub http_head($$;@) { 706sub http_head($@) {
454 unshift @_, "HEAD"; 707 unshift @_, "HEAD";
455 &http_request 708 &http_request
456} 709}
457 710
458sub http_post($$$;@) { 711sub http_post($$@) {
712 my $url = shift;
459 unshift @_, "POST", "body"; 713 unshift @_, "POST", $url, "body";
460 &http_request 714 &http_request
461} 715}
462 716
463=back 717=back
464 718
476The default value for the C<recurse> request parameter (default: C<10>). 730The default value for the C<recurse> request parameter (default: C<10>).
477 731
478=item $AnyEvent::HTTP::USERAGENT 732=item $AnyEvent::HTTP::USERAGENT
479 733
480The default value for the C<User-Agent> header (the default is 734The default value for the C<User-Agent> header (the default is
481C<Mozilla/5.0 (compatible; AnyEvent::HTTP/$VERSION; +http://software.schmorp.de/pkg/AnyEvent)>). 735C<Mozilla/5.0 (compatible; U; AnyEvent-HTTP/$VERSION; +http://software.schmorp.de/pkg/AnyEvent)>).
482 736
483=item $AnyEvent::HTTP::MAX_PERSISTENT 737=item $AnyEvent::HTTP::MAX_PERSISTENT
484 738
485The maximum number of persistent connections to keep open (default: 8). 739The maximum number of persistent connections to keep open (default: 8).
486 740
489=item $AnyEvent::HTTP::PERSISTENT_TIMEOUT 743=item $AnyEvent::HTTP::PERSISTENT_TIMEOUT
490 744
491The maximum time to cache a persistent connection, in seconds (default: 2). 745The maximum time to cache a persistent connection, in seconds (default: 2).
492 746
493Not implemented currently. 747Not implemented currently.
748
749=item $AnyEvent::HTTP::ACTIVE
750
751The number of active connections. This is not the number of currently
752running requests, but the number of currently open and non-idle TCP
753connections. This number of can be useful for load-leveling.
494 754
495=back 755=back
496 756
497=cut 757=cut
498 758
507 767
508L<AnyEvent>. 768L<AnyEvent>.
509 769
510=head1 AUTHOR 770=head1 AUTHOR
511 771
512 Marc Lehmann <schmorp@schmorp.de> 772 Marc Lehmann <schmorp@schmorp.de>
513 http://home.schmorp.de/ 773 http://home.schmorp.de/
774
775With many thanks to Дмитрий Шалашов, who provided countless
776testcases and bugreports.
514 777
515=cut 778=cut
516 779
5171 7801
518 781

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines