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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines