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.62 by root, Thu Dec 30 04:30:24 2010 UTC vs.
Revision 1.135 by root, Mon Sep 10 07:03:12 2018 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines