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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines