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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines