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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines