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.84 by root, Sun Jan 2 05:13:27 2011 UTC vs.
Revision 1.102 by root, Sat Feb 19 06:46:14 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.04';
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
421 $uhost = lc $uhost;
422 477
423 %$jar = () if $jar->{version} != 1; 478 %$jar = () if $jar->{version} != 1;
424 479
425 my @cookies; 480 my @cookies;
426 481
427 while (my ($chost, $paths) = each %$jar) { 482 while (my ($chost, $paths) = each %$jar) {
428 next unless ref $paths; 483 next unless ref $paths;
429 484
430 if ($chost =~ /^\./) { 485 if ($chost =~ /^\./) {
431 next unless $chost eq substr $uhost, -length $chost; 486 next unless $chost eq substr $host, -length $chost;
432 } elsif ($chost =~ /\./) { 487 } elsif ($chost =~ /\./) {
433 next unless $chost eq $uhost; 488 next unless $chost eq $host;
434 } else { 489 } else {
435 next; 490 next;
436 } 491 }
437 492
438 while (my ($cpath, $cookies) = each %$paths) { 493 while (my ($cpath, $cookies) = each %$paths) {
439 next unless $cpath eq substr $upath, 0, length $cpath; 494 next unless $cpath eq substr $path, 0, length $cpath;
440 495
441 while (my ($cookie, $kv) = each %$cookies) { 496 while (my ($cookie, $kv) = each %$cookies) {
442 next if $uscheme ne "https" && exists $kv->{secure}; 497 next if $scheme ne "https" && exists $kv->{secure};
443 498
444 if (exists $kv->{_expires} and AE::now > $kv->{_expires}) { 499 if (exists $kv->{_expires} and AE::now > $kv->{_expires}) {
445 delete $cookies->{$cookie}; 500 delete $cookies->{$cookie};
446 next; 501 next;
447 } 502 }
461 \@cookies 516 \@cookies
462} 517}
463 518
464# parse set_cookie header into jar 519# parse set_cookie header into jar
465sub cookie_jar_set_cookie($$$$) { 520sub cookie_jar_set_cookie($$$$) {
466 my ($jar, $set_cookie, $uhost, $date) = @_; 521 my ($jar, $set_cookie, $host, $date) = @_;
467 522
468 my $anow = int AE::now; 523 my $anow = int AE::now;
469 my $snow; # server-now 524 my $snow; # server-now
470 525
471 for ($set_cookie) { 526 for ($set_cookie) {
477 while ( 532 while (
478 m{ 533 m{
479 \G\s* 534 \G\s*
480 (?: 535 (?:
481 expires \s*=\s* ([A-Z][a-z][a-z]+,\ [^,;]+) 536 expires \s*=\s* ([A-Z][a-z][a-z]+,\ [^,;]+)
482 | ([^=;,[:space:]]+) (?: \s*=\s* (?: "((?:[^\\"]+|\\.)*)" | ([^=;,[:space:]]*) ) )? 537 | ([^=;,[:space:]]+) (?: \s*=\s* (?: "((?:[^\\"]+|\\.)*)" | ([^;,[:space:]]*) ) )?
483 ) 538 )
484 }gcxsi 539 }gcxsi
485 ) { 540 ) {
486 my $name = $2; 541 my $name = $2;
487 my $value = $4; 542 my $value = $4;
494 # quoted 549 # quoted
495 $value = $3; 550 $value = $3;
496 $value =~ s/\\(.)/$1/gs; 551 $value =~ s/\\(.)/$1/gs;
497 } 552 }
498 553
499 push @kv, lc $name, $value; 554 push @kv, @kv ? lc $name : $name, $value;
500 555
501 last unless /\G\s*;/gc; 556 last unless /\G\s*;/gc;
502 } 557 }
503 558
504 last unless @kv; 559 last unless @kv;
527 582
528 # this is not rfc-like and not netscape-like. go figure. 583 # this is not rfc-like and not netscape-like. go figure.
529 my $ndots = $cdom =~ y/.//; 584 my $ndots = $cdom =~ y/.//;
530 next if $ndots < ($cdom =~ /\.[^.][^.]\.[^.][^.]$/ ? 3 : 2); 585 next if $ndots < ($cdom =~ /\.[^.][^.]\.[^.][^.]$/ ? 3 : 2);
531 } else { 586 } else {
532 $cdom = $uhost; 587 $cdom = $host;
533 } 588 }
534 589
535 # store it 590 # store it
536 $jar->{version} = 1; 591 $jar->{version} = 1;
537 $jar->{lc $cdom}{$cpath}{$name} = \%kv; 592 $jar->{lc $cdom}{$cpath}{$name} = \%kv;
538 593
539 redo if /\G\s*,/gc; 594 redo if /\G\s*,/gc;
540 } 595 }
541} 596}
542 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
543# continue to parse $_ for headers and place them into the arg 640# continue to parse $_ for headers and place them into the arg
544sub parse_hdr() { 641sub _parse_hdr() {
545 my %hdr; 642 my %hdr;
546 643
547 # things seen, not parsed: 644 # things seen, not parsed:
548 # p3pP="NON CUR OTPi OUR NOR UNI" 645 # p3pP="NON CUR OTPi OUR NOR UNI"
549 646
563 for values %hdr; 660 for values %hdr;
564 661
565 \%hdr 662 \%hdr
566} 663}
567 664
665#############################################################################
666# http_get
667
568our $qr_nlnl = qr{(?<![^\012])\015?\012}; 668our $qr_nlnl = qr{(?<![^\012])\015?\012};
569 669
570our $TLS_CTX_LOW = { cache => 1, sslv2 => 1 }; 670our $TLS_CTX_LOW = { cache => 1, sslv2 => 1 };
571our $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}
572 690
573sub http_request($$@) { 691sub http_request($$@) {
574 my $cb = pop; 692 my $cb = pop;
575 my ($method, $url, %arg) = @_; 693 my ($method, $url, %arg) = @_;
576 694
594 my $recurse = exists $arg{recurse} ? delete $arg{recurse} : $MAX_RECURSE; 712 my $recurse = exists $arg{recurse} ? delete $arg{recurse} : $MAX_RECURSE;
595 713
596 return $cb->(undef, { @pseudo, Status => 599, Reason => "Too many redirections" }) 714 return $cb->(undef, { @pseudo, Status => 599, Reason => "Too many redirections" })
597 if $recurse < 0; 715 if $recurse < 0;
598 716
599 my $proxy = $arg{proxy} || $PROXY; 717 my $proxy = exists $arg{proxy} ? $arg{proxy} : $PROXY;
600 my $timeout = $arg{timeout} || $TIMEOUT; 718 my $timeout = $arg{timeout} || $TIMEOUT;
601 719
602 my ($uscheme, $uauthority, $upath, $query, $fragment) = 720 my ($uscheme, $uauthority, $upath, $query, undef) = # ignore fragment
603 $url =~ m|(?:([^:/?#]+):)?(?://([^/?#]*))?([^?#]*)(?:(\?[^#]*))?(?:#(.*))?|; 721 $url =~ m|^([^:]+):(?://([^/?#]*))?([^?#]*)(?:(\?[^#]*))?(?:#(.*))?$|;
604 722
605 $uscheme = lc $uscheme; 723 $uscheme = lc $uscheme;
606 724
607 my $uport = $uscheme eq "http" ? 80 725 my $uport = $uscheme eq "http" ? 80
608 : $uscheme eq "https" ? 443 726 : $uscheme eq "https" ? 443
609 : 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" });
610 728
611 $uauthority =~ /^(?: .*\@ )? ([^\@:]+) (?: : (\d+) )?$/x 729 $uauthority =~ /^(?: .*\@ )? ([^\@:]+) (?: : (\d+) )?$/x
612 or return $cb->(undef, { @pseudo, Status => 599, Reason => "Unparsable URL" }); 730 or return $cb->(undef, { @pseudo, Status => 599, Reason => "Unparsable URL" });
613 731
614 my $uhost = $1; 732 my $uhost = lc $1;
615 $uport = $2 if defined $2; 733 $uport = $2 if defined $2;
616 734
617 $hdr{host} = defined $2 ? "$uhost:$2" : "$uhost" 735 $hdr{host} = defined $2 ? "$uhost:$2" : "$uhost"
618 unless exists $hdr{host}; 736 unless exists $hdr{host};
619 737
638 $rscheme = "http" unless defined $rscheme; 756 $rscheme = "http" unless defined $rscheme;
639 757
640 # don't support https requests over https-proxy transport, 758 # don't support https requests over https-proxy transport,
641 # 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.
642 $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;
643 } else { 764 } else {
644 ($rhost, $rport, $rscheme, $rpath) = ($uhost, $uport, $uscheme, $upath); 765 ($rhost, $rport, $rscheme, $rpath) = ($uhost, $uport, $uscheme, $upath);
645 } 766 }
646 767
647 # leave out fragment and query string, just a heuristic 768 # leave out fragment and query string, just a heuristic
649 $hdr{"user-agent"} = $USERAGENT unless exists $hdr{"user-agent"}; 770 $hdr{"user-agent"} = $USERAGENT unless exists $hdr{"user-agent"};
650 771
651 $hdr{"content-length"} = length $arg{body} 772 $hdr{"content-length"} = length $arg{body}
652 if length $arg{body} || $method ne "GET"; 773 if length $arg{body} || $method ne "GET";
653 774
654 $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 $keepalive = exists $arg{keepalive} ? !!$arg{keepalive} : $idempotent;
779 my $keepalive10 = exists $arg{keepalive10} ? $arg{keepalive10} : !$proxy;
780 my $keptalive; # 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} = ($keepalive ? $keepalive10 ? "keep-alive " : "" : "close ") . "Te"; #1.1
655 $hdr{te} = "trailers" unless exists $hdr{te}; #1.1 786 $hdr{te} = "trailers" unless exists $hdr{te}; #1.1
656 787
657 my %state = (connect_guard => 1); 788 my %state = (connect_guard => 1);
789
790 my $ae_error = 595; # connecting
791
792 # handle actual, non-tunneled, request
793 my $handle_actual_request = sub {
794 $ae_error = 596; # request phase
795
796 my $hdl = $state{handle};
797
798 $hdl->starttls ("connect") if $uscheme eq "https" && !exists $hdl->{tls};
799
800 # send request
801 $hdl->push_write (
802 "$method $rpath HTTP/1.1\015\012"
803 . (join "", map "\u$_: $hdr{$_}\015\012", grep defined $hdr{$_}, keys %hdr)
804 . "\015\012"
805 . (delete $arg{body})
806 );
807
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 {
816 return unless %state;
817
818 for ("$_[1]") {
819 y/\015//d; # weed out any \015, as they show up in the weirdest of places.
820
821 /^HTTP\/0*([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\012]*) )? \012/gxci
822 or return _error %state, $cb, { @pseudo, Status => 599, Reason => "Invalid server response" };
823
824 # 100 Continue handling
825 # should not happen as we don't send expect: 100-continue,
826 # but we handle it just in case.
827 # since we send the request body regardless, if we get an error
828 # we are out of-sync, which we currently do NOT handle correctly.
829 return $state{handle}->push_read (line => $qr_nlnl, $state{read_response})
830 if $2 eq 100;
831
832 push @pseudo,
833 HTTPVersion => $1,
834 Status => $2,
835 Reason => $3,
836 ;
837
838 my $hdr = _parse_hdr
839 or return _error %state, $cb, { @pseudo, Status => 599, Reason => "Garbled response headers" };
840
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/\/[^\/]*$//;
855 }
856
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;
876 }
877 }
878
879 my $finish = sub { # ($data, $err_status, $err_reason[, $keepalive])
880 if ($state{handle}) {
881 # handle keepalive
882 if (
883 $keepalive
884 && $_[3]
885 && ($hdr{HTTPVersion} < 1.1
886 ? $hdr{connection} =~ /\bkeep-?alive\b/i
887 : $hdr{connection} !~ /\bclose\b/i)
888 ) {
889 ka_store $ka_key, delete $state{handle};
890 } else {
891 # no keepalive, destroy the handle
892 $state{handle}->destroy;
893 }
894 }
895
896 %state = ();
897
898 if (defined $_[1]) {
899 $hdr{OrigStatus} = $hdr{Status}; $hdr{Status} = $_[1];
900 $hdr{OrigReason} = $hdr{Reason}; $hdr{Reason} = $_[2];
901 }
902
903 # set-cookie processing
904 if ($arg{cookie_jar}) {
905 cookie_jar_set_cookie $arg{cookie_jar}, $hdr{"set-cookie"}, $uhost, $hdr{date};
906 }
907
908 if ($redirect && exists $hdr{location}) {
909 # we ignore any errors, as it is very common to receive
910 # Content-Length != 0 but no actual body
911 # we also access %hdr, as $_[1] might be an erro
912 http_request (
913 $method => $hdr{location},
914 %arg,
915 recurse => $recurse - 1,
916 Redirect => [$_[0], \%hdr],
917 $cb
918 );
919 } else {
920 $cb->($_[0], \%hdr);
921 }
922 };
923
924 $ae_error = 597; # body phase
925
926 my $chunked = $hdr{"transfer-encoding"} =~ /\bchunked\b/i; # not quite correct...
927
928 my $len = $chunked ? undef : $hdr{"content-length"};
929
930 # body handling, many different code paths
931 # - no body expected
932 # - want_body_handle
933 # - te chunked
934 # - 2x length known (with or without on_body)
935 # - 2x length not known (with or without on_body)
936 if (!$redirect && $arg{on_header} && !$arg{on_header}(\%hdr)) {
937 $finish->(undef, 598 => "Request cancelled by on_header");
938 } elsif (
939 $hdr{Status} =~ /^(?:1..|204|205|304)$/
940 or $method eq "HEAD"
941 or (defined $len && $len == 0) # == 0, not !, because "0 " is true
942 ) {
943 # no body
944 $finish->("", undef, undef, 1);
945
946 } elsif (!$redirect && $arg{want_body_handle}) {
947 $_[0]->on_eof (undef);
948 $_[0]->on_error (undef);
949 $_[0]->on_read (undef);
950
951 $finish->(delete $state{handle});
952
953 } elsif ($chunked) {
954 my $cl = 0;
955 my $body = "";
956 my $on_body = $arg{on_body} || sub { $body .= shift; 1 };
957
958 $state{read_chunk} = sub {
959 $_[1] =~ /^([0-9a-fA-F]+)/
960 or $finish->(undef, $ae_error => "Garbled chunked transfer encoding");
961
962 my $len = hex $1;
963
964 if ($len) {
965 $cl += $len;
966
967 $_[0]->push_read (chunk => $len, sub {
968 $on_body->($_[1], \%hdr)
969 or return $finish->(undef, 598 => "Request cancelled by on_body");
970
971 $_[0]->push_read (line => sub {
972 length $_[1]
973 and return $finish->(undef, $ae_error => "Garbled chunked transfer encoding");
974 $_[0]->push_read (line => $state{read_chunk});
975 });
976 });
977 } else {
978 $hdr{"content-length"} ||= $cl;
979
980 $_[0]->push_read (line => $qr_nlnl, sub {
981 if (length $_[1]) {
982 for ("$_[1]") {
983 y/\015//d; # weed out any \015, as they show up in the weirdest of places.
984
985 my $hdr = _parse_hdr
986 or return $finish->(undef, $ae_error => "Garbled response trailers");
987
988 %hdr = (%hdr, %$hdr);
989 }
990 }
991
992 $finish->($body, undef, undef, 1);
993 });
994 }
995 };
996
997 $_[0]->push_read (line => $state{read_chunk});
998
999 } elsif ($arg{on_body}) {
1000 if (defined $len) {
1001 $_[0]->on_read (sub {
1002 $len -= length $_[0]{rbuf};
1003
1004 $arg{on_body}(delete $_[0]{rbuf}, \%hdr)
1005 or return $finish->(undef, 598 => "Request cancelled by on_body");
1006
1007 $len > 0
1008 or $finish->("", undef, undef, 1);
1009 });
1010 } else {
1011 $_[0]->on_eof (sub {
1012 $finish->("");
1013 });
1014 $_[0]->on_read (sub {
1015 $arg{on_body}(delete $_[0]{rbuf}, \%hdr)
1016 or $finish->(undef, 598 => "Request cancelled by on_body");
1017 });
1018 }
1019 } else {
1020 $_[0]->on_eof (undef);
1021
1022 if (defined $len) {
1023 $_[0]->on_read (sub {
1024 $finish->((substr delete $_[0]{rbuf}, 0, $len, ""), undef, undef, 1)
1025 if $len <= length $_[0]{rbuf};
1026 });
1027 } else {
1028 $_[0]->on_error (sub {
1029 ($! == Errno::EPIPE || !$!)
1030 ? $finish->(delete $_[0]{rbuf})
1031 : $finish->(undef, $ae_error => $_[2]);
1032 });
1033 $_[0]->on_read (sub { });
1034 }
1035 }
1036 };
1037
1038 # if keepalive is enabled, then the server closing the connection
1039 # before a response can happen legally - we retry on idempotent methods.
1040 if ($keptalive && $idempotent) {
1041 my $old_eof = $hdl->{on_eof};
1042 $hdl->{on_eof} = sub {
1043 _destroy_state %state;
1044
1045 http_request (
1046 $method => $url,
1047 %arg,
1048 keepalive => 0,
1049 $cb
1050 );
1051 };
1052 $hdl->on_read (sub {
1053 return unless %state;
1054
1055 # as soon as we receive something, a connection close
1056 # once more becomes a hard error
1057 $hdl->{on_eof} = $old_eof;
1058 $hdl->push_read (line => $qr_nlnl, $state{read_response});
1059 });
1060 } else {
1061 $hdl->push_read (line => $qr_nlnl, $state{read_response});
1062 }
1063 };
1064
1065 my $prepare_handle = sub {
1066 my ($hdl) = $state{handle};
1067
1068 $hdl->timeout ($timeout);
1069 $hdl->on_error (sub {
1070 _error %state, $cb, { @pseudo, Status => $ae_error, Reason => $_[2] };
1071 });
1072 $hdl->on_eof (sub {
1073 _error %state, $cb, { @pseudo, Status => $ae_error, Reason => "Unexpected end-of-file" };
1074 });
1075 };
1076
1077 # connected to proxy (or origin server)
1078 my $connect_cb = sub {
1079 my $fh = shift
1080 or return _error %state, $cb, { @pseudo, Status => $ae_error, Reason => "$!" };
1081
1082 return unless delete $state{connect_guard};
1083
1084 # get handle
1085 $state{handle} = new AnyEvent::Handle
1086 %{ $arg{handle_params} },
1087 fh => $fh,
1088 peername => $uhost,
1089 tls_ctx => $arg{tls_ctx},
1090 ;
1091
1092 $prepare_handle->();
1093
1094 #$state{handle}->starttls ("connect") if $rscheme eq "https";
1095
1096 # now handle proxy-CONNECT method
1097 if ($proxy && $uscheme eq "https") {
1098 # oh dear, we have to wrap it into a connect request
1099
1100 # maybe re-use $uauthority with patched port?
1101 $state{handle}->push_write ("CONNECT $uhost:$uport HTTP/1.0\015\012\015\012");
1102 $state{handle}->push_read (line => $qr_nlnl, sub {
1103 $_[1] =~ /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\015\012]*) )?/ix
1104 or return _error %state, $cb, { @pseudo, Status => 599, Reason => "Invalid proxy connect response ($_[1])" };
1105
1106 if ($2 == 200) {
1107 $rpath = $upath;
1108 $handle_actual_request->();
1109 } else {
1110 _error %state, $cb, { @pseudo, Status => $2, Reason => $3 };
1111 }
1112 });
1113 } else {
1114 $handle_actual_request->();
1115 }
1116 };
658 1117
659 _get_slot $uhost, sub { 1118 _get_slot $uhost, sub {
660 $state{slot_guard} = shift; 1119 $state{slot_guard} = shift;
661 1120
662 return unless $state{connect_guard}; 1121 return unless $state{connect_guard};
663 1122
664 my $ae_error = 595; # connecting 1123 # try to use an existing keepalive connection, but only if we, ourselves, plan
665 1124 # on a keepalive request (in theory, this should be a separate config option).
666 # handle actual, non-tunneled, request 1125 if ($keepalive && $KA_CACHE{$ka_key}) {
667 my $handle_actual_request = sub { 1126 $keptalive = 1;
668 $ae_error = 596; # request phase 1127 $state{handle} = ka_fetch $ka_key;
669 1128 $prepare_handle->();
670 $state{handle}->starttls ("connect") if $uscheme eq "https" && !exists $state{handle}{tls};
671
672 # send request
673 $state{handle}->push_write (
674 "$method $rpath HTTP/1.1\015\012"
675 . (join "", map "\u$_: $hdr{$_}\015\012", grep defined $hdr{$_}, keys %hdr)
676 . "\015\012"
677 . (delete $arg{body})
678 );
679
680 # return if error occured during push_write()
681 return unless %state;
682
683 %hdr = (); # reduce memory usage, save a kitten, also make it possible to re-use
684
685 # status line and headers
686 $state{read_response} = sub {
687 for ("$_[1]") {
688 y/\015//d; # weed out any \015, as they show up in the weirdest of places.
689
690 /^HTTP\/0*([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\012]*) )? \012/gxci
691 or return (%state = (), $cb->(undef, { @pseudo, Status => 599, Reason => "Invalid server response" }));
692
693 # 100 Continue handling
694 # should not happen as we don't send expect: 100-continue,
695 # but we handle it just in case.
696 # since we send the request body regardless, if we get an error
697 # we are out of-sync, which we currently do NOT handle correctly.
698 return $state{handle}->push_read (line => $qr_nlnl, $state{read_response})
699 if $2 eq 100;
700
701 push @pseudo,
702 HTTPVersion => $1,
703 Status => $2,
704 Reason => $3,
705 ;
706
707 my $hdr = parse_hdr
708 or return (%state = (), $cb->(undef, { @pseudo, Status => 599, Reason => "Garbled response headers" }));
709
710 %hdr = (%$hdr, @pseudo);
711 }
712
713 # redirect handling
714 # microsoft and other shitheads don't give a shit for following standards,
715 # try to support some common forms of broken Location headers.
716 if ($hdr{location} !~ /^(?: $ | [^:\/?\#]+ : )/x) {
717 $hdr{location} =~ s/^\.\/+//;
718
719 my $url = "$rscheme://$uhost:$uport";
720
721 unless ($hdr{location} =~ s/^\///) {
722 $url .= $upath;
723 $url =~ s/\/[^\/]*$//;
724 }
725
726 $hdr{location} = "$url/$hdr{location}";
727 }
728
729 my $redirect;
730
731 if ($recurse) {
732 my $status = $hdr{Status};
733
734 # industry standard is to redirect POST as GET for
735 # 301, 302 and 303, in contrast to HTTP/1.0 and 1.1.
736 # also, the UA should ask the user for 301 and 307 and POST,
737 # industry standard seems to be to simply follow.
738 # we go with the industry standard.
739 if ($status == 301 or $status == 302 or $status == 303) {
740 # HTTP/1.1 is unclear on how to mutate the method
741 $method = "GET" unless $method eq "HEAD";
742 $redirect = 1;
743 } elsif ($status == 307) {
744 $redirect = 1;
745 }
746 }
747
748 my $finish = sub { # ($data, $err_status, $err_reason[, $keepalive])
749 my $may_keep_alive = $_[3];
750
751 $state{handle}->destroy if $state{handle};
752 %state = ();
753
754 if (defined $_[1]) {
755 $hdr{OrigStatus} = $hdr{Status}; $hdr{Status} = $_[1];
756 $hdr{OrigReason} = $hdr{Reason}; $hdr{Reason} = $_[2];
757 }
758
759 # set-cookie processing
760 if ($arg{cookie_jar}) {
761 cookie_jar_set_cookie $arg{cookie_jar}, $hdr{"set-cookie"}, $uhost, $hdr{date};
762 }
763
764 if ($redirect && exists $hdr{location}) {
765 # we ignore any errors, as it is very common to receive
766 # Content-Length != 0 but no actual body
767 # we also access %hdr, as $_[1] might be an erro
768 http_request (
769 $method => $hdr{location},
770 %arg,
771 recurse => $recurse - 1,
772 Redirect => [$_[0], \%hdr],
773 $cb);
774 } else {
775 $cb->($_[0], \%hdr);
776 }
777 };
778
779 $ae_error = 597; # body phase
780
781 my $len = $hdr{"content-length"};
782 warn "no content $redirect x<$len>$hdr{Status}\n";#d#
783
784 # body handling, many different code paths
785 # - no body expected
786 # - want_body_handle
787 # - te chunked
788 # - 2x length known (with or without on_body)
789 # - 2x length not known (with or without on_body)
790 if (!$redirect && $arg{on_header} && !$arg{on_header}(\%hdr)) {
791 $finish->(undef, 598 => "Request cancelled by on_header");
792 } elsif (
793 $hdr{Status} =~ /^(?:1..|204|205|304)$/
794 or $method eq "HEAD"
795 or (defined $len && $len == 0) # == 0, not !, because "0 " is true
796 ) {
797 # no body
798 $finish->("", undef, undef, 1);
799
800 } elsif (!$redirect && $arg{want_body_handle}) {
801 $_[0]->on_eof (undef);
802 $_[0]->on_error (undef);
803 $_[0]->on_read (undef);
804
805 $finish->(delete $state{handle});
806
807 } elsif ($hdr{"transfer-encoding"} =~ /\bchunked\b/i) {
808 my $cl = 0;
809 my $body = undef;
810 my $on_body = $arg{on_body} || sub { $body .= shift; 1 };
811
812 $state{read_chunk} = sub {
813 $_[1] =~ /^([0-9a-fA-F]+)/
814 or $finish->(undef, $ae_error => "Garbled chunked transfer encoding");
815
816 my $len = hex $1;
817
818 if ($len) {
819 $cl += $len;
820
821 $_[0]->push_read (chunk => $len, sub {
822 $on_body->($_[1], \%hdr)
823 or return $finish->(undef, 598 => "Request cancelled by on_body");
824
825 $_[0]->push_read (line => sub {
826 length $_[1]
827 and return $finish->(undef, $ae_error => "Garbled chunked transfer encoding");
828 $_[0]->push_read (line => $state{read_chunk});
829 });
830 });
831 } else {
832 $hdr{"content-length"} ||= $cl;
833
834 $_[0]->push_read (line => $qr_nlnl, sub {
835 if (length $_[1]) {
836 for ("$_[1]") {
837 y/\015//d; # weed out any \015, as they show up in the weirdest of places.
838
839 my $hdr = parse_hdr
840 or return $finish->(undef, $ae_error => "Garbled response trailers");
841
842 %hdr = (%hdr, %$hdr);
843 }
844 }
845
846 $finish->($body, undef, undef, 1);
847 });
848 }
849 };
850
851 $_[0]->push_read (line => $state{read_chunk});
852
853 } elsif ($arg{on_body}) {
854 if (defined $len) {
855 $_[0]->on_read (sub {
856 $len -= length $_[0]{rbuf};
857
858 $arg{on_body}(delete $_[0]{rbuf}, \%hdr)
859 or return $finish->(undef, 598 => "Request cancelled by on_body");
860
861 $len > 0
862 or $finish->("", undef, undef, 1);
863 });
864 } else {
865 $_[0]->on_eof (sub {
866 $finish->("");
867 });
868 $_[0]->on_read (sub {
869 $arg{on_body}(delete $_[0]{rbuf}, \%hdr)
870 or $finish->(undef, 598 => "Request cancelled by on_body");
871 });
872 }
873 } else {
874 $_[0]->on_eof (undef);
875
876 if (defined $len) {
877 $_[0]->on_read (sub {
878 $finish->((substr delete $_[0]{rbuf}, 0, $len, ""), undef, undef, 1)
879 if $len <= length $_[0]{rbuf};
880 });
881 } else {
882 $_[0]->on_error (sub {
883 ($! == Errno::EPIPE || !$!)
884 ? $finish->(delete $_[0]{rbuf})
885 : $finish->(undef, $ae_error => $_[2]);
886 });
887 $_[0]->on_read (sub { });
888 }
889 }
890 };
891
892 $state{handle}->push_read (line => $qr_nlnl, $state{read_response});
893 };
894
895 my $connect_cb = sub {
896 $state{fh} = shift
897 or do {
898 my $err = "$!";
899 %state = ();
900 return $cb->(undef, { @pseudo, Status => $ae_error, Reason => $err });
901 };
902
903 return unless delete $state{connect_guard};
904
905 # get handle
906 $state{handle} = new AnyEvent::Handle
907 fh => $state{fh},
908 peername => $rhost,
909 tls_ctx => $arg{tls_ctx},
910 # these need to be reconfigured on keepalive handles
911 timeout => $timeout,
912 on_error => sub {
913 %state = ();
914 $cb->(undef, { @pseudo, Status => $ae_error, Reason => $_[2] });
915 },
916 on_eof => sub {
917 %state = ();
918 $cb->(undef, { @pseudo, Status => $ae_error, Reason => "Unexpected end-of-file" });
919 },
920 ;
921
922 # limit the number of persistent connections
923 # keepalive not yet supported
924# if ($KA_COUNT{$_[1]} < $MAX_PERSISTENT_PER_HOST) {
925# ++$KA_COUNT{$_[1]};
926# $state{handle}{ka_count_guard} = AnyEvent::Util::guard {
927# --$KA_COUNT{$_[1]}
928# };
929# $hdr{connection} = "keep-alive";
930# }
931
932 $state{handle}->starttls ("connect") if $rscheme eq "https";
933
934 # now handle proxy-CONNECT method
935 if ($proxy && $uscheme eq "https") {
936 # oh dear, we have to wrap it into a connect request
937
938 # maybe re-use $uauthority with patched port?
939 $state{handle}->push_write ("CONNECT $uhost:$uport HTTP/1.0\015\012Host: $uhost\015\012\015\012");
940 $state{handle}->push_read (line => $qr_nlnl, sub {
941 $_[1] =~ /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\015\012]*) )?/ix
942 or return (%state = (), $cb->(undef, { @pseudo, Status => 599, Reason => "Invalid proxy connect response ($_[1])" }));
943
944 if ($2 == 200) {
945 $rpath = $upath;
946 $handle_actual_request->();
947 } else {
948 %state = ();
949 $cb->(undef, { @pseudo, Status => $2, Reason => $3 });
950 }
951 });
952 } else {
953 $handle_actual_request->(); 1129 $handle_actual_request->();
954 }
955 };
956 1130
1131 } else {
957 my $tcp_connect = $arg{tcp_connect} 1132 my $tcp_connect = $arg{tcp_connect}
958 || do { require AnyEvent::Socket; \&AnyEvent::Socket::tcp_connect }; 1133 || do { require AnyEvent::Socket; \&AnyEvent::Socket::tcp_connect };
959 1134
960 $state{connect_guard} = $tcp_connect->($rhost, $rport, $connect_cb, $arg{on_prepare} || sub { $timeout }); 1135 $state{connect_guard} = $tcp_connect->($rhost, $rport, $connect_cb, $arg{on_prepare} || sub { $timeout });
1136 }
961 }; 1137 };
962 1138
963 defined wantarray && AnyEvent::Util::guard { %state = () } 1139 defined wantarray && AnyEvent::Util::guard { _destroy_state %state }
964} 1140}
965 1141
966sub http_get($@) { 1142sub http_get($@) {
967 unshift @_, "GET"; 1143 unshift @_, "GET";
968 &http_request 1144 &http_request
986AnyEvent::HTTP uses the AnyEvent::Socket::tcp_connect function for 1162AnyEvent::HTTP uses the AnyEvent::Socket::tcp_connect function for
987the actual connection, which in turn uses AnyEvent::DNS to resolve 1163the actual connection, which in turn uses AnyEvent::DNS to resolve
988hostnames. The latter is a simple stub resolver and does no caching 1164hostnames. The latter is a simple stub resolver and does no caching
989on its own. If you want DNS caching, you currently have to provide 1165on its own. If you want DNS caching, you currently have to provide
990your own default resolver (by storing a suitable resolver object in 1166your own default resolver (by storing a suitable resolver object in
991C<$AnyEvent::DNS::RESOLVER>). 1167C<$AnyEvent::DNS::RESOLVER>) or your own C<tcp_connect> callback.
992 1168
993=head2 GLOBAL FUNCTIONS AND VARIABLES 1169=head2 GLOBAL FUNCTIONS AND VARIABLES
994 1170
995=over 4 1171=over 4
996 1172
997=item AnyEvent::HTTP::set_proxy "proxy-url" 1173=item AnyEvent::HTTP::set_proxy "proxy-url"
998 1174
999Sets the default proxy server to use. The proxy-url must begin with a 1175Sets the default proxy server to use. The proxy-url must begin with a
1000string of the form C<http://host:port> (optionally C<https:...>), croaks 1176string of the form C<http://host:port>, croaks otherwise.
1001otherwise.
1002 1177
1003To clear an already-set proxy, use C<undef>. 1178To clear an already-set proxy, use C<undef>.
1179
1180When AnyEvent::HTTP is laoded for the first time it will query the
1181default proxy from the operating system, currently by looking at
1182C<$ENV{http_proxy>}.
1004 1183
1005=item AnyEvent::HTTP::cookie_jar_expire $jar[, $session_end] 1184=item AnyEvent::HTTP::cookie_jar_expire $jar[, $session_end]
1006 1185
1007Remove all cookies from the cookie jar that have been expired. If 1186Remove all cookies from the cookie jar that have been expired. If
1008C<$session_end> is given and true, then additionally remove all session 1187C<$session_end> is given and true, then additionally remove all session
1054 1233
1055=item $AnyEvent::HTTP::MAX_RECURSE 1234=item $AnyEvent::HTTP::MAX_RECURSE
1056 1235
1057The default value for the C<recurse> request parameter (default: C<10>). 1236The default value for the C<recurse> request parameter (default: C<10>).
1058 1237
1238=item $AnyEvent::HTTP::TIMEOUT
1239
1240The default timeout for conenction operations (default: C<300>).
1241
1059=item $AnyEvent::HTTP::USERAGENT 1242=item $AnyEvent::HTTP::USERAGENT
1060 1243
1061The default value for the C<User-Agent> header (the default is 1244The default value for the C<User-Agent> header (the default is
1062C<Mozilla/5.0 (compatible; U; AnyEvent-HTTP/$VERSION; +http://software.schmorp.de/pkg/AnyEvent)>). 1245C<Mozilla/5.0 (compatible; U; AnyEvent-HTTP/$VERSION; +http://software.schmorp.de/pkg/AnyEvent)>).
1063 1246
1064=item $AnyEvent::HTTP::MAX_PER_HOST 1247=item $AnyEvent::HTTP::MAX_PER_HOST
1065 1248
1066The maximum number of concurrent connections to the same host (identified 1249The maximum number of concurrent connections to the same host (identified
1067by the hostname). If the limit is exceeded, then the additional requests 1250by the hostname). If the limit is exceeded, then the additional requests
1068are queued until previous connections are closed. 1251are queued until previous connections are closed. Both persistent and
1252non-persistent connections are counted in this limit.
1069 1253
1070The default value for this is C<4>, and it is highly advisable to not 1254The default value for this is C<4>, and it is highly advisable to not
1071increase it. 1255increase it much.
1256
1257For comparison: the RFC's recommend 4 non-persistent or 2 persistent
1258connections, older browsers used 2, newers (such as firefox 3) typically
1259use 6, and Opera uses 8 because like, they have the fastest browser and
1260give a shit for everybody else on the planet.
1261
1262=item $AnyEvent::HTTP::PERSISTENT_TIMEOUT
1263
1264The time after which idle persistent conenctions get closed by
1265AnyEvent::HTTP (default: C<3>).
1072 1266
1073=item $AnyEvent::HTTP::ACTIVE 1267=item $AnyEvent::HTTP::ACTIVE
1074 1268
1075The number of active connections. This is not the number of currently 1269The number of active connections. This is not the number of currently
1076running requests, but the number of currently open and non-idle TCP 1270running requests, but the number of currently open and non-idle TCP
1077connections. This number of can be useful for load-leveling. 1271connections. This number can be useful for load-leveling.
1078 1272
1079=back 1273=back
1080 1274
1081=cut 1275=cut
1082 1276
1125 undef 1319 undef
1126} 1320}
1127 1321
1128sub set_proxy($) { 1322sub set_proxy($) {
1129 if (length $_[0]) { 1323 if (length $_[0]) {
1130 $_[0] =~ m%^(https?):// ([^:/]+) (?: : (\d*) )?%ix 1324 $_[0] =~ m%^(http):// ([^:/]+) (?: : (\d*) )?%ix
1131 or Carp::croak "$_[0]: invalid proxy URL"; 1325 or Carp::croak "$_[0]: invalid proxy URL";
1132 $PROXY = [$2, $3 || 3128, $1] 1326 $PROXY = [$2, $3 || 3128, $1]
1133 } else { 1327 } else {
1134 undef $PROXY; 1328 undef $PROXY;
1135 } 1329 }
1138# initialise proxy from environment 1332# initialise proxy from environment
1139eval { 1333eval {
1140 set_proxy $ENV{http_proxy}; 1334 set_proxy $ENV{http_proxy};
1141}; 1335};
1142 1336
1337=head2 SHOWCASE
1338
1339This section contaisn some more elaborate "real-world" examples or code
1340snippets.
1341
1342=head2 HTTP/1.1 FILE DOWNLOAD
1343
1344Downloading files with HTTP can be quite tricky, especially when something
1345goes wrong and you want to resume.
1346
1347Here is a function that initiates and resumes a download. It uses the
1348last modified time to check for file content changes, and works with many
1349HTTP/1.0 servers as well, and usually falls back to a complete re-download
1350on older servers.
1351
1352It calls the completion callback with either C<undef>, which means a
1353nonretryable error occured, C<0> when the download was partial and should
1354be retried, and C<1> if it was successful.
1355
1356 use AnyEvent::HTTP;
1357
1358 sub download($$$) {
1359 my ($url, $file, $cb) = @_;
1360
1361 open my $fh, "+<", $file
1362 or die "$file: $!";
1363
1364 my %hdr;
1365 my $ofs = 0;
1366
1367 warn stat $fh;
1368 warn -s _;
1369 if (stat $fh and -s _) {
1370 $ofs = -s _;
1371 warn "-s is ", $ofs;#d#
1372 $hdr{"if-unmodified-since"} = AnyEvent::HTTP::format_date +(stat _)[9];
1373 $hdr{"range"} = "bytes=$ofs-";
1374 }
1375
1376 http_get $url,
1377 headers => \%hdr,
1378 on_header => sub {
1379 my ($hdr) = @_;
1380
1381 if ($hdr->{Status} == 200 && $ofs) {
1382 # resume failed
1383 truncate $fh, $ofs = 0;
1384 }
1385
1386 sysseek $fh, $ofs, 0;
1387
1388 1
1389 },
1390 on_body => sub {
1391 my ($data, $hdr) = @_;
1392
1393 if ($hdr->{Status} =~ /^2/) {
1394 length $data == syswrite $fh, $data
1395 or return; # abort on write errors
1396 }
1397
1398 1
1399 },
1400 sub {
1401 my (undef, $hdr) = @_;
1402
1403 my $status = $hdr->{Status};
1404
1405 if (my $time = AnyEvent::HTTP::parse_date $hdr->{"last-modified"}) {
1406 utime $fh, $time, $time;
1407 }
1408
1409 if ($status == 200 || $status == 206 || $status == 416) {
1410 # download ok || resume ok || file already fully downloaded
1411 $cb->(1, $hdr);
1412
1413 } elsif ($status == 412) {
1414 # file has changed while resuming, delete and retry
1415 unlink $file;
1416 $cb->(0, $hdr);
1417
1418 } elsif ($status == 500 or $status == 503 or $status =~ /^59/) {
1419 # retry later
1420 $cb->(0, $hdr);
1421
1422 } else {
1423 $cb->(undef, $hdr);
1424 }
1425 }
1426 ;
1427 }
1428
1429 download "http://server/somelargefile", "/tmp/somelargefile", sub {
1430 if ($_[0]) {
1431 print "OK!\n";
1432 } elsif (defined $_[0]) {
1433 print "please retry later\n";
1434 } else {
1435 print "ERROR\n";
1436 }
1437 };
1438
1143=head2 SOCKS PROXIES 1439=head3 SOCKS PROXIES
1144 1440
1145Socks proxies are not directly supported by AnyEvent::HTTP. You can 1441Socks proxies are not directly supported by AnyEvent::HTTP. You can
1146compile your perl to support socks, or use an external program such as 1442compile your perl to support socks, or use an external program such as
1147F<socksify> (dante) or F<tsocks> to make your program use a socks proxy 1443F<socksify> (dante) or F<tsocks> to make your program use a socks proxy
1148transparently. 1444transparently.

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines