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.84 by root, Sun Jan 2 05:13:27 2011 UTC vs.
Revision 1.122 by root, Fri May 8 17:28:39 2015 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines