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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines