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.90 by root, Mon Jan 3 00:41:25 2011 UTC vs.
Revision 1.118 by root, Mon Nov 18 01:01:02 2013 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.15';
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 = 2;
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
93C<http_request> returns a "cancellation guard" - you have to keep the 89C<http_request> returns a "cancellation guard" - you have to keep the
94object at least alive until the callback get called. If the object gets 90object at least alive until the callback get called. If the object gets
95destroyed before the callback is called, the request will be cancelled. 91destroyed before the callback is called, the request will be cancelled.
96 92
97The callback will be called with the response body data as first argument 93The callback will be called with the response body data as first argument
98(or C<undef> if an error occured), and a hash-ref with response headers 94(or C<undef> if an error occurred), and a hash-ref with response headers
99(and trailers) as second argument. 95(and trailers) as second argument.
100 96
101All the headers in that hash are lowercased. In addition to the response 97All the headers in that hash are lowercased. In addition to the response
102headers, the "pseudo-headers" (uppercase to avoid clashing with possible 98headers, the "pseudo-headers" (uppercase to avoid clashing with possible
103response headers) C<HTTPVersion>, C<Status> and C<Reason> contain the 99response headers) C<HTTPVersion>, C<Status> and C<Reason> contain the
127C<590>-C<599> and the C<Reason> pseudo-header will contain an error 123C<590>-C<599> and the C<Reason> pseudo-header will contain an error
128message. Currently the following status codes are used: 124message. Currently the following status codes are used:
129 125
130=over 4 126=over 4
131 127
132=item 595 - errors during connection etsbalishment, proxy handshake. 128=item 595 - errors during connection establishment, proxy handshake.
133 129
134=item 596 - errors during TLS negotiation, request sending and header processing. 130=item 596 - errors during TLS negotiation, request sending and header processing.
135 131
136=item 597 - errors during body receiving or processing. 132=item 597 - errors during body receiving or processing.
137 133
158 154
159=over 4 155=over 4
160 156
161=item recurse => $count (default: $MAX_RECURSE) 157=item recurse => $count (default: $MAX_RECURSE)
162 158
163Whether to recurse requests or not, e.g. on redirects, authentication 159Whether to recurse requests or not, e.g. on redirects, authentication and
164retries and so on, and how often to do so. 160other retries and so on, and how often to do so.
165 161
166=item headers => hashref 162=item headers => hashref
167 163
168The request headers to use. Currently, C<http_request> may provide its own 164The request headers to use. Currently, C<http_request> may provide its own
169C<Host:>, C<Content-Length:>, C<Connection:> and C<Cookie:> headers and 165C<Host:>, C<Content-Length:>, C<Connection:> and C<Cookie:> headers and
173 169
174You really should provide your own C<User-Agent:> header value that is 170You really should provide your own C<User-Agent:> header value that is
175appropriate for your program - I wouldn't be surprised if the default 171appropriate for your program - I wouldn't be surprised if the default
176AnyEvent string gets blocked by webservers sooner or later. 172AnyEvent string gets blocked by webservers sooner or later.
177 173
174Also, make sure that your headers names and values do not contain any
175embedded newlines.
176
178=item timeout => $seconds 177=item timeout => $seconds
179 178
180The 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
181the 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
182timeout. 181timeout.
183 182
184Default timeout is 5 minutes. 183Default timeout is 5 minutes.
185 184
186=item proxy => [$host, $port[, $scheme]] or undef 185=item proxy => [$host, $port[, $scheme]] or undef
187 186
188Use 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
189default proxy (as specified by C<$ENV{http_proxy}>) is used. 188used.
190 189
191C<$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.
192HTTPS. 191
192If not specified, then the default proxy is used (see
193C<AnyEvent::HTTP::set_proxy>).
193 194
194=item body => $string 195=item body => $string
195 196
196The 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
197this module might offer more options). 198this module might offer more options).
228verification) TLS context. 229verification) TLS context.
229 230
230The 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
231me the page, no matter what". 232me the page, no matter what".
232 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.
243
233=item on_prepare => $callback->($fh) 244=item on_prepare => $callback->($fh)
234 245
235In 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
236connect (for exmaple, to bind it on a given IP address). This parameter 247connect (for example, to bind it on a given IP address). This parameter
237overrides the prepare callback passed to C<AnyEvent::Socket::tcp_connect> 248overrides the prepare callback passed to C<AnyEvent::Socket::tcp_connect>
238and behaves exactly the same way (e.g. it has to provide a 249and behaves exactly the same way (e.g. it has to provide a
239timeout). See the description for the C<$prepare_cb> argument of 250timeout). See the description for the C<$prepare_cb> argument of
240C<AnyEvent::Socket::tcp_connect> for details. 251C<AnyEvent::Socket::tcp_connect> for details.
241 252
306called. Instead of the C<$body> argument containing the body data, the 317called. Instead of the C<$body> argument containing the body data, the
307callback will receive the L<AnyEvent::Handle> object associated with the 318callback will receive the L<AnyEvent::Handle> object associated with the
308connection. 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
309(e.g. status C<304>), the empty string will be passed. 320(e.g. status C<304>), the empty string will be passed.
310 321
311The 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
312a proxy, be a persistent connection etc., and configured in unspecified 323to a proxy, be a persistent connection, use chunked transfer encoding
313ways. 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
314module anymore). 325handle (it will not be used by this module anymore).
315 326
316This is useful with some push-type services, where, after the initial 327This is useful with some push-type services, where, after the initial
317headers, an interactive protocol is used (typical example would be the 328headers, an interactive protocol is used (typical example would be the
318push-style twitter API which starts a JSON/XML stream). 329push-style twitter API which starts a JSON/XML stream).
319 330
320If 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
321that 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 },
322 374
323=back 375=back
324 376
325Example: 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
326the response body. 378the response body.
332 384
333Example: 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
334timeout of 30 seconds. 386timeout of 30 seconds.
335 387
336 http_request 388 http_request
337 GET => "https://www.google.com", 389 HEAD => "https://www.google.com",
338 headers => { "user-agent" => "MySearchClient 1.0" }, 390 headers => { "user-agent" => "MySearchClient 1.0" },
339 timeout => 30, 391 timeout => 30,
340 sub { 392 sub {
341 my ($body, $hdr) = @_; 393 my ($body, $hdr) = @_;
342 use Data::Dumper; 394 use Data::Dumper;
353 }; 405 };
354 406
355 undef $request; 407 undef $request;
356 408
357=cut 409=cut
410
411#############################################################################
412# wait queue/slots
358 413
359sub _slot_schedule; 414sub _slot_schedule;
360sub _slot_schedule($) { 415sub _slot_schedule($) {
361 my $host = shift; 416 my $host = shift;
362 417
385 440
386 _slot_schedule $_[0]; 441 _slot_schedule $_[0];
387} 442}
388 443
389############################################################################# 444#############################################################################
445# cookie handling
390 446
391# expire cookies 447# expire cookies
392sub cookie_jar_expire($;$) { 448sub cookie_jar_expire($;$) {
393 my ($jar, $session_end) = @_; 449 my ($jar, $session_end) = @_;
394 450
418 } 474 }
419} 475}
420 476
421# extract cookies from jar 477# extract cookies from jar
422sub cookie_jar_extract($$$$) { 478sub cookie_jar_extract($$$$) {
423 my ($jar, $uscheme, $uhost, $upath) = @_; 479 my ($jar, $scheme, $host, $path) = @_;
424 480
425 %$jar = () if $jar->{version} != 1; 481 %$jar = () if $jar->{version} != 1;
426 482
427 my @cookies; 483 my @cookies;
428 484
429 while (my ($chost, $paths) = each %$jar) { 485 while (my ($chost, $paths) = each %$jar) {
430 next unless ref $paths; 486 next unless ref $paths;
431 487
432 if ($chost =~ /^\./) { 488 if ($chost =~ /^\./) {
433 next unless $chost eq substr $uhost, -length $chost; 489 next unless $chost eq substr $host, -length $chost;
434 } elsif ($chost =~ /\./) { 490 } elsif ($chost =~ /\./) {
435 next unless $chost eq $uhost; 491 next unless $chost eq $host;
436 } else { 492 } else {
437 next; 493 next;
438 } 494 }
439 495
440 while (my ($cpath, $cookies) = each %$paths) { 496 while (my ($cpath, $cookies) = each %$paths) {
441 next unless $cpath eq substr $upath, 0, length $cpath; 497 next unless $cpath eq substr $path, 0, length $cpath;
442 498
443 while (my ($cookie, $kv) = each %$cookies) { 499 while (my ($cookie, $kv) = each %$cookies) {
444 next if $uscheme ne "https" && exists $kv->{secure}; 500 next if $scheme ne "https" && exists $kv->{secure};
445 501
446 if (exists $kv->{_expires} and AE::now > $kv->{_expires}) { 502 if (exists $kv->{_expires} and AE::now > $kv->{_expires}) {
447 delete $cookies->{$cookie}; 503 delete $cookies->{$cookie};
448 next; 504 next;
449 } 505 }
463 \@cookies 519 \@cookies
464} 520}
465 521
466# parse set_cookie header into jar 522# parse set_cookie header into jar
467sub cookie_jar_set_cookie($$$$) { 523sub cookie_jar_set_cookie($$$$) {
468 my ($jar, $set_cookie, $uhost, $date) = @_; 524 my ($jar, $set_cookie, $host, $date) = @_;
469 525
470 my $anow = int AE::now; 526 my $anow = int AE::now;
471 my $snow; # server-now 527 my $snow; # server-now
472 528
473 for ($set_cookie) { 529 for ($set_cookie) {
479 while ( 535 while (
480 m{ 536 m{
481 \G\s* 537 \G\s*
482 (?: 538 (?:
483 expires \s*=\s* ([A-Z][a-z][a-z]+,\ [^,;]+) 539 expires \s*=\s* ([A-Z][a-z][a-z]+,\ [^,;]+)
484 | ([^=;,[:space:]]+) (?: \s*=\s* (?: "((?:[^\\"]+|\\.)*)" | ([^=;,[:space:]]*) ) )? 540 | ([^=;,[:space:]]+) (?: \s*=\s* (?: "((?:[^\\"]+|\\.)*)" | ([^;,[:space:]]*) ) )?
485 ) 541 )
486 }gcxsi 542 }gcxsi
487 ) { 543 ) {
488 my $name = $2; 544 my $name = $2;
489 my $value = $4; 545 my $value = $4;
496 # quoted 552 # quoted
497 $value = $3; 553 $value = $3;
498 $value =~ s/\\(.)/$1/gs; 554 $value =~ s/\\(.)/$1/gs;
499 } 555 }
500 556
501 push @kv, lc $name, $value; 557 push @kv, @kv ? lc $name : $name, $value;
502 558
503 last unless /\G\s*;/gc; 559 last unless /\G\s*;/gc;
504 } 560 }
505 561
506 last unless @kv; 562 last unless @kv;
529 585
530 # this is not rfc-like and not netscape-like. go figure. 586 # this is not rfc-like and not netscape-like. go figure.
531 my $ndots = $cdom =~ y/.//; 587 my $ndots = $cdom =~ y/.//;
532 next if $ndots < ($cdom =~ /\.[^.][^.]\.[^.][^.]$/ ? 3 : 2); 588 next if $ndots < ($cdom =~ /\.[^.][^.]\.[^.][^.]$/ ? 3 : 2);
533 } else { 589 } else {
534 $cdom = $uhost; 590 $cdom = $host;
535 } 591 }
536 592
537 # store it 593 # store it
538 $jar->{version} = 1; 594 $jar->{version} = 1;
539 $jar->{lc $cdom}{$cpath}{$name} = \%kv; 595 $jar->{lc $cdom}{$cpath}{$name} = \%kv;
540 596
541 redo if /\G\s*,/gc; 597 redo if /\G\s*,/gc;
542 } 598 }
543} 599}
544 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
545# continue to parse $_ for headers and place them into the arg 643# continue to parse $_ for headers and place them into the arg
546sub parse_hdr() { 644sub _parse_hdr() {
547 my %hdr; 645 my %hdr;
548 646
549 # things seen, not parsed: 647 # things seen, not parsed:
550 # p3pP="NON CUR OTPi OUR NOR UNI" 648 # p3pP="NON CUR OTPi OUR NOR UNI"
551 649
565 for values %hdr; 663 for values %hdr;
566 664
567 \%hdr 665 \%hdr
568} 666}
569 667
668#############################################################################
669# http_get
670
570our $qr_nlnl = qr{(?<![^\012])\015?\012}; 671our $qr_nlnl = qr{(?<![^\012])\015?\012};
571 672
572our $TLS_CTX_LOW = { cache => 1, sslv2 => 1 }; 673our $TLS_CTX_LOW = { cache => 1, sslv2 => 1 };
573our $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}
693
694our %IDEMPOTENT = (
695 DELETE => 1,
696 GET => 1,
697 HEAD => 1,
698 OPTIONS => 1,
699 PUT => 1,
700 TRACE => 1,
701
702 ACL => 1,
703 "BASELINE-CONTROL" => 1,
704 BIND => 1,
705 CHECKIN => 1,
706 CHECKOUT => 1,
707 COPY => 1,
708 LABEL => 1,
709 LINK => 1,
710 MERGE => 1,
711 MKACTIVITY => 1,
712 MKCALENDAR => 1,
713 MKCOL => 1,
714 MKREDIRECTREF => 1,
715 MKWORKSPACE => 1,
716 MOVE => 1,
717 ORDERPATCH => 1,
718 PROPFIND => 1,
719 PROPPATCH => 1,
720 REBIND => 1,
721 REPORT => 1,
722 SEARCH => 1,
723 UNBIND => 1,
724 UNCHECKOUT => 1,
725 UNLINK => 1,
726 UNLOCK => 1,
727 UPDATE => 1,
728 UPDATEREDIRECTREF => 1,
729 "VERSION-CONTROL" => 1,
730);
574 731
575sub http_request($$@) { 732sub http_request($$@) {
576 my $cb = pop; 733 my $cb = pop;
577 my ($method, $url, %arg) = @_; 734 my ($method, $url, %arg) = @_;
578 735
596 my $recurse = exists $arg{recurse} ? delete $arg{recurse} : $MAX_RECURSE; 753 my $recurse = exists $arg{recurse} ? delete $arg{recurse} : $MAX_RECURSE;
597 754
598 return $cb->(undef, { @pseudo, Status => 599, Reason => "Too many redirections" }) 755 return $cb->(undef, { @pseudo, Status => 599, Reason => "Too many redirections" })
599 if $recurse < 0; 756 if $recurse < 0;
600 757
601 my $proxy = $arg{proxy} || $PROXY; 758 my $proxy = exists $arg{proxy} ? $arg{proxy} : $PROXY;
602 my $timeout = $arg{timeout} || $TIMEOUT; 759 my $timeout = $arg{timeout} || $TIMEOUT;
603 760
604 my ($uscheme, $uauthority, $upath, $query, $fragment) = 761 my ($uscheme, $uauthority, $upath, $query, undef) = # ignore fragment
605 $url =~ m|(?:([^:/?#]+):)?(?://([^/?#]*))?([^?#]*)(?:(\?[^#]*))?(?:#(.*))?|; 762 $url =~ m|^([^:]+):(?://([^/?#]*))?([^?#]*)(?:(\?[^#]*))?(?:#(.*))?$|;
606 763
607 $uscheme = lc $uscheme; 764 $uscheme = lc $uscheme;
608 765
609 my $uport = $uscheme eq "http" ? 80 766 my $uport = $uscheme eq "http" ? 80
610 : $uscheme eq "https" ? 443 767 : $uscheme eq "https" ? 443
654 $hdr{"user-agent"} = $USERAGENT unless exists $hdr{"user-agent"}; 811 $hdr{"user-agent"} = $USERAGENT unless exists $hdr{"user-agent"};
655 812
656 $hdr{"content-length"} = length $arg{body} 813 $hdr{"content-length"} = length $arg{body}
657 if length $arg{body} || $method ne "GET"; 814 if length $arg{body} || $method ne "GET";
658 815
659 my $idempotent = $method =~ /^(?:GET|HEAD|PUT|DELETE|OPTIONS|TRACE)$/; 816 my $idempotent = $IDEMPOTENT{$method};
660 817
661 # default value for keepalive is true iff the request is for an idempotent method 818 # default value for keepalive is true iff the request is for an idempotent method
662 my $keepalive = exists $arg{keepalive} 819 my $persistent = exists $arg{persistent} ? !!$arg{persistent} : $idempotent;
663 ? $arg{keepalive}*1 820 my $keepalive = exists $arg{keepalive} ? !!$arg{keepalive} : !$proxy;
664 : $idempotent ? $PERSISTENT_TIMEOUT : 0; 821 my $was_persistent; # true if this is actually a recycled connection
665 822
823 # the key to use in the keepalive cache
824 my $ka_key = "$uscheme\x00$uhost\x00$uport\x00$arg{sessionid}";
825
666 $hdr{connection} = ($keepalive ? "" : "close ") . "Te"; #1.1 826 $hdr{connection} = ($persistent ? $keepalive ? "keep-alive, " : "" : "close, ") . "Te"; #1.1
667 $hdr{te} = "trailers" unless exists $hdr{te}; #1.1 827 $hdr{te} = "trailers" unless exists $hdr{te}; #1.1
668 828
669 my %state = (connect_guard => 1); 829 my %state = (connect_guard => 1);
670 830
671 my $ae_error = 595; # connecting 831 my $ae_error = 595; # connecting
672 832
673 # handle actual, non-tunneled, request 833 # handle actual, non-tunneled, request
674 my $handle_actual_request = sub { 834 my $handle_actual_request = sub {
675 $ae_error = 596; # request phase 835 $ae_error = 596; # request phase
676 836
837 my $hdl = $state{handle};
838
677 $state{handle}->starttls ("connect") if $uscheme eq "https" && !exists $state{handle}{tls}; 839 $hdl->starttls ("connect") if $uscheme eq "https" && !exists $hdl->{tls};
678 840
679 # send request 841 # send request
680 $state{handle}->push_write ( 842 $hdl->push_write (
681 "$method $rpath HTTP/1.1\015\012" 843 "$method $rpath HTTP/1.1\015\012"
682 . (join "", map "\u$_: $hdr{$_}\015\012", grep defined $hdr{$_}, keys %hdr) 844 . (join "", map "\u$_: $hdr{$_}\015\012", grep defined $hdr{$_}, keys %hdr)
683 . "\015\012" 845 . "\015\012"
684 . (delete $arg{body}) 846 . (delete $arg{body})
685 ); 847 );
686 848
687 # return if error occured during push_write() 849 # return if error occurred during push_write()
688 return unless %state; 850 return unless %state;
689 851
690 # reduce memory usage, save a kitten, also re-use it for the response headers. 852 # reduce memory usage, save a kitten, also re-use it for the response headers.
691 %hdr = (); 853 %hdr = ();
692 854
693 # status line and headers 855 # status line and headers
694 $state{read_response} = sub { 856 $state{read_response} = sub {
857 return unless %state;
858
695 for ("$_[1]") { 859 for ("$_[1]") {
696 y/\015//d; # weed out any \015, as they show up in the weirdest of places. 860 y/\015//d; # weed out any \015, as they show up in the weirdest of places.
697 861
698 /^HTTP\/0*([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\012]*) )? \012/gxci 862 /^HTTP\/0*([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\012]*) )? \012/gxci
699 or return (%state = (), $cb->(undef, { @pseudo, Status => 599, Reason => "Invalid server response" })); 863 or return _error %state, $cb, { @pseudo, Status => 599, Reason => "Invalid server response" };
700 864
701 # 100 Continue handling 865 # 100 Continue handling
702 # should not happen as we don't send expect: 100-continue, 866 # should not happen as we don't send expect: 100-continue,
703 # but we handle it just in case. 867 # but we handle it just in case.
704 # since we send the request body regardless, if we get an error 868 # since we send the request body regardless, if we get an error
710 HTTPVersion => $1, 874 HTTPVersion => $1,
711 Status => $2, 875 Status => $2,
712 Reason => $3, 876 Reason => $3,
713 ; 877 ;
714 878
715 my $hdr = parse_hdr 879 my $hdr = _parse_hdr
716 or return (%state = (), $cb->(undef, { @pseudo, Status => 599, Reason => "Garbled response headers" })); 880 or return _error %state, $cb, { @pseudo, Status => 599, Reason => "Garbled response headers" };
717 881
718 %hdr = (%$hdr, @pseudo); 882 %hdr = (%$hdr, @pseudo);
719 } 883 }
720 884
721 # redirect handling 885 # redirect handling
751 } elsif ($status == 307) { 915 } elsif ($status == 307) {
752 $redirect = 1; 916 $redirect = 1;
753 } 917 }
754 } 918 }
755 919
756 my $finish = sub { # ($data, $err_status, $err_reason[, $keepalive]) 920 my $finish = sub { # ($data, $err_status, $err_reason[, $persistent])
757 my $may_keep_alive = $_[3]; 921 if ($state{handle}) {
758 922 # handle keepalive
923 if (
924 $persistent
925 && $_[3]
926 && ($hdr{HTTPVersion} < 1.1
927 ? $hdr{connection} =~ /\bkeep-?alive\b/i
928 : $hdr{connection} !~ /\bclose\b/i)
929 ) {
930 ka_store $ka_key, delete $state{handle};
931 } else {
932 # no keepalive, destroy the handle
759 $state{handle}->destroy if $state{handle}; 933 $state{handle}->destroy;
934 }
935 }
936
760 %state = (); 937 %state = ();
761 938
762 if (defined $_[1]) { 939 if (defined $_[1]) {
763 $hdr{OrigStatus} = $hdr{Status}; $hdr{Status} = $_[1]; 940 $hdr{OrigStatus} = $hdr{Status}; $hdr{Status} = $_[1];
764 $hdr{OrigReason} = $hdr{Reason}; $hdr{Reason} = $_[2]; 941 $hdr{OrigReason} = $hdr{Reason}; $hdr{Reason} = $_[2];
771 948
772 if ($redirect && exists $hdr{location}) { 949 if ($redirect && exists $hdr{location}) {
773 # we ignore any errors, as it is very common to receive 950 # we ignore any errors, as it is very common to receive
774 # Content-Length != 0 but no actual body 951 # Content-Length != 0 but no actual body
775 # we also access %hdr, as $_[1] might be an erro 952 # we also access %hdr, as $_[1] might be an erro
953 $state{recurse} =
776 http_request ( 954 http_request (
777 $method => $hdr{location}, 955 $method => $hdr{location},
778 %arg, 956 %arg,
779 recurse => $recurse - 1, 957 recurse => $recurse - 1,
780 Redirect => [$_[0], \%hdr], 958 Redirect => [$_[0], \%hdr],
959 sub {
960 %state = ();
961 &$cb
962 },
781 $cb); 963 );
782 } else { 964 } else {
783 $cb->($_[0], \%hdr); 965 $cb->($_[0], \%hdr);
784 } 966 }
785 }; 967 };
786 968
787 $ae_error = 597; # body phase 969 $ae_error = 597; # body phase
788 970
971 my $chunked = $hdr{"transfer-encoding"} =~ /\bchunked\b/i; # not quite correct...
972
789 my $len = $hdr{"content-length"}; 973 my $len = $chunked ? undef : $hdr{"content-length"};
790 974
791 # body handling, many different code paths 975 # body handling, many different code paths
792 # - no body expected 976 # - no body expected
793 # - want_body_handle 977 # - want_body_handle
794 # - te chunked 978 # - te chunked
809 $_[0]->on_error (undef); 993 $_[0]->on_error (undef);
810 $_[0]->on_read (undef); 994 $_[0]->on_read (undef);
811 995
812 $finish->(delete $state{handle}); 996 $finish->(delete $state{handle});
813 997
814 } elsif ($hdr{"transfer-encoding"} =~ /\bchunked\b/i) { 998 } elsif ($chunked) {
815 my $cl = 0; 999 my $cl = 0;
816 my $body = undef; 1000 my $body = "";
817 my $on_body = $arg{on_body} || sub { $body .= shift; 1 }; 1001 my $on_body = $arg{on_body} || sub { $body .= shift; 1 };
818 1002
819 $state{read_chunk} = sub { 1003 $state{read_chunk} = sub {
820 $_[1] =~ /^([0-9a-fA-F]+)/ 1004 $_[1] =~ /^([0-9a-fA-F]+)/
821 or $finish->(undef, $ae_error => "Garbled chunked transfer encoding"); 1005 or return $finish->(undef, $ae_error => "Garbled chunked transfer encoding");
822 1006
823 my $len = hex $1; 1007 my $len = hex $1;
824 1008
825 if ($len) { 1009 if ($len) {
826 $cl += $len; 1010 $cl += $len;
841 $_[0]->push_read (line => $qr_nlnl, sub { 1025 $_[0]->push_read (line => $qr_nlnl, sub {
842 if (length $_[1]) { 1026 if (length $_[1]) {
843 for ("$_[1]") { 1027 for ("$_[1]") {
844 y/\015//d; # weed out any \015, as they show up in the weirdest of places. 1028 y/\015//d; # weed out any \015, as they show up in the weirdest of places.
845 1029
846 my $hdr = parse_hdr 1030 my $hdr = _parse_hdr
847 or return $finish->(undef, $ae_error => "Garbled response trailers"); 1031 or return $finish->(undef, $ae_error => "Garbled response trailers");
848 1032
849 %hdr = (%hdr, %$hdr); 1033 %hdr = (%hdr, %$hdr);
850 } 1034 }
851 } 1035 }
894 $_[0]->on_read (sub { }); 1078 $_[0]->on_read (sub { });
895 } 1079 }
896 } 1080 }
897 }; 1081 };
898 1082
1083 # if keepalive is enabled, then the server closing the connection
1084 # before a response can happen legally - we retry on idempotent methods.
1085 if ($was_persistent && $idempotent) {
1086 my $old_eof = $hdl->{on_eof};
1087 $hdl->{on_eof} = sub {
1088 _destroy_state %state;
1089
1090 %state = ();
1091 $state{recurse} =
1092 http_request (
1093 $method => $url,
1094 %arg,
1095 recurse => $recurse - 1,
1096 keepalive => 0,
1097 sub {
1098 %state = ();
1099 &$cb
1100 }
1101 );
1102 };
1103 $hdl->on_read (sub {
1104 return unless %state;
1105
1106 # as soon as we receive something, a connection close
1107 # once more becomes a hard error
1108 $hdl->{on_eof} = $old_eof;
1109 $hdl->push_read (line => $qr_nlnl, $state{read_response});
1110 });
1111 } else {
899 $state{handle}->push_read (line => $qr_nlnl, $state{read_response}); 1112 $hdl->push_read (line => $qr_nlnl, $state{read_response});
1113 }
900 }; 1114 };
901 1115
1116 my $prepare_handle = sub {
1117 my ($hdl) = $state{handle};
1118
1119 $hdl->on_error (sub {
1120 _error %state, $cb, { @pseudo, Status => $ae_error, Reason => $_[2] };
1121 });
1122 $hdl->on_eof (sub {
1123 _error %state, $cb, { @pseudo, Status => $ae_error, Reason => "Unexpected end-of-file" };
1124 });
1125 $hdl->timeout_reset;
1126 $hdl->timeout ($timeout);
1127 };
1128
1129 # connected to proxy (or origin server)
902 my $connect_cb = sub { 1130 my $connect_cb = sub {
903 $state{fh} = shift 1131 my $fh = shift
904 or do {
905 my $err = "$!";
906 %state = ();
907 return $cb->(undef, { @pseudo, Status => $ae_error, Reason => $err }); 1132 or return _error %state, $cb, { @pseudo, Status => $ae_error, Reason => "$!" };
908 };
909 1133
910 return unless delete $state{connect_guard}; 1134 return unless delete $state{connect_guard};
911 1135
912 # get handle 1136 # get handle
913 $state{handle} = new AnyEvent::Handle 1137 $state{handle} = new AnyEvent::Handle
1138 %{ $arg{handle_params} },
914 fh => $state{fh}, 1139 fh => $fh,
915 peername => $rhost, 1140 peername => $uhost,
916 tls_ctx => $arg{tls_ctx}, 1141 tls_ctx => $arg{tls_ctx},
917 # these need to be reconfigured on keepalive handles
918 timeout => $timeout,
919 on_error => sub {
920 %state = ();
921 $cb->(undef, { @pseudo, Status => $ae_error, Reason => $_[2] });
922 },
923 on_eof => sub {
924 %state = ();
925 $cb->(undef, { @pseudo, Status => $ae_error, Reason => "Unexpected end-of-file" });
926 },
927 ; 1142 ;
928 1143
929 # limit the number of persistent connections 1144 $prepare_handle->();
930 # keepalive not yet supported
931# if ($KA_COUNT{$_[1]} < $MAX_PERSISTENT_PER_HOST) {
932# ++$KA_COUNT{$_[1]};
933# $state{handle}{ka_count_guard} = AnyEvent::Util::guard {
934# --$KA_COUNT{$_[1]}
935# };
936# $hdr{connection} = "keep-alive";
937# }
938 1145
939 $state{handle}->starttls ("connect") if $rscheme eq "https"; 1146 #$state{handle}->starttls ("connect") if $rscheme eq "https";
940 1147
941 # now handle proxy-CONNECT method 1148 # now handle proxy-CONNECT method
942 if ($proxy && $uscheme eq "https") { 1149 if ($proxy && $uscheme eq "https") {
943 # oh dear, we have to wrap it into a connect request 1150 # oh dear, we have to wrap it into a connect request
944 1151
945 # maybe re-use $uauthority with patched port? 1152 # maybe re-use $uauthority with patched port?
946 $state{handle}->push_write ("CONNECT $uhost:$uport HTTP/1.0\015\012\015\012"); 1153 $state{handle}->push_write ("CONNECT $uhost:$uport HTTP/1.0\015\012\015\012");
947 $state{handle}->push_read (line => $qr_nlnl, sub { 1154 $state{handle}->push_read (line => $qr_nlnl, sub {
948 $_[1] =~ /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\015\012]*) )?/ix 1155 $_[1] =~ /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\015\012]*) )?/ix
949 or return (%state = (), $cb->(undef, { @pseudo, Status => 599, Reason => "Invalid proxy connect response ($_[1])" })); 1156 or return _error %state, $cb, { @pseudo, Status => 599, Reason => "Invalid proxy connect response ($_[1])" };
950 1157
951 if ($2 == 200) { 1158 if ($2 == 200) {
952 $rpath = $upath; 1159 $rpath = $upath;
953 $handle_actual_request->(); 1160 $handle_actual_request->();
954 } else { 1161 } else {
955 %state = ();
956 $cb->(undef, { @pseudo, Status => $2, Reason => $3 }); 1162 _error %state, $cb, { @pseudo, Status => $2, Reason => $3 };
957 } 1163 }
958 }); 1164 });
959 } else { 1165 } else {
960 $handle_actual_request->(); 1166 $handle_actual_request->();
961 } 1167 }
964 _get_slot $uhost, sub { 1170 _get_slot $uhost, sub {
965 $state{slot_guard} = shift; 1171 $state{slot_guard} = shift;
966 1172
967 return unless $state{connect_guard}; 1173 return unless $state{connect_guard};
968 1174
1175 # try to use an existing keepalive connection, but only if we, ourselves, plan
1176 # on a keepalive request (in theory, this should be a separate config option).
1177 if ($persistent && $KA_CACHE{$ka_key}) {
1178 $was_persistent = 1;
1179
1180 $state{handle} = ka_fetch $ka_key;
1181 $state{handle}->destroyed
1182 and die "AnyEvent::HTTP: unexpectedly got a destructed handle (1), please report.";#d#
1183 $prepare_handle->();
1184 $state{handle}->destroyed
1185 and die "AnyEvent::HTTP: unexpectedly got a destructed handle (2), please report.";#d#
1186 $handle_actual_request->();
1187
1188 } else {
969 my $tcp_connect = $arg{tcp_connect} 1189 my $tcp_connect = $arg{tcp_connect}
970 || do { require AnyEvent::Socket; \&AnyEvent::Socket::tcp_connect }; 1190 || do { require AnyEvent::Socket; \&AnyEvent::Socket::tcp_connect };
971 1191
972 $state{connect_guard} = $tcp_connect->($rhost, $rport, $connect_cb, $arg{on_prepare} || sub { $timeout }); 1192 $state{connect_guard} = $tcp_connect->($rhost, $rport, $connect_cb, $arg{on_prepare} || sub { $timeout });
1193 }
973 }; 1194 };
974 1195
975 defined wantarray && AnyEvent::Util::guard { %state = () } 1196 defined wantarray && AnyEvent::Util::guard { _destroy_state %state }
976} 1197}
977 1198
978sub http_get($@) { 1199sub http_get($@) {
979 unshift @_, "GET"; 1200 unshift @_, "GET";
980 &http_request 1201 &http_request
998AnyEvent::HTTP uses the AnyEvent::Socket::tcp_connect function for 1219AnyEvent::HTTP uses the AnyEvent::Socket::tcp_connect function for
999the actual connection, which in turn uses AnyEvent::DNS to resolve 1220the actual connection, which in turn uses AnyEvent::DNS to resolve
1000hostnames. The latter is a simple stub resolver and does no caching 1221hostnames. The latter is a simple stub resolver and does no caching
1001on its own. If you want DNS caching, you currently have to provide 1222on its own. If you want DNS caching, you currently have to provide
1002your own default resolver (by storing a suitable resolver object in 1223your own default resolver (by storing a suitable resolver object in
1003C<$AnyEvent::DNS::RESOLVER>). 1224C<$AnyEvent::DNS::RESOLVER>) or your own C<tcp_connect> callback.
1004 1225
1005=head2 GLOBAL FUNCTIONS AND VARIABLES 1226=head2 GLOBAL FUNCTIONS AND VARIABLES
1006 1227
1007=over 4 1228=over 4
1008 1229
1009=item AnyEvent::HTTP::set_proxy "proxy-url" 1230=item AnyEvent::HTTP::set_proxy "proxy-url"
1010 1231
1011Sets the default proxy server to use. The proxy-url must begin with a 1232Sets the default proxy server to use. The proxy-url must begin with a
1012string of the form C<http://host:port> (optionally C<https:...>), croaks 1233string of the form C<http://host:port>, croaks otherwise.
1013otherwise.
1014 1234
1015To clear an already-set proxy, use C<undef>. 1235To clear an already-set proxy, use C<undef>.
1236
1237When AnyEvent::HTTP is loaded for the first time it will query the
1238default proxy from the operating system, currently by looking at
1239C<$ENV{http_proxy>}.
1016 1240
1017=item AnyEvent::HTTP::cookie_jar_expire $jar[, $session_end] 1241=item AnyEvent::HTTP::cookie_jar_expire $jar[, $session_end]
1018 1242
1019Remove all cookies from the cookie jar that have been expired. If 1243Remove all cookies from the cookie jar that have been expired. If
1020C<$session_end> is given and true, then additionally remove all session 1244C<$session_end> is given and true, then additionally remove all session
1021cookies. 1245cookies.
1022 1246
1023You should call this function (with a true C<$session_end>) before you 1247You should call this function (with a true C<$session_end>) before you
1024save cookies to disk, and you should call this function after loading them 1248save cookies to disk, and you should call this function after loading them
1025again. If you have a long-running program you can additonally call this 1249again. If you have a long-running program you can additionally call this
1026function from time to time. 1250function from time to time.
1027 1251
1028A cookie jar is initially an empty hash-reference that is managed by this 1252A cookie jar is initially an empty hash-reference that is managed by this
1029module. It's format is subject to change, but currently it is like this: 1253module. It's format is subject to change, but currently it is like this:
1030 1254
1031The key C<version> has to contain C<1>, otherwise the hash gets 1255The key C<version> has to contain C<1>, otherwise the hash gets
1032emptied. All other keys are hostnames or IP addresses pointing to 1256emptied. All other keys are hostnames or IP addresses pointing to
1033hash-references. The key for these inner hash references is the 1257hash-references. The key for these inner hash references is the
1034server path for which this cookie is meant, and the values are again 1258server path for which this cookie is meant, and the values are again
1035hash-references. The keys of those hash-references is the cookie name, and 1259hash-references. Each key of those hash-references is a cookie name, and
1036the value, you guessed it, is another hash-reference, this time with the 1260the value, you guessed it, is another hash-reference, this time with the
1037key-value pairs from the cookie, except for C<expires> and C<max-age>, 1261key-value pairs from the cookie, except for C<expires> and C<max-age>,
1038which have been replaced by a C<_expires> key that contains the cookie 1262which have been replaced by a C<_expires> key that contains the cookie
1039expiry timestamp. 1263expiry timestamp. Session cookies are indicated by not having an
1264C<_expires> key.
1040 1265
1041Here is an example of a cookie jar with a single cookie, so you have a 1266Here is an example of a cookie jar with a single cookie, so you have a
1042chance of understanding the above paragraph: 1267chance of understanding the above paragraph:
1043 1268
1044 { 1269 {
1066 1291
1067=item $AnyEvent::HTTP::MAX_RECURSE 1292=item $AnyEvent::HTTP::MAX_RECURSE
1068 1293
1069The default value for the C<recurse> request parameter (default: C<10>). 1294The default value for the C<recurse> request parameter (default: C<10>).
1070 1295
1296=item $AnyEvent::HTTP::TIMEOUT
1297
1298The default timeout for connection operations (default: C<300>).
1299
1071=item $AnyEvent::HTTP::USERAGENT 1300=item $AnyEvent::HTTP::USERAGENT
1072 1301
1073The default value for the C<User-Agent> header (the default is 1302The default value for the C<User-Agent> header (the default is
1074C<Mozilla/5.0 (compatible; U; AnyEvent-HTTP/$VERSION; +http://software.schmorp.de/pkg/AnyEvent)>). 1303C<Mozilla/5.0 (compatible; U; AnyEvent-HTTP/$VERSION; +http://software.schmorp.de/pkg/AnyEvent)>).
1075 1304
1076=item $AnyEvent::HTTP::MAX_PER_HOST 1305=item $AnyEvent::HTTP::MAX_PER_HOST
1077 1306
1078The maximum number of concurrent connections to the same host (identified 1307The maximum number of concurrent connections to the same host (identified
1079by the hostname). If the limit is exceeded, then the additional requests 1308by the hostname). If the limit is exceeded, then the additional requests
1080are queued until previous connections are closed. 1309are queued until previous connections are closed. Both persistent and
1310non-persistent connections are counted in this limit.
1081 1311
1082The default value for this is C<4>, and it is highly advisable to not 1312The default value for this is C<4>, and it is highly advisable to not
1083increase it. 1313increase it much.
1314
1315For comparison: the RFC's recommend 4 non-persistent or 2 persistent
1316connections, older browsers used 2, newer ones (such as firefox 3)
1317typically use 6, and Opera uses 8 because like, they have the fastest
1318browser and give a shit for everybody else on the planet.
1319
1320=item $AnyEvent::HTTP::PERSISTENT_TIMEOUT
1321
1322The time after which idle persistent connections get closed by
1323AnyEvent::HTTP (default: C<3>).
1084 1324
1085=item $AnyEvent::HTTP::ACTIVE 1325=item $AnyEvent::HTTP::ACTIVE
1086 1326
1087The number of active connections. This is not the number of currently 1327The number of active connections. This is not the number of currently
1088running requests, but the number of currently open and non-idle TCP 1328running requests, but the number of currently open and non-idle TCP
1089connections. This number of can be useful for load-leveling. 1329connections. This number can be useful for load-leveling.
1090 1330
1091=back 1331=back
1092 1332
1093=cut 1333=cut
1094 1334
1128 # other formats fail in the loop below 1368 # other formats fail in the loop below
1129 1369
1130 for (0..11) { 1370 for (0..11) {
1131 if ($m eq $month[$_]) { 1371 if ($m eq $month[$_]) {
1132 require Time::Local; 1372 require Time::Local;
1133 return Time::Local::timegm ($S, $M, $H, $d, $_, $y); 1373 return eval { Time::Local::timegm ($S, $M, $H, $d, $_, $y) };
1134 } 1374 }
1135 } 1375 }
1136 1376
1137 undef 1377 undef
1138} 1378}
1139 1379
1140sub set_proxy($) { 1380sub set_proxy($) {
1141 if (length $_[0]) { 1381 if (length $_[0]) {
1142 $_[0] =~ m%^(https?):// ([^:/]+) (?: : (\d*) )?%ix 1382 $_[0] =~ m%^(http):// ([^:/]+) (?: : (\d*) )?%ix
1143 or Carp::croak "$_[0]: invalid proxy URL"; 1383 or Carp::croak "$_[0]: invalid proxy URL";
1144 $PROXY = [$2, $3 || 3128, $1] 1384 $PROXY = [$2, $3 || 3128, $1]
1145 } else { 1385 } else {
1146 undef $PROXY; 1386 undef $PROXY;
1147 } 1387 }
1150# initialise proxy from environment 1390# initialise proxy from environment
1151eval { 1391eval {
1152 set_proxy $ENV{http_proxy}; 1392 set_proxy $ENV{http_proxy};
1153}; 1393};
1154 1394
1395=head2 SHOWCASE
1396
1397This section contains some more elaborate "real-world" examples or code
1398snippets.
1399
1400=head2 HTTP/1.1 FILE DOWNLOAD
1401
1402Downloading files with HTTP can be quite tricky, especially when something
1403goes wrong and you want to resume.
1404
1405Here is a function that initiates and resumes a download. It uses the
1406last modified time to check for file content changes, and works with many
1407HTTP/1.0 servers as well, and usually falls back to a complete re-download
1408on older servers.
1409
1410It calls the completion callback with either C<undef>, which means a
1411nonretryable error occurred, C<0> when the download was partial and should
1412be retried, and C<1> if it was successful.
1413
1414 use AnyEvent::HTTP;
1415
1416 sub download($$$) {
1417 my ($url, $file, $cb) = @_;
1418
1419 open my $fh, "+<", $file
1420 or die "$file: $!";
1421
1422 my %hdr;
1423 my $ofs = 0;
1424
1425 warn stat $fh;
1426 warn -s _;
1427 if (stat $fh and -s _) {
1428 $ofs = -s _;
1429 warn "-s is ", $ofs;
1430 $hdr{"if-unmodified-since"} = AnyEvent::HTTP::format_date +(stat _)[9];
1431 $hdr{"range"} = "bytes=$ofs-";
1432 }
1433
1434 http_get $url,
1435 headers => \%hdr,
1436 on_header => sub {
1437 my ($hdr) = @_;
1438
1439 if ($hdr->{Status} == 200 && $ofs) {
1440 # resume failed
1441 truncate $fh, $ofs = 0;
1442 }
1443
1444 sysseek $fh, $ofs, 0;
1445
1446 1
1447 },
1448 on_body => sub {
1449 my ($data, $hdr) = @_;
1450
1451 if ($hdr->{Status} =~ /^2/) {
1452 length $data == syswrite $fh, $data
1453 or return; # abort on write errors
1454 }
1455
1456 1
1457 },
1458 sub {
1459 my (undef, $hdr) = @_;
1460
1461 my $status = $hdr->{Status};
1462
1463 if (my $time = AnyEvent::HTTP::parse_date $hdr->{"last-modified"}) {
1464 utime $fh, $time, $time;
1465 }
1466
1467 if ($status == 200 || $status == 206 || $status == 416) {
1468 # download ok || resume ok || file already fully downloaded
1469 $cb->(1, $hdr);
1470
1471 } elsif ($status == 412) {
1472 # file has changed while resuming, delete and retry
1473 unlink $file;
1474 $cb->(0, $hdr);
1475
1476 } elsif ($status == 500 or $status == 503 or $status =~ /^59/) {
1477 # retry later
1478 $cb->(0, $hdr);
1479
1480 } else {
1481 $cb->(undef, $hdr);
1482 }
1483 }
1484 ;
1485 }
1486
1487 download "http://server/somelargefile", "/tmp/somelargefile", sub {
1488 if ($_[0]) {
1489 print "OK!\n";
1490 } elsif (defined $_[0]) {
1491 print "please retry later\n";
1492 } else {
1493 print "ERROR\n";
1494 }
1495 };
1496
1155=head2 SOCKS PROXIES 1497=head3 SOCKS PROXIES
1156 1498
1157Socks proxies are not directly supported by AnyEvent::HTTP. You can 1499Socks proxies are not directly supported by AnyEvent::HTTP. You can
1158compile your perl to support socks, or use an external program such as 1500compile your perl to support socks, or use an external program such as
1159F<socksify> (dante) or F<tsocks> to make your program use a socks proxy 1501F<socksify> (dante) or F<tsocks> to make your program use a socks proxy
1160transparently. 1502transparently.

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines