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.138 by root, Fri Aug 5 20:45:09 2022 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.25;
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 QUERY => 1,
722 HEAD => 1,
723 OPTIONS => 1,
724 PUT => 1,
725 TRACE => 1,
726
727 ACL => 1,
728 "BASELINE-CONTROL" => 1,
729 BIND => 1,
730 CHECKIN => 1,
731 CHECKOUT => 1,
732 COPY => 1,
733 LABEL => 1,
734 LINK => 1,
735 MERGE => 1,
736 MKACTIVITY => 1,
737 MKCALENDAR => 1,
738 MKCOL => 1,
739 MKREDIRECTREF => 1,
740 MKWORKSPACE => 1,
741 MOVE => 1,
742 ORDERPATCH => 1,
743 PROPFIND => 1,
744 PROPPATCH => 1,
745 REBIND => 1,
746 REPORT => 1,
747 SEARCH => 1,
748 UNBIND => 1,
749 UNCHECKOUT => 1,
750 UNLINK => 1,
751 UNLOCK => 1,
752 UPDATE => 1,
753 UPDATEREDIRECTREF => 1,
754 "VERSION-CONTROL" => 1,
755);
527 756
528sub http_request($$@) { 757sub http_request($$@) {
529 my $cb = pop; 758 my $cb = pop;
530 my ($method, $url, %arg) = @_; 759 my ($method, $url, %arg) = @_;
531 760
549 my $recurse = exists $arg{recurse} ? delete $arg{recurse} : $MAX_RECURSE; 778 my $recurse = exists $arg{recurse} ? delete $arg{recurse} : $MAX_RECURSE;
550 779
551 return $cb->(undef, { @pseudo, Status => 599, Reason => "Too many redirections" }) 780 return $cb->(undef, { @pseudo, Status => 599, Reason => "Too many redirections" })
552 if $recurse < 0; 781 if $recurse < 0;
553 782
554 my $proxy = $arg{proxy} || $PROXY; 783 my $proxy = exists $arg{proxy} ? $arg{proxy} : $PROXY;
555 my $timeout = $arg{timeout} || $TIMEOUT; 784 my $timeout = $arg{timeout} || $TIMEOUT;
556 785
557 my ($uscheme, $uauthority, $upath, $query, $fragment) = 786 my ($uscheme, $uauthority, $upath, $query, undef) = # ignore fragment
558 $url =~ m|(?:([^:/?#]+):)?(?://([^/?#]*))?([^?#]*)(?:(\?[^#]*))?(?:#(.*))?|; 787 $url =~ m|^([^:]+):(?://([^/?#]*))?([^?#]*)(?:(\?[^#]*))?(?:#(.*))?$|;
559 788
560 $uscheme = lc $uscheme; 789 $uscheme = lc $uscheme;
561 790
562 my $uport = $uscheme eq "http" ? 80 791 my $uport = $uscheme eq "http" ? 80
563 : $uscheme eq "https" ? 443 792 : $uscheme eq "https" ? 443
564 : return $cb->(undef, { @pseudo, Status => 599, Reason => "Only http and https URL schemes supported" }); 793 : return $cb->(undef, { @pseudo, Status => 599, Reason => "Only http and https URL schemes supported" });
565 794
566 $uauthority =~ /^(?: .*\@ )? ([^\@:]+) (?: : (\d+) )?$/x 795 $uauthority =~ /^(?: .*\@ )? ([^\@]+?) (?: : (\d+) )?$/x
567 or return $cb->(undef, { @pseudo, Status => 599, Reason => "Unparsable URL" }); 796 or return $cb->(undef, { @pseudo, Status => 599, Reason => "Unparsable URL" });
568 797
569 my $uhost = $1; 798 my $uhost = lc $1;
570 $uport = $2 if defined $2; 799 $uport = $2 if defined $2;
571 800
572 $hdr{host} = defined $2 ? "$uhost:$2" : "$uhost" 801 $hdr{host} = defined $2 ? "$uhost:$2" : "$uhost"
573 unless exists $hdr{host}; 802 unless exists $hdr{host};
574 803
593 $rscheme = "http" unless defined $rscheme; 822 $rscheme = "http" unless defined $rscheme;
594 823
595 # don't support https requests over https-proxy transport, 824 # don't support https requests over https-proxy transport,
596 # can't be done with tls as spec'ed, unless you double-encrypt. 825 # can't be done with tls as spec'ed, unless you double-encrypt.
597 $rscheme = "http" if $uscheme eq "https" && $rscheme eq "https"; 826 $rscheme = "http" if $uscheme eq "https" && $rscheme eq "https";
827
828 $rhost = lc $rhost;
829 $rscheme = lc $rscheme;
598 } else { 830 } else {
599 ($rhost, $rport, $rscheme, $rpath) = ($uhost, $uport, $uscheme, $upath); 831 ($rhost, $rport, $rscheme, $rpath) = ($uhost, $uport, $uscheme, $upath);
600 } 832 }
601 833
602 # leave out fragment and query string, just a heuristic 834 # leave out fragment and query string, just a heuristic
604 $hdr{"user-agent"} = $USERAGENT unless exists $hdr{"user-agent"}; 836 $hdr{"user-agent"} = $USERAGENT unless exists $hdr{"user-agent"};
605 837
606 $hdr{"content-length"} = length $arg{body} 838 $hdr{"content-length"} = length $arg{body}
607 if length $arg{body} || $method ne "GET"; 839 if length $arg{body} || $method ne "GET";
608 840
609 $hdr{connection} = "close TE"; #1.1 841 my $idempotent = $IDEMPOTENT{$method};
842
843 # default value for keepalive is true iff the request is for an idempotent method
844 my $persistent = exists $arg{persistent} ? !!$arg{persistent} : $idempotent;
845 my $keepalive = exists $arg{keepalive} ? !!$arg{keepalive} : !$proxy;
846 my $was_persistent; # true if this is actually a recycled connection
847
848 # the key to use in the keepalive cache
849 my $ka_key = "$uscheme\x00$uhost\x00$uport\x00$arg{sessionid}";
850
851 $hdr{connection} = ($persistent ? $keepalive ? "keep-alive, " : "" : "close, ") . "Te"; #1.1
610 $hdr{te} = "trailers" unless exists $hdr{te}; #1.1 852 $hdr{te} = "trailers" unless exists $hdr{te}; #1.1
611 853
612 my %state = (connect_guard => 1); 854 my %state = (connect_guard => 1);
855
856 my $ae_error = 595; # connecting
857
858 # handle actual, non-tunneled, request
859 my $handle_actual_request = sub {
860 $ae_error = 596; # request phase
861
862 my $hdl = $state{handle};
863
864 $hdl->starttls ("connect") if $uscheme eq "https" && !exists $hdl->{tls};
865
866 # send request
867 $hdl->push_write (
868 "$method $rpath HTTP/1.1\015\012"
869 . (join "", map "\u$_: $hdr{$_}\015\012", grep defined $hdr{$_}, keys %hdr)
870 . "\015\012"
871 . $arg{body}
872 );
873
874 # return if error occurred during push_write()
875 return unless %state;
876
877 # reduce memory usage, save a kitten, also re-use it for the response headers.
878 %hdr = ();
879
880 # status line and headers
881 $state{read_response} = sub {
882 return unless %state;
883
884 for ("$_[1]") {
885 y/\015//d; # weed out any \015, as they show up in the weirdest of places.
886
887 /^HTTP\/0*([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\012]*) )? \012/gxci
888 or return _error %state, $cb, { @pseudo, Status => 599, Reason => "Invalid server response" };
889
890 # 100 Continue handling
891 # should not happen as we don't send expect: 100-continue,
892 # but we handle it just in case.
893 # since we send the request body regardless, if we get an error
894 # we are out of-sync, which we currently do NOT handle correctly.
895 return $state{handle}->push_read (line => $qr_nlnl, $state{read_response})
896 if $2 eq 100;
897
898 push @pseudo,
899 HTTPVersion => $1,
900 Status => $2,
901 Reason => $3,
902 ;
903
904 my $hdr = _parse_hdr
905 or return _error %state, $cb, { @pseudo, Status => 599, Reason => "Garbled response headers" };
906
907 %hdr = (%$hdr, @pseudo);
908 }
909
910 # redirect handling
911 # relative uri handling forced by microsoft and other shitheads.
912 # we give our best and fall back to URI if available.
913 if (exists $hdr{location}) {
914 my $loc = $hdr{location};
915
916 if ($loc =~ m%^//%) { # //
917 $loc = "$uscheme:$loc";
918
919 } elsif ($loc eq "") {
920 $loc = $url;
921
922 } elsif ($loc !~ /^(?: $ | [^:\/?\#]+ : )/x) { # anything "simple"
923 $loc =~ s/^\.\/+//;
924
925 if ($loc !~ m%^[.?#]%) {
926 my $prefix = "$uscheme://$uauthority";
927
928 unless ($loc =~ s/^\///) {
929 $prefix .= $upath;
930 $prefix =~ s/\/[^\/]*$//;
931 }
932
933 $loc = "$prefix/$loc";
934
935 } elsif (eval { require URI }) { # uri
936 $loc = URI->new_abs ($loc, $url)->as_string;
937
938 } else {
939 return _error %state, $cb, { @pseudo, Status => 599, Reason => "Cannot parse Location (URI module missing)" };
940 #$hdr{Status} = 599;
941 #$hdr{Reason} = "Unparsable Redirect (URI module missing)";
942 #$recurse = 0;
943 }
944 }
945
946 $hdr{location} = $loc;
947 }
948
949 my $redirect;
950
951 if ($recurse) {
952 my $status = $hdr{Status};
953
954 # industry standard is to redirect POST as GET for
955 # 301, 302 and 303, in contrast to HTTP/1.0 and 1.1.
956 # also, the UA should ask the user for 301 and 307 and POST,
957 # industry standard seems to be to simply follow.
958 # we go with the industry standard. 308 is defined
959 # by rfc7538
960 if ($status == 301 or $status == 302 or $status == 303) {
961 $redirect = 1;
962 # HTTP/1.1 is unclear on how to mutate the method
963 unless ($method eq "HEAD") {
964 $method = "GET";
965 delete $arg{body};
966 }
967 } elsif ($status == 307 or $status == 308) {
968 $redirect = 1;
969 }
970 }
971
972 my $finish = sub { # ($data, $err_status, $err_reason[, $persistent])
973 if ($state{handle}) {
974 # handle keepalive
975 if (
976 $persistent
977 && $_[3]
978 && ($hdr{HTTPVersion} < 1.1
979 ? $hdr{connection} =~ /\bkeep-?alive\b/i
980 : $hdr{connection} !~ /\bclose\b/i)
981 ) {
982 ka_store $ka_key, delete $state{handle};
983 } else {
984 # no keepalive, destroy the handle
985 $state{handle}->destroy;
986 }
987 }
988
989 %state = ();
990
991 if (defined $_[1]) {
992 $hdr{OrigStatus} = $hdr{Status}; $hdr{Status} = $_[1];
993 $hdr{OrigReason} = $hdr{Reason}; $hdr{Reason} = $_[2];
994 }
995
996 # set-cookie processing
997 if ($arg{cookie_jar}) {
998 cookie_jar_set_cookie $arg{cookie_jar}, $hdr{"set-cookie"}, $uhost, $hdr{date};
999 }
1000
1001 if ($redirect && exists $hdr{location}) {
1002 # we ignore any errors, as it is very common to receive
1003 # Content-Length != 0 but no actual body
1004 # we also access %hdr, as $_[1] might be an erro
1005 $state{recurse} =
1006 http_request (
1007 $method => $hdr{location},
1008 %arg,
1009 recurse => $recurse - 1,
1010 Redirect => [$_[0], \%hdr],
1011 sub {
1012 %state = ();
1013 &$cb
1014 },
1015 );
1016 } else {
1017 $cb->($_[0], \%hdr);
1018 }
1019 };
1020
1021 $ae_error = 597; # body phase
1022
1023 my $chunked = $hdr{"transfer-encoding"} =~ /\bchunked\b/i; # not quite correct...
1024
1025 my $len = $chunked ? undef : $hdr{"content-length"};
1026
1027 # body handling, many different code paths
1028 # - no body expected
1029 # - want_body_handle
1030 # - te chunked
1031 # - 2x length known (with or without on_body)
1032 # - 2x length not known (with or without on_body)
1033 if (!$redirect && $arg{on_header} && !$arg{on_header}(\%hdr)) {
1034 $finish->(undef, 598 => "Request cancelled by on_header");
1035 } elsif (
1036 $hdr{Status} =~ /^(?:1..|204|205|304)$/
1037 or $method eq "HEAD"
1038 or (defined $len && $len == 0) # == 0, not !, because "0 " is true
1039 ) {
1040 # no body
1041 $finish->("", undef, undef, 1);
1042
1043 } elsif (!$redirect && $arg{want_body_handle}) {
1044 $_[0]->on_eof (undef);
1045 $_[0]->on_error (undef);
1046 $_[0]->on_read (undef);
1047
1048 $finish->(delete $state{handle});
1049
1050 } elsif ($chunked) {
1051 my $cl = 0;
1052 my $body = "";
1053 my $on_body = (!$redirect && $arg{on_body}) || sub { $body .= shift; 1 };
1054
1055 $state{read_chunk} = sub {
1056 $_[1] =~ /^([0-9a-fA-F]+)/
1057 or return $finish->(undef, $ae_error => "Garbled chunked transfer encoding");
1058
1059 my $len = hex $1;
1060
1061 if ($len) {
1062 $cl += $len;
1063
1064 $_[0]->push_read (chunk => $len, sub {
1065 $on_body->($_[1], \%hdr)
1066 or return $finish->(undef, 598 => "Request cancelled by on_body");
1067
1068 $_[0]->push_read (line => sub {
1069 length $_[1]
1070 and return $finish->(undef, $ae_error => "Garbled chunked transfer encoding");
1071 $_[0]->push_read (line => $state{read_chunk});
1072 });
1073 });
1074 } else {
1075 $hdr{"content-length"} ||= $cl;
1076
1077 $_[0]->push_read (line => $qr_nlnl, sub {
1078 if (length $_[1]) {
1079 for ("$_[1]") {
1080 y/\015//d; # weed out any \015, as they show up in the weirdest of places.
1081
1082 my $hdr = _parse_hdr
1083 or return $finish->(undef, $ae_error => "Garbled response trailers");
1084
1085 %hdr = (%hdr, %$hdr);
1086 }
1087 }
1088
1089 $finish->($body, undef, undef, 1);
1090 });
1091 }
1092 };
1093
1094 $_[0]->push_read (line => $state{read_chunk});
1095
1096 } elsif (!$redirect && $arg{on_body}) {
1097 if (defined $len) {
1098 $_[0]->on_read (sub {
1099 $len -= length $_[0]{rbuf};
1100
1101 $arg{on_body}(delete $_[0]{rbuf}, \%hdr)
1102 or return $finish->(undef, 598 => "Request cancelled by on_body");
1103
1104 $len > 0
1105 or $finish->("", undef, undef, 1);
1106 });
1107 } else {
1108 $_[0]->on_eof (sub {
1109 $finish->("");
1110 });
1111 $_[0]->on_read (sub {
1112 $arg{on_body}(delete $_[0]{rbuf}, \%hdr)
1113 or $finish->(undef, 598 => "Request cancelled by on_body");
1114 });
1115 }
1116 } else {
1117 $_[0]->on_eof (undef);
1118
1119 if (defined $len) {
1120 $_[0]->on_read (sub {
1121 $finish->((substr delete $_[0]{rbuf}, 0, $len, ""), undef, undef, 1)
1122 if $len <= length $_[0]{rbuf};
1123 });
1124 } else {
1125 $_[0]->on_error (sub {
1126 ($! == Errno::EPIPE || !$!)
1127 ? $finish->(delete $_[0]{rbuf})
1128 : $finish->(undef, $ae_error => $_[2]);
1129 });
1130 $_[0]->on_read (sub { });
1131 }
1132 }
1133 };
1134
1135 # if keepalive is enabled, then the server closing the connection
1136 # before a response can happen legally - we retry on idempotent methods.
1137 if ($was_persistent && $idempotent) {
1138 my $old_eof = $hdl->{on_eof};
1139 $hdl->{on_eof} = sub {
1140 _destroy_state %state;
1141
1142 %state = ();
1143 $state{recurse} =
1144 http_request (
1145 $method => $url,
1146 %arg,
1147 recurse => $recurse - 1,
1148 persistent => 0,
1149 sub {
1150 %state = ();
1151 &$cb
1152 }
1153 );
1154 };
1155 $hdl->on_read (sub {
1156 return unless %state;
1157
1158 # as soon as we receive something, a connection close
1159 # once more becomes a hard error
1160 $hdl->{on_eof} = $old_eof;
1161 $hdl->push_read (line => $qr_nlnl, $state{read_response});
1162 });
1163 } else {
1164 $hdl->push_read (line => $qr_nlnl, $state{read_response});
1165 }
1166 };
1167
1168 my $prepare_handle = sub {
1169 my ($hdl) = $state{handle};
1170
1171 $hdl->on_error (sub {
1172 _error %state, $cb, { @pseudo, Status => $ae_error, Reason => $_[2] };
1173 });
1174 $hdl->on_eof (sub {
1175 _error %state, $cb, { @pseudo, Status => $ae_error, Reason => "Unexpected end-of-file" };
1176 });
1177 $hdl->timeout_reset;
1178 $hdl->timeout ($timeout);
1179 };
1180
1181 # connected to proxy (or origin server)
1182 my $connect_cb = sub {
1183 my $fh = shift
1184 or return _error %state, $cb, { @pseudo, Status => $ae_error, Reason => "$!" };
1185
1186 return unless delete $state{connect_guard};
1187
1188 # get handle
1189 $state{handle} = new AnyEvent::Handle
1190 %{ $arg{handle_params} },
1191 fh => $fh,
1192 peername => $uhost,
1193 tls_ctx => $arg{tls_ctx},
1194 ;
1195
1196 $prepare_handle->();
1197
1198 #$state{handle}->starttls ("connect") if $rscheme eq "https";
1199
1200 # now handle proxy-CONNECT method
1201 if ($proxy && $uscheme eq "https") {
1202 # oh dear, we have to wrap it into a connect request
1203
1204 my $auth = exists $hdr{"proxy-authorization"}
1205 ? "proxy-authorization: " . (delete $hdr{"proxy-authorization"}) . "\015\012"
1206 : "";
1207
1208 # maybe re-use $uauthority with patched port?
1209 $state{handle}->push_write ("CONNECT $uhost:$uport HTTP/1.0\015\012$auth\015\012");
1210 $state{handle}->push_read (line => $qr_nlnl, sub {
1211 $_[1] =~ /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\015\012]*) )?/ix
1212 or return _error %state, $cb, { @pseudo, Status => 599, Reason => "Invalid proxy connect response ($_[1])" };
1213
1214 if ($2 == 200) {
1215 $rpath = $upath;
1216 $handle_actual_request->();
1217 } else {
1218 _error %state, $cb, { @pseudo, Status => $2, Reason => $3 };
1219 }
1220 });
1221 } else {
1222 delete $hdr{"proxy-authorization"} unless $proxy;
1223
1224 $handle_actual_request->();
1225 }
1226 };
613 1227
614 _get_slot $uhost, sub { 1228 _get_slot $uhost, sub {
615 $state{slot_guard} = shift; 1229 $state{slot_guard} = shift;
616 1230
617 return unless $state{connect_guard}; 1231 return unless $state{connect_guard};
618 1232
619 my $ae_error = 595; # connecting 1233 # try to use an existing keepalive connection, but only if we, ourselves, plan
1234 # on a keepalive request (in theory, this should be a separate config option).
1235 if ($persistent && $KA_CACHE{$ka_key}) {
1236 $was_persistent = 1;
620 1237
621 my $connect_cb = sub { 1238 $state{handle} = ka_fetch $ka_key;
622 $state{fh} = shift 1239# $state{handle}->destroyed
623 or do { 1240# and die "AnyEvent::HTTP: unexpectedly got a destructed handle (1), please report.";#d#
624 my $err = "$!"; 1241 $prepare_handle->();
625 %state = (); 1242# $state{handle}->destroyed
626 return $cb->(undef, { @pseudo, Status => $ae_error, Reason => $err }); 1243# 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; 1244 $rpath = $upath;
901 &$handle_actual_request; 1245 $handle_actual_request->();
902 } else { 1246
903 %state = ();
904 $cb->(undef, { @pseudo, Status => $2, Reason => $3 });
905 }
906 });
907 } else { 1247 } else {
908 &$handle_actual_request;
909 }
910 };
911
912 my $tcp_connect = $arg{tcp_connect} 1248 my $tcp_connect = $arg{tcp_connect}
913 || do { require AnyEvent::Socket; \&AnyEvent::Socket::tcp_connect }; 1249 || do { require AnyEvent::Socket; \&AnyEvent::Socket::tcp_connect };
914 1250
915 $state{connect_guard} = $tcp_connect->($rhost, $rport, $connect_cb, $arg{on_prepare} || sub { $timeout }); 1251 $state{connect_guard} = $tcp_connect->($rhost, $rport, $connect_cb, $arg{on_prepare} || sub { $timeout });
916 1252 }
917 }; 1253 };
918 1254
919 defined wantarray && AnyEvent::Util::guard { %state = () } 1255 defined wantarray && AnyEvent::Util::guard { _destroy_state %state }
920} 1256}
921 1257
922sub http_get($@) { 1258sub http_get($@) {
923 unshift @_, "GET"; 1259 unshift @_, "GET";
924 &http_request 1260 &http_request
942AnyEvent::HTTP uses the AnyEvent::Socket::tcp_connect function for 1278AnyEvent::HTTP uses the AnyEvent::Socket::tcp_connect function for
943the actual connection, which in turn uses AnyEvent::DNS to resolve 1279the actual connection, which in turn uses AnyEvent::DNS to resolve
944hostnames. The latter is a simple stub resolver and does no caching 1280hostnames. The latter is a simple stub resolver and does no caching
945on its own. If you want DNS caching, you currently have to provide 1281on its own. If you want DNS caching, you currently have to provide
946your own default resolver (by storing a suitable resolver object in 1282your own default resolver (by storing a suitable resolver object in
947C<$AnyEvent::DNS::RESOLVER>). 1283C<$AnyEvent::DNS::RESOLVER>) or your own C<tcp_connect> callback.
948 1284
949=head2 GLOBAL FUNCTIONS AND VARIABLES 1285=head2 GLOBAL FUNCTIONS AND VARIABLES
950 1286
951=over 4 1287=over 4
952 1288
953=item AnyEvent::HTTP::set_proxy "proxy-url" 1289=item AnyEvent::HTTP::set_proxy "proxy-url"
954 1290
955Sets the default proxy server to use. The proxy-url must begin with a 1291Sets 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 1292string of the form C<http://host:port>, croaks otherwise.
957otherwise.
958 1293
959To clear an already-set proxy, use C<undef>. 1294To clear an already-set proxy, use C<undef>.
1295
1296When AnyEvent::HTTP is loaded for the first time it will query the
1297default proxy from the operating system, currently by looking at
1298C<$ENV{http_proxy>}.
1299
1300=item AnyEvent::HTTP::cookie_jar_expire $jar[, $session_end]
1301
1302Remove all cookies from the cookie jar that have been expired. If
1303C<$session_end> is given and true, then additionally remove all session
1304cookies.
1305
1306You should call this function (with a true C<$session_end>) before you
1307save cookies to disk, and you should call this function after loading them
1308again. If you have a long-running program you can additionally call this
1309function from time to time.
1310
1311A cookie jar is initially an empty hash-reference that is managed by this
1312module. Its format is subject to change, but currently it is as follows:
1313
1314The key C<version> has to contain C<2>, otherwise the hash gets
1315cleared. All other keys are hostnames or IP addresses pointing to
1316hash-references. The key for these inner hash references is the
1317server path for which this cookie is meant, and the values are again
1318hash-references. Each key of those hash-references is a cookie name, and
1319the value, you guessed it, is another hash-reference, this time with the
1320key-value pairs from the cookie, except for C<expires> and C<max-age>,
1321which have been replaced by a C<_expires> key that contains the cookie
1322expiry timestamp. Session cookies are indicated by not having an
1323C<_expires> key.
1324
1325Here is an example of a cookie jar with a single cookie, so you have a
1326chance of understanding the above paragraph:
1327
1328 {
1329 version => 2,
1330 "10.0.0.1" => {
1331 "/" => {
1332 "mythweb_id" => {
1333 _expires => 1293917923,
1334 value => "ooRung9dThee3ooyXooM1Ohm",
1335 },
1336 },
1337 },
1338 }
960 1339
961=item $date = AnyEvent::HTTP::format_date $timestamp 1340=item $date = AnyEvent::HTTP::format_date $timestamp
962 1341
963Takes a POSIX timestamp (seconds since the epoch) and formats it as a HTTP 1342Takes a POSIX timestamp (seconds since the epoch) and formats it as a HTTP
964Date (RFC 2616). 1343Date (RFC 2616).
965 1344
966=item $timestamp = AnyEvent::HTTP::parse_date $date 1345=item $timestamp = AnyEvent::HTTP::parse_date $date
967 1346
968Takes a HTTP Date (RFC 2616) or a Cookie date (netscape cookie spec) and 1347Takes 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 1348bunch of minor variations of those, and returns the corresponding POSIX
970be parsed. 1349timestamp, or C<undef> if the date cannot be parsed.
971 1350
972=item $AnyEvent::HTTP::MAX_RECURSE 1351=item $AnyEvent::HTTP::MAX_RECURSE
973 1352
974The default value for the C<recurse> request parameter (default: C<10>). 1353The default value for the C<recurse> request parameter (default: C<10>).
1354
1355=item $AnyEvent::HTTP::TIMEOUT
1356
1357The default timeout for connection operations (default: C<300>).
975 1358
976=item $AnyEvent::HTTP::USERAGENT 1359=item $AnyEvent::HTTP::USERAGENT
977 1360
978The default value for the C<User-Agent> header (the default is 1361The 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)>). 1362C<Mozilla/5.0 (compatible; U; AnyEvent-HTTP/$VERSION; +http://software.schmorp.de/pkg/AnyEvent)>).
980 1363
981=item $AnyEvent::HTTP::MAX_PER_HOST 1364=item $AnyEvent::HTTP::MAX_PER_HOST
982 1365
983The maximum number of concurrent connections to the same host (identified 1366The maximum number of concurrent connections to the same host (identified
984by the hostname). If the limit is exceeded, then the additional requests 1367by the hostname). If the limit is exceeded, then additional requests
985are queued until previous connections are closed. 1368are queued until previous connections are closed. Both persistent and
1369non-persistent connections are counted in this limit.
986 1370
987The default value for this is C<4>, and it is highly advisable to not 1371The default value for this is C<4>, and it is highly advisable to not
988increase it. 1372increase it much.
1373
1374For comparison: the RFC's recommend 4 non-persistent or 2 persistent
1375connections, older browsers used 2, newer ones (such as firefox 3)
1376typically use 6, and Opera uses 8 because like, they have the fastest
1377browser and give a shit for everybody else on the planet.
1378
1379=item $AnyEvent::HTTP::PERSISTENT_TIMEOUT
1380
1381The time after which idle persistent connections get closed by
1382AnyEvent::HTTP (default: C<3>).
989 1383
990=item $AnyEvent::HTTP::ACTIVE 1384=item $AnyEvent::HTTP::ACTIVE
991 1385
992The number of active connections. This is not the number of currently 1386The number of active connections. This is not the number of currently
993running requests, but the number of currently open and non-idle TCP 1387running requests, but the number of currently open and non-idle TCP
994connections. This number of can be useful for load-leveling. 1388connections. This number can be useful for load-leveling.
995 1389
996=back 1390=back
997 1391
998=cut 1392=cut
999 1393
1014sub parse_date($) { 1408sub parse_date($) {
1015 my ($date) = @_; 1409 my ($date) = @_;
1016 1410
1017 my ($d, $m, $y, $H, $M, $S); 1411 my ($d, $m, $y, $H, $M, $S);
1018 1412
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$/) { 1413 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 " ") 1414 # RFC 822/1123, required by RFC 2616 (with " ")
1021 # cookie dates (with "-") 1415 # cookie dates (with "-")
1022 1416
1023 ($d, $m, $y, $H, $M, $S) = ($1, $2, $3, $4, $5, $6); 1417 ($d, $m, $y, $H, $M, $S) = ($1, $2, $3, $4, $5, $6);
1024 1418
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$/) { 1419 } 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 1420 # RFC 850
1027 ($d, $m, $y, $H, $M, $S) = ($1, $2, $3 < 69 ? $3 + 2000 : $3 + 1900, $4, $5, $6); 1421 ($d, $m, $y, $H, $M, $S) = ($1, $2, $3 < 69 ? $3 + 2000 : $3 + 1900, $4, $5, $6);
1028 1422
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])$/) { 1423 } 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 1424 # ISO C's asctime
1031 ($d, $m, $y, $H, $M, $S) = ($2, $1, $6, $3, $4, $5); 1425 ($d, $m, $y, $H, $M, $S) = ($2, $1, $6, $3, $4, $5);
1032 } 1426 }
1033 # other formats fail in the loop below 1427 # other formats fail in the loop below
1034 1428
1035 for (0..11) { 1429 for (0..11) {
1036 if ($m eq $month[$_]) { 1430 if ($m eq $month[$_]) {
1037 require Time::Local; 1431 require Time::Local;
1038 return Time::Local::timegm ($S, $M, $H, $d, $_, $y); 1432 return eval { Time::Local::timegm ($S, $M, $H, $d, $_, $y) };
1039 } 1433 }
1040 } 1434 }
1041 1435
1042 undef 1436 undef
1043} 1437}
1044 1438
1045sub set_proxy($) { 1439sub set_proxy($) {
1046 if (length $_[0]) { 1440 if (length $_[0]) {
1047 $_[0] =~ m%^(https?):// ([^:/]+) (?: : (\d*) )?%ix 1441 $_[0] =~ m%^(http):// ([^:/]+) (?: : (\d*) )?%ix
1048 or Carp::croak "$_[0]: invalid proxy URL"; 1442 or Carp::croak "$_[0]: invalid proxy URL";
1049 $PROXY = [$2, $3 || 3128, $1] 1443 $PROXY = [$2, $3 || 3128, $1]
1050 } else { 1444 } else {
1051 undef $PROXY; 1445 undef $PROXY;
1052 } 1446 }
1055# initialise proxy from environment 1449# initialise proxy from environment
1056eval { 1450eval {
1057 set_proxy $ENV{http_proxy}; 1451 set_proxy $ENV{http_proxy};
1058}; 1452};
1059 1453
1454=head2 SHOWCASE
1455
1456This section contains some more elaborate "real-world" examples or code
1457snippets.
1458
1459=head2 HTTP/1.1 FILE DOWNLOAD
1460
1461Downloading files with HTTP can be quite tricky, especially when something
1462goes wrong and you want to resume.
1463
1464Here is a function that initiates and resumes a download. It uses the
1465last modified time to check for file content changes, and works with many
1466HTTP/1.0 servers as well, and usually falls back to a complete re-download
1467on older servers.
1468
1469It calls the completion callback with either C<undef>, which means a
1470nonretryable error occurred, C<0> when the download was partial and should
1471be retried, and C<1> if it was successful.
1472
1473 use AnyEvent::HTTP;
1474
1475 sub download($$$) {
1476 my ($url, $file, $cb) = @_;
1477
1478 open my $fh, "+<", $file
1479 or die "$file: $!";
1480
1481 my %hdr;
1482 my $ofs = 0;
1483
1484 if (stat $fh and -s _) {
1485 $ofs = -s _;
1486 warn "-s is ", $ofs;
1487 $hdr{"if-unmodified-since"} = AnyEvent::HTTP::format_date +(stat _)[9];
1488 $hdr{"range"} = "bytes=$ofs-";
1489 }
1490
1491 http_get $url,
1492 headers => \%hdr,
1493 on_header => sub {
1494 my ($hdr) = @_;
1495
1496 if ($hdr->{Status} == 200 && $ofs) {
1497 # resume failed
1498 truncate $fh, $ofs = 0;
1499 }
1500
1501 sysseek $fh, $ofs, 0;
1502
1503 1
1504 },
1505 on_body => sub {
1506 my ($data, $hdr) = @_;
1507
1508 if ($hdr->{Status} =~ /^2/) {
1509 length $data == syswrite $fh, $data
1510 or return; # abort on write errors
1511 }
1512
1513 1
1514 },
1515 sub {
1516 my (undef, $hdr) = @_;
1517
1518 my $status = $hdr->{Status};
1519
1520 if (my $time = AnyEvent::HTTP::parse_date $hdr->{"last-modified"}) {
1521 utime $time, $time, $fh;
1522 }
1523
1524 if ($status == 200 || $status == 206 || $status == 416) {
1525 # download ok || resume ok || file already fully downloaded
1526 $cb->(1, $hdr);
1527
1528 } elsif ($status == 412) {
1529 # file has changed while resuming, delete and retry
1530 unlink $file;
1531 $cb->(0, $hdr);
1532
1533 } elsif ($status == 500 or $status == 503 or $status =~ /^59/) {
1534 # retry later
1535 $cb->(0, $hdr);
1536
1537 } else {
1538 $cb->(undef, $hdr);
1539 }
1540 }
1541 ;
1542 }
1543
1544 download "http://server/somelargefile", "/tmp/somelargefile", sub {
1545 if ($_[0]) {
1546 print "OK!\n";
1547 } elsif (defined $_[0]) {
1548 print "please retry later\n";
1549 } else {
1550 print "ERROR\n";
1551 }
1552 };
1553
1060=head2 SOCKS PROXIES 1554=head3 SOCKS PROXIES
1061 1555
1062Socks proxies are not directly supported by AnyEvent::HTTP. You can 1556Socks proxies are not directly supported by AnyEvent::HTTP. You can
1063compile your perl to support socks, or use an external program such as 1557compile 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 1558F<socksify> (dante) or F<tsocks> to make your program use a socks proxy
1065transparently. 1559transparently.

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines