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.80 by root, Sat Jan 1 21:51:22 2011 UTC vs.
Revision 1.112 by root, Wed Nov 14 22:22:24 2012 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines