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.45 by root, Fri Jul 17 16:56:36 2009 UTC vs.
Revision 1.63 by root, Thu Dec 30 04:31:55 2010 UTC

… …
41use strict; 41use strict;
42no warnings; 42no warnings;
43 43
44use Errno (); 44use Errno ();
45 45
46use AnyEvent 4.8 (); 46use AnyEvent 5.0 ();
47use AnyEvent::Util (); 47use AnyEvent::Util ();
48use AnyEvent::Socket ();
49use AnyEvent::Handle (); 48use AnyEvent::Handle ();
50 49
51use base Exporter::; 50use base Exporter::;
52 51
53our $VERSION = '1.4'; 52our $VERSION = '1.46';
54 53
55our @EXPORT = qw(http_get http_post http_head http_request); 54our @EXPORT = qw(http_get http_post http_head http_request);
56 55
57our $USERAGENT = "Mozilla/5.0 (compatible; U; AnyEvent-HTTP/$VERSION; +http://software.schmorp.de/pkg/AnyEvent)"; 56our $USERAGENT = "Mozilla/5.0 (compatible; U; AnyEvent-HTTP/$VERSION; +http://software.schmorp.de/pkg/AnyEvent)";
58our $MAX_RECURSE = 10; 57our $MAX_RECURSE = 10;
… …
92must be an absolute http or https URL. 91must be an absolute http or https URL.
93 92
94When called in void context, nothing is returned. In other contexts, 93When called in void context, nothing is returned. In other contexts,
95C<http_request> returns a "cancellation guard" - you have to keep the 94C<http_request> returns a "cancellation guard" - you have to keep the
96object at least alive until the callback get called. If the object gets 95object at least alive until the callback get called. If the object gets
97destroyed before the callbakc is called, the request will be cancelled. 96destroyed before the callback is called, the request will be cancelled.
98 97
99The callback will be called with the response body data as first argument 98The callback will be called with the response body data as first argument
100(or C<undef> if an error occured), and a hash-ref with response headers as 99(or C<undef> if an error occured), and a hash-ref with response headers as
101second argument. 100second argument.
102 101
103All the headers in that hash are lowercased. In addition to the response 102All the headers in that hash are lowercased. In addition to the response
104headers, the "pseudo-headers" C<HTTPVersion>, C<Status> and C<Reason> 103headers, the "pseudo-headers" (uppercase to avoid clashing with possible
104response headers) C<HTTPVersion>, C<Status> and C<Reason> contain the
105contain the three parts of the HTTP Status-Line of the same name. The 105three parts of the HTTP Status-Line of the same name.
106
106pseudo-header C<URL> contains the original URL (which can differ from the 107The pseudo-header C<URL> contains the actual URL (which can differ from
107requested URL when following redirects). 108the requested URL when following redirects - for example, you might get
109an error that your URL scheme is not supported even though your URL is a
110valid http URL because it redirected to an ftp URL, in which case you can
111look at the URL pseudo header).
112
113The pseudo-header C<Redirect> only exists when the request was a result
114of an internal redirect. In that case it is an array reference with
115the C<($data, $headers)> from the redirect response. Note that this
116response could in turn be the result of a redirect itself, and C<<
117$headers->{Redirect}[1]{Redirect} >> will then contain the original
118response, and so on.
108 119
109If the server sends a header multiple times, then their contents will be 120If the server sends a header multiple times, then their contents will be
110joined together with a comma (C<,>), as per the HTTP spec. 121joined together with a comma (C<,>), as per the HTTP spec.
111 122
112If an internal error occurs, such as not being able to resolve a hostname, 123If an internal error occurs, such as not being able to resolve a hostname,
… …
138 149
139=item headers => hashref 150=item headers => hashref
140 151
141The request headers to use. Currently, C<http_request> may provide its 152The request headers to use. Currently, C<http_request> may provide its
142own C<Host:>, C<Content-Length:>, C<Connection:> and C<Cookie:> headers 153own C<Host:>, C<Content-Length:>, C<Connection:> and C<Cookie:> headers
143and will provide defaults for C<User-Agent:> and C<Referer:>. 154and will provide defaults for C<User-Agent:> and C<Referer:> (this can be
155suppressed by using C<undef> for these headers in which case they won't be
156sent at all).
144 157
145=item timeout => $seconds 158=item timeout => $seconds
146 159
147The time-out to use for various stages - each connect attempt will reset 160The time-out to use for various stages - each connect attempt will reset
148the timeout, as will read or write activity. Default timeout is 5 minutes. 161the timeout, as will read or write activity, i.e. this is not an overall
162timeout.
163
164Default timeout is 5 minutes.
149 165
150=item proxy => [$host, $port[, $scheme]] or undef 166=item proxy => [$host, $port[, $scheme]] or undef
151 167
152Use the given http proxy for all requests. If not specified, then the 168Use the given http proxy for all requests. If not specified, then the
153default proxy (as specified by C<$ENV{http_proxy}>) is used. 169default proxy (as specified by C<$ENV{http_proxy}>) is used.
154 170
155C<$scheme> must be either missing or C<http> for HTTP, or C<https> for 171C<$scheme> must be either missing, C<http> for HTTP or C<https> for
156HTTPS. 172HTTPS.
157 173
158=item body => $string 174=item body => $string
159 175
160The request body, usually empty. Will be-sent as-is (future versions of 176The request body, usually empty. Will be-sent as-is (future versions of
… …
185verification, highest compatibility) and high-security (CA and common-name 201verification, highest compatibility) and high-security (CA and common-name
186verification) TLS context. 202verification) TLS context.
187 203
188The default for this option is C<low>, which could be interpreted as "give 204The default for this option is C<low>, which could be interpreted as "give
189me the page, no matter what". 205me the page, no matter what".
206
207=item on_prepare => $callback->($fh)
208
209In rare cases you need to "tune" the socket before it is used to
210connect (for exmaple, to bind it on a given IP address). This parameter
211overrides the prepare callback passed to C<AnyEvent::Socket::tcp_connect>
212and behaves exactly the same way (e.g. it has to provide a
213timeout). See the description for the C<$prepare_cb> argument of
214C<AnyEvent::Socket::tcp_connect> for details.
215
216=item tcp_connect => $callback->($host, $service, $connect_cb, $prepare_cb)
217
218In even rarer cases you want total control over how AnyEvent::HTTP
219establishes connections. Normally it uses L<AnyEvent::Socket::tcp_connect>
220to do this, but you can provide your own C<tcp_connect> function -
221obviously, it has to follow the same calling conventions, except that it
222may always return a connection guard object.
223
224There are probably lots of weird uses for this function, starting from
225tracing the hosts C<http_request> actually tries to connect, to (inexact
226but fast) host => IP address caching or even socks protocol support.
190 227
191=item on_header => $callback->($headers) 228=item on_header => $callback->($headers)
192 229
193When specified, this callback will be called with the header hash as soon 230When specified, this callback will be called with the header hash as soon
194as headers have been successfully received from the remote server (not on 231as headers have been successfully received from the remote server (not on
… …
312 push @{ $CO_SLOT{$_[0]}[1] }, $_[1]; 349 push @{ $CO_SLOT{$_[0]}[1] }, $_[1];
313 350
314 _slot_schedule $_[0]; 351 _slot_schedule $_[0];
315} 352}
316 353
317our $qr_nl = qr<\015?\012>; 354our $qr_nlnl = qr{(?<![^\012])\015?\012};
318our $qr_nlnl = qr<\015?\012\015?\012>;
319 355
320our $TLS_CTX_LOW = { cache => 1, sslv2 => 1 }; 356our $TLS_CTX_LOW = { cache => 1, sslv2 => 1 };
321our $TLS_CTX_HIGH = { cache => 1, verify => 1, verify_peername => "https" }; 357our $TLS_CTX_HIGH = { cache => 1, verify => 1, verify_peername => "https" };
322 358
323sub http_request($$@) { 359sub http_request($$@) {
… …
335 while (my ($k, $v) = each %$hdr) { 371 while (my ($k, $v) = each %$hdr) {
336 $hdr{lc $k} = $v; 372 $hdr{lc $k} = $v;
337 } 373 }
338 } 374 }
339 375
376 # pseudo headers for all subsequent responses
377 my @pseudo = (URL => $url);
378 push @pseudo, Redirect => delete $arg{Redirect} if exists $arg{Redirect};
379
340 my $recurse = exists $arg{recurse} ? delete $arg{recurse} : $MAX_RECURSE; 380 my $recurse = exists $arg{recurse} ? delete $arg{recurse} : $MAX_RECURSE;
341 381
342 return $cb->(undef, { Status => 599, Reason => "Too many redirections", URL => $url }) 382 return $cb->(undef, { Status => 599, Reason => "Too many redirections", @pseudo })
343 if $recurse < 0; 383 if $recurse < 0;
344 384
345 my $proxy = $arg{proxy} || $PROXY; 385 my $proxy = $arg{proxy} || $PROXY;
346 my $timeout = $arg{timeout} || $TIMEOUT; 386 my $timeout = $arg{timeout} || $TIMEOUT;
347 387
348 my ($uscheme, $uauthority, $upath, $query, $fragment) = 388 my ($uscheme, $uauthority, $upath, $query, $fragment) =
349 $url =~ m|(?:([^:/?#]+):)?(?://([^/?#]*))?([^?#]*)(?:\?([^#]*))?(?:#(.*))?|; 389 $url =~ m|(?:([^:/?#]+):)?(?://([^/?#]*))?([^?#]*)(?:(\?[^#]*))?(?:#(.*))?|;
350 390
351 $uscheme = lc $uscheme; 391 $uscheme = lc $uscheme;
352 392
353 my $uport = $uscheme eq "http" ? 80 393 my $uport = $uscheme eq "http" ? 80
354 : $uscheme eq "https" ? 443 394 : $uscheme eq "https" ? 443
355 : return $cb->(undef, { Status => 599, Reason => "Only http and https URL schemes supported", URL => $url }); 395 : return $cb->(undef, { Status => 599, Reason => "Only http and https URL schemes supported", @pseudo });
356 396
357 $uauthority =~ /^(?: .*\@ )? ([^\@:]+) (?: : (\d+) )?$/x 397 $uauthority =~ /^(?: .*\@ )? ([^\@:]+) (?: : (\d+) )?$/x
358 or return $cb->(undef, { Status => 599, Reason => "Unparsable URL", URL => $url }); 398 or return $cb->(undef, { Status => 599, Reason => "Unparsable URL", @pseudo });
359 399
360 my $uhost = $1; 400 my $uhost = $1;
361 $uport = $2 if defined $2; 401 $uport = $2 if defined $2;
362 402
363 $hdr{host} = defined $2 ? "$uhost:$2" : "$uhost"; 403 $hdr{host} = defined $2 ? "$uhost:$2" : "$uhost"
404 unless exists $hdr{host};
364 405
365 $uhost =~ s/^\[(.*)\]$/$1/; 406 $uhost =~ s/^\[(.*)\]$/$1/;
366 $upath .= "?$query" if length $query; 407 $upath .= $query if length $query;
367 408
368 $upath =~ s%^/?%/%; 409 $upath =~ s%^/?%/%;
369 410
370 # cookie processing 411 # cookie processing
371 if (my $jar = $arg{cookie_jar}) { 412 if (my $jar = $arg{cookie_jar}) {
… …
401 my ($rhost, $rport, $rscheme, $rpath); # request host, port, path 442 my ($rhost, $rport, $rscheme, $rpath); # request host, port, path
402 443
403 if ($proxy) { 444 if ($proxy) {
404 ($rpath, $rhost, $rport, $rscheme) = ($url, @$proxy); 445 ($rpath, $rhost, $rport, $rscheme) = ($url, @$proxy);
405 446
447 $rscheme = "http" unless defined $rscheme;
448
406 # don't support https requests over https-proxy transport, 449 # don't support https requests over https-proxy transport,
407 # can't be done with tls as spec'ed, unless you double-encrypt. 450 # can't be done with tls as spec'ed, unless you double-encrypt.
408 $rscheme = "http" if $uscheme eq "https" && $rscheme eq "https"; 451 $rscheme = "http" if $uscheme eq "https" && $rscheme eq "https";
409 } else { 452 } else {
410 ($rhost, $rport, $rscheme, $rpath) = ($uhost, $uport, $uscheme, $upath); 453 ($rhost, $rport, $rscheme, $rpath) = ($uhost, $uport, $uscheme, $upath);
411 } 454 }
412 455
413 $hdr{"user-agent"} ||= $USERAGENT; 456 # leave out fragment and query string, just a heuristic
414 $hdr{referer} ||= "$uscheme://$uauthority$upath"; # leave out fragment and query string, just a heuristic 457 $hdr{referer} ||= "$uscheme://$uauthority$upath" unless exists $hdr{referer};
458 $hdr{"user-agent"} ||= $USERAGENT unless exists $hdr{"user-agent"};
415 459
416 $hdr{"content-length"} = length $arg{body}; 460 $hdr{"content-length"} = length $arg{body}
461 if length $arg{body} || $method ne "GET";
417 462
418 my %state = (connect_guard => 1); 463 my %state = (connect_guard => 1);
419 464
420 _get_slot $uhost, sub { 465 _get_slot $uhost, sub {
421 $state{slot_guard} = shift; 466 $state{slot_guard} = shift;
422 467
423 return unless $state{connect_guard}; 468 return unless $state{connect_guard};
424 469
425 $state{connect_guard} = AnyEvent::Socket::tcp_connect $rhost, $rport, sub { 470 my $tcp_connect = $arg{tcp_connect}
471 || do { require AnyEvent::Socket; \&AnyEvent::Socket::tcp_connect };
472
473 $state{connect_guard} = $tcp_connect->(
474 $rhost,
475 $rport,
476 sub {
426 $state{fh} = shift 477 $state{fh} = shift
427 or do { 478 or do {
428 my $err = "$!"; 479 my $err = "$!";
429 %state = (); 480 %state = ();
430 return $cb->(undef, { Status => 599, Reason => $err, URL => $url }); 481 return $cb->(undef, { Status => 599, Reason => $err, @pseudo });
431 }; 482 };
432 483
433 pop; # free memory, save a tree 484 pop; # free memory, save a tree
434 485
435 return unless delete $state{connect_guard}; 486 return unless delete $state{connect_guard};
436 487
437 # get handle 488 # get handle
438 $state{handle} = new AnyEvent::Handle 489 $state{handle} = new AnyEvent::Handle
439 fh => $state{fh}, 490 fh => $state{fh},
491 peername => $rhost,
492 tls_ctx => $arg{tls_ctx},
493 # these need to be reconfigured on keepalive handles
440 timeout => $timeout, 494 timeout => $timeout,
441 peername => $rhost, 495 on_error => sub {
442 tls_ctx => $arg{tls_ctx}; 496 %state = ();
497 $cb->(undef, { Status => 599, Reason => $_[2], @pseudo });
498 },
499 on_eof => sub {
500 %state = ();
501 $cb->(undef, { Status => 599, Reason => "Unexpected end-of-file", @pseudo });
502 },
503 ;
443 504
444 # limit the number of persistent connections 505 # limit the number of persistent connections
445 # keepalive not yet supported 506 # keepalive not yet supported
446 if ($KA_COUNT{$_[1]} < $MAX_PERSISTENT_PER_HOST) { 507# if ($KA_COUNT{$_[1]} < $MAX_PERSISTENT_PER_HOST) {
447 ++$KA_COUNT{$_[1]}; 508# ++$KA_COUNT{$_[1]};
448 $state{handle}{ka_count_guard} = AnyEvent::Util::guard { 509# $state{handle}{ka_count_guard} = AnyEvent::Util::guard {
449 --$KA_COUNT{$_[1]} 510# --$KA_COUNT{$_[1]}
450 }; 511# };
451 $hdr{connection} = "keep-alive"; 512# $hdr{connection} = "keep-alive";
452 } else { 513# } else {
453 delete $hdr{connection}; 514 delete $hdr{connection};
454 } 515# }
455 516
456 # (re-)configure handle
457 $state{handle}->on_error (sub {
458 %state = ();
459 $cb->(undef, { Status => 599, Reason => $_[2], URL => $url });
460 });
461 $state{handle}->on_eof (sub {
462 %state = ();
463 $cb->(undef, { Status => 599, Reason => "Unexpected end-of-file", URL => $url });
464 });
465
466 $state{handle}->starttls ("connect") if $rscheme eq "https"; 517 $state{handle}->starttls ("connect") if $rscheme eq "https";
467 518
468 # handle actual, non-tunneled, request 519 # handle actual, non-tunneled, request
469 my $handle_actual_request = sub { 520 my $handle_actual_request = sub {
470 $state{handle}->starttls ("connect") if $uscheme eq "https" && !exists $state{handle}{tls}; 521 $state{handle}->starttls ("connect") if $uscheme eq "https" && !exists $state{handle}{tls};
471 522
472 # send request 523 # send request
473 $state{handle}->push_write ( 524 $state{handle}->push_write (
474 "$method $rpath HTTP/1.0\015\012" 525 "$method $rpath HTTP/1.0\015\012"
475 . (join "", map "\u$_: $hdr{$_}\015\012", keys %hdr) 526 . (join "", map "\u$_: $hdr{$_}\015\012", grep defined $hdr{$_}, keys %hdr)
476 . "\015\012" 527 . "\015\012"
477 . (delete $arg{body}) 528 . (delete $arg{body})
478 );
479
480 %hdr = (); # reduce memory usage, save a kitten
481
482 # status line
483 $state{handle}->push_read (line => $qr_nl, sub {
484 $_[1] =~ /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\015\012]*) )?/ix
485 or return (%state = (), $cb->(undef, { Status => 599, Reason => "Invalid server response ($_[1])", URL => $url }));
486
487 my %hdr = ( # response headers
488 HTTPVersion => ",$1",
489 Status => ",$2",
490 Reason => ",$3",
491 URL => ",$url"
492 ); 529 );
493 530
494 # headers, could be optimized a bit 531 # return if error occured during push_write()
532 return unless %state;
533
534 %hdr = (); # reduce memory usage, save a kitten, also make it possible to re-use
535
536 # status line and headers
495 $state{handle}->unshift_read (line => $qr_nlnl, sub { 537 $state{handle}->push_read (line => $qr_nlnl, sub {
496 for ("$_[1]\012") { 538 for ("$_[1]") {
497 y/\015//d; # weed out any \015, as they show up in the weirdest of places. 539 y/\015//d; # weed out any \015, as they show up in the weirdest of places.
540
541 /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\015\012]*) )? \015?\012/igxc
542 or return (%state = (), $cb->(undef, { Status => 599, Reason => "Invalid server response", @pseudo }));
543
544 push @pseudo,
545 HTTPVersion => $1,
546 Status => $2,
547 Reason => $3,
548 ;
498 549
499 # things seen, not parsed: 550 # things seen, not parsed:
500 # p3pP="NON CUR OTPi OUR NOR UNI" 551 # p3pP="NON CUR OTPi OUR NOR UNI"
501 552
502 $hdr{lc $1} .= ",$2" 553 $hdr{lc $1} .= ",$2"
… …
506 ((?: [^\012]+ | \012[\011\040] )*) 557 ((?: [^\012]+ | \012[\011\040] )*)
507 \012 558 \012
508 /gxc; 559 /gxc;
509 560
510 /\G$/ 561 /\G$/
511 or return (%state = (), $cb->(undef, { Status => 599, Reason => "Garbled response headers", URL => $url })); 562 or return (%state = (), $cb->(undef, { Status => 599, Reason => "Garbled response headers", @pseudo }));
512 } 563 }
513 564
565 # remove the "," prefix we added to all headers above
514 substr $_, 0, 1, "" 566 substr $_, 0, 1, ""
515 for values %hdr; 567 for values %hdr;
568
569 # patch in all pseudo headers
570 %hdr = (%hdr, @pseudo);
516 571
517 # redirect handling 572 # redirect handling
518 # microsoft and other shitheads don't give a shit for following standards, 573 # microsoft and other shitheads don't give a shit for following standards,
519 # try to support some common forms of broken Location headers. 574 # try to support some common forms of broken Location headers.
520 if ($hdr{location} !~ /^(?: $ | [^:\/?\#]+ : )/x) { 575 if ($hdr{location} !~ /^(?: $ | [^:\/?\#]+ : )/x) {
… …
531 } 586 }
532 587
533 my $redirect; 588 my $redirect;
534 589
535 if ($recurse) { 590 if ($recurse) {
536 if ($hdr{Status} =~ /^30[12]$/ && $method ne "POST") { 591 my $status = $hdr{Status};
537 # apparently, mozilla et al. just change POST to GET here 592
538 # more research is needed before we do the same 593 # industry standard is to redirect POST as GET for
539 $redirect = 1; 594 # 301, 302 and 303, in contrast to http/1.0 and 1.1.
540 } elsif ($hdr{Status} == 303) { 595 # also, the UA should ask the user for 301 and 307 and POST,
596 # industry standard seems to be to simply follow.
597 # we go with the industry standard.
598 if ($status == 301 or $status == 302 or $status == 303) {
541 # even http/1.1 is unclear on how to mutate the method 599 # HTTP/1.1 is unclear on how to mutate the method
542 $method = "GET" unless $method eq "HEAD"; 600 $method = "GET" unless $method eq "HEAD";
543 $redirect = 1; 601 $redirect = 1;
544 } elsif ($hdr{Status} == 307 && $method =~ /^(?:GET|HEAD)$/) { 602 } elsif ($status == 307) {
545 $redirect = 1; 603 $redirect = 1;
546 } 604 }
547 } 605 }
548 606
549 my $finish = sub { 607 my $finish = sub {
… …
598 656
599 redo if /\G\s*,/gc; 657 redo if /\G\s*,/gc;
600 } 658 }
601 } 659 }
602 660
603 if ($redirect) { 661 if ($redirect && exists $hdr{location}) {
604 # we ignore any errors, as it is very common to receive 662 # we ignore any errors, as it is very common to receive
605 # Content-Length != 0 but no actual body 663 # Content-Length != 0 but no actual body
606 # we also access %hdr, as $_[1] might be an erro 664 # we also access %hdr, as $_[1] might be an erro
607 http_request ($method => $hdr{location}, %arg, recurse => $recurse - 1, $cb); 665 http_request (
666 $method => $hdr{location},
667 %arg,
668 recurse => $recurse - 1,
669 Redirect => \@_,
670 $cb);
608 } else { 671 } else {
609 $cb->($_[0], $_[1]); 672 $cb->($_[0], $_[1]);
610 } 673 }
611 }; 674 };
612 675
613 my $len = $hdr{"content-length"}; 676 my $len = $hdr{"content-length"};
614 677
615 if (!$redirect && $arg{on_header} && !$arg{on_header}(\%hdr)) { 678 if (!$redirect && $arg{on_header} && !$arg{on_header}(\%hdr)) {
616 $finish->(undef, { Status => 598, Reason => "Request cancelled by on_header", URL => $url }); 679 $finish->(undef, { Status => 598, Reason => "Request cancelled by on_header", @pseudo });
617 } elsif ( 680 } elsif (
618 $hdr{Status} =~ /^(?:1..|[23]04)$/ 681 $hdr{Status} =~ /^(?:1..|[23]04)$/
619 or $method eq "HEAD" 682 or $method eq "HEAD"
620 or (defined $len && !$len) 683 or (defined $len && !$len)
621 ) { 684 ) {
… …
624 } else { 687 } else {
625 # body handling, four different code paths 688 # body handling, four different code paths
626 # for want_body_handle, on_body (2x), normal (2x) 689 # for want_body_handle, on_body (2x), normal (2x)
627 # we might read too much here, but it does not matter yet (no pers. connections) 690 # we might read too much here, but it does not matter yet (no pers. connections)
628 if (!$redirect && $arg{want_body_handle}) { 691 if (!$redirect && $arg{want_body_handle}) {
629 $_[0]->on_eof (undef); 692 $_[0]->on_eof (undef);
630 $_[0]->on_error (undef); 693 $_[0]->on_error (undef);
631 $_[0]->on_read (undef); 694 $_[0]->on_read (undef);
632 695
633 $finish->(delete $state{handle}, \%hdr); 696 $finish->(delete $state{handle}, \%hdr);
634 697
635 } elsif ($arg{on_body}) { 698 } elsif ($arg{on_body}) {
636 $_[0]->on_error (sub { $finish->(undef, { Status => 599, Reason => $_[2], URL => $url }) }); 699 $_[0]->on_error (sub { $finish->(undef, { Status => 599, Reason => $_[2], @pseudo }) });
637 if ($len) { 700 if ($len) {
638 $_[0]->on_eof (undef); 701 $_[0]->on_eof (undef);
639 $_[0]->on_read (sub { 702 $_[0]->on_read (sub {
640 $len -= length $_[0]{rbuf}; 703 $len -= length $_[0]{rbuf};
641 704
642 $arg{on_body}(delete $_[0]{rbuf}, \%hdr) 705 $arg{on_body}(delete $_[0]{rbuf}, \%hdr)
643 or $finish->(undef, { Status => 598, Reason => "Request cancelled by on_body", URL => $url }); 706 or $finish->(undef, { Status => 598, Reason => "Request cancelled by on_body", @pseudo });
644 707
645 $len > 0 708 $len > 0
646 or $finish->("", \%hdr); 709 or $finish->("", \%hdr);
647 }); 710 });
648 } else { 711 } else {
649 $_[0]->on_eof (sub { 712 $_[0]->on_eof (sub {
650 $finish->("", \%hdr); 713 $finish->("", \%hdr);
651 }); 714 });
652 $_[0]->on_read (sub { 715 $_[0]->on_read (sub {
653 $arg{on_body}(delete $_[0]{rbuf}, \%hdr) 716 $arg{on_body}(delete $_[0]{rbuf}, \%hdr)
654 or $finish->(undef, { Status => 598, Reason => "Request cancelled by on_body", URL => $url }); 717 or $finish->(undef, { Status => 598, Reason => "Request cancelled by on_body", @pseudo });
655 }); 718 });
656 } 719 }
657 } else { 720 } else {
658 $_[0]->on_eof (undef); 721 $_[0]->on_eof (undef);
659 722
660 if ($len) { 723 if ($len) {
661 $_[0]->on_error (sub { $finish->(undef, { Status => 599, Reason => $_[2], URL => $url }) }); 724 $_[0]->on_error (sub { $finish->(undef, { Status => 599, Reason => $_[2], @pseudo }) });
662 $_[0]->on_read (sub { 725 $_[0]->on_read (sub {
663 $finish->((substr delete $_[0]{rbuf}, 0, $len, ""), \%hdr) 726 $finish->((substr delete $_[0]{rbuf}, 0, $len, ""), \%hdr)
664 if $len <= length $_[0]{rbuf}; 727 if $len <= length $_[0]{rbuf};
665 }); 728 });
666 } else { 729 } else {
667 $_[0]->on_error (sub { 730 $_[0]->on_error (sub {
668 $! == Errno::EPIPE || !$! 731 ($! == Errno::EPIPE || !$!)
669 ? $finish->(delete $_[0]{rbuf}, \%hdr) 732 ? $finish->(delete $_[0]{rbuf}, \%hdr)
670 : $finish->(undef, { Status => 599, Reason => $_[2], URL => $url }); 733 : $finish->(undef, { Status => 599, Reason => $_[2], @pseudo });
671 }); 734 });
672 $_[0]->on_read (sub { }); 735 $_[0]->on_read (sub { });
673 } 736 }
674 } 737 }
675 } 738 }
676 }); 739 });
677 }); 740 };
678 };
679 741
680 # now handle proxy-CONNECT method 742 # now handle proxy-CONNECT method
681 if ($proxy && $uscheme eq "https") { 743 if ($proxy && $uscheme eq "https") {
682 # oh dear, we have to wrap it into a connect request 744 # oh dear, we have to wrap it into a connect request
683 745
684 # maybe re-use $uauthority with patched port? 746 # maybe re-use $uauthority with patched port?
685 $state{handle}->push_write ("CONNECT $uhost:$uport HTTP/1.0\015\012Host: $uhost\015\012\015\012"); 747 $state{handle}->push_write ("CONNECT $uhost:$uport HTTP/1.0\015\012Host: $uhost\015\012\015\012");
686 $state{handle}->push_read (line => $qr_nlnl, sub { 748 $state{handle}->push_read (line => $qr_nlnl, sub {
687 $_[1] =~ /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\015\012]*) )?/ix 749 $_[1] =~ /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\015\012]*) )?/ix
688 or return (%state = (), $cb->(undef, { Status => 599, Reason => "Invalid proxy connect response ($_[1])", URL => $url })); 750 or return (%state = (), $cb->(undef, { Status => 599, Reason => "Invalid proxy connect response ($_[1])", @pseudo }));
689 751
690 if ($2 == 200) { 752 if ($2 == 200) {
691 $rpath = $upath; 753 $rpath = $upath;
692 &$handle_actual_request; 754 &$handle_actual_request;
693 } else { 755 } else {
694 %state = (); 756 %state = ();
695 $cb->(undef, { Status => $2, Reason => $3, URL => $url }); 757 $cb->(undef, { Status => $2, Reason => $3, @pseudo });
758 }
696 } 759 });
697 });
698 } else { 760 } else {
699 &$handle_actual_request; 761 &$handle_actual_request;
762 }
763
700 } 764 },
701 765 $arg{on_prepare} || sub { $timeout }
702 }, sub {
703 $timeout
704 }; 766 );
705 }; 767 };
706 768
707 defined wantarray && AnyEvent::Util::guard { %state = () } 769 defined wantarray && AnyEvent::Util::guard { %state = () }
708} 770}
709 771
… …
723 &http_request 785 &http_request
724} 786}
725 787
726=back 788=back
727 789
790=head2 DNS CACHING
791
792AnyEvent::HTTP uses the AnyEvent::Socket::tcp_connect function for
793the actual connection, which in turn uses AnyEvent::DNS to resolve
794hostnames. The latter is a simple stub resolver and does no caching
795on its own. If you want DNS caching, you currently have to provide
796your own default resolver (by storing a suitable resolver object in
797C<$AnyEvent::DNS::RESOLVER>).
798
728=head2 GLOBAL FUNCTIONS AND VARIABLES 799=head2 GLOBAL FUNCTIONS AND VARIABLES
729 800
730=over 4 801=over 4
731 802
732=item AnyEvent::HTTP::set_proxy "proxy-url" 803=item AnyEvent::HTTP::set_proxy "proxy-url"
733 804
734Sets the default proxy server to use. The proxy-url must begin with a 805Sets the default proxy server to use. The proxy-url must begin with a
735string of the form C<http://host:port> (optionally C<https:...>). 806string of the form C<http://host:port> (optionally C<https:...>), croaks
807otherwise.
808
809To clear an already-set proxy, use C<undef>.
810
811=item $date = AnyEvent::HTTP::format_date $timestamp
812
813Takes a POSIX timestamp (seconds since the epoch) and formats it as a HTTP
814Date (RFC 2616).
815
816=item $timestamp = AnyEvent::HTTP::parse_date $date
817
818Takes a HTTP Date (RFC 2616) and returns the corresponding POSIX
819timestamp, or C<undef> if the date cannot be parsed.
736 820
737=item $AnyEvent::HTTP::MAX_RECURSE 821=item $AnyEvent::HTTP::MAX_RECURSE
738 822
739The default value for the C<recurse> request parameter (default: C<10>). 823The default value for the C<recurse> request parameter (default: C<10>).
740 824
… …
743The default value for the C<User-Agent> header (the default is 827The default value for the C<User-Agent> header (the default is
744C<Mozilla/5.0 (compatible; U; AnyEvent-HTTP/$VERSION; +http://software.schmorp.de/pkg/AnyEvent)>). 828C<Mozilla/5.0 (compatible; U; AnyEvent-HTTP/$VERSION; +http://software.schmorp.de/pkg/AnyEvent)>).
745 829
746=item $AnyEvent::HTTP::MAX_PER_HOST 830=item $AnyEvent::HTTP::MAX_PER_HOST
747 831
748The maximum number of concurrent conenctions to the same host (identified 832The maximum number of concurrent connections to the same host (identified
749by the hostname). If the limit is exceeded, then the additional requests 833by the hostname). If the limit is exceeded, then the additional requests
750are queued until previous connections are closed. 834are queued until previous connections are closed.
751 835
752The default value for this is C<4>, and it is highly advisable to not 836The default value for this is C<4>, and it is highly advisable to not
753increase it. 837increase it.
… …
760 844
761=back 845=back
762 846
763=cut 847=cut
764 848
849our @month = qw(Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec);
850our @weekday = qw(Sun Mon Tue Wed Thu Fri Sat);
851
852sub format_date($) {
853 my ($time) = @_;
854
855 # RFC 822/1123 format
856 my ($S, $M, $H, $mday, $mon, $year, $wday, $yday, undef) = gmtime $time;
857
858 sprintf "%s, %02d %s %04d %02d:%02d:%02d GMT",
859 $weekday[$wday], $mday, $month[$mon], $year + 1900,
860 $H, $M, $S;
861}
862
863sub parse_date($) {
864 my ($date) = @_;
865
866 my ($d, $m, $y, $H, $M, $S);
867
868 if ($date =~ /^[A-Z][a-z][a-z], ([0-9][0-9]) ([A-Z][a-z][a-z]) ([0-9][0-9][0-9][0-9]) ([0-9][0-9]):([0-9][0-9]):([0-9][0-9]) GMT$/) {
869 # RFC 822/1123, required by RFC 2616
870 ($d, $m, $y, $H, $M, $S) = ($1, $2, $3, $4, $5, $6);
871
872 } elsif ($date =~ /^[A-Z][a-z]+, ([0-9][0-9])-([A-Z][a-z][a-z])-([0-9][0-9]) ([0-9][0-9]):([0-9][0-9]):([0-9][0-9]) GMT$/) {
873 # RFC 850
874 ($d, $m, $y, $H, $M, $S) = ($1, $2, $3 < 69 ? $3 + 2000 : $3 + 1900, $4, $5, $6);
875
876 } elsif ($date =~ /^[A-Z][a-z][a-z] ([A-Z][a-z][a-z]) ([0-9 ][0-9]) ([0-9][0-9]):([0-9][0-9]):([0-9][0-9]) ([0-9][0-9][0-9][0-9])$/) {
877 # ISO C's asctime
878 ($d, $m, $y, $H, $M, $S) = ($2, $1, $6, $3, $4, $5);
879 }
880 # other formats fail in the loop below
881
882 for (0..11) {
883 if ($m eq $month[$_]) {
884 require Time::Local;
885 return Time::Local::timegm ($S, $M, $H, $d, $_, $y);
886 }
887 }
888
889 undef
890}
891
765sub set_proxy($) { 892sub set_proxy($) {
893 if (length $_[0]) {
766 $PROXY = [$2, $3 || 3128, $1] if $_[0] =~ m%^(https?):// ([^:/]+) (?: : (\d*) )?%ix; 894 $_[0] =~ m%^(https?):// ([^:/]+) (?: : (\d*) )?%ix
895 or Carp::croak "$_[0]: invalid proxy URL";
896 $PROXY = [$2, $3 || 3128, $1]
897 } else {
898 undef $PROXY;
899 }
767} 900}
768 901
769# initialise proxy from environment 902# initialise proxy from environment
903eval {
770set_proxy $ENV{http_proxy}; 904 set_proxy $ENV{http_proxy};
905};
906
907=head2 SOCKS PROXIES
908
909Socks proxies are not directly supported by AnyEvent::HTTP. You can
910compile your perl to support socks, or use an external program such as
911F<socksify> (dante) or F<tsocks> to make your program use a socks proxy
912transparently.
913
914Alternatively, for AnyEvent::HTTP only, you can use your own
915C<tcp_connect> function that does the proxy handshake - here is an example
916that works with socks4a proxies:
917
918 use Errno;
919 use AnyEvent::Util;
920 use AnyEvent::Socket;
921 use AnyEvent::Handle;
922
923 # host, port and username of/for your socks4a proxy
924 my $socks_host = "10.0.0.23";
925 my $socks_port = 9050;
926 my $socks_user = "";
927
928 sub socks4a_connect {
929 my ($host, $port, $connect_cb, $prepare_cb) = @_;
930
931 my $hdl = new AnyEvent::Handle
932 connect => [$socks_host, $socks_port],
933 on_prepare => sub { $prepare_cb->($_[0]{fh}) },
934 on_error => sub { $connect_cb->() },
935 ;
936
937 $hdl->push_write (pack "CCnNZ*Z*", 4, 1, $port, 1, $socks_user, $host);
938
939 $hdl->push_read (chunk => 8, sub {
940 my ($hdl, $chunk) = @_;
941 my ($status, $port, $ipn) = unpack "xCna4", $chunk;
942
943 if ($status == 0x5a) {
944 $connect_cb->($hdl->{fh}, (format_address $ipn) . ":$port");
945 } else {
946 $! = Errno::ENXIO; $connect_cb->();
947 }
948 });
949
950 $hdl
951 }
952
953Use C<socks4a_connect> instead of C<tcp_connect> when doing C<http_request>s,
954possibly after switching off other proxy types:
955
956 AnyEvent::HTTP::set_proxy undef; # usually you do not want other proxies
957
958 http_get 'http://www.google.com', tcp_connect => \&socks4a_connect, sub {
959 my ($data, $headers) = @_;
960 ...
961 };
771 962
772=head1 SEE ALSO 963=head1 SEE ALSO
773 964
774L<AnyEvent>. 965L<AnyEvent>.
775 966

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines