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.105 by root, Tue May 10 12:33:51 2011 UTC vs.
Revision 1.131 by root, Thu Aug 30 17:04:28 2018 UTC

… …
46use AnyEvent::Util (); 46use AnyEvent::Util ();
47use AnyEvent::Handle (); 47use AnyEvent::Handle ();
48 48
49use base Exporter::; 49use base Exporter::;
50 50
51our $VERSION = '2.11'; 51our $VERSION = 2.24;
52 52
53our @EXPORT = qw(http_get http_post http_head http_request); 53our @EXPORT = qw(http_get http_post http_head http_request);
54 54
55our $USERAGENT = "Mozilla/5.0 (compatible; U; AnyEvent-HTTP/$VERSION; +http://software.schmorp.de/pkg/AnyEvent)"; 55our $USERAGENT = "Mozilla/5.0 (compatible; U; AnyEvent-HTTP/$VERSION; +http://software.schmorp.de/pkg/AnyEvent)";
56our $MAX_RECURSE = 10; 56our $MAX_RECURSE = 10;
… …
89C<http_request> returns a "cancellation guard" - you have to keep the 89C<http_request> returns a "cancellation guard" - you have to keep the
90object at least alive until the callback get called. If the object gets 90object at least alive until the callback get called. If the object gets
91destroyed before the callback is called, the request will be cancelled. 91destroyed before the callback is called, the request will be cancelled.
92 92
93The callback will be called with the response body data as first argument 93The callback will be called with the response body data as first argument
94(or C<undef> if an error occured), and a hash-ref with response headers 94(or C<undef> if an error occurred), and a hash-ref with response headers
95(and trailers) as second argument. 95(and trailers) as second argument.
96 96
97All the headers in that hash are lowercased. In addition to the response 97All the headers in that hash are lowercased. In addition to the response
98headers, the "pseudo-headers" (uppercase to avoid clashing with possible 98headers, the "pseudo-headers" (uppercase to avoid clashing with possible
99response headers) C<HTTPVersion>, C<Status> and C<Reason> contain the 99response headers) C<HTTPVersion>, C<Status> and C<Reason> contain the
… …
123C<590>-C<599> and the C<Reason> pseudo-header will contain an error 123C<590>-C<599> and the C<Reason> pseudo-header will contain an error
124message. Currently the following status codes are used: 124message. Currently the following status codes are used:
125 125
126=over 4 126=over 4
127 127
128=item 595 - errors during connection etsbalishment, proxy handshake. 128=item 595 - errors during connection establishment, proxy handshake.
129 129
130=item 596 - errors during TLS negotiation, request sending and header processing. 130=item 596 - errors during TLS negotiation, request sending and header processing.
131 131
132=item 597 - errors during body receiving or processing. 132=item 597 - errors during body receiving or processing.
133 133
… …
154 154
155=over 4 155=over 4
156 156
157=item recurse => $count (default: $MAX_RECURSE) 157=item recurse => $count (default: $MAX_RECURSE)
158 158
159Whether to recurse requests or not, e.g. on redirects, authentication 159Whether to recurse requests or not, e.g. on redirects, authentication and
160retries and so on, and how often to do so. 160other retries and so on, and how often to do so.
161
162Only redirects to http and https URLs are supported. While most common
163redirection forms are handled entirely within this module, some require
164the use of the optional L<URI> module. If it is required but missing, then
165the request will fail with an error.
161 166
162=item headers => hashref 167=item headers => hashref
163 168
164The request headers to use. Currently, C<http_request> may provide its own 169The request headers to use. Currently, C<http_request> may provide its own
165C<Host:>, C<Content-Length:>, C<Connection:> and C<Cookie:> headers and 170C<Host:>, C<Content-Length:>, C<Connection:> and C<Cookie:> headers and
… …
189 194
190C<$scheme> must be either missing or must be C<http> for HTTP. 195C<$scheme> must be either missing or must be C<http> for HTTP.
191 196
192If not specified, then the default proxy is used (see 197If not specified, then the default proxy is used (see
193C<AnyEvent::HTTP::set_proxy>). 198C<AnyEvent::HTTP::set_proxy>).
199
200Currently, if your proxy requires authorization, you have to specify an
201appropriate "Proxy-Authorization" header in every request.
194 202
195=item body => $string 203=item body => $string
196 204
197The request body, usually empty. Will be sent as-is (future versions of 205The request body, usually empty. Will be sent as-is (future versions of
198this module might offer more options). 206this module might offer more options).
… …
242context) - only connections using the same unique ID will be reused. 250context) - only connections using the same unique ID will be reused.
243 251
244=item on_prepare => $callback->($fh) 252=item on_prepare => $callback->($fh)
245 253
246In rare cases you need to "tune" the socket before it is used to 254In rare cases you need to "tune" the socket before it is used to
247connect (for exmaple, to bind it on a given IP address). This parameter 255connect (for example, to bind it on a given IP address). This parameter
248overrides the prepare callback passed to C<AnyEvent::Socket::tcp_connect> 256overrides the prepare callback passed to C<AnyEvent::Socket::tcp_connect>
249and behaves exactly the same way (e.g. it has to provide a 257and behaves exactly the same way (e.g. it has to provide a
250timeout). See the description for the C<$prepare_cb> argument of 258timeout). See the description for the C<$prepare_cb> argument of
251C<AnyEvent::Socket::tcp_connect> for details. 259C<AnyEvent::Socket::tcp_connect> for details.
252 260
… …
384 392
385Example: do a HTTP HEAD request on https://www.google.com/, use a 393Example: do a HTTP HEAD request on https://www.google.com/, use a
386timeout of 30 seconds. 394timeout of 30 seconds.
387 395
388 http_request 396 http_request
389 GET => "https://www.google.com", 397 HEAD => "https://www.google.com",
390 headers => { "user-agent" => "MySearchClient 1.0" }, 398 headers => { "user-agent" => "MySearchClient 1.0" },
391 timeout => 30, 399 timeout => 30,
392 sub { 400 sub {
393 my ($body, $hdr) = @_; 401 my ($body, $hdr) = @_;
394 use Data::Dumper; 402 use Data::Dumper;
… …
446 454
447# expire cookies 455# expire cookies
448sub cookie_jar_expire($;$) { 456sub cookie_jar_expire($;$) {
449 my ($jar, $session_end) = @_; 457 my ($jar, $session_end) = @_;
450 458
451 %$jar = () if $jar->{version} != 1; 459 %$jar = () if $jar->{version} != 2;
452 460
453 my $anow = AE::now; 461 my $anow = AE::now;
454 462
455 while (my ($chost, $paths) = each %$jar) { 463 while (my ($chost, $paths) = each %$jar) {
456 next unless ref $paths; 464 next unless ref $paths;
… …
476 484
477# extract cookies from jar 485# extract cookies from jar
478sub cookie_jar_extract($$$$) { 486sub cookie_jar_extract($$$$) {
479 my ($jar, $scheme, $host, $path) = @_; 487 my ($jar, $scheme, $host, $path) = @_;
480 488
481 %$jar = () if $jar->{version} != 1; 489 %$jar = () if $jar->{version} != 2;
490
491 $host = AnyEvent::Util::idn_to_ascii $host
492 if $host =~ /[^\x00-\x7f]/;
482 493
483 my @cookies; 494 my @cookies;
484 495
485 while (my ($chost, $paths) = each %$jar) { 496 while (my ($chost, $paths) = each %$jar) {
486 next unless ref $paths; 497 next unless ref $paths;
487 498
488 if ($chost =~ /^\./) { 499 # exact match or suffix including . match
489 next unless $chost eq substr $host, -length $chost; 500 $chost eq $host or ".$chost" eq substr $host, -1 - length $chost
490 } elsif ($chost =~ /\./) {
491 next unless $chost eq $host;
492 } else {
493 next; 501 or next;
494 }
495 502
496 while (my ($cpath, $cookies) = each %$paths) { 503 while (my ($cpath, $cookies) = each %$paths) {
497 next unless $cpath eq substr $path, 0, length $cpath; 504 next unless $cpath eq substr $path, 0, length $cpath;
498 505
499 while (my ($cookie, $kv) = each %$cookies) { 506 while (my ($cookie, $kv) = each %$cookies) {
… …
520} 527}
521 528
522# parse set_cookie header into jar 529# parse set_cookie header into jar
523sub cookie_jar_set_cookie($$$$) { 530sub cookie_jar_set_cookie($$$$) {
524 my ($jar, $set_cookie, $host, $date) = @_; 531 my ($jar, $set_cookie, $host, $date) = @_;
532
533 %$jar = () if $jar->{version} != 2;
525 534
526 my $anow = int AE::now; 535 my $anow = int AE::now;
527 my $snow; # server-now 536 my $snow; # server-now
528 537
529 for ($set_cookie) { 538 for ($set_cookie) {
… …
575 584
576 my $cdom; 585 my $cdom;
577 my $cpath = (delete $kv{path}) || "/"; 586 my $cpath = (delete $kv{path}) || "/";
578 587
579 if (exists $kv{domain}) { 588 if (exists $kv{domain}) {
580 $cdom = delete $kv{domain}; 589 $cdom = $kv{domain};
581 590
582 $cdom =~ s/^\.?/./; # make sure it starts with a "." 591 $cdom =~ s/^\.?/./; # make sure it starts with a "."
583 592
584 next if $cdom =~ /\.$/; 593 next if $cdom =~ /\.$/;
585 594
586 # this is not rfc-like and not netscape-like. go figure. 595 # this is not rfc-like and not netscape-like. go figure.
587 my $ndots = $cdom =~ y/.//; 596 my $ndots = $cdom =~ y/.//;
588 next if $ndots < ($cdom =~ /\.[^.][^.]\.[^.][^.]$/ ? 3 : 2); 597 next if $ndots < ($cdom =~ /\.[^.][^.]\.[^.][^.]$/ ? 3 : 2);
598
599 $cdom = substr $cdom, 1; # remove initial .
589 } else { 600 } else {
590 $cdom = $host; 601 $cdom = $host;
591 } 602 }
592 603
593 # store it 604 # store it
594 $jar->{version} = 1; 605 $jar->{version} = 2;
595 $jar->{lc $cdom}{$cpath}{$name} = \%kv; 606 $jar->{lc $cdom}{$cpath}{$name} = \%kv;
596 607
597 redo if /\G\s*,/gc; 608 redo if /\G\s*,/gc;
598 } 609 }
599} 610}
… …
689 700
690 $cb->(undef, $hdr); 701 $cb->(undef, $hdr);
691 () 702 ()
692} 703}
693 704
705our %IDEMPOTENT = (
706 DELETE => 1,
707 GET => 1,
708 HEAD => 1,
709 OPTIONS => 1,
710 PUT => 1,
711 TRACE => 1,
712
713 ACL => 1,
714 "BASELINE-CONTROL" => 1,
715 BIND => 1,
716 CHECKIN => 1,
717 CHECKOUT => 1,
718 COPY => 1,
719 LABEL => 1,
720 LINK => 1,
721 MERGE => 1,
722 MKACTIVITY => 1,
723 MKCALENDAR => 1,
724 MKCOL => 1,
725 MKREDIRECTREF => 1,
726 MKWORKSPACE => 1,
727 MOVE => 1,
728 ORDERPATCH => 1,
729 PROPFIND => 1,
730 PROPPATCH => 1,
731 REBIND => 1,
732 REPORT => 1,
733 SEARCH => 1,
734 UNBIND => 1,
735 UNCHECKOUT => 1,
736 UNLINK => 1,
737 UNLOCK => 1,
738 UPDATE => 1,
739 UPDATEREDIRECTREF => 1,
740 "VERSION-CONTROL" => 1,
741);
742
694sub http_request($$@) { 743sub http_request($$@) {
695 my $cb = pop; 744 my $cb = pop;
696 my ($method, $url, %arg) = @_; 745 my ($method, $url, %arg) = @_;
697 746
698 my %hdr; 747 my %hdr;
… …
727 776
728 my $uport = $uscheme eq "http" ? 80 777 my $uport = $uscheme eq "http" ? 80
729 : $uscheme eq "https" ? 443 778 : $uscheme eq "https" ? 443
730 : return $cb->(undef, { @pseudo, Status => 599, Reason => "Only http and https URL schemes supported" }); 779 : return $cb->(undef, { @pseudo, Status => 599, Reason => "Only http and https URL schemes supported" });
731 780
732 $uauthority =~ /^(?: .*\@ )? ([^\@:]+) (?: : (\d+) )?$/x 781 $uauthority =~ /^(?: .*\@ )? ([^\@]+?) (?: : (\d+) )?$/x
733 or return $cb->(undef, { @pseudo, Status => 599, Reason => "Unparsable URL" }); 782 or return $cb->(undef, { @pseudo, Status => 599, Reason => "Unparsable URL" });
734 783
735 my $uhost = lc $1; 784 my $uhost = lc $1;
736 $uport = $2 if defined $2; 785 $uport = $2 if defined $2;
737 786
… …
773 $hdr{"user-agent"} = $USERAGENT unless exists $hdr{"user-agent"}; 822 $hdr{"user-agent"} = $USERAGENT unless exists $hdr{"user-agent"};
774 823
775 $hdr{"content-length"} = length $arg{body} 824 $hdr{"content-length"} = length $arg{body}
776 if length $arg{body} || $method ne "GET"; 825 if length $arg{body} || $method ne "GET";
777 826
778 my $idempotent = $method =~ /^(?:GET|HEAD|PUT|DELETE|OPTIONS|TRACE)$/; 827 my $idempotent = $IDEMPOTENT{$method};
779 828
780 # default value for keepalive is true iff the request is for an idempotent method 829 # default value for keepalive is true iff the request is for an idempotent method
781 my $persistent = exists $arg{persistent} ? !!$arg{persistent} : $idempotent; 830 my $persistent = exists $arg{persistent} ? !!$arg{persistent} : $idempotent;
782 my $keepalive = exists $arg{keepalive} ? !!$arg{keepalive} : !$proxy; 831 my $keepalive = exists $arg{keepalive} ? !!$arg{keepalive} : !$proxy;
783 my $was_persistent; # true if this is actually a recycled connection 832 my $was_persistent; # true if this is actually a recycled connection
784 833
785 # the key to use in the keepalive cache 834 # the key to use in the keepalive cache
786 my $ka_key = "$uscheme\x00$uhost\x00$uport\x00$arg{sessionid}"; 835 my $ka_key = "$uscheme\x00$uhost\x00$uport\x00$arg{sessionid}";
787 836
788 $hdr{connection} = ($persistent ? $keepalive ? "keep-alive " : "" : "close ") . "Te"; #1.1 837 $hdr{connection} = ($persistent ? $keepalive ? "keep-alive, " : "" : "close, ") . "Te"; #1.1
789 $hdr{te} = "trailers" unless exists $hdr{te}; #1.1 838 $hdr{te} = "trailers" unless exists $hdr{te}; #1.1
790 839
791 my %state = (connect_guard => 1); 840 my %state = (connect_guard => 1);
792 841
793 my $ae_error = 595; # connecting 842 my $ae_error = 595; # connecting
… …
803 # send request 852 # send request
804 $hdl->push_write ( 853 $hdl->push_write (
805 "$method $rpath HTTP/1.1\015\012" 854 "$method $rpath HTTP/1.1\015\012"
806 . (join "", map "\u$_: $hdr{$_}\015\012", grep defined $hdr{$_}, keys %hdr) 855 . (join "", map "\u$_: $hdr{$_}\015\012", grep defined $hdr{$_}, keys %hdr)
807 . "\015\012" 856 . "\015\012"
808 . (delete $arg{body}) 857 . $arg{body}
809 ); 858 );
810 859
811 # return if error occured during push_write() 860 # return if error occurred during push_write()
812 return unless %state; 861 return unless %state;
813 862
814 # reduce memory usage, save a kitten, also re-use it for the response headers. 863 # reduce memory usage, save a kitten, also re-use it for the response headers.
815 %hdr = (); 864 %hdr = ();
816 865
… …
843 892
844 %hdr = (%$hdr, @pseudo); 893 %hdr = (%$hdr, @pseudo);
845 } 894 }
846 895
847 # redirect handling 896 # redirect handling
848 # microsoft and other shitheads don't give a shit for following standards, 897 # relative uri handling forced by microsoft and other shitheads.
849 # try to support some common forms of broken Location headers. 898 # we give our best and fall back to URI if available.
850 if ($hdr{location} !~ /^(?: $ | [^:\/?\#]+ : )/x) { 899 if (exists $hdr{location}) {
900 my $loc = $hdr{location};
901
902 if ($loc =~ m%^//%) { # //
903 $loc = "$uscheme:$loc";
904
905 } elsif ($loc eq "") {
906 $loc = $url;
907
908 } elsif ($loc !~ /^(?: $ | [^:\/?\#]+ : )/x) { # anything "simple"
851 $hdr{location} =~ s/^\.\/+//; 909 $loc =~ s/^\.\/+//;
852 910
853 my $url = "$rscheme://$uhost:$uport"; 911 if ($loc !~ m%^[.?#]%) {
912 my $prefix = "$uscheme://$uauthority";
854 913
855 unless ($hdr{location} =~ s/^\///) { 914 unless ($loc =~ s/^\///) {
856 $url .= $upath; 915 $prefix .= $upath;
857 $url =~ s/\/[^\/]*$//; 916 $prefix =~ s/\/[^\/]*$//;
917 }
918
919 $loc = "$prefix/$loc";
920
921 } elsif (eval { require URI }) { # uri
922 $loc = URI->new_abs ($loc, $url)->as_string;
923
924 } else {
925 return _error %state, $cb, { @pseudo, Status => 599, Reason => "Cannot parse Location (URI module missing)" };
926 #$hdr{Status} = 599;
927 #$hdr{Reason} = "Unparsable Redirect (URI module missing)";
928 #$recurse = 0;
929 }
858 } 930 }
859 931
860 $hdr{location} = "$url/$hdr{location}"; 932 $hdr{location} = $loc;
861 } 933 }
862 934
863 my $redirect; 935 my $redirect;
864 936
865 if ($recurse) { 937 if ($recurse) {
… …
867 939
868 # industry standard is to redirect POST as GET for 940 # industry standard is to redirect POST as GET for
869 # 301, 302 and 303, in contrast to HTTP/1.0 and 1.1. 941 # 301, 302 and 303, in contrast to HTTP/1.0 and 1.1.
870 # also, the UA should ask the user for 301 and 307 and POST, 942 # also, the UA should ask the user for 301 and 307 and POST,
871 # industry standard seems to be to simply follow. 943 # industry standard seems to be to simply follow.
872 # we go with the industry standard. 944 # we go with the industry standard. 308 is defined
945 # by rfc7538
873 if ($status == 301 or $status == 302 or $status == 303) { 946 if ($status == 301 or $status == 302 or $status == 303) {
947 $redirect = 1;
874 # HTTP/1.1 is unclear on how to mutate the method 948 # HTTP/1.1 is unclear on how to mutate the method
875 $method = "GET" unless $method eq "HEAD"; 949 unless ($method eq "HEAD") {
876 $redirect = 1; 950 $method = "GET";
951 delete $arg{body};
952 }
877 } elsif ($status == 307) { 953 } elsif ($status == 307 or $status == 308) {
878 $redirect = 1; 954 $redirect = 1;
879 } 955 }
880 } 956 }
881 957
882 my $finish = sub { # ($data, $err_status, $err_reason[, $persistent]) 958 my $finish = sub { # ($data, $err_status, $err_reason[, $persistent])
… …
958 $finish->(delete $state{handle}); 1034 $finish->(delete $state{handle});
959 1035
960 } elsif ($chunked) { 1036 } elsif ($chunked) {
961 my $cl = 0; 1037 my $cl = 0;
962 my $body = ""; 1038 my $body = "";
963 my $on_body = $arg{on_body} || sub { $body .= shift; 1 }; 1039 my $on_body = (!$redirect && $arg{on_body}) || sub { $body .= shift; 1 };
964 1040
965 $state{read_chunk} = sub { 1041 $state{read_chunk} = sub {
966 $_[1] =~ /^([0-9a-fA-F]+)/ 1042 $_[1] =~ /^([0-9a-fA-F]+)/
967 or $finish->(undef, $ae_error => "Garbled chunked transfer encoding"); 1043 or return $finish->(undef, $ae_error => "Garbled chunked transfer encoding");
968 1044
969 my $len = hex $1; 1045 my $len = hex $1;
970 1046
971 if ($len) { 1047 if ($len) {
972 $cl += $len; 1048 $cl += $len;
… …
1001 } 1077 }
1002 }; 1078 };
1003 1079
1004 $_[0]->push_read (line => $state{read_chunk}); 1080 $_[0]->push_read (line => $state{read_chunk});
1005 1081
1006 } elsif ($arg{on_body}) { 1082 } elsif (!$redirect && $arg{on_body}) {
1007 if (defined $len) { 1083 if (defined $len) {
1008 $_[0]->on_read (sub { 1084 $_[0]->on_read (sub {
1009 $len -= length $_[0]{rbuf}; 1085 $len -= length $_[0]{rbuf};
1010 1086
1011 $arg{on_body}(delete $_[0]{rbuf}, \%hdr) 1087 $arg{on_body}(delete $_[0]{rbuf}, \%hdr)
… …
1050 _destroy_state %state; 1126 _destroy_state %state;
1051 1127
1052 %state = (); 1128 %state = ();
1053 $state{recurse} = 1129 $state{recurse} =
1054 http_request ( 1130 http_request (
1055 $method => $url, 1131 $method => $url,
1056 %arg, 1132 %arg,
1133 recurse => $recurse - 1,
1057 keepalive => 0, 1134 persistent => 0,
1058 sub { 1135 sub {
1059 %state = (); 1136 %state = ();
1060 &$cb 1137 &$cb
1061 } 1138 }
1062 ); 1139 );
… …
1108 1185
1109 # now handle proxy-CONNECT method 1186 # now handle proxy-CONNECT method
1110 if ($proxy && $uscheme eq "https") { 1187 if ($proxy && $uscheme eq "https") {
1111 # oh dear, we have to wrap it into a connect request 1188 # oh dear, we have to wrap it into a connect request
1112 1189
1190 my $auth = exists $hdr{"proxy-authorization"}
1191 ? "proxy-authorization: " . (delete $hdr{"proxy-authorization"}) . "\015\012"
1192 : "";
1193
1113 # maybe re-use $uauthority with patched port? 1194 # maybe re-use $uauthority with patched port?
1114 $state{handle}->push_write ("CONNECT $uhost:$uport HTTP/1.0\015\012\015\012"); 1195 $state{handle}->push_write ("CONNECT $uhost:$uport HTTP/1.0\015\012$auth\015\012");
1115 $state{handle}->push_read (line => $qr_nlnl, sub { 1196 $state{handle}->push_read (line => $qr_nlnl, sub {
1116 $_[1] =~ /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\015\012]*) )?/ix 1197 $_[1] =~ /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\015\012]*) )?/ix
1117 or return _error %state, $cb, { @pseudo, Status => 599, Reason => "Invalid proxy connect response ($_[1])" }; 1198 or return _error %state, $cb, { @pseudo, Status => 599, Reason => "Invalid proxy connect response ($_[1])" };
1118 1199
1119 if ($2 == 200) { 1200 if ($2 == 200) {
… …
1122 } else { 1203 } else {
1123 _error %state, $cb, { @pseudo, Status => $2, Reason => $3 }; 1204 _error %state, $cb, { @pseudo, Status => $2, Reason => $3 };
1124 } 1205 }
1125 }); 1206 });
1126 } else { 1207 } else {
1208 delete $hdr{"proxy-authorization"} unless $proxy;
1209
1127 $handle_actual_request->(); 1210 $handle_actual_request->();
1128 } 1211 }
1129 }; 1212 };
1130 1213
1131 _get_slot $uhost, sub { 1214 _get_slot $uhost, sub {
… …
1137 # on a keepalive request (in theory, this should be a separate config option). 1220 # on a keepalive request (in theory, this should be a separate config option).
1138 if ($persistent && $KA_CACHE{$ka_key}) { 1221 if ($persistent && $KA_CACHE{$ka_key}) {
1139 $was_persistent = 1; 1222 $was_persistent = 1;
1140 1223
1141 $state{handle} = ka_fetch $ka_key; 1224 $state{handle} = ka_fetch $ka_key;
1142 $state{handle}->destroyed 1225# $state{handle}->destroyed
1143 and die "got a destructed habndle. pah\n";#d# 1226# and die "AnyEvent::HTTP: unexpectedly got a destructed handle (1), please report.";#d#
1144 $prepare_handle->(); 1227 $prepare_handle->();
1145 $state{handle}->destroyed 1228# $state{handle}->destroyed
1146 and die "got a destructed habndle. pa2\n";#d# 1229# and die "AnyEvent::HTTP: unexpectedly got a destructed handle (2), please report.";#d#
1147 $handle_actual_request->(); 1230 $handle_actual_request->();
1148 $state{handle}->destroyed
1149 and die "got a destructed habndle. pa3\n";#d#
1150 1231
1151 } else { 1232 } else {
1152 my $tcp_connect = $arg{tcp_connect} 1233 my $tcp_connect = $arg{tcp_connect}
1153 || do { require AnyEvent::Socket; \&AnyEvent::Socket::tcp_connect }; 1234 || do { require AnyEvent::Socket; \&AnyEvent::Socket::tcp_connect };
1154 1235
… …
1195Sets the default proxy server to use. The proxy-url must begin with a 1276Sets the default proxy server to use. The proxy-url must begin with a
1196string of the form C<http://host:port>, croaks otherwise. 1277string of the form C<http://host:port>, croaks otherwise.
1197 1278
1198To clear an already-set proxy, use C<undef>. 1279To clear an already-set proxy, use C<undef>.
1199 1280
1200When AnyEvent::HTTP is laoded for the first time it will query the 1281When AnyEvent::HTTP is loaded for the first time it will query the
1201default proxy from the operating system, currently by looking at 1282default proxy from the operating system, currently by looking at
1202C<$ENV{http_proxy>}. 1283C<$ENV{http_proxy>}.
1203 1284
1204=item AnyEvent::HTTP::cookie_jar_expire $jar[, $session_end] 1285=item AnyEvent::HTTP::cookie_jar_expire $jar[, $session_end]
1205 1286
… …
1207C<$session_end> is given and true, then additionally remove all session 1288C<$session_end> is given and true, then additionally remove all session
1208cookies. 1289cookies.
1209 1290
1210You should call this function (with a true C<$session_end>) before you 1291You should call this function (with a true C<$session_end>) before you
1211save cookies to disk, and you should call this function after loading them 1292save cookies to disk, and you should call this function after loading them
1212again. If you have a long-running program you can additonally call this 1293again. If you have a long-running program you can additionally call this
1213function from time to time. 1294function from time to time.
1214 1295
1215A cookie jar is initially an empty hash-reference that is managed by this 1296A cookie jar is initially an empty hash-reference that is managed by this
1216module. It's format is subject to change, but currently it is like this: 1297module. Its format is subject to change, but currently it is as follows:
1217 1298
1218The key C<version> has to contain C<1>, otherwise the hash gets 1299The key C<version> has to contain C<2>, otherwise the hash gets
1219emptied. All other keys are hostnames or IP addresses pointing to 1300cleared. All other keys are hostnames or IP addresses pointing to
1220hash-references. The key for these inner hash references is the 1301hash-references. The key for these inner hash references is the
1221server path for which this cookie is meant, and the values are again 1302server path for which this cookie is meant, and the values are again
1222hash-references. The keys of those hash-references is the cookie name, and 1303hash-references. Each key of those hash-references is a cookie name, and
1223the value, you guessed it, is another hash-reference, this time with the 1304the value, you guessed it, is another hash-reference, this time with the
1224key-value pairs from the cookie, except for C<expires> and C<max-age>, 1305key-value pairs from the cookie, except for C<expires> and C<max-age>,
1225which have been replaced by a C<_expires> key that contains the cookie 1306which have been replaced by a C<_expires> key that contains the cookie
1226expiry timestamp. 1307expiry timestamp. Session cookies are indicated by not having an
1308C<_expires> key.
1227 1309
1228Here is an example of a cookie jar with a single cookie, so you have a 1310Here is an example of a cookie jar with a single cookie, so you have a
1229chance of understanding the above paragraph: 1311chance of understanding the above paragraph:
1230 1312
1231 { 1313 {
… …
1255 1337
1256The default value for the C<recurse> request parameter (default: C<10>). 1338The default value for the C<recurse> request parameter (default: C<10>).
1257 1339
1258=item $AnyEvent::HTTP::TIMEOUT 1340=item $AnyEvent::HTTP::TIMEOUT
1259 1341
1260The default timeout for conenction operations (default: C<300>). 1342The default timeout for connection operations (default: C<300>).
1261 1343
1262=item $AnyEvent::HTTP::USERAGENT 1344=item $AnyEvent::HTTP::USERAGENT
1263 1345
1264The default value for the C<User-Agent> header (the default is 1346The default value for the C<User-Agent> header (the default is
1265C<Mozilla/5.0 (compatible; U; AnyEvent-HTTP/$VERSION; +http://software.schmorp.de/pkg/AnyEvent)>). 1347C<Mozilla/5.0 (compatible; U; AnyEvent-HTTP/$VERSION; +http://software.schmorp.de/pkg/AnyEvent)>).
1266 1348
1267=item $AnyEvent::HTTP::MAX_PER_HOST 1349=item $AnyEvent::HTTP::MAX_PER_HOST
1268 1350
1269The maximum number of concurrent connections to the same host (identified 1351The maximum number of concurrent connections to the same host (identified
1270by the hostname). If the limit is exceeded, then the additional requests 1352by the hostname). If the limit is exceeded, then additional requests
1271are queued until previous connections are closed. Both persistent and 1353are queued until previous connections are closed. Both persistent and
1272non-persistent connections are counted in this limit. 1354non-persistent connections are counted in this limit.
1273 1355
1274The default value for this is C<4>, and it is highly advisable to not 1356The default value for this is C<4>, and it is highly advisable to not
1275increase it much. 1357increase it much.
1276 1358
1277For comparison: the RFC's recommend 4 non-persistent or 2 persistent 1359For comparison: the RFC's recommend 4 non-persistent or 2 persistent
1278connections, older browsers used 2, newers (such as firefox 3) typically 1360connections, older browsers used 2, newer ones (such as firefox 3)
1279use 6, and Opera uses 8 because like, they have the fastest browser and 1361typically use 6, and Opera uses 8 because like, they have the fastest
1280give a shit for everybody else on the planet. 1362browser and give a shit for everybody else on the planet.
1281 1363
1282=item $AnyEvent::HTTP::PERSISTENT_TIMEOUT 1364=item $AnyEvent::HTTP::PERSISTENT_TIMEOUT
1283 1365
1284The time after which idle persistent conenctions get closed by 1366The time after which idle persistent connections get closed by
1285AnyEvent::HTTP (default: C<3>). 1367AnyEvent::HTTP (default: C<3>).
1286 1368
1287=item $AnyEvent::HTTP::ACTIVE 1369=item $AnyEvent::HTTP::ACTIVE
1288 1370
1289The number of active connections. This is not the number of currently 1371The number of active connections. This is not the number of currently
… …
1330 # other formats fail in the loop below 1412 # other formats fail in the loop below
1331 1413
1332 for (0..11) { 1414 for (0..11) {
1333 if ($m eq $month[$_]) { 1415 if ($m eq $month[$_]) {
1334 require Time::Local; 1416 require Time::Local;
1335 return Time::Local::timegm ($S, $M, $H, $d, $_, $y); 1417 return eval { Time::Local::timegm ($S, $M, $H, $d, $_, $y) };
1336 } 1418 }
1337 } 1419 }
1338 1420
1339 undef 1421 undef
1340} 1422}
… …
1354 set_proxy $ENV{http_proxy}; 1436 set_proxy $ENV{http_proxy};
1355}; 1437};
1356 1438
1357=head2 SHOWCASE 1439=head2 SHOWCASE
1358 1440
1359This section contaisn some more elaborate "real-world" examples or code 1441This section contains some more elaborate "real-world" examples or code
1360snippets. 1442snippets.
1361 1443
1362=head2 HTTP/1.1 FILE DOWNLOAD 1444=head2 HTTP/1.1 FILE DOWNLOAD
1363 1445
1364Downloading files with HTTP can be quite tricky, especially when something 1446Downloading files with HTTP can be quite tricky, especially when something
… …
1368last modified time to check for file content changes, and works with many 1450last modified time to check for file content changes, and works with many
1369HTTP/1.0 servers as well, and usually falls back to a complete re-download 1451HTTP/1.0 servers as well, and usually falls back to a complete re-download
1370on older servers. 1452on older servers.
1371 1453
1372It calls the completion callback with either C<undef>, which means a 1454It calls the completion callback with either C<undef>, which means a
1373nonretryable error occured, C<0> when the download was partial and should 1455nonretryable error occurred, C<0> when the download was partial and should
1374be retried, and C<1> if it was successful. 1456be retried, and C<1> if it was successful.
1375 1457
1376 use AnyEvent::HTTP; 1458 use AnyEvent::HTTP;
1377 1459
1378 sub download($$$) { 1460 sub download($$$) {
… …
1382 or die "$file: $!"; 1464 or die "$file: $!";
1383 1465
1384 my %hdr; 1466 my %hdr;
1385 my $ofs = 0; 1467 my $ofs = 0;
1386 1468
1387 warn stat $fh;
1388 warn -s _;
1389 if (stat $fh and -s _) { 1469 if (stat $fh and -s _) {
1390 $ofs = -s _; 1470 $ofs = -s _;
1391 warn "-s is ", $ofs;#d# 1471 warn "-s is ", $ofs;
1392 $hdr{"if-unmodified-since"} = AnyEvent::HTTP::format_date +(stat _)[9]; 1472 $hdr{"if-unmodified-since"} = AnyEvent::HTTP::format_date +(stat _)[9];
1393 $hdr{"range"} = "bytes=$ofs-"; 1473 $hdr{"range"} = "bytes=$ofs-";
1394 } 1474 }
1395 1475
1396 http_get $url, 1476 http_get $url,
… …
1421 my (undef, $hdr) = @_; 1501 my (undef, $hdr) = @_;
1422 1502
1423 my $status = $hdr->{Status}; 1503 my $status = $hdr->{Status};
1424 1504
1425 if (my $time = AnyEvent::HTTP::parse_date $hdr->{"last-modified"}) { 1505 if (my $time = AnyEvent::HTTP::parse_date $hdr->{"last-modified"}) {
1426 utime $fh, $time, $time; 1506 utime $time, $time, $fh;
1427 } 1507 }
1428 1508
1429 if ($status == 200 || $status == 206 || $status == 416) { 1509 if ($status == 200 || $status == 206 || $status == 416) {
1430 # download ok || resume ok || file already fully downloaded 1510 # download ok || resume ok || file already fully downloaded
1431 $cb->(1, $hdr); 1511 $cb->(1, $hdr);

Diff Legend

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