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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines