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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines