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.45 by root, Fri Jul 17 16:56:36 2009 UTC vs.
Revision 1.54 by root, Wed Jun 16 18:09:52 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 (); 48use AnyEvent::Socket ();
49use AnyEvent::Handle (); 49use AnyEvent::Handle ();
50 50
51use base Exporter::; 51use base Exporter::;
52 52
53our $VERSION = '1.4'; 53our $VERSION = '1.44';
54 54
55our @EXPORT = qw(http_get http_post http_head http_request); 55our @EXPORT = qw(http_get http_post http_head http_request);
56 56
57our $USERAGENT = "Mozilla/5.0 (compatible; U; AnyEvent-HTTP/$VERSION; +http://software.schmorp.de/pkg/AnyEvent)"; 57our $USERAGENT = "Mozilla/5.0 (compatible; U; AnyEvent-HTTP/$VERSION; +http://software.schmorp.de/pkg/AnyEvent)";
58our $MAX_RECURSE = 10; 58our $MAX_RECURSE = 10;
138 138
139=item headers => hashref 139=item headers => hashref
140 140
141The request headers to use. Currently, C<http_request> may provide its 141The request headers to use. Currently, C<http_request> may provide its
142own C<Host:>, C<Content-Length:>, C<Connection:> and C<Cookie:> headers 142own C<Host:>, C<Content-Length:>, C<Connection:> and C<Cookie:> headers
143and will provide defaults for C<User-Agent:> and C<Referer:>. 143and will provide defaults for C<User-Agent:> and C<Referer:> (this can be
144suppressed by using C<undef> for these headers in which case they won't be
145sent at all).
144 146
145=item timeout => $seconds 147=item timeout => $seconds
146 148
147The time-out to use for various stages - each connect attempt will reset 149The time-out to use for various stages - each connect attempt will reset
148the timeout, as will read or write activity. Default timeout is 5 minutes. 150the timeout, as will read or write activity, i.e. this is not an overall
151timeout.
152
153Default timeout is 5 minutes.
149 154
150=item proxy => [$host, $port[, $scheme]] or undef 155=item proxy => [$host, $port[, $scheme]] or undef
151 156
152Use the given http proxy for all requests. If not specified, then the 157Use the given http proxy for all requests. If not specified, then the
153default proxy (as specified by C<$ENV{http_proxy}>) is used. 158default proxy (as specified by C<$ENV{http_proxy}>) is used.
154 159
155C<$scheme> must be either missing or C<http> for HTTP, or C<https> for 160C<$scheme> must be either missing, C<http> for HTTP or C<https> for
156HTTPS. 161HTTPS.
157 162
158=item body => $string 163=item body => $string
159 164
160The request body, usually empty. Will be-sent as-is (future versions of 165The request body, usually empty. Will be-sent as-is (future versions of
185verification, highest compatibility) and high-security (CA and common-name 190verification, highest compatibility) and high-security (CA and common-name
186verification) TLS context. 191verification) TLS context.
187 192
188The default for this option is C<low>, which could be interpreted as "give 193The default for this option is C<low>, which could be interpreted as "give
189me the page, no matter what". 194me the page, no matter what".
195
196=item on_prepare => $callback->($fh)
197
198In rare cases you need to "tune" the socket before it is used to
199connect (for exmaple, to bind it on a given IP address). This parameter
200overrides the prepare callback passed to C<AnyEvent::Socket::tcp_connect>
201and behaves exactly the same way (e.g. it has to provide a
202timeout). See the description for the C<$prepare_cb> argument of
203C<AnyEvent::Socket::tcp_connect> for details.
190 204
191=item on_header => $callback->($headers) 205=item on_header => $callback->($headers)
192 206
193When specified, this callback will be called with the header hash as soon 207When specified, this callback will be called with the header hash as soon
194as headers have been successfully received from the remote server (not on 208as headers have been successfully received from the remote server (not on
312 push @{ $CO_SLOT{$_[0]}[1] }, $_[1]; 326 push @{ $CO_SLOT{$_[0]}[1] }, $_[1];
313 327
314 _slot_schedule $_[0]; 328 _slot_schedule $_[0];
315} 329}
316 330
317our $qr_nl = qr<\015?\012>; 331our $qr_nl = qr{\015?\012};
318our $qr_nlnl = qr<\015?\012\015?\012>; 332our $qr_nlnl = qr{(?<![^\012])\015?\012};
319 333
320our $TLS_CTX_LOW = { cache => 1, sslv2 => 1 }; 334our $TLS_CTX_LOW = { cache => 1, sslv2 => 1 };
321our $TLS_CTX_HIGH = { cache => 1, verify => 1, verify_peername => "https" }; 335our $TLS_CTX_HIGH = { cache => 1, verify => 1, verify_peername => "https" };
322 336
323sub http_request($$@) { 337sub http_request($$@) {
358 or return $cb->(undef, { Status => 599, Reason => "Unparsable URL", URL => $url }); 372 or return $cb->(undef, { Status => 599, Reason => "Unparsable URL", URL => $url });
359 373
360 my $uhost = $1; 374 my $uhost = $1;
361 $uport = $2 if defined $2; 375 $uport = $2 if defined $2;
362 376
363 $hdr{host} = defined $2 ? "$uhost:$2" : "$uhost"; 377 $hdr{host} = defined $2 ? "$uhost:$2" : "$uhost"
378 unless exists $hdr{host};
364 379
365 $uhost =~ s/^\[(.*)\]$/$1/; 380 $uhost =~ s/^\[(.*)\]$/$1/;
366 $upath .= "?$query" if length $query; 381 $upath .= "?$query" if length $query;
367 382
368 $upath =~ s%^/?%/%; 383 $upath =~ s%^/?%/%;
401 my ($rhost, $rport, $rscheme, $rpath); # request host, port, path 416 my ($rhost, $rport, $rscheme, $rpath); # request host, port, path
402 417
403 if ($proxy) { 418 if ($proxy) {
404 ($rpath, $rhost, $rport, $rscheme) = ($url, @$proxy); 419 ($rpath, $rhost, $rport, $rscheme) = ($url, @$proxy);
405 420
421 $rscheme = "http" unless defined $rscheme;
422
406 # don't support https requests over https-proxy transport, 423 # don't support https requests over https-proxy transport,
407 # can't be done with tls as spec'ed, unless you double-encrypt. 424 # can't be done with tls as spec'ed, unless you double-encrypt.
408 $rscheme = "http" if $uscheme eq "https" && $rscheme eq "https"; 425 $rscheme = "http" if $uscheme eq "https" && $rscheme eq "https";
409 } else { 426 } else {
410 ($rhost, $rport, $rscheme, $rpath) = ($uhost, $uport, $uscheme, $upath); 427 ($rhost, $rport, $rscheme, $rpath) = ($uhost, $uport, $uscheme, $upath);
411 } 428 }
412 429
413 $hdr{"user-agent"} ||= $USERAGENT; 430 # leave out fragment and query string, just a heuristic
414 $hdr{referer} ||= "$uscheme://$uauthority$upath"; # leave out fragment and query string, just a heuristic 431 $hdr{referer} ||= "$uscheme://$uauthority$upath" unless exists $hdr{referer};
432 $hdr{"user-agent"} ||= $USERAGENT unless exists $hdr{"user-agent"};
415 433
416 $hdr{"content-length"} = length $arg{body}; 434 $hdr{"content-length"} = length $arg{body}
435 if length $arg{body} || $method ne "GET";
417 436
418 my %state = (connect_guard => 1); 437 my %state = (connect_guard => 1);
419 438
420 _get_slot $uhost, sub { 439 _get_slot $uhost, sub {
421 $state{slot_guard} = shift; 440 $state{slot_guard} = shift;
470 $state{handle}->starttls ("connect") if $uscheme eq "https" && !exists $state{handle}{tls}; 489 $state{handle}->starttls ("connect") if $uscheme eq "https" && !exists $state{handle}{tls};
471 490
472 # send request 491 # send request
473 $state{handle}->push_write ( 492 $state{handle}->push_write (
474 "$method $rpath HTTP/1.0\015\012" 493 "$method $rpath HTTP/1.0\015\012"
475 . (join "", map "\u$_: $hdr{$_}\015\012", keys %hdr) 494 . (join "", map "\u$_: $hdr{$_}\015\012", grep defined $hdr{$_}, keys %hdr)
476 . "\015\012" 495 . "\015\012"
477 . (delete $arg{body}) 496 . (delete $arg{body})
478 ); 497 );
498
499 # return if error occured during push_write()
500 return unless %state;
479 501
480 %hdr = (); # reduce memory usage, save a kitten 502 %hdr = (); # reduce memory usage, save a kitten
481 503
482 # status line 504 # status line
483 $state{handle}->push_read (line => $qr_nl, sub { 505 $state{handle}->push_read (line => $qr_nl, sub {
491 URL => ",$url" 513 URL => ",$url"
492 ); 514 );
493 515
494 # headers, could be optimized a bit 516 # headers, could be optimized a bit
495 $state{handle}->unshift_read (line => $qr_nlnl, sub { 517 $state{handle}->unshift_read (line => $qr_nlnl, sub {
496 for ("$_[1]\012") { 518 for ("$_[1]") {
497 y/\015//d; # weed out any \015, as they show up in the weirdest of places. 519 y/\015//d; # weed out any \015, as they show up in the weirdest of places.
498 520
499 # things seen, not parsed: 521 # things seen, not parsed:
500 # p3pP="NON CUR OTPi OUR NOR UNI" 522 # p3pP="NON CUR OTPi OUR NOR UNI"
501 523
598 620
599 redo if /\G\s*,/gc; 621 redo if /\G\s*,/gc;
600 } 622 }
601 } 623 }
602 624
603 if ($redirect) { 625 if ($redirect && exists $hdr{location}) {
604 # we ignore any errors, as it is very common to receive 626 # we ignore any errors, as it is very common to receive
605 # Content-Length != 0 but no actual body 627 # Content-Length != 0 but no actual body
606 # we also access %hdr, as $_[1] might be an erro 628 # we also access %hdr, as $_[1] might be an erro
607 http_request ($method => $hdr{location}, %arg, recurse => $recurse - 1, $cb); 629 http_request ($method => $hdr{location}, %arg, recurse => $recurse - 1, $cb);
608 } else { 630 } else {
697 }); 719 });
698 } else { 720 } else {
699 &$handle_actual_request; 721 &$handle_actual_request;
700 } 722 }
701 723
702 }, sub { 724 }, $arg{on_prepare} || sub { $timeout };
703 $timeout
704 };
705 }; 725 };
706 726
707 defined wantarray && AnyEvent::Util::guard { %state = () } 727 defined wantarray && AnyEvent::Util::guard { %state = () }
708} 728}
709 729
730=over 4 750=over 4
731 751
732=item AnyEvent::HTTP::set_proxy "proxy-url" 752=item AnyEvent::HTTP::set_proxy "proxy-url"
733 753
734Sets the default proxy server to use. The proxy-url must begin with a 754Sets the default proxy server to use. The proxy-url must begin with a
735string of the form C<http://host:port> (optionally C<https:...>). 755string of the form C<http://host:port> (optionally C<https:...>), croaks
756otherwise.
757
758To clear an already-set proxy, use C<undef>.
736 759
737=item $AnyEvent::HTTP::MAX_RECURSE 760=item $AnyEvent::HTTP::MAX_RECURSE
738 761
739The default value for the C<recurse> request parameter (default: C<10>). 762The default value for the C<recurse> request parameter (default: C<10>).
740 763
743The default value for the C<User-Agent> header (the default is 766The default value for the C<User-Agent> header (the default is
744C<Mozilla/5.0 (compatible; U; AnyEvent-HTTP/$VERSION; +http://software.schmorp.de/pkg/AnyEvent)>). 767C<Mozilla/5.0 (compatible; U; AnyEvent-HTTP/$VERSION; +http://software.schmorp.de/pkg/AnyEvent)>).
745 768
746=item $AnyEvent::HTTP::MAX_PER_HOST 769=item $AnyEvent::HTTP::MAX_PER_HOST
747 770
748The maximum number of concurrent conenctions to the same host (identified 771The maximum number of concurrent connections to the same host (identified
749by the hostname). If the limit is exceeded, then the additional requests 772by the hostname). If the limit is exceeded, then the additional requests
750are queued until previous connections are closed. 773are queued until previous connections are closed.
751 774
752The default value for this is C<4>, and it is highly advisable to not 775The default value for this is C<4>, and it is highly advisable to not
753increase it. 776increase it.
761=back 784=back
762 785
763=cut 786=cut
764 787
765sub set_proxy($) { 788sub set_proxy($) {
789 if (length $_[0]) {
766 $PROXY = [$2, $3 || 3128, $1] if $_[0] =~ m%^(https?):// ([^:/]+) (?: : (\d*) )?%ix; 790 $_[0] =~ m%^(https?):// ([^:/]+) (?: : (\d*) )?%ix
791 or Carp::croak "$_[0]: invalid proxy URL";
792 $PROXY = [$2, $3 || 3128, $1]
793 } else {
794 undef $PROXY;
795 }
767} 796}
768 797
769# initialise proxy from environment 798# initialise proxy from environment
799eval {
770set_proxy $ENV{http_proxy}; 800 set_proxy $ENV{http_proxy};
801};
771 802
772=head1 SEE ALSO 803=head1 SEE ALSO
773 804
774L<AnyEvent>. 805L<AnyEvent>.
775 806

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines