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.72 by root, Fri Dec 31 20:59:19 2010 UTC vs.
Revision 1.126 by root, Thu Jan 7 13:14:16 2016 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.22;
53 52
54our @EXPORT = qw(http_get http_post http_head http_request); 53our @EXPORT = qw(http_get http_post http_head http_request);
55 54
56our $USERAGENT = "Mozilla/5.0 (compatible; U; AnyEvent-HTTP/$VERSION; +http://software.schmorp.de/pkg/AnyEvent)"; 55our $USERAGENT = "Mozilla/5.0 (compatible; U; AnyEvent-HTTP/$VERSION; +http://software.schmorp.de/pkg/AnyEvent)";
57our $MAX_RECURSE = 10; 56our $MAX_RECURSE = 10;
58our $MAX_PERSISTENT = 8;
59our $PERSISTENT_TIMEOUT = 2; 57our $PERSISTENT_TIMEOUT = 3;
60our $TIMEOUT = 300; 58our $TIMEOUT = 300;
61 59our $MAX_PER_HOST = 4; # changing this is evil
62# changing these is evil
63our $MAX_PERSISTENT_PER_HOST = 0;
64our $MAX_PER_HOST = 4;
65 60
66our $PROXY; 61our $PROXY;
67our $ACTIVE = 0; 62our $ACTIVE = 0;
68 63
69my %KA_COUNT; # number of open keep-alive connections per host 64my %KA_CACHE; # indexed by uhost currently, points to [$handle...] array
70my %CO_SLOT; # number of open connections, and wait queue, per host 65my %CO_SLOT; # number of open connections, and wait queue, per host
71 66
72=item http_get $url, key => value..., $cb->($data, $headers) 67=item http_get $url, key => value..., $cb->($data, $headers)
73 68
74Executes an HTTP-GET request. See the http_request function for details on 69Executes an HTTP-GET request. See the http_request function for details on
94C<http_request> returns a "cancellation guard" - you have to keep the 89C<http_request> returns a "cancellation guard" - you have to keep the
95object at least alive until the callback get called. If the object gets 90object at least alive until the callback get called. If the object gets
96destroyed before the callback is called, the request will be cancelled. 91destroyed before the callback is called, the request will be cancelled.
97 92
98The callback will be called with the response body data as first argument 93The callback will be called with the response body data as first argument
99(or C<undef> if an error occured), and a hash-ref with response headers 94(or C<undef> if an error occurred), and a hash-ref with response headers
100(and trailers) as second argument. 95(and trailers) as second argument.
101 96
102All the headers in that hash are lowercased. In addition to the response 97All the headers in that hash are lowercased. In addition to the response
103headers, the "pseudo-headers" (uppercase to avoid clashing with possible 98headers, the "pseudo-headers" (uppercase to avoid clashing with possible
104response headers) C<HTTPVersion>, C<Status> and C<Reason> contain the 99response headers) C<HTTPVersion>, C<Status> and C<Reason> contain the
122 117
123If the server sends a header multiple times, then their contents will be 118If the server sends a header multiple times, then their contents will be
124joined together with a comma (C<,>), as per the HTTP spec. 119joined together with a comma (C<,>), as per the HTTP spec.
125 120
126If an internal error occurs, such as not being able to resolve a hostname, 121If an internal error occurs, such as not being able to resolve a hostname,
127then C<$data> will be C<undef>, C<< $headers->{Status} >> will be C<59x> 122then C<$data> will be C<undef>, C<< $headers->{Status} >> will be
128(usually C<599>) and the C<Reason> pseudo-header will contain an error 123C<590>-C<599> and the C<Reason> pseudo-header will contain an error
129message. 124message. Currently the following status codes are used:
125
126=over 4
127
128=item 595 - errors during connection establishment, proxy handshake.
129
130=item 596 - errors during TLS negotiation, request sending and header processing.
131
132=item 597 - errors during body receiving or processing.
133
134=item 598 - user aborted request via C<on_header> or C<on_body>.
135
136=item 599 - other, usually nonretryable, errors (garbled URL etc.).
137
138=back
130 139
131A typical callback might look like this: 140A typical callback might look like this:
132 141
133 sub { 142 sub {
134 my ($body, $hdr) = @_; 143 my ($body, $hdr) = @_;
145 154
146=over 4 155=over 4
147 156
148=item recurse => $count (default: $MAX_RECURSE) 157=item recurse => $count (default: $MAX_RECURSE)
149 158
150Whether to recurse requests or not, e.g. on redirects, authentication 159Whether to recurse requests or not, e.g. on redirects, authentication and
151retries and so on, and how often to do so. 160other retries and so on, and how often to do so.
161
162Only redirects to http and https URLs are supported. While most common
163redirection forms are handled entirely within this module, some require
164the use of the optional L<URI> module. If it is required but missing, then
165the request will fail with an error.
152 166
153=item headers => hashref 167=item headers => hashref
154 168
155The request headers to use. Currently, C<http_request> may provide its own 169The request headers to use. Currently, C<http_request> may provide its own
156C<Host:>, C<Content-Length:>, C<Connection:> and C<Cookie:> headers and 170C<Host:>, C<Content-Length:>, C<Connection:> and C<Cookie:> headers and
157will provide defaults at least for C<TE:>, C<Referer:> and C<User-Agent:> 171will provide defaults at least for C<TE:>, C<Referer:> and C<User-Agent:>
158(this can be suppressed by using C<undef> for these headers in which case 172(this can be suppressed by using C<undef> for these headers in which case
159they won't be sent at all). 173they won't be sent at all).
160 174
175You really should provide your own C<User-Agent:> header value that is
176appropriate for your program - I wouldn't be surprised if the default
177AnyEvent string gets blocked by webservers sooner or later.
178
179Also, make sure that your headers names and values do not contain any
180embedded newlines.
181
161=item timeout => $seconds 182=item timeout => $seconds
162 183
163The time-out to use for various stages - each connect attempt will reset 184The time-out to use for various stages - each connect attempt will reset
164the timeout, as will read or write activity, i.e. this is not an overall 185the timeout, as will read or write activity, i.e. this is not an overall
165timeout. 186timeout.
166 187
167Default timeout is 5 minutes. 188Default timeout is 5 minutes.
168 189
169=item proxy => [$host, $port[, $scheme]] or undef 190=item proxy => [$host, $port[, $scheme]] or undef
170 191
171Use the given http proxy for all requests. If not specified, then the 192Use the given http proxy for all requests, or no proxy if C<undef> is
172default proxy (as specified by C<$ENV{http_proxy}>) is used. 193used.
173 194
174C<$scheme> must be either missing, C<http> for HTTP or C<https> for 195C<$scheme> must be either missing or must be C<http> for HTTP.
175HTTPS. 196
197If not specified, then the default proxy is used (see
198C<AnyEvent::HTTP::set_proxy>).
199
200Currently, if your proxy requires authorization, you have to specify an
201appropriate "Proxy-Authorization" header in every request.
176 202
177=item body => $string 203=item body => $string
178 204
179The request body, usually empty. Will be sent as-is (future versions of 205The request body, usually empty. Will be sent as-is (future versions of
180this module might offer more options). 206this module might offer more options).
182=item cookie_jar => $hash_ref 208=item cookie_jar => $hash_ref
183 209
184Passing this parameter enables (simplified) cookie-processing, loosely 210Passing this parameter enables (simplified) cookie-processing, loosely
185based on the original netscape specification. 211based on the original netscape specification.
186 212
187The C<$hash_ref> must be an (initially empty) hash reference which will 213The C<$hash_ref> must be an (initially empty) hash reference which
188get updated automatically. It is possible to save the cookie jar to 214will get updated automatically. It is possible to save the cookie jar
189persistent storage with something like JSON or Storable, but this is not 215to persistent storage with something like JSON or Storable - see the
190recommended, as session-only cookies might survive longer than expected. 216C<AnyEvent::HTTP::cookie_jar_expire> function if you wish to remove
217expired or session-only cookies, and also for documentation on the format
218of the cookie jar.
191 219
192Note that this cookie implementation is not meant to be complete. If 220Note that this cookie implementation is not meant to be complete. If
193you want complete cookie management you have to do that on your 221you want complete cookie management you have to do that on your
194own. C<cookie_jar> is meant as a quick fix to get some cookie-using sites 222own. C<cookie_jar> is meant as a quick fix to get most cookie-using sites
195working. Cookies are a privacy disaster, do not use them unless required 223working. Cookies are a privacy disaster, do not use them unless required
196to. 224to.
197 225
198When cookie processing is enabled, the C<Cookie:> and C<Set-Cookie:> 226When cookie processing is enabled, the C<Cookie:> and C<Set-Cookie:>
199headers will be set and handled by this module, otherwise they will be 227headers will be set and handled by this module, otherwise they will be
209verification) TLS context. 237verification) TLS context.
210 238
211The default for this option is C<low>, which could be interpreted as "give 239The default for this option is C<low>, which could be interpreted as "give
212me the page, no matter what". 240me the page, no matter what".
213 241
242See also the C<sessionid> parameter.
243
244=item session => $string
245
246The module might reuse connections to the same host internally. Sometimes
247(e.g. when using TLS), you do not want to reuse connections from other
248sessions. This can be achieved by setting this parameter to some unique
249ID (such as the address of an object storing your state data, or the TLS
250context) - only connections using the same unique ID will be reused.
251
214=item on_prepare => $callback->($fh) 252=item on_prepare => $callback->($fh)
215 253
216In rare cases you need to "tune" the socket before it is used to 254In rare cases you need to "tune" the socket before it is used to
217connect (for exmaple, to bind it on a given IP address). This parameter 255connect (for example, to bind it on a given IP address). This parameter
218overrides the prepare callback passed to C<AnyEvent::Socket::tcp_connect> 256overrides the prepare callback passed to C<AnyEvent::Socket::tcp_connect>
219and behaves exactly the same way (e.g. it has to provide a 257and behaves exactly the same way (e.g. it has to provide a
220timeout). See the description for the C<$prepare_cb> argument of 258timeout). See the description for the C<$prepare_cb> argument of
221C<AnyEvent::Socket::tcp_connect> for details. 259C<AnyEvent::Socket::tcp_connect> for details.
222 260
287called. Instead of the C<$body> argument containing the body data, the 325called. Instead of the C<$body> argument containing the body data, the
288callback will receive the L<AnyEvent::Handle> object associated with the 326callback will receive the L<AnyEvent::Handle> object associated with the
289connection. In error cases, C<undef> will be passed. When there is no body 327connection. In error cases, C<undef> will be passed. When there is no body
290(e.g. status C<304>), the empty string will be passed. 328(e.g. status C<304>), the empty string will be passed.
291 329
292The handle object might or might not be in TLS mode, might be connected to 330The handle object might or might not be in TLS mode, might be connected
293a proxy, be a persistent connection etc., and configured in unspecified 331to a proxy, be a persistent connection, use chunked transfer encoding
294ways. The user is responsible for this handle (it will not be used by this 332etc., and configured in unspecified ways. The user is responsible for this
295module anymore). 333handle (it will not be used by this module anymore).
296 334
297This is useful with some push-type services, where, after the initial 335This is useful with some push-type services, where, after the initial
298headers, an interactive protocol is used (typical example would be the 336headers, an interactive protocol is used (typical example would be the
299push-style twitter API which starts a JSON/XML stream). 337push-style twitter API which starts a JSON/XML stream).
300 338
301If you think you need this, first have a look at C<on_body>, to see if 339If you think you need this, first have a look at C<on_body>, to see if
302that doesn't solve your problem in a better way. 340that doesn't solve your problem in a better way.
341
342=item persistent => $boolean
343
344Try to create/reuse a persistent connection. When this flag is set
345(default: true for idempotent requests, false for all others), then
346C<http_request> tries to re-use an existing (previously-created)
347persistent connection to the host and, failing that, tries to create a new
348one.
349
350Requests failing in certain ways will be automatically retried once, which
351is dangerous for non-idempotent requests, which is why it defaults to off
352for them. The reason for this is because the bozos who designed HTTP/1.1
353made it impossible to distinguish between a fatal error and a normal
354connection timeout, so you never know whether there was a problem with
355your request or not.
356
357When reusing an existent connection, many parameters (such as TLS context)
358will be ignored. See the C<session> parameter for a workaround.
359
360=item keepalive => $boolean
361
362Only used when C<persistent> is also true. This parameter decides whether
363C<http_request> tries to handshake a HTTP/1.0-style keep-alive connection
364(as opposed to only a HTTP/1.1 persistent connection).
365
366The default is true, except when using a proxy, in which case it defaults
367to false, as HTTP/1.0 proxies cannot support this in a meaningful way.
368
369=item handle_params => { key => value ... }
370
371The key-value pairs in this hash will be passed to any L<AnyEvent::Handle>
372constructor that is called - not all requests will create a handle, and
373sometimes more than one is created, so this parameter is only good for
374setting hints.
375
376Example: set the maximum read size to 4096, to potentially conserve memory
377at the cost of speed.
378
379 handle_params => {
380 max_read_size => 4096,
381 },
303 382
304=back 383=back
305 384
306Example: do a simple HTTP GET request for http://www.nethype.de/ and print 385Example: do a simple HTTP GET request for http://www.nethype.de/ and print
307the response body. 386the response body.
313 392
314Example: do a HTTP HEAD request on https://www.google.com/, use a 393Example: do a HTTP HEAD request on https://www.google.com/, use a
315timeout of 30 seconds. 394timeout of 30 seconds.
316 395
317 http_request 396 http_request
318 GET => "https://www.google.com", 397 HEAD => "https://www.google.com",
398 headers => { "user-agent" => "MySearchClient 1.0" },
319 timeout => 30, 399 timeout => 30,
320 sub { 400 sub {
321 my ($body, $hdr) = @_; 401 my ($body, $hdr) = @_;
322 use Data::Dumper; 402 use Data::Dumper;
323 print Dumper $hdr; 403 print Dumper $hdr;
333 }; 413 };
334 414
335 undef $request; 415 undef $request;
336 416
337=cut 417=cut
418
419#############################################################################
420# wait queue/slots
338 421
339sub _slot_schedule; 422sub _slot_schedule;
340sub _slot_schedule($) { 423sub _slot_schedule($) {
341 my $host = shift; 424 my $host = shift;
342 425
364 push @{ $CO_SLOT{$_[0]}[1] }, $_[1]; 447 push @{ $CO_SLOT{$_[0]}[1] }, $_[1];
365 448
366 _slot_schedule $_[0]; 449 _slot_schedule $_[0];
367} 450}
368 451
452#############################################################################
453# cookie handling
454
455# expire cookies
456sub cookie_jar_expire($;$) {
457 my ($jar, $session_end) = @_;
458
459 %$jar = () if $jar->{version} != 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
369# extract cookies from jar 485# extract cookies from jar
370sub cookie_jar_extract($$$$) { 486sub cookie_jar_extract($$$$) {
371 my ($jar, $uscheme, $uhost, $upath) = @_; 487 my ($jar, $scheme, $host, $path) = @_;
372 488
373 %$jar = () if $jar->{version} != 1; 489 %$jar = () if $jar->{version} != 1;
374 490
375 my @cookies; 491 my @cookies;
376 492
377 while (my ($chost, $paths) = each %$jar) { 493 while (my ($chost, $paths) = each %$jar) {
378 next unless ref $paths; 494 next unless ref $paths;
379 495
380 if ($chost =~ /^\./) { 496 if ($chost =~ /^\./) {
381 next unless $chost eq substr $uhost, -length $chost; 497 next unless $chost eq substr $host, -length $chost;
382 } elsif ($chost =~ /\./) { 498 } elsif ($chost =~ /\./) {
383 next unless $chost eq $uhost; 499 next unless $chost eq $host;
384 } else { 500 } else {
385 next; 501 next;
386 } 502 }
387 503
388 while (my ($cpath, $cookies) = each %$paths) { 504 while (my ($cpath, $cookies) = each %$paths) {
389 next unless $cpath eq substr $upath, 0, length $cpath; 505 next unless $cpath eq substr $path, 0, length $cpath;
390 506
391 while (my ($cookie, $kv) = each %$cookies) { 507 while (my ($cookie, $kv) = each %$cookies) {
392 next if $uscheme ne "https" && exists $kv->{secure}; 508 next if $scheme ne "https" && exists $kv->{secure};
393 509
394 if (exists $kv->{expires}) { 510 if (exists $kv->{_expires} and AE::now > $kv->{_expires}) {
395 if (AE::now > parse_date ($kv->{expires})) {
396 delete $cookies->{$cookie}; 511 delete $cookies->{$cookie};
397 next; 512 next;
398 }
399 } 513 }
400 514
401 my $value = $kv->{value}; 515 my $value = $kv->{value};
402 516
403 if ($value =~ /[=;,[:space:]]/) { 517 if ($value =~ /[=;,[:space:]]/) {
412 526
413 \@cookies 527 \@cookies
414} 528}
415 529
416# parse set_cookie header into jar 530# parse set_cookie header into jar
417sub cookie_jar_set_cookie($$) { 531sub cookie_jar_set_cookie($$$$) {
418 my ($jar, $set_cookie) = @_; 532 my ($jar, $set_cookie, $host, $date) = @_;
533
534 my $anow = int AE::now;
535 my $snow; # server-now
419 536
420 for ($set_cookie) { 537 for ($set_cookie) {
421 # parse NAME=VALUE 538 # parse NAME=VALUE
422 my @kv; 539 my @kv;
423 540
541 # expires is not http-compliant in the original cookie-spec,
542 # we support the official date format and some extensions
424 while ( 543 while (
425 m{ 544 m{
426 \G\s* 545 \G\s*
427 (?: 546 (?:
428 expires \s*=\s* ([A-Z][a-z][a-z],\ [^,;]+) 547 expires \s*=\s* ([A-Z][a-z][a-z]+,\ [^,;]+)
429 | ([^=;,[:space:]]+) \s*=\s* (?: "((?:[^\\"]+|\\.)*)" | ([^=;,[:space:]]*) ) 548 | ([^=;,[:space:]]+) (?: \s*=\s* (?: "((?:[^\\"]+|\\.)*)" | ([^;,[:space:]]*) ) )?
430 ) 549 )
431 }gcxsi 550 }gcxsi
432 ) { 551 ) {
433 my $name = $2; 552 my $name = $2;
434 my $value = $4; 553 my $value = $4;
435 554
436 unless (defined $name) { 555 if (defined $1) {
437 # expires 556 # expires
438 $name = "expires"; 557 $name = "expires";
439 $value = $1; 558 $value = $1;
440 } elsif (!defined $value) { 559 } elsif (defined $3) {
441 # quoted 560 # quoted
442 $value = $3; 561 $value = $3;
443 $value =~ s/\\(.)/$1/gs; 562 $value =~ s/\\(.)/$1/gs;
444 } 563 }
445 564
446 push @kv, lc $name, $value; 565 push @kv, @kv ? lc $name : $name, $value;
447 566
448 last unless /\G\s*;/gc; 567 last unless /\G\s*;/gc;
449 } 568 }
450 569
451 last unless @kv; 570 last unless @kv;
452 571
453 my $name = shift @kv; 572 my $name = shift @kv;
454 my %kv = (value => shift @kv, @kv); 573 my %kv = (value => shift @kv, @kv);
455 574
456 $kv{expires} ||= format_date (AE::now + $kv{"max-age"})
457 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 }
458 583
459 my $cdom; 584 my $cdom;
460 my $cpath = (delete $kv{path}) || "/"; 585 my $cpath = (delete $kv{path}) || "/";
461 586
462 if (exists $kv{domain}) { 587 if (exists $kv{domain}) {
468 593
469 # this is not rfc-like and not netscape-like. go figure. 594 # this is not rfc-like and not netscape-like. go figure.
470 my $ndots = $cdom =~ y/.//; 595 my $ndots = $cdom =~ y/.//;
471 next if $ndots < ($cdom =~ /\.[^.][^.]\.[^.][^.]$/ ? 3 : 2); 596 next if $ndots < ($cdom =~ /\.[^.][^.]\.[^.][^.]$/ ? 3 : 2);
472 } else { 597 } else {
473 $cdom = $uhost; 598 $cdom = $host;
474 } 599 }
475 600
476 # store it 601 # store it
477 $arg{cookie_jar}{version} = 1; 602 $jar->{version} = 1;
478 $arg{cookie_jar}{$cdom}{$cpath}{$name} = \%kv; 603 $jar->{lc $cdom}{$cpath}{$name} = \%kv;
479 604
480 redo if /\G\s*,/gc; 605 redo if /\G\s*,/gc;
481 } 606 }
482} 607}
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
483} 621}
484 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
485# continue to parse $_ for headers and place them into the arg 651# continue to parse $_ for headers and place them into the arg
486sub parse_hdr() { 652sub _parse_hdr() {
487 my %hdr; 653 my %hdr;
488 654
489 # things seen, not parsed: 655 # things seen, not parsed:
490 # p3pP="NON CUR OTPi OUR NOR UNI" 656 # p3pP="NON CUR OTPi OUR NOR UNI"
491 657
505 for values %hdr; 671 for values %hdr;
506 672
507 \%hdr 673 \%hdr
508} 674}
509 675
676#############################################################################
677# http_get
678
510our $qr_nlnl = qr{(?<![^\012])\015?\012}; 679our $qr_nlnl = qr{(?<![^\012])\015?\012};
511 680
512our $TLS_CTX_LOW = { cache => 1, sslv2 => 1 }; 681our $TLS_CTX_LOW = { cache => 1, sslv2 => 1 };
513our $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);
514 739
515sub http_request($$@) { 740sub http_request($$@) {
516 my $cb = pop; 741 my $cb = pop;
517 my ($method, $url, %arg) = @_; 742 my ($method, $url, %arg) = @_;
518 743
536 my $recurse = exists $arg{recurse} ? delete $arg{recurse} : $MAX_RECURSE; 761 my $recurse = exists $arg{recurse} ? delete $arg{recurse} : $MAX_RECURSE;
537 762
538 return $cb->(undef, { @pseudo, Status => 599, Reason => "Too many redirections" }) 763 return $cb->(undef, { @pseudo, Status => 599, Reason => "Too many redirections" })
539 if $recurse < 0; 764 if $recurse < 0;
540 765
541 my $proxy = $arg{proxy} || $PROXY; 766 my $proxy = exists $arg{proxy} ? $arg{proxy} : $PROXY;
542 my $timeout = $arg{timeout} || $TIMEOUT; 767 my $timeout = $arg{timeout} || $TIMEOUT;
543 768
544 my ($uscheme, $uauthority, $upath, $query, $fragment) = 769 my ($uscheme, $uauthority, $upath, $query, undef) = # ignore fragment
545 $url =~ m|(?:([^:/?#]+):)?(?://([^/?#]*))?([^?#]*)(?:(\?[^#]*))?(?:#(.*))?|; 770 $url =~ m|^([^:]+):(?://([^/?#]*))?([^?#]*)(?:(\?[^#]*))?(?:#(.*))?$|;
546 771
547 $uscheme = lc $uscheme; 772 $uscheme = lc $uscheme;
548 773
549 my $uport = $uscheme eq "http" ? 80 774 my $uport = $uscheme eq "http" ? 80
550 : $uscheme eq "https" ? 443 775 : $uscheme eq "https" ? 443
551 : 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" });
552 777
553 $uauthority =~ /^(?: .*\@ )? ([^\@:]+) (?: : (\d+) )?$/x 778 $uauthority =~ /^(?: .*\@ )? ([^\@]+?) (?: : (\d+) )?$/x
554 or return $cb->(undef, { @pseudo, Status => 599, Reason => "Unparsable URL" }); 779 or return $cb->(undef, { @pseudo, Status => 599, Reason => "Unparsable URL" });
555 780
556 my $uhost = $1; 781 my $uhost = lc $1;
557 $uport = $2 if defined $2; 782 $uport = $2 if defined $2;
558 783
559 $hdr{host} = defined $2 ? "$uhost:$2" : "$uhost" 784 $hdr{host} = defined $2 ? "$uhost:$2" : "$uhost"
560 unless exists $hdr{host}; 785 unless exists $hdr{host};
561 786
580 $rscheme = "http" unless defined $rscheme; 805 $rscheme = "http" unless defined $rscheme;
581 806
582 # don't support https requests over https-proxy transport, 807 # don't support https requests over https-proxy transport,
583 # 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.
584 $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;
585 } else { 813 } else {
586 ($rhost, $rport, $rscheme, $rpath) = ($uhost, $uport, $uscheme, $upath); 814 ($rhost, $rport, $rscheme, $rpath) = ($uhost, $uport, $uscheme, $upath);
587 } 815 }
588 816
589 # leave out fragment and query string, just a heuristic 817 # leave out fragment and query string, just a heuristic
591 $hdr{"user-agent"} = $USERAGENT unless exists $hdr{"user-agent"}; 819 $hdr{"user-agent"} = $USERAGENT unless exists $hdr{"user-agent"};
592 820
593 $hdr{"content-length"} = length $arg{body} 821 $hdr{"content-length"} = length $arg{body}
594 if length $arg{body} || $method ne "GET"; 822 if length $arg{body} || $method ne "GET";
595 823
596 $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
597 $hdr{te} = "trailers" unless exists $hdr{te}; #1.1 835 $hdr{te} = "trailers" unless exists $hdr{te}; #1.1
598 836
599 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 = "$uscheme:$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 = "$uscheme://$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 };
600 1210
601 _get_slot $uhost, sub { 1211 _get_slot $uhost, sub {
602 $state{slot_guard} = shift; 1212 $state{slot_guard} = shift;
603 1213
604 return unless $state{connect_guard}; 1214 return unless $state{connect_guard};
605 1215
606 my $connect_cb = sub { 1216 # try to use an existing keepalive connection, but only if we, ourselves, plan
607 $state{fh} = shift 1217 # on a keepalive request (in theory, this should be a separate config option).
608 or do { 1218 if ($persistent && $KA_CACHE{$ka_key}) {
609 my $err = "$!"; 1219 $was_persistent = 1;
610 %state = ();
611 return $cb->(undef, { @pseudo, Status => 599, Reason => $err });
612 };
613 1220
614 pop; # free memory, save a tree 1221 $state{handle} = ka_fetch $ka_key;
615
616 return unless delete $state{connect_guard};
617
618 # get handle
619 $state{handle} = new AnyEvent::Handle
620 fh => $state{fh},
621 peername => $rhost,
622 tls_ctx => $arg{tls_ctx},
623 # these need to be reconfigured on keepalive handles
624 timeout => $timeout,
625 on_error => sub {
626 %state = ();
627 $cb->(undef, { @pseudo, Status => 599, Reason => $_[2] });
628 },
629 on_eof => sub {
630 %state = ();
631 $cb->(undef, { @pseudo, Status => 599, Reason => "Unexpected end-of-file" });
632 },
633 ;
634
635 # limit the number of persistent connections
636 # keepalive not yet supported
637# if ($KA_COUNT{$_[1]} < $MAX_PERSISTENT_PER_HOST) {
638# ++$KA_COUNT{$_[1]};
639# $state{handle}{ka_count_guard} = AnyEvent::Util::guard {
640# --$KA_COUNT{$_[1]}
641# };
642# $hdr{connection} = "keep-alive";
643# }
644
645 $state{handle}->starttls ("connect") if $rscheme eq "https";
646
647 # handle actual, non-tunneled, request
648 my $handle_actual_request = sub {
649 $state{handle}->starttls ("connect") if $uscheme eq "https" && !exists $state{handle}{tls};
650
651 # send request
652 $state{handle}->push_write ( 1222 $state{handle}->destroyed
653 "$method $rpath HTTP/1.1\015\012" 1223 and die "AnyEvent::HTTP: unexpectedly got a destructed handle (1), please report.";#d#
654 . (join "", map "\u$_: $hdr{$_}\015\012", grep defined $hdr{$_}, keys %hdr) 1224 $prepare_handle->();
655 . "\015\012" 1225 $state{handle}->destroyed
656 . (delete $arg{body}) 1226 and die "AnyEvent::HTTP: unexpectedly got a destructed handle (2), please report.";#d#
657 );
658
659 # return if error occured during push_write()
660 return unless %state;
661
662 %hdr = (); # reduce memory usage, save a kitten, also make it possible to re-use
663
664 # status line and headers
665 $state{read_response} = sub {
666 for ("$_[1]") {
667 y/\015//d; # weed out any \015, as they show up in the weirdest of places.
668
669 /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\012]*) )? \012/igxc
670 or return (%state = (), $cb->(undef, { @pseudo, Status => 599, Reason => "Invalid server response" }));
671
672 # 100 Continue handling
673 # should not happen as we don't send expect: 100-continue,
674 # but we handle it just in case.
675 # since we send the request body regardless, if we get an error
676 # we are out of-sync, which we currently do NOT handle correctly.
677 return $state{handle}->push_read (line => $qr_nlnl, $state{read_response})
678 if $2 eq 100;
679
680 push @pseudo,
681 HTTPVersion => $1,
682 Status => $2,
683 Reason => $3,
684 ;
685
686 my $hdr = parse_hdr
687 or return (%state = (), $cb->(undef, { @pseudo, Status => 599, Reason => "Garbled response headers" }));
688
689 %hdr = (%$hdr, @pseudo);
690 }
691
692 # redirect handling
693 # microsoft and other shitheads don't give a shit for following standards,
694 # try to support some common forms of broken Location headers.
695 if ($hdr{location} !~ /^(?: $ | [^:\/?\#]+ : )/x) {
696 $hdr{location} =~ s/^\.\/+//;
697
698 my $url = "$rscheme://$uhost:$uport";
699
700 unless ($hdr{location} =~ s/^\///) {
701 $url .= $upath;
702 $url =~ s/\/[^\/]*$//;
703 }
704
705 $hdr{location} = "$url/$hdr{location}";
706 }
707
708 my $redirect;
709
710 if ($recurse) {
711 my $status = $hdr{Status};
712
713 # industry standard is to redirect POST as GET for
714 # 301, 302 and 303, in contrast to http/1.0 and 1.1.
715 # also, the UA should ask the user for 301 and 307 and POST,
716 # industry standard seems to be to simply follow.
717 # we go with the industry standard.
718 if ($status == 301 or $status == 302 or $status == 303) {
719 # HTTP/1.1 is unclear on how to mutate the method
720 $method = "GET" unless $method eq "HEAD";
721 $redirect = 1;
722 } elsif ($status == 307) {
723 $redirect = 1;
724 }
725 }
726
727 my $finish = sub { # ($data, $err_status, $err_reason[, $keepalive])
728 my $keepalive = pop;
729
730 $state{handle}->destroy if $state{handle};
731 %state = ();
732
733 if (defined $_[1]) {
734 $hdr{OrigStatus} = $hdr{Status}; $hdr{Status} = $_[1];
735 $hdr{OrigReason} = $hdr{Reason}; $hdr{Reason} = $_[2];
736 }
737
738 # set-cookie processing
739 if ($arg{cookie_jar}) {
740 cookie_jar_set_cookie $arg{cookie_jar}, $hdr{"set-cookie"};
741
742 if ($redirect && exists $hdr{location}) {
743 # we ignore any errors, as it is very common to receive
744 # Content-Length != 0 but no actual body
745 # we also access %hdr, as $_[1] might be an erro
746 http_request (
747 $method => $hdr{location},
748 %arg,
749 recurse => $recurse - 1,
750 Redirect => [$_[0], \%hdr],
751 $cb);
752 } else {
753 $cb->($_[0], \%hdr);
754 }
755 };
756
757 my $len = $hdr{"content-length"};
758
759 if (!$redirect && $arg{on_header} && !$arg{on_header}(\%hdr)) {
760 $finish->(undef, 598 => "Request cancelled by on_header");
761 } elsif (
762 $hdr{Status} =~ /^(?:1..|204|205|304)$/
763 or $method eq "HEAD"
764 or (defined $len && !$len)
765 ) {
766 # no body
767 $finish->("", undef, undef, 1);
768 } else {
769 # body handling, many different code paths
770 # - no body expected
771 # - want_body_handle
772 # - te chunked
773 # - 2x length known (with or without on_body)
774 # - 2x length not known (with or without on_body)
775 if (!$redirect && $arg{want_body_handle}) {
776 $_[0]->on_eof (undef);
777 $_[0]->on_error (undef);
778 $_[0]->on_read (undef);
779
780 $finish->(delete $state{handle});
781
782 } elsif ($hdr{"transfer-encoding"} =~ /\bchunked\b/i) {
783 my $cl = 0;
784 my $body = undef;
785 my $on_body = $arg{on_body} || sub { $body .= shift; 1 };
786
787 $_[0]->on_error (sub { $finish->(undef, 599 => $_[2]) });
788
789 my $read_chunk; $read_chunk = sub {
790 $_[1] =~ /^([0-9a-fA-F]+)/
791 or $finish->(undef, 599 => "Garbled chunked transfer encoding");
792
793 my $len = hex $1;
794
795 if ($len) {
796 $cl += $len;
797
798 $_[0]->push_read (chunk => $len, sub {
799 $on_body->($_[1], \%hdr)
800 or return $finish->(undef, 598 => "Request cancelled by on_body");
801
802 $_[0]->push_read (line => sub {
803 length $_[1]
804 and return $finish->(undef, 599 => "Garbled chunked transfer encoding");
805 $_[0]->push_read (line => $read_chunk);
806 });
807 });
808 } else {
809 $hdr{"content-length"} ||= $cl;
810
811 $_[0]->push_read (line => $qr_nlnl, sub {
812 if (length $_[1]) {
813 for ("$_[1]") {
814 y/\015//d; # weed out any \015, as they show up in the weirdest of places.
815
816 my $hdr = parse_hdr
817 or return $finish->(undef, 599 => "Garbled response trailers");
818
819 %hdr = (%hdr, %$hdr);
820 }
821 }
822
823 $finish->($body, undef, undef, 1);
824 });
825 }
826 };
827
828 $_[0]->push_read (line => $read_chunk);
829
830 } elsif ($arg{on_body}) {
831 $_[0]->on_error (sub { $finish->(undef, 599 => $_[2]) });
832
833 if ($len) {
834 $_[0]->on_read (sub {
835 $len -= length $_[0]{rbuf};
836
837 $arg{on_body}(delete $_[0]{rbuf}, \%hdr)
838 or return $finish->(undef, 598 => "Request cancelled by on_body");
839
840 $len > 0
841 or $finish->("", undef, undef, 1);
842 });
843 } else {
844 $_[0]->on_eof (sub {
845 $finish->("");
846 });
847 $_[0]->on_read (sub {
848 $arg{on_body}(delete $_[0]{rbuf}, \%hdr)
849 or $finish->(undef, 598 => "Request cancelled by on_body");
850 });
851 }
852 } else {
853 $_[0]->on_eof (undef);
854
855 if ($len) {
856 $_[0]->on_error (sub { $finish->(undef, 599 => $_[2]) });
857 $_[0]->on_read (sub {
858 $finish->((substr delete $_[0]{rbuf}, 0, $len, ""), undef, undef, 1)
859 if $len <= length $_[0]{rbuf};
860 });
861 } else {
862 $_[0]->on_error (sub {
863 ($! == Errno::EPIPE || !$!)
864 ? $finish->(delete $_[0]{rbuf})
865 : $finish->(undef, 599 => $_[2]);
866 });
867 $_[0]->on_read (sub { });
868 }
869 }
870 }
871 };
872
873 $state{handle}->push_read (line => $qr_nlnl, $state{read_response});
874 };
875
876 # now handle proxy-CONNECT method
877 if ($proxy && $uscheme eq "https") {
878 # oh dear, we have to wrap it into a connect request
879
880 # maybe re-use $uauthority with patched port?
881 $state{handle}->push_write ("CONNECT $uhost:$uport HTTP/1.0\015\012Host: $uhost\015\012\015\012");
882 $state{handle}->push_read (line => $qr_nlnl, sub {
883 $_[1] =~ /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\015\012]*) )?/ix
884 or return (%state = (), $cb->(undef, { @pseudo, Status => 599, Reason => "Invalid proxy connect response ($_[1])" }));
885
886 if ($2 == 200) {
887 $rpath = $upath;
888 &$handle_actual_request; 1227 $handle_actual_request->();
889 } else { 1228
890 %state = ();
891 $cb->(undef, { @pseudo, Status => $2, Reason => $3 });
892 }
893 });
894 } else { 1229 } else {
895 &$handle_actual_request;
896 }
897 };
898
899 my $tcp_connect = $arg{tcp_connect} 1230 my $tcp_connect = $arg{tcp_connect}
900 || do { require AnyEvent::Socket; \&AnyEvent::Socket::tcp_connect }; 1231 || do { require AnyEvent::Socket; \&AnyEvent::Socket::tcp_connect };
901 1232
902 $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 });
903 1234 }
904 }; 1235 };
905 1236
906 defined wantarray && AnyEvent::Util::guard { %state = () } 1237 defined wantarray && AnyEvent::Util::guard { _destroy_state %state }
907} 1238}
908 1239
909sub http_get($@) { 1240sub http_get($@) {
910 unshift @_, "GET"; 1241 unshift @_, "GET";
911 &http_request 1242 &http_request
929AnyEvent::HTTP uses the AnyEvent::Socket::tcp_connect function for 1260AnyEvent::HTTP uses the AnyEvent::Socket::tcp_connect function for
930the actual connection, which in turn uses AnyEvent::DNS to resolve 1261the actual connection, which in turn uses AnyEvent::DNS to resolve
931hostnames. The latter is a simple stub resolver and does no caching 1262hostnames. The latter is a simple stub resolver and does no caching
932on 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
933your own default resolver (by storing a suitable resolver object in 1264your own default resolver (by storing a suitable resolver object in
934C<$AnyEvent::DNS::RESOLVER>). 1265C<$AnyEvent::DNS::RESOLVER>) or your own C<tcp_connect> callback.
935 1266
936=head2 GLOBAL FUNCTIONS AND VARIABLES 1267=head2 GLOBAL FUNCTIONS AND VARIABLES
937 1268
938=over 4 1269=over 4
939 1270
940=item AnyEvent::HTTP::set_proxy "proxy-url" 1271=item AnyEvent::HTTP::set_proxy "proxy-url"
941 1272
942Sets 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
943string of the form C<http://host:port> (optionally C<https:...>), croaks 1274string of the form C<http://host:port>, croaks otherwise.
944otherwise.
945 1275
946To 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 }
947 1321
948=item $date = AnyEvent::HTTP::format_date $timestamp 1322=item $date = AnyEvent::HTTP::format_date $timestamp
949 1323
950Takes 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
951Date (RFC 2616). 1325Date (RFC 2616).
952 1326
953=item $timestamp = AnyEvent::HTTP::parse_date $date 1327=item $timestamp = AnyEvent::HTTP::parse_date $date
954 1328
955Takes 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
956returns the corresponding POSIX timestamp, or C<undef> if the date cannot 1330bunch of minor variations of those, and returns the corresponding POSIX
957be parsed. 1331timestamp, or C<undef> if the date cannot be parsed.
958 1332
959=item $AnyEvent::HTTP::MAX_RECURSE 1333=item $AnyEvent::HTTP::MAX_RECURSE
960 1334
961The 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>).
962 1340
963=item $AnyEvent::HTTP::USERAGENT 1341=item $AnyEvent::HTTP::USERAGENT
964 1342
965The default value for the C<User-Agent> header (the default is 1343The default value for the C<User-Agent> header (the default is
966C<Mozilla/5.0 (compatible; U; AnyEvent-HTTP/$VERSION; +http://software.schmorp.de/pkg/AnyEvent)>). 1344C<Mozilla/5.0 (compatible; U; AnyEvent-HTTP/$VERSION; +http://software.schmorp.de/pkg/AnyEvent)>).
967 1345
968=item $AnyEvent::HTTP::MAX_PER_HOST 1346=item $AnyEvent::HTTP::MAX_PER_HOST
969 1347
970The maximum number of concurrent connections to the same host (identified 1348The maximum number of concurrent connections to the same host (identified
971by the hostname). If the limit is exceeded, then the additional requests 1349by the hostname). If the limit is exceeded, then additional requests
972are queued until previous connections are closed. 1350are queued until previous connections are closed. Both persistent and
1351non-persistent connections are counted in this limit.
973 1352
974The 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
975increase 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>).
976 1365
977=item $AnyEvent::HTTP::ACTIVE 1366=item $AnyEvent::HTTP::ACTIVE
978 1367
979The number of active connections. This is not the number of currently 1368The number of active connections. This is not the number of currently
980running requests, but the number of currently open and non-idle TCP 1369running requests, but the number of currently open and non-idle TCP
981connections. This number of can be useful for load-leveling. 1370connections. This number can be useful for load-leveling.
982 1371
983=back 1372=back
984 1373
985=cut 1374=cut
986 1375
1001sub parse_date($) { 1390sub parse_date($) {
1002 my ($date) = @_; 1391 my ($date) = @_;
1003 1392
1004 my ($d, $m, $y, $H, $M, $S); 1393 my ($d, $m, $y, $H, $M, $S);
1005 1394
1006 if ($date =~ /^[A-Z][a-z][a-z], ([0-9][0-9])[\- ]([A-Z][a-z][a-z])[\- ]([0-9][0-9][0-9][0-9]) ([0-9][0-9]):([0-9][0-9]):([0-9][0-9]) GMT$/) { 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$/) {
1007 # RFC 822/1123, required by RFC 2616 (with " ") 1396 # RFC 822/1123, required by RFC 2616 (with " ")
1008 # cookie dates (with "-") 1397 # cookie dates (with "-")
1009 1398
1010 ($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);
1011 1400
1012 } elsif ($date =~ /^[A-Z][a-z]+, ([0-9][0-9])-([A-Z][a-z][a-z])-([0-9][0-9]) ([0-9][0-9]):([0-9][0-9]):([0-9][0-9]) GMT$/) { 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$/) {
1013 # RFC 850 1402 # RFC 850
1014 ($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);
1015 1404
1016 } elsif ($date =~ /^[A-Z][a-z][a-z] ([A-Z][a-z][a-z]) ([0-9 ][0-9]) ([0-9][0-9]):([0-9][0-9]):([0-9][0-9]) ([0-9][0-9][0-9][0-9])$/) { 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])$/) {
1017 # ISO C's asctime 1406 # ISO C's asctime
1018 ($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);
1019 } 1408 }
1020 # other formats fail in the loop below 1409 # other formats fail in the loop below
1021 1410
1022 for (0..11) { 1411 for (0..11) {
1023 if ($m eq $month[$_]) { 1412 if ($m eq $month[$_]) {
1024 require Time::Local; 1413 require Time::Local;
1025 return Time::Local::timegm ($S, $M, $H, $d, $_, $y); 1414 return eval { Time::Local::timegm ($S, $M, $H, $d, $_, $y) };
1026 } 1415 }
1027 } 1416 }
1028 1417
1029 undef 1418 undef
1030} 1419}
1031 1420
1032sub set_proxy($) { 1421sub set_proxy($) {
1033 if (length $_[0]) { 1422 if (length $_[0]) {
1034 $_[0] =~ m%^(https?):// ([^:/]+) (?: : (\d*) )?%ix 1423 $_[0] =~ m%^(http):// ([^:/]+) (?: : (\d*) )?%ix
1035 or Carp::croak "$_[0]: invalid proxy URL"; 1424 or Carp::croak "$_[0]: invalid proxy URL";
1036 $PROXY = [$2, $3 || 3128, $1] 1425 $PROXY = [$2, $3 || 3128, $1]
1037 } else { 1426 } else {
1038 undef $PROXY; 1427 undef $PROXY;
1039 } 1428 }
1042# initialise proxy from environment 1431# initialise proxy from environment
1043eval { 1432eval {
1044 set_proxy $ENV{http_proxy}; 1433 set_proxy $ENV{http_proxy};
1045}; 1434};
1046 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
1047=head2 SOCKS PROXIES 1538=head3 SOCKS PROXIES
1048 1539
1049Socks proxies are not directly supported by AnyEvent::HTTP. You can 1540Socks proxies are not directly supported by AnyEvent::HTTP. You can
1050compile 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
1051F<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
1052transparently. 1543transparently.

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines