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.82 by root, Sun Jan 2 04:50:40 2011 UTC vs.
Revision 1.118 by root, Mon Nov 18 01:01:02 2013 UTC

15This module is an L<AnyEvent> user, you need to make sure that you use and 15This module is an L<AnyEvent> user, you need to make sure that you use and
16run a supported event loop. 16run a supported event loop.
17 17
18This module implements a simple, stateless and non-blocking HTTP 18This module implements a simple, stateless and non-blocking HTTP
19client. It supports GET, POST and other request methods, cookies and more, 19client. It supports GET, POST and other request methods, cookies and more,
20all on a very low level. It can follow redirects supports proxies and 20all on a very low level. It can follow redirects, supports proxies, and
21automatically limits the number of connections to the values specified in 21automatically limits the number of connections to the values specified in
22the RFC. 22the RFC.
23 23
24It should generally be a "good client" that is enough for most HTTP 24It should generally be a "good client" that is enough for most HTTP
25tasks. Simple tasks should be simple, but complex tasks should still be 25tasks. Simple tasks should be simple, but complex tasks should still be
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
94C<http_request> returns a "cancellation guard" - you have to keep the 89C<http_request> returns a "cancellation guard" - you have to keep the
95object 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
96destroyed before the callback is called, the request will be cancelled. 91destroyed before the callback is called, the request will be cancelled.
97 92
98The 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
99(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
100(and trailers) as second argument. 95(and trailers) as second argument.
101 96
102All 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
103headers, the "pseudo-headers" (uppercase to avoid clashing with possible 98headers, the "pseudo-headers" (uppercase to avoid clashing with possible
104response headers) C<HTTPVersion>, C<Status> and C<Reason> contain the 99response headers) C<HTTPVersion>, C<Status> and C<Reason> contain the
128C<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
129message. Currently the following status codes are used: 124message. Currently the following status codes are used:
130 125
131=over 4 126=over 4
132 127
133=item 595 - errors during connection etsbalishment, proxy handshake. 128=item 595 - errors during connection establishment, proxy handshake.
134 129
135=item 596 - errors during TLS negotiation, request sending and header processing. 130=item 596 - errors during TLS negotiation, request sending and header processing.
136 131
137=item 597 - errors during body receiving or processing. 132=item 597 - errors during body receiving or processing.
138 133
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).
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".
229 233
234See also the C<sessionid> parameter.
235
236=item session => $string
237
238The module might reuse connections to the same host internally. Sometimes
239(e.g. when using TLS), you do not want to reuse connections from other
240sessions. This can be achieved by setting this parameter to some unique
241ID (such as the address of an object storing your state data, or the TLS
242context) - only connections using the same unique ID will be reused.
243
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 example, to bind it on a given IP address). This parameter
234overrides the prepare callback passed to C<AnyEvent::Socket::tcp_connect> 248overrides the prepare callback passed to C<AnyEvent::Socket::tcp_connect>
235and behaves exactly the same way (e.g. it has to provide a 249and behaves exactly the same way (e.g. it has to provide a
236timeout). See the description for the C<$prepare_cb> argument of 250timeout). See the description for the C<$prepare_cb> argument of
237C<AnyEvent::Socket::tcp_connect> for details. 251C<AnyEvent::Socket::tcp_connect> for details.
238 252
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;
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}
693
694our %IDEMPOTENT = (
695 DELETE => 1,
696 GET => 1,
697 HEAD => 1,
698 OPTIONS => 1,
699 PUT => 1,
700 TRACE => 1,
701
702 ACL => 1,
703 "BASELINE-CONTROL" => 1,
704 BIND => 1,
705 CHECKIN => 1,
706 CHECKOUT => 1,
707 COPY => 1,
708 LABEL => 1,
709 LINK => 1,
710 MERGE => 1,
711 MKACTIVITY => 1,
712 MKCALENDAR => 1,
713 MKCOL => 1,
714 MKREDIRECTREF => 1,
715 MKWORKSPACE => 1,
716 MOVE => 1,
717 ORDERPATCH => 1,
718 PROPFIND => 1,
719 PROPPATCH => 1,
720 REBIND => 1,
721 REPORT => 1,
722 SEARCH => 1,
723 UNBIND => 1,
724 UNCHECKOUT => 1,
725 UNLINK => 1,
726 UNLOCK => 1,
727 UPDATE => 1,
728 UPDATEREDIRECTREF => 1,
729 "VERSION-CONTROL" => 1,
730);
570 731
571sub http_request($$@) { 732sub http_request($$@) {
572 my $cb = pop; 733 my $cb = pop;
573 my ($method, $url, %arg) = @_; 734 my ($method, $url, %arg) = @_;
574 735
592 my $recurse = exists $arg{recurse} ? delete $arg{recurse} : $MAX_RECURSE; 753 my $recurse = exists $arg{recurse} ? delete $arg{recurse} : $MAX_RECURSE;
593 754
594 return $cb->(undef, { @pseudo, Status => 599, Reason => "Too many redirections" }) 755 return $cb->(undef, { @pseudo, Status => 599, Reason => "Too many redirections" })
595 if $recurse < 0; 756 if $recurse < 0;
596 757
597 my $proxy = $arg{proxy} || $PROXY; 758 my $proxy = exists $arg{proxy} ? $arg{proxy} : $PROXY;
598 my $timeout = $arg{timeout} || $TIMEOUT; 759 my $timeout = $arg{timeout} || $TIMEOUT;
599 760
600 my ($uscheme, $uauthority, $upath, $query, $fragment) = 761 my ($uscheme, $uauthority, $upath, $query, undef) = # ignore fragment
601 $url =~ m|(?:([^:/?#]+):)?(?://([^/?#]*))?([^?#]*)(?:(\?[^#]*))?(?:#(.*))?|; 762 $url =~ m|^([^:]+):(?://([^/?#]*))?([^?#]*)(?:(\?[^#]*))?(?:#(.*))?$|;
602 763
603 $uscheme = lc $uscheme; 764 $uscheme = lc $uscheme;
604 765
605 my $uport = $uscheme eq "http" ? 80 766 my $uport = $uscheme eq "http" ? 80
606 : $uscheme eq "https" ? 443 767 : $uscheme eq "https" ? 443
607 : return $cb->(undef, { @pseudo, Status => 599, Reason => "Only http and https URL schemes supported" }); 768 : return $cb->(undef, { @pseudo, Status => 599, Reason => "Only http and https URL schemes supported" });
608 769
609 $uauthority =~ /^(?: .*\@ )? ([^\@:]+) (?: : (\d+) )?$/x 770 $uauthority =~ /^(?: .*\@ )? ([^\@:]+) (?: : (\d+) )?$/x
610 or return $cb->(undef, { @pseudo, Status => 599, Reason => "Unparsable URL" }); 771 or return $cb->(undef, { @pseudo, Status => 599, Reason => "Unparsable URL" });
611 772
612 my $uhost = $1; 773 my $uhost = lc $1;
613 $uport = $2 if defined $2; 774 $uport = $2 if defined $2;
614 775
615 $hdr{host} = defined $2 ? "$uhost:$2" : "$uhost" 776 $hdr{host} = defined $2 ? "$uhost:$2" : "$uhost"
616 unless exists $hdr{host}; 777 unless exists $hdr{host};
617 778
636 $rscheme = "http" unless defined $rscheme; 797 $rscheme = "http" unless defined $rscheme;
637 798
638 # don't support https requests over https-proxy transport, 799 # don't support https requests over https-proxy transport,
639 # can't be done with tls as spec'ed, unless you double-encrypt. 800 # can't be done with tls as spec'ed, unless you double-encrypt.
640 $rscheme = "http" if $uscheme eq "https" && $rscheme eq "https"; 801 $rscheme = "http" if $uscheme eq "https" && $rscheme eq "https";
802
803 $rhost = lc $rhost;
804 $rscheme = lc $rscheme;
641 } else { 805 } else {
642 ($rhost, $rport, $rscheme, $rpath) = ($uhost, $uport, $uscheme, $upath); 806 ($rhost, $rport, $rscheme, $rpath) = ($uhost, $uport, $uscheme, $upath);
643 } 807 }
644 808
645 # leave out fragment and query string, just a heuristic 809 # leave out fragment and query string, just a heuristic
647 $hdr{"user-agent"} = $USERAGENT unless exists $hdr{"user-agent"}; 811 $hdr{"user-agent"} = $USERAGENT unless exists $hdr{"user-agent"};
648 812
649 $hdr{"content-length"} = length $arg{body} 813 $hdr{"content-length"} = length $arg{body}
650 if length $arg{body} || $method ne "GET"; 814 if length $arg{body} || $method ne "GET";
651 815
652 $hdr{connection} = "close TE"; #1.1 816 my $idempotent = $IDEMPOTENT{$method};
817
818 # default value for keepalive is true iff the request is for an idempotent method
819 my $persistent = exists $arg{persistent} ? !!$arg{persistent} : $idempotent;
820 my $keepalive = exists $arg{keepalive} ? !!$arg{keepalive} : !$proxy;
821 my $was_persistent; # true if this is actually a recycled connection
822
823 # the key to use in the keepalive cache
824 my $ka_key = "$uscheme\x00$uhost\x00$uport\x00$arg{sessionid}";
825
826 $hdr{connection} = ($persistent ? $keepalive ? "keep-alive, " : "" : "close, ") . "Te"; #1.1
653 $hdr{te} = "trailers" unless exists $hdr{te}; #1.1 827 $hdr{te} = "trailers" unless exists $hdr{te}; #1.1
654 828
655 my %state = (connect_guard => 1); 829 my %state = (connect_guard => 1);
656 830
657 _get_slot $uhost, sub {
658 $state{slot_guard} = shift;
659
660 return unless $state{connect_guard};
661
662 my $ae_error = 595; # connecting 831 my $ae_error = 595; # connecting
663 832
664 # handle actual, non-tunneled, request 833 # handle actual, non-tunneled, request
665 my $handle_actual_request = sub { 834 my $handle_actual_request = sub {
666 $ae_error = 596; # request phase 835 $ae_error = 596; # request phase
667 836
837 my $hdl = $state{handle};
838
668 $state{handle}->starttls ("connect") if $uscheme eq "https" && !exists $state{handle}{tls}; 839 $hdl->starttls ("connect") if $uscheme eq "https" && !exists $hdl->{tls};
669 840
670 # send request 841 # send request
671 $state{handle}->push_write ( 842 $hdl->push_write (
672 "$method $rpath HTTP/1.1\015\012" 843 "$method $rpath HTTP/1.1\015\012"
673 . (join "", map "\u$_: $hdr{$_}\015\012", grep defined $hdr{$_}, keys %hdr) 844 . (join "", map "\u$_: $hdr{$_}\015\012", grep defined $hdr{$_}, keys %hdr)
674 . "\015\012" 845 . "\015\012"
675 . (delete $arg{body}) 846 . (delete $arg{body})
676 ); 847 );
677 848
678 # return if error occured during push_write() 849 # return if error occurred during push_write()
850 return unless %state;
851
852 # reduce memory usage, save a kitten, also re-use it for the response headers.
853 %hdr = ();
854
855 # status line and headers
856 $state{read_response} = sub {
679 return unless %state; 857 return unless %state;
680 858
681 %hdr = (); # reduce memory usage, save a kitten, also make it possible to re-use
682
683 # status line and headers
684 $state{read_response} = sub {
685 for ("$_[1]") { 859 for ("$_[1]") {
686 y/\015//d; # weed out any \015, as they show up in the weirdest of places. 860 y/\015//d; # weed out any \015, as they show up in the weirdest of places.
687 861
688 /^HTTP\/0*([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\012]*) )? \012/gxci 862 /^HTTP\/0*([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\012]*) )? \012/gxci
689 or return (%state = (), $cb->(undef, { @pseudo, Status => 599, Reason => "Invalid server response" })); 863 or return _error %state, $cb, { @pseudo, Status => 599, Reason => "Invalid server response" };
690 864
691 # 100 Continue handling 865 # 100 Continue handling
692 # should not happen as we don't send expect: 100-continue, 866 # should not happen as we don't send expect: 100-continue,
693 # but we handle it just in case. 867 # but we handle it just in case.
694 # since we send the request body regardless, if we get an error 868 # since we send the request body regardless, if we get an error
695 # we are out of-sync, which we currently do NOT handle correctly. 869 # we are out of-sync, which we currently do NOT handle correctly.
696 return $state{handle}->push_read (line => $qr_nlnl, $state{read_response}) 870 return $state{handle}->push_read (line => $qr_nlnl, $state{read_response})
697 if $2 eq 100; 871 if $2 eq 100;
698 872
699 push @pseudo, 873 push @pseudo,
700 HTTPVersion => $1, 874 HTTPVersion => $1,
701 Status => $2, 875 Status => $2,
702 Reason => $3, 876 Reason => $3,
703 ; 877 ;
704 878
705 my $hdr = parse_hdr 879 my $hdr = _parse_hdr
706 or return (%state = (), $cb->(undef, { @pseudo, Status => 599, Reason => "Garbled response headers" })); 880 or return _error %state, $cb, { @pseudo, Status => 599, Reason => "Garbled response headers" };
707 881
708 %hdr = (%$hdr, @pseudo); 882 %hdr = (%$hdr, @pseudo);
883 }
884
885 # redirect handling
886 # microsoft and other shitheads don't give a shit for following standards,
887 # try to support some common forms of broken Location headers.
888 if ($hdr{location} !~ /^(?: $ | [^:\/?\#]+ : )/x) {
889 $hdr{location} =~ s/^\.\/+//;
890
891 my $url = "$rscheme://$uhost:$uport";
892
893 unless ($hdr{location} =~ s/^\///) {
894 $url .= $upath;
895 $url =~ s/\/[^\/]*$//;
709 } 896 }
710 897
711 # redirect handling
712 # microsoft and other shitheads don't give a shit for following standards,
713 # try to support some common forms of broken Location headers.
714 if ($hdr{location} !~ /^(?: $ | [^:\/?\#]+ : )/x) {
715 $hdr{location} =~ s/^\.\/+//;
716
717 my $url = "$rscheme://$uhost:$uport";
718
719 unless ($hdr{location} =~ s/^\///) {
720 $url .= $upath;
721 $url =~ s/\/[^\/]*$//;
722 }
723
724 $hdr{location} = "$url/$hdr{location}"; 898 $hdr{location} = "$url/$hdr{location}";
899 }
900
901 my $redirect;
902
903 if ($recurse) {
904 my $status = $hdr{Status};
905
906 # industry standard is to redirect POST as GET for
907 # 301, 302 and 303, in contrast to HTTP/1.0 and 1.1.
908 # also, the UA should ask the user for 301 and 307 and POST,
909 # industry standard seems to be to simply follow.
910 # we go with the industry standard.
911 if ($status == 301 or $status == 302 or $status == 303) {
912 # HTTP/1.1 is unclear on how to mutate the method
913 $method = "GET" unless $method eq "HEAD";
914 $redirect = 1;
915 } elsif ($status == 307) {
916 $redirect = 1;
725 } 917 }
918 }
726 919
727 my $redirect; 920 my $finish = sub { # ($data, $err_status, $err_reason[, $persistent])
728 921 if ($state{handle}) {
729 if ($recurse) { 922 # handle keepalive
730 my $status = $hdr{Status}; 923 if (
731 924 $persistent
732 # industry standard is to redirect POST as GET for 925 && $_[3]
733 # 301, 302 and 303, in contrast to HTTP/1.0 and 1.1. 926 && ($hdr{HTTPVersion} < 1.1
734 # also, the UA should ask the user for 301 and 307 and POST, 927 ? $hdr{connection} =~ /\bkeep-?alive\b/i
735 # industry standard seems to be to simply follow. 928 : $hdr{connection} !~ /\bclose\b/i)
736 # we go with the industry standard. 929 ) {
737 if ($status == 301 or $status == 302 or $status == 303) { 930 ka_store $ka_key, delete $state{handle};
738 # HTTP/1.1 is unclear on how to mutate the method 931 } else {
739 $method = "GET" unless $method eq "HEAD"; 932 # no keepalive, destroy the handle
740 $redirect = 1; 933 $state{handle}->destroy;
741 } elsif ($status == 307) {
742 $redirect = 1;
743 } 934 }
744 } 935 }
745 936
746 my $finish = sub { # ($data, $err_status, $err_reason[, $keepalive])
747 my $may_keep_alive = $_[3];
748
749 $state{handle}->destroy if $state{handle};
750 %state = (); 937 %state = ();
751 938
752 if (defined $_[1]) { 939 if (defined $_[1]) {
753 $hdr{OrigStatus} = $hdr{Status}; $hdr{Status} = $_[1]; 940 $hdr{OrigStatus} = $hdr{Status}; $hdr{Status} = $_[1];
754 $hdr{OrigReason} = $hdr{Reason}; $hdr{Reason} = $_[2]; 941 $hdr{OrigReason} = $hdr{Reason}; $hdr{Reason} = $_[2];
755 } 942 }
756 943
757 # set-cookie processing 944 # set-cookie processing
758 if ($arg{cookie_jar}) { 945 if ($arg{cookie_jar}) {
759 cookie_jar_set_cookie $arg{cookie_jar}, $hdr{"set-cookie"}, $uhost, $hdr{date}; 946 cookie_jar_set_cookie $arg{cookie_jar}, $hdr{"set-cookie"}, $uhost, $hdr{date};
760 } 947 }
761 948
762 if ($redirect && exists $hdr{location}) { 949 if ($redirect && exists $hdr{location}) {
763 # we ignore any errors, as it is very common to receive 950 # we ignore any errors, as it is very common to receive
764 # Content-Length != 0 but no actual body 951 # Content-Length != 0 but no actual body
765 # we also access %hdr, as $_[1] might be an erro 952 # we also access %hdr, as $_[1] might be an erro
953 $state{recurse} =
766 http_request ( 954 http_request (
767 $method => $hdr{location}, 955 $method => $hdr{location},
768 %arg, 956 %arg,
769 recurse => $recurse - 1, 957 recurse => $recurse - 1,
770 Redirect => [$_[0], \%hdr], 958 Redirect => [$_[0], \%hdr],
959 sub {
960 %state = ();
961 &$cb
962 },
963 );
964 } else {
965 $cb->($_[0], \%hdr);
966 }
967 };
968
969 $ae_error = 597; # body phase
970
971 my $chunked = $hdr{"transfer-encoding"} =~ /\bchunked\b/i; # not quite correct...
972
973 my $len = $chunked ? undef : $hdr{"content-length"};
974
975 # body handling, many different code paths
976 # - no body expected
977 # - want_body_handle
978 # - te chunked
979 # - 2x length known (with or without on_body)
980 # - 2x length not known (with or without on_body)
981 if (!$redirect && $arg{on_header} && !$arg{on_header}(\%hdr)) {
982 $finish->(undef, 598 => "Request cancelled by on_header");
983 } elsif (
984 $hdr{Status} =~ /^(?:1..|204|205|304)$/
985 or $method eq "HEAD"
986 or (defined $len && $len == 0) # == 0, not !, because "0 " is true
987 ) {
988 # no body
989 $finish->("", undef, undef, 1);
990
991 } elsif (!$redirect && $arg{want_body_handle}) {
992 $_[0]->on_eof (undef);
993 $_[0]->on_error (undef);
994 $_[0]->on_read (undef);
995
996 $finish->(delete $state{handle});
997
998 } elsif ($chunked) {
999 my $cl = 0;
1000 my $body = "";
1001 my $on_body = $arg{on_body} || sub { $body .= shift; 1 };
1002
1003 $state{read_chunk} = sub {
1004 $_[1] =~ /^([0-9a-fA-F]+)/
1005 or return $finish->(undef, $ae_error => "Garbled chunked transfer encoding");
1006
1007 my $len = hex $1;
1008
1009 if ($len) {
1010 $cl += $len;
1011
1012 $_[0]->push_read (chunk => $len, sub {
1013 $on_body->($_[1], \%hdr)
1014 or return $finish->(undef, 598 => "Request cancelled by on_body");
1015
1016 $_[0]->push_read (line => sub {
1017 length $_[1]
1018 and return $finish->(undef, $ae_error => "Garbled chunked transfer encoding");
1019 $_[0]->push_read (line => $state{read_chunk});
771 $cb); 1020 });
1021 });
772 } else { 1022 } else {
773 $cb->($_[0], \%hdr); 1023 $hdr{"content-length"} ||= $cl;
1024
1025 $_[0]->push_read (line => $qr_nlnl, sub {
1026 if (length $_[1]) {
1027 for ("$_[1]") {
1028 y/\015//d; # weed out any \015, as they show up in the weirdest of places.
1029
1030 my $hdr = _parse_hdr
1031 or return $finish->(undef, $ae_error => "Garbled response trailers");
1032
1033 %hdr = (%hdr, %$hdr);
1034 }
1035 }
1036
1037 $finish->($body, undef, undef, 1);
1038 });
774 } 1039 }
775 }; 1040 };
776 1041
777 $ae_error = 597; # body phase 1042 $_[0]->push_read (line => $state{read_chunk});
778 1043
779 my $len = $hdr{"content-length"}; 1044 } elsif ($arg{on_body}) {
1045 if (defined $len) {
1046 $_[0]->on_read (sub {
1047 $len -= length $_[0]{rbuf};
780 1048
781 if (!$redirect && $arg{on_header} && !$arg{on_header}(\%hdr)) { 1049 $arg{on_body}(delete $_[0]{rbuf}, \%hdr)
782 $finish->(undef, 598 => "Request cancelled by on_header"); 1050 or return $finish->(undef, 598 => "Request cancelled by on_body");
783 } elsif ( 1051
784 $hdr{Status} =~ /^(?:1..|204|205|304)$/ 1052 $len > 0
785 or $method eq "HEAD"
786 or (defined $len && !$len)
787 ) {
788 # no body
789 $finish->("", undef, undef, 1); 1053 or $finish->("", undef, undef, 1);
1054 });
790 } else { 1055 } else {
791 # body handling, many different code paths
792 # - no body expected
793 # - want_body_handle
794 # - te chunked
795 # - 2x length known (with or without on_body)
796 # - 2x length not known (with or without on_body)
797 if (!$redirect && $arg{want_body_handle}) {
798 $_[0]->on_eof (undef); 1056 $_[0]->on_eof (sub {
799 $_[0]->on_error (undef); 1057 $finish->("");
800 $_[0]->on_read (undef);
801
802 $finish->(delete $state{handle});
803
804 } elsif ($hdr{"transfer-encoding"} =~ /\bchunked\b/i) {
805 my $cl = 0;
806 my $body = undef;
807 my $on_body = $arg{on_body} || sub { $body .= shift; 1 };
808
809 $state{read_chunk} = sub {
810 $_[1] =~ /^([0-9a-fA-F]+)/
811 or $finish->(undef, $ae_error => "Garbled chunked transfer encoding");
812
813 my $len = hex $1;
814
815 if ($len) {
816 $cl += $len;
817
818 $_[0]->push_read (chunk => $len, sub {
819 $on_body->($_[1], \%hdr)
820 or return $finish->(undef, 598 => "Request cancelled by on_body");
821
822 $_[0]->push_read (line => sub {
823 length $_[1]
824 and return $finish->(undef, $ae_error => "Garbled chunked transfer encoding");
825 $_[0]->push_read (line => $state{read_chunk});
826 });
827 });
828 } else {
829 $hdr{"content-length"} ||= $cl;
830
831 $_[0]->push_read (line => $qr_nlnl, sub {
832 if (length $_[1]) {
833 for ("$_[1]") {
834 y/\015//d; # weed out any \015, as they show up in the weirdest of places.
835
836 my $hdr = parse_hdr
837 or return $finish->(undef, $ae_error => "Garbled response trailers");
838
839 %hdr = (%hdr, %$hdr);
840 }
841 }
842
843 $finish->($body, undef, undef, 1);
844 });
845 }
846 }; 1058 });
847
848 $_[0]->push_read (line => $state{read_chunk});
849
850 } elsif ($arg{on_body}) {
851 if ($len) {
852 $_[0]->on_read (sub { 1059 $_[0]->on_read (sub {
853 $len -= length $_[0]{rbuf};
854
855 $arg{on_body}(delete $_[0]{rbuf}, \%hdr) 1060 $arg{on_body}(delete $_[0]{rbuf}, \%hdr)
856 or return $finish->(undef, 598 => "Request cancelled by on_body");
857
858 $len > 0
859 or $finish->("", undef, undef, 1);
860 });
861 } else {
862 $_[0]->on_eof (sub {
863 $finish->("");
864 });
865 $_[0]->on_read (sub {
866 $arg{on_body}(delete $_[0]{rbuf}, \%hdr)
867 or $finish->(undef, 598 => "Request cancelled by on_body"); 1061 or $finish->(undef, 598 => "Request cancelled by on_body");
868 });
869 }
870 } else {
871 $_[0]->on_eof (undef);
872
873 if ($len) {
874 $_[0]->on_read (sub {
875 $finish->((substr delete $_[0]{rbuf}, 0, $len, ""), undef, undef, 1)
876 if $len <= length $_[0]{rbuf};
877 });
878 } else {
879 $_[0]->on_error (sub {
880 ($! == Errno::EPIPE || !$!)
881 ? $finish->(delete $_[0]{rbuf})
882 : $finish->(undef, $ae_error => $_[2]);
883 });
884 $_[0]->on_read (sub { });
885 }
886 } 1062 });
887 } 1063 }
888 };
889
890 $state{handle}->push_read (line => $qr_nlnl, $state{read_response});
891 };
892
893 my $connect_cb = sub {
894 $state{fh} = shift
895 or do {
896 my $err = "$!";
897 %state = ();
898 return $cb->(undef, { @pseudo, Status => $ae_error, Reason => $err });
899 };
900
901 return unless delete $state{connect_guard};
902
903 # get handle
904 $state{handle} = new AnyEvent::Handle
905 fh => $state{fh},
906 peername => $rhost,
907 tls_ctx => $arg{tls_ctx},
908 # these need to be reconfigured on keepalive handles
909 timeout => $timeout,
910 on_error => sub {
911 %state = ();
912 $cb->(undef, { @pseudo, Status => $ae_error, Reason => $_[2] });
913 },
914 on_eof => sub {
915 %state = ();
916 $cb->(undef, { @pseudo, Status => $ae_error, Reason => "Unexpected end-of-file" });
917 },
918 ;
919
920 # limit the number of persistent connections
921 # keepalive not yet supported
922# if ($KA_COUNT{$_[1]} < $MAX_PERSISTENT_PER_HOST) {
923# ++$KA_COUNT{$_[1]};
924# $state{handle}{ka_count_guard} = AnyEvent::Util::guard {
925# --$KA_COUNT{$_[1]}
926# };
927# $hdr{connection} = "keep-alive";
928# }
929
930 $state{handle}->starttls ("connect") if $rscheme eq "https";
931
932 # now handle proxy-CONNECT method
933 if ($proxy && $uscheme eq "https") {
934 # oh dear, we have to wrap it into a connect request
935
936 # maybe re-use $uauthority with patched port?
937 $state{handle}->push_write ("CONNECT $uhost:$uport HTTP/1.0\015\012Host: $uhost\015\012\015\012");
938 $state{handle}->push_read (line => $qr_nlnl, sub {
939 $_[1] =~ /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\015\012]*) )?/ix
940 or return (%state = (), $cb->(undef, { @pseudo, Status => 599, Reason => "Invalid proxy connect response ($_[1])" }));
941
942 if ($2 == 200) {
943 $rpath = $upath;
944 $handle_actual_request->();
945 } else {
946 %state = ();
947 $cb->(undef, { @pseudo, Status => $2, Reason => $3 });
948 }
949 });
950 } else { 1064 } else {
951 $handle_actual_request->(); 1065 $_[0]->on_eof (undef);
1066
1067 if (defined $len) {
1068 $_[0]->on_read (sub {
1069 $finish->((substr delete $_[0]{rbuf}, 0, $len, ""), undef, undef, 1)
1070 if $len <= length $_[0]{rbuf};
1071 });
1072 } else {
1073 $_[0]->on_error (sub {
1074 ($! == Errno::EPIPE || !$!)
1075 ? $finish->(delete $_[0]{rbuf})
1076 : $finish->(undef, $ae_error => $_[2]);
1077 });
1078 $_[0]->on_read (sub { });
1079 }
952 } 1080 }
953 }; 1081 };
954 1082
955 my $tcp_connect = $arg{tcp_connect} 1083 # if keepalive is enabled, then the server closing the connection
956 || do { require AnyEvent::Socket; \&AnyEvent::Socket::tcp_connect }; 1084 # before a response can happen legally - we retry on idempotent methods.
1085 if ($was_persistent && $idempotent) {
1086 my $old_eof = $hdl->{on_eof};
1087 $hdl->{on_eof} = sub {
1088 _destroy_state %state;
957 1089
958 $state{connect_guard} = $tcp_connect->($rhost, $rport, $connect_cb, $arg{on_prepare} || sub { $timeout }); 1090 %state = ();
1091 $state{recurse} =
1092 http_request (
1093 $method => $url,
1094 %arg,
1095 recurse => $recurse - 1,
1096 keepalive => 0,
1097 sub {
1098 %state = ();
1099 &$cb
1100 }
1101 );
1102 };
1103 $hdl->on_read (sub {
1104 return unless %state;
1105
1106 # as soon as we receive something, a connection close
1107 # once more becomes a hard error
1108 $hdl->{on_eof} = $old_eof;
1109 $hdl->push_read (line => $qr_nlnl, $state{read_response});
1110 });
1111 } else {
1112 $hdl->push_read (line => $qr_nlnl, $state{read_response});
1113 }
959 }; 1114 };
960 1115
1116 my $prepare_handle = sub {
1117 my ($hdl) = $state{handle};
1118
1119 $hdl->on_error (sub {
1120 _error %state, $cb, { @pseudo, Status => $ae_error, Reason => $_[2] };
1121 });
1122 $hdl->on_eof (sub {
1123 _error %state, $cb, { @pseudo, Status => $ae_error, Reason => "Unexpected end-of-file" };
1124 });
1125 $hdl->timeout_reset;
1126 $hdl->timeout ($timeout);
1127 };
1128
1129 # connected to proxy (or origin server)
1130 my $connect_cb = sub {
1131 my $fh = shift
1132 or return _error %state, $cb, { @pseudo, Status => $ae_error, Reason => "$!" };
1133
1134 return unless delete $state{connect_guard};
1135
1136 # get handle
1137 $state{handle} = new AnyEvent::Handle
1138 %{ $arg{handle_params} },
1139 fh => $fh,
1140 peername => $uhost,
1141 tls_ctx => $arg{tls_ctx},
1142 ;
1143
1144 $prepare_handle->();
1145
1146 #$state{handle}->starttls ("connect") if $rscheme eq "https";
1147
1148 # now handle proxy-CONNECT method
1149 if ($proxy && $uscheme eq "https") {
1150 # oh dear, we have to wrap it into a connect request
1151
1152 # maybe re-use $uauthority with patched port?
1153 $state{handle}->push_write ("CONNECT $uhost:$uport HTTP/1.0\015\012\015\012");
1154 $state{handle}->push_read (line => $qr_nlnl, sub {
1155 $_[1] =~ /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\015\012]*) )?/ix
1156 or return _error %state, $cb, { @pseudo, Status => 599, Reason => "Invalid proxy connect response ($_[1])" };
1157
1158 if ($2 == 200) {
1159 $rpath = $upath;
1160 $handle_actual_request->();
1161 } else {
1162 _error %state, $cb, { @pseudo, Status => $2, Reason => $3 };
1163 }
1164 });
1165 } else {
1166 $handle_actual_request->();
1167 }
1168 };
1169
1170 _get_slot $uhost, sub {
1171 $state{slot_guard} = shift;
1172
1173 return unless $state{connect_guard};
1174
1175 # try to use an existing keepalive connection, but only if we, ourselves, plan
1176 # on a keepalive request (in theory, this should be a separate config option).
1177 if ($persistent && $KA_CACHE{$ka_key}) {
1178 $was_persistent = 1;
1179
1180 $state{handle} = ka_fetch $ka_key;
1181 $state{handle}->destroyed
1182 and die "AnyEvent::HTTP: unexpectedly got a destructed handle (1), please report.";#d#
1183 $prepare_handle->();
1184 $state{handle}->destroyed
1185 and die "AnyEvent::HTTP: unexpectedly got a destructed handle (2), please report.";#d#
1186 $handle_actual_request->();
1187
1188 } else {
1189 my $tcp_connect = $arg{tcp_connect}
1190 || do { require AnyEvent::Socket; \&AnyEvent::Socket::tcp_connect };
1191
1192 $state{connect_guard} = $tcp_connect->($rhost, $rport, $connect_cb, $arg{on_prepare} || sub { $timeout });
1193 }
1194 };
1195
961 defined wantarray && AnyEvent::Util::guard { %state = () } 1196 defined wantarray && AnyEvent::Util::guard { _destroy_state %state }
962} 1197}
963 1198
964sub http_get($@) { 1199sub http_get($@) {
965 unshift @_, "GET"; 1200 unshift @_, "GET";
966 &http_request 1201 &http_request
984AnyEvent::HTTP uses the AnyEvent::Socket::tcp_connect function for 1219AnyEvent::HTTP uses the AnyEvent::Socket::tcp_connect function for
985the actual connection, which in turn uses AnyEvent::DNS to resolve 1220the actual connection, which in turn uses AnyEvent::DNS to resolve
986hostnames. The latter is a simple stub resolver and does no caching 1221hostnames. The latter is a simple stub resolver and does no caching
987on its own. If you want DNS caching, you currently have to provide 1222on its own. If you want DNS caching, you currently have to provide
988your own default resolver (by storing a suitable resolver object in 1223your own default resolver (by storing a suitable resolver object in
989C<$AnyEvent::DNS::RESOLVER>). 1224C<$AnyEvent::DNS::RESOLVER>) or your own C<tcp_connect> callback.
990 1225
991=head2 GLOBAL FUNCTIONS AND VARIABLES 1226=head2 GLOBAL FUNCTIONS AND VARIABLES
992 1227
993=over 4 1228=over 4
994 1229
995=item AnyEvent::HTTP::set_proxy "proxy-url" 1230=item AnyEvent::HTTP::set_proxy "proxy-url"
996 1231
997Sets the default proxy server to use. The proxy-url must begin with a 1232Sets the default proxy server to use. The proxy-url must begin with a
998string of the form C<http://host:port> (optionally C<https:...>), croaks 1233string of the form C<http://host:port>, croaks otherwise.
999otherwise.
1000 1234
1001To clear an already-set proxy, use C<undef>. 1235To clear an already-set proxy, use C<undef>.
1236
1237When AnyEvent::HTTP is loaded for the first time it will query the
1238default proxy from the operating system, currently by looking at
1239C<$ENV{http_proxy>}.
1002 1240
1003=item AnyEvent::HTTP::cookie_jar_expire $jar[, $session_end] 1241=item AnyEvent::HTTP::cookie_jar_expire $jar[, $session_end]
1004 1242
1005Remove all cookies from the cookie jar that have been expired. If 1243Remove all cookies from the cookie jar that have been expired. If
1006C<$session_end> is given and true, then additionally remove all session 1244C<$session_end> is given and true, then additionally remove all session
1007cookies. 1245cookies.
1008 1246
1009You should call this function (with a true C<$session_end>) before you 1247You should call this function (with a true C<$session_end>) before you
1010save cookies to disk, and you should call this function after loading them 1248save cookies to disk, and you should call this function after loading them
1011again. If you have a long-running program you can additonally call this 1249again. If you have a long-running program you can additionally call this
1012function from time to time. 1250function from time to time.
1013 1251
1014A cookie jar is initially an empty hash-reference that is managed by this 1252A cookie jar is initially an empty hash-reference that is managed by this
1015module. It's format is subject to change, but currently it is like this: 1253module. It's format is subject to change, but currently it is like this:
1016 1254
1017The key C<version> has to contain C<1>, otherwise the hash gets 1255The key C<version> has to contain C<1>, otherwise the hash gets
1018emptied. All other keys are hostnames or IP addresses pointing to 1256emptied. All other keys are hostnames or IP addresses pointing to
1019hash-references. The key for these inner hash references is the 1257hash-references. The key for these inner hash references is the
1020server path for which this cookie is meant, and the values are again 1258server path for which this cookie is meant, and the values are again
1021hash-references. The keys of those hash-references is the cookie name, and 1259hash-references. Each key of those hash-references is a cookie name, and
1022the value, you guessed it, is another hash-reference, this time with the 1260the value, you guessed it, is another hash-reference, this time with the
1023key-value pairs from the cookie, except for C<expires> and C<max-age>, 1261key-value pairs from the cookie, except for C<expires> and C<max-age>,
1024which have been replaced by a C<_expires> key that contains the cookie 1262which have been replaced by a C<_expires> key that contains the cookie
1025expiry timestamp. 1263expiry timestamp. Session cookies are indicated by not having an
1264C<_expires> key.
1026 1265
1027Here is an example of a cookie jar with a single cookie, so you have a 1266Here is an example of a cookie jar with a single cookie, so you have a
1028chance of understanding the above paragraph: 1267chance of understanding the above paragraph:
1029 1268
1030 { 1269 {
1052 1291
1053=item $AnyEvent::HTTP::MAX_RECURSE 1292=item $AnyEvent::HTTP::MAX_RECURSE
1054 1293
1055The default value for the C<recurse> request parameter (default: C<10>). 1294The default value for the C<recurse> request parameter (default: C<10>).
1056 1295
1296=item $AnyEvent::HTTP::TIMEOUT
1297
1298The default timeout for connection operations (default: C<300>).
1299
1057=item $AnyEvent::HTTP::USERAGENT 1300=item $AnyEvent::HTTP::USERAGENT
1058 1301
1059The default value for the C<User-Agent> header (the default is 1302The default value for the C<User-Agent> header (the default is
1060C<Mozilla/5.0 (compatible; U; AnyEvent-HTTP/$VERSION; +http://software.schmorp.de/pkg/AnyEvent)>). 1303C<Mozilla/5.0 (compatible; U; AnyEvent-HTTP/$VERSION; +http://software.schmorp.de/pkg/AnyEvent)>).
1061 1304
1062=item $AnyEvent::HTTP::MAX_PER_HOST 1305=item $AnyEvent::HTTP::MAX_PER_HOST
1063 1306
1064The maximum number of concurrent connections to the same host (identified 1307The maximum number of concurrent connections to the same host (identified
1065by the hostname). If the limit is exceeded, then the additional requests 1308by the hostname). If the limit is exceeded, then the additional requests
1066are queued until previous connections are closed. 1309are queued until previous connections are closed. Both persistent and
1310non-persistent connections are counted in this limit.
1067 1311
1068The default value for this is C<4>, and it is highly advisable to not 1312The default value for this is C<4>, and it is highly advisable to not
1069increase it. 1313increase it much.
1314
1315For comparison: the RFC's recommend 4 non-persistent or 2 persistent
1316connections, older browsers used 2, newer ones (such as firefox 3)
1317typically use 6, and Opera uses 8 because like, they have the fastest
1318browser and give a shit for everybody else on the planet.
1319
1320=item $AnyEvent::HTTP::PERSISTENT_TIMEOUT
1321
1322The time after which idle persistent connections get closed by
1323AnyEvent::HTTP (default: C<3>).
1070 1324
1071=item $AnyEvent::HTTP::ACTIVE 1325=item $AnyEvent::HTTP::ACTIVE
1072 1326
1073The number of active connections. This is not the number of currently 1327The number of active connections. This is not the number of currently
1074running requests, but the number of currently open and non-idle TCP 1328running requests, but the number of currently open and non-idle TCP
1075connections. This number of can be useful for load-leveling. 1329connections. This number can be useful for load-leveling.
1076 1330
1077=back 1331=back
1078 1332
1079=cut 1333=cut
1080 1334
1114 # other formats fail in the loop below 1368 # other formats fail in the loop below
1115 1369
1116 for (0..11) { 1370 for (0..11) {
1117 if ($m eq $month[$_]) { 1371 if ($m eq $month[$_]) {
1118 require Time::Local; 1372 require Time::Local;
1119 return Time::Local::timegm ($S, $M, $H, $d, $_, $y); 1373 return eval { Time::Local::timegm ($S, $M, $H, $d, $_, $y) };
1120 } 1374 }
1121 } 1375 }
1122 1376
1123 undef 1377 undef
1124} 1378}
1125 1379
1126sub set_proxy($) { 1380sub set_proxy($) {
1127 if (length $_[0]) { 1381 if (length $_[0]) {
1128 $_[0] =~ m%^(https?):// ([^:/]+) (?: : (\d*) )?%ix 1382 $_[0] =~ m%^(http):// ([^:/]+) (?: : (\d*) )?%ix
1129 or Carp::croak "$_[0]: invalid proxy URL"; 1383 or Carp::croak "$_[0]: invalid proxy URL";
1130 $PROXY = [$2, $3 || 3128, $1] 1384 $PROXY = [$2, $3 || 3128, $1]
1131 } else { 1385 } else {
1132 undef $PROXY; 1386 undef $PROXY;
1133 } 1387 }
1136# initialise proxy from environment 1390# initialise proxy from environment
1137eval { 1391eval {
1138 set_proxy $ENV{http_proxy}; 1392 set_proxy $ENV{http_proxy};
1139}; 1393};
1140 1394
1395=head2 SHOWCASE
1396
1397This section contains some more elaborate "real-world" examples or code
1398snippets.
1399
1400=head2 HTTP/1.1 FILE DOWNLOAD
1401
1402Downloading files with HTTP can be quite tricky, especially when something
1403goes wrong and you want to resume.
1404
1405Here is a function that initiates and resumes a download. It uses the
1406last modified time to check for file content changes, and works with many
1407HTTP/1.0 servers as well, and usually falls back to a complete re-download
1408on older servers.
1409
1410It calls the completion callback with either C<undef>, which means a
1411nonretryable error occurred, C<0> when the download was partial and should
1412be retried, and C<1> if it was successful.
1413
1414 use AnyEvent::HTTP;
1415
1416 sub download($$$) {
1417 my ($url, $file, $cb) = @_;
1418
1419 open my $fh, "+<", $file
1420 or die "$file: $!";
1421
1422 my %hdr;
1423 my $ofs = 0;
1424
1425 warn stat $fh;
1426 warn -s _;
1427 if (stat $fh and -s _) {
1428 $ofs = -s _;
1429 warn "-s is ", $ofs;
1430 $hdr{"if-unmodified-since"} = AnyEvent::HTTP::format_date +(stat _)[9];
1431 $hdr{"range"} = "bytes=$ofs-";
1432 }
1433
1434 http_get $url,
1435 headers => \%hdr,
1436 on_header => sub {
1437 my ($hdr) = @_;
1438
1439 if ($hdr->{Status} == 200 && $ofs) {
1440 # resume failed
1441 truncate $fh, $ofs = 0;
1442 }
1443
1444 sysseek $fh, $ofs, 0;
1445
1446 1
1447 },
1448 on_body => sub {
1449 my ($data, $hdr) = @_;
1450
1451 if ($hdr->{Status} =~ /^2/) {
1452 length $data == syswrite $fh, $data
1453 or return; # abort on write errors
1454 }
1455
1456 1
1457 },
1458 sub {
1459 my (undef, $hdr) = @_;
1460
1461 my $status = $hdr->{Status};
1462
1463 if (my $time = AnyEvent::HTTP::parse_date $hdr->{"last-modified"}) {
1464 utime $fh, $time, $time;
1465 }
1466
1467 if ($status == 200 || $status == 206 || $status == 416) {
1468 # download ok || resume ok || file already fully downloaded
1469 $cb->(1, $hdr);
1470
1471 } elsif ($status == 412) {
1472 # file has changed while resuming, delete and retry
1473 unlink $file;
1474 $cb->(0, $hdr);
1475
1476 } elsif ($status == 500 or $status == 503 or $status =~ /^59/) {
1477 # retry later
1478 $cb->(0, $hdr);
1479
1480 } else {
1481 $cb->(undef, $hdr);
1482 }
1483 }
1484 ;
1485 }
1486
1487 download "http://server/somelargefile", "/tmp/somelargefile", sub {
1488 if ($_[0]) {
1489 print "OK!\n";
1490 } elsif (defined $_[0]) {
1491 print "please retry later\n";
1492 } else {
1493 print "ERROR\n";
1494 }
1495 };
1496
1141=head2 SOCKS PROXIES 1497=head3 SOCKS PROXIES
1142 1498
1143Socks proxies are not directly supported by AnyEvent::HTTP. You can 1499Socks proxies are not directly supported by AnyEvent::HTTP. You can
1144compile your perl to support socks, or use an external program such as 1500compile your perl to support socks, or use an external program such as
1145F<socksify> (dante) or F<tsocks> to make your program use a socks proxy 1501F<socksify> (dante) or F<tsocks> to make your program use a socks proxy
1146transparently. 1502transparently.

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines