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.50 by root, Tue Aug 11 13:20:42 2009 UTC vs.
Revision 1.62 by root, Thu Dec 30 04:30:24 2010 UTC

… …
41use strict; 41use strict;
42no warnings; 42no warnings;
43 43
44use Errno (); 44use Errno ();
45 45
46use AnyEvent 4.8 (); 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.42'; 52our $VERSION = '1.46';
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 as
101second argument. 100second 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" C<HTTPVersion>, C<Status> and C<Reason> 103headers, the "pseudo-headers" (uppercase to avoid clashing with possible
104response headers) C<HTTPVersion>, C<Status> and C<Reason> contain the
105contain the three parts of the HTTP Status-Line of the same name. The 105three parts of the HTTP Status-Line of the same name.
106
106pseudo-header C<URL> contains the original URL (which can differ from the 107The pseudo-header C<URL> contains the actual URL (which can differ from
107requested URL when following redirects). 108the requested URL when following redirects - for example, you might get
109an error that your URL scheme is not supported even though your URL is a
110valid http URL because it redirected to an ftp URL, in which case you can
111look at the URL pseudo header).
112
113The pseudo-header C<Redirect> only exists when the request was a result
114of an internal redirect. In that case it is an array reference with
115the C<($data, $headers)> from the redirect response. Note that this
116response could in turn be the result of a redirect itself, and C<<
117$headers->{Redirect}[1]{Redirect} >> will then contain the original
118response, and so on.
108 119
109If the server sends a header multiple times, then their contents will be 120If the server sends a header multiple times, then their contents will be
110joined together with a comma (C<,>), as per the HTTP spec. 121joined together with a comma (C<,>), as per the HTTP spec.
111 122
112If an internal error occurs, such as not being able to resolve a hostname, 123If an internal error occurs, such as not being able to resolve a hostname,
… …
136Whether to recurse requests or not, e.g. on redirects, authentication 147Whether to recurse requests or not, e.g. on redirects, authentication
137retries and so on, and how often to do so. 148retries and so on, and how often to do so.
138 149
139=item headers => hashref 150=item headers => hashref
140 151
141The request headers to use. Currently, C<http_request> may provide its 152The request headers to use, with the header name (I<MUST be in lowercase>)
142own C<Host:>, C<Content-Length:>, C<Connection:> and C<Cookie:> headers 153as key and header value as hash value.
143and will provide defaults for C<User-Agent:> and C<Referer:> (this can be 154
155Currently, http_request> may provide its own C<host>, C<content-length>,
156C<connection> and C<cookie> headers and will provide defaults for
157C<user-agent> and C<referer> (this can be suppressed by using a value of
144suppressed by using C<undef> for these headers in which case they won't be 158C<undef> for these headers in which case they won't be sent at all).
145sent at all).
146 159
147=item timeout => $seconds 160=item timeout => $seconds
148 161
149The time-out to use for various stages - each connect attempt will reset 162The time-out to use for various stages - each connect attempt will reset
150the timeout, as will read or write activity. Default timeout is 5 minutes. 163the timeout, as will read or write activity, i.e. this is not an overall
164timeout.
165
166Default timeout is 5 minutes.
151 167
152=item proxy => [$host, $port[, $scheme]] or undef 168=item proxy => [$host, $port[, $scheme]] or undef
153 169
154Use the given http proxy for all requests. If not specified, then the 170Use the given http proxy for all requests. If not specified, then the
155default proxy (as specified by C<$ENV{http_proxy}>) is used. 171default proxy (as specified by C<$ENV{http_proxy}>) is used.
… …
187verification, highest compatibility) and high-security (CA and common-name 203verification, highest compatibility) and high-security (CA and common-name
188verification) TLS context. 204verification) TLS context.
189 205
190The default for this option is C<low>, which could be interpreted as "give 206The default for this option is C<low>, which could be interpreted as "give
191me the page, no matter what". 207me the page, no matter what".
208
209=item on_prepare => $callback->($fh)
210
211In rare cases you need to "tune" the socket before it is used to
212connect (for exmaple, to bind it on a given IP address). This parameter
213overrides the prepare callback passed to C<AnyEvent::Socket::tcp_connect>
214and behaves exactly the same way (e.g. it has to provide a
215timeout). See the description for the C<$prepare_cb> argument of
216C<AnyEvent::Socket::tcp_connect> for details.
217
218=item tcp_connect => $callback->($host, $service, $connect_cb, $prepare_cb)
219
220In even rarer cases you want total control over how AnyEvent::HTTP
221establishes connections. Normally it uses L<AnyEvent::Socket::tcp_connect>
222to do this, but you can provide your own C<tcp_connect> function -
223obviously, it has to follow the same calling conventions, except that it
224may always return a connection guard object.
225
226There are probably lots of weird uses for this function, starting from
227tracing the hosts C<http_request> actually tries to connect, to (inexact
228but fast) host => IP address caching or even socks protocol support.
192 229
193=item on_header => $callback->($headers) 230=item on_header => $callback->($headers)
194 231
195When specified, this callback will be called with the header hash as soon 232When specified, this callback will be called with the header hash as soon
196as headers have been successfully received from the remote server (not on 233as headers have been successfully received from the remote server (not on
… …
314 push @{ $CO_SLOT{$_[0]}[1] }, $_[1]; 351 push @{ $CO_SLOT{$_[0]}[1] }, $_[1];
315 352
316 _slot_schedule $_[0]; 353 _slot_schedule $_[0];
317} 354}
318 355
319our $qr_nl = qr{\015?\012};
320our $qr_nlnl = qr{(?<![^\012])\015?\012}; 356our $qr_nlnl = qr{(?<![^\012])\015?\012};
321 357
322our $TLS_CTX_LOW = { cache => 1, sslv2 => 1 }; 358our $TLS_CTX_LOW = { cache => 1, sslv2 => 1 };
323our $TLS_CTX_HIGH = { cache => 1, verify => 1, verify_peername => "https" }; 359our $TLS_CTX_HIGH = { cache => 1, verify => 1, verify_peername => "https" };
324 360
… …
337 while (my ($k, $v) = each %$hdr) { 373 while (my ($k, $v) = each %$hdr) {
338 $hdr{lc $k} = $v; 374 $hdr{lc $k} = $v;
339 } 375 }
340 } 376 }
341 377
378 # pseudo headers for all subsequent responses
379 my @pseudo = (URL => $url);
380 push @pseudo, Redirect => delete $arg{Redirect} if exists $arg{Redirect};
381
342 my $recurse = exists $arg{recurse} ? delete $arg{recurse} : $MAX_RECURSE; 382 my $recurse = exists $arg{recurse} ? delete $arg{recurse} : $MAX_RECURSE;
343 383
344 return $cb->(undef, { Status => 599, Reason => "Too many redirections", URL => $url }) 384 return $cb->(undef, { Status => 599, Reason => "Too many redirections", @pseudo })
345 if $recurse < 0; 385 if $recurse < 0;
346 386
347 my $proxy = $arg{proxy} || $PROXY; 387 my $proxy = $arg{proxy} || $PROXY;
348 my $timeout = $arg{timeout} || $TIMEOUT; 388 my $timeout = $arg{timeout} || $TIMEOUT;
349 389
350 my ($uscheme, $uauthority, $upath, $query, $fragment) = 390 my ($uscheme, $uauthority, $upath, $query, $fragment) =
351 $url =~ m|(?:([^:/?#]+):)?(?://([^/?#]*))?([^?#]*)(?:\?([^#]*))?(?:#(.*))?|; 391 $url =~ m|(?:([^:/?#]+):)?(?://([^/?#]*))?([^?#]*)(?:(\?[^#]*))?(?:#(.*))?|;
352 392
353 $uscheme = lc $uscheme; 393 $uscheme = lc $uscheme;
354 394
355 my $uport = $uscheme eq "http" ? 80 395 my $uport = $uscheme eq "http" ? 80
356 : $uscheme eq "https" ? 443 396 : $uscheme eq "https" ? 443
357 : return $cb->(undef, { Status => 599, Reason => "Only http and https URL schemes supported", URL => $url }); 397 : return $cb->(undef, { Status => 599, Reason => "Only http and https URL schemes supported", @pseudo });
358 398
359 $uauthority =~ /^(?: .*\@ )? ([^\@:]+) (?: : (\d+) )?$/x 399 $uauthority =~ /^(?: .*\@ )? ([^\@:]+) (?: : (\d+) )?$/x
360 or return $cb->(undef, { Status => 599, Reason => "Unparsable URL", URL => $url }); 400 or return $cb->(undef, { Status => 599, Reason => "Unparsable URL", @pseudo });
361 401
362 my $uhost = $1; 402 my $uhost = $1;
363 $uport = $2 if defined $2; 403 $uport = $2 if defined $2;
364 404
365 $hdr{host} = defined $2 ? "$uhost:$2" : "$uhost"; 405 $hdr{host} = defined $2 ? "$uhost:$2" : "$uhost"
406 unless exists $hdr{host};
366 407
367 $uhost =~ s/^\[(.*)\]$/$1/; 408 $uhost =~ s/^\[(.*)\]$/$1/;
368 $upath .= "?$query" if length $query; 409 $upath .= $query if length $query;
369 410
370 $upath =~ s%^/?%/%; 411 $upath =~ s%^/?%/%;
371 412
372 # cookie processing 413 # cookie processing
373 if (my $jar = $arg{cookie_jar}) { 414 if (my $jar = $arg{cookie_jar}) {
… …
416 457
417 # leave out fragment and query string, just a heuristic 458 # leave out fragment and query string, just a heuristic
418 $hdr{referer} ||= "$uscheme://$uauthority$upath" unless exists $hdr{referer}; 459 $hdr{referer} ||= "$uscheme://$uauthority$upath" unless exists $hdr{referer};
419 $hdr{"user-agent"} ||= $USERAGENT unless exists $hdr{"user-agent"}; 460 $hdr{"user-agent"} ||= $USERAGENT unless exists $hdr{"user-agent"};
420 461
421 $hdr{"content-length"} = length $arg{body}; 462 $hdr{"content-length"} = length $arg{body}
463 if length $arg{body} || $method ne "GET";
422 464
423 my %state = (connect_guard => 1); 465 my %state = (connect_guard => 1);
424 466
425 _get_slot $uhost, sub { 467 _get_slot $uhost, sub {
426 $state{slot_guard} = shift; 468 $state{slot_guard} = shift;
427 469
428 return unless $state{connect_guard}; 470 return unless $state{connect_guard};
429 471
430 $state{connect_guard} = AnyEvent::Socket::tcp_connect $rhost, $rport, sub { 472 my $tcp_connect = $arg{tcp_connect}
473 || do { require AnyEvent::Socket; \&AnyEvent::Socket::tcp_connect };
474
475 $state{connect_guard} = $tcp_connect->(
476 $rhost,
477 $rport,
478 sub {
431 $state{fh} = shift 479 $state{fh} = shift
432 or do { 480 or do {
433 my $err = "$!"; 481 my $err = "$!";
434 %state = (); 482 %state = ();
435 return $cb->(undef, { Status => 599, Reason => $err, URL => $url }); 483 return $cb->(undef, { Status => 599, Reason => $err, @pseudo });
436 }; 484 };
437 485
438 pop; # free memory, save a tree 486 pop; # free memory, save a tree
439 487
440 return unless delete $state{connect_guard}; 488 return unless delete $state{connect_guard};
441 489
442 # get handle 490 # get handle
443 $state{handle} = new AnyEvent::Handle 491 $state{handle} = new AnyEvent::Handle
444 fh => $state{fh}, 492 fh => $state{fh},
493 peername => $rhost,
494 tls_ctx => $arg{tls_ctx},
495 # these need to be reconfigured on keepalive handles
445 timeout => $timeout, 496 timeout => $timeout,
446 peername => $rhost, 497 on_error => sub {
447 tls_ctx => $arg{tls_ctx}; 498 %state = ();
499 $cb->(undef, { Status => 599, Reason => $_[2], @pseudo });
500 },
501 on_eof => sub {
502 %state = ();
503 $cb->(undef, { Status => 599, Reason => "Unexpected end-of-file", @pseudo });
504 },
505 ;
448 506
449 # limit the number of persistent connections 507 # limit the number of persistent connections
450 # keepalive not yet supported 508 # keepalive not yet supported
451 if ($KA_COUNT{$_[1]} < $MAX_PERSISTENT_PER_HOST) { 509# if ($KA_COUNT{$_[1]} < $MAX_PERSISTENT_PER_HOST) {
452 ++$KA_COUNT{$_[1]}; 510# ++$KA_COUNT{$_[1]};
453 $state{handle}{ka_count_guard} = AnyEvent::Util::guard { 511# $state{handle}{ka_count_guard} = AnyEvent::Util::guard {
454 --$KA_COUNT{$_[1]} 512# --$KA_COUNT{$_[1]}
455 }; 513# };
456 $hdr{connection} = "keep-alive"; 514# $hdr{connection} = "keep-alive";
457 } else { 515# } else {
458 delete $hdr{connection}; 516 delete $hdr{connection};
459 } 517# }
460 518
461 # (re-)configure handle
462 $state{handle}->on_error (sub {
463 %state = ();
464 $cb->(undef, { Status => 599, Reason => $_[2], URL => $url });
465 });
466 $state{handle}->on_eof (sub {
467 %state = ();
468 $cb->(undef, { Status => 599, Reason => "Unexpected end-of-file", URL => $url });
469 });
470
471 $state{handle}->starttls ("connect") if $rscheme eq "https"; 519 $state{handle}->starttls ("connect") if $rscheme eq "https";
472 520
473 # handle actual, non-tunneled, request 521 # handle actual, non-tunneled, request
474 my $handle_actual_request = sub { 522 my $handle_actual_request = sub {
475 $state{handle}->starttls ("connect") if $uscheme eq "https" && !exists $state{handle}{tls}; 523 $state{handle}->starttls ("connect") if $uscheme eq "https" && !exists $state{handle}{tls};
476 524
477 # send request 525 # send request
478 $state{handle}->push_write ( 526 $state{handle}->push_write (
479 "$method $rpath HTTP/1.0\015\012" 527 "$method $rpath HTTP/1.0\015\012"
480 . (join "", map "\u$_: $hdr{$_}\015\012", grep defined $hdr{$_}, keys %hdr) 528 . (join "", map "\u$_: $hdr{$_}\015\012", grep defined $hdr{$_}, keys %hdr)
481 . "\015\012" 529 . "\015\012"
482 . (delete $arg{body}) 530 . (delete $arg{body})
483 );
484
485 %hdr = (); # reduce memory usage, save a kitten
486
487 # status line
488 $state{handle}->push_read (line => $qr_nl, sub {
489 $_[1] =~ /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\015\012]*) )?/ix
490 or return (%state = (), $cb->(undef, { Status => 599, Reason => "Invalid server response ($_[1])", URL => $url }));
491
492 my %hdr = ( # response headers
493 HTTPVersion => ",$1",
494 Status => ",$2",
495 Reason => ",$3",
496 URL => ",$url"
497 ); 531 );
498 532
499 # headers, could be optimized a bit 533 # return if error occured during push_write()
534 return unless %state;
535
536 %hdr = (); # reduce memory usage, save a kitten, also make it possible to re-use
537
538 # status line and headers
500 $state{handle}->unshift_read (line => $qr_nlnl, sub { 539 $state{handle}->push_read (line => $qr_nlnl, sub {
501 for ("$_[1]") { 540 for ("$_[1]") {
502 y/\015//d; # weed out any \015, as they show up in the weirdest of places. 541 y/\015//d; # weed out any \015, as they show up in the weirdest of places.
542
543 /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\015\012]*) )? \015?\012/igxc
544 or return (%state = (), $cb->(undef, { Status => 599, Reason => "Invalid server response", @pseudo }));
545
546 push @pseudo,
547 HTTPVersion => $1,
548 Status => $2,
549 Reason => $3,
550 ;
503 551
504 # things seen, not parsed: 552 # things seen, not parsed:
505 # p3pP="NON CUR OTPi OUR NOR UNI" 553 # p3pP="NON CUR OTPi OUR NOR UNI"
506 554
507 $hdr{lc $1} .= ",$2" 555 $hdr{lc $1} .= ",$2"
… …
511 ((?: [^\012]+ | \012[\011\040] )*) 559 ((?: [^\012]+ | \012[\011\040] )*)
512 \012 560 \012
513 /gxc; 561 /gxc;
514 562
515 /\G$/ 563 /\G$/
516 or return (%state = (), $cb->(undef, { Status => 599, Reason => "Garbled response headers", URL => $url })); 564 or return (%state = (), $cb->(undef, { Status => 599, Reason => "Garbled response headers", @pseudo }));
517 } 565 }
518 566
567 # remove the "," prefix we added to all headers above
519 substr $_, 0, 1, "" 568 substr $_, 0, 1, ""
520 for values %hdr; 569 for values %hdr;
570
571 # patch in all pseudo headers
572 %hdr = (%hdr, @pseudo);
521 573
522 # redirect handling 574 # redirect handling
523 # microsoft and other shitheads don't give a shit for following standards, 575 # microsoft and other shitheads don't give a shit for following standards,
524 # try to support some common forms of broken Location headers. 576 # try to support some common forms of broken Location headers.
525 if ($hdr{location} !~ /^(?: $ | [^:\/?\#]+ : )/x) { 577 if ($hdr{location} !~ /^(?: $ | [^:\/?\#]+ : )/x) {
… …
536 } 588 }
537 589
538 my $redirect; 590 my $redirect;
539 591
540 if ($recurse) { 592 if ($recurse) {
541 if ($hdr{Status} =~ /^30[12]$/ && $method ne "POST") { 593 my $status = $hdr{Status};
542 # apparently, mozilla et al. just change POST to GET here 594
543 # more research is needed before we do the same 595 # industry standard is to redirect POST as GET for
544 $redirect = 1; 596 # 301, 302 and 303, in contrast to http/1.0 and 1.1.
545 } elsif ($hdr{Status} == 303) { 597 # also, the UA should ask the user for 301 and 307 and POST,
598 # industry standard seems to be to simply follow.
599 # we go with the industry standard.
600 if ($status == 301 or $status == 302 or $status == 303) {
546 # even http/1.1 is unclear on how to mutate the method 601 # HTTP/1.1 is unclear on how to mutate the method
547 $method = "GET" unless $method eq "HEAD"; 602 $method = "GET" unless $method eq "HEAD";
548 $redirect = 1; 603 $redirect = 1;
549 } elsif ($hdr{Status} == 307 && $method =~ /^(?:GET|HEAD)$/) { 604 } elsif ($status == 307) {
550 $redirect = 1; 605 $redirect = 1;
551 } 606 }
552 } 607 }
553 608
554 my $finish = sub { 609 my $finish = sub {
… …
607 662
608 if ($redirect && exists $hdr{location}) { 663 if ($redirect && exists $hdr{location}) {
609 # we ignore any errors, as it is very common to receive 664 # we ignore any errors, as it is very common to receive
610 # Content-Length != 0 but no actual body 665 # Content-Length != 0 but no actual body
611 # we also access %hdr, as $_[1] might be an erro 666 # we also access %hdr, as $_[1] might be an erro
612 http_request ($method => $hdr{location}, %arg, recurse => $recurse - 1, $cb); 667 http_request (
668 $method => $hdr{location},
669 %arg,
670 recurse => $recurse - 1,
671 Redirect => \@_,
672 $cb);
613 } else { 673 } else {
614 $cb->($_[0], $_[1]); 674 $cb->($_[0], $_[1]);
615 } 675 }
616 }; 676 };
617 677
618 my $len = $hdr{"content-length"}; 678 my $len = $hdr{"content-length"};
619 679
620 if (!$redirect && $arg{on_header} && !$arg{on_header}(\%hdr)) { 680 if (!$redirect && $arg{on_header} && !$arg{on_header}(\%hdr)) {
621 $finish->(undef, { Status => 598, Reason => "Request cancelled by on_header", URL => $url }); 681 $finish->(undef, { Status => 598, Reason => "Request cancelled by on_header", @pseudo });
622 } elsif ( 682 } elsif (
623 $hdr{Status} =~ /^(?:1..|[23]04)$/ 683 $hdr{Status} =~ /^(?:1..|[23]04)$/
624 or $method eq "HEAD" 684 or $method eq "HEAD"
625 or (defined $len && !$len) 685 or (defined $len && !$len)
626 ) { 686 ) {
… …
629 } else { 689 } else {
630 # body handling, four different code paths 690 # body handling, four different code paths
631 # for want_body_handle, on_body (2x), normal (2x) 691 # for want_body_handle, on_body (2x), normal (2x)
632 # we might read too much here, but it does not matter yet (no pers. connections) 692 # we might read too much here, but it does not matter yet (no pers. connections)
633 if (!$redirect && $arg{want_body_handle}) { 693 if (!$redirect && $arg{want_body_handle}) {
634 $_[0]->on_eof (undef); 694 $_[0]->on_eof (undef);
635 $_[0]->on_error (undef); 695 $_[0]->on_error (undef);
636 $_[0]->on_read (undef); 696 $_[0]->on_read (undef);
637 697
638 $finish->(delete $state{handle}, \%hdr); 698 $finish->(delete $state{handle}, \%hdr);
639 699
640 } elsif ($arg{on_body}) { 700 } elsif ($arg{on_body}) {
641 $_[0]->on_error (sub { $finish->(undef, { Status => 599, Reason => $_[2], URL => $url }) }); 701 $_[0]->on_error (sub { $finish->(undef, { Status => 599, Reason => $_[2], @pseudo }) });
642 if ($len) { 702 if ($len) {
643 $_[0]->on_eof (undef); 703 $_[0]->on_eof (undef);
644 $_[0]->on_read (sub { 704 $_[0]->on_read (sub {
645 $len -= length $_[0]{rbuf}; 705 $len -= length $_[0]{rbuf};
646 706
647 $arg{on_body}(delete $_[0]{rbuf}, \%hdr) 707 $arg{on_body}(delete $_[0]{rbuf}, \%hdr)
648 or $finish->(undef, { Status => 598, Reason => "Request cancelled by on_body", URL => $url }); 708 or $finish->(undef, { Status => 598, Reason => "Request cancelled by on_body", @pseudo });
649 709
650 $len > 0 710 $len > 0
651 or $finish->("", \%hdr); 711 or $finish->("", \%hdr);
652 }); 712 });
653 } else { 713 } else {
654 $_[0]->on_eof (sub { 714 $_[0]->on_eof (sub {
655 $finish->("", \%hdr); 715 $finish->("", \%hdr);
656 }); 716 });
657 $_[0]->on_read (sub { 717 $_[0]->on_read (sub {
658 $arg{on_body}(delete $_[0]{rbuf}, \%hdr) 718 $arg{on_body}(delete $_[0]{rbuf}, \%hdr)
659 or $finish->(undef, { Status => 598, Reason => "Request cancelled by on_body", URL => $url }); 719 or $finish->(undef, { Status => 598, Reason => "Request cancelled by on_body", @pseudo });
660 }); 720 });
661 } 721 }
662 } else { 722 } else {
663 $_[0]->on_eof (undef); 723 $_[0]->on_eof (undef);
664 724
665 if ($len) { 725 if ($len) {
666 $_[0]->on_error (sub { $finish->(undef, { Status => 599, Reason => $_[2], URL => $url }) }); 726 $_[0]->on_error (sub { $finish->(undef, { Status => 599, Reason => $_[2], @pseudo }) });
667 $_[0]->on_read (sub { 727 $_[0]->on_read (sub {
668 $finish->((substr delete $_[0]{rbuf}, 0, $len, ""), \%hdr) 728 $finish->((substr delete $_[0]{rbuf}, 0, $len, ""), \%hdr)
669 if $len <= length $_[0]{rbuf}; 729 if $len <= length $_[0]{rbuf};
670 }); 730 });
671 } else { 731 } else {
672 $_[0]->on_error (sub { 732 $_[0]->on_error (sub {
673 $! == Errno::EPIPE || !$! 733 ($! == Errno::EPIPE || !$!)
674 ? $finish->(delete $_[0]{rbuf}, \%hdr) 734 ? $finish->(delete $_[0]{rbuf}, \%hdr)
675 : $finish->(undef, { Status => 599, Reason => $_[2], URL => $url }); 735 : $finish->(undef, { Status => 599, Reason => $_[2], @pseudo });
676 }); 736 });
677 $_[0]->on_read (sub { }); 737 $_[0]->on_read (sub { });
678 } 738 }
679 } 739 }
680 } 740 }
681 }); 741 });
682 }); 742 };
683 };
684 743
685 # now handle proxy-CONNECT method 744 # now handle proxy-CONNECT method
686 if ($proxy && $uscheme eq "https") { 745 if ($proxy && $uscheme eq "https") {
687 # oh dear, we have to wrap it into a connect request 746 # oh dear, we have to wrap it into a connect request
688 747
689 # maybe re-use $uauthority with patched port? 748 # maybe re-use $uauthority with patched port?
690 $state{handle}->push_write ("CONNECT $uhost:$uport HTTP/1.0\015\012Host: $uhost\015\012\015\012"); 749 $state{handle}->push_write ("CONNECT $uhost:$uport HTTP/1.0\015\012Host: $uhost\015\012\015\012");
691 $state{handle}->push_read (line => $qr_nlnl, sub { 750 $state{handle}->push_read (line => $qr_nlnl, sub {
692 $_[1] =~ /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\015\012]*) )?/ix 751 $_[1] =~ /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\015\012]*) )?/ix
693 or return (%state = (), $cb->(undef, { Status => 599, Reason => "Invalid proxy connect response ($_[1])", URL => $url })); 752 or return (%state = (), $cb->(undef, { Status => 599, Reason => "Invalid proxy connect response ($_[1])", @pseudo }));
694 753
695 if ($2 == 200) { 754 if ($2 == 200) {
696 $rpath = $upath; 755 $rpath = $upath;
697 &$handle_actual_request; 756 &$handle_actual_request;
698 } else { 757 } else {
699 %state = (); 758 %state = ();
700 $cb->(undef, { Status => $2, Reason => $3, URL => $url }); 759 $cb->(undef, { Status => $2, Reason => $3, @pseudo });
760 }
701 } 761 });
702 });
703 } else { 762 } else {
704 &$handle_actual_request; 763 &$handle_actual_request;
764 }
765
705 } 766 },
706
707 }, $arg{on_prepare} || sub { $timeout }; 767 $arg{on_prepare} || sub { $timeout }
768 );
708 }; 769 };
709 770
710 defined wantarray && AnyEvent::Util::guard { %state = () } 771 defined wantarray && AnyEvent::Util::guard { %state = () }
711} 772}
712 773
… …
726 &http_request 787 &http_request
727} 788}
728 789
729=back 790=back
730 791
792=head2 DNS CACHING
793
794AnyEvent::HTTP uses the AnyEvent::Socket::tcp_connect function for
795the actual connection, which in turn uses AnyEvent::DNS to resolve
796hostnames. The latter is a simple stub resolver and does no caching
797on its own. If you want DNS caching, you currently have to provide
798your own default resolver (by storing a suitable resolver object in
799C<$AnyEvent::DNS::RESOLVER>).
800
731=head2 GLOBAL FUNCTIONS AND VARIABLES 801=head2 GLOBAL FUNCTIONS AND VARIABLES
732 802
733=over 4 803=over 4
734 804
735=item AnyEvent::HTTP::set_proxy "proxy-url" 805=item AnyEvent::HTTP::set_proxy "proxy-url"
736 806
737Sets the default proxy server to use. The proxy-url must begin with a 807Sets the default proxy server to use. The proxy-url must begin with a
738string of the form C<http://host:port> (optionally C<https:...>). 808string of the form C<http://host:port> (optionally C<https:...>), croaks
809otherwise.
810
811To clear an already-set proxy, use C<undef>.
812
813=item $date = AnyEvent::HTTP::format_date $timestamp
814
815Takes a POSIX timestamp (seconds since the epoch) and formats it as a HTTP
816Date (RFC 2616).
817
818=item $timestamp = AnyEvent::HTTP::parse_date $date
819
820Takes a HTTP Date (RFC 2616) and returns the corresponding POSIX
821timestamp, or C<undef> if the date cannot be parsed.
739 822
740=item $AnyEvent::HTTP::MAX_RECURSE 823=item $AnyEvent::HTTP::MAX_RECURSE
741 824
742The default value for the C<recurse> request parameter (default: C<10>). 825The default value for the C<recurse> request parameter (default: C<10>).
743 826
… …
763 846
764=back 847=back
765 848
766=cut 849=cut
767 850
851our @month = qw(Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec);
852our @weekday = qw(Sun Mon Tue Wed Thu Fri Sat);
853
854sub format_date($) {
855 my ($time) = @_;
856
857 # RFC 822/1123 format
858 my ($S, $M, $H, $mday, $mon, $year, $wday, $yday, undef) = gmtime $time;
859
860 sprintf "%s, %02d %s %04d %02d:%02d:%02d GMT",
861 $weekday[$wday], $mday, $month[$mon], $year + 1900,
862 $H, $M, $S;
863}
864
865sub parse_date($) {
866 my ($date) = @_;
867
868 my ($d, $m, $y, $H, $M, $S);
869
870 if ($date =~ /^[A-Z][a-z][a-z], ([0-9][0-9]) ([A-Z][a-z][a-z]) ([0-9][0-9][0-9][0-9]) ([0-9][0-9]):([0-9][0-9]):([0-9][0-9]) GMT$/) {
871 # RFC 822/1123, required by RFC 2616
872 ($d, $m, $y, $H, $M, $S) = ($1, $2, $3, $4, $5, $6);
873
874 } elsif ($date =~ /^[A-Z][a-z]+, ([0-9][0-9])-([A-Z][a-z][a-z])-([0-9][0-9]) ([0-9][0-9]):([0-9][0-9]):([0-9][0-9]) GMT$/) {
875 # RFC 850
876 ($d, $m, $y, $H, $M, $S) = ($1, $2, $3 < 69 ? $3 + 2000 : $3 + 1900, $4, $5, $6);
877
878 } elsif ($date =~ /^[A-Z][a-z][a-z] ([A-Z][a-z][a-z]) ([0-9 ][0-9]) ([0-9][0-9]):([0-9][0-9]):([0-9][0-9]) ([0-9][0-9][0-9][0-9])$/) {
879 # ISO C's asctime
880 ($d, $m, $y, $H, $M, $S) = ($2, $1, $6, $3, $4, $5);
881 }
882 # other formats fail in the loop below
883
884 for (0..11) {
885 if ($m eq $month[$_]) {
886 require Time::Local;
887 return Time::Local::timegm ($S, $M, $H, $d, $_, $y);
888 }
889 }
890
891 undef
892}
893
768sub set_proxy($) { 894sub set_proxy($) {
895 if (length $_[0]) {
769 $PROXY = [$2, $3 || 3128, $1] if $_[0] =~ m%^(https?):// ([^:/]+) (?: : (\d*) )?%ix; 896 $_[0] =~ m%^(https?):// ([^:/]+) (?: : (\d*) )?%ix
897 or Carp::croak "$_[0]: invalid proxy URL";
898 $PROXY = [$2, $3 || 3128, $1]
899 } else {
900 undef $PROXY;
901 }
770} 902}
771 903
772# initialise proxy from environment 904# initialise proxy from environment
905eval {
773set_proxy $ENV{http_proxy}; 906 set_proxy $ENV{http_proxy};
907};
908
909=head2 SOCKS PROXIES
910
911Socks proxies are not directly supported by AnyEvent::HTTP. You can
912compile your perl to support socks, or use an external program such as
913F<socksify> (dante) or F<tsocks> to make your program use a socks proxy
914transparently.
915
916Alternatively, for AnyEvent::HTTP only, you can use your own
917C<tcp_connect> function that does the proxy handshake - here is an example
918that works with socks4a proxies:
919
920 use Errno;
921 use AnyEvent::Util;
922 use AnyEvent::Socket;
923 use AnyEvent::Handle;
924
925 # host, port and username of/for your socks4a proxy
926 my $socks_host = "10.0.0.23";
927 my $socks_port = 9050;
928 my $socks_user = "";
929
930 sub socks4a_connect {
931 my ($host, $port, $connect_cb, $prepare_cb) = @_;
932
933 my $hdl = new AnyEvent::Handle
934 connect => [$socks_host, $socks_port],
935 on_prepare => sub { $prepare_cb->($_[0]{fh}) },
936 on_error => sub { $connect_cb->() },
937 ;
938
939 $hdl->push_write (pack "CCnNZ*Z*", 4, 1, $port, 1, $socks_user, $host);
940
941 $hdl->push_read (chunk => 8, sub {
942 my ($hdl, $chunk) = @_;
943 my ($status, $port, $ipn) = unpack "xCna4", $chunk;
944
945 if ($status == 0x5a) {
946 $connect_cb->($hdl->{fh}, (format_address $ipn) . ":$port");
947 } else {
948 $! = Errno::ENXIO; $connect_cb->();
949 }
950 });
951
952 $hdl
953 }
954
955Use C<socks4a_connect> instead of C<tcp_connect> when doing C<http_request>s,
956possibly after switching off other proxy types:
957
958 AnyEvent::HTTP::set_proxy undef; # usually you do not want other proxies
959
960 http_get 'http://www.google.com', tcp_connect => \&socks4a_connect, sub {
961 my ($data, $headers) = @_;
962 ...
963 };
774 964
775=head1 SEE ALSO 965=head1 SEE ALSO
776 966
777L<AnyEvent>. 967L<AnyEvent>.
778 968

Diff Legend

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