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.122 by root, Fri May 8 17:28:39 2015 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines