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.103 by root, Thu Feb 24 12:13:11 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.1'; 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
… …
169 174
170You really should provide your own C<User-Agent:> header value that is 175You really should provide your own C<User-Agent:> header value that is
171appropriate for your program - I wouldn't be surprised if the default 176appropriate for your program - I wouldn't be surprised if the default
172AnyEvent string gets blocked by webservers sooner or later. 177AnyEvent string gets blocked by webservers sooner or later.
173 178
179Also, make sure that your headers names and values do not contain any
180embedded newlines.
181
174=item timeout => $seconds 182=item timeout => $seconds
175 183
176The time-out to use for various stages - each connect attempt will reset 184The time-out to use for various stages - each connect attempt will reset
177the timeout, as will read or write activity, i.e. this is not an overall 185the timeout, as will read or write activity, i.e. this is not an overall
178timeout. 186timeout.
… …
186 194
187C<$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.
188 196
189If not specified, then the default proxy is used (see 197If not specified, then the default proxy is used (see
190C<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.
191 202
192=item body => $string 203=item body => $string
193 204
194The 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
195this module might offer more options). 206this module might offer more options).
… …
239context) - only connections using the same unique ID will be reused. 250context) - only connections using the same unique ID will be reused.
240 251
241=item on_prepare => $callback->($fh) 252=item on_prepare => $callback->($fh)
242 253
243In 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
244connect (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
245overrides the prepare callback passed to C<AnyEvent::Socket::tcp_connect> 256overrides the prepare callback passed to C<AnyEvent::Socket::tcp_connect>
246and 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
247timeout). See the description for the C<$prepare_cb> argument of 258timeout). See the description for the C<$prepare_cb> argument of
248C<AnyEvent::Socket::tcp_connect> for details. 259C<AnyEvent::Socket::tcp_connect> for details.
249 260
… …
381 392
382Example: 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
383timeout of 30 seconds. 394timeout of 30 seconds.
384 395
385 http_request 396 http_request
386 GET => "https://www.google.com", 397 HEAD => "https://www.google.com",
387 headers => { "user-agent" => "MySearchClient 1.0" }, 398 headers => { "user-agent" => "MySearchClient 1.0" },
388 timeout => 30, 399 timeout => 30,
389 sub { 400 sub {
390 my ($body, $hdr) = @_; 401 my ($body, $hdr) = @_;
391 use Data::Dumper; 402 use Data::Dumper;
… …
443 454
444# expire cookies 455# expire cookies
445sub cookie_jar_expire($;$) { 456sub cookie_jar_expire($;$) {
446 my ($jar, $session_end) = @_; 457 my ($jar, $session_end) = @_;
447 458
448 %$jar = () if $jar->{version} != 1; 459 %$jar = () if $jar->{version} != 2;
449 460
450 my $anow = AE::now; 461 my $anow = AE::now;
451 462
452 while (my ($chost, $paths) = each %$jar) { 463 while (my ($chost, $paths) = each %$jar) {
453 next unless ref $paths; 464 next unless ref $paths;
… …
473 484
474# extract cookies from jar 485# extract cookies from jar
475sub cookie_jar_extract($$$$) { 486sub cookie_jar_extract($$$$) {
476 my ($jar, $scheme, $host, $path) = @_; 487 my ($jar, $scheme, $host, $path) = @_;
477 488
478 %$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]/;
479 493
480 my @cookies; 494 my @cookies;
481 495
482 while (my ($chost, $paths) = each %$jar) { 496 while (my ($chost, $paths) = each %$jar) {
483 next unless ref $paths; 497 next unless ref $paths;
484 498
485 if ($chost =~ /^\./) { 499 # exact match or suffix including . match
486 next unless $chost eq substr $host, -length $chost; 500 $chost eq $host or ".$chost" eq substr $host, -1 - length $chost
487 } elsif ($chost =~ /\./) {
488 next unless $chost eq $host;
489 } else {
490 next; 501 or next;
491 }
492 502
493 while (my ($cpath, $cookies) = each %$paths) { 503 while (my ($cpath, $cookies) = each %$paths) {
494 next unless $cpath eq substr $path, 0, length $cpath; 504 next unless $cpath eq substr $path, 0, length $cpath;
495 505
496 while (my ($cookie, $kv) = each %$cookies) { 506 while (my ($cookie, $kv) = each %$cookies) {
… …
517} 527}
518 528
519# parse set_cookie header into jar 529# parse set_cookie header into jar
520sub cookie_jar_set_cookie($$$$) { 530sub cookie_jar_set_cookie($$$$) {
521 my ($jar, $set_cookie, $host, $date) = @_; 531 my ($jar, $set_cookie, $host, $date) = @_;
532
533 %$jar = () if $jar->{version} != 2;
522 534
523 my $anow = int AE::now; 535 my $anow = int AE::now;
524 my $snow; # server-now 536 my $snow; # server-now
525 537
526 for ($set_cookie) { 538 for ($set_cookie) {
… …
572 584
573 my $cdom; 585 my $cdom;
574 my $cpath = (delete $kv{path}) || "/"; 586 my $cpath = (delete $kv{path}) || "/";
575 587
576 if (exists $kv{domain}) { 588 if (exists $kv{domain}) {
577 $cdom = delete $kv{domain}; 589 $cdom = $kv{domain};
578 590
579 $cdom =~ s/^\.?/./; # make sure it starts with a "." 591 $cdom =~ s/^\.?/./; # make sure it starts with a "."
580 592
581 next if $cdom =~ /\.$/; 593 next if $cdom =~ /\.$/;
582 594
583 # this is not rfc-like and not netscape-like. go figure. 595 # this is not rfc-like and not netscape-like. go figure.
584 my $ndots = $cdom =~ y/.//; 596 my $ndots = $cdom =~ y/.//;
585 next if $ndots < ($cdom =~ /\.[^.][^.]\.[^.][^.]$/ ? 3 : 2); 597 next if $ndots < ($cdom =~ /\.[^.][^.]\.[^.][^.]$/ ? 3 : 2);
598
599 $cdom = substr $cdom, 1; # remove initial .
586 } else { 600 } else {
587 $cdom = $host; 601 $cdom = $host;
588 } 602 }
589 603
590 # store it 604 # store it
591 $jar->{version} = 1; 605 $jar->{version} = 2;
592 $jar->{lc $cdom}{$cpath}{$name} = \%kv; 606 $jar->{lc $cdom}{$cpath}{$name} = \%kv;
593 607
594 redo if /\G\s*,/gc; 608 redo if /\G\s*,/gc;
595 } 609 }
596} 610}
… …
686 700
687 $cb->(undef, $hdr); 701 $cb->(undef, $hdr);
688 () 702 ()
689} 703}
690 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
691sub http_request($$@) { 743sub http_request($$@) {
692 my $cb = pop; 744 my $cb = pop;
693 my ($method, $url, %arg) = @_; 745 my ($method, $url, %arg) = @_;
694 746
695 my %hdr; 747 my %hdr;
… …
724 776
725 my $uport = $uscheme eq "http" ? 80 777 my $uport = $uscheme eq "http" ? 80
726 : $uscheme eq "https" ? 443 778 : $uscheme eq "https" ? 443
727 : 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" });
728 780
729 $uauthority =~ /^(?: .*\@ )? ([^\@:]+) (?: : (\d+) )?$/x 781 $uauthority =~ /^(?: .*\@ )? ([^\@]+?) (?: : (\d+) )?$/x
730 or return $cb->(undef, { @pseudo, Status => 599, Reason => "Unparsable URL" }); 782 or return $cb->(undef, { @pseudo, Status => 599, Reason => "Unparsable URL" });
731 783
732 my $uhost = lc $1; 784 my $uhost = lc $1;
733 $uport = $2 if defined $2; 785 $uport = $2 if defined $2;
734 786
… …
770 $hdr{"user-agent"} = $USERAGENT unless exists $hdr{"user-agent"}; 822 $hdr{"user-agent"} = $USERAGENT unless exists $hdr{"user-agent"};
771 823
772 $hdr{"content-length"} = length $arg{body} 824 $hdr{"content-length"} = length $arg{body}
773 if length $arg{body} || $method ne "GET"; 825 if length $arg{body} || $method ne "GET";
774 826
775 my $idempotent = $method =~ /^(?:GET|HEAD|PUT|DELETE|OPTIONS|TRACE)$/; 827 my $idempotent = $IDEMPOTENT{$method};
776 828
777 # 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
778 my $persistent = exists $arg{persistent} ? !!$arg{persistent} : $idempotent; 830 my $persistent = exists $arg{persistent} ? !!$arg{persistent} : $idempotent;
779 my $keepalive = exists $arg{keepalive} ? !!$arg{keepalive} : !$proxy; 831 my $keepalive = exists $arg{keepalive} ? !!$arg{keepalive} : !$proxy;
780 my $was_persistent; # true if this is actually a recycled connection 832 my $was_persistent; # true if this is actually a recycled connection
781 833
782 # the key to use in the keepalive cache 834 # the key to use in the keepalive cache
783 my $ka_key = "$uhost\x00$arg{sessionid}"; 835 my $ka_key = "$uscheme\x00$uhost\x00$uport\x00$arg{sessionid}";
784 836
785 $hdr{connection} = ($persistent ? $keepalive ? "keep-alive " : "" : "close ") . "Te"; #1.1 837 $hdr{connection} = ($persistent ? $keepalive ? "keep-alive, " : "" : "close, ") . "Te"; #1.1
786 $hdr{te} = "trailers" unless exists $hdr{te}; #1.1 838 $hdr{te} = "trailers" unless exists $hdr{te}; #1.1
787 839
788 my %state = (connect_guard => 1); 840 my %state = (connect_guard => 1);
789 841
790 my $ae_error = 595; # connecting 842 my $ae_error = 595; # connecting
… …
800 # send request 852 # send request
801 $hdl->push_write ( 853 $hdl->push_write (
802 "$method $rpath HTTP/1.1\015\012" 854 "$method $rpath HTTP/1.1\015\012"
803 . (join "", map "\u$_: $hdr{$_}\015\012", grep defined $hdr{$_}, keys %hdr) 855 . (join "", map "\u$_: $hdr{$_}\015\012", grep defined $hdr{$_}, keys %hdr)
804 . "\015\012" 856 . "\015\012"
805 . (delete $arg{body}) 857 . $arg{body}
806 ); 858 );
807 859
808 # return if error occured during push_write() 860 # return if error occurred during push_write()
809 return unless %state; 861 return unless %state;
810 862
811 # 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.
812 %hdr = (); 864 %hdr = ();
813 865
… …
840 892
841 %hdr = (%$hdr, @pseudo); 893 %hdr = (%$hdr, @pseudo);
842 } 894 }
843 895
844 # redirect handling 896 # redirect handling
845 # microsoft and other shitheads don't give a shit for following standards, 897 # relative uri handling forced by microsoft and other shitheads.
846 # try to support some common forms of broken Location headers. 898 # we give our best and fall back to URI if available.
847 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"
848 $hdr{location} =~ s/^\.\/+//; 909 $loc =~ s/^\.\/+//;
849 910
850 my $url = "$rscheme://$uhost:$uport"; 911 if ($loc !~ m%^[.?#]%) {
912 my $prefix = "$uscheme://$uauthority";
851 913
852 unless ($hdr{location} =~ s/^\///) { 914 unless ($loc =~ s/^\///) {
853 $url .= $upath; 915 $prefix .= $upath;
854 $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 }
855 } 930 }
856 931
857 $hdr{location} = "$url/$hdr{location}"; 932 $hdr{location} = $loc;
858 } 933 }
859 934
860 my $redirect; 935 my $redirect;
861 936
862 if ($recurse) { 937 if ($recurse) {
… …
864 939
865 # industry standard is to redirect POST as GET for 940 # industry standard is to redirect POST as GET for
866 # 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.
867 # 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,
868 # industry standard seems to be to simply follow. 943 # industry standard seems to be to simply follow.
869 # we go with the industry standard. 944 # we go with the industry standard. 308 is defined
945 # by rfc7538
870 if ($status == 301 or $status == 302 or $status == 303) { 946 if ($status == 301 or $status == 302 or $status == 303) {
947 $redirect = 1;
871 # HTTP/1.1 is unclear on how to mutate the method 948 # HTTP/1.1 is unclear on how to mutate the method
872 $method = "GET" unless $method eq "HEAD"; 949 unless ($method eq "HEAD") {
873 $redirect = 1; 950 $method = "GET";
951 delete $arg{body};
952 }
874 } elsif ($status == 307) { 953 } elsif ($status == 307 or $status == 308) {
875 $redirect = 1; 954 $redirect = 1;
876 } 955 }
877 } 956 }
878 957
879 my $finish = sub { # ($data, $err_status, $err_reason[, $persistent]) 958 my $finish = sub { # ($data, $err_status, $err_reason[, $persistent])
… …
955 $finish->(delete $state{handle}); 1034 $finish->(delete $state{handle});
956 1035
957 } elsif ($chunked) { 1036 } elsif ($chunked) {
958 my $cl = 0; 1037 my $cl = 0;
959 my $body = ""; 1038 my $body = "";
960 my $on_body = $arg{on_body} || sub { $body .= shift; 1 }; 1039 my $on_body = (!$redirect && $arg{on_body}) || sub { $body .= shift; 1 };
961 1040
962 $state{read_chunk} = sub { 1041 $state{read_chunk} = sub {
963 $_[1] =~ /^([0-9a-fA-F]+)/ 1042 $_[1] =~ /^([0-9a-fA-F]+)/
964 or $finish->(undef, $ae_error => "Garbled chunked transfer encoding"); 1043 or return $finish->(undef, $ae_error => "Garbled chunked transfer encoding");
965 1044
966 my $len = hex $1; 1045 my $len = hex $1;
967 1046
968 if ($len) { 1047 if ($len) {
969 $cl += $len; 1048 $cl += $len;
… …
998 } 1077 }
999 }; 1078 };
1000 1079
1001 $_[0]->push_read (line => $state{read_chunk}); 1080 $_[0]->push_read (line => $state{read_chunk});
1002 1081
1003 } elsif ($arg{on_body}) { 1082 } elsif (!$redirect && $arg{on_body}) {
1004 if (defined $len) { 1083 if (defined $len) {
1005 $_[0]->on_read (sub { 1084 $_[0]->on_read (sub {
1006 $len -= length $_[0]{rbuf}; 1085 $len -= length $_[0]{rbuf};
1007 1086
1008 $arg{on_body}(delete $_[0]{rbuf}, \%hdr) 1087 $arg{on_body}(delete $_[0]{rbuf}, \%hdr)
… …
1047 _destroy_state %state; 1126 _destroy_state %state;
1048 1127
1049 %state = (); 1128 %state = ();
1050 $state{recurse} = 1129 $state{recurse} =
1051 http_request ( 1130 http_request (
1052 $method => $url, 1131 $method => $url,
1053 %arg, 1132 %arg,
1133 recurse => $recurse - 1,
1054 keepalive => 0, 1134 persistent => 0,
1055 sub { 1135 sub {
1056 %state = (); 1136 %state = ();
1057 &$cb 1137 &$cb
1058 } 1138 }
1059 ); 1139 );
… …
1105 1185
1106 # now handle proxy-CONNECT method 1186 # now handle proxy-CONNECT method
1107 if ($proxy && $uscheme eq "https") { 1187 if ($proxy && $uscheme eq "https") {
1108 # oh dear, we have to wrap it into a connect request 1188 # oh dear, we have to wrap it into a connect request
1109 1189
1190 my $auth = exists $hdr{"proxy-authorization"}
1191 ? "proxy-authorization: " . (delete $hdr{"proxy-authorization"}) . "\015\012"
1192 : "";
1193
1110 # maybe re-use $uauthority with patched port? 1194 # maybe re-use $uauthority with patched port?
1111 $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");
1112 $state{handle}->push_read (line => $qr_nlnl, sub { 1196 $state{handle}->push_read (line => $qr_nlnl, sub {
1113 $_[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
1114 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])" };
1115 1199
1116 if ($2 == 200) { 1200 if ($2 == 200) {
… …
1119 } else { 1203 } else {
1120 _error %state, $cb, { @pseudo, Status => $2, Reason => $3 }; 1204 _error %state, $cb, { @pseudo, Status => $2, Reason => $3 };
1121 } 1205 }
1122 }); 1206 });
1123 } else { 1207 } else {
1208 delete $hdr{"proxy-authorization"} unless $proxy;
1209
1124 $handle_actual_request->(); 1210 $handle_actual_request->();
1125 } 1211 }
1126 }; 1212 };
1127 1213
1128 _get_slot $uhost, sub { 1214 _get_slot $uhost, sub {
… …
1134 # 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).
1135 if ($persistent && $KA_CACHE{$ka_key}) { 1221 if ($persistent && $KA_CACHE{$ka_key}) {
1136 $was_persistent = 1; 1222 $was_persistent = 1;
1137 1223
1138 $state{handle} = ka_fetch $ka_key; 1224 $state{handle} = ka_fetch $ka_key;
1139 $state{handle}->destroyed 1225# $state{handle}->destroyed
1140 and die "got a destructed habndle. pah\n";#d# 1226# and die "AnyEvent::HTTP: unexpectedly got a destructed handle (1), please report.";#d#
1141 $prepare_handle->(); 1227 $prepare_handle->();
1142 $state{handle}->destroyed 1228# $state{handle}->destroyed
1143 and die "got a destructed habndle. pa2\n";#d# 1229# and die "AnyEvent::HTTP: unexpectedly got a destructed handle (2), please report.";#d#
1144 $handle_actual_request->(); 1230 $handle_actual_request->();
1145 $state{handle}->destroyed
1146 and die "got a destructed habndle. pa3\n";#d#
1147 1231
1148 } else { 1232 } else {
1149 my $tcp_connect = $arg{tcp_connect} 1233 my $tcp_connect = $arg{tcp_connect}
1150 || do { require AnyEvent::Socket; \&AnyEvent::Socket::tcp_connect }; 1234 || do { require AnyEvent::Socket; \&AnyEvent::Socket::tcp_connect };
1151 1235
… …
1192Sets 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
1193string of the form C<http://host:port>, croaks otherwise. 1277string of the form C<http://host:port>, croaks otherwise.
1194 1278
1195To clear an already-set proxy, use C<undef>. 1279To clear an already-set proxy, use C<undef>.
1196 1280
1197When 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
1198default proxy from the operating system, currently by looking at 1282default proxy from the operating system, currently by looking at
1199C<$ENV{http_proxy>}. 1283C<$ENV{http_proxy>}.
1200 1284
1201=item AnyEvent::HTTP::cookie_jar_expire $jar[, $session_end] 1285=item AnyEvent::HTTP::cookie_jar_expire $jar[, $session_end]
1202 1286
… …
1204C<$session_end> is given and true, then additionally remove all session 1288C<$session_end> is given and true, then additionally remove all session
1205cookies. 1289cookies.
1206 1290
1207You 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
1208save 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
1209again. 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
1210function from time to time. 1294function from time to time.
1211 1295
1212A 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
1213module. 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:
1214 1298
1215The 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
1216emptied. All other keys are hostnames or IP addresses pointing to 1300cleared. All other keys are hostnames or IP addresses pointing to
1217hash-references. The key for these inner hash references is the 1301hash-references. The key for these inner hash references is the
1218server 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
1219hash-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
1220the 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
1221key-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>,
1222which 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
1223expiry timestamp. 1307expiry timestamp. Session cookies are indicated by not having an
1308C<_expires> key.
1224 1309
1225Here 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
1226chance of understanding the above paragraph: 1311chance of understanding the above paragraph:
1227 1312
1228 { 1313 {
… …
1252 1337
1253The default value for the C<recurse> request parameter (default: C<10>). 1338The default value for the C<recurse> request parameter (default: C<10>).
1254 1339
1255=item $AnyEvent::HTTP::TIMEOUT 1340=item $AnyEvent::HTTP::TIMEOUT
1256 1341
1257The default timeout for conenction operations (default: C<300>). 1342The default timeout for connection operations (default: C<300>).
1258 1343
1259=item $AnyEvent::HTTP::USERAGENT 1344=item $AnyEvent::HTTP::USERAGENT
1260 1345
1261The default value for the C<User-Agent> header (the default is 1346The default value for the C<User-Agent> header (the default is
1262C<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)>).
1263 1348
1264=item $AnyEvent::HTTP::MAX_PER_HOST 1349=item $AnyEvent::HTTP::MAX_PER_HOST
1265 1350
1266The maximum number of concurrent connections to the same host (identified 1351The maximum number of concurrent connections to the same host (identified
1267by the hostname). If the limit is exceeded, then the additional requests 1352by the hostname). If the limit is exceeded, then additional requests
1268are queued until previous connections are closed. Both persistent and 1353are queued until previous connections are closed. Both persistent and
1269non-persistent connections are counted in this limit. 1354non-persistent connections are counted in this limit.
1270 1355
1271The 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
1272increase it much. 1357increase it much.
1273 1358
1274For comparison: the RFC's recommend 4 non-persistent or 2 persistent 1359For comparison: the RFC's recommend 4 non-persistent or 2 persistent
1275connections, older browsers used 2, newers (such as firefox 3) typically 1360connections, older browsers used 2, newer ones (such as firefox 3)
1276use 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
1277give a shit for everybody else on the planet. 1362browser and give a shit for everybody else on the planet.
1278 1363
1279=item $AnyEvent::HTTP::PERSISTENT_TIMEOUT 1364=item $AnyEvent::HTTP::PERSISTENT_TIMEOUT
1280 1365
1281The time after which idle persistent conenctions get closed by 1366The time after which idle persistent connections get closed by
1282AnyEvent::HTTP (default: C<3>). 1367AnyEvent::HTTP (default: C<3>).
1283 1368
1284=item $AnyEvent::HTTP::ACTIVE 1369=item $AnyEvent::HTTP::ACTIVE
1285 1370
1286The number of active connections. This is not the number of currently 1371The number of active connections. This is not the number of currently
… …
1327 # other formats fail in the loop below 1412 # other formats fail in the loop below
1328 1413
1329 for (0..11) { 1414 for (0..11) {
1330 if ($m eq $month[$_]) { 1415 if ($m eq $month[$_]) {
1331 require Time::Local; 1416 require Time::Local;
1332 return Time::Local::timegm ($S, $M, $H, $d, $_, $y); 1417 return eval { Time::Local::timegm ($S, $M, $H, $d, $_, $y) };
1333 } 1418 }
1334 } 1419 }
1335 1420
1336 undef 1421 undef
1337} 1422}
… …
1351 set_proxy $ENV{http_proxy}; 1436 set_proxy $ENV{http_proxy};
1352}; 1437};
1353 1438
1354=head2 SHOWCASE 1439=head2 SHOWCASE
1355 1440
1356This section contaisn some more elaborate "real-world" examples or code 1441This section contains some more elaborate "real-world" examples or code
1357snippets. 1442snippets.
1358 1443
1359=head2 HTTP/1.1 FILE DOWNLOAD 1444=head2 HTTP/1.1 FILE DOWNLOAD
1360 1445
1361Downloading files with HTTP can be quite tricky, especially when something 1446Downloading files with HTTP can be quite tricky, especially when something
… …
1365last 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
1366HTTP/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
1367on older servers. 1452on older servers.
1368 1453
1369It calls the completion callback with either C<undef>, which means a 1454It calls the completion callback with either C<undef>, which means a
1370nonretryable error occured, C<0> when the download was partial and should 1455nonretryable error occurred, C<0> when the download was partial and should
1371be retried, and C<1> if it was successful. 1456be retried, and C<1> if it was successful.
1372 1457
1373 use AnyEvent::HTTP; 1458 use AnyEvent::HTTP;
1374 1459
1375 sub download($$$) { 1460 sub download($$$) {
… …
1379 or die "$file: $!"; 1464 or die "$file: $!";
1380 1465
1381 my %hdr; 1466 my %hdr;
1382 my $ofs = 0; 1467 my $ofs = 0;
1383 1468
1384 warn stat $fh;
1385 warn -s _;
1386 if (stat $fh and -s _) { 1469 if (stat $fh and -s _) {
1387 $ofs = -s _; 1470 $ofs = -s _;
1388 warn "-s is ", $ofs;#d# 1471 warn "-s is ", $ofs;
1389 $hdr{"if-unmodified-since"} = AnyEvent::HTTP::format_date +(stat _)[9]; 1472 $hdr{"if-unmodified-since"} = AnyEvent::HTTP::format_date +(stat _)[9];
1390 $hdr{"range"} = "bytes=$ofs-"; 1473 $hdr{"range"} = "bytes=$ofs-";
1391 } 1474 }
1392 1475
1393 http_get $url, 1476 http_get $url,
… …
1418 my (undef, $hdr) = @_; 1501 my (undef, $hdr) = @_;
1419 1502
1420 my $status = $hdr->{Status}; 1503 my $status = $hdr->{Status};
1421 1504
1422 if (my $time = AnyEvent::HTTP::parse_date $hdr->{"last-modified"}) { 1505 if (my $time = AnyEvent::HTTP::parse_date $hdr->{"last-modified"}) {
1423 utime $fh, $time, $time; 1506 utime $time, $time, $fh;
1424 } 1507 }
1425 1508
1426 if ($status == 200 || $status == 206 || $status == 416) { 1509 if ($status == 200 || $status == 206 || $status == 416) {
1427 # download ok || resume ok || file already fully downloaded 1510 # download ok || resume ok || file already fully downloaded
1428 $cb->(1, $hdr); 1511 $cb->(1, $hdr);

Diff Legend

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