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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines