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.40 by root, Sun Jul 5 01:45:01 2009 UTC vs.
Revision 1.46 by root, Sat Jul 25 01:29:09 2009 UTC

… …
39package AnyEvent::HTTP; 39package AnyEvent::HTTP;
40 40
41use strict; 41use strict;
42no warnings; 42no warnings;
43 43
44use Carp; 44use Errno ();
45 45
46use AnyEvent 4.452 (); 46use AnyEvent 4.8 ();
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.12'; 53our $VERSION = '1.41';
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;
59our $MAX_PERSISTENT = 8; 59our $MAX_PERSISTENT = 8;
60our $PERSISTENT_TIMEOUT = 2; 60our $PERSISTENT_TIMEOUT = 2;
61our $TIMEOUT = 300; 61our $TIMEOUT = 300;
62 62
63# changing these is evil 63# changing these is evil
64our $MAX_PERSISTENT_PER_HOST = 2; 64our $MAX_PERSISTENT_PER_HOST = 0;
65our $MAX_PER_HOST = 4; 65our $MAX_PER_HOST = 4;
66 66
67our $PROXY; 67our $PROXY;
68our $ACTIVE = 0; 68our $ACTIVE = 0;
69 69
… …
94When called in void context, nothing is returned. In other contexts, 94When called in void context, nothing is returned. In other contexts,
95C<http_request> returns a "cancellation guard" - you have to keep the 95C<http_request> returns a "cancellation guard" - you have to keep the
96object at least alive until the callback get called. If the object gets 96object at least alive until the callback get called. If the object gets
97destroyed before the callbakc is called, the request will be cancelled. 97destroyed before the callbakc is called, the request will be cancelled.
98 98
99The callback will be called with the response data as first argument 99The callback will be called with the response body data as first argument
100(or C<undef> if it wasn't available due to errors), and a hash-ref with 100(or C<undef> if an error occured), and a hash-ref with response headers as
101response headers as second argument. 101second argument.
102 102
103All the headers in that hash are lowercased. In addition to the response 103All the headers in that hash are lowercased. In addition to the response
104headers, the "pseudo-headers" C<HTTPVersion>, C<Status> and C<Reason> 104headers, the "pseudo-headers" C<HTTPVersion>, C<Status> and C<Reason>
105contain the three parts of the HTTP Status-Line of the same name. The 105contain the three parts of the HTTP Status-Line of the same name. The
106pseudo-header C<URL> contains the original URL (which can differ from the 106pseudo-header C<URL> contains the original URL (which can differ from the
… …
108 108
109If the server sends a header multiple times, then their contents will be 109If the server sends a header multiple times, then their contents will be
110joined together with a comma (C<,>), as per the HTTP spec. 110joined together with a comma (C<,>), as per the HTTP spec.
111 111
112If an internal error occurs, such as not being able to resolve a hostname, 112If an internal error occurs, such as not being able to resolve a hostname,
113then C<$data> will be C<undef>, C<< $headers->{Status} >> will be C<599> 113then C<$data> will be C<undef>, C<< $headers->{Status} >> will be C<59x>
114and the C<Reason> pseudo-header will contain an error message. 114(usually C<599>) and the C<Reason> pseudo-header will contain an error
115message.
115 116
116A typical callback might look like this: 117A typical callback might look like this:
117 118
118 sub { 119 sub {
119 my ($body, $hdr) = @_; 120 my ($body, $hdr) = @_;
… …
184verification, highest compatibility) and high-security (CA and common-name 185verification, highest compatibility) and high-security (CA and common-name
185verification) TLS context. 186verification) TLS context.
186 187
187The default for this option is C<low>, which could be interpreted as "give 188The default for this option is C<low>, which could be interpreted as "give
188me the page, no matter what". 189me the page, no matter what".
190
191=item on_header => $callback->($headers)
192
193When specified, this callback will be called with the header hash as soon
194as headers have been successfully received from the remote server (not on
195locally-generated errors).
196
197It has to return either true (in which case AnyEvent::HTTP will continue),
198or false, in which case AnyEvent::HTTP will cancel the download (and call
199the finish callback with an error code of C<598>).
200
201This callback is useful, among other things, to quickly reject unwanted
202content, which, if it is supposed to be rare, can be faster than first
203doing a C<HEAD> request.
204
205Example: cancel the request unless the content-type is "text/html".
206
207 on_header => sub {
208 $_[0]{"content-type"} =~ /^text\/html\s*(?:;|$)/
209 },
210
211=item on_body => $callback->($partial_body, $headers)
212
213When specified, all body data will be passed to this callback instead of
214to the completion callback. The completion callback will get the empty
215string instead of the body data.
216
217It has to return either true (in which case AnyEvent::HTTP will continue),
218or false, in which case AnyEvent::HTTP will cancel the download (and call
219the completion callback with an error code of C<598>).
220
221This callback is useful when the data is too large to be held in memory
222(so the callback writes it to a file) or when only some information should
223be extracted, or when the body should be processed incrementally.
224
225It is usually preferred over doing your own body handling via
226C<want_body_handle>, but in case of streaming APIs, where HTTP is
227only used to create a connection, C<want_body_handle> is the better
228alternative, as it allows you to install your own event handler, reducing
229resource usage.
230
231=item want_body_handle => $enable
232
233When enabled (default is disabled), the behaviour of AnyEvent::HTTP
234changes considerably: after parsing the headers, and instead of
235downloading the body (if any), the completion callback will be
236called. Instead of the C<$body> argument containing the body data, the
237callback will receive the L<AnyEvent::Handle> object associated with the
238connection. In error cases, C<undef> will be passed. When there is no body
239(e.g. status C<304>), the empty string will be passed.
240
241The handle object might or might not be in TLS mode, might be connected to
242a proxy, be a persistent connection etc., and configured in unspecified
243ways. The user is responsible for this handle (it will not be used by this
244module anymore).
245
246This is useful with some push-type services, where, after the initial
247headers, an interactive protocol is used (typical example would be the
248push-style twitter API which starts a JSON/XML stream).
249
250If you think you need this, first have a look at C<on_body>, to see if
251that doesn't solve your problem in a better way.
189 252
190=back 253=back
191 254
192Example: make a simple HTTP GET request for http://www.nethype.de/ 255Example: make a simple HTTP GET request for http://www.nethype.de/
193 256
… …
249 push @{ $CO_SLOT{$_[0]}[1] }, $_[1]; 312 push @{ $CO_SLOT{$_[0]}[1] }, $_[1];
250 313
251 _slot_schedule $_[0]; 314 _slot_schedule $_[0];
252} 315}
253 316
254our $qr_nl = qr<\015?\012>; 317our $qr_nl = qr{\015?\012};
255our $qr_nlnl = qr<\015?\012\015?\012>; 318our $qr_nlnl = qr{(?<![^\012])\015?\012};
256 319
257our $TLS_CTX_LOW = { cache => 1, dh => undef, sslv2 => 1 }; 320our $TLS_CTX_LOW = { cache => 1, sslv2 => 1 };
258our $TLS_CTX_HIGH = { cache => 1, verify => 1, verify_cn => "https", dh => "skip4096" }; 321our $TLS_CTX_HIGH = { cache => 1, verify => 1, verify_peername => "https" };
259 322
260sub http_request($$@) { 323sub http_request($$@) {
261 my $cb = pop; 324 my $cb = pop;
262 my ($method, $url, %arg) = @_; 325 my ($method, $url, %arg) = @_;
263 326
… …
280 if $recurse < 0; 343 if $recurse < 0;
281 344
282 my $proxy = $arg{proxy} || $PROXY; 345 my $proxy = $arg{proxy} || $PROXY;
283 my $timeout = $arg{timeout} || $TIMEOUT; 346 my $timeout = $arg{timeout} || $TIMEOUT;
284 347
285 $hdr{"user-agent"} ||= $USERAGENT;
286
287 my ($uscheme, $uauthority, $upath, $query, $fragment) = 348 my ($uscheme, $uauthority, $upath, $query, $fragment) =
288 $url =~ m|(?:([^:/?#]+):)?(?://([^/?#]*))?([^?#]*)(?:\?([^#]*))?(?:#(.*))?|; 349 $url =~ m|(?:([^:/?#]+):)?(?://([^/?#]*))?([^?#]*)(?:\?([^#]*))?(?:#(.*))?|;
289 350
290 $uscheme = lc $uscheme; 351 $uscheme = lc $uscheme;
291 352
292 my $uport = $uscheme eq "http" ? 80 353 my $uport = $uscheme eq "http" ? 80
293 : $uscheme eq "https" ? 443 354 : $uscheme eq "https" ? 443
294 : return $cb->(undef, { Status => 599, Reason => "Only http and https URL schemes supported (not '$uscheme')", URL => $url }); 355 : return $cb->(undef, { Status => 599, Reason => "Only http and https URL schemes supported", URL => $url });
295
296 $hdr{referer} ||= "$uscheme://$uauthority$upath"; # leave out fragment and query string, just a heuristic
297 356
298 $uauthority =~ /^(?: .*\@ )? ([^\@:]+) (?: : (\d+) )?$/x 357 $uauthority =~ /^(?: .*\@ )? ([^\@:]+) (?: : (\d+) )?$/x
299 or return $cb->(undef, { Status => 599, Reason => "Unparsable URL", URL => $url }); 358 or return $cb->(undef, { Status => 599, Reason => "Unparsable URL", URL => $url });
300 359
301 my $uhost = $1; 360 my $uhost = $1;
302 $uport = $2 if defined $2; 361 $uport = $2 if defined $2;
362
363 $hdr{host} = defined $2 ? "$uhost:$2" : "$uhost";
303 364
304 $uhost =~ s/^\[(.*)\]$/$1/; 365 $uhost =~ s/^\[(.*)\]$/$1/;
305 $upath .= "?$query" if length $query; 366 $upath .= "?$query" if length $query;
306 367
307 $upath =~ s%^/?%/%; 368 $upath =~ s%^/?%/%;
… …
347 $rscheme = "http" if $uscheme eq "https" && $rscheme eq "https"; 408 $rscheme = "http" if $uscheme eq "https" && $rscheme eq "https";
348 } else { 409 } else {
349 ($rhost, $rport, $rscheme, $rpath) = ($uhost, $uport, $uscheme, $upath); 410 ($rhost, $rport, $rscheme, $rpath) = ($uhost, $uport, $uscheme, $upath);
350 } 411 }
351 412
352 $hdr{host} = $uhost; 413 $hdr{"user-agent"} ||= $USERAGENT;
414 $hdr{referer} ||= "$uscheme://$uauthority$upath"; # leave out fragment and query string, just a heuristic
415
353 $hdr{"content-length"} = length $arg{body}; 416 $hdr{"content-length"} = length $arg{body};
354 417
355 my %state = (connect_guard => 1); 418 my %state = (connect_guard => 1);
356 419
357 _get_slot $uhost, sub { 420 _get_slot $uhost, sub {
… …
359 422
360 return unless $state{connect_guard}; 423 return unless $state{connect_guard};
361 424
362 $state{connect_guard} = AnyEvent::Socket::tcp_connect $rhost, $rport, sub { 425 $state{connect_guard} = AnyEvent::Socket::tcp_connect $rhost, $rport, sub {
363 $state{fh} = shift 426 $state{fh} = shift
427 or do {
428 my $err = "$!";
429 %state = ();
364 or return (%state = (), $cb->(undef, { Status => 599, Reason => "$!", URL => $url })); 430 return $cb->(undef, { Status => 599, Reason => $err, URL => $url });
431 };
432
365 pop; # free memory, save a tree 433 pop; # free memory, save a tree
366 434
367 return unless delete $state{connect_guard}; 435 return unless delete $state{connect_guard};
368 436
369 # get handle 437 # get handle
… …
423 URL => ",$url" 491 URL => ",$url"
424 ); 492 );
425 493
426 # headers, could be optimized a bit 494 # headers, could be optimized a bit
427 $state{handle}->unshift_read (line => $qr_nlnl, sub { 495 $state{handle}->unshift_read (line => $qr_nlnl, sub {
428 for ("$_[1]\012") { 496 for ("$_[1]") {
429 y/\015//d; # weed out any \015, as they show up in the weirdest of places. 497 y/\015//d; # weed out any \015, as they show up in the weirdest of places.
430 498
431 # things seen, not parsed: 499 # things seen, not parsed:
432 # p3pP="NON CUR OTPi OUR NOR UNI" 500 # p3pP="NON CUR OTPi OUR NOR UNI"
433 501
434 $hdr{lc $1} .= ",$2" 502 $hdr{lc $1} .= ",$2"
435 while /\G 503 while /\G
436 ([^:\000-\037]+): 504 ([^:\000-\037]*):
437 [\011\040]* 505 [\011\040]*
438 ((?: [^\012]+ | \012[\011\040] )*) 506 ((?: [^\012]+ | \012[\011\040] )*)
439 \012 507 \012
440 /gxc; 508 /gxc;
441 509
… …
444 } 512 }
445 513
446 substr $_, 0, 1, "" 514 substr $_, 0, 1, ""
447 for values %hdr; 515 for values %hdr;
448 516
517 # redirect handling
518 # microsoft and other shitheads don't give a shit for following standards,
519 # try to support some common forms of broken Location headers.
520 if ($hdr{location} !~ /^(?: $ | [^:\/?\#]+ : )/x) {
521 $hdr{location} =~ s/^\.\/+//;
522
523 my $url = "$rscheme://$uhost:$uport";
524
525 unless ($hdr{location} =~ s/^\///) {
526 $url .= $upath;
527 $url =~ s/\/[^\/]*$//;
528 }
529
530 $hdr{location} = "$url/$hdr{location}";
531 }
532
533 my $redirect;
534
535 if ($recurse) {
536 if ($hdr{Status} =~ /^30[12]$/ && $method ne "POST") {
537 # apparently, mozilla et al. just change POST to GET here
538 # more research is needed before we do the same
539 $redirect = 1;
540 } elsif ($hdr{Status} == 303) {
541 # even http/1.1 is unclear on how to mutate the method
542 $method = "GET" unless $method eq "HEAD";
543 $redirect = 1;
544 } elsif ($hdr{Status} == 307 && $method =~ /^(?:GET|HEAD)$/) {
545 $redirect = 1;
546 }
547 }
548
449 my $finish = sub { 549 my $finish = sub {
450 $state{handle}->destroy; 550 $state{handle}->destroy if $state{handle};
451 %state = (); 551 %state = ();
452 552
453 # set-cookie processing 553 # set-cookie processing
454 if ($arg{cookie_jar}) { 554 if ($arg{cookie_jar}) {
455 for ($hdr{"set-cookie"}) { 555 for ($_[1]{"set-cookie"}) {
456 # parse NAME=VALUE 556 # parse NAME=VALUE
457 my @kv; 557 my @kv;
458 558
459 while (/\G\s* ([^=;,[:space:]]+) \s*=\s* (?: "((?:[^\\"]+|\\.)*)" | ([^=;,[:space:]]*) )/gcxs) { 559 while (/\G\s* ([^=;,[:space:]]+) \s*=\s* (?: "((?:[^\\"]+|\\.)*)" | ([^=;,[:space:]]*) )/gcxs) {
460 my $name = $1; 560 my $name = $1;
… …
498 598
499 redo if /\G\s*,/gc; 599 redo if /\G\s*,/gc;
500 } 600 }
501 } 601 }
502 602
503 # microsoft and other shitheads don't give a shit for following standards, 603 if ($redirect) {
504 # try to support some common forms of broken Location headers. 604 # we ignore any errors, as it is very common to receive
505 if ($_[1]{location} !~ /^(?: $ | [^:\/?\#]+ : )/x) { 605 # Content-Length != 0 but no actual body
506 $_[1]{location} =~ s/^\.\/+//; 606 # we also access %hdr, as $_[1] might be an erro
507
508 my $url = "$rscheme://$uhost:$uport";
509
510 unless ($_[1]{location} =~ s/^\///) {
511 $url .= $upath;
512 $url =~ s/\/[^\/]*$//;
513 }
514
515 $_[1]{location} = "$url/$_[1]{location}";
516 }
517
518 if ($_[1]{Status} =~ /^30[12]$/ && $recurse && $method ne "POST") {
519 # apparently, mozilla et al. just change POST to GET here
520 # more research is needed before we do the same
521 http_request ($method => $_[1]{location}, %arg, recurse => $recurse - 1, $cb); 607 http_request ($method => $hdr{location}, %arg, recurse => $recurse - 1, $cb);
522 } elsif ($_[1]{Status} == 303 && $recurse) {
523 # even http/1.1 is unclear on how to mutate the method
524 $method = "GET" unless $method eq "HEAD";
525 http_request ($method => $_[1]{location}, %arg, recurse => $recurse - 1, $cb);
526 } elsif ($_[1]{Status} == 307 && $recurse && $method =~ /^(?:GET|HEAD)$/) {
527 http_request ($method => $_[1]{location}, %arg, recurse => $recurse - 1, $cb);
528 } else { 608 } else {
529 $cb->($_[0], $_[1]); 609 $cb->($_[0], $_[1]);
530 } 610 }
531 }; 611 };
532 612
533 if ($hdr{Status} =~ /^(?:1..|204|304)$/ or $method eq "HEAD") { 613 my $len = $hdr{"content-length"};
614
615 if (!$redirect && $arg{on_header} && !$arg{on_header}(\%hdr)) {
616 $finish->(undef, { Status => 598, Reason => "Request cancelled by on_header", URL => $url });
617 } elsif (
618 $hdr{Status} =~ /^(?:1..|[23]04)$/
619 or $method eq "HEAD"
620 or (defined $len && !$len)
621 ) {
622 # no body
534 $finish->(undef, \%hdr); 623 $finish->("", \%hdr);
535 } else { 624 } else {
536 if (exists $hdr{"content-length"}) { 625 # body handling, four different code paths
537 $_[0]->unshift_read (chunk => $hdr{"content-length"}, sub { 626 # for want_body_handle, on_body (2x), normal (2x)
538 # could cache persistent connection now 627 # we might read too much here, but it does not matter yet (no pers. connections)
539 if ($hdr{connection} =~ /\bkeep-alive\b/i) { 628 if (!$redirect && $arg{want_body_handle}) {
540 # but we don't, due to misdesigns, this is annoyingly complex 629 $_[0]->on_eof (undef);
630 $_[0]->on_error (undef);
631 $_[0]->on_read (undef);
632
633 $finish->(delete $state{handle}, \%hdr);
634
635 } elsif ($arg{on_body}) {
636 $_[0]->on_error (sub { $finish->(undef, { Status => 599, Reason => $_[2], URL => $url }) });
637 if ($len) {
638 $_[0]->on_eof (undef);
639 $_[0]->on_read (sub {
640 $len -= length $_[0]{rbuf};
641
642 $arg{on_body}(delete $_[0]{rbuf}, \%hdr)
643 or $finish->(undef, { Status => 598, Reason => "Request cancelled by on_body", URL => $url });
644
645 $len > 0
646 or $finish->("", \%hdr);
541 }; 647 });
542 648 } else {
649 $_[0]->on_eof (sub {
543 $finish->($_[1], \%hdr); 650 $finish->("", \%hdr);
651 });
652 $_[0]->on_read (sub {
653 $arg{on_body}(delete $_[0]{rbuf}, \%hdr)
654 or $finish->(undef, { Status => 598, Reason => "Request cancelled by on_body", URL => $url });
655 });
544 }); 656 }
545 } else { 657 } else {
546 # too bad, need to read until we get an error or EOF,
547 # no way to detect winged data.
548 $_[0]->on_error (sub {
549 # delete ought to be more efficient, as we would have to make
550 # a copy otherwise as $_[0] gets destroyed.
551 $finish->(delete $_[0]{rbuf}, \%hdr);
552 });
553 $_[0]->on_eof (undef); 658 $_[0]->on_eof (undef);
659
660 if ($len) {
661 $_[0]->on_error (sub { $finish->(undef, { Status => 599, Reason => $_[2], URL => $url }) });
662 $_[0]->on_read (sub {
663 $finish->((substr delete $_[0]{rbuf}, 0, $len, ""), \%hdr)
664 if $len <= length $_[0]{rbuf};
665 });
666 } else {
667 $_[0]->on_error (sub {
668 $! == Errno::EPIPE || !$!
669 ? $finish->(delete $_[0]{rbuf}, \%hdr)
670 : $finish->(undef, { Status => 599, Reason => $_[2], URL => $url });
671 });
554 $_[0]->on_read (sub { }); 672 $_[0]->on_read (sub { });
673 }
555 } 674 }
556 } 675 }
557 }); 676 });
558 }); 677 });
559 }; 678 };
… …
622=item $AnyEvent::HTTP::USERAGENT 741=item $AnyEvent::HTTP::USERAGENT
623 742
624The default value for the C<User-Agent> header (the default is 743The default value for the C<User-Agent> header (the default is
625C<Mozilla/5.0 (compatible; U; AnyEvent-HTTP/$VERSION; +http://software.schmorp.de/pkg/AnyEvent)>). 744C<Mozilla/5.0 (compatible; U; AnyEvent-HTTP/$VERSION; +http://software.schmorp.de/pkg/AnyEvent)>).
626 745
627=item $AnyEvent::HTTP::MAX_PERSISTENT 746=item $AnyEvent::HTTP::MAX_PER_HOST
628 747
629The maximum number of persistent connections to keep open (default: 8). 748The maximum number of concurrent conenctions to the same host (identified
749by the hostname). If the limit is exceeded, then the additional requests
750are queued until previous connections are closed.
630 751
631Not implemented currently. 752The default value for this is C<4>, and it is highly advisable to not
632 753increase it.
633=item $AnyEvent::HTTP::PERSISTENT_TIMEOUT
634
635The maximum time to cache a persistent connection, in seconds (default: 2).
636
637Not implemented currently.
638 754
639=item $AnyEvent::HTTP::ACTIVE 755=item $AnyEvent::HTTP::ACTIVE
640 756
641The number of active connections. This is not the number of currently 757The number of active connections. This is not the number of currently
642running requests, but the number of currently open and non-idle TCP 758running requests, but the number of currently open and non-idle TCP

Diff Legend

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