ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/AnyEvent-HTTP/HTTP.pm
(Generate patch)

Comparing AnyEvent-HTTP/HTTP.pm (file contents):
Revision 1.80 by root, Sat Jan 1 21:51:22 2011 UTC vs.
Revision 1.120 by root, Sun Jun 8 23:36:36 2014 UTC

15This module is an L<AnyEvent> user, you need to make sure that you use and 15This module is an L<AnyEvent> user, you need to make sure that you use and
16run a supported event loop. 16run a supported event loop.
17 17
18This module implements a simple, stateless and non-blocking HTTP 18This module implements a simple, stateless and non-blocking HTTP
19client. It supports GET, POST and other request methods, cookies and more, 19client. It supports GET, POST and other request methods, cookies and more,
20all on a very low level. It can follow redirects supports proxies and 20all on a very low level. It can follow redirects, supports proxies, and
21automatically limits the number of connections to the values specified in 21automatically limits the number of connections to the values specified in
22the RFC. 22the RFC.
23 23
24It should generally be a "good client" that is enough for most HTTP 24It should generally be a "good client" that is enough for most HTTP
25tasks. Simple tasks should be simple, but complex tasks should still be 25tasks. Simple tasks should be simple, but complex tasks should still be
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 485
421 %$jar = () if $jar->{version} != 1; 486 %$jar = () if $jar->{version} != 1;
422 487
423 my @cookies; 488 my @cookies;
424 489
425 while (my ($chost, $paths) = each %$jar) { 490 while (my ($chost, $paths) = each %$jar) {
426 next unless ref $paths; 491 next unless ref $paths;
427 492
428 if ($chost =~ /^\./) { 493 if ($chost =~ /^\./) {
429 next unless $chost eq substr $uhost, -length $chost; 494 next unless $chost eq substr $host, -length $chost;
430 } elsif ($chost =~ /\./) { 495 } elsif ($chost =~ /\./) {
431 next unless $chost eq $uhost; 496 next unless $chost eq $host;
432 } else { 497 } else {
433 next; 498 next;
434 } 499 }
435 500
436 while (my ($cpath, $cookies) = each %$paths) { 501 while (my ($cpath, $cookies) = each %$paths) {
437 next unless $cpath eq substr $upath, 0, length $cpath; 502 next unless $cpath eq substr $path, 0, length $cpath;
438 503
439 while (my ($cookie, $kv) = each %$cookies) { 504 while (my ($cookie, $kv) = each %$cookies) {
440 next if $uscheme ne "https" && exists $kv->{secure}; 505 next if $scheme ne "https" && exists $kv->{secure};
441 506
442 if (exists $kv->{_expires} and AE::now > $kv->{_expires}) { 507 if (exists $kv->{_expires} and AE::now > $kv->{_expires}) {
443 delete $cookies->{$cookie}; 508 delete $cookies->{$cookie};
444 next; 509 next;
445 } 510 }
459 \@cookies 524 \@cookies
460} 525}
461 526
462# parse set_cookie header into jar 527# parse set_cookie header into jar
463sub cookie_jar_set_cookie($$$$) { 528sub cookie_jar_set_cookie($$$$) {
464 my ($jar, $set_cookie, $uhost, $date) = @_; 529 my ($jar, $set_cookie, $host, $date) = @_;
465 530
466 my $anow = int AE::now; 531 my $anow = int AE::now;
467 my $snow; # server-now 532 my $snow; # server-now
468 533
469 for ($set_cookie) { 534 for ($set_cookie) {
475 while ( 540 while (
476 m{ 541 m{
477 \G\s* 542 \G\s*
478 (?: 543 (?:
479 expires \s*=\s* ([A-Z][a-z][a-z]+,\ [^,;]+) 544 expires \s*=\s* ([A-Z][a-z][a-z]+,\ [^,;]+)
480 | ([^=;,[:space:]]+) \s*=\s* (?: "((?:[^\\"]+|\\.)*)" | ([^=;,[:space:]]*) ) 545 | ([^=;,[:space:]]+) (?: \s*=\s* (?: "((?:[^\\"]+|\\.)*)" | ([^;,[:space:]]*) ) )?
481 ) 546 )
482 }gcxsi 547 }gcxsi
483 ) { 548 ) {
484 my $name = $2; 549 my $name = $2;
485 my $value = $4; 550 my $value = $4;
486 551
487 unless (defined $name) { 552 if (defined $1) {
488 # expires 553 # expires
489 $name = "expires"; 554 $name = "expires";
490 $value = $1; 555 $value = $1;
491 } elsif (!defined $value) { 556 } elsif (defined $3) {
492 # quoted 557 # quoted
493 $value = $3; 558 $value = $3;
494 $value =~ s/\\(.)/$1/gs; 559 $value =~ s/\\(.)/$1/gs;
495 } 560 }
496 561
497 push @kv, lc $name, $value; 562 push @kv, @kv ? lc $name : $name, $value;
498 563
499 last unless /\G\s*;/gc; 564 last unless /\G\s*;/gc;
500 } 565 }
501 566
502 last unless @kv; 567 last unless @kv;
525 590
526 # this is not rfc-like and not netscape-like. go figure. 591 # this is not rfc-like and not netscape-like. go figure.
527 my $ndots = $cdom =~ y/.//; 592 my $ndots = $cdom =~ y/.//;
528 next if $ndots < ($cdom =~ /\.[^.][^.]\.[^.][^.]$/ ? 3 : 2); 593 next if $ndots < ($cdom =~ /\.[^.][^.]\.[^.][^.]$/ ? 3 : 2);
529 } else { 594 } else {
530 $cdom = $uhost; 595 $cdom = $host;
531 } 596 }
532 597
533 # store it 598 # store it
534 $jar->{version} = 1; 599 $jar->{version} = 1;
535 $jar->{$cdom}{$cpath}{$name} = \%kv; 600 $jar->{lc $cdom}{$cpath}{$name} = \%kv;
536 601
537 redo if /\G\s*,/gc; 602 redo if /\G\s*,/gc;
538 } 603 }
539} 604}
540 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
541# continue to parse $_ for headers and place them into the arg 648# continue to parse $_ for headers and place them into the arg
542sub parse_hdr() { 649sub _parse_hdr() {
543 my %hdr; 650 my %hdr;
544 651
545 # things seen, not parsed: 652 # things seen, not parsed:
546 # p3pP="NON CUR OTPi OUR NOR UNI" 653 # p3pP="NON CUR OTPi OUR NOR UNI"
547 654
561 for values %hdr; 668 for values %hdr;
562 669
563 \%hdr 670 \%hdr
564} 671}
565 672
673#############################################################################
674# http_get
675
566our $qr_nlnl = qr{(?<![^\012])\015?\012}; 676our $qr_nlnl = qr{(?<![^\012])\015?\012};
567 677
568our $TLS_CTX_LOW = { cache => 1, sslv2 => 1 }; 678our $TLS_CTX_LOW = { cache => 1, sslv2 => 1 };
569our $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);
570 736
571sub http_request($$@) { 737sub http_request($$@) {
572 my $cb = pop; 738 my $cb = pop;
573 my ($method, $url, %arg) = @_; 739 my ($method, $url, %arg) = @_;
574 740
592 my $recurse = exists $arg{recurse} ? delete $arg{recurse} : $MAX_RECURSE; 758 my $recurse = exists $arg{recurse} ? delete $arg{recurse} : $MAX_RECURSE;
593 759
594 return $cb->(undef, { @pseudo, Status => 599, Reason => "Too many redirections" }) 760 return $cb->(undef, { @pseudo, Status => 599, Reason => "Too many redirections" })
595 if $recurse < 0; 761 if $recurse < 0;
596 762
597 my $proxy = $arg{proxy} || $PROXY; 763 my $proxy = exists $arg{proxy} ? $arg{proxy} : $PROXY;
598 my $timeout = $arg{timeout} || $TIMEOUT; 764 my $timeout = $arg{timeout} || $TIMEOUT;
599 765
600 my ($uscheme, $uauthority, $upath, $query, $fragment) = 766 my ($uscheme, $uauthority, $upath, $query, undef) = # ignore fragment
601 $url =~ m|(?:([^:/?#]+):)?(?://([^/?#]*))?([^?#]*)(?:(\?[^#]*))?(?:#(.*))?|; 767 $url =~ m|^([^:]+):(?://([^/?#]*))?([^?#]*)(?:(\?[^#]*))?(?:#(.*))?$|;
602 768
603 $uscheme = lc $uscheme; 769 $uscheme = lc $uscheme;
604 770
605 my $uport = $uscheme eq "http" ? 80 771 my $uport = $uscheme eq "http" ? 80
606 : $uscheme eq "https" ? 443 772 : $uscheme eq "https" ? 443
607 : 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" });
608 774
609 $uauthority =~ /^(?: .*\@ )? ([^\@:]+) (?: : (\d+) )?$/x 775 $uauthority =~ /^(?: .*\@ )? ([^\@:]+) (?: : (\d+) )?$/x
610 or return $cb->(undef, { @pseudo, Status => 599, Reason => "Unparsable URL" }); 776 or return $cb->(undef, { @pseudo, Status => 599, Reason => "Unparsable URL" });
611 777
612 my $uhost = $1; 778 my $uhost = lc $1;
613 $uport = $2 if defined $2; 779 $uport = $2 if defined $2;
614 780
615 $hdr{host} = defined $2 ? "$uhost:$2" : "$uhost" 781 $hdr{host} = defined $2 ? "$uhost:$2" : "$uhost"
616 unless exists $hdr{host}; 782 unless exists $hdr{host};
617 783
636 $rscheme = "http" unless defined $rscheme; 802 $rscheme = "http" unless defined $rscheme;
637 803
638 # don't support https requests over https-proxy transport, 804 # don't support https requests over https-proxy transport,
639 # 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.
640 $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;
641 } else { 810 } else {
642 ($rhost, $rport, $rscheme, $rpath) = ($uhost, $uport, $uscheme, $upath); 811 ($rhost, $rport, $rscheme, $rpath) = ($uhost, $uport, $uscheme, $upath);
643 } 812 }
644 813
645 # leave out fragment and query string, just a heuristic 814 # leave out fragment and query string, just a heuristic
647 $hdr{"user-agent"} = $USERAGENT unless exists $hdr{"user-agent"}; 816 $hdr{"user-agent"} = $USERAGENT unless exists $hdr{"user-agent"};
648 817
649 $hdr{"content-length"} = length $arg{body} 818 $hdr{"content-length"} = length $arg{body}
650 if length $arg{body} || $method ne "GET"; 819 if length $arg{body} || $method ne "GET";
651 820
652 $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
653 $hdr{te} = "trailers" unless exists $hdr{te}; #1.1 832 $hdr{te} = "trailers" unless exists $hdr{te}; #1.1
654 833
655 my %state = (connect_guard => 1); 834 my %state = (connect_guard => 1);
835
836 my $ae_error = 595; # connecting
837
838 # handle actual, non-tunneled, request
839 my $handle_actual_request = sub {
840 $ae_error = 596; # request phase
841
842 my $hdl = $state{handle};
843
844 $hdl->starttls ("connect") if $uscheme eq "https" && !exists $hdl->{tls};
845
846 # send request
847 $hdl->push_write (
848 "$method $rpath HTTP/1.1\015\012"
849 . (join "", map "\u$_: $hdr{$_}\015\012", grep defined $hdr{$_}, keys %hdr)
850 . "\015\012"
851 . $arg{body}
852 );
853
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 {
862 return unless %state;
863
864 for ("$_[1]") {
865 y/\015//d; # weed out any \015, as they show up in the weirdest of places.
866
867 /^HTTP\/0*([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\012]*) )? \012/gxci
868 or return _error %state, $cb, { @pseudo, Status => 599, Reason => "Invalid server response" };
869
870 # 100 Continue handling
871 # should not happen as we don't send expect: 100-continue,
872 # but we handle it just in case.
873 # since we send the request body regardless, if we get an error
874 # we are out of-sync, which we currently do NOT handle correctly.
875 return $state{handle}->push_read (line => $qr_nlnl, $state{read_response})
876 if $2 eq 100;
877
878 push @pseudo,
879 HTTPVersion => $1,
880 Status => $2,
881 Reason => $3,
882 ;
883
884 my $hdr = _parse_hdr
885 or return _error %state, $cb, { @pseudo, Status => 599, Reason => "Garbled response headers" };
886
887 %hdr = (%$hdr, @pseudo);
888 }
889
890 # redirect handling
891 # relative uri handling forced by microsoft and other shitheads.
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
902 } elsif ($loc !~ /^(?: $ | [^:\/?\#]+ : )/x) { # anything "simple"
903 $loc =~ s/^\.\/+//;
904
905 if ($loc !~ m%^[.?#]%) {
906 my $prefix = "$rscheme://$uhost:$uport";
907
908 unless ($loc =~ s/^\///) {
909 $prefix .= $upath;
910 $prefix =~ s/\/[^\/]*$//;
911 }
912
913 $loc = "$prefix/$loc";
914
915 } elsif (eval { require URI }) { # uri
916 $loc = URI->new_abs ($loc, $url)->as_string;
917
918 } else {
919 return _error %state, $cb, { @pseudo, Status => 599, Reason => "Cannot parse Location (URI module missing)" };
920 #$hdr{Status} = 599;
921 #$hdr{Reason} = "Unparsable Redirect (URI module missing)";
922 #$recurse = 0;
923 }
924 }
925
926 $hdr{location} = $loc;
927 }
928
929 my $redirect;
930
931 if ($recurse) {
932 my $status = $hdr{Status};
933
934 # industry standard is to redirect POST as GET for
935 # 301, 302 and 303, in contrast to HTTP/1.0 and 1.1.
936 # also, the UA should ask the user for 301 and 307 and POST,
937 # industry standard seems to be to simply follow.
938 # we go with the industry standard. 308 is defined
939 # by rfc7238
940 if ($status == 301 or $status == 302 or $status == 303) {
941 # HTTP/1.1 is unclear on how to mutate the method
942 $method = "GET" unless $method eq "HEAD";
943 $redirect = 1;
944 } elsif ($status == 307 or $status == 308) {
945 $redirect = 1;
946 }
947 }
948
949 my $finish = sub { # ($data, $err_status, $err_reason[, $persistent])
950 if ($state{handle}) {
951 # handle keepalive
952 if (
953 $persistent
954 && $_[3]
955 && ($hdr{HTTPVersion} < 1.1
956 ? $hdr{connection} =~ /\bkeep-?alive\b/i
957 : $hdr{connection} !~ /\bclose\b/i)
958 ) {
959 ka_store $ka_key, delete $state{handle};
960 } else {
961 # no keepalive, destroy the handle
962 $state{handle}->destroy;
963 }
964 }
965
966 %state = ();
967
968 if (defined $_[1]) {
969 $hdr{OrigStatus} = $hdr{Status}; $hdr{Status} = $_[1];
970 $hdr{OrigReason} = $hdr{Reason}; $hdr{Reason} = $_[2];
971 }
972
973 # set-cookie processing
974 if ($arg{cookie_jar}) {
975 cookie_jar_set_cookie $arg{cookie_jar}, $hdr{"set-cookie"}, $uhost, $hdr{date};
976 }
977
978 if ($redirect && exists $hdr{location}) {
979 # we ignore any errors, as it is very common to receive
980 # Content-Length != 0 but no actual body
981 # we also access %hdr, as $_[1] might be an erro
982 $state{recurse} =
983 http_request (
984 $method => $hdr{location},
985 %arg,
986 recurse => $recurse - 1,
987 Redirect => [$_[0], \%hdr],
988 sub {
989 %state = ();
990 &$cb
991 },
992 );
993 } else {
994 $cb->($_[0], \%hdr);
995 }
996 };
997
998 $ae_error = 597; # body phase
999
1000 my $chunked = $hdr{"transfer-encoding"} =~ /\bchunked\b/i; # not quite correct...
1001
1002 my $len = $chunked ? undef : $hdr{"content-length"};
1003
1004 # body handling, many different code paths
1005 # - no body expected
1006 # - want_body_handle
1007 # - te chunked
1008 # - 2x length known (with or without on_body)
1009 # - 2x length not known (with or without on_body)
1010 if (!$redirect && $arg{on_header} && !$arg{on_header}(\%hdr)) {
1011 $finish->(undef, 598 => "Request cancelled by on_header");
1012 } elsif (
1013 $hdr{Status} =~ /^(?:1..|204|205|304)$/
1014 or $method eq "HEAD"
1015 or (defined $len && $len == 0) # == 0, not !, because "0 " is true
1016 ) {
1017 # no body
1018 $finish->("", undef, undef, 1);
1019
1020 } elsif (!$redirect && $arg{want_body_handle}) {
1021 $_[0]->on_eof (undef);
1022 $_[0]->on_error (undef);
1023 $_[0]->on_read (undef);
1024
1025 $finish->(delete $state{handle});
1026
1027 } elsif ($chunked) {
1028 my $cl = 0;
1029 my $body = "";
1030 my $on_body = $arg{on_body} || sub { $body .= shift; 1 };
1031
1032 $state{read_chunk} = sub {
1033 $_[1] =~ /^([0-9a-fA-F]+)/
1034 or return $finish->(undef, $ae_error => "Garbled chunked transfer encoding");
1035
1036 my $len = hex $1;
1037
1038 if ($len) {
1039 $cl += $len;
1040
1041 $_[0]->push_read (chunk => $len, sub {
1042 $on_body->($_[1], \%hdr)
1043 or return $finish->(undef, 598 => "Request cancelled by on_body");
1044
1045 $_[0]->push_read (line => sub {
1046 length $_[1]
1047 and return $finish->(undef, $ae_error => "Garbled chunked transfer encoding");
1048 $_[0]->push_read (line => $state{read_chunk});
1049 });
1050 });
1051 } else {
1052 $hdr{"content-length"} ||= $cl;
1053
1054 $_[0]->push_read (line => $qr_nlnl, sub {
1055 if (length $_[1]) {
1056 for ("$_[1]") {
1057 y/\015//d; # weed out any \015, as they show up in the weirdest of places.
1058
1059 my $hdr = _parse_hdr
1060 or return $finish->(undef, $ae_error => "Garbled response trailers");
1061
1062 %hdr = (%hdr, %$hdr);
1063 }
1064 }
1065
1066 $finish->($body, undef, undef, 1);
1067 });
1068 }
1069 };
1070
1071 $_[0]->push_read (line => $state{read_chunk});
1072
1073 } elsif ($arg{on_body}) {
1074 if (defined $len) {
1075 $_[0]->on_read (sub {
1076 $len -= length $_[0]{rbuf};
1077
1078 $arg{on_body}(delete $_[0]{rbuf}, \%hdr)
1079 or return $finish->(undef, 598 => "Request cancelled by on_body");
1080
1081 $len > 0
1082 or $finish->("", undef, undef, 1);
1083 });
1084 } else {
1085 $_[0]->on_eof (sub {
1086 $finish->("");
1087 });
1088 $_[0]->on_read (sub {
1089 $arg{on_body}(delete $_[0]{rbuf}, \%hdr)
1090 or $finish->(undef, 598 => "Request cancelled by on_body");
1091 });
1092 }
1093 } else {
1094 $_[0]->on_eof (undef);
1095
1096 if (defined $len) {
1097 $_[0]->on_read (sub {
1098 $finish->((substr delete $_[0]{rbuf}, 0, $len, ""), undef, undef, 1)
1099 if $len <= length $_[0]{rbuf};
1100 });
1101 } else {
1102 $_[0]->on_error (sub {
1103 ($! == Errno::EPIPE || !$!)
1104 ? $finish->(delete $_[0]{rbuf})
1105 : $finish->(undef, $ae_error => $_[2]);
1106 });
1107 $_[0]->on_read (sub { });
1108 }
1109 }
1110 };
1111
1112 # if keepalive is enabled, then the server closing the connection
1113 # before a response can happen legally - we retry on idempotent methods.
1114 if ($was_persistent && $idempotent) {
1115 my $old_eof = $hdl->{on_eof};
1116 $hdl->{on_eof} = sub {
1117 _destroy_state %state;
1118
1119 %state = ();
1120 $state{recurse} =
1121 http_request (
1122 $method => $url,
1123 %arg,
1124 recurse => $recurse - 1,
1125 keepalive => 0,
1126 sub {
1127 %state = ();
1128 &$cb
1129 }
1130 );
1131 };
1132 $hdl->on_read (sub {
1133 return unless %state;
1134
1135 # as soon as we receive something, a connection close
1136 # once more becomes a hard error
1137 $hdl->{on_eof} = $old_eof;
1138 $hdl->push_read (line => $qr_nlnl, $state{read_response});
1139 });
1140 } else {
1141 $hdl->push_read (line => $qr_nlnl, $state{read_response});
1142 }
1143 };
1144
1145 my $prepare_handle = sub {
1146 my ($hdl) = $state{handle};
1147
1148 $hdl->on_error (sub {
1149 _error %state, $cb, { @pseudo, Status => $ae_error, Reason => $_[2] };
1150 });
1151 $hdl->on_eof (sub {
1152 _error %state, $cb, { @pseudo, Status => $ae_error, Reason => "Unexpected end-of-file" };
1153 });
1154 $hdl->timeout_reset;
1155 $hdl->timeout ($timeout);
1156 };
1157
1158 # connected to proxy (or origin server)
1159 my $connect_cb = sub {
1160 my $fh = shift
1161 or return _error %state, $cb, { @pseudo, Status => $ae_error, Reason => "$!" };
1162
1163 return unless delete $state{connect_guard};
1164
1165 # get handle
1166 $state{handle} = new AnyEvent::Handle
1167 %{ $arg{handle_params} },
1168 fh => $fh,
1169 peername => $uhost,
1170 tls_ctx => $arg{tls_ctx},
1171 ;
1172
1173 $prepare_handle->();
1174
1175 #$state{handle}->starttls ("connect") if $rscheme eq "https";
1176
1177 # now handle proxy-CONNECT method
1178 if ($proxy && $uscheme eq "https") {
1179 # oh dear, we have to wrap it into a connect request
1180
1181 # maybe re-use $uauthority with patched port?
1182 $state{handle}->push_write ("CONNECT $uhost:$uport HTTP/1.0\015\012\015\012");
1183 $state{handle}->push_read (line => $qr_nlnl, sub {
1184 $_[1] =~ /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\015\012]*) )?/ix
1185 or return _error %state, $cb, { @pseudo, Status => 599, Reason => "Invalid proxy connect response ($_[1])" };
1186
1187 if ($2 == 200) {
1188 $rpath = $upath;
1189 $handle_actual_request->();
1190 } else {
1191 _error %state, $cb, { @pseudo, Status => $2, Reason => $3 };
1192 }
1193 });
1194 } else {
1195 $handle_actual_request->();
1196 }
1197 };
656 1198
657 _get_slot $uhost, sub { 1199 _get_slot $uhost, sub {
658 $state{slot_guard} = shift; 1200 $state{slot_guard} = shift;
659 1201
660 return unless $state{connect_guard}; 1202 return unless $state{connect_guard};
661 1203
662 my $ae_error = 595; # connecting 1204 # try to use an existing keepalive connection, but only if we, ourselves, plan
1205 # on a keepalive request (in theory, this should be a separate config option).
1206 if ($persistent && $KA_CACHE{$ka_key}) {
1207 $was_persistent = 1;
663 1208
664 my $connect_cb = sub { 1209 $state{handle} = ka_fetch $ka_key;
665 $state{fh} = shift
666 or do {
667 my $err = "$!";
668 %state = ();
669 return $cb->(undef, { @pseudo, Status => $ae_error, Reason => $err });
670 };
671
672 return unless delete $state{connect_guard};
673
674 # get handle
675 $state{handle} = new AnyEvent::Handle
676 fh => $state{fh},
677 peername => $rhost,
678 tls_ctx => $arg{tls_ctx},
679 # these need to be reconfigured on keepalive handles
680 timeout => $timeout,
681 on_error => sub {
682 %state = ();
683 $cb->(undef, { @pseudo, Status => $ae_error, Reason => $_[2] });
684 },
685 on_eof => sub {
686 %state = ();
687 $cb->(undef, { @pseudo, Status => $ae_error, Reason => "Unexpected end-of-file" });
688 },
689 ;
690
691 # limit the number of persistent connections
692 # keepalive not yet supported
693# if ($KA_COUNT{$_[1]} < $MAX_PERSISTENT_PER_HOST) {
694# ++$KA_COUNT{$_[1]};
695# $state{handle}{ka_count_guard} = AnyEvent::Util::guard {
696# --$KA_COUNT{$_[1]}
697# };
698# $hdr{connection} = "keep-alive";
699# }
700
701 $state{handle}->starttls ("connect") if $rscheme eq "https";
702
703 # handle actual, non-tunneled, request
704 my $handle_actual_request = sub {
705 $ae_error = 596; # request phase
706
707 $state{handle}->starttls ("connect") if $uscheme eq "https" && !exists $state{handle}{tls};
708
709 # send request
710 $state{handle}->push_write ( 1210 $state{handle}->destroyed
711 "$method $rpath HTTP/1.1\015\012" 1211 and die "AnyEvent::HTTP: unexpectedly got a destructed handle (1), please report.";#d#
712 . (join "", map "\u$_: $hdr{$_}\015\012", grep defined $hdr{$_}, keys %hdr) 1212 $prepare_handle->();
713 . "\015\012" 1213 $state{handle}->destroyed
714 . (delete $arg{body}) 1214 and die "AnyEvent::HTTP: unexpectedly got a destructed handle (2), please report.";#d#
715 );
716
717 # return if error occured during push_write()
718 return unless %state;
719
720 %hdr = (); # reduce memory usage, save a kitten, also make it possible to re-use
721
722 # status line and headers
723 $state{read_response} = sub {
724 for ("$_[1]") {
725 y/\015//d; # weed out any \015, as they show up in the weirdest of places.
726
727 /^HTTP\/0*([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\012]*) )? \012/gxci
728 or return (%state = (), $cb->(undef, { @pseudo, Status => 599, Reason => "Invalid server response" }));
729
730 # 100 Continue handling
731 # should not happen as we don't send expect: 100-continue,
732 # but we handle it just in case.
733 # since we send the request body regardless, if we get an error
734 # we are out of-sync, which we currently do NOT handle correctly.
735 return $state{handle}->push_read (line => $qr_nlnl, $state{read_response})
736 if $2 eq 100;
737
738 push @pseudo,
739 HTTPVersion => $1,
740 Status => $2,
741 Reason => $3,
742 ;
743
744 my $hdr = parse_hdr
745 or return (%state = (), $cb->(undef, { @pseudo, Status => 599, Reason => "Garbled response headers" }));
746
747 %hdr = (%$hdr, @pseudo);
748 }
749
750 # redirect handling
751 # microsoft and other shitheads don't give a shit for following standards,
752 # try to support some common forms of broken Location headers.
753 if ($hdr{location} !~ /^(?: $ | [^:\/?\#]+ : )/x) {
754 $hdr{location} =~ s/^\.\/+//;
755
756 my $url = "$rscheme://$uhost:$uport";
757
758 unless ($hdr{location} =~ s/^\///) {
759 $url .= $upath;
760 $url =~ s/\/[^\/]*$//;
761 }
762
763 $hdr{location} = "$url/$hdr{location}";
764 }
765
766 my $redirect;
767
768 if ($recurse) {
769 my $status = $hdr{Status};
770
771 # industry standard is to redirect POST as GET for
772 # 301, 302 and 303, in contrast to HTTP/1.0 and 1.1.
773 # also, the UA should ask the user for 301 and 307 and POST,
774 # industry standard seems to be to simply follow.
775 # we go with the industry standard.
776 if ($status == 301 or $status == 302 or $status == 303) {
777 # HTTP/1.1 is unclear on how to mutate the method
778 $method = "GET" unless $method eq "HEAD";
779 $redirect = 1;
780 } elsif ($status == 307) {
781 $redirect = 1;
782 }
783 }
784
785 my $finish = sub { # ($data, $err_status, $err_reason[, $keepalive])
786 my $may_keep_alive = $_[3];
787
788 $state{handle}->destroy if $state{handle};
789 %state = ();
790
791 if (defined $_[1]) {
792 $hdr{OrigStatus} = $hdr{Status}; $hdr{Status} = $_[1];
793 $hdr{OrigReason} = $hdr{Reason}; $hdr{Reason} = $_[2];
794 }
795
796 # set-cookie processing
797 if ($arg{cookie_jar}) {
798 cookie_jar_set_cookie $arg{cookie_jar}, $hdr{"set-cookie"}, $uhost, $hdr{date};
799 }
800
801 if ($redirect && exists $hdr{location}) {
802 # we ignore any errors, as it is very common to receive
803 # Content-Length != 0 but no actual body
804 # we also access %hdr, as $_[1] might be an erro
805 http_request (
806 $method => $hdr{location},
807 %arg,
808 recurse => $recurse - 1,
809 Redirect => [$_[0], \%hdr],
810 $cb);
811 } else {
812 $cb->($_[0], \%hdr);
813 }
814 };
815
816 $ae_error = 597; # body phase
817
818 my $len = $hdr{"content-length"};
819
820 if (!$redirect && $arg{on_header} && !$arg{on_header}(\%hdr)) {
821 $finish->(undef, 598 => "Request cancelled by on_header");
822 } elsif (
823 $hdr{Status} =~ /^(?:1..|204|205|304)$/
824 or $method eq "HEAD"
825 or (defined $len && !$len)
826 ) {
827 # no body
828 $finish->("", undef, undef, 1);
829 } else {
830 # body handling, many different code paths
831 # - no body expected
832 # - want_body_handle
833 # - te chunked
834 # - 2x length known (with or without on_body)
835 # - 2x length not known (with or without on_body)
836 if (!$redirect && $arg{want_body_handle}) {
837 $_[0]->on_eof (undef);
838 $_[0]->on_error (undef);
839 $_[0]->on_read (undef);
840
841 $finish->(delete $state{handle});
842
843 } elsif ($hdr{"transfer-encoding"} =~ /\bchunked\b/i) {
844 my $cl = 0;
845 my $body = undef;
846 my $on_body = $arg{on_body} || sub { $body .= shift; 1 };
847
848 my $read_chunk; $read_chunk = sub {
849 $_[1] =~ /^([0-9a-fA-F]+)/
850 or $finish->(undef, $ae_error => "Garbled chunked transfer encoding");
851
852 my $len = hex $1;
853
854 if ($len) {
855 $cl += $len;
856
857 $_[0]->push_read (chunk => $len, sub {
858 $on_body->($_[1], \%hdr)
859 or return $finish->(undef, 598 => "Request cancelled by on_body");
860
861 $_[0]->push_read (line => sub {
862 length $_[1]
863 and return $finish->(undef, $ae_error => "Garbled chunked transfer encoding");
864 $_[0]->push_read (line => $read_chunk);
865 });
866 });
867 } else {
868 $hdr{"content-length"} ||= $cl;
869
870 $_[0]->push_read (line => $qr_nlnl, sub {
871 if (length $_[1]) {
872 for ("$_[1]") {
873 y/\015//d; # weed out any \015, as they show up in the weirdest of places.
874
875 my $hdr = parse_hdr
876 or return $finish->(undef, $ae_error => "Garbled response trailers");
877
878 %hdr = (%hdr, %$hdr);
879 }
880 }
881
882 $finish->($body, undef, undef, 1);
883 });
884 }
885 };
886
887 $_[0]->push_read (line => $read_chunk);
888
889 } elsif ($arg{on_body}) {
890 if ($len) {
891 $_[0]->on_read (sub {
892 $len -= length $_[0]{rbuf};
893
894 $arg{on_body}(delete $_[0]{rbuf}, \%hdr)
895 or return $finish->(undef, 598 => "Request cancelled by on_body");
896
897 $len > 0
898 or $finish->("", undef, undef, 1);
899 });
900 } else {
901 $_[0]->on_eof (sub {
902 $finish->("");
903 });
904 $_[0]->on_read (sub {
905 $arg{on_body}(delete $_[0]{rbuf}, \%hdr)
906 or $finish->(undef, 598 => "Request cancelled by on_body");
907 });
908 }
909 } else {
910 $_[0]->on_eof (undef);
911
912 if ($len) {
913 $_[0]->on_read (sub {
914 $finish->((substr delete $_[0]{rbuf}, 0, $len, ""), undef, undef, 1)
915 if $len <= length $_[0]{rbuf};
916 });
917 } else {
918 $_[0]->on_error (sub {
919 ($! == Errno::EPIPE || !$!)
920 ? $finish->(delete $_[0]{rbuf})
921 : $finish->(undef, $ae_error => $_[2]);
922 });
923 $_[0]->on_read (sub { });
924 }
925 }
926 }
927 };
928
929 $state{handle}->push_read (line => $qr_nlnl, $state{read_response});
930 };
931
932 # now handle proxy-CONNECT method
933 if ($proxy && $uscheme eq "https") {
934 # oh dear, we have to wrap it into a connect request
935
936 # maybe re-use $uauthority with patched port?
937 $state{handle}->push_write ("CONNECT $uhost:$uport HTTP/1.0\015\012Host: $uhost\015\012\015\012");
938 $state{handle}->push_read (line => $qr_nlnl, sub {
939 $_[1] =~ /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\015\012]*) )?/ix
940 or return (%state = (), $cb->(undef, { @pseudo, Status => 599, Reason => "Invalid proxy connect response ($_[1])" }));
941
942 if ($2 == 200) {
943 $rpath = $upath;
944 &$handle_actual_request; 1215 $handle_actual_request->();
945 } else { 1216
946 %state = ();
947 $cb->(undef, { @pseudo, Status => $2, Reason => $3 });
948 }
949 });
950 } else { 1217 } else {
951 &$handle_actual_request;
952 }
953 };
954
955 my $tcp_connect = $arg{tcp_connect} 1218 my $tcp_connect = $arg{tcp_connect}
956 || do { require AnyEvent::Socket; \&AnyEvent::Socket::tcp_connect }; 1219 || do { require AnyEvent::Socket; \&AnyEvent::Socket::tcp_connect };
957 1220
958 $state{connect_guard} = $tcp_connect->($rhost, $rport, $connect_cb, $arg{on_prepare} || sub { $timeout }); 1221 $state{connect_guard} = $tcp_connect->($rhost, $rport, $connect_cb, $arg{on_prepare} || sub { $timeout });
959 1222 }
960 }; 1223 };
961 1224
962 defined wantarray && AnyEvent::Util::guard { %state = () } 1225 defined wantarray && AnyEvent::Util::guard { _destroy_state %state }
963} 1226}
964 1227
965sub http_get($@) { 1228sub http_get($@) {
966 unshift @_, "GET"; 1229 unshift @_, "GET";
967 &http_request 1230 &http_request
985AnyEvent::HTTP uses the AnyEvent::Socket::tcp_connect function for 1248AnyEvent::HTTP uses the AnyEvent::Socket::tcp_connect function for
986the actual connection, which in turn uses AnyEvent::DNS to resolve 1249the actual connection, which in turn uses AnyEvent::DNS to resolve
987hostnames. The latter is a simple stub resolver and does no caching 1250hostnames. The latter is a simple stub resolver and does no caching
988on its own. If you want DNS caching, you currently have to provide 1251on its own. If you want DNS caching, you currently have to provide
989your own default resolver (by storing a suitable resolver object in 1252your own default resolver (by storing a suitable resolver object in
990C<$AnyEvent::DNS::RESOLVER>). 1253C<$AnyEvent::DNS::RESOLVER>) or your own C<tcp_connect> callback.
991 1254
992=head2 GLOBAL FUNCTIONS AND VARIABLES 1255=head2 GLOBAL FUNCTIONS AND VARIABLES
993 1256
994=over 4 1257=over 4
995 1258
996=item AnyEvent::HTTP::set_proxy "proxy-url" 1259=item AnyEvent::HTTP::set_proxy "proxy-url"
997 1260
998Sets the default proxy server to use. The proxy-url must begin with a 1261Sets the default proxy server to use. The proxy-url must begin with a
999string of the form C<http://host:port> (optionally C<https:...>), croaks 1262string of the form C<http://host:port>, croaks otherwise.
1000otherwise.
1001 1263
1002To clear an already-set proxy, use C<undef>. 1264To clear an already-set proxy, use C<undef>.
1265
1266When AnyEvent::HTTP is loaded for the first time it will query the
1267default proxy from the operating system, currently by looking at
1268C<$ENV{http_proxy>}.
1003 1269
1004=item AnyEvent::HTTP::cookie_jar_expire $jar[, $session_end] 1270=item AnyEvent::HTTP::cookie_jar_expire $jar[, $session_end]
1005 1271
1006Remove all cookies from the cookie jar that have been expired. If 1272Remove all cookies from the cookie jar that have been expired. If
1007C<$session_end> is given and true, then additionally remove all session 1273C<$session_end> is given and true, then additionally remove all session
1008cookies. 1274cookies.
1009 1275
1010You should call this function (with a true C<$session_end>) before you 1276You should call this function (with a true C<$session_end>) before you
1011save cookies to disk, and you should call this function after loading them 1277save cookies to disk, and you should call this function after loading them
1012again. If you have a long-running program you can additonally call this 1278again. If you have a long-running program you can additionally call this
1013function from time to time. 1279function from time to time.
1014 1280
1015A cookie jar is initially an empty hash-reference that is managed by this 1281A cookie jar is initially an empty hash-reference that is managed by this
1016module. It's format is subject to change, but currently it is like this: 1282module. It's format is subject to change, but currently it is like this:
1017 1283
1018The key C<version> has to contain C<1>, otherwise the hash gets 1284The key C<version> has to contain C<1>, otherwise the hash gets
1019emptied. All other keys are hostnames or IP addresses pointing to 1285emptied. All other keys are hostnames or IP addresses pointing to
1020hash-references. The key for these inner hash references is the 1286hash-references. The key for these inner hash references is the
1021server path for which this cookie is meant, and the values are again 1287server path for which this cookie is meant, and the values are again
1022hash-references. The keys of those hash-references is the cookie name, and 1288hash-references. Each key of those hash-references is a cookie name, and
1023the value, you guessed it, is another hash-reference, this time with the 1289the value, you guessed it, is another hash-reference, this time with the
1024key-value pairs from the cookie, except for C<expires> and C<max-age>, 1290key-value pairs from the cookie, except for C<expires> and C<max-age>,
1025which have been replaced by a C<_expires> key that contains the cookie 1291which have been replaced by a C<_expires> key that contains the cookie
1026expiry timestamp. 1292expiry timestamp. Session cookies are indicated by not having an
1293C<_expires> key.
1027 1294
1028Here is an example of a cookie jar with a single cookie, so you have a 1295Here is an example of a cookie jar with a single cookie, so you have a
1029chance of understanding the above paragraph: 1296chance of understanding the above paragraph:
1030 1297
1031 { 1298 {
1053 1320
1054=item $AnyEvent::HTTP::MAX_RECURSE 1321=item $AnyEvent::HTTP::MAX_RECURSE
1055 1322
1056The default value for the C<recurse> request parameter (default: C<10>). 1323The default value for the C<recurse> request parameter (default: C<10>).
1057 1324
1325=item $AnyEvent::HTTP::TIMEOUT
1326
1327The default timeout for connection operations (default: C<300>).
1328
1058=item $AnyEvent::HTTP::USERAGENT 1329=item $AnyEvent::HTTP::USERAGENT
1059 1330
1060The default value for the C<User-Agent> header (the default is 1331The default value for the C<User-Agent> header (the default is
1061C<Mozilla/5.0 (compatible; U; AnyEvent-HTTP/$VERSION; +http://software.schmorp.de/pkg/AnyEvent)>). 1332C<Mozilla/5.0 (compatible; U; AnyEvent-HTTP/$VERSION; +http://software.schmorp.de/pkg/AnyEvent)>).
1062 1333
1063=item $AnyEvent::HTTP::MAX_PER_HOST 1334=item $AnyEvent::HTTP::MAX_PER_HOST
1064 1335
1065The maximum number of concurrent connections to the same host (identified 1336The maximum number of concurrent connections to the same host (identified
1066by the hostname). If the limit is exceeded, then the additional requests 1337by the hostname). If the limit is exceeded, then the additional requests
1067are queued until previous connections are closed. 1338are queued until previous connections are closed. Both persistent and
1339non-persistent connections are counted in this limit.
1068 1340
1069The default value for this is C<4>, and it is highly advisable to not 1341The default value for this is C<4>, and it is highly advisable to not
1070increase it. 1342increase it much.
1343
1344For comparison: the RFC's recommend 4 non-persistent or 2 persistent
1345connections, older browsers used 2, newer ones (such as firefox 3)
1346typically use 6, and Opera uses 8 because like, they have the fastest
1347browser and give a shit for everybody else on the planet.
1348
1349=item $AnyEvent::HTTP::PERSISTENT_TIMEOUT
1350
1351The time after which idle persistent connections get closed by
1352AnyEvent::HTTP (default: C<3>).
1071 1353
1072=item $AnyEvent::HTTP::ACTIVE 1354=item $AnyEvent::HTTP::ACTIVE
1073 1355
1074The number of active connections. This is not the number of currently 1356The number of active connections. This is not the number of currently
1075running requests, but the number of currently open and non-idle TCP 1357running requests, but the number of currently open and non-idle TCP
1076connections. This number of can be useful for load-leveling. 1358connections. This number can be useful for load-leveling.
1077 1359
1078=back 1360=back
1079 1361
1080=cut 1362=cut
1081 1363
1115 # other formats fail in the loop below 1397 # other formats fail in the loop below
1116 1398
1117 for (0..11) { 1399 for (0..11) {
1118 if ($m eq $month[$_]) { 1400 if ($m eq $month[$_]) {
1119 require Time::Local; 1401 require Time::Local;
1120 return Time::Local::timegm ($S, $M, $H, $d, $_, $y); 1402 return eval { Time::Local::timegm ($S, $M, $H, $d, $_, $y) };
1121 } 1403 }
1122 } 1404 }
1123 1405
1124 undef 1406 undef
1125} 1407}
1126 1408
1127sub set_proxy($) { 1409sub set_proxy($) {
1128 if (length $_[0]) { 1410 if (length $_[0]) {
1129 $_[0] =~ m%^(https?):// ([^:/]+) (?: : (\d*) )?%ix 1411 $_[0] =~ m%^(http):// ([^:/]+) (?: : (\d*) )?%ix
1130 or Carp::croak "$_[0]: invalid proxy URL"; 1412 or Carp::croak "$_[0]: invalid proxy URL";
1131 $PROXY = [$2, $3 || 3128, $1] 1413 $PROXY = [$2, $3 || 3128, $1]
1132 } else { 1414 } else {
1133 undef $PROXY; 1415 undef $PROXY;
1134 } 1416 }
1137# initialise proxy from environment 1419# initialise proxy from environment
1138eval { 1420eval {
1139 set_proxy $ENV{http_proxy}; 1421 set_proxy $ENV{http_proxy};
1140}; 1422};
1141 1423
1424=head2 SHOWCASE
1425
1426This section contains some more elaborate "real-world" examples or code
1427snippets.
1428
1429=head2 HTTP/1.1 FILE DOWNLOAD
1430
1431Downloading files with HTTP can be quite tricky, especially when something
1432goes wrong and you want to resume.
1433
1434Here is a function that initiates and resumes a download. It uses the
1435last modified time to check for file content changes, and works with many
1436HTTP/1.0 servers as well, and usually falls back to a complete re-download
1437on older servers.
1438
1439It calls the completion callback with either C<undef>, which means a
1440nonretryable error occurred, C<0> when the download was partial and should
1441be retried, and C<1> if it was successful.
1442
1443 use AnyEvent::HTTP;
1444
1445 sub download($$$) {
1446 my ($url, $file, $cb) = @_;
1447
1448 open my $fh, "+<", $file
1449 or die "$file: $!";
1450
1451 my %hdr;
1452 my $ofs = 0;
1453
1454 warn stat $fh;
1455 warn -s _;
1456 if (stat $fh and -s _) {
1457 $ofs = -s _;
1458 warn "-s is ", $ofs;
1459 $hdr{"if-unmodified-since"} = AnyEvent::HTTP::format_date +(stat _)[9];
1460 $hdr{"range"} = "bytes=$ofs-";
1461 }
1462
1463 http_get $url,
1464 headers => \%hdr,
1465 on_header => sub {
1466 my ($hdr) = @_;
1467
1468 if ($hdr->{Status} == 200 && $ofs) {
1469 # resume failed
1470 truncate $fh, $ofs = 0;
1471 }
1472
1473 sysseek $fh, $ofs, 0;
1474
1475 1
1476 },
1477 on_body => sub {
1478 my ($data, $hdr) = @_;
1479
1480 if ($hdr->{Status} =~ /^2/) {
1481 length $data == syswrite $fh, $data
1482 or return; # abort on write errors
1483 }
1484
1485 1
1486 },
1487 sub {
1488 my (undef, $hdr) = @_;
1489
1490 my $status = $hdr->{Status};
1491
1492 if (my $time = AnyEvent::HTTP::parse_date $hdr->{"last-modified"}) {
1493 utime $fh, $time, $time;
1494 }
1495
1496 if ($status == 200 || $status == 206 || $status == 416) {
1497 # download ok || resume ok || file already fully downloaded
1498 $cb->(1, $hdr);
1499
1500 } elsif ($status == 412) {
1501 # file has changed while resuming, delete and retry
1502 unlink $file;
1503 $cb->(0, $hdr);
1504
1505 } elsif ($status == 500 or $status == 503 or $status =~ /^59/) {
1506 # retry later
1507 $cb->(0, $hdr);
1508
1509 } else {
1510 $cb->(undef, $hdr);
1511 }
1512 }
1513 ;
1514 }
1515
1516 download "http://server/somelargefile", "/tmp/somelargefile", sub {
1517 if ($_[0]) {
1518 print "OK!\n";
1519 } elsif (defined $_[0]) {
1520 print "please retry later\n";
1521 } else {
1522 print "ERROR\n";
1523 }
1524 };
1525
1142=head2 SOCKS PROXIES 1526=head3 SOCKS PROXIES
1143 1527
1144Socks proxies are not directly supported by AnyEvent::HTTP. You can 1528Socks proxies are not directly supported by AnyEvent::HTTP. You can
1145compile your perl to support socks, or use an external program such as 1529compile your perl to support socks, or use an external program such as
1146F<socksify> (dante) or F<tsocks> to make your program use a socks proxy 1530F<socksify> (dante) or F<tsocks> to make your program use a socks proxy
1147transparently. 1531transparently.

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines