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.57 by root, Mon Sep 6 06:31:32 2010 UTC vs.
Revision 1.79 by root, Sat Jan 1 20:01:07 2011 UTC

… …
43 43
44use Errno (); 44use Errno ();
45 45
46use AnyEvent 5.0 (); 46use AnyEvent 5.0 ();
47use AnyEvent::Util (); 47use AnyEvent::Util ();
48use AnyEvent::Socket ();
49use AnyEvent::Handle (); 48use AnyEvent::Handle ();
50 49
51use base Exporter::; 50use base Exporter::;
52 51
53our $VERSION = '1.46'; 52our $VERSION = '1.5';
54 53
55our @EXPORT = qw(http_get http_post http_head http_request); 54our @EXPORT = qw(http_get http_post http_head http_request);
56 55
57our $USERAGENT = "Mozilla/5.0 (compatible; U; AnyEvent-HTTP/$VERSION; +http://software.schmorp.de/pkg/AnyEvent)"; 56our $USERAGENT = "Mozilla/5.0 (compatible; U; AnyEvent-HTTP/$VERSION; +http://software.schmorp.de/pkg/AnyEvent)";
58our $MAX_RECURSE = 10; 57our $MAX_RECURSE = 10;
… …
92must be an absolute http or https URL. 91must be an absolute http or https URL.
93 92
94When called in void context, nothing is returned. In other contexts, 93When called in void context, nothing is returned. In other contexts,
95C<http_request> returns a "cancellation guard" - you have to keep the 94C<http_request> returns a "cancellation guard" - you have to keep the
96object at least alive until the callback get called. If the object gets 95object at least alive until the callback get called. If the object gets
97destroyed before the callbakc is called, the request will be cancelled. 96destroyed before the callback is called, the request will be cancelled.
98 97
99The callback will be called with the response body data as first argument 98The callback will be called with the response body data as first argument
100(or C<undef> if an error occured), and a hash-ref with response headers as 99(or C<undef> if an error occured), and a hash-ref with response headers
101second argument. 100(and trailers) as second argument.
102 101
103All the headers in that hash are lowercased. In addition to the response 102All the headers in that hash are lowercased. In addition to the response
104headers, the "pseudo-headers" (uppercase to avoid clashing with possible 103headers, the "pseudo-headers" (uppercase to avoid clashing with possible
105response headers) C<HTTPVersion>, C<Status> and C<Reason> contain the 104response headers) C<HTTPVersion>, C<Status> and C<Reason> contain the
106three parts of the HTTP Status-Line of the same name. 105three parts of the HTTP Status-Line of the same name. If an error occurs
106during the body phase of a request, then the original C<Status> and
107C<Reason> values from the header are available as C<OrigStatus> and
108C<OrigReason>.
107 109
108The pseudo-header C<URL> contains the actual URL (which can differ from 110The pseudo-header C<URL> contains the actual URL (which can differ from
109the requested URL when following redirects - for example, you might get 111the requested URL when following redirects - for example, you might get
110an error that your URL scheme is not supported even though your URL is a 112an error that your URL scheme is not supported even though your URL is a
111valid http URL because it redirected to an ftp URL, in which case you can 113valid http URL because it redirected to an ftp URL, in which case you can
… …
120 122
121If the server sends a header multiple times, then their contents will be 123If the server sends a header multiple times, then their contents will be
122joined together with a comma (C<,>), as per the HTTP spec. 124joined together with a comma (C<,>), as per the HTTP spec.
123 125
124If an internal error occurs, such as not being able to resolve a hostname, 126If an internal error occurs, such as not being able to resolve a hostname,
125then C<$data> will be C<undef>, C<< $headers->{Status} >> will be C<59x> 127then C<$data> will be C<undef>, C<< $headers->{Status} >> will be
126(usually C<599>) and the C<Reason> pseudo-header will contain an error 128C<590>-C<599> and the C<Reason> pseudo-header will contain an error
127message. 129message. Currently the following status codes are used:
130
131=over 4
132
133=item 595 - errors during connection etsbalishment, proxy handshake.
134
135=item 596 - errors during TLS negotiation, request sending and header processing.
136
137=item 597 - errors during body receiving or processing.
138
139=item 598 - user aborted request via C<on_header> or C<on_body>.
140
141=item 599 - other, usually nonretryable, errors (garbled URL etc.).
142
143=back
128 144
129A typical callback might look like this: 145A typical callback might look like this:
130 146
131 sub { 147 sub {
132 my ($body, $hdr) = @_; 148 my ($body, $hdr) = @_;
… …
148Whether to recurse requests or not, e.g. on redirects, authentication 164Whether to recurse requests or not, e.g. on redirects, authentication
149retries and so on, and how often to do so. 165retries and so on, and how often to do so.
150 166
151=item headers => hashref 167=item headers => hashref
152 168
153The request headers to use. Currently, C<http_request> may provide its 169The request headers to use. Currently, C<http_request> may provide its own
154own C<Host:>, C<Content-Length:>, C<Connection:> and C<Cookie:> headers 170C<Host:>, C<Content-Length:>, C<Connection:> and C<Cookie:> headers and
155and will provide defaults for C<User-Agent:> and C<Referer:> (this can be 171will provide defaults at least for C<TE:>, C<Referer:> and C<User-Agent:>
156suppressed by using C<undef> for these headers in which case they won't be 172(this can be suppressed by using C<undef> for these headers in which case
157sent at all). 173they won't be sent at all).
158 174
159=item timeout => $seconds 175=item timeout => $seconds
160 176
161The time-out to use for various stages - each connect attempt will reset 177The time-out to use for various stages - each connect attempt will reset
162the timeout, as will read or write activity, i.e. this is not an overall 178the timeout, as will read or write activity, i.e. this is not an overall
… …
172C<$scheme> must be either missing, C<http> for HTTP or C<https> for 188C<$scheme> must be either missing, C<http> for HTTP or C<https> for
173HTTPS. 189HTTPS.
174 190
175=item body => $string 191=item body => $string
176 192
177The request body, usually empty. Will be-sent as-is (future versions of 193The request body, usually empty. Will be sent as-is (future versions of
178this module might offer more options). 194this module might offer more options).
179 195
180=item cookie_jar => $hash_ref 196=item cookie_jar => $hash_ref
181 197
182Passing this parameter enables (simplified) cookie-processing, loosely 198Passing this parameter enables (simplified) cookie-processing, loosely
183based on the original netscape specification. 199based on the original netscape specification.
184 200
185The C<$hash_ref> must be an (initially empty) hash reference which will 201The C<$hash_ref> must be an (initially empty) hash reference which will
186get updated automatically. It is possible to save the cookie_jar to 202get updated automatically. It is possible to save the cookie jar to
187persistent storage with something like JSON or Storable, but this is not 203persistent storage with something like JSON or Storable, but this is not
188recommended, as expiry times are currently being ignored. 204recommended, as session-only cookies might survive longer than expected.
189 205
190Note that this cookie implementation is not of very high quality, nor 206Note that this cookie implementation is not meant to be complete. If
191meant to be complete. If you want complete cookie management you have to 207you want complete cookie management you have to do that on your
192do that on your own. C<cookie_jar> is meant as a quick fix to get some 208own. C<cookie_jar> is meant as a quick fix to get some cookie-using sites
193cookie-using sites working. Cookies are a privacy disaster, do not use 209working. Cookies are a privacy disaster, do not use them unless required
194them unless required to. 210to.
211
212When cookie processing is enabled, the C<Cookie:> and C<Set-Cookie:>
213headers will be set and handled by this module, otherwise they will be
214left untouched.
195 215
196=item tls_ctx => $scheme | $tls_ctx 216=item tls_ctx => $scheme | $tls_ctx
197 217
198Specifies the AnyEvent::TLS context to be used for https connections. This 218Specifies the AnyEvent::TLS context to be used for https connections. This
199parameter follows the same rules as the C<tls_ctx> parameter to 219parameter follows the same rules as the C<tls_ctx> parameter to
… …
212overrides the prepare callback passed to C<AnyEvent::Socket::tcp_connect> 232overrides the prepare callback passed to C<AnyEvent::Socket::tcp_connect>
213and behaves exactly the same way (e.g. it has to provide a 233and behaves exactly the same way (e.g. it has to provide a
214timeout). See the description for the C<$prepare_cb> argument of 234timeout). See the description for the C<$prepare_cb> argument of
215C<AnyEvent::Socket::tcp_connect> for details. 235C<AnyEvent::Socket::tcp_connect> for details.
216 236
237=item tcp_connect => $callback->($host, $service, $connect_cb, $prepare_cb)
238
239In even rarer cases you want total control over how AnyEvent::HTTP
240establishes connections. Normally it uses L<AnyEvent::Socket::tcp_connect>
241to do this, but you can provide your own C<tcp_connect> function -
242obviously, it has to follow the same calling conventions, except that it
243may always return a connection guard object.
244
245There are probably lots of weird uses for this function, starting from
246tracing the hosts C<http_request> actually tries to connect, to (inexact
247but fast) host => IP address caching or even socks protocol support.
248
217=item on_header => $callback->($headers) 249=item on_header => $callback->($headers)
218 250
219When specified, this callback will be called with the header hash as soon 251When specified, this callback will be called with the header hash as soon
220as headers have been successfully received from the remote server (not on 252as headers have been successfully received from the remote server (not on
221locally-generated errors). 253locally-generated errors).
… …
226 258
227This callback is useful, among other things, to quickly reject unwanted 259This callback is useful, among other things, to quickly reject unwanted
228content, which, if it is supposed to be rare, can be faster than first 260content, which, if it is supposed to be rare, can be faster than first
229doing a C<HEAD> request. 261doing a C<HEAD> request.
230 262
263The downside is that cancelling the request makes it impossible to re-use
264the connection. Also, the C<on_header> callback will not receive any
265trailer (headers sent after the response body).
266
231Example: cancel the request unless the content-type is "text/html". 267Example: cancel the request unless the content-type is "text/html".
232 268
233 on_header => sub { 269 on_header => sub {
234 $_[0]{"content-type"} =~ /^text\/html\s*(?:;|$)/ 270 $_[0]{"content-type"} =~ /^text\/html\s*(?:;|$)/
235 }, 271 },
… …
241string instead of the body data. 277string instead of the body data.
242 278
243It has to return either true (in which case AnyEvent::HTTP will continue), 279It has to return either true (in which case AnyEvent::HTTP will continue),
244or false, in which case AnyEvent::HTTP will cancel the download (and call 280or false, in which case AnyEvent::HTTP will cancel the download (and call
245the completion callback with an error code of C<598>). 281the completion callback with an error code of C<598>).
282
283The downside to cancelling the request is that it makes it impossible to
284re-use the connection.
246 285
247This callback is useful when the data is too large to be held in memory 286This callback is useful when the data is too large to be held in memory
248(so the callback writes it to a file) or when only some information should 287(so the callback writes it to a file) or when only some information should
249be extracted, or when the body should be processed incrementally. 288be extracted, or when the body should be processed incrementally.
250 289
… …
276If you think you need this, first have a look at C<on_body>, to see if 315If you think you need this, first have a look at C<on_body>, to see if
277that doesn't solve your problem in a better way. 316that doesn't solve your problem in a better way.
278 317
279=back 318=back
280 319
281Example: make a simple HTTP GET request for http://www.nethype.de/ 320Example: do a simple HTTP GET request for http://www.nethype.de/ and print
321the response body.
282 322
283 http_request GET => "http://www.nethype.de/", sub { 323 http_request GET => "http://www.nethype.de/", sub {
284 my ($body, $hdr) = @_; 324 my ($body, $hdr) = @_;
285 print "$body\n"; 325 print "$body\n";
286 }; 326 };
287 327
288Example: make a HTTP HEAD request on https://www.google.com/, use a 328Example: do a HTTP HEAD request on https://www.google.com/, use a
289timeout of 30 seconds. 329timeout of 30 seconds.
290 330
291 http_request 331 http_request
292 GET => "https://www.google.com", 332 GET => "https://www.google.com",
293 timeout => 30, 333 timeout => 30,
… …
296 use Data::Dumper; 336 use Data::Dumper;
297 print Dumper $hdr; 337 print Dumper $hdr;
298 } 338 }
299 ; 339 ;
300 340
301Example: make another simple HTTP GET request, but immediately try to 341Example: do another simple HTTP GET request, but immediately try to
302cancel it. 342cancel it.
303 343
304 my $request = http_request GET => "http://www.nethype.de/", sub { 344 my $request = http_request GET => "http://www.nethype.de/", sub {
305 my ($body, $hdr) = @_; 345 my ($body, $hdr) = @_;
306 print "$body\n"; 346 print "$body\n";
… …
338 push @{ $CO_SLOT{$_[0]}[1] }, $_[1]; 378 push @{ $CO_SLOT{$_[0]}[1] }, $_[1];
339 379
340 _slot_schedule $_[0]; 380 _slot_schedule $_[0];
341} 381}
342 382
383# extract cookies from jar
384sub cookie_jar_extract($$$$) {
385 my ($jar, $uscheme, $uhost, $upath) = @_;
386
387 %$jar = () if $jar->{version} != 1;
388
389 my @cookies;
390
391 while (my ($chost, $paths) = each %$jar) {
392 next unless ref $paths;
393
394 if ($chost =~ /^\./) {
395 next unless $chost eq substr $uhost, -length $chost;
396 } elsif ($chost =~ /\./) {
397 next unless $chost eq $uhost;
398 } else {
399 next;
400 }
401
402 while (my ($cpath, $cookies) = each %$paths) {
403 next unless $cpath eq substr $upath, 0, length $cpath;
404
405 while (my ($cookie, $kv) = each %$cookies) {
406 next if $uscheme ne "https" && exists $kv->{secure};
407
408 if (exists $kv->{expires}) {
409 if (AE::now > parse_date ($kv->{expires})) {
410 delete $cookies->{$cookie};
411 next;
412 }
413 }
414
415 my $value = $kv->{value};
416
417 if ($value =~ /[=;,[:space:]]/) {
418 $value =~ s/([\\"])/\\$1/g;
419 $value = "\"$value\"";
420 }
421
422 push @cookies, "$cookie=$value";
423 }
424 }
425 }
426
427 \@cookies
428}
429
430# parse set_cookie header into jar
431sub cookie_jar_set_cookie($$$) {
432 my ($jar, $set_cookie, $uhost) = @_;
433
434 for ($set_cookie) {
435 # parse NAME=VALUE
436 my @kv;
437
438 # expires is not http-compliant in the original cookie-spec,
439 # we support the official date format and some extensions
440 while (
441 m{
442 \G\s*
443 (?:
444 expires \s*=\s* ([A-Z][a-z][a-z]+,\ [^,;]+)
445 | ([^=;,[:space:]]+) \s*=\s* (?: "((?:[^\\"]+|\\.)*)" | ([^=;,[:space:]]*) )
446 )
447 }gcxsi
448 ) {
449 my $name = $2;
450 my $value = $4;
451
452 unless (defined $name) {
453 # expires
454 $name = "expires";
455 $value = $1;
456 } elsif (!defined $value) {
457 # quoted
458 $value = $3;
459 $value =~ s/\\(.)/$1/gs;
460 }
461
462 push @kv, lc $name, $value;
463
464 last unless /\G\s*;/gc;
465 }
466
467 last unless @kv;
468
469 my $name = shift @kv;
470 my %kv = (value => shift @kv, @kv);
471
472 $kv{expires} ||= format_date (AE::now + $kv{"max-age"})
473 if exists $kv{"max-age"};
474
475 my $cdom;
476 my $cpath = (delete $kv{path}) || "/";
477
478 if (exists $kv{domain}) {
479 $cdom = delete $kv{domain};
480
481 $cdom =~ s/^\.?/./; # make sure it starts with a "."
482
483 next if $cdom =~ /\.$/;
484
485 # this is not rfc-like and not netscape-like. go figure.
486 my $ndots = $cdom =~ y/.//;
487 next if $ndots < ($cdom =~ /\.[^.][^.]\.[^.][^.]$/ ? 3 : 2);
488 } else {
489 $cdom = $uhost;
490 }
491
492 # store it
493 $jar->{version} = 1;
494 $jar->{$cdom}{$cpath}{$name} = \%kv;
495
496 redo if /\G\s*,/gc;
497 }
498}
499
500# continue to parse $_ for headers and place them into the arg
501sub parse_hdr() {
502 my %hdr;
503
504 # things seen, not parsed:
505 # p3pP="NON CUR OTPi OUR NOR UNI"
506
507 $hdr{lc $1} .= ",$2"
508 while /\G
509 ([^:\000-\037]*):
510 [\011\040]*
511 ((?: [^\012]+ | \012[\011\040] )*)
512 \012
513 /gxc;
514
515 /\G$/
516 or return;
517
518 # remove the "," prefix we added to all headers above
519 substr $_, 0, 1, ""
520 for values %hdr;
521
522 \%hdr
523}
524
343our $qr_nlnl = qr{(?<![^\012])\015?\012}; 525our $qr_nlnl = qr{(?<![^\012])\015?\012};
344 526
345our $TLS_CTX_LOW = { cache => 1, sslv2 => 1 }; 527our $TLS_CTX_LOW = { cache => 1, sslv2 => 1 };
346our $TLS_CTX_HIGH = { cache => 1, verify => 1, verify_peername => "https" }; 528our $TLS_CTX_HIGH = { cache => 1, verify => 1, verify_peername => "https" };
347 529
… …
366 my @pseudo = (URL => $url); 548 my @pseudo = (URL => $url);
367 push @pseudo, Redirect => delete $arg{Redirect} if exists $arg{Redirect}; 549 push @pseudo, Redirect => delete $arg{Redirect} if exists $arg{Redirect};
368 550
369 my $recurse = exists $arg{recurse} ? delete $arg{recurse} : $MAX_RECURSE; 551 my $recurse = exists $arg{recurse} ? delete $arg{recurse} : $MAX_RECURSE;
370 552
371 return $cb->(undef, { Status => 599, Reason => "Too many redirections", @pseudo }) 553 return $cb->(undef, { @pseudo, Status => 599, Reason => "Too many redirections" })
372 if $recurse < 0; 554 if $recurse < 0;
373 555
374 my $proxy = $arg{proxy} || $PROXY; 556 my $proxy = $arg{proxy} || $PROXY;
375 my $timeout = $arg{timeout} || $TIMEOUT; 557 my $timeout = $arg{timeout} || $TIMEOUT;
376 558
… …
379 561
380 $uscheme = lc $uscheme; 562 $uscheme = lc $uscheme;
381 563
382 my $uport = $uscheme eq "http" ? 80 564 my $uport = $uscheme eq "http" ? 80
383 : $uscheme eq "https" ? 443 565 : $uscheme eq "https" ? 443
384 : return $cb->(undef, { Status => 599, Reason => "Only http and https URL schemes supported", @pseudo }); 566 : return $cb->(undef, { @pseudo, Status => 599, Reason => "Only http and https URL schemes supported" });
385 567
386 $uauthority =~ /^(?: .*\@ )? ([^\@:]+) (?: : (\d+) )?$/x 568 $uauthority =~ /^(?: .*\@ )? ([^\@:]+) (?: : (\d+) )?$/x
387 or return $cb->(undef, { Status => 599, Reason => "Unparsable URL", @pseudo }); 569 or return $cb->(undef, { @pseudo, Status => 599, Reason => "Unparsable URL" });
388 570
389 my $uhost = $1; 571 my $uhost = $1;
390 $uport = $2 if defined $2; 572 $uport = $2 if defined $2;
391 573
392 $hdr{host} = defined $2 ? "$uhost:$2" : "$uhost" 574 $hdr{host} = defined $2 ? "$uhost:$2" : "$uhost"
… …
397 579
398 $upath =~ s%^/?%/%; 580 $upath =~ s%^/?%/%;
399 581
400 # cookie processing 582 # cookie processing
401 if (my $jar = $arg{cookie_jar}) { 583 if (my $jar = $arg{cookie_jar}) {
402 %$jar = () if $jar->{version} != 1; 584 my $cookies = cookie_jar_extract $jar, $uscheme, $uhost, $upath;
403 585
404 my @cookie;
405
406 while (my ($chost, $v) = each %$jar) {
407 if ($chost =~ /^\./) {
408 next unless $chost eq substr $uhost, -length $chost;
409 } elsif ($chost =~ /\./) {
410 next unless $chost eq $uhost;
411 } else {
412 next;
413 }
414
415 while (my ($cpath, $v) = each %$v) {
416 next unless $cpath eq substr $upath, 0, length $cpath;
417
418 while (my ($k, $v) = each %$v) {
419 next if $uscheme ne "https" && exists $v->{secure};
420 my $value = $v->{value};
421 $value =~ s/([\\"])/\\$1/g;
422 push @cookie, "$k=\"$value\"";
423 }
424 }
425 }
426
427 $hdr{cookie} = join "; ", @cookie 586 $hdr{cookie} = join "; ", @$cookies
428 if @cookie; 587 if @$cookies;
429 } 588 }
430 589
431 my ($rhost, $rport, $rscheme, $rpath); # request host, port, path 590 my ($rhost, $rport, $rscheme, $rpath); # request host, port, path
432 591
433 if ($proxy) { 592 if ($proxy) {
… …
441 } else { 600 } else {
442 ($rhost, $rport, $rscheme, $rpath) = ($uhost, $uport, $uscheme, $upath); 601 ($rhost, $rport, $rscheme, $rpath) = ($uhost, $uport, $uscheme, $upath);
443 } 602 }
444 603
445 # leave out fragment and query string, just a heuristic 604 # leave out fragment and query string, just a heuristic
446 $hdr{referer} ||= "$uscheme://$uauthority$upath" unless exists $hdr{referer}; 605 $hdr{referer} = "$uscheme://$uauthority$upath" unless exists $hdr{referer};
447 $hdr{"user-agent"} ||= $USERAGENT unless exists $hdr{"user-agent"}; 606 $hdr{"user-agent"} = $USERAGENT unless exists $hdr{"user-agent"};
448 607
449 $hdr{"content-length"} = length $arg{body} 608 $hdr{"content-length"} = length $arg{body}
450 if length $arg{body} || $method ne "GET"; 609 if length $arg{body} || $method ne "GET";
451 610
611 $hdr{connection} = "close TE"; #1.1
612 $hdr{te} = "trailers" unless exists $hdr{te}; #1.1
613
452 my %state = (connect_guard => 1); 614 my %state = (connect_guard => 1);
453 615
454 _get_slot $uhost, sub { 616 _get_slot $uhost, sub {
455 $state{slot_guard} = shift; 617 $state{slot_guard} = shift;
456 618
457 return unless $state{connect_guard}; 619 return unless $state{connect_guard};
458 620
459 $state{connect_guard} = AnyEvent::Socket::tcp_connect $rhost, $rport, sub { 621 my $ae_error = 595; # connecting
622
623 my $connect_cb = sub {
460 $state{fh} = shift 624 $state{fh} = shift
461 or do { 625 or do {
462 my $err = "$!"; 626 my $err = "$!";
463 %state = (); 627 %state = ();
464 return $cb->(undef, { Status => 599, Reason => $err, @pseudo }); 628 return $cb->(undef, { @pseudo, Status => $ae_error, Reason => $err });
465 }; 629 };
466
467 pop; # free memory, save a tree
468 630
469 return unless delete $state{connect_guard}; 631 return unless delete $state{connect_guard};
470 632
471 # get handle 633 # get handle
472 $state{handle} = new AnyEvent::Handle 634 $state{handle} = new AnyEvent::Handle
… …
475 tls_ctx => $arg{tls_ctx}, 637 tls_ctx => $arg{tls_ctx},
476 # these need to be reconfigured on keepalive handles 638 # these need to be reconfigured on keepalive handles
477 timeout => $timeout, 639 timeout => $timeout,
478 on_error => sub { 640 on_error => sub {
479 %state = (); 641 %state = ();
480 $cb->(undef, { Status => 599, Reason => $_[2], @pseudo }); 642 $cb->(undef, { @pseudo, Status => $ae_error, Reason => $_[2] });
481 }, 643 },
482 on_eof => sub { 644 on_eof => sub {
483 %state = (); 645 %state = ();
484 $cb->(undef, { Status => 599, Reason => "Unexpected end-of-file", @pseudo }); 646 $cb->(undef, { @pseudo, Status => $ae_error, Reason => "Unexpected end-of-file" });
485 }, 647 },
486 ; 648 ;
487 649
488 # limit the number of persistent connections 650 # limit the number of persistent connections
489 # keepalive not yet supported 651 # keepalive not yet supported
… …
491# ++$KA_COUNT{$_[1]}; 653# ++$KA_COUNT{$_[1]};
492# $state{handle}{ka_count_guard} = AnyEvent::Util::guard { 654# $state{handle}{ka_count_guard} = AnyEvent::Util::guard {
493# --$KA_COUNT{$_[1]} 655# --$KA_COUNT{$_[1]}
494# }; 656# };
495# $hdr{connection} = "keep-alive"; 657# $hdr{connection} = "keep-alive";
496# } else {
497 delete $hdr{connection};
498# } 658# }
499 659
500 $state{handle}->starttls ("connect") if $rscheme eq "https"; 660 $state{handle}->starttls ("connect") if $rscheme eq "https";
501 661
502 # handle actual, non-tunneled, request 662 # handle actual, non-tunneled, request
503 my $handle_actual_request = sub { 663 my $handle_actual_request = sub {
664 $ae_error = 596; # request phase
665
504 $state{handle}->starttls ("connect") if $uscheme eq "https" && !exists $state{handle}{tls}; 666 $state{handle}->starttls ("connect") if $uscheme eq "https" && !exists $state{handle}{tls};
505 667
506 # send request 668 # send request
507 $state{handle}->push_write ( 669 $state{handle}->push_write (
508 "$method $rpath HTTP/1.0\015\012" 670 "$method $rpath HTTP/1.1\015\012"
509 . (join "", map "\u$_: $hdr{$_}\015\012", grep defined $hdr{$_}, keys %hdr) 671 . (join "", map "\u$_: $hdr{$_}\015\012", grep defined $hdr{$_}, keys %hdr)
510 . "\015\012" 672 . "\015\012"
511 . (delete $arg{body}) 673 . (delete $arg{body})
512 ); 674 );
513 675
… …
515 return unless %state; 677 return unless %state;
516 678
517 %hdr = (); # reduce memory usage, save a kitten, also make it possible to re-use 679 %hdr = (); # reduce memory usage, save a kitten, also make it possible to re-use
518 680
519 # status line and headers 681 # status line and headers
520 $state{handle}->push_read (line => $qr_nlnl, sub { 682 $state{read_response} = sub {
521 for ("$_[1]") { 683 for ("$_[1]") {
522 y/\015//d; # weed out any \015, as they show up in the weirdest of places. 684 y/\015//d; # weed out any \015, as they show up in the weirdest of places.
523 685
524 /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\015\012]*) )? \015?\012/igxc 686 /^HTTP\/0*([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\012]*) )? \012/gxci
525 or return (%state = (), $cb->(undef, { Status => 599, Reason => "Invalid server response", @pseudo })); 687 or return (%state = (), $cb->(undef, { @pseudo, Status => 599, Reason => "Invalid server response" }));
688
689 # 100 Continue handling
690 # should not happen as we don't send expect: 100-continue,
691 # but we handle it just in case.
692 # since we send the request body regardless, if we get an error
693 # we are out of-sync, which we currently do NOT handle correctly.
694 return $state{handle}->push_read (line => $qr_nlnl, $state{read_response})
695 if $2 eq 100;
526 696
527 push @pseudo, 697 push @pseudo,
528 HTTPVersion => $1, 698 HTTPVersion => $1,
529 Status => $2, 699 Status => $2,
530 Reason => $3, 700 Reason => $3,
531 ; 701 ;
532 702
533 # things seen, not parsed: 703 my $hdr = parse_hdr
534 # p3pP="NON CUR OTPi OUR NOR UNI"
535
536 $hdr{lc $1} .= ",$2"
537 while /\G
538 ([^:\000-\037]*):
539 [\011\040]*
540 ((?: [^\012]+ | \012[\011\040] )*)
541 \012
542 /gxc;
543
544 /\G$/
545 or return (%state = (), $cb->(undef, { Status => 599, Reason => "Garbled response headers", @pseudo })); 704 or return (%state = (), $cb->(undef, { @pseudo, Status => 599, Reason => "Garbled response headers" }));
705
706 %hdr = (%$hdr, @pseudo);
546 } 707 }
547
548 # remove the "," prefix we added to all headers above
549 substr $_, 0, 1, ""
550 for values %hdr;
551
552 # patch in all pseudo headers
553 %hdr = (%hdr, @pseudo);
554 708
555 # redirect handling 709 # redirect handling
556 # microsoft and other shitheads don't give a shit for following standards, 710 # microsoft and other shitheads don't give a shit for following standards,
557 # try to support some common forms of broken Location headers. 711 # try to support some common forms of broken Location headers.
558 if ($hdr{location} !~ /^(?: $ | [^:\/?\#]+ : )/x) { 712 if ($hdr{location} !~ /^(?: $ | [^:\/?\#]+ : )/x) {
… …
572 726
573 if ($recurse) { 727 if ($recurse) {
574 my $status = $hdr{Status}; 728 my $status = $hdr{Status};
575 729
576 # industry standard is to redirect POST as GET for 730 # industry standard is to redirect POST as GET for
577 # 301, 302 and 303, in contrast to http/1.0 and 1.1. 731 # 301, 302 and 303, in contrast to HTTP/1.0 and 1.1.
578 # also, the UA should ask the user for 301 and 307 and POST, 732 # also, the UA should ask the user for 301 and 307 and POST,
579 # industry standard seems to be to simply follow. 733 # industry standard seems to be to simply follow.
580 # we go with the industry standard. 734 # we go with the industry standard.
581 if ($status == 301 or $status == 302 or $status == 303) { 735 if ($status == 301 or $status == 302 or $status == 303) {
582 # HTTP/1.1 is unclear on how to mutate the method 736 # HTTP/1.1 is unclear on how to mutate the method
… …
585 } elsif ($status == 307) { 739 } elsif ($status == 307) {
586 $redirect = 1; 740 $redirect = 1;
587 } 741 }
588 } 742 }
589 743
590 my $finish = sub { 744 my $finish = sub { # ($data, $err_status, $err_reason[, $keepalive])
745 my $may_keep_alive = $_[3];
746
591 $state{handle}->destroy if $state{handle}; 747 $state{handle}->destroy if $state{handle};
592 %state = (); 748 %state = ();
593 749
750 if (defined $_[1]) {
751 $hdr{OrigStatus} = $hdr{Status}; $hdr{Status} = $_[1];
752 $hdr{OrigReason} = $hdr{Reason}; $hdr{Reason} = $_[2];
753 }
754
594 # set-cookie processing 755 # set-cookie processing
595 if ($arg{cookie_jar}) { 756 if ($arg{cookie_jar}) {
596 for ($_[1]{"set-cookie"}) { 757 cookie_jar_set_cookie $arg{cookie_jar}, $hdr{"set-cookie"}, $uhost;
597 # parse NAME=VALUE
598 my @kv;
599
600 while (/\G\s* ([^=;,[:space:]]+) \s*=\s* (?: "((?:[^\\"]+|\\.)*)" | ([^=;,[:space:]]*) )/gcxs) {
601 my $name = $1;
602 my $value = $3;
603
604 unless ($value) {
605 $value = $2;
606 $value =~ s/\\(.)/$1/gs;
607 }
608
609 push @kv, $name => $value;
610
611 last unless /\G\s*;/gc;
612 }
613
614 last unless @kv;
615
616 my $name = shift @kv;
617 my %kv = (value => shift @kv, @kv);
618
619 my $cdom;
620 my $cpath = (delete $kv{path}) || "/";
621
622 if (exists $kv{domain}) {
623 $cdom = delete $kv{domain};
624
625 $cdom =~ s/^\.?/./; # make sure it starts with a "."
626
627 next if $cdom =~ /\.$/;
628
629 # this is not rfc-like and not netscape-like. go figure.
630 my $ndots = $cdom =~ y/.//;
631 next if $ndots < ($cdom =~ /\.[^.][^.]\.[^.][^.]$/ ? 3 : 2);
632 } else {
633 $cdom = $uhost;
634 }
635
636 # store it
637 $arg{cookie_jar}{version} = 1;
638 $arg{cookie_jar}{$cdom}{$cpath}{$name} = \%kv;
639
640 redo if /\G\s*,/gc;
641 }
642 } 758 }
643 759
644 if ($redirect && exists $hdr{location}) { 760 if ($redirect && exists $hdr{location}) {
645 # we ignore any errors, as it is very common to receive 761 # we ignore any errors, as it is very common to receive
646 # Content-Length != 0 but no actual body 762 # Content-Length != 0 but no actual body
647 # we also access %hdr, as $_[1] might be an erro 763 # we also access %hdr, as $_[1] might be an erro
648 http_request ( 764 http_request (
649 $method => $hdr{location}, 765 $method => $hdr{location},
650 %arg, 766 %arg,
651 recurse => $recurse - 1, 767 recurse => $recurse - 1,
652 Redirect => \@_, 768 Redirect => [$_[0], \%hdr],
653 $cb); 769 $cb);
654 } else { 770 } else {
655 $cb->($_[0], $_[1]); 771 $cb->($_[0], \%hdr);
656 } 772 }
657 }; 773 };
658 774
775 $ae_error = 597; # body phase
776
659 my $len = $hdr{"content-length"}; 777 my $len = $hdr{"content-length"};
660 778
661 if (!$redirect && $arg{on_header} && !$arg{on_header}(\%hdr)) { 779 if (!$redirect && $arg{on_header} && !$arg{on_header}(\%hdr)) {
662 $finish->(undef, { Status => 598, Reason => "Request cancelled by on_header", @pseudo }); 780 $finish->(undef, 598 => "Request cancelled by on_header");
663 } elsif ( 781 } elsif (
664 $hdr{Status} =~ /^(?:1..|[23]04)$/ 782 $hdr{Status} =~ /^(?:1..|204|205|304)$/
665 or $method eq "HEAD" 783 or $method eq "HEAD"
666 or (defined $len && !$len) 784 or (defined $len && !$len)
667 ) { 785 ) {
668 # no body 786 # no body
669 $finish->("", \%hdr); 787 $finish->("", undef, undef, 1);
670 } else { 788 } else {
671 # body handling, four different code paths 789 # body handling, many different code paths
672 # for want_body_handle, on_body (2x), normal (2x) 790 # - no body expected
673 # we might read too much here, but it does not matter yet (no pers. connections) 791 # - want_body_handle
792 # - te chunked
793 # - 2x length known (with or without on_body)
794 # - 2x length not known (with or without on_body)
674 if (!$redirect && $arg{want_body_handle}) { 795 if (!$redirect && $arg{want_body_handle}) {
675 $_[0]->on_eof (undef); 796 $_[0]->on_eof (undef);
676 $_[0]->on_error (undef); 797 $_[0]->on_error (undef);
677 $_[0]->on_read (undef); 798 $_[0]->on_read (undef);
678 799
679 $finish->(delete $state{handle}, \%hdr); 800 $finish->(delete $state{handle});
801
802 } elsif ($hdr{"transfer-encoding"} =~ /\bchunked\b/i) {
803 my $cl = 0;
804 my $body = undef;
805 my $on_body = $arg{on_body} || sub { $body .= shift; 1 };
806
807 my $read_chunk; $read_chunk = sub {
808 $_[1] =~ /^([0-9a-fA-F]+)/
809 or $finish->(undef, $ae_error => "Garbled chunked transfer encoding");
810
811 my $len = hex $1;
812
813 if ($len) {
814 $cl += $len;
815
816 $_[0]->push_read (chunk => $len, sub {
817 $on_body->($_[1], \%hdr)
818 or return $finish->(undef, 598 => "Request cancelled by on_body");
819
820 $_[0]->push_read (line => sub {
821 length $_[1]
822 and return $finish->(undef, $ae_error => "Garbled chunked transfer encoding");
823 $_[0]->push_read (line => $read_chunk);
824 });
825 });
826 } else {
827 $hdr{"content-length"} ||= $cl;
828
829 $_[0]->push_read (line => $qr_nlnl, sub {
830 if (length $_[1]) {
831 for ("$_[1]") {
832 y/\015//d; # weed out any \015, as they show up in the weirdest of places.
833
834 my $hdr = parse_hdr
835 or return $finish->(undef, $ae_error => "Garbled response trailers");
836
837 %hdr = (%hdr, %$hdr);
838 }
839 }
840
841 $finish->($body, undef, undef, 1);
842 });
843 }
844 };
845
846 $_[0]->push_read (line => $read_chunk);
680 847
681 } elsif ($arg{on_body}) { 848 } elsif ($arg{on_body}) {
682 $_[0]->on_error (sub { $finish->(undef, { Status => 599, Reason => $_[2], @pseudo }) });
683 if ($len) { 849 if ($len) {
684 $_[0]->on_eof (undef);
685 $_[0]->on_read (sub { 850 $_[0]->on_read (sub {
686 $len -= length $_[0]{rbuf}; 851 $len -= length $_[0]{rbuf};
687 852
688 $arg{on_body}(delete $_[0]{rbuf}, \%hdr) 853 $arg{on_body}(delete $_[0]{rbuf}, \%hdr)
689 or $finish->(undef, { Status => 598, Reason => "Request cancelled by on_body", @pseudo }); 854 or return $finish->(undef, 598 => "Request cancelled by on_body");
690 855
691 $len > 0 856 $len > 0
692 or $finish->("", \%hdr); 857 or $finish->("", undef, undef, 1);
693 }); 858 });
694 } else { 859 } else {
695 $_[0]->on_eof (sub { 860 $_[0]->on_eof (sub {
696 $finish->("", \%hdr); 861 $finish->("");
697 }); 862 });
698 $_[0]->on_read (sub { 863 $_[0]->on_read (sub {
699 $arg{on_body}(delete $_[0]{rbuf}, \%hdr) 864 $arg{on_body}(delete $_[0]{rbuf}, \%hdr)
700 or $finish->(undef, { Status => 598, Reason => "Request cancelled by on_body", @pseudo }); 865 or $finish->(undef, 598 => "Request cancelled by on_body");
701 }); 866 });
702 } 867 }
703 } else { 868 } else {
704 $_[0]->on_eof (undef); 869 $_[0]->on_eof (undef);
705 870
706 if ($len) { 871 if ($len) {
707 $_[0]->on_error (sub { $finish->(undef, { Status => 599, Reason => $_[2], @pseudo }) });
708 $_[0]->on_read (sub { 872 $_[0]->on_read (sub {
709 $finish->((substr delete $_[0]{rbuf}, 0, $len, ""), \%hdr) 873 $finish->((substr delete $_[0]{rbuf}, 0, $len, ""), undef, undef, 1)
710 if $len <= length $_[0]{rbuf}; 874 if $len <= length $_[0]{rbuf};
711 }); 875 });
712 } else { 876 } else {
713 $_[0]->on_error (sub { 877 $_[0]->on_error (sub {
714 ($! == Errno::EPIPE || !$!) 878 ($! == Errno::EPIPE || !$!)
715 ? $finish->(delete $_[0]{rbuf}, \%hdr) 879 ? $finish->(delete $_[0]{rbuf})
716 : $finish->(undef, { Status => 599, Reason => $_[2], @pseudo }); 880 : $finish->(undef, $ae_error => $_[2]);
717 }); 881 });
718 $_[0]->on_read (sub { }); 882 $_[0]->on_read (sub { });
719 } 883 }
720 } 884 }
721 } 885 }
722 }); 886 };
887
888 $state{handle}->push_read (line => $qr_nlnl, $state{read_response});
723 }; 889 };
724 890
725 # now handle proxy-CONNECT method 891 # now handle proxy-CONNECT method
726 if ($proxy && $uscheme eq "https") { 892 if ($proxy && $uscheme eq "https") {
727 # oh dear, we have to wrap it into a connect request 893 # oh dear, we have to wrap it into a connect request
728 894
729 # maybe re-use $uauthority with patched port? 895 # maybe re-use $uauthority with patched port?
730 $state{handle}->push_write ("CONNECT $uhost:$uport HTTP/1.0\015\012Host: $uhost\015\012\015\012"); 896 $state{handle}->push_write ("CONNECT $uhost:$uport HTTP/1.0\015\012Host: $uhost\015\012\015\012");
731 $state{handle}->push_read (line => $qr_nlnl, sub { 897 $state{handle}->push_read (line => $qr_nlnl, sub {
732 $_[1] =~ /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\015\012]*) )?/ix 898 $_[1] =~ /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\015\012]*) )?/ix
733 or return (%state = (), $cb->(undef, { Status => 599, Reason => "Invalid proxy connect response ($_[1])", @pseudo })); 899 or return (%state = (), $cb->(undef, { @pseudo, Status => 599, Reason => "Invalid proxy connect response ($_[1])" }));
734 900
735 if ($2 == 200) { 901 if ($2 == 200) {
736 $rpath = $upath; 902 $rpath = $upath;
737 &$handle_actual_request; 903 &$handle_actual_request;
738 } else { 904 } else {
739 %state = (); 905 %state = ();
740 $cb->(undef, { Status => $2, Reason => $3, @pseudo }); 906 $cb->(undef, { @pseudo, Status => $2, Reason => $3 });
741 } 907 }
742 }); 908 });
743 } else { 909 } else {
744 &$handle_actual_request; 910 &$handle_actual_request;
745 } 911 }
912 };
746 913
747 }, $arg{on_prepare} || sub { $timeout }; 914 my $tcp_connect = $arg{tcp_connect}
915 || do { require AnyEvent::Socket; \&AnyEvent::Socket::tcp_connect };
916
917 $state{connect_guard} = $tcp_connect->($rhost, $rport, $connect_cb, $arg{on_prepare} || sub { $timeout });
918
748 }; 919 };
749 920
750 defined wantarray && AnyEvent::Util::guard { %state = () } 921 defined wantarray && AnyEvent::Util::guard { %state = () }
751} 922}
752 923
… …
787string of the form C<http://host:port> (optionally C<https:...>), croaks 958string of the form C<http://host:port> (optionally C<https:...>), croaks
788otherwise. 959otherwise.
789 960
790To clear an already-set proxy, use C<undef>. 961To clear an already-set proxy, use C<undef>.
791 962
963=item $date = AnyEvent::HTTP::format_date $timestamp
964
965Takes a POSIX timestamp (seconds since the epoch) and formats it as a HTTP
966Date (RFC 2616).
967
968=item $timestamp = AnyEvent::HTTP::parse_date $date
969
970Takes a HTTP Date (RFC 2616) or a Cookie date (netscape cookie spec) or a
971bunch of minor variations of those, and returns the corresponding POSIX
972timestamp, or C<undef> if the date cannot be parsed.
973
792=item $AnyEvent::HTTP::MAX_RECURSE 974=item $AnyEvent::HTTP::MAX_RECURSE
793 975
794The default value for the C<recurse> request parameter (default: C<10>). 976The default value for the C<recurse> request parameter (default: C<10>).
795 977
796=item $AnyEvent::HTTP::USERAGENT 978=item $AnyEvent::HTTP::USERAGENT
… …
814connections. This number of can be useful for load-leveling. 996connections. This number of can be useful for load-leveling.
815 997
816=back 998=back
817 999
818=cut 1000=cut
1001
1002our @month = qw(Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec);
1003our @weekday = qw(Sun Mon Tue Wed Thu Fri Sat);
1004
1005sub format_date($) {
1006 my ($time) = @_;
1007
1008 # RFC 822/1123 format
1009 my ($S, $M, $H, $mday, $mon, $year, $wday, $yday, undef) = gmtime $time;
1010
1011 sprintf "%s, %02d %s %04d %02d:%02d:%02d GMT",
1012 $weekday[$wday], $mday, $month[$mon], $year + 1900,
1013 $H, $M, $S;
1014}
1015
1016sub parse_date($) {
1017 my ($date) = @_;
1018
1019 my ($d, $m, $y, $H, $M, $S);
1020
1021 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$/) {
1022 # RFC 822/1123, required by RFC 2616 (with " ")
1023 # cookie dates (with "-")
1024
1025 ($d, $m, $y, $H, $M, $S) = ($1, $2, $3, $4, $5, $6);
1026
1027 } 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$/) {
1028 # RFC 850
1029 ($d, $m, $y, $H, $M, $S) = ($1, $2, $3 < 69 ? $3 + 2000 : $3 + 1900, $4, $5, $6);
1030
1031 } 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])$/) {
1032 # ISO C's asctime
1033 ($d, $m, $y, $H, $M, $S) = ($2, $1, $6, $3, $4, $5);
1034 }
1035 # other formats fail in the loop below
1036
1037 for (0..11) {
1038 if ($m eq $month[$_]) {
1039 require Time::Local;
1040 return Time::Local::timegm ($S, $M, $H, $d, $_, $y);
1041 }
1042 }
1043
1044 undef
1045}
819 1046
820sub set_proxy($) { 1047sub set_proxy($) {
821 if (length $_[0]) { 1048 if (length $_[0]) {
822 $_[0] =~ m%^(https?):// ([^:/]+) (?: : (\d*) )?%ix 1049 $_[0] =~ m%^(https?):// ([^:/]+) (?: : (\d*) )?%ix
823 or Carp::croak "$_[0]: invalid proxy URL"; 1050 or Carp::croak "$_[0]: invalid proxy URL";
… …
830# initialise proxy from environment 1057# initialise proxy from environment
831eval { 1058eval {
832 set_proxy $ENV{http_proxy}; 1059 set_proxy $ENV{http_proxy};
833}; 1060};
834 1061
1062=head2 SOCKS PROXIES
1063
1064Socks proxies are not directly supported by AnyEvent::HTTP. You can
1065compile your perl to support socks, or use an external program such as
1066F<socksify> (dante) or F<tsocks> to make your program use a socks proxy
1067transparently.
1068
1069Alternatively, for AnyEvent::HTTP only, you can use your own
1070C<tcp_connect> function that does the proxy handshake - here is an example
1071that works with socks4a proxies:
1072
1073 use Errno;
1074 use AnyEvent::Util;
1075 use AnyEvent::Socket;
1076 use AnyEvent::Handle;
1077
1078 # host, port and username of/for your socks4a proxy
1079 my $socks_host = "10.0.0.23";
1080 my $socks_port = 9050;
1081 my $socks_user = "";
1082
1083 sub socks4a_connect {
1084 my ($host, $port, $connect_cb, $prepare_cb) = @_;
1085
1086 my $hdl = new AnyEvent::Handle
1087 connect => [$socks_host, $socks_port],
1088 on_prepare => sub { $prepare_cb->($_[0]{fh}) },
1089 on_error => sub { $connect_cb->() },
1090 ;
1091
1092 $hdl->push_write (pack "CCnNZ*Z*", 4, 1, $port, 1, $socks_user, $host);
1093
1094 $hdl->push_read (chunk => 8, sub {
1095 my ($hdl, $chunk) = @_;
1096 my ($status, $port, $ipn) = unpack "xCna4", $chunk;
1097
1098 if ($status == 0x5a) {
1099 $connect_cb->($hdl->{fh}, (format_address $ipn) . ":$port");
1100 } else {
1101 $! = Errno::ENXIO; $connect_cb->();
1102 }
1103 });
1104
1105 $hdl
1106 }
1107
1108Use C<socks4a_connect> instead of C<tcp_connect> when doing C<http_request>s,
1109possibly after switching off other proxy types:
1110
1111 AnyEvent::HTTP::set_proxy undef; # usually you do not want other proxies
1112
1113 http_get 'http://www.google.com', tcp_connect => \&socks4a_connect, sub {
1114 my ($data, $headers) = @_;
1115 ...
1116 };
1117
835=head1 SEE ALSO 1118=head1 SEE ALSO
836 1119
837L<AnyEvent>. 1120L<AnyEvent>.
838 1121
839=head1 AUTHOR 1122=head1 AUTHOR

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines