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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines