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.82 by root, Sun Jan 2 04:50:40 2011 UTC vs.
Revision 1.103 by root, Thu Feb 24 12:13:11 2011 UTC

15This 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
16run a supported event loop. 16run a supported event loop.
17 17
18This module implements a simple, stateless and non-blocking HTTP 18This module implements a simple, stateless and non-blocking HTTP
19client. It supports GET, POST and other request methods, cookies and more, 19client. It supports GET, POST and other request methods, cookies and more,
20all on a very low level. It can follow redirects supports proxies and 20all on a very low level. It can follow redirects, supports proxies, and
21automatically limits the number of connections to the values specified in 21automatically limits the number of connections to the values specified in
22the RFC. 22the RFC.
23 23
24It should generally be a "good client" that is enough for most HTTP 24It should generally be a "good client" that is enough for most HTTP
25tasks. Simple tasks should be simple, but complex tasks should still be 25tasks. Simple tasks should be simple, but complex tasks should still be
36 36
37=cut 37=cut
38 38
39package AnyEvent::HTTP; 39package AnyEvent::HTTP;
40 40
41use strict; 41use common::sense;
42no warnings;
43 42
44use Errno (); 43use Errno ();
45 44
46use AnyEvent 5.0 (); 45use AnyEvent 5.0 ();
47use AnyEvent::Util (); 46use AnyEvent::Util ();
48use AnyEvent::Handle (); 47use AnyEvent::Handle ();
49 48
50use base Exporter::; 49use base Exporter::;
51 50
52our $VERSION = '1.5'; 51our $VERSION = '2.1';
53 52
54our @EXPORT = qw(http_get http_post http_head http_request); 53our @EXPORT = qw(http_get http_post http_head http_request);
55 54
56our $USERAGENT = "Mozilla/5.0 (compatible; U; AnyEvent-HTTP/$VERSION; +http://software.schmorp.de/pkg/AnyEvent)"; 55our $USERAGENT = "Mozilla/5.0 (compatible; U; AnyEvent-HTTP/$VERSION; +http://software.schmorp.de/pkg/AnyEvent)";
57our $MAX_RECURSE = 10; 56our $MAX_RECURSE = 10;
58our $MAX_PERSISTENT = 8;
59our $PERSISTENT_TIMEOUT = 2; 57our $PERSISTENT_TIMEOUT = 3;
60our $TIMEOUT = 300; 58our $TIMEOUT = 300;
61 59our $MAX_PER_HOST = 4; # changing this is evil
62# changing these is evil
63our $MAX_PERSISTENT_PER_HOST = 0;
64our $MAX_PER_HOST = 4;
65 60
66our $PROXY; 61our $PROXY;
67our $ACTIVE = 0; 62our $ACTIVE = 0;
68 63
69my %KA_COUNT; # number of open keep-alive connections per host 64my %KA_CACHE; # indexed by uhost currently, points to [$handle...] array
70my %CO_SLOT; # number of open connections, and wait queue, per host 65my %CO_SLOT; # number of open connections, and wait queue, per host
71 66
72=item http_get $url, key => value..., $cb->($data, $headers) 67=item http_get $url, key => value..., $cb->($data, $headers)
73 68
74Executes an HTTP-GET request. See the http_request function for details on 69Executes an HTTP-GET request. See the http_request function for details on
170C<Host:>, C<Content-Length:>, C<Connection:> and C<Cookie:> headers and 165C<Host:>, C<Content-Length:>, C<Connection:> and C<Cookie:> headers and
171will provide defaults at least for C<TE:>, C<Referer:> and C<User-Agent:> 166will provide defaults at least for C<TE:>, C<Referer:> and C<User-Agent:>
172(this can be suppressed by using C<undef> for these headers in which case 167(this can be suppressed by using C<undef> for these headers in which case
173they won't be sent at all). 168they won't be sent at all).
174 169
170You really should provide your own C<User-Agent:> header value that is
171appropriate for your program - I wouldn't be surprised if the default
172AnyEvent string gets blocked by webservers sooner or later.
173
175=item timeout => $seconds 174=item timeout => $seconds
176 175
177The time-out to use for various stages - each connect attempt will reset 176The time-out to use for various stages - each connect attempt will reset
178the timeout, as will read or write activity, i.e. this is not an overall 177the timeout, as will read or write activity, i.e. this is not an overall
179timeout. 178timeout.
180 179
181Default timeout is 5 minutes. 180Default timeout is 5 minutes.
182 181
183=item proxy => [$host, $port[, $scheme]] or undef 182=item proxy => [$host, $port[, $scheme]] or undef
184 183
185Use the given http proxy for all requests. If not specified, then the 184Use the given http proxy for all requests, or no proxy if C<undef> is
186default proxy (as specified by C<$ENV{http_proxy}>) is used. 185used.
187 186
188C<$scheme> must be either missing, C<http> for HTTP or C<https> for 187C<$scheme> must be either missing or must be C<http> for HTTP.
189HTTPS. 188
189If not specified, then the default proxy is used (see
190C<AnyEvent::HTTP::set_proxy>).
190 191
191=item body => $string 192=item body => $string
192 193
193The request body, usually empty. Will be sent as-is (future versions of 194The request body, usually empty. Will be sent as-is (future versions of
194this module might offer more options). 195this module might offer more options).
224verification, highest compatibility) and high-security (CA and common-name 225verification, highest compatibility) and high-security (CA and common-name
225verification) TLS context. 226verification) TLS context.
226 227
227The default for this option is C<low>, which could be interpreted as "give 228The default for this option is C<low>, which could be interpreted as "give
228me the page, no matter what". 229me the page, no matter what".
230
231See also the C<sessionid> parameter.
232
233=item session => $string
234
235The module might reuse connections to the same host internally. Sometimes
236(e.g. when using TLS), you do not want to reuse connections from other
237sessions. This can be achieved by setting this parameter to some unique
238ID (such as the address of an object storing your state data, or the TLS
239context) - only connections using the same unique ID will be reused.
229 240
230=item on_prepare => $callback->($fh) 241=item on_prepare => $callback->($fh)
231 242
232In rare cases you need to "tune" the socket before it is used to 243In rare cases you need to "tune" the socket before it is used to
233connect (for exmaple, to bind it on a given IP address). This parameter 244connect (for exmaple, to bind it on a given IP address). This parameter
303called. Instead of the C<$body> argument containing the body data, the 314called. Instead of the C<$body> argument containing the body data, the
304callback will receive the L<AnyEvent::Handle> object associated with the 315callback will receive the L<AnyEvent::Handle> object associated with the
305connection. In error cases, C<undef> will be passed. When there is no body 316connection. In error cases, C<undef> will be passed. When there is no body
306(e.g. status C<304>), the empty string will be passed. 317(e.g. status C<304>), the empty string will be passed.
307 318
308The handle object might or might not be in TLS mode, might be connected to 319The handle object might or might not be in TLS mode, might be connected
309a proxy, be a persistent connection etc., and configured in unspecified 320to a proxy, be a persistent connection, use chunked transfer encoding
310ways. The user is responsible for this handle (it will not be used by this 321etc., and configured in unspecified ways. The user is responsible for this
311module anymore). 322handle (it will not be used by this module anymore).
312 323
313This is useful with some push-type services, where, after the initial 324This is useful with some push-type services, where, after the initial
314headers, an interactive protocol is used (typical example would be the 325headers, an interactive protocol is used (typical example would be the
315push-style twitter API which starts a JSON/XML stream). 326push-style twitter API which starts a JSON/XML stream).
316 327
317If you think you need this, first have a look at C<on_body>, to see if 328If you think you need this, first have a look at C<on_body>, to see if
318that doesn't solve your problem in a better way. 329that doesn't solve your problem in a better way.
330
331=item persistent => $boolean
332
333Try to create/reuse a persistent connection. When this flag is set
334(default: true for idempotent requests, false for all others), then
335C<http_request> tries to re-use an existing (previously-created)
336persistent connection to the host and, failing that, tries to create a new
337one.
338
339Requests failing in certain ways will be automatically retried once, which
340is dangerous for non-idempotent requests, which is why it defaults to off
341for them. The reason for this is because the bozos who designed HTTP/1.1
342made it impossible to distinguish between a fatal error and a normal
343connection timeout, so you never know whether there was a problem with
344your request or not.
345
346When reusing an existent connection, many parameters (such as TLS context)
347will be ignored. See the C<session> parameter for a workaround.
348
349=item keepalive => $boolean
350
351Only used when C<persistent> is also true. This parameter decides whether
352C<http_request> tries to handshake a HTTP/1.0-style keep-alive connection
353(as opposed to only a HTTP/1.1 persistent connection).
354
355The default is true, except when using a proxy, in which case it defaults
356to false, as HTTP/1.0 proxies cannot support this in a meaningful way.
357
358=item handle_params => { key => value ... }
359
360The key-value pairs in this hash will be passed to any L<AnyEvent::Handle>
361constructor that is called - not all requests will create a handle, and
362sometimes more than one is created, so this parameter is only good for
363setting hints.
364
365Example: set the maximum read size to 4096, to potentially conserve memory
366at the cost of speed.
367
368 handle_params => {
369 max_read_size => 4096,
370 },
319 371
320=back 372=back
321 373
322Example: do a simple HTTP GET request for http://www.nethype.de/ and print 374Example: do a simple HTTP GET request for http://www.nethype.de/ and print
323the response body. 375the response body.
330Example: do a HTTP HEAD request on https://www.google.com/, use a 382Example: do a HTTP HEAD request on https://www.google.com/, use a
331timeout of 30 seconds. 383timeout of 30 seconds.
332 384
333 http_request 385 http_request
334 GET => "https://www.google.com", 386 GET => "https://www.google.com",
387 headers => { "user-agent" => "MySearchClient 1.0" },
335 timeout => 30, 388 timeout => 30,
336 sub { 389 sub {
337 my ($body, $hdr) = @_; 390 my ($body, $hdr) = @_;
338 use Data::Dumper; 391 use Data::Dumper;
339 print Dumper $hdr; 392 print Dumper $hdr;
349 }; 402 };
350 403
351 undef $request; 404 undef $request;
352 405
353=cut 406=cut
407
408#############################################################################
409# wait queue/slots
354 410
355sub _slot_schedule; 411sub _slot_schedule;
356sub _slot_schedule($) { 412sub _slot_schedule($) {
357 my $host = shift; 413 my $host = shift;
358 414
381 437
382 _slot_schedule $_[0]; 438 _slot_schedule $_[0];
383} 439}
384 440
385############################################################################# 441#############################################################################
442# cookie handling
386 443
387# expire cookies 444# expire cookies
388sub cookie_jar_expire($;$) { 445sub cookie_jar_expire($;$) {
389 my ($jar, $session_end) = @_; 446 my ($jar, $session_end) = @_;
390 447
414 } 471 }
415} 472}
416 473
417# extract cookies from jar 474# extract cookies from jar
418sub cookie_jar_extract($$$$) { 475sub cookie_jar_extract($$$$) {
419 my ($jar, $uscheme, $uhost, $upath) = @_; 476 my ($jar, $scheme, $host, $path) = @_;
420 477
421 %$jar = () if $jar->{version} != 1; 478 %$jar = () if $jar->{version} != 1;
422 479
423 my @cookies; 480 my @cookies;
424 481
425 while (my ($chost, $paths) = each %$jar) { 482 while (my ($chost, $paths) = each %$jar) {
426 next unless ref $paths; 483 next unless ref $paths;
427 484
428 if ($chost =~ /^\./) { 485 if ($chost =~ /^\./) {
429 next unless $chost eq substr $uhost, -length $chost; 486 next unless $chost eq substr $host, -length $chost;
430 } elsif ($chost =~ /\./) { 487 } elsif ($chost =~ /\./) {
431 next unless $chost eq $uhost; 488 next unless $chost eq $host;
432 } else { 489 } else {
433 next; 490 next;
434 } 491 }
435 492
436 while (my ($cpath, $cookies) = each %$paths) { 493 while (my ($cpath, $cookies) = each %$paths) {
437 next unless $cpath eq substr $upath, 0, length $cpath; 494 next unless $cpath eq substr $path, 0, length $cpath;
438 495
439 while (my ($cookie, $kv) = each %$cookies) { 496 while (my ($cookie, $kv) = each %$cookies) {
440 next if $uscheme ne "https" && exists $kv->{secure}; 497 next if $scheme ne "https" && exists $kv->{secure};
441 498
442 if (exists $kv->{_expires} and AE::now > $kv->{_expires}) { 499 if (exists $kv->{_expires} and AE::now > $kv->{_expires}) {
443 delete $cookies->{$cookie}; 500 delete $cookies->{$cookie};
444 next; 501 next;
445 } 502 }
459 \@cookies 516 \@cookies
460} 517}
461 518
462# parse set_cookie header into jar 519# parse set_cookie header into jar
463sub cookie_jar_set_cookie($$$$) { 520sub cookie_jar_set_cookie($$$$) {
464 my ($jar, $set_cookie, $uhost, $date) = @_; 521 my ($jar, $set_cookie, $host, $date) = @_;
465 522
466 my $anow = int AE::now; 523 my $anow = int AE::now;
467 my $snow; # server-now 524 my $snow; # server-now
468 525
469 for ($set_cookie) { 526 for ($set_cookie) {
475 while ( 532 while (
476 m{ 533 m{
477 \G\s* 534 \G\s*
478 (?: 535 (?:
479 expires \s*=\s* ([A-Z][a-z][a-z]+,\ [^,;]+) 536 expires \s*=\s* ([A-Z][a-z][a-z]+,\ [^,;]+)
480 | ([^=;,[:space:]]+) (?: \s*=\s* (?: "((?:[^\\"]+|\\.)*)" | ([^=;,[:space:]]*) ) )? 537 | ([^=;,[:space:]]+) (?: \s*=\s* (?: "((?:[^\\"]+|\\.)*)" | ([^;,[:space:]]*) ) )?
481 ) 538 )
482 }gcxsi 539 }gcxsi
483 ) { 540 ) {
484 my $name = $2; 541 my $name = $2;
485 my $value = $4; 542 my $value = $4;
492 # quoted 549 # quoted
493 $value = $3; 550 $value = $3;
494 $value =~ s/\\(.)/$1/gs; 551 $value =~ s/\\(.)/$1/gs;
495 } 552 }
496 553
497 push @kv, lc $name, $value; 554 push @kv, @kv ? lc $name : $name, $value;
498 555
499 last unless /\G\s*;/gc; 556 last unless /\G\s*;/gc;
500 } 557 }
501 558
502 last unless @kv; 559 last unless @kv;
525 582
526 # this is not rfc-like and not netscape-like. go figure. 583 # this is not rfc-like and not netscape-like. go figure.
527 my $ndots = $cdom =~ y/.//; 584 my $ndots = $cdom =~ y/.//;
528 next if $ndots < ($cdom =~ /\.[^.][^.]\.[^.][^.]$/ ? 3 : 2); 585 next if $ndots < ($cdom =~ /\.[^.][^.]\.[^.][^.]$/ ? 3 : 2);
529 } else { 586 } else {
530 $cdom = $uhost; 587 $cdom = $host;
531 } 588 }
532 589
533 # store it 590 # store it
534 $jar->{version} = 1; 591 $jar->{version} = 1;
535 $jar->{$cdom}{$cpath}{$name} = \%kv; 592 $jar->{lc $cdom}{$cpath}{$name} = \%kv;
536 593
537 redo if /\G\s*,/gc; 594 redo if /\G\s*,/gc;
538 } 595 }
539} 596}
540 597
598#############################################################################
599# keepalive/persistent connection cache
600
601# fetch a connection from the keepalive cache
602sub ka_fetch($) {
603 my $ka_key = shift;
604
605 my $hdl = pop @{ $KA_CACHE{$ka_key} }; # currently we reuse the MOST RECENTLY USED connection
606 delete $KA_CACHE{$ka_key}
607 unless @{ $KA_CACHE{$ka_key} };
608
609 $hdl
610}
611
612sub ka_store($$) {
613 my ($ka_key, $hdl) = @_;
614
615 my $kaa = $KA_CACHE{$ka_key} ||= [];
616
617 my $destroy = sub {
618 my @ka = grep $_ != $hdl, @{ $KA_CACHE{$ka_key} };
619
620 $hdl->destroy;
621
622 @ka
623 ? $KA_CACHE{$ka_key} = \@ka
624 : delete $KA_CACHE{$ka_key};
625 };
626
627 # on error etc., destroy
628 $hdl->on_error ($destroy);
629 $hdl->on_eof ($destroy);
630 $hdl->on_read ($destroy);
631 $hdl->timeout ($PERSISTENT_TIMEOUT);
632
633 push @$kaa, $hdl;
634 shift @$kaa while @$kaa > $MAX_PER_HOST;
635}
636
637#############################################################################
638# utilities
639
541# continue to parse $_ for headers and place them into the arg 640# continue to parse $_ for headers and place them into the arg
542sub parse_hdr() { 641sub _parse_hdr() {
543 my %hdr; 642 my %hdr;
544 643
545 # things seen, not parsed: 644 # things seen, not parsed:
546 # p3pP="NON CUR OTPi OUR NOR UNI" 645 # p3pP="NON CUR OTPi OUR NOR UNI"
547 646
561 for values %hdr; 660 for values %hdr;
562 661
563 \%hdr 662 \%hdr
564} 663}
565 664
665#############################################################################
666# http_get
667
566our $qr_nlnl = qr{(?<![^\012])\015?\012}; 668our $qr_nlnl = qr{(?<![^\012])\015?\012};
567 669
568our $TLS_CTX_LOW = { cache => 1, sslv2 => 1 }; 670our $TLS_CTX_LOW = { cache => 1, sslv2 => 1 };
569our $TLS_CTX_HIGH = { cache => 1, verify => 1, verify_peername => "https" }; 671our $TLS_CTX_HIGH = { cache => 1, verify => 1, verify_peername => "https" };
672
673# maybe it should just become a normal object :/
674
675sub _destroy_state(\%) {
676 my ($state) = @_;
677
678 $state->{handle}->destroy if $state->{handle};
679 %$state = ();
680}
681
682sub _error(\%$$) {
683 my ($state, $cb, $hdr) = @_;
684
685 &_destroy_state ($state);
686
687 $cb->(undef, $hdr);
688 ()
689}
570 690
571sub http_request($$@) { 691sub http_request($$@) {
572 my $cb = pop; 692 my $cb = pop;
573 my ($method, $url, %arg) = @_; 693 my ($method, $url, %arg) = @_;
574 694
592 my $recurse = exists $arg{recurse} ? delete $arg{recurse} : $MAX_RECURSE; 712 my $recurse = exists $arg{recurse} ? delete $arg{recurse} : $MAX_RECURSE;
593 713
594 return $cb->(undef, { @pseudo, Status => 599, Reason => "Too many redirections" }) 714 return $cb->(undef, { @pseudo, Status => 599, Reason => "Too many redirections" })
595 if $recurse < 0; 715 if $recurse < 0;
596 716
597 my $proxy = $arg{proxy} || $PROXY; 717 my $proxy = exists $arg{proxy} ? $arg{proxy} : $PROXY;
598 my $timeout = $arg{timeout} || $TIMEOUT; 718 my $timeout = $arg{timeout} || $TIMEOUT;
599 719
600 my ($uscheme, $uauthority, $upath, $query, $fragment) = 720 my ($uscheme, $uauthority, $upath, $query, undef) = # ignore fragment
601 $url =~ m|(?:([^:/?#]+):)?(?://([^/?#]*))?([^?#]*)(?:(\?[^#]*))?(?:#(.*))?|; 721 $url =~ m|^([^:]+):(?://([^/?#]*))?([^?#]*)(?:(\?[^#]*))?(?:#(.*))?$|;
602 722
603 $uscheme = lc $uscheme; 723 $uscheme = lc $uscheme;
604 724
605 my $uport = $uscheme eq "http" ? 80 725 my $uport = $uscheme eq "http" ? 80
606 : $uscheme eq "https" ? 443 726 : $uscheme eq "https" ? 443
607 : return $cb->(undef, { @pseudo, Status => 599, Reason => "Only http and https URL schemes supported" }); 727 : return $cb->(undef, { @pseudo, Status => 599, Reason => "Only http and https URL schemes supported" });
608 728
609 $uauthority =~ /^(?: .*\@ )? ([^\@:]+) (?: : (\d+) )?$/x 729 $uauthority =~ /^(?: .*\@ )? ([^\@:]+) (?: : (\d+) )?$/x
610 or return $cb->(undef, { @pseudo, Status => 599, Reason => "Unparsable URL" }); 730 or return $cb->(undef, { @pseudo, Status => 599, Reason => "Unparsable URL" });
611 731
612 my $uhost = $1; 732 my $uhost = lc $1;
613 $uport = $2 if defined $2; 733 $uport = $2 if defined $2;
614 734
615 $hdr{host} = defined $2 ? "$uhost:$2" : "$uhost" 735 $hdr{host} = defined $2 ? "$uhost:$2" : "$uhost"
616 unless exists $hdr{host}; 736 unless exists $hdr{host};
617 737
636 $rscheme = "http" unless defined $rscheme; 756 $rscheme = "http" unless defined $rscheme;
637 757
638 # don't support https requests over https-proxy transport, 758 # don't support https requests over https-proxy transport,
639 # can't be done with tls as spec'ed, unless you double-encrypt. 759 # can't be done with tls as spec'ed, unless you double-encrypt.
640 $rscheme = "http" if $uscheme eq "https" && $rscheme eq "https"; 760 $rscheme = "http" if $uscheme eq "https" && $rscheme eq "https";
761
762 $rhost = lc $rhost;
763 $rscheme = lc $rscheme;
641 } else { 764 } else {
642 ($rhost, $rport, $rscheme, $rpath) = ($uhost, $uport, $uscheme, $upath); 765 ($rhost, $rport, $rscheme, $rpath) = ($uhost, $uport, $uscheme, $upath);
643 } 766 }
644 767
645 # leave out fragment and query string, just a heuristic 768 # leave out fragment and query string, just a heuristic
647 $hdr{"user-agent"} = $USERAGENT unless exists $hdr{"user-agent"}; 770 $hdr{"user-agent"} = $USERAGENT unless exists $hdr{"user-agent"};
648 771
649 $hdr{"content-length"} = length $arg{body} 772 $hdr{"content-length"} = length $arg{body}
650 if length $arg{body} || $method ne "GET"; 773 if length $arg{body} || $method ne "GET";
651 774
652 $hdr{connection} = "close TE"; #1.1 775 my $idempotent = $method =~ /^(?:GET|HEAD|PUT|DELETE|OPTIONS|TRACE)$/;
776
777 # default value for keepalive is true iff the request is for an idempotent method
778 my $persistent = exists $arg{persistent} ? !!$arg{persistent} : $idempotent;
779 my $keepalive = exists $arg{keepalive} ? !!$arg{keepalive} : !$proxy;
780 my $was_persistent; # true if this is actually a recycled connection
781
782 # the key to use in the keepalive cache
783 my $ka_key = "$uhost\x00$arg{sessionid}";
784
785 $hdr{connection} = ($persistent ? $keepalive ? "keep-alive " : "" : "close ") . "Te"; #1.1
653 $hdr{te} = "trailers" unless exists $hdr{te}; #1.1 786 $hdr{te} = "trailers" unless exists $hdr{te}; #1.1
654 787
655 my %state = (connect_guard => 1); 788 my %state = (connect_guard => 1);
656 789
657 _get_slot $uhost, sub {
658 $state{slot_guard} = shift;
659
660 return unless $state{connect_guard};
661
662 my $ae_error = 595; # connecting 790 my $ae_error = 595; # connecting
663 791
664 # handle actual, non-tunneled, request 792 # handle actual, non-tunneled, request
665 my $handle_actual_request = sub { 793 my $handle_actual_request = sub {
666 $ae_error = 596; # request phase 794 $ae_error = 596; # request phase
667 795
796 my $hdl = $state{handle};
797
668 $state{handle}->starttls ("connect") if $uscheme eq "https" && !exists $state{handle}{tls}; 798 $hdl->starttls ("connect") if $uscheme eq "https" && !exists $hdl->{tls};
669 799
670 # send request 800 # send request
671 $state{handle}->push_write ( 801 $hdl->push_write (
672 "$method $rpath HTTP/1.1\015\012" 802 "$method $rpath HTTP/1.1\015\012"
673 . (join "", map "\u$_: $hdr{$_}\015\012", grep defined $hdr{$_}, keys %hdr) 803 . (join "", map "\u$_: $hdr{$_}\015\012", grep defined $hdr{$_}, keys %hdr)
674 . "\015\012" 804 . "\015\012"
675 . (delete $arg{body}) 805 . (delete $arg{body})
676 ); 806 );
677 807
678 # return if error occured during push_write() 808 # return if error occured during push_write()
809 return unless %state;
810
811 # reduce memory usage, save a kitten, also re-use it for the response headers.
812 %hdr = ();
813
814 # status line and headers
815 $state{read_response} = sub {
679 return unless %state; 816 return unless %state;
680 817
681 %hdr = (); # reduce memory usage, save a kitten, also make it possible to re-use
682
683 # status line and headers
684 $state{read_response} = sub {
685 for ("$_[1]") { 818 for ("$_[1]") {
686 y/\015//d; # weed out any \015, as they show up in the weirdest of places. 819 y/\015//d; # weed out any \015, as they show up in the weirdest of places.
687 820
688 /^HTTP\/0*([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\012]*) )? \012/gxci 821 /^HTTP\/0*([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\012]*) )? \012/gxci
689 or return (%state = (), $cb->(undef, { @pseudo, Status => 599, Reason => "Invalid server response" })); 822 or return _error %state, $cb, { @pseudo, Status => 599, Reason => "Invalid server response" };
690 823
691 # 100 Continue handling 824 # 100 Continue handling
692 # should not happen as we don't send expect: 100-continue, 825 # should not happen as we don't send expect: 100-continue,
693 # but we handle it just in case. 826 # but we handle it just in case.
694 # since we send the request body regardless, if we get an error 827 # since we send the request body regardless, if we get an error
695 # we are out of-sync, which we currently do NOT handle correctly. 828 # we are out of-sync, which we currently do NOT handle correctly.
696 return $state{handle}->push_read (line => $qr_nlnl, $state{read_response}) 829 return $state{handle}->push_read (line => $qr_nlnl, $state{read_response})
697 if $2 eq 100; 830 if $2 eq 100;
698 831
699 push @pseudo, 832 push @pseudo,
700 HTTPVersion => $1, 833 HTTPVersion => $1,
701 Status => $2, 834 Status => $2,
702 Reason => $3, 835 Reason => $3,
703 ; 836 ;
704 837
705 my $hdr = parse_hdr 838 my $hdr = _parse_hdr
706 or return (%state = (), $cb->(undef, { @pseudo, Status => 599, Reason => "Garbled response headers" })); 839 or return _error %state, $cb, { @pseudo, Status => 599, Reason => "Garbled response headers" };
707 840
708 %hdr = (%$hdr, @pseudo); 841 %hdr = (%$hdr, @pseudo);
842 }
843
844 # redirect handling
845 # microsoft and other shitheads don't give a shit for following standards,
846 # try to support some common forms of broken Location headers.
847 if ($hdr{location} !~ /^(?: $ | [^:\/?\#]+ : )/x) {
848 $hdr{location} =~ s/^\.\/+//;
849
850 my $url = "$rscheme://$uhost:$uport";
851
852 unless ($hdr{location} =~ s/^\///) {
853 $url .= $upath;
854 $url =~ s/\/[^\/]*$//;
709 } 855 }
710 856
711 # redirect handling
712 # microsoft and other shitheads don't give a shit for following standards,
713 # try to support some common forms of broken Location headers.
714 if ($hdr{location} !~ /^(?: $ | [^:\/?\#]+ : )/x) {
715 $hdr{location} =~ s/^\.\/+//;
716
717 my $url = "$rscheme://$uhost:$uport";
718
719 unless ($hdr{location} =~ s/^\///) {
720 $url .= $upath;
721 $url =~ s/\/[^\/]*$//;
722 }
723
724 $hdr{location} = "$url/$hdr{location}"; 857 $hdr{location} = "$url/$hdr{location}";
858 }
859
860 my $redirect;
861
862 if ($recurse) {
863 my $status = $hdr{Status};
864
865 # industry standard is to redirect POST as GET for
866 # 301, 302 and 303, in contrast to HTTP/1.0 and 1.1.
867 # also, the UA should ask the user for 301 and 307 and POST,
868 # industry standard seems to be to simply follow.
869 # we go with the industry standard.
870 if ($status == 301 or $status == 302 or $status == 303) {
871 # HTTP/1.1 is unclear on how to mutate the method
872 $method = "GET" unless $method eq "HEAD";
873 $redirect = 1;
874 } elsif ($status == 307) {
875 $redirect = 1;
725 } 876 }
877 }
726 878
727 my $redirect; 879 my $finish = sub { # ($data, $err_status, $err_reason[, $persistent])
728 880 if ($state{handle}) {
729 if ($recurse) { 881 # handle keepalive
730 my $status = $hdr{Status}; 882 if (
731 883 $persistent
732 # industry standard is to redirect POST as GET for 884 && $_[3]
733 # 301, 302 and 303, in contrast to HTTP/1.0 and 1.1. 885 && ($hdr{HTTPVersion} < 1.1
734 # also, the UA should ask the user for 301 and 307 and POST, 886 ? $hdr{connection} =~ /\bkeep-?alive\b/i
735 # industry standard seems to be to simply follow. 887 : $hdr{connection} !~ /\bclose\b/i)
736 # we go with the industry standard. 888 ) {
737 if ($status == 301 or $status == 302 or $status == 303) { 889 ka_store $ka_key, delete $state{handle};
738 # HTTP/1.1 is unclear on how to mutate the method 890 } else {
739 $method = "GET" unless $method eq "HEAD"; 891 # no keepalive, destroy the handle
740 $redirect = 1; 892 $state{handle}->destroy;
741 } elsif ($status == 307) {
742 $redirect = 1;
743 } 893 }
744 } 894 }
745 895
746 my $finish = sub { # ($data, $err_status, $err_reason[, $keepalive])
747 my $may_keep_alive = $_[3];
748
749 $state{handle}->destroy if $state{handle};
750 %state = (); 896 %state = ();
751 897
752 if (defined $_[1]) { 898 if (defined $_[1]) {
753 $hdr{OrigStatus} = $hdr{Status}; $hdr{Status} = $_[1]; 899 $hdr{OrigStatus} = $hdr{Status}; $hdr{Status} = $_[1];
754 $hdr{OrigReason} = $hdr{Reason}; $hdr{Reason} = $_[2]; 900 $hdr{OrigReason} = $hdr{Reason}; $hdr{Reason} = $_[2];
755 } 901 }
756 902
757 # set-cookie processing 903 # set-cookie processing
758 if ($arg{cookie_jar}) { 904 if ($arg{cookie_jar}) {
759 cookie_jar_set_cookie $arg{cookie_jar}, $hdr{"set-cookie"}, $uhost, $hdr{date}; 905 cookie_jar_set_cookie $arg{cookie_jar}, $hdr{"set-cookie"}, $uhost, $hdr{date};
760 } 906 }
761 907
762 if ($redirect && exists $hdr{location}) { 908 if ($redirect && exists $hdr{location}) {
763 # we ignore any errors, as it is very common to receive 909 # we ignore any errors, as it is very common to receive
764 # Content-Length != 0 but no actual body 910 # Content-Length != 0 but no actual body
765 # we also access %hdr, as $_[1] might be an erro 911 # we also access %hdr, as $_[1] might be an erro
912 $state{recurse} =
766 http_request ( 913 http_request (
767 $method => $hdr{location}, 914 $method => $hdr{location},
768 %arg, 915 %arg,
769 recurse => $recurse - 1, 916 recurse => $recurse - 1,
770 Redirect => [$_[0], \%hdr], 917 Redirect => [$_[0], \%hdr],
918 sub {
919 %state = ();
920 &$cb
921 },
922 );
923 } else {
924 $cb->($_[0], \%hdr);
925 }
926 };
927
928 $ae_error = 597; # body phase
929
930 my $chunked = $hdr{"transfer-encoding"} =~ /\bchunked\b/i; # not quite correct...
931
932 my $len = $chunked ? undef : $hdr{"content-length"};
933
934 # body handling, many different code paths
935 # - no body expected
936 # - want_body_handle
937 # - te chunked
938 # - 2x length known (with or without on_body)
939 # - 2x length not known (with or without on_body)
940 if (!$redirect && $arg{on_header} && !$arg{on_header}(\%hdr)) {
941 $finish->(undef, 598 => "Request cancelled by on_header");
942 } elsif (
943 $hdr{Status} =~ /^(?:1..|204|205|304)$/
944 or $method eq "HEAD"
945 or (defined $len && $len == 0) # == 0, not !, because "0 " is true
946 ) {
947 # no body
948 $finish->("", undef, undef, 1);
949
950 } elsif (!$redirect && $arg{want_body_handle}) {
951 $_[0]->on_eof (undef);
952 $_[0]->on_error (undef);
953 $_[0]->on_read (undef);
954
955 $finish->(delete $state{handle});
956
957 } elsif ($chunked) {
958 my $cl = 0;
959 my $body = "";
960 my $on_body = $arg{on_body} || sub { $body .= shift; 1 };
961
962 $state{read_chunk} = sub {
963 $_[1] =~ /^([0-9a-fA-F]+)/
964 or $finish->(undef, $ae_error => "Garbled chunked transfer encoding");
965
966 my $len = hex $1;
967
968 if ($len) {
969 $cl += $len;
970
971 $_[0]->push_read (chunk => $len, sub {
972 $on_body->($_[1], \%hdr)
973 or return $finish->(undef, 598 => "Request cancelled by on_body");
974
975 $_[0]->push_read (line => sub {
976 length $_[1]
977 and return $finish->(undef, $ae_error => "Garbled chunked transfer encoding");
978 $_[0]->push_read (line => $state{read_chunk});
771 $cb); 979 });
980 });
772 } else { 981 } else {
773 $cb->($_[0], \%hdr); 982 $hdr{"content-length"} ||= $cl;
983
984 $_[0]->push_read (line => $qr_nlnl, sub {
985 if (length $_[1]) {
986 for ("$_[1]") {
987 y/\015//d; # weed out any \015, as they show up in the weirdest of places.
988
989 my $hdr = _parse_hdr
990 or return $finish->(undef, $ae_error => "Garbled response trailers");
991
992 %hdr = (%hdr, %$hdr);
993 }
994 }
995
996 $finish->($body, undef, undef, 1);
997 });
774 } 998 }
775 }; 999 };
776 1000
777 $ae_error = 597; # body phase 1001 $_[0]->push_read (line => $state{read_chunk});
778 1002
779 my $len = $hdr{"content-length"}; 1003 } elsif ($arg{on_body}) {
1004 if (defined $len) {
1005 $_[0]->on_read (sub {
1006 $len -= length $_[0]{rbuf};
780 1007
781 if (!$redirect && $arg{on_header} && !$arg{on_header}(\%hdr)) { 1008 $arg{on_body}(delete $_[0]{rbuf}, \%hdr)
782 $finish->(undef, 598 => "Request cancelled by on_header"); 1009 or return $finish->(undef, 598 => "Request cancelled by on_body");
783 } elsif ( 1010
784 $hdr{Status} =~ /^(?:1..|204|205|304)$/ 1011 $len > 0
785 or $method eq "HEAD"
786 or (defined $len && !$len)
787 ) {
788 # no body
789 $finish->("", undef, undef, 1); 1012 or $finish->("", undef, undef, 1);
1013 });
790 } else { 1014 } else {
791 # body handling, many different code paths
792 # - no body expected
793 # - want_body_handle
794 # - te chunked
795 # - 2x length known (with or without on_body)
796 # - 2x length not known (with or without on_body)
797 if (!$redirect && $arg{want_body_handle}) {
798 $_[0]->on_eof (undef); 1015 $_[0]->on_eof (sub {
799 $_[0]->on_error (undef); 1016 $finish->("");
800 $_[0]->on_read (undef);
801
802 $finish->(delete $state{handle});
803
804 } elsif ($hdr{"transfer-encoding"} =~ /\bchunked\b/i) {
805 my $cl = 0;
806 my $body = undef;
807 my $on_body = $arg{on_body} || sub { $body .= shift; 1 };
808
809 $state{read_chunk} = sub {
810 $_[1] =~ /^([0-9a-fA-F]+)/
811 or $finish->(undef, $ae_error => "Garbled chunked transfer encoding");
812
813 my $len = hex $1;
814
815 if ($len) {
816 $cl += $len;
817
818 $_[0]->push_read (chunk => $len, sub {
819 $on_body->($_[1], \%hdr)
820 or return $finish->(undef, 598 => "Request cancelled by on_body");
821
822 $_[0]->push_read (line => sub {
823 length $_[1]
824 and return $finish->(undef, $ae_error => "Garbled chunked transfer encoding");
825 $_[0]->push_read (line => $state{read_chunk});
826 });
827 });
828 } else {
829 $hdr{"content-length"} ||= $cl;
830
831 $_[0]->push_read (line => $qr_nlnl, sub {
832 if (length $_[1]) {
833 for ("$_[1]") {
834 y/\015//d; # weed out any \015, as they show up in the weirdest of places.
835
836 my $hdr = parse_hdr
837 or return $finish->(undef, $ae_error => "Garbled response trailers");
838
839 %hdr = (%hdr, %$hdr);
840 }
841 }
842
843 $finish->($body, undef, undef, 1);
844 });
845 }
846 }; 1017 });
847
848 $_[0]->push_read (line => $state{read_chunk});
849
850 } elsif ($arg{on_body}) {
851 if ($len) {
852 $_[0]->on_read (sub { 1018 $_[0]->on_read (sub {
853 $len -= length $_[0]{rbuf};
854
855 $arg{on_body}(delete $_[0]{rbuf}, \%hdr) 1019 $arg{on_body}(delete $_[0]{rbuf}, \%hdr)
856 or return $finish->(undef, 598 => "Request cancelled by on_body");
857
858 $len > 0
859 or $finish->("", undef, undef, 1);
860 });
861 } else {
862 $_[0]->on_eof (sub {
863 $finish->("");
864 });
865 $_[0]->on_read (sub {
866 $arg{on_body}(delete $_[0]{rbuf}, \%hdr)
867 or $finish->(undef, 598 => "Request cancelled by on_body"); 1020 or $finish->(undef, 598 => "Request cancelled by on_body");
868 });
869 }
870 } else {
871 $_[0]->on_eof (undef);
872
873 if ($len) {
874 $_[0]->on_read (sub {
875 $finish->((substr delete $_[0]{rbuf}, 0, $len, ""), undef, undef, 1)
876 if $len <= length $_[0]{rbuf};
877 });
878 } else {
879 $_[0]->on_error (sub {
880 ($! == Errno::EPIPE || !$!)
881 ? $finish->(delete $_[0]{rbuf})
882 : $finish->(undef, $ae_error => $_[2]);
883 });
884 $_[0]->on_read (sub { });
885 }
886 } 1021 });
887 } 1022 }
888 };
889
890 $state{handle}->push_read (line => $qr_nlnl, $state{read_response});
891 };
892
893 my $connect_cb = sub {
894 $state{fh} = shift
895 or do {
896 my $err = "$!";
897 %state = ();
898 return $cb->(undef, { @pseudo, Status => $ae_error, Reason => $err });
899 };
900
901 return unless delete $state{connect_guard};
902
903 # get handle
904 $state{handle} = new AnyEvent::Handle
905 fh => $state{fh},
906 peername => $rhost,
907 tls_ctx => $arg{tls_ctx},
908 # these need to be reconfigured on keepalive handles
909 timeout => $timeout,
910 on_error => sub {
911 %state = ();
912 $cb->(undef, { @pseudo, Status => $ae_error, Reason => $_[2] });
913 },
914 on_eof => sub {
915 %state = ();
916 $cb->(undef, { @pseudo, Status => $ae_error, Reason => "Unexpected end-of-file" });
917 },
918 ;
919
920 # limit the number of persistent connections
921 # keepalive not yet supported
922# if ($KA_COUNT{$_[1]} < $MAX_PERSISTENT_PER_HOST) {
923# ++$KA_COUNT{$_[1]};
924# $state{handle}{ka_count_guard} = AnyEvent::Util::guard {
925# --$KA_COUNT{$_[1]}
926# };
927# $hdr{connection} = "keep-alive";
928# }
929
930 $state{handle}->starttls ("connect") if $rscheme eq "https";
931
932 # now handle proxy-CONNECT method
933 if ($proxy && $uscheme eq "https") {
934 # oh dear, we have to wrap it into a connect request
935
936 # maybe re-use $uauthority with patched port?
937 $state{handle}->push_write ("CONNECT $uhost:$uport HTTP/1.0\015\012Host: $uhost\015\012\015\012");
938 $state{handle}->push_read (line => $qr_nlnl, sub {
939 $_[1] =~ /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\015\012]*) )?/ix
940 or return (%state = (), $cb->(undef, { @pseudo, Status => 599, Reason => "Invalid proxy connect response ($_[1])" }));
941
942 if ($2 == 200) {
943 $rpath = $upath;
944 $handle_actual_request->();
945 } else {
946 %state = ();
947 $cb->(undef, { @pseudo, Status => $2, Reason => $3 });
948 }
949 });
950 } else { 1023 } else {
951 $handle_actual_request->(); 1024 $_[0]->on_eof (undef);
1025
1026 if (defined $len) {
1027 $_[0]->on_read (sub {
1028 $finish->((substr delete $_[0]{rbuf}, 0, $len, ""), undef, undef, 1)
1029 if $len <= length $_[0]{rbuf};
1030 });
1031 } else {
1032 $_[0]->on_error (sub {
1033 ($! == Errno::EPIPE || !$!)
1034 ? $finish->(delete $_[0]{rbuf})
1035 : $finish->(undef, $ae_error => $_[2]);
1036 });
1037 $_[0]->on_read (sub { });
1038 }
952 } 1039 }
953 }; 1040 };
954 1041
955 my $tcp_connect = $arg{tcp_connect} 1042 # if keepalive is enabled, then the server closing the connection
956 || do { require AnyEvent::Socket; \&AnyEvent::Socket::tcp_connect }; 1043 # before a response can happen legally - we retry on idempotent methods.
1044 if ($was_persistent && $idempotent) {
1045 my $old_eof = $hdl->{on_eof};
1046 $hdl->{on_eof} = sub {
1047 _destroy_state %state;
957 1048
958 $state{connect_guard} = $tcp_connect->($rhost, $rport, $connect_cb, $arg{on_prepare} || sub { $timeout }); 1049 %state = ();
1050 $state{recurse} =
1051 http_request (
1052 $method => $url,
1053 %arg,
1054 keepalive => 0,
1055 sub {
1056 %state = ();
1057 &$cb
1058 }
1059 );
1060 };
1061 $hdl->on_read (sub {
1062 return unless %state;
1063
1064 # as soon as we receive something, a connection close
1065 # once more becomes a hard error
1066 $hdl->{on_eof} = $old_eof;
1067 $hdl->push_read (line => $qr_nlnl, $state{read_response});
1068 });
1069 } else {
1070 $hdl->push_read (line => $qr_nlnl, $state{read_response});
1071 }
959 }; 1072 };
960 1073
1074 my $prepare_handle = sub {
1075 my ($hdl) = $state{handle};
1076
1077 $hdl->on_error (sub {
1078 _error %state, $cb, { @pseudo, Status => $ae_error, Reason => $_[2] };
1079 });
1080 $hdl->on_eof (sub {
1081 _error %state, $cb, { @pseudo, Status => $ae_error, Reason => "Unexpected end-of-file" };
1082 });
1083 $hdl->timeout_reset;
1084 $hdl->timeout ($timeout);
1085 };
1086
1087 # connected to proxy (or origin server)
1088 my $connect_cb = sub {
1089 my $fh = shift
1090 or return _error %state, $cb, { @pseudo, Status => $ae_error, Reason => "$!" };
1091
1092 return unless delete $state{connect_guard};
1093
1094 # get handle
1095 $state{handle} = new AnyEvent::Handle
1096 %{ $arg{handle_params} },
1097 fh => $fh,
1098 peername => $uhost,
1099 tls_ctx => $arg{tls_ctx},
1100 ;
1101
1102 $prepare_handle->();
1103
1104 #$state{handle}->starttls ("connect") if $rscheme eq "https";
1105
1106 # now handle proxy-CONNECT method
1107 if ($proxy && $uscheme eq "https") {
1108 # oh dear, we have to wrap it into a connect request
1109
1110 # maybe re-use $uauthority with patched port?
1111 $state{handle}->push_write ("CONNECT $uhost:$uport HTTP/1.0\015\012\015\012");
1112 $state{handle}->push_read (line => $qr_nlnl, sub {
1113 $_[1] =~ /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\015\012]*) )?/ix
1114 or return _error %state, $cb, { @pseudo, Status => 599, Reason => "Invalid proxy connect response ($_[1])" };
1115
1116 if ($2 == 200) {
1117 $rpath = $upath;
1118 $handle_actual_request->();
1119 } else {
1120 _error %state, $cb, { @pseudo, Status => $2, Reason => $3 };
1121 }
1122 });
1123 } else {
1124 $handle_actual_request->();
1125 }
1126 };
1127
1128 _get_slot $uhost, sub {
1129 $state{slot_guard} = shift;
1130
1131 return unless $state{connect_guard};
1132
1133 # try to use an existing keepalive connection, but only if we, ourselves, plan
1134 # on a keepalive request (in theory, this should be a separate config option).
1135 if ($persistent && $KA_CACHE{$ka_key}) {
1136 $was_persistent = 1;
1137
1138 $state{handle} = ka_fetch $ka_key;
1139 $state{handle}->destroyed
1140 and die "got a destructed habndle. pah\n";#d#
1141 $prepare_handle->();
1142 $state{handle}->destroyed
1143 and die "got a destructed habndle. pa2\n";#d#
1144 $handle_actual_request->();
1145 $state{handle}->destroyed
1146 and die "got a destructed habndle. pa3\n";#d#
1147
1148 } else {
1149 my $tcp_connect = $arg{tcp_connect}
1150 || do { require AnyEvent::Socket; \&AnyEvent::Socket::tcp_connect };
1151
1152 $state{connect_guard} = $tcp_connect->($rhost, $rport, $connect_cb, $arg{on_prepare} || sub { $timeout });
1153 }
1154 };
1155
961 defined wantarray && AnyEvent::Util::guard { %state = () } 1156 defined wantarray && AnyEvent::Util::guard { _destroy_state %state }
962} 1157}
963 1158
964sub http_get($@) { 1159sub http_get($@) {
965 unshift @_, "GET"; 1160 unshift @_, "GET";
966 &http_request 1161 &http_request
984AnyEvent::HTTP uses the AnyEvent::Socket::tcp_connect function for 1179AnyEvent::HTTP uses the AnyEvent::Socket::tcp_connect function for
985the actual connection, which in turn uses AnyEvent::DNS to resolve 1180the actual connection, which in turn uses AnyEvent::DNS to resolve
986hostnames. The latter is a simple stub resolver and does no caching 1181hostnames. The latter is a simple stub resolver and does no caching
987on its own. If you want DNS caching, you currently have to provide 1182on its own. If you want DNS caching, you currently have to provide
988your own default resolver (by storing a suitable resolver object in 1183your own default resolver (by storing a suitable resolver object in
989C<$AnyEvent::DNS::RESOLVER>). 1184C<$AnyEvent::DNS::RESOLVER>) or your own C<tcp_connect> callback.
990 1185
991=head2 GLOBAL FUNCTIONS AND VARIABLES 1186=head2 GLOBAL FUNCTIONS AND VARIABLES
992 1187
993=over 4 1188=over 4
994 1189
995=item AnyEvent::HTTP::set_proxy "proxy-url" 1190=item AnyEvent::HTTP::set_proxy "proxy-url"
996 1191
997Sets the default proxy server to use. The proxy-url must begin with a 1192Sets the default proxy server to use. The proxy-url must begin with a
998string of the form C<http://host:port> (optionally C<https:...>), croaks 1193string of the form C<http://host:port>, croaks otherwise.
999otherwise.
1000 1194
1001To clear an already-set proxy, use C<undef>. 1195To clear an already-set proxy, use C<undef>.
1196
1197When AnyEvent::HTTP is laoded for the first time it will query the
1198default proxy from the operating system, currently by looking at
1199C<$ENV{http_proxy>}.
1002 1200
1003=item AnyEvent::HTTP::cookie_jar_expire $jar[, $session_end] 1201=item AnyEvent::HTTP::cookie_jar_expire $jar[, $session_end]
1004 1202
1005Remove all cookies from the cookie jar that have been expired. If 1203Remove all cookies from the cookie jar that have been expired. If
1006C<$session_end> is given and true, then additionally remove all session 1204C<$session_end> is given and true, then additionally remove all session
1052 1250
1053=item $AnyEvent::HTTP::MAX_RECURSE 1251=item $AnyEvent::HTTP::MAX_RECURSE
1054 1252
1055The default value for the C<recurse> request parameter (default: C<10>). 1253The default value for the C<recurse> request parameter (default: C<10>).
1056 1254
1255=item $AnyEvent::HTTP::TIMEOUT
1256
1257The default timeout for conenction operations (default: C<300>).
1258
1057=item $AnyEvent::HTTP::USERAGENT 1259=item $AnyEvent::HTTP::USERAGENT
1058 1260
1059The default value for the C<User-Agent> header (the default is 1261The default value for the C<User-Agent> header (the default is
1060C<Mozilla/5.0 (compatible; U; AnyEvent-HTTP/$VERSION; +http://software.schmorp.de/pkg/AnyEvent)>). 1262C<Mozilla/5.0 (compatible; U; AnyEvent-HTTP/$VERSION; +http://software.schmorp.de/pkg/AnyEvent)>).
1061 1263
1062=item $AnyEvent::HTTP::MAX_PER_HOST 1264=item $AnyEvent::HTTP::MAX_PER_HOST
1063 1265
1064The maximum number of concurrent connections to the same host (identified 1266The maximum number of concurrent connections to the same host (identified
1065by the hostname). If the limit is exceeded, then the additional requests 1267by the hostname). If the limit is exceeded, then the additional requests
1066are queued until previous connections are closed. 1268are queued until previous connections are closed. Both persistent and
1269non-persistent connections are counted in this limit.
1067 1270
1068The default value for this is C<4>, and it is highly advisable to not 1271The default value for this is C<4>, and it is highly advisable to not
1069increase it. 1272increase it much.
1273
1274For comparison: the RFC's recommend 4 non-persistent or 2 persistent
1275connections, older browsers used 2, newers (such as firefox 3) typically
1276use 6, and Opera uses 8 because like, they have the fastest browser and
1277give a shit for everybody else on the planet.
1278
1279=item $AnyEvent::HTTP::PERSISTENT_TIMEOUT
1280
1281The time after which idle persistent conenctions get closed by
1282AnyEvent::HTTP (default: C<3>).
1070 1283
1071=item $AnyEvent::HTTP::ACTIVE 1284=item $AnyEvent::HTTP::ACTIVE
1072 1285
1073The number of active connections. This is not the number of currently 1286The number of active connections. This is not the number of currently
1074running requests, but the number of currently open and non-idle TCP 1287running requests, but the number of currently open and non-idle TCP
1075connections. This number of can be useful for load-leveling. 1288connections. This number can be useful for load-leveling.
1076 1289
1077=back 1290=back
1078 1291
1079=cut 1292=cut
1080 1293
1123 undef 1336 undef
1124} 1337}
1125 1338
1126sub set_proxy($) { 1339sub set_proxy($) {
1127 if (length $_[0]) { 1340 if (length $_[0]) {
1128 $_[0] =~ m%^(https?):// ([^:/]+) (?: : (\d*) )?%ix 1341 $_[0] =~ m%^(http):// ([^:/]+) (?: : (\d*) )?%ix
1129 or Carp::croak "$_[0]: invalid proxy URL"; 1342 or Carp::croak "$_[0]: invalid proxy URL";
1130 $PROXY = [$2, $3 || 3128, $1] 1343 $PROXY = [$2, $3 || 3128, $1]
1131 } else { 1344 } else {
1132 undef $PROXY; 1345 undef $PROXY;
1133 } 1346 }
1136# initialise proxy from environment 1349# initialise proxy from environment
1137eval { 1350eval {
1138 set_proxy $ENV{http_proxy}; 1351 set_proxy $ENV{http_proxy};
1139}; 1352};
1140 1353
1354=head2 SHOWCASE
1355
1356This section contaisn some more elaborate "real-world" examples or code
1357snippets.
1358
1359=head2 HTTP/1.1 FILE DOWNLOAD
1360
1361Downloading files with HTTP can be quite tricky, especially when something
1362goes wrong and you want to resume.
1363
1364Here is a function that initiates and resumes a download. It uses the
1365last modified time to check for file content changes, and works with many
1366HTTP/1.0 servers as well, and usually falls back to a complete re-download
1367on older servers.
1368
1369It calls the completion callback with either C<undef>, which means a
1370nonretryable error occured, C<0> when the download was partial and should
1371be retried, and C<1> if it was successful.
1372
1373 use AnyEvent::HTTP;
1374
1375 sub download($$$) {
1376 my ($url, $file, $cb) = @_;
1377
1378 open my $fh, "+<", $file
1379 or die "$file: $!";
1380
1381 my %hdr;
1382 my $ofs = 0;
1383
1384 warn stat $fh;
1385 warn -s _;
1386 if (stat $fh and -s _) {
1387 $ofs = -s _;
1388 warn "-s is ", $ofs;#d#
1389 $hdr{"if-unmodified-since"} = AnyEvent::HTTP::format_date +(stat _)[9];
1390 $hdr{"range"} = "bytes=$ofs-";
1391 }
1392
1393 http_get $url,
1394 headers => \%hdr,
1395 on_header => sub {
1396 my ($hdr) = @_;
1397
1398 if ($hdr->{Status} == 200 && $ofs) {
1399 # resume failed
1400 truncate $fh, $ofs = 0;
1401 }
1402
1403 sysseek $fh, $ofs, 0;
1404
1405 1
1406 },
1407 on_body => sub {
1408 my ($data, $hdr) = @_;
1409
1410 if ($hdr->{Status} =~ /^2/) {
1411 length $data == syswrite $fh, $data
1412 or return; # abort on write errors
1413 }
1414
1415 1
1416 },
1417 sub {
1418 my (undef, $hdr) = @_;
1419
1420 my $status = $hdr->{Status};
1421
1422 if (my $time = AnyEvent::HTTP::parse_date $hdr->{"last-modified"}) {
1423 utime $fh, $time, $time;
1424 }
1425
1426 if ($status == 200 || $status == 206 || $status == 416) {
1427 # download ok || resume ok || file already fully downloaded
1428 $cb->(1, $hdr);
1429
1430 } elsif ($status == 412) {
1431 # file has changed while resuming, delete and retry
1432 unlink $file;
1433 $cb->(0, $hdr);
1434
1435 } elsif ($status == 500 or $status == 503 or $status =~ /^59/) {
1436 # retry later
1437 $cb->(0, $hdr);
1438
1439 } else {
1440 $cb->(undef, $hdr);
1441 }
1442 }
1443 ;
1444 }
1445
1446 download "http://server/somelargefile", "/tmp/somelargefile", sub {
1447 if ($_[0]) {
1448 print "OK!\n";
1449 } elsif (defined $_[0]) {
1450 print "please retry later\n";
1451 } else {
1452 print "ERROR\n";
1453 }
1454 };
1455
1141=head2 SOCKS PROXIES 1456=head3 SOCKS PROXIES
1142 1457
1143Socks proxies are not directly supported by AnyEvent::HTTP. You can 1458Socks proxies are not directly supported by AnyEvent::HTTP. You can
1144compile your perl to support socks, or use an external program such as 1459compile your perl to support socks, or use an external program such as
1145F<socksify> (dante) or F<tsocks> to make your program use a socks proxy 1460F<socksify> (dante) or F<tsocks> to make your program use a socks proxy
1146transparently. 1461transparently.

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines