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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines