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.91 by root, Mon Jan 3 01:03:29 2011 UTC vs.
Revision 1.125 by root, Thu May 14 02:04:35 2015 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.22;
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.
161
162Only redirects to http and https URLs are supported. While most common
163redirection forms are handled entirely within this module, some require
164the use of the optional L<URI> module. If it is required but missing, then
165the request will fail with an error.
165 166
166=item headers => hashref 167=item headers => hashref
167 168
168The request headers to use. Currently, C<http_request> may provide its own 169The request headers to use. Currently, C<http_request> may provide its own
169C<Host:>, C<Content-Length:>, C<Connection:> and C<Cookie:> headers and 170C<Host:>, C<Content-Length:>, C<Connection:> and C<Cookie:> headers and
173 174
174You really should provide your own C<User-Agent:> header value that is 175You really should provide your own C<User-Agent:> header value that is
175appropriate for your program - I wouldn't be surprised if the default 176appropriate for your program - I wouldn't be surprised if the default
176AnyEvent string gets blocked by webservers sooner or later. 177AnyEvent string gets blocked by webservers sooner or later.
177 178
179Also, make sure that your headers names and values do not contain any
180embedded newlines.
181
178=item timeout => $seconds 182=item timeout => $seconds
179 183
180The time-out to use for various stages - each connect attempt will reset 184The 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 185the timeout, as will read or write activity, i.e. this is not an overall
182timeout. 186timeout.
183 187
184Default timeout is 5 minutes. 188Default timeout is 5 minutes.
185 189
186=item proxy => [$host, $port[, $scheme]] or undef 190=item proxy => [$host, $port[, $scheme]] or undef
187 191
188Use the given http proxy for all requests. If not specified, then the 192Use 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. 193used.
190 194
191C<$scheme> must be either missing, C<http> for HTTP or C<https> for 195C<$scheme> must be either missing or must be C<http> for HTTP.
192HTTPS. 196
197If not specified, then the default proxy is used (see
198C<AnyEvent::HTTP::set_proxy>).
199
200Currently, if your proxy requires authorization, you have to specify an
201appropriate "Proxy-Authorization" header in every request.
193 202
194=item body => $string 203=item body => $string
195 204
196The request body, usually empty. Will be sent as-is (future versions of 205The request body, usually empty. Will be sent as-is (future versions of
197this module might offer more options). 206this module might offer more options).
228verification) TLS context. 237verification) TLS context.
229 238
230The default for this option is C<low>, which could be interpreted as "give 239The default for this option is C<low>, which could be interpreted as "give
231me the page, no matter what". 240me the page, no matter what".
232 241
242See also the C<sessionid> parameter.
243
244=item session => $string
245
246The module might reuse connections to the same host internally. Sometimes
247(e.g. when using TLS), you do not want to reuse connections from other
248sessions. This can be achieved by setting this parameter to some unique
249ID (such as the address of an object storing your state data, or the TLS
250context) - only connections using the same unique ID will be reused.
251
233=item on_prepare => $callback->($fh) 252=item on_prepare => $callback->($fh)
234 253
235In rare cases you need to "tune" the socket before it is used to 254In 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 255connect (for example, to bind it on a given IP address). This parameter
237overrides the prepare callback passed to C<AnyEvent::Socket::tcp_connect> 256overrides the prepare callback passed to C<AnyEvent::Socket::tcp_connect>
238and behaves exactly the same way (e.g. it has to provide a 257and behaves exactly the same way (e.g. it has to provide a
239timeout). See the description for the C<$prepare_cb> argument of 258timeout). See the description for the C<$prepare_cb> argument of
240C<AnyEvent::Socket::tcp_connect> for details. 259C<AnyEvent::Socket::tcp_connect> for details.
241 260
306called. Instead of the C<$body> argument containing the body data, the 325called. Instead of the C<$body> argument containing the body data, the
307callback will receive the L<AnyEvent::Handle> object associated with the 326callback will receive the L<AnyEvent::Handle> object associated with the
308connection. In error cases, C<undef> will be passed. When there is no body 327connection. 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. 328(e.g. status C<304>), the empty string will be passed.
310 329
311The handle object might or might not be in TLS mode, might be connected to 330The handle object might or might not be in TLS mode, might be connected
312a proxy, be a persistent connection etc., and configured in unspecified 331to 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 332etc., and configured in unspecified ways. The user is responsible for this
314module anymore). 333handle (it will not be used by this module anymore).
315 334
316This is useful with some push-type services, where, after the initial 335This is useful with some push-type services, where, after the initial
317headers, an interactive protocol is used (typical example would be the 336headers, an interactive protocol is used (typical example would be the
318push-style twitter API which starts a JSON/XML stream). 337push-style twitter API which starts a JSON/XML stream).
319 338
320If you think you need this, first have a look at C<on_body>, to see if 339If 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. 340that doesn't solve your problem in a better way.
341
342=item persistent => $boolean
343
344Try to create/reuse a persistent connection. When this flag is set
345(default: true for idempotent requests, false for all others), then
346C<http_request> tries to re-use an existing (previously-created)
347persistent connection to the host and, failing that, tries to create a new
348one.
349
350Requests failing in certain ways will be automatically retried once, which
351is dangerous for non-idempotent requests, which is why it defaults to off
352for them. The reason for this is because the bozos who designed HTTP/1.1
353made it impossible to distinguish between a fatal error and a normal
354connection timeout, so you never know whether there was a problem with
355your request or not.
356
357When reusing an existent connection, many parameters (such as TLS context)
358will be ignored. See the C<session> parameter for a workaround.
359
360=item keepalive => $boolean
361
362Only used when C<persistent> is also true. This parameter decides whether
363C<http_request> tries to handshake a HTTP/1.0-style keep-alive connection
364(as opposed to only a HTTP/1.1 persistent connection).
365
366The default is true, except when using a proxy, in which case it defaults
367to false, as HTTP/1.0 proxies cannot support this in a meaningful way.
368
369=item handle_params => { key => value ... }
370
371The key-value pairs in this hash will be passed to any L<AnyEvent::Handle>
372constructor that is called - not all requests will create a handle, and
373sometimes more than one is created, so this parameter is only good for
374setting hints.
375
376Example: set the maximum read size to 4096, to potentially conserve memory
377at the cost of speed.
378
379 handle_params => {
380 max_read_size => 4096,
381 },
322 382
323=back 383=back
324 384
325Example: do a simple HTTP GET request for http://www.nethype.de/ and print 385Example: do a simple HTTP GET request for http://www.nethype.de/ and print
326the response body. 386the response body.
332 392
333Example: do a HTTP HEAD request on https://www.google.com/, use a 393Example: do a HTTP HEAD request on https://www.google.com/, use a
334timeout of 30 seconds. 394timeout of 30 seconds.
335 395
336 http_request 396 http_request
337 GET => "https://www.google.com", 397 HEAD => "https://www.google.com",
338 headers => { "user-agent" => "MySearchClient 1.0" }, 398 headers => { "user-agent" => "MySearchClient 1.0" },
339 timeout => 30, 399 timeout => 30,
340 sub { 400 sub {
341 my ($body, $hdr) = @_; 401 my ($body, $hdr) = @_;
342 use Data::Dumper; 402 use Data::Dumper;
353 }; 413 };
354 414
355 undef $request; 415 undef $request;
356 416
357=cut 417=cut
418
419#############################################################################
420# wait queue/slots
358 421
359sub _slot_schedule; 422sub _slot_schedule;
360sub _slot_schedule($) { 423sub _slot_schedule($) {
361 my $host = shift; 424 my $host = shift;
362 425
385 448
386 _slot_schedule $_[0]; 449 _slot_schedule $_[0];
387} 450}
388 451
389############################################################################# 452#############################################################################
453# cookie handling
390 454
391# expire cookies 455# expire cookies
392sub cookie_jar_expire($;$) { 456sub cookie_jar_expire($;$) {
393 my ($jar, $session_end) = @_; 457 my ($jar, $session_end) = @_;
394 458
418 } 482 }
419} 483}
420 484
421# extract cookies from jar 485# extract cookies from jar
422sub cookie_jar_extract($$$$) { 486sub cookie_jar_extract($$$$) {
423 my ($jar, $uscheme, $uhost, $upath) = @_; 487 my ($jar, $scheme, $host, $path) = @_;
424 488
425 %$jar = () if $jar->{version} != 1; 489 %$jar = () if $jar->{version} != 1;
426 490
427 my @cookies; 491 my @cookies;
428 492
429 while (my ($chost, $paths) = each %$jar) { 493 while (my ($chost, $paths) = each %$jar) {
430 next unless ref $paths; 494 next unless ref $paths;
431 495
432 if ($chost =~ /^\./) { 496 if ($chost =~ /^\./) {
433 next unless $chost eq substr $uhost, -length $chost; 497 next unless $chost eq substr $host, -length $chost;
434 } elsif ($chost =~ /\./) { 498 } elsif ($chost =~ /\./) {
435 next unless $chost eq $uhost; 499 next unless $chost eq $host;
436 } else { 500 } else {
437 next; 501 next;
438 } 502 }
439 503
440 while (my ($cpath, $cookies) = each %$paths) { 504 while (my ($cpath, $cookies) = each %$paths) {
441 next unless $cpath eq substr $upath, 0, length $cpath; 505 next unless $cpath eq substr $path, 0, length $cpath;
442 506
443 while (my ($cookie, $kv) = each %$cookies) { 507 while (my ($cookie, $kv) = each %$cookies) {
444 next if $uscheme ne "https" && exists $kv->{secure}; 508 next if $scheme ne "https" && exists $kv->{secure};
445 509
446 if (exists $kv->{_expires} and AE::now > $kv->{_expires}) { 510 if (exists $kv->{_expires} and AE::now > $kv->{_expires}) {
447 delete $cookies->{$cookie}; 511 delete $cookies->{$cookie};
448 next; 512 next;
449 } 513 }
463 \@cookies 527 \@cookies
464} 528}
465 529
466# parse set_cookie header into jar 530# parse set_cookie header into jar
467sub cookie_jar_set_cookie($$$$) { 531sub cookie_jar_set_cookie($$$$) {
468 my ($jar, $set_cookie, $uhost, $date) = @_; 532 my ($jar, $set_cookie, $host, $date) = @_;
469 533
470 my $anow = int AE::now; 534 my $anow = int AE::now;
471 my $snow; # server-now 535 my $snow; # server-now
472 536
473 for ($set_cookie) { 537 for ($set_cookie) {
479 while ( 543 while (
480 m{ 544 m{
481 \G\s* 545 \G\s*
482 (?: 546 (?:
483 expires \s*=\s* ([A-Z][a-z][a-z]+,\ [^,;]+) 547 expires \s*=\s* ([A-Z][a-z][a-z]+,\ [^,;]+)
484 | ([^=;,[:space:]]+) (?: \s*=\s* (?: "((?:[^\\"]+|\\.)*)" | ([^=;,[:space:]]*) ) )? 548 | ([^=;,[:space:]]+) (?: \s*=\s* (?: "((?:[^\\"]+|\\.)*)" | ([^;,[:space:]]*) ) )?
485 ) 549 )
486 }gcxsi 550 }gcxsi
487 ) { 551 ) {
488 my $name = $2; 552 my $name = $2;
489 my $value = $4; 553 my $value = $4;
496 # quoted 560 # quoted
497 $value = $3; 561 $value = $3;
498 $value =~ s/\\(.)/$1/gs; 562 $value =~ s/\\(.)/$1/gs;
499 } 563 }
500 564
501 push @kv, lc $name, $value; 565 push @kv, @kv ? lc $name : $name, $value;
502 566
503 last unless /\G\s*;/gc; 567 last unless /\G\s*;/gc;
504 } 568 }
505 569
506 last unless @kv; 570 last unless @kv;
529 593
530 # this is not rfc-like and not netscape-like. go figure. 594 # this is not rfc-like and not netscape-like. go figure.
531 my $ndots = $cdom =~ y/.//; 595 my $ndots = $cdom =~ y/.//;
532 next if $ndots < ($cdom =~ /\.[^.][^.]\.[^.][^.]$/ ? 3 : 2); 596 next if $ndots < ($cdom =~ /\.[^.][^.]\.[^.][^.]$/ ? 3 : 2);
533 } else { 597 } else {
534 $cdom = $uhost; 598 $cdom = $host;
535 } 599 }
536 600
537 # store it 601 # store it
538 $jar->{version} = 1; 602 $jar->{version} = 1;
539 $jar->{lc $cdom}{$cpath}{$name} = \%kv; 603 $jar->{lc $cdom}{$cpath}{$name} = \%kv;
540 604
541 redo if /\G\s*,/gc; 605 redo if /\G\s*,/gc;
542 } 606 }
543} 607}
544 608
609#############################################################################
610# keepalive/persistent connection cache
611
612# fetch a connection from the keepalive cache
613sub ka_fetch($) {
614 my $ka_key = shift;
615
616 my $hdl = pop @{ $KA_CACHE{$ka_key} }; # currently we reuse the MOST RECENTLY USED connection
617 delete $KA_CACHE{$ka_key}
618 unless @{ $KA_CACHE{$ka_key} };
619
620 $hdl
621}
622
623sub ka_store($$) {
624 my ($ka_key, $hdl) = @_;
625
626 my $kaa = $KA_CACHE{$ka_key} ||= [];
627
628 my $destroy = sub {
629 my @ka = grep $_ != $hdl, @{ $KA_CACHE{$ka_key} };
630
631 $hdl->destroy;
632
633 @ka
634 ? $KA_CACHE{$ka_key} = \@ka
635 : delete $KA_CACHE{$ka_key};
636 };
637
638 # on error etc., destroy
639 $hdl->on_error ($destroy);
640 $hdl->on_eof ($destroy);
641 $hdl->on_read ($destroy);
642 $hdl->timeout ($PERSISTENT_TIMEOUT);
643
644 push @$kaa, $hdl;
645 shift @$kaa while @$kaa > $MAX_PER_HOST;
646}
647
648#############################################################################
649# utilities
650
545# continue to parse $_ for headers and place them into the arg 651# continue to parse $_ for headers and place them into the arg
546sub parse_hdr() { 652sub _parse_hdr() {
547 my %hdr; 653 my %hdr;
548 654
549 # things seen, not parsed: 655 # things seen, not parsed:
550 # p3pP="NON CUR OTPi OUR NOR UNI" 656 # p3pP="NON CUR OTPi OUR NOR UNI"
551 657
565 for values %hdr; 671 for values %hdr;
566 672
567 \%hdr 673 \%hdr
568} 674}
569 675
676#############################################################################
677# http_get
678
570our $qr_nlnl = qr{(?<![^\012])\015?\012}; 679our $qr_nlnl = qr{(?<![^\012])\015?\012};
571 680
572our $TLS_CTX_LOW = { cache => 1, sslv2 => 1 }; 681our $TLS_CTX_LOW = { cache => 1, sslv2 => 1 };
573our $TLS_CTX_HIGH = { cache => 1, verify => 1, verify_peername => "https" }; 682our $TLS_CTX_HIGH = { cache => 1, verify => 1, verify_peername => "https" };
683
684# maybe it should just become a normal object :/
685
686sub _destroy_state(\%) {
687 my ($state) = @_;
688
689 $state->{handle}->destroy if $state->{handle};
690 %$state = ();
691}
692
693sub _error(\%$$) {
694 my ($state, $cb, $hdr) = @_;
695
696 &_destroy_state ($state);
697
698 $cb->(undef, $hdr);
699 ()
700}
701
702our %IDEMPOTENT = (
703 DELETE => 1,
704 GET => 1,
705 HEAD => 1,
706 OPTIONS => 1,
707 PUT => 1,
708 TRACE => 1,
709
710 ACL => 1,
711 "BASELINE-CONTROL" => 1,
712 BIND => 1,
713 CHECKIN => 1,
714 CHECKOUT => 1,
715 COPY => 1,
716 LABEL => 1,
717 LINK => 1,
718 MERGE => 1,
719 MKACTIVITY => 1,
720 MKCALENDAR => 1,
721 MKCOL => 1,
722 MKREDIRECTREF => 1,
723 MKWORKSPACE => 1,
724 MOVE => 1,
725 ORDERPATCH => 1,
726 PROPFIND => 1,
727 PROPPATCH => 1,
728 REBIND => 1,
729 REPORT => 1,
730 SEARCH => 1,
731 UNBIND => 1,
732 UNCHECKOUT => 1,
733 UNLINK => 1,
734 UNLOCK => 1,
735 UPDATE => 1,
736 UPDATEREDIRECTREF => 1,
737 "VERSION-CONTROL" => 1,
738);
574 739
575sub http_request($$@) { 740sub http_request($$@) {
576 my $cb = pop; 741 my $cb = pop;
577 my ($method, $url, %arg) = @_; 742 my ($method, $url, %arg) = @_;
578 743
596 my $recurse = exists $arg{recurse} ? delete $arg{recurse} : $MAX_RECURSE; 761 my $recurse = exists $arg{recurse} ? delete $arg{recurse} : $MAX_RECURSE;
597 762
598 return $cb->(undef, { @pseudo, Status => 599, Reason => "Too many redirections" }) 763 return $cb->(undef, { @pseudo, Status => 599, Reason => "Too many redirections" })
599 if $recurse < 0; 764 if $recurse < 0;
600 765
601 my $proxy = $arg{proxy} || $PROXY; 766 my $proxy = exists $arg{proxy} ? $arg{proxy} : $PROXY;
602 my $timeout = $arg{timeout} || $TIMEOUT; 767 my $timeout = $arg{timeout} || $TIMEOUT;
603 768
604 my ($uscheme, $uauthority, $upath, $query, $fragment) = 769 my ($uscheme, $uauthority, $upath, $query, undef) = # ignore fragment
605 $url =~ m|(?:([^:/?#]+):)?(?://([^/?#]*))?([^?#]*)(?:(\?[^#]*))?(?:#(.*))?|; 770 $url =~ m|^([^:]+):(?://([^/?#]*))?([^?#]*)(?:(\?[^#]*))?(?:#(.*))?$|;
606 771
607 $uscheme = lc $uscheme; 772 $uscheme = lc $uscheme;
608 773
609 my $uport = $uscheme eq "http" ? 80 774 my $uport = $uscheme eq "http" ? 80
610 : $uscheme eq "https" ? 443 775 : $uscheme eq "https" ? 443
611 : return $cb->(undef, { @pseudo, Status => 599, Reason => "Only http and https URL schemes supported" }); 776 : return $cb->(undef, { @pseudo, Status => 599, Reason => "Only http and https URL schemes supported" });
612 777
613 $uauthority =~ /^(?: .*\@ )? ([^\@:]+) (?: : (\d+) )?$/x 778 $uauthority =~ /^(?: .*\@ )? ([^\@]+?) (?: : (\d+) )?$/x
614 or return $cb->(undef, { @pseudo, Status => 599, Reason => "Unparsable URL" }); 779 or return $cb->(undef, { @pseudo, Status => 599, Reason => "Unparsable URL" });
615 780
616 my $uhost = lc $1; 781 my $uhost = lc $1;
617 $uport = $2 if defined $2; 782 $uport = $2 if defined $2;
618 783
654 $hdr{"user-agent"} = $USERAGENT unless exists $hdr{"user-agent"}; 819 $hdr{"user-agent"} = $USERAGENT unless exists $hdr{"user-agent"};
655 820
656 $hdr{"content-length"} = length $arg{body} 821 $hdr{"content-length"} = length $arg{body}
657 if length $arg{body} || $method ne "GET"; 822 if length $arg{body} || $method ne "GET";
658 823
659 my $idempotent = $method =~ /^(?:GET|HEAD|PUT|DELETE|OPTIONS|TRACE)$/; 824 my $idempotent = $IDEMPOTENT{$method};
660 825
661 # default value for keepalive is true iff the request is for an idempotent method 826 # default value for keepalive is true iff the request is for an idempotent method
662 my $keepalive = exists $arg{keepalive} 827 my $persistent = exists $arg{persistent} ? !!$arg{persistent} : $idempotent;
663 ? $arg{keepalive}*1 828 my $keepalive = exists $arg{keepalive} ? !!$arg{keepalive} : !$proxy;
664 : $idempotent ? $PERSISTENT_TIMEOUT : 0; 829 my $was_persistent; # true if this is actually a recycled connection
665 830
831 # the key to use in the keepalive cache
832 my $ka_key = "$uscheme\x00$uhost\x00$uport\x00$arg{sessionid}";
833
666 $hdr{connection} = ($keepalive ? "" : "close ") . "Te"; #1.1 834 $hdr{connection} = ($persistent ? $keepalive ? "keep-alive, " : "" : "close, ") . "Te"; #1.1
667 $hdr{te} = "trailers" unless exists $hdr{te}; #1.1 835 $hdr{te} = "trailers" unless exists $hdr{te}; #1.1
668 836
669 my %state = (connect_guard => 1); 837 my %state = (connect_guard => 1);
670 838
671 my $ae_error = 595; # connecting 839 my $ae_error = 595; # connecting
672 840
673 # handle actual, non-tunneled, request 841 # handle actual, non-tunneled, request
674 my $handle_actual_request = sub { 842 my $handle_actual_request = sub {
675 $ae_error = 596; # request phase 843 $ae_error = 596; # request phase
676 844
845 my $hdl = $state{handle};
846
677 $state{handle}->starttls ("connect") if $uscheme eq "https" && !exists $state{handle}{tls}; 847 $hdl->starttls ("connect") if $uscheme eq "https" && !exists $hdl->{tls};
678 848
679 # send request 849 # send request
680 $state{handle}->push_write ( 850 $hdl->push_write (
681 "$method $rpath HTTP/1.1\015\012" 851 "$method $rpath HTTP/1.1\015\012"
682 . (join "", map "\u$_: $hdr{$_}\015\012", grep defined $hdr{$_}, keys %hdr) 852 . (join "", map "\u$_: $hdr{$_}\015\012", grep defined $hdr{$_}, keys %hdr)
683 . "\015\012" 853 . "\015\012"
684 . (delete $arg{body}) 854 . $arg{body}
685 ); 855 );
686 856
687 # return if error occured during push_write() 857 # return if error occurred during push_write()
688 return unless %state; 858 return unless %state;
689 859
690 # reduce memory usage, save a kitten, also re-use it for the response headers. 860 # reduce memory usage, save a kitten, also re-use it for the response headers.
691 %hdr = (); 861 %hdr = ();
692 862
693 # status line and headers 863 # status line and headers
694 $state{read_response} = sub { 864 $state{read_response} = sub {
865 return unless %state;
866
695 for ("$_[1]") { 867 for ("$_[1]") {
696 y/\015//d; # weed out any \015, as they show up in the weirdest of places. 868 y/\015//d; # weed out any \015, as they show up in the weirdest of places.
697 869
698 /^HTTP\/0*([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\012]*) )? \012/gxci 870 /^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" })); 871 or return _error %state, $cb, { @pseudo, Status => 599, Reason => "Invalid server response" };
700 872
701 # 100 Continue handling 873 # 100 Continue handling
702 # should not happen as we don't send expect: 100-continue, 874 # should not happen as we don't send expect: 100-continue,
703 # but we handle it just in case. 875 # but we handle it just in case.
704 # since we send the request body regardless, if we get an error 876 # since we send the request body regardless, if we get an error
710 HTTPVersion => $1, 882 HTTPVersion => $1,
711 Status => $2, 883 Status => $2,
712 Reason => $3, 884 Reason => $3,
713 ; 885 ;
714 886
715 my $hdr = parse_hdr 887 my $hdr = _parse_hdr
716 or return (%state = (), $cb->(undef, { @pseudo, Status => 599, Reason => "Garbled response headers" })); 888 or return _error %state, $cb, { @pseudo, Status => 599, Reason => "Garbled response headers" };
717 889
718 %hdr = (%$hdr, @pseudo); 890 %hdr = (%$hdr, @pseudo);
719 } 891 }
720 892
721 # redirect handling 893 # redirect handling
722 # microsoft and other shitheads don't give a shit for following standards, 894 # relative uri handling forced by microsoft and other shitheads.
723 # try to support some common forms of broken Location headers. 895 # we give our best and fall back to URI if available.
724 if ($hdr{location} !~ /^(?: $ | [^:\/?\#]+ : )/x) { 896 if (exists $hdr{location}) {
897 my $loc = $hdr{location};
898
899 if ($loc =~ m%^//%) { # //
900 $loc = "$rscheme:$loc";
901
902 } elsif ($loc eq "") {
903 $loc = $url;
904
905 } elsif ($loc !~ /^(?: $ | [^:\/?\#]+ : )/x) { # anything "simple"
725 $hdr{location} =~ s/^\.\/+//; 906 $loc =~ s/^\.\/+//;
726 907
908 if ($loc !~ m%^[.?#]%) {
727 my $url = "$rscheme://$uhost:$uport"; 909 my $prefix = "$rscheme://$uhost:$uport";
728 910
729 unless ($hdr{location} =~ s/^\///) { 911 unless ($loc =~ s/^\///) {
730 $url .= $upath; 912 $prefix .= $upath;
731 $url =~ s/\/[^\/]*$//; 913 $prefix =~ s/\/[^\/]*$//;
914 }
915
916 $loc = "$prefix/$loc";
917
918 } elsif (eval { require URI }) { # uri
919 $loc = URI->new_abs ($loc, $url)->as_string;
920
921 } else {
922 return _error %state, $cb, { @pseudo, Status => 599, Reason => "Cannot parse Location (URI module missing)" };
923 #$hdr{Status} = 599;
924 #$hdr{Reason} = "Unparsable Redirect (URI module missing)";
925 #$recurse = 0;
926 }
732 } 927 }
733 928
734 $hdr{location} = "$url/$hdr{location}"; 929 $hdr{location} = $loc;
735 } 930 }
736 931
737 my $redirect; 932 my $redirect;
738 933
739 if ($recurse) { 934 if ($recurse) {
741 936
742 # industry standard is to redirect POST as GET for 937 # industry standard is to redirect POST as GET for
743 # 301, 302 and 303, in contrast to HTTP/1.0 and 1.1. 938 # 301, 302 and 303, in contrast to HTTP/1.0 and 1.1.
744 # also, the UA should ask the user for 301 and 307 and POST, 939 # also, the UA should ask the user for 301 and 307 and POST,
745 # industry standard seems to be to simply follow. 940 # industry standard seems to be to simply follow.
746 # we go with the industry standard. 941 # we go with the industry standard. 308 is defined
942 # by rfc7538
747 if ($status == 301 or $status == 302 or $status == 303) { 943 if ($status == 301 or $status == 302 or $status == 303) {
944 $redirect = 1;
748 # HTTP/1.1 is unclear on how to mutate the method 945 # HTTP/1.1 is unclear on how to mutate the method
749 $method = "GET" unless $method eq "HEAD"; 946 unless ($method eq "HEAD") {
750 $redirect = 1; 947 $method = "GET";
948 delete $arg{body};
949 }
751 } elsif ($status == 307) { 950 } elsif ($status == 307 or $status == 308) {
752 $redirect = 1; 951 $redirect = 1;
753 } 952 }
754 } 953 }
755 954
756 my $finish = sub { # ($data, $err_status, $err_reason[, $keepalive]) 955 my $finish = sub { # ($data, $err_status, $err_reason[, $persistent])
757 my $may_keep_alive = $_[3]; 956 if ($state{handle}) {
758 957 # handle keepalive
958 if (
959 $persistent
960 && $_[3]
961 && ($hdr{HTTPVersion} < 1.1
962 ? $hdr{connection} =~ /\bkeep-?alive\b/i
963 : $hdr{connection} !~ /\bclose\b/i)
964 ) {
965 ka_store $ka_key, delete $state{handle};
966 } else {
967 # no keepalive, destroy the handle
759 $state{handle}->destroy if $state{handle}; 968 $state{handle}->destroy;
969 }
970 }
971
760 %state = (); 972 %state = ();
761 973
762 if (defined $_[1]) { 974 if (defined $_[1]) {
763 $hdr{OrigStatus} = $hdr{Status}; $hdr{Status} = $_[1]; 975 $hdr{OrigStatus} = $hdr{Status}; $hdr{Status} = $_[1];
764 $hdr{OrigReason} = $hdr{Reason}; $hdr{Reason} = $_[2]; 976 $hdr{OrigReason} = $hdr{Reason}; $hdr{Reason} = $_[2];
771 983
772 if ($redirect && exists $hdr{location}) { 984 if ($redirect && exists $hdr{location}) {
773 # we ignore any errors, as it is very common to receive 985 # we ignore any errors, as it is very common to receive
774 # Content-Length != 0 but no actual body 986 # Content-Length != 0 but no actual body
775 # we also access %hdr, as $_[1] might be an erro 987 # we also access %hdr, as $_[1] might be an erro
988 $state{recurse} =
776 http_request ( 989 http_request (
777 $method => $hdr{location}, 990 $method => $hdr{location},
778 %arg, 991 %arg,
779 recurse => $recurse - 1, 992 recurse => $recurse - 1,
780 Redirect => [$_[0], \%hdr], 993 Redirect => [$_[0], \%hdr],
994 sub {
995 %state = ();
996 &$cb
997 },
781 $cb); 998 );
782 } else { 999 } else {
783 $cb->($_[0], \%hdr); 1000 $cb->($_[0], \%hdr);
784 } 1001 }
785 }; 1002 };
786 1003
813 1030
814 $finish->(delete $state{handle}); 1031 $finish->(delete $state{handle});
815 1032
816 } elsif ($chunked) { 1033 } elsif ($chunked) {
817 my $cl = 0; 1034 my $cl = 0;
818 my $body = undef; 1035 my $body = "";
819 my $on_body = $arg{on_body} || sub { $body .= shift; 1 }; 1036 my $on_body = $arg{on_body} || sub { $body .= shift; 1 };
820 1037
821 $state{read_chunk} = sub { 1038 $state{read_chunk} = sub {
822 $_[1] =~ /^([0-9a-fA-F]+)/ 1039 $_[1] =~ /^([0-9a-fA-F]+)/
823 or $finish->(undef, $ae_error => "Garbled chunked transfer encoding"); 1040 or return $finish->(undef, $ae_error => "Garbled chunked transfer encoding");
824 1041
825 my $len = hex $1; 1042 my $len = hex $1;
826 1043
827 if ($len) { 1044 if ($len) {
828 $cl += $len; 1045 $cl += $len;
843 $_[0]->push_read (line => $qr_nlnl, sub { 1060 $_[0]->push_read (line => $qr_nlnl, sub {
844 if (length $_[1]) { 1061 if (length $_[1]) {
845 for ("$_[1]") { 1062 for ("$_[1]") {
846 y/\015//d; # weed out any \015, as they show up in the weirdest of places. 1063 y/\015//d; # weed out any \015, as they show up in the weirdest of places.
847 1064
848 my $hdr = parse_hdr 1065 my $hdr = _parse_hdr
849 or return $finish->(undef, $ae_error => "Garbled response trailers"); 1066 or return $finish->(undef, $ae_error => "Garbled response trailers");
850 1067
851 %hdr = (%hdr, %$hdr); 1068 %hdr = (%hdr, %$hdr);
852 } 1069 }
853 } 1070 }
896 $_[0]->on_read (sub { }); 1113 $_[0]->on_read (sub { });
897 } 1114 }
898 } 1115 }
899 }; 1116 };
900 1117
1118 # if keepalive is enabled, then the server closing the connection
1119 # before a response can happen legally - we retry on idempotent methods.
1120 if ($was_persistent && $idempotent) {
1121 my $old_eof = $hdl->{on_eof};
1122 $hdl->{on_eof} = sub {
1123 _destroy_state %state;
1124
1125 %state = ();
1126 $state{recurse} =
1127 http_request (
1128 $method => $url,
1129 %arg,
1130 recurse => $recurse - 1,
1131 persistent => 0,
1132 sub {
1133 %state = ();
1134 &$cb
1135 }
1136 );
1137 };
1138 $hdl->on_read (sub {
1139 return unless %state;
1140
1141 # as soon as we receive something, a connection close
1142 # once more becomes a hard error
1143 $hdl->{on_eof} = $old_eof;
1144 $hdl->push_read (line => $qr_nlnl, $state{read_response});
1145 });
1146 } else {
901 $state{handle}->push_read (line => $qr_nlnl, $state{read_response}); 1147 $hdl->push_read (line => $qr_nlnl, $state{read_response});
1148 }
902 }; 1149 };
903 1150
1151 my $prepare_handle = sub {
1152 my ($hdl) = $state{handle};
1153
1154 $hdl->on_error (sub {
1155 _error %state, $cb, { @pseudo, Status => $ae_error, Reason => $_[2] };
1156 });
1157 $hdl->on_eof (sub {
1158 _error %state, $cb, { @pseudo, Status => $ae_error, Reason => "Unexpected end-of-file" };
1159 });
1160 $hdl->timeout_reset;
1161 $hdl->timeout ($timeout);
1162 };
1163
1164 # connected to proxy (or origin server)
904 my $connect_cb = sub { 1165 my $connect_cb = sub {
905 $state{fh} = shift 1166 my $fh = shift
906 or do {
907 my $err = "$!";
908 %state = ();
909 return $cb->(undef, { @pseudo, Status => $ae_error, Reason => $err }); 1167 or return _error %state, $cb, { @pseudo, Status => $ae_error, Reason => "$!" };
910 };
911 1168
912 return unless delete $state{connect_guard}; 1169 return unless delete $state{connect_guard};
913 1170
914 # get handle 1171 # get handle
915 $state{handle} = new AnyEvent::Handle 1172 $state{handle} = new AnyEvent::Handle
1173 %{ $arg{handle_params} },
916 fh => $state{fh}, 1174 fh => $fh,
917 peername => $rhost, 1175 peername => $uhost,
918 tls_ctx => $arg{tls_ctx}, 1176 tls_ctx => $arg{tls_ctx},
919 # these need to be reconfigured on keepalive handles
920 timeout => $timeout,
921 on_error => sub {
922 %state = ();
923 $cb->(undef, { @pseudo, Status => $ae_error, Reason => $_[2] });
924 },
925 on_eof => sub {
926 %state = ();
927 $cb->(undef, { @pseudo, Status => $ae_error, Reason => "Unexpected end-of-file" });
928 },
929 ; 1177 ;
930 1178
931 # limit the number of persistent connections 1179 $prepare_handle->();
932 # keepalive not yet supported
933# if ($KA_COUNT{$_[1]} < $MAX_PERSISTENT_PER_HOST) {
934# ++$KA_COUNT{$_[1]};
935# $state{handle}{ka_count_guard} = AnyEvent::Util::guard {
936# --$KA_COUNT{$_[1]}
937# };
938# $hdr{connection} = "keep-alive";
939# }
940 1180
941 $state{handle}->starttls ("connect") if $rscheme eq "https"; 1181 #$state{handle}->starttls ("connect") if $rscheme eq "https";
942 1182
943 # now handle proxy-CONNECT method 1183 # now handle proxy-CONNECT method
944 if ($proxy && $uscheme eq "https") { 1184 if ($proxy && $uscheme eq "https") {
945 # oh dear, we have to wrap it into a connect request 1185 # oh dear, we have to wrap it into a connect request
946 1186
1187 my $auth = exists $hdr{"proxy-authorization"}
1188 ? "proxy-authorization: " . (delete $hdr{"proxy-authorization"}) . "\015\012"
1189 : "";
1190
947 # maybe re-use $uauthority with patched port? 1191 # maybe re-use $uauthority with patched port?
948 $state{handle}->push_write ("CONNECT $uhost:$uport HTTP/1.0\015\012\015\012"); 1192 $state{handle}->push_write ("CONNECT $uhost:$uport HTTP/1.0\015\012$auth\015\012");
949 $state{handle}->push_read (line => $qr_nlnl, sub { 1193 $state{handle}->push_read (line => $qr_nlnl, sub {
950 $_[1] =~ /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\015\012]*) )?/ix 1194 $_[1] =~ /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\015\012]*) )?/ix
951 or return (%state = (), $cb->(undef, { @pseudo, Status => 599, Reason => "Invalid proxy connect response ($_[1])" })); 1195 or return _error %state, $cb, { @pseudo, Status => 599, Reason => "Invalid proxy connect response ($_[1])" };
952 1196
953 if ($2 == 200) { 1197 if ($2 == 200) {
954 $rpath = $upath; 1198 $rpath = $upath;
955 $handle_actual_request->(); 1199 $handle_actual_request->();
956 } else { 1200 } else {
957 %state = ();
958 $cb->(undef, { @pseudo, Status => $2, Reason => $3 }); 1201 _error %state, $cb, { @pseudo, Status => $2, Reason => $3 };
959 } 1202 }
960 }); 1203 });
961 } else { 1204 } else {
1205 delete $hdr{"proxy-authorization"} unless $proxy;
1206
962 $handle_actual_request->(); 1207 $handle_actual_request->();
963 } 1208 }
964 }; 1209 };
965 1210
966 _get_slot $uhost, sub { 1211 _get_slot $uhost, sub {
967 $state{slot_guard} = shift; 1212 $state{slot_guard} = shift;
968 1213
969 return unless $state{connect_guard}; 1214 return unless $state{connect_guard};
970 1215
1216 # try to use an existing keepalive connection, but only if we, ourselves, plan
1217 # on a keepalive request (in theory, this should be a separate config option).
1218 if ($persistent && $KA_CACHE{$ka_key}) {
1219 $was_persistent = 1;
1220
1221 $state{handle} = ka_fetch $ka_key;
1222 $state{handle}->destroyed
1223 and die "AnyEvent::HTTP: unexpectedly got a destructed handle (1), please report.";#d#
1224 $prepare_handle->();
1225 $state{handle}->destroyed
1226 and die "AnyEvent::HTTP: unexpectedly got a destructed handle (2), please report.";#d#
1227 $handle_actual_request->();
1228
1229 } else {
971 my $tcp_connect = $arg{tcp_connect} 1230 my $tcp_connect = $arg{tcp_connect}
972 || do { require AnyEvent::Socket; \&AnyEvent::Socket::tcp_connect }; 1231 || do { require AnyEvent::Socket; \&AnyEvent::Socket::tcp_connect };
973 1232
974 $state{connect_guard} = $tcp_connect->($rhost, $rport, $connect_cb, $arg{on_prepare} || sub { $timeout }); 1233 $state{connect_guard} = $tcp_connect->($rhost, $rport, $connect_cb, $arg{on_prepare} || sub { $timeout });
1234 }
975 }; 1235 };
976 1236
977 defined wantarray && AnyEvent::Util::guard { %state = () } 1237 defined wantarray && AnyEvent::Util::guard { _destroy_state %state }
978} 1238}
979 1239
980sub http_get($@) { 1240sub http_get($@) {
981 unshift @_, "GET"; 1241 unshift @_, "GET";
982 &http_request 1242 &http_request
1000AnyEvent::HTTP uses the AnyEvent::Socket::tcp_connect function for 1260AnyEvent::HTTP uses the AnyEvent::Socket::tcp_connect function for
1001the actual connection, which in turn uses AnyEvent::DNS to resolve 1261the actual connection, which in turn uses AnyEvent::DNS to resolve
1002hostnames. The latter is a simple stub resolver and does no caching 1262hostnames. The latter is a simple stub resolver and does no caching
1003on its own. If you want DNS caching, you currently have to provide 1263on its own. If you want DNS caching, you currently have to provide
1004your own default resolver (by storing a suitable resolver object in 1264your own default resolver (by storing a suitable resolver object in
1005C<$AnyEvent::DNS::RESOLVER>). 1265C<$AnyEvent::DNS::RESOLVER>) or your own C<tcp_connect> callback.
1006 1266
1007=head2 GLOBAL FUNCTIONS AND VARIABLES 1267=head2 GLOBAL FUNCTIONS AND VARIABLES
1008 1268
1009=over 4 1269=over 4
1010 1270
1011=item AnyEvent::HTTP::set_proxy "proxy-url" 1271=item AnyEvent::HTTP::set_proxy "proxy-url"
1012 1272
1013Sets the default proxy server to use. The proxy-url must begin with a 1273Sets the default proxy server to use. The proxy-url must begin with a
1014string of the form C<http://host:port> (optionally C<https:...>), croaks 1274string of the form C<http://host:port>, croaks otherwise.
1015otherwise.
1016 1275
1017To clear an already-set proxy, use C<undef>. 1276To clear an already-set proxy, use C<undef>.
1277
1278When AnyEvent::HTTP is loaded for the first time it will query the
1279default proxy from the operating system, currently by looking at
1280C<$ENV{http_proxy>}.
1018 1281
1019=item AnyEvent::HTTP::cookie_jar_expire $jar[, $session_end] 1282=item AnyEvent::HTTP::cookie_jar_expire $jar[, $session_end]
1020 1283
1021Remove all cookies from the cookie jar that have been expired. If 1284Remove all cookies from the cookie jar that have been expired. If
1022C<$session_end> is given and true, then additionally remove all session 1285C<$session_end> is given and true, then additionally remove all session
1023cookies. 1286cookies.
1024 1287
1025You should call this function (with a true C<$session_end>) before you 1288You should call this function (with a true C<$session_end>) before you
1026save cookies to disk, and you should call this function after loading them 1289save cookies to disk, and you should call this function after loading them
1027again. If you have a long-running program you can additonally call this 1290again. If you have a long-running program you can additionally call this
1028function from time to time. 1291function from time to time.
1029 1292
1030A cookie jar is initially an empty hash-reference that is managed by this 1293A cookie jar is initially an empty hash-reference that is managed by this
1031module. It's format is subject to change, but currently it is like this: 1294module. Its format is subject to change, but currently it is as follows:
1032 1295
1033The key C<version> has to contain C<1>, otherwise the hash gets 1296The key C<version> has to contain C<1>, otherwise the hash gets
1034emptied. All other keys are hostnames or IP addresses pointing to 1297emptied. All other keys are hostnames or IP addresses pointing to
1035hash-references. The key for these inner hash references is the 1298hash-references. The key for these inner hash references is the
1036server path for which this cookie is meant, and the values are again 1299server path for which this cookie is meant, and the values are again
1037hash-references. The keys of those hash-references is the cookie name, and 1300hash-references. Each key of those hash-references is a cookie name, and
1038the value, you guessed it, is another hash-reference, this time with the 1301the value, you guessed it, is another hash-reference, this time with the
1039key-value pairs from the cookie, except for C<expires> and C<max-age>, 1302key-value pairs from the cookie, except for C<expires> and C<max-age>,
1040which have been replaced by a C<_expires> key that contains the cookie 1303which have been replaced by a C<_expires> key that contains the cookie
1041expiry timestamp. 1304expiry timestamp. Session cookies are indicated by not having an
1305C<_expires> key.
1042 1306
1043Here is an example of a cookie jar with a single cookie, so you have a 1307Here is an example of a cookie jar with a single cookie, so you have a
1044chance of understanding the above paragraph: 1308chance of understanding the above paragraph:
1045 1309
1046 { 1310 {
1068 1332
1069=item $AnyEvent::HTTP::MAX_RECURSE 1333=item $AnyEvent::HTTP::MAX_RECURSE
1070 1334
1071The default value for the C<recurse> request parameter (default: C<10>). 1335The default value for the C<recurse> request parameter (default: C<10>).
1072 1336
1337=item $AnyEvent::HTTP::TIMEOUT
1338
1339The default timeout for connection operations (default: C<300>).
1340
1073=item $AnyEvent::HTTP::USERAGENT 1341=item $AnyEvent::HTTP::USERAGENT
1074 1342
1075The default value for the C<User-Agent> header (the default is 1343The default value for the C<User-Agent> header (the default is
1076C<Mozilla/5.0 (compatible; U; AnyEvent-HTTP/$VERSION; +http://software.schmorp.de/pkg/AnyEvent)>). 1344C<Mozilla/5.0 (compatible; U; AnyEvent-HTTP/$VERSION; +http://software.schmorp.de/pkg/AnyEvent)>).
1077 1345
1078=item $AnyEvent::HTTP::MAX_PER_HOST 1346=item $AnyEvent::HTTP::MAX_PER_HOST
1079 1347
1080The maximum number of concurrent connections to the same host (identified 1348The maximum number of concurrent connections to the same host (identified
1081by the hostname). If the limit is exceeded, then the additional requests 1349by the hostname). If the limit is exceeded, then additional requests
1082are queued until previous connections are closed. 1350are queued until previous connections are closed. Both persistent and
1351non-persistent connections are counted in this limit.
1083 1352
1084The default value for this is C<4>, and it is highly advisable to not 1353The default value for this is C<4>, and it is highly advisable to not
1085increase it. 1354increase it much.
1355
1356For comparison: the RFC's recommend 4 non-persistent or 2 persistent
1357connections, older browsers used 2, newer ones (such as firefox 3)
1358typically use 6, and Opera uses 8 because like, they have the fastest
1359browser and give a shit for everybody else on the planet.
1360
1361=item $AnyEvent::HTTP::PERSISTENT_TIMEOUT
1362
1363The time after which idle persistent connections get closed by
1364AnyEvent::HTTP (default: C<3>).
1086 1365
1087=item $AnyEvent::HTTP::ACTIVE 1366=item $AnyEvent::HTTP::ACTIVE
1088 1367
1089The number of active connections. This is not the number of currently 1368The number of active connections. This is not the number of currently
1090running requests, but the number of currently open and non-idle TCP 1369running requests, but the number of currently open and non-idle TCP
1091connections. This number of can be useful for load-leveling. 1370connections. This number can be useful for load-leveling.
1092 1371
1093=back 1372=back
1094 1373
1095=cut 1374=cut
1096 1375
1130 # other formats fail in the loop below 1409 # other formats fail in the loop below
1131 1410
1132 for (0..11) { 1411 for (0..11) {
1133 if ($m eq $month[$_]) { 1412 if ($m eq $month[$_]) {
1134 require Time::Local; 1413 require Time::Local;
1135 return Time::Local::timegm ($S, $M, $H, $d, $_, $y); 1414 return eval { Time::Local::timegm ($S, $M, $H, $d, $_, $y) };
1136 } 1415 }
1137 } 1416 }
1138 1417
1139 undef 1418 undef
1140} 1419}
1141 1420
1142sub set_proxy($) { 1421sub set_proxy($) {
1143 if (length $_[0]) { 1422 if (length $_[0]) {
1144 $_[0] =~ m%^(https?):// ([^:/]+) (?: : (\d*) )?%ix 1423 $_[0] =~ m%^(http):// ([^:/]+) (?: : (\d*) )?%ix
1145 or Carp::croak "$_[0]: invalid proxy URL"; 1424 or Carp::croak "$_[0]: invalid proxy URL";
1146 $PROXY = [$2, $3 || 3128, $1] 1425 $PROXY = [$2, $3 || 3128, $1]
1147 } else { 1426 } else {
1148 undef $PROXY; 1427 undef $PROXY;
1149 } 1428 }
1152# initialise proxy from environment 1431# initialise proxy from environment
1153eval { 1432eval {
1154 set_proxy $ENV{http_proxy}; 1433 set_proxy $ENV{http_proxy};
1155}; 1434};
1156 1435
1436=head2 SHOWCASE
1437
1438This section contains some more elaborate "real-world" examples or code
1439snippets.
1440
1441=head2 HTTP/1.1 FILE DOWNLOAD
1442
1443Downloading files with HTTP can be quite tricky, especially when something
1444goes wrong and you want to resume.
1445
1446Here is a function that initiates and resumes a download. It uses the
1447last modified time to check for file content changes, and works with many
1448HTTP/1.0 servers as well, and usually falls back to a complete re-download
1449on older servers.
1450
1451It calls the completion callback with either C<undef>, which means a
1452nonretryable error occurred, C<0> when the download was partial and should
1453be retried, and C<1> if it was successful.
1454
1455 use AnyEvent::HTTP;
1456
1457 sub download($$$) {
1458 my ($url, $file, $cb) = @_;
1459
1460 open my $fh, "+<", $file
1461 or die "$file: $!";
1462
1463 my %hdr;
1464 my $ofs = 0;
1465
1466 warn stat $fh;
1467 warn -s _;
1468 if (stat $fh and -s _) {
1469 $ofs = -s _;
1470 warn "-s is ", $ofs;
1471 $hdr{"if-unmodified-since"} = AnyEvent::HTTP::format_date +(stat _)[9];
1472 $hdr{"range"} = "bytes=$ofs-";
1473 }
1474
1475 http_get $url,
1476 headers => \%hdr,
1477 on_header => sub {
1478 my ($hdr) = @_;
1479
1480 if ($hdr->{Status} == 200 && $ofs) {
1481 # resume failed
1482 truncate $fh, $ofs = 0;
1483 }
1484
1485 sysseek $fh, $ofs, 0;
1486
1487 1
1488 },
1489 on_body => sub {
1490 my ($data, $hdr) = @_;
1491
1492 if ($hdr->{Status} =~ /^2/) {
1493 length $data == syswrite $fh, $data
1494 or return; # abort on write errors
1495 }
1496
1497 1
1498 },
1499 sub {
1500 my (undef, $hdr) = @_;
1501
1502 my $status = $hdr->{Status};
1503
1504 if (my $time = AnyEvent::HTTP::parse_date $hdr->{"last-modified"}) {
1505 utime $fh, $time, $time;
1506 }
1507
1508 if ($status == 200 || $status == 206 || $status == 416) {
1509 # download ok || resume ok || file already fully downloaded
1510 $cb->(1, $hdr);
1511
1512 } elsif ($status == 412) {
1513 # file has changed while resuming, delete and retry
1514 unlink $file;
1515 $cb->(0, $hdr);
1516
1517 } elsif ($status == 500 or $status == 503 or $status =~ /^59/) {
1518 # retry later
1519 $cb->(0, $hdr);
1520
1521 } else {
1522 $cb->(undef, $hdr);
1523 }
1524 }
1525 ;
1526 }
1527
1528 download "http://server/somelargefile", "/tmp/somelargefile", sub {
1529 if ($_[0]) {
1530 print "OK!\n";
1531 } elsif (defined $_[0]) {
1532 print "please retry later\n";
1533 } else {
1534 print "ERROR\n";
1535 }
1536 };
1537
1157=head2 SOCKS PROXIES 1538=head3 SOCKS PROXIES
1158 1539
1159Socks proxies are not directly supported by AnyEvent::HTTP. You can 1540Socks proxies are not directly supported by AnyEvent::HTTP. You can
1160compile your perl to support socks, or use an external program such as 1541compile your perl to support socks, or use an external program such as
1161F<socksify> (dante) or F<tsocks> to make your program use a socks proxy 1542F<socksify> (dante) or F<tsocks> to make your program use a socks proxy
1162transparently. 1543transparently.

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines