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.67 by root, Fri Dec 31 06:18:54 2010 UTC vs.
Revision 1.68 by root, Fri Dec 31 19:22:18 2010 UTC

94C<http_request> returns a "cancellation guard" - you have to keep the 94C<http_request> returns a "cancellation guard" - you have to keep the
95object 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
96destroyed before the callback is called, the request will be cancelled. 96destroyed before the callback is called, the request will be cancelled.
97 97
98The 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
99(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
100second argument. 100(and trailers) as second argument.
101 101
102All 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
103headers, the "pseudo-headers" (uppercase to avoid clashing with possible 103headers, the "pseudo-headers" (uppercase to avoid clashing with possible
104response headers) C<HTTPVersion>, C<Status> and C<Reason> contain the 104response 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 105three parts of the HTTP Status-Line of the same name. If an error occurs
150Whether to recurse requests or not, e.g. on redirects, authentication 150Whether to recurse requests or not, e.g. on redirects, authentication
151retries and so on, and how often to do so. 151retries and so on, and how often to do so.
152 152
153=item headers => hashref 153=item headers => hashref
154 154
155The request headers to use. Currently, C<http_request> may provide its 155The request headers to use. Currently, C<http_request> may provide its own
156own C<Host:>, C<Content-Length:>, C<Connection:> and C<Cookie:> headers 156C<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 157will provide defaults for C<TE:>, C<Referer:> and C<User-Agent:> (this can
158suppressed by using C<undef> for these headers in which case they won't be 158be suppressed by using C<undef> for these headers in which case they won't
159sent at all). 159be sent at all).
160 160
161=item timeout => $seconds 161=item timeout => $seconds
162 162
163The time-out to use for various stages - each connect attempt will reset 163The 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 164the timeout, as will read or write activity, i.e. this is not an overall
174C<$scheme> must be either missing, C<http> for HTTP or C<https> for 174C<$scheme> must be either missing, C<http> for HTTP or C<https> for
175HTTPS. 175HTTPS.
176 176
177=item body => $string 177=item body => $string
178 178
179The request body, usually empty. Will be-sent as-is (future versions of 179The request body, usually empty. Will be sent as-is (future versions of
180this module might offer more options). 180this module might offer more options).
181 181
182=item cookie_jar => $hash_ref 182=item cookie_jar => $hash_ref
183 183
184Passing this parameter enables (simplified) cookie-processing, loosely 184Passing this parameter enables (simplified) cookie-processing, loosely
240 240
241This callback is useful, among other things, to quickly reject unwanted 241This callback is useful, among other things, to quickly reject unwanted
242content, which, if it is supposed to be rare, can be faster than first 242content, which, if it is supposed to be rare, can be faster than first
243doing a C<HEAD> request. 243doing a C<HEAD> request.
244 244
245The downside is that cancelling the request makes it impossible to re-use
246the connection. Also, the C<on_header> callback will not receive any
247trailer (headers sent after the response body).
248
245Example: cancel the request unless the content-type is "text/html". 249Example: cancel the request unless the content-type is "text/html".
246 250
247 on_header => sub { 251 on_header => sub {
248 $_[0]{"content-type"} =~ /^text\/html\s*(?:;|$)/ 252 $_[0]{"content-type"} =~ /^text\/html\s*(?:;|$)/
249 }, 253 },
255string instead of the body data. 259string instead of the body data.
256 260
257It has to return either true (in which case AnyEvent::HTTP will continue), 261It 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 262or false, in which case AnyEvent::HTTP will cancel the download (and call
259the completion callback with an error code of C<598>). 263the completion callback with an error code of C<598>).
264
265The downside to cancelling the request is that it makes it impossible to
266re-use the connection.
260 267
261This callback is useful when the data is too large to be held in memory 268This 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 269(so the callback writes it to a file) or when only some information should
263be extracted, or when the body should be processed incrementally. 270be extracted, or when the body should be processed incrementally.
264 271
290If you think you need this, first have a look at C<on_body>, to see if 297If 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. 298that doesn't solve your problem in a better way.
292 299
293=back 300=back
294 301
295Example: make a simple HTTP GET request for http://www.nethype.de/ 302Example: do a simple HTTP GET request for http://www.nethype.de/ and print
303the response body.
296 304
297 http_request GET => "http://www.nethype.de/", sub { 305 http_request GET => "http://www.nethype.de/", sub {
298 my ($body, $hdr) = @_; 306 my ($body, $hdr) = @_;
299 print "$body\n"; 307 print "$body\n";
300 }; 308 };
301 309
302Example: make a HTTP HEAD request on https://www.google.com/, use a 310Example: do a HTTP HEAD request on https://www.google.com/, use a
303timeout of 30 seconds. 311timeout of 30 seconds.
304 312
305 http_request 313 http_request
306 GET => "https://www.google.com", 314 GET => "https://www.google.com",
307 timeout => 30, 315 timeout => 30,
310 use Data::Dumper; 318 use Data::Dumper;
311 print Dumper $hdr; 319 print Dumper $hdr;
312 } 320 }
313 ; 321 ;
314 322
315Example: make another simple HTTP GET request, but immediately try to 323Example: do another simple HTTP GET request, but immediately try to
316cancel it. 324cancel it.
317 325
318 my $request = http_request GET => "http://www.nethype.de/", sub { 326 my $request = http_request GET => "http://www.nethype.de/", sub {
319 my ($body, $hdr) = @_; 327 my ($body, $hdr) = @_;
320 print "$body\n"; 328 print "$body\n";
486 $hdr{"user-agent"} = $USERAGENT unless exists $hdr{"user-agent"}; 494 $hdr{"user-agent"} = $USERAGENT unless exists $hdr{"user-agent"};
487 495
488 $hdr{"content-length"} = length $arg{body} 496 $hdr{"content-length"} = length $arg{body}
489 if length $arg{body} || $method ne "GET"; 497 if length $arg{body} || $method ne "GET";
490 498
491 $hdr{connection} = "close TE"; 499 $hdr{connection} = "close TE"; #1.1
492 $hdr{te} = "trailers" unless exists $hdr{te}; 500 $hdr{te} = "trailers" unless exists $hdr{te}; #1.1
493 501
494 my %state = (connect_guard => 1); 502 my %state = (connect_guard => 1);
495 503
496 _get_slot $uhost, sub { 504 _get_slot $uhost, sub {
497 $state{slot_guard} = shift; 505 $state{slot_guard} = shift;
533# ++$KA_COUNT{$_[1]}; 541# ++$KA_COUNT{$_[1]};
534# $state{handle}{ka_count_guard} = AnyEvent::Util::guard { 542# $state{handle}{ka_count_guard} = AnyEvent::Util::guard {
535# --$KA_COUNT{$_[1]} 543# --$KA_COUNT{$_[1]}
536# }; 544# };
537# $hdr{connection} = "keep-alive"; 545# $hdr{connection} = "keep-alive";
538# } else {
539# delete $hdr{connection};
540# } 546# }
541 547
542 $state{handle}->starttls ("connect") if $rscheme eq "https"; 548 $state{handle}->starttls ("connect") if $rscheme eq "https";
543 549
544 # handle actual, non-tunneled, request 550 # handle actual, non-tunneled, request
557 return unless %state; 563 return unless %state;
558 564
559 %hdr = (); # reduce memory usage, save a kitten, also make it possible to re-use 565 %hdr = (); # reduce memory usage, save a kitten, also make it possible to re-use
560 566
561 # status line and headers 567 # status line and headers
562 $state{handle}->push_read (line => $qr_nlnl, sub { 568 $state{read_response} = sub {
563 my $keepalive = pop;
564
565 for ("$_[1]") { 569 for ("$_[1]") {
566 y/\015//d; # weed out any \015, as they show up in the weirdest of places. 570 y/\015//d; # weed out any \015, as they show up in the weirdest of places.
567 571
568 /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\012]*) )? \012/igxc 572 /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\012]*) )? \012/igxc
569 or return (%state = (), $cb->(undef, { @pseudo, Status => 599, Reason => "Invalid server response" })); 573 or return (%state = (), $cb->(undef, { @pseudo, Status => 599, Reason => "Invalid server response" }));
574
575 # 100 Continue handling
576 # should not happen as we don't send expect: 100-continue,
577 # but we handle it just in case.
578 # since we send the request body regardless, if we get an error
579 # we are out of-sync, which we currently do NOT handle correctly.
580 return $state{handle}->push_read (line => $qr_nlnl, $state{read_response})
581 if $2 eq 100;
570 582
571 push @pseudo, 583 push @pseudo,
572 HTTPVersion => $1, 584 HTTPVersion => $1,
573 Status => $2, 585 Status => $2,
574 Reason => $3, 586 Reason => $3,
614 $redirect = 1; 626 $redirect = 1;
615 } 627 }
616 } 628 }
617 629
618 my $finish = sub { # ($data, $err_status, $err_reason[, $keepalive]) 630 my $finish = sub { # ($data, $err_status, $err_reason[, $keepalive])
631 my $keepalive = pop;
632
619 $state{handle}->destroy if $state{handle}; 633 $state{handle}->destroy if $state{handle};
620 %state = (); 634 %state = ();
621 635
622 if (defined $_[1]) { 636 if (defined $_[1]) {
623 $hdr{OrigStatus} = $hdr{Status}; $hdr{Status} = $_[1]; 637 $hdr{OrigStatus} = $hdr{Status}; $hdr{Status} = $_[1];
712 $_[0]->on_error (undef); 726 $_[0]->on_error (undef);
713 $_[0]->on_read (undef); 727 $_[0]->on_read (undef);
714 728
715 $finish->(delete $state{handle}); 729 $finish->(delete $state{handle});
716 730
717 } elsif ($hdr{"transfer-encoding"} =~ /chunked/) { 731 } elsif ($hdr{"transfer-encoding"} =~ /\bchunked\b/i) {
732 my $cl = 0;
718 my $body = undef; 733 my $body = undef;
719 my $on_body = $arg{on_body} || sub { $body .= shift; 1 }; 734 my $on_body = $arg{on_body} || sub { $body .= shift; 1 };
720 735
721 $_[0]->on_error (sub { $finish->(undef, 599 => $_[2]) }); 736 $_[0]->on_error (sub { $finish->(undef, 599 => $_[2]) });
722 737
725 or $finish->(undef, 599 => "Garbled chunked transfer encoding"); 740 or $finish->(undef, 599 => "Garbled chunked transfer encoding");
726 741
727 my $len = hex $1; 742 my $len = hex $1;
728 743
729 if ($len) { 744 if ($len) {
745 $cl += $len;
746
730 $_[0]->push_read (chunk => hex $1, sub { 747 $_[0]->push_read (chunk => $len, sub {
731 $on_body->($_[1], \%hdr) 748 $on_body->($_[1], \%hdr)
732 or return $finish->(undef, 598 => "Request cancelled by on_body"); 749 or return $finish->(undef, 598 => "Request cancelled by on_body");
733 750
734 $_[0]->push_read (line => sub { 751 $_[0]->push_read (line => sub {
735 length $_[1] 752 length $_[1]
736 and return $finish->(undef, 599 => "Garbled chunked transfer encoding"); 753 and return $finish->(undef, 599 => "Garbled chunked transfer encoding");
737 $_[0]->push_read (line => $read_chunk); 754 $_[0]->push_read (line => $read_chunk);
738 }); 755 });
739 }); 756 });
740 } else { 757 } else {
758 $hdr{"content-length"} ||= $cl;
759
741 $_[0]->push_read (line => $qr_nlnl, sub { 760 $_[0]->push_read (line => $qr_nlnl, sub {
742 if (length $_[1]) { 761 if (length $_[1]) {
743 for ("$_[1]") { 762 for ("$_[1]") {
744 y/\015//d; # weed out any \015, as they show up in the weirdest of places. 763 y/\015//d; # weed out any \015, as they show up in the weirdest of places.
745 764
796 }); 815 });
797 $_[0]->on_read (sub { }); 816 $_[0]->on_read (sub { });
798 } 817 }
799 } 818 }
800 } 819 }
801 }); 820 };
821
822 $state{handle}->push_read (line => $qr_nlnl, $state{read_response});
802 }; 823 };
803 824
804 # now handle proxy-CONNECT method 825 # now handle proxy-CONNECT method
805 if ($proxy && $uscheme eq "https") { 826 if ($proxy && $uscheme eq "https") {
806 # oh dear, we have to wrap it into a connect request 827 # oh dear, we have to wrap it into a connect request

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines