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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines