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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines