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.85 by root, Sun Jan 2 05:31:56 2011 UTC vs.
Revision 1.119 by root, Sun Jun 8 23:33:28 2014 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines