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.72 by root, Fri Dec 31 20:59:19 2010 UTC vs.
Revision 1.90 by root, Mon Jan 3 00:41:25 2011 UTC

36 36
37=cut 37=cut
38 38
39package AnyEvent::HTTP; 39package AnyEvent::HTTP;
40 40
41use strict; 41use common::sense;
42no warnings;
43 42
44use Errno (); 43use Errno ();
45 44
46use AnyEvent 5.0 (); 45use AnyEvent 5.0 ();
47use AnyEvent::Util (); 46use AnyEvent::Util ();
58our $MAX_PERSISTENT = 8; 57our $MAX_PERSISTENT = 8;
59our $PERSISTENT_TIMEOUT = 2; 58our $PERSISTENT_TIMEOUT = 2;
60our $TIMEOUT = 300; 59our $TIMEOUT = 300;
61 60
62# changing these is evil 61# changing these is evil
63our $MAX_PERSISTENT_PER_HOST = 0; 62our $MAX_PERSISTENT_PER_HOST = 2;
64our $MAX_PER_HOST = 4; 63our $MAX_PER_HOST = 4;
65 64
66our $PROXY; 65our $PROXY;
67our $ACTIVE = 0; 66our $ACTIVE = 0;
68 67
122 121
123If the server sends a header multiple times, then their contents will be 122If the server sends a header multiple times, then their contents will be
124joined together with a comma (C<,>), as per the HTTP spec. 123joined together with a comma (C<,>), as per the HTTP spec.
125 124
126If an internal error occurs, such as not being able to resolve a hostname, 125If an internal error occurs, such as not being able to resolve a hostname,
127then C<$data> will be C<undef>, C<< $headers->{Status} >> will be C<59x> 126then C<$data> will be C<undef>, C<< $headers->{Status} >> will be
128(usually C<599>) and the C<Reason> pseudo-header will contain an error 127C<590>-C<599> and the C<Reason> pseudo-header will contain an error
129message. 128message. Currently the following status codes are used:
129
130=over 4
131
132=item 595 - errors during connection etsbalishment, proxy handshake.
133
134=item 596 - errors during TLS negotiation, request sending and header processing.
135
136=item 597 - errors during body receiving or processing.
137
138=item 598 - user aborted request via C<on_header> or C<on_body>.
139
140=item 599 - other, usually nonretryable, errors (garbled URL etc.).
141
142=back
130 143
131A typical callback might look like this: 144A typical callback might look like this:
132 145
133 sub { 146 sub {
134 my ($body, $hdr) = @_; 147 my ($body, $hdr) = @_;
156C<Host:>, C<Content-Length:>, C<Connection:> and C<Cookie:> headers and 169C<Host:>, C<Content-Length:>, C<Connection:> and C<Cookie:> headers and
157will provide defaults at least for C<TE:>, C<Referer:> and C<User-Agent:> 170will provide defaults at least for C<TE:>, C<Referer:> and C<User-Agent:>
158(this can be suppressed by using C<undef> for these headers in which case 171(this can be suppressed by using C<undef> for these headers in which case
159they won't be sent at all). 172they won't be sent at all).
160 173
174You really should provide your own C<User-Agent:> header value that is
175appropriate for your program - I wouldn't be surprised if the default
176AnyEvent string gets blocked by webservers sooner or later.
177
161=item timeout => $seconds 178=item timeout => $seconds
162 179
163The time-out to use for various stages - each connect attempt will reset 180The 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 181the timeout, as will read or write activity, i.e. this is not an overall
165timeout. 182timeout.
182=item cookie_jar => $hash_ref 199=item cookie_jar => $hash_ref
183 200
184Passing this parameter enables (simplified) cookie-processing, loosely 201Passing this parameter enables (simplified) cookie-processing, loosely
185based on the original netscape specification. 202based on the original netscape specification.
186 203
187The C<$hash_ref> must be an (initially empty) hash reference which will 204The C<$hash_ref> must be an (initially empty) hash reference which
188get updated automatically. It is possible to save the cookie jar to 205will get updated automatically. It is possible to save the cookie jar
189persistent storage with something like JSON or Storable, but this is not 206to persistent storage with something like JSON or Storable - see the
190recommended, as session-only cookies might survive longer than expected. 207C<AnyEvent::HTTP::cookie_jar_expire> function if you wish to remove
208expired or session-only cookies, and also for documentation on the format
209of the cookie jar.
191 210
192Note that this cookie implementation is not meant to be complete. If 211Note that this cookie implementation is not meant to be complete. If
193you want complete cookie management you have to do that on your 212you want complete cookie management you have to do that on your
194own. C<cookie_jar> is meant as a quick fix to get some cookie-using sites 213own. C<cookie_jar> is meant as a quick fix to get most cookie-using sites
195working. Cookies are a privacy disaster, do not use them unless required 214working. Cookies are a privacy disaster, do not use them unless required
196to. 215to.
197 216
198When cookie processing is enabled, the C<Cookie:> and C<Set-Cookie:> 217When cookie processing is enabled, the C<Cookie:> and C<Set-Cookie:>
199headers will be set and handled by this module, otherwise they will be 218headers will be set and handled by this module, otherwise they will be
314Example: do a HTTP HEAD request on https://www.google.com/, use a 333Example: do a HTTP HEAD request on https://www.google.com/, use a
315timeout of 30 seconds. 334timeout of 30 seconds.
316 335
317 http_request 336 http_request
318 GET => "https://www.google.com", 337 GET => "https://www.google.com",
338 headers => { "user-agent" => "MySearchClient 1.0" },
319 timeout => 30, 339 timeout => 30,
320 sub { 340 sub {
321 my ($body, $hdr) = @_; 341 my ($body, $hdr) = @_;
322 use Data::Dumper; 342 use Data::Dumper;
323 print Dumper $hdr; 343 print Dumper $hdr;
364 push @{ $CO_SLOT{$_[0]}[1] }, $_[1]; 384 push @{ $CO_SLOT{$_[0]}[1] }, $_[1];
365 385
366 _slot_schedule $_[0]; 386 _slot_schedule $_[0];
367} 387}
368 388
389#############################################################################
390
391# expire cookies
392sub cookie_jar_expire($;$) {
393 my ($jar, $session_end) = @_;
394
395 %$jar = () if $jar->{version} != 1;
396
397 my $anow = AE::now;
398
399 while (my ($chost, $paths) = each %$jar) {
400 next unless ref $paths;
401
402 while (my ($cpath, $cookies) = each %$paths) {
403 while (my ($cookie, $kv) = each %$cookies) {
404 if (exists $kv->{_expires}) {
405 delete $cookies->{$cookie}
406 if $anow > $kv->{_expires};
407 } elsif ($session_end) {
408 delete $cookies->{$cookie};
409 }
410 }
411
412 delete $paths->{$cpath}
413 unless %$cookies;
414 }
415
416 delete $jar->{$chost}
417 unless %$paths;
418 }
419}
420
369# extract cookies from jar 421# extract cookies from jar
370sub cookie_jar_extract($$$$) { 422sub cookie_jar_extract($$$$) {
371 my ($jar, $uscheme, $uhost, $upath) = @_; 423 my ($jar, $uscheme, $uhost, $upath) = @_;
372 424
373 %$jar = () if $jar->{version} != 1; 425 %$jar = () if $jar->{version} != 1;
389 next unless $cpath eq substr $upath, 0, length $cpath; 441 next unless $cpath eq substr $upath, 0, length $cpath;
390 442
391 while (my ($cookie, $kv) = each %$cookies) { 443 while (my ($cookie, $kv) = each %$cookies) {
392 next if $uscheme ne "https" && exists $kv->{secure}; 444 next if $uscheme ne "https" && exists $kv->{secure};
393 445
394 if (exists $kv->{expires}) { 446 if (exists $kv->{_expires} and AE::now > $kv->{_expires}) {
395 if (AE::now > parse_date ($kv->{expires})) {
396 delete $cookies->{$cookie}; 447 delete $cookies->{$cookie};
397 next; 448 next;
398 }
399 } 449 }
400 450
401 my $value = $kv->{value}; 451 my $value = $kv->{value};
402 452
403 if ($value =~ /[=;,[:space:]]/) { 453 if ($value =~ /[=;,[:space:]]/) {
412 462
413 \@cookies 463 \@cookies
414} 464}
415 465
416# parse set_cookie header into jar 466# parse set_cookie header into jar
417sub cookie_jar_set_cookie($$) { 467sub cookie_jar_set_cookie($$$$) {
418 my ($jar, $set_cookie) = @_; 468 my ($jar, $set_cookie, $uhost, $date) = @_;
469
470 my $anow = int AE::now;
471 my $snow; # server-now
419 472
420 for ($set_cookie) { 473 for ($set_cookie) {
421 # parse NAME=VALUE 474 # parse NAME=VALUE
422 my @kv; 475 my @kv;
423 476
477 # expires is not http-compliant in the original cookie-spec,
478 # we support the official date format and some extensions
424 while ( 479 while (
425 m{ 480 m{
426 \G\s* 481 \G\s*
427 (?: 482 (?:
428 expires \s*=\s* ([A-Z][a-z][a-z],\ [^,;]+) 483 expires \s*=\s* ([A-Z][a-z][a-z]+,\ [^,;]+)
429 | ([^=;,[:space:]]+) \s*=\s* (?: "((?:[^\\"]+|\\.)*)" | ([^=;,[:space:]]*) ) 484 | ([^=;,[:space:]]+) (?: \s*=\s* (?: "((?:[^\\"]+|\\.)*)" | ([^=;,[:space:]]*) ) )?
430 ) 485 )
431 }gcxsi 486 }gcxsi
432 ) { 487 ) {
433 my $name = $2; 488 my $name = $2;
434 my $value = $4; 489 my $value = $4;
435 490
436 unless (defined $name) { 491 if (defined $1) {
437 # expires 492 # expires
438 $name = "expires"; 493 $name = "expires";
439 $value = $1; 494 $value = $1;
440 } elsif (!defined $value) { 495 } elsif (defined $3) {
441 # quoted 496 # quoted
442 $value = $3; 497 $value = $3;
443 $value =~ s/\\(.)/$1/gs; 498 $value =~ s/\\(.)/$1/gs;
444 } 499 }
445 500
451 last unless @kv; 506 last unless @kv;
452 507
453 my $name = shift @kv; 508 my $name = shift @kv;
454 my %kv = (value => shift @kv, @kv); 509 my %kv = (value => shift @kv, @kv);
455 510
456 $kv{expires} ||= format_date (AE::now + $kv{"max-age"})
457 if exists $kv{"max-age"}; 511 if (exists $kv{"max-age"}) {
512 $kv{_expires} = $anow + delete $kv{"max-age"};
513 } elsif (exists $kv{expires}) {
514 $snow ||= parse_date ($date) || $anow;
515 $kv{_expires} = $anow + (parse_date (delete $kv{expires}) - $snow);
516 } else {
517 delete $kv{_expires};
518 }
458 519
459 my $cdom; 520 my $cdom;
460 my $cpath = (delete $kv{path}) || "/"; 521 my $cpath = (delete $kv{path}) || "/";
461 522
462 if (exists $kv{domain}) { 523 if (exists $kv{domain}) {
472 } else { 533 } else {
473 $cdom = $uhost; 534 $cdom = $uhost;
474 } 535 }
475 536
476 # store it 537 # store it
477 $arg{cookie_jar}{version} = 1; 538 $jar->{version} = 1;
478 $arg{cookie_jar}{$cdom}{$cpath}{$name} = \%kv; 539 $jar->{lc $cdom}{$cpath}{$name} = \%kv;
479 540
480 redo if /\G\s*,/gc; 541 redo if /\G\s*,/gc;
481 } 542 }
482}
483} 543}
484 544
485# continue to parse $_ for headers and place them into the arg 545# continue to parse $_ for headers and place them into the arg
486sub parse_hdr() { 546sub parse_hdr() {
487 my %hdr; 547 my %hdr;
551 : return $cb->(undef, { @pseudo, Status => 599, Reason => "Only http and https URL schemes supported" }); 611 : return $cb->(undef, { @pseudo, Status => 599, Reason => "Only http and https URL schemes supported" });
552 612
553 $uauthority =~ /^(?: .*\@ )? ([^\@:]+) (?: : (\d+) )?$/x 613 $uauthority =~ /^(?: .*\@ )? ([^\@:]+) (?: : (\d+) )?$/x
554 or return $cb->(undef, { @pseudo, Status => 599, Reason => "Unparsable URL" }); 614 or return $cb->(undef, { @pseudo, Status => 599, Reason => "Unparsable URL" });
555 615
556 my $uhost = $1; 616 my $uhost = lc $1;
557 $uport = $2 if defined $2; 617 $uport = $2 if defined $2;
558 618
559 $hdr{host} = defined $2 ? "$uhost:$2" : "$uhost" 619 $hdr{host} = defined $2 ? "$uhost:$2" : "$uhost"
560 unless exists $hdr{host}; 620 unless exists $hdr{host};
561 621
580 $rscheme = "http" unless defined $rscheme; 640 $rscheme = "http" unless defined $rscheme;
581 641
582 # don't support https requests over https-proxy transport, 642 # don't support https requests over https-proxy transport,
583 # can't be done with tls as spec'ed, unless you double-encrypt. 643 # can't be done with tls as spec'ed, unless you double-encrypt.
584 $rscheme = "http" if $uscheme eq "https" && $rscheme eq "https"; 644 $rscheme = "http" if $uscheme eq "https" && $rscheme eq "https";
645
646 $rhost = lc $rhost;
647 $rscheme = lc $rscheme;
585 } else { 648 } else {
586 ($rhost, $rport, $rscheme, $rpath) = ($uhost, $uport, $uscheme, $upath); 649 ($rhost, $rport, $rscheme, $rpath) = ($uhost, $uport, $uscheme, $upath);
587 } 650 }
588 651
589 # leave out fragment and query string, just a heuristic 652 # leave out fragment and query string, just a heuristic
591 $hdr{"user-agent"} = $USERAGENT unless exists $hdr{"user-agent"}; 654 $hdr{"user-agent"} = $USERAGENT unless exists $hdr{"user-agent"};
592 655
593 $hdr{"content-length"} = length $arg{body} 656 $hdr{"content-length"} = length $arg{body}
594 if length $arg{body} || $method ne "GET"; 657 if length $arg{body} || $method ne "GET";
595 658
596 $hdr{connection} = "close TE"; #1.1 659 my $idempotent = $method =~ /^(?:GET|HEAD|PUT|DELETE|OPTIONS|TRACE)$/;
660
661 # default value for keepalive is true iff the request is for an idempotent method
662 my $keepalive = exists $arg{keepalive}
663 ? $arg{keepalive}*1
664 : $idempotent ? $PERSISTENT_TIMEOUT : 0;
665
666 $hdr{connection} = ($keepalive ? "" : "close ") . "Te"; #1.1
597 $hdr{te} = "trailers" unless exists $hdr{te}; #1.1 667 $hdr{te} = "trailers" unless exists $hdr{te}; #1.1
598 668
599 my %state = (connect_guard => 1); 669 my %state = (connect_guard => 1);
600 670
601 _get_slot $uhost, sub { 671 my $ae_error = 595; # connecting
602 $state{slot_guard} = shift;
603 672
673 # handle actual, non-tunneled, request
674 my $handle_actual_request = sub {
675 $ae_error = 596; # request phase
676
677 $state{handle}->starttls ("connect") if $uscheme eq "https" && !exists $state{handle}{tls};
678
679 # send request
680 $state{handle}->push_write (
681 "$method $rpath HTTP/1.1\015\012"
682 . (join "", map "\u$_: $hdr{$_}\015\012", grep defined $hdr{$_}, keys %hdr)
683 . "\015\012"
684 . (delete $arg{body})
685 );
686
687 # return if error occured during push_write()
604 return unless $state{connect_guard}; 688 return unless %state;
605 689
606 my $connect_cb = sub { 690 # reduce memory usage, save a kitten, also re-use it for the response headers.
607 $state{fh} = shift 691 %hdr = ();
692
693 # status line and headers
694 $state{read_response} = sub {
695 for ("$_[1]") {
696 y/\015//d; # weed out any \015, as they show up in the weirdest of places.
697
698 /^HTTP\/0*([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\012]*) )? \012/gxci
699 or return (%state = (), $cb->(undef, { @pseudo, Status => 599, Reason => "Invalid server response" }));
700
701 # 100 Continue handling
702 # should not happen as we don't send expect: 100-continue,
703 # but we handle it just in case.
704 # since we send the request body regardless, if we get an error
705 # we are out of-sync, which we currently do NOT handle correctly.
706 return $state{handle}->push_read (line => $qr_nlnl, $state{read_response})
707 if $2 eq 100;
708
709 push @pseudo,
710 HTTPVersion => $1,
711 Status => $2,
712 Reason => $3,
608 or do { 713 ;
609 my $err = "$!"; 714
715 my $hdr = parse_hdr
716 or return (%state = (), $cb->(undef, { @pseudo, Status => 599, Reason => "Garbled response headers" }));
717
718 %hdr = (%$hdr, @pseudo);
719 }
720
721 # redirect handling
722 # microsoft and other shitheads don't give a shit for following standards,
723 # try to support some common forms of broken Location headers.
724 if ($hdr{location} !~ /^(?: $ | [^:\/?\#]+ : )/x) {
725 $hdr{location} =~ s/^\.\/+//;
726
727 my $url = "$rscheme://$uhost:$uport";
728
729 unless ($hdr{location} =~ s/^\///) {
730 $url .= $upath;
731 $url =~ s/\/[^\/]*$//;
732 }
733
734 $hdr{location} = "$url/$hdr{location}";
735 }
736
737 my $redirect;
738
739 if ($recurse) {
740 my $status = $hdr{Status};
741
742 # industry standard is to redirect POST as GET for
743 # 301, 302 and 303, in contrast to HTTP/1.0 and 1.1.
744 # also, the UA should ask the user for 301 and 307 and POST,
745 # industry standard seems to be to simply follow.
746 # we go with the industry standard.
747 if ($status == 301 or $status == 302 or $status == 303) {
748 # HTTP/1.1 is unclear on how to mutate the method
749 $method = "GET" unless $method eq "HEAD";
750 $redirect = 1;
751 } elsif ($status == 307) {
752 $redirect = 1;
753 }
754 }
755
756 my $finish = sub { # ($data, $err_status, $err_reason[, $keepalive])
757 my $may_keep_alive = $_[3];
758
759 $state{handle}->destroy if $state{handle};
610 %state = (); 760 %state = ();
611 return $cb->(undef, { @pseudo, Status => 599, Reason => $err }); 761
762 if (defined $_[1]) {
763 $hdr{OrigStatus} = $hdr{Status}; $hdr{Status} = $_[1];
764 $hdr{OrigReason} = $hdr{Reason}; $hdr{Reason} = $_[2];
765 }
766
767 # set-cookie processing
768 if ($arg{cookie_jar}) {
769 cookie_jar_set_cookie $arg{cookie_jar}, $hdr{"set-cookie"}, $uhost, $hdr{date};
770 }
771
772 if ($redirect && exists $hdr{location}) {
773 # we ignore any errors, as it is very common to receive
774 # Content-Length != 0 but no actual body
775 # we also access %hdr, as $_[1] might be an erro
776 http_request (
777 $method => $hdr{location},
778 %arg,
779 recurse => $recurse - 1,
780 Redirect => [$_[0], \%hdr],
781 $cb);
782 } else {
783 $cb->($_[0], \%hdr);
784 }
785 };
786
787 $ae_error = 597; # body phase
788
789 my $len = $hdr{"content-length"};
790
791 # body handling, many different code paths
792 # - no body expected
793 # - want_body_handle
794 # - te chunked
795 # - 2x length known (with or without on_body)
796 # - 2x length not known (with or without on_body)
797 if (!$redirect && $arg{on_header} && !$arg{on_header}(\%hdr)) {
798 $finish->(undef, 598 => "Request cancelled by on_header");
799 } elsif (
800 $hdr{Status} =~ /^(?:1..|204|205|304)$/
801 or $method eq "HEAD"
802 or (defined $len && $len == 0) # == 0, not !, because "0 " is true
803 ) {
804 # no body
805 $finish->("", undef, undef, 1);
806
807 } elsif (!$redirect && $arg{want_body_handle}) {
808 $_[0]->on_eof (undef);
809 $_[0]->on_error (undef);
810 $_[0]->on_read (undef);
811
812 $finish->(delete $state{handle});
813
814 } elsif ($hdr{"transfer-encoding"} =~ /\bchunked\b/i) {
815 my $cl = 0;
816 my $body = undef;
817 my $on_body = $arg{on_body} || sub { $body .= shift; 1 };
818
819 $state{read_chunk} = sub {
820 $_[1] =~ /^([0-9a-fA-F]+)/
821 or $finish->(undef, $ae_error => "Garbled chunked transfer encoding");
822
823 my $len = hex $1;
824
825 if ($len) {
826 $cl += $len;
827
828 $_[0]->push_read (chunk => $len, sub {
829 $on_body->($_[1], \%hdr)
830 or return $finish->(undef, 598 => "Request cancelled by on_body");
831
832 $_[0]->push_read (line => sub {
833 length $_[1]
834 and return $finish->(undef, $ae_error => "Garbled chunked transfer encoding");
835 $_[0]->push_read (line => $state{read_chunk});
836 });
837 });
838 } else {
839 $hdr{"content-length"} ||= $cl;
840
841 $_[0]->push_read (line => $qr_nlnl, sub {
842 if (length $_[1]) {
843 for ("$_[1]") {
844 y/\015//d; # weed out any \015, as they show up in the weirdest of places.
845
846 my $hdr = parse_hdr
847 or return $finish->(undef, $ae_error => "Garbled response trailers");
848
849 %hdr = (%hdr, %$hdr);
850 }
851 }
852
853 $finish->($body, undef, undef, 1);
854 });
855 }
612 }; 856 };
613 857
614 pop; # free memory, save a tree 858 $_[0]->push_read (line => $state{read_chunk});
615 859
860 } elsif ($arg{on_body}) {
861 if (defined $len) {
862 $_[0]->on_read (sub {
863 $len -= length $_[0]{rbuf};
864
865 $arg{on_body}(delete $_[0]{rbuf}, \%hdr)
866 or return $finish->(undef, 598 => "Request cancelled by on_body");
867
868 $len > 0
869 or $finish->("", undef, undef, 1);
870 });
871 } else {
872 $_[0]->on_eof (sub {
873 $finish->("");
874 });
875 $_[0]->on_read (sub {
876 $arg{on_body}(delete $_[0]{rbuf}, \%hdr)
877 or $finish->(undef, 598 => "Request cancelled by on_body");
878 });
879 }
880 } else {
881 $_[0]->on_eof (undef);
882
883 if (defined $len) {
884 $_[0]->on_read (sub {
885 $finish->((substr delete $_[0]{rbuf}, 0, $len, ""), undef, undef, 1)
886 if $len <= length $_[0]{rbuf};
887 });
888 } else {
889 $_[0]->on_error (sub {
890 ($! == Errno::EPIPE || !$!)
891 ? $finish->(delete $_[0]{rbuf})
892 : $finish->(undef, $ae_error => $_[2]);
893 });
894 $_[0]->on_read (sub { });
895 }
896 }
897 };
898
899 $state{handle}->push_read (line => $qr_nlnl, $state{read_response});
900 };
901
902 my $connect_cb = sub {
903 $state{fh} = shift
904 or do {
905 my $err = "$!";
906 %state = ();
907 return $cb->(undef, { @pseudo, Status => $ae_error, Reason => $err });
908 };
909
616 return unless delete $state{connect_guard}; 910 return unless delete $state{connect_guard};
617 911
618 # get handle 912 # get handle
619 $state{handle} = new AnyEvent::Handle 913 $state{handle} = new AnyEvent::Handle
620 fh => $state{fh}, 914 fh => $state{fh},
621 peername => $rhost, 915 peername => $rhost,
622 tls_ctx => $arg{tls_ctx}, 916 tls_ctx => $arg{tls_ctx},
623 # these need to be reconfigured on keepalive handles 917 # these need to be reconfigured on keepalive handles
624 timeout => $timeout, 918 timeout => $timeout,
625 on_error => sub { 919 on_error => sub {
626 %state = (); 920 %state = ();
627 $cb->(undef, { @pseudo, Status => 599, Reason => $_[2] }); 921 $cb->(undef, { @pseudo, Status => $ae_error, Reason => $_[2] });
628 }, 922 },
629 on_eof => sub { 923 on_eof => sub {
630 %state = (); 924 %state = ();
631 $cb->(undef, { @pseudo, Status => 599, Reason => "Unexpected end-of-file" }); 925 $cb->(undef, { @pseudo, Status => $ae_error, Reason => "Unexpected end-of-file" });
632 }, 926 },
633 ; 927 ;
634 928
635 # limit the number of persistent connections 929 # limit the number of persistent connections
636 # keepalive not yet supported 930 # keepalive not yet supported
637# if ($KA_COUNT{$_[1]} < $MAX_PERSISTENT_PER_HOST) { 931# if ($KA_COUNT{$_[1]} < $MAX_PERSISTENT_PER_HOST) {
638# ++$KA_COUNT{$_[1]}; 932# ++$KA_COUNT{$_[1]};
639# $state{handle}{ka_count_guard} = AnyEvent::Util::guard { 933# $state{handle}{ka_count_guard} = AnyEvent::Util::guard {
640# --$KA_COUNT{$_[1]} 934# --$KA_COUNT{$_[1]}
641# }; 935# };
642# $hdr{connection} = "keep-alive"; 936# $hdr{connection} = "keep-alive";
643# } 937# }
644 938
645 $state{handle}->starttls ("connect") if $rscheme eq "https"; 939 $state{handle}->starttls ("connect") if $rscheme eq "https";
646 940
647 # handle actual, non-tunneled, request
648 my $handle_actual_request = sub {
649 $state{handle}->starttls ("connect") if $uscheme eq "https" && !exists $state{handle}{tls};
650
651 # send request
652 $state{handle}->push_write (
653 "$method $rpath HTTP/1.1\015\012"
654 . (join "", map "\u$_: $hdr{$_}\015\012", grep defined $hdr{$_}, keys %hdr)
655 . "\015\012"
656 . (delete $arg{body})
657 );
658
659 # return if error occured during push_write()
660 return unless %state;
661
662 %hdr = (); # reduce memory usage, save a kitten, also make it possible to re-use
663
664 # status line and headers
665 $state{read_response} = sub {
666 for ("$_[1]") {
667 y/\015//d; # weed out any \015, as they show up in the weirdest of places.
668
669 /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\012]*) )? \012/igxc
670 or return (%state = (), $cb->(undef, { @pseudo, Status => 599, Reason => "Invalid server response" }));
671
672 # 100 Continue handling
673 # should not happen as we don't send expect: 100-continue,
674 # but we handle it just in case.
675 # since we send the request body regardless, if we get an error
676 # we are out of-sync, which we currently do NOT handle correctly.
677 return $state{handle}->push_read (line => $qr_nlnl, $state{read_response})
678 if $2 eq 100;
679
680 push @pseudo,
681 HTTPVersion => $1,
682 Status => $2,
683 Reason => $3,
684 ;
685
686 my $hdr = parse_hdr
687 or return (%state = (), $cb->(undef, { @pseudo, Status => 599, Reason => "Garbled response headers" }));
688
689 %hdr = (%$hdr, @pseudo);
690 }
691
692 # redirect handling
693 # microsoft and other shitheads don't give a shit for following standards,
694 # try to support some common forms of broken Location headers.
695 if ($hdr{location} !~ /^(?: $ | [^:\/?\#]+ : )/x) {
696 $hdr{location} =~ s/^\.\/+//;
697
698 my $url = "$rscheme://$uhost:$uport";
699
700 unless ($hdr{location} =~ s/^\///) {
701 $url .= $upath;
702 $url =~ s/\/[^\/]*$//;
703 }
704
705 $hdr{location} = "$url/$hdr{location}";
706 }
707
708 my $redirect;
709
710 if ($recurse) {
711 my $status = $hdr{Status};
712
713 # industry standard is to redirect POST as GET for
714 # 301, 302 and 303, in contrast to http/1.0 and 1.1.
715 # also, the UA should ask the user for 301 and 307 and POST,
716 # industry standard seems to be to simply follow.
717 # we go with the industry standard.
718 if ($status == 301 or $status == 302 or $status == 303) {
719 # HTTP/1.1 is unclear on how to mutate the method
720 $method = "GET" unless $method eq "HEAD";
721 $redirect = 1;
722 } elsif ($status == 307) {
723 $redirect = 1;
724 }
725 }
726
727 my $finish = sub { # ($data, $err_status, $err_reason[, $keepalive])
728 my $keepalive = pop;
729
730 $state{handle}->destroy if $state{handle};
731 %state = ();
732
733 if (defined $_[1]) {
734 $hdr{OrigStatus} = $hdr{Status}; $hdr{Status} = $_[1];
735 $hdr{OrigReason} = $hdr{Reason}; $hdr{Reason} = $_[2];
736 }
737
738 # set-cookie processing
739 if ($arg{cookie_jar}) {
740 cookie_jar_set_cookie $arg{cookie_jar}, $hdr{"set-cookie"};
741
742 if ($redirect && exists $hdr{location}) {
743 # we ignore any errors, as it is very common to receive
744 # Content-Length != 0 but no actual body
745 # we also access %hdr, as $_[1] might be an erro
746 http_request (
747 $method => $hdr{location},
748 %arg,
749 recurse => $recurse - 1,
750 Redirect => [$_[0], \%hdr],
751 $cb);
752 } else {
753 $cb->($_[0], \%hdr);
754 }
755 };
756
757 my $len = $hdr{"content-length"};
758
759 if (!$redirect && $arg{on_header} && !$arg{on_header}(\%hdr)) {
760 $finish->(undef, 598 => "Request cancelled by on_header");
761 } elsif (
762 $hdr{Status} =~ /^(?:1..|204|205|304)$/
763 or $method eq "HEAD"
764 or (defined $len && !$len)
765 ) {
766 # no body
767 $finish->("", undef, undef, 1);
768 } else {
769 # body handling, many different code paths
770 # - no body expected
771 # - want_body_handle
772 # - te chunked
773 # - 2x length known (with or without on_body)
774 # - 2x length not known (with or without on_body)
775 if (!$redirect && $arg{want_body_handle}) {
776 $_[0]->on_eof (undef);
777 $_[0]->on_error (undef);
778 $_[0]->on_read (undef);
779
780 $finish->(delete $state{handle});
781
782 } elsif ($hdr{"transfer-encoding"} =~ /\bchunked\b/i) {
783 my $cl = 0;
784 my $body = undef;
785 my $on_body = $arg{on_body} || sub { $body .= shift; 1 };
786
787 $_[0]->on_error (sub { $finish->(undef, 599 => $_[2]) });
788
789 my $read_chunk; $read_chunk = sub {
790 $_[1] =~ /^([0-9a-fA-F]+)/
791 or $finish->(undef, 599 => "Garbled chunked transfer encoding");
792
793 my $len = hex $1;
794
795 if ($len) {
796 $cl += $len;
797
798 $_[0]->push_read (chunk => $len, sub {
799 $on_body->($_[1], \%hdr)
800 or return $finish->(undef, 598 => "Request cancelled by on_body");
801
802 $_[0]->push_read (line => sub {
803 length $_[1]
804 and return $finish->(undef, 599 => "Garbled chunked transfer encoding");
805 $_[0]->push_read (line => $read_chunk);
806 });
807 });
808 } else {
809 $hdr{"content-length"} ||= $cl;
810
811 $_[0]->push_read (line => $qr_nlnl, sub {
812 if (length $_[1]) {
813 for ("$_[1]") {
814 y/\015//d; # weed out any \015, as they show up in the weirdest of places.
815
816 my $hdr = parse_hdr
817 or return $finish->(undef, 599 => "Garbled response trailers");
818
819 %hdr = (%hdr, %$hdr);
820 }
821 }
822
823 $finish->($body, undef, undef, 1);
824 });
825 }
826 };
827
828 $_[0]->push_read (line => $read_chunk);
829
830 } elsif ($arg{on_body}) {
831 $_[0]->on_error (sub { $finish->(undef, 599 => $_[2]) });
832
833 if ($len) {
834 $_[0]->on_read (sub {
835 $len -= length $_[0]{rbuf};
836
837 $arg{on_body}(delete $_[0]{rbuf}, \%hdr)
838 or return $finish->(undef, 598 => "Request cancelled by on_body");
839
840 $len > 0
841 or $finish->("", undef, undef, 1);
842 });
843 } else {
844 $_[0]->on_eof (sub {
845 $finish->("");
846 });
847 $_[0]->on_read (sub {
848 $arg{on_body}(delete $_[0]{rbuf}, \%hdr)
849 or $finish->(undef, 598 => "Request cancelled by on_body");
850 });
851 }
852 } else {
853 $_[0]->on_eof (undef);
854
855 if ($len) {
856 $_[0]->on_error (sub { $finish->(undef, 599 => $_[2]) });
857 $_[0]->on_read (sub {
858 $finish->((substr delete $_[0]{rbuf}, 0, $len, ""), undef, undef, 1)
859 if $len <= length $_[0]{rbuf};
860 });
861 } else {
862 $_[0]->on_error (sub {
863 ($! == Errno::EPIPE || !$!)
864 ? $finish->(delete $_[0]{rbuf})
865 : $finish->(undef, 599 => $_[2]);
866 });
867 $_[0]->on_read (sub { });
868 }
869 }
870 }
871 };
872
873 $state{handle}->push_read (line => $qr_nlnl, $state{read_response});
874 };
875
876 # now handle proxy-CONNECT method 941 # now handle proxy-CONNECT method
877 if ($proxy && $uscheme eq "https") { 942 if ($proxy && $uscheme eq "https") {
878 # oh dear, we have to wrap it into a connect request 943 # oh dear, we have to wrap it into a connect request
879 944
880 # maybe re-use $uauthority with patched port? 945 # maybe re-use $uauthority with patched port?
881 $state{handle}->push_write ("CONNECT $uhost:$uport HTTP/1.0\015\012Host: $uhost\015\012\015\012"); 946 $state{handle}->push_write ("CONNECT $uhost:$uport HTTP/1.0\015\012\015\012");
882 $state{handle}->push_read (line => $qr_nlnl, sub { 947 $state{handle}->push_read (line => $qr_nlnl, sub {
883 $_[1] =~ /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\015\012]*) )?/ix 948 $_[1] =~ /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\015\012]*) )?/ix
884 or return (%state = (), $cb->(undef, { @pseudo, Status => 599, Reason => "Invalid proxy connect response ($_[1])" })); 949 or return (%state = (), $cb->(undef, { @pseudo, Status => 599, Reason => "Invalid proxy connect response ($_[1])" }));
885 950
886 if ($2 == 200) { 951 if ($2 == 200) {
887 $rpath = $upath; 952 $rpath = $upath;
888 &$handle_actual_request; 953 $handle_actual_request->();
889 } else { 954 } else {
890 %state = (); 955 %state = ();
891 $cb->(undef, { @pseudo, Status => $2, Reason => $3 }); 956 $cb->(undef, { @pseudo, Status => $2, Reason => $3 });
892 }
893 }); 957 }
894 } else {
895 &$handle_actual_request;
896 } 958 });
959 } else {
960 $handle_actual_request->();
897 }; 961 }
962 };
963
964 _get_slot $uhost, sub {
965 $state{slot_guard} = shift;
966
967 return unless $state{connect_guard};
898 968
899 my $tcp_connect = $arg{tcp_connect} 969 my $tcp_connect = $arg{tcp_connect}
900 || do { require AnyEvent::Socket; \&AnyEvent::Socket::tcp_connect }; 970 || do { require AnyEvent::Socket; \&AnyEvent::Socket::tcp_connect };
901 971
902 $state{connect_guard} = $tcp_connect->($rhost, $rport, $connect_cb, $arg{on_prepare} || sub { $timeout }); 972 $state{connect_guard} = $tcp_connect->($rhost, $rport, $connect_cb, $arg{on_prepare} || sub { $timeout });
903
904 }; 973 };
905 974
906 defined wantarray && AnyEvent::Util::guard { %state = () } 975 defined wantarray && AnyEvent::Util::guard { %state = () }
907} 976}
908 977
943string of the form C<http://host:port> (optionally C<https:...>), croaks 1012string of the form C<http://host:port> (optionally C<https:...>), croaks
944otherwise. 1013otherwise.
945 1014
946To clear an already-set proxy, use C<undef>. 1015To clear an already-set proxy, use C<undef>.
947 1016
1017=item AnyEvent::HTTP::cookie_jar_expire $jar[, $session_end]
1018
1019Remove all cookies from the cookie jar that have been expired. If
1020C<$session_end> is given and true, then additionally remove all session
1021cookies.
1022
1023You should call this function (with a true C<$session_end>) before you
1024save cookies to disk, and you should call this function after loading them
1025again. If you have a long-running program you can additonally call this
1026function from time to time.
1027
1028A cookie jar is initially an empty hash-reference that is managed by this
1029module. It's format is subject to change, but currently it is like this:
1030
1031The key C<version> has to contain C<1>, otherwise the hash gets
1032emptied. All other keys are hostnames or IP addresses pointing to
1033hash-references. The key for these inner hash references is the
1034server path for which this cookie is meant, and the values are again
1035hash-references. The keys of those hash-references is the cookie name, and
1036the value, you guessed it, is another hash-reference, this time with the
1037key-value pairs from the cookie, except for C<expires> and C<max-age>,
1038which have been replaced by a C<_expires> key that contains the cookie
1039expiry timestamp.
1040
1041Here is an example of a cookie jar with a single cookie, so you have a
1042chance of understanding the above paragraph:
1043
1044 {
1045 version => 1,
1046 "10.0.0.1" => {
1047 "/" => {
1048 "mythweb_id" => {
1049 _expires => 1293917923,
1050 value => "ooRung9dThee3ooyXooM1Ohm",
1051 },
1052 },
1053 },
1054 }
1055
948=item $date = AnyEvent::HTTP::format_date $timestamp 1056=item $date = AnyEvent::HTTP::format_date $timestamp
949 1057
950Takes a POSIX timestamp (seconds since the epoch) and formats it as a HTTP 1058Takes a POSIX timestamp (seconds since the epoch) and formats it as a HTTP
951Date (RFC 2616). 1059Date (RFC 2616).
952 1060
953=item $timestamp = AnyEvent::HTTP::parse_date $date 1061=item $timestamp = AnyEvent::HTTP::parse_date $date
954 1062
955Takes a HTTP Date (RFC 2616) or a Cookie date (netscape cookie spec) and 1063Takes a HTTP Date (RFC 2616) or a Cookie date (netscape cookie spec) or a
956returns the corresponding POSIX timestamp, or C<undef> if the date cannot 1064bunch of minor variations of those, and returns the corresponding POSIX
957be parsed. 1065timestamp, or C<undef> if the date cannot be parsed.
958 1066
959=item $AnyEvent::HTTP::MAX_RECURSE 1067=item $AnyEvent::HTTP::MAX_RECURSE
960 1068
961The default value for the C<recurse> request parameter (default: C<10>). 1069The default value for the C<recurse> request parameter (default: C<10>).
962 1070
1001sub parse_date($) { 1109sub parse_date($) {
1002 my ($date) = @_; 1110 my ($date) = @_;
1003 1111
1004 my ($d, $m, $y, $H, $M, $S); 1112 my ($d, $m, $y, $H, $M, $S);
1005 1113
1006 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$/) { 1114 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$/) {
1007 # RFC 822/1123, required by RFC 2616 (with " ") 1115 # RFC 822/1123, required by RFC 2616 (with " ")
1008 # cookie dates (with "-") 1116 # cookie dates (with "-")
1009 1117
1010 ($d, $m, $y, $H, $M, $S) = ($1, $2, $3, $4, $5, $6); 1118 ($d, $m, $y, $H, $M, $S) = ($1, $2, $3, $4, $5, $6);
1011 1119
1012 } 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$/) { 1120 } elsif ($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]?) GMT$/) {
1013 # RFC 850 1121 # RFC 850
1014 ($d, $m, $y, $H, $M, $S) = ($1, $2, $3 < 69 ? $3 + 2000 : $3 + 1900, $4, $5, $6); 1122 ($d, $m, $y, $H, $M, $S) = ($1, $2, $3 < 69 ? $3 + 2000 : $3 + 1900, $4, $5, $6);
1015 1123
1016 } 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])$/) { 1124 } 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])$/) {
1017 # ISO C's asctime 1125 # ISO C's asctime
1018 ($d, $m, $y, $H, $M, $S) = ($2, $1, $6, $3, $4, $5); 1126 ($d, $m, $y, $H, $M, $S) = ($2, $1, $6, $3, $4, $5);
1019 } 1127 }
1020 # other formats fail in the loop below 1128 # other formats fail in the loop below
1021 1129

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines