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.102 by root, Sat Feb 19 06:46:14 2011 UTC vs.
Revision 1.125 by root, Thu May 14 02:04:35 2015 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.04'; 51our $VERSION = 2.22;
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;
… …
686 697
687 $cb->(undef, $hdr); 698 $cb->(undef, $hdr);
688 () 699 ()
689} 700}
690 701
702our %IDEMPOTENT = (
703 DELETE => 1,
704 GET => 1,
705 HEAD => 1,
706 OPTIONS => 1,
707 PUT => 1,
708 TRACE => 1,
709
710 ACL => 1,
711 "BASELINE-CONTROL" => 1,
712 BIND => 1,
713 CHECKIN => 1,
714 CHECKOUT => 1,
715 COPY => 1,
716 LABEL => 1,
717 LINK => 1,
718 MERGE => 1,
719 MKACTIVITY => 1,
720 MKCALENDAR => 1,
721 MKCOL => 1,
722 MKREDIRECTREF => 1,
723 MKWORKSPACE => 1,
724 MOVE => 1,
725 ORDERPATCH => 1,
726 PROPFIND => 1,
727 PROPPATCH => 1,
728 REBIND => 1,
729 REPORT => 1,
730 SEARCH => 1,
731 UNBIND => 1,
732 UNCHECKOUT => 1,
733 UNLINK => 1,
734 UNLOCK => 1,
735 UPDATE => 1,
736 UPDATEREDIRECTREF => 1,
737 "VERSION-CONTROL" => 1,
738);
739
691sub http_request($$@) { 740sub http_request($$@) {
692 my $cb = pop; 741 my $cb = pop;
693 my ($method, $url, %arg) = @_; 742 my ($method, $url, %arg) = @_;
694 743
695 my %hdr; 744 my %hdr;
… …
724 773
725 my $uport = $uscheme eq "http" ? 80 774 my $uport = $uscheme eq "http" ? 80
726 : $uscheme eq "https" ? 443 775 : $uscheme eq "https" ? 443
727 : return $cb->(undef, { @pseudo, Status => 599, Reason => "Only http and https URL schemes supported" }); 776 : return $cb->(undef, { @pseudo, Status => 599, Reason => "Only http and https URL schemes supported" });
728 777
729 $uauthority =~ /^(?: .*\@ )? ([^\@:]+) (?: : (\d+) )?$/x 778 $uauthority =~ /^(?: .*\@ )? ([^\@]+?) (?: : (\d+) )?$/x
730 or return $cb->(undef, { @pseudo, Status => 599, Reason => "Unparsable URL" }); 779 or return $cb->(undef, { @pseudo, Status => 599, Reason => "Unparsable URL" });
731 780
732 my $uhost = lc $1; 781 my $uhost = lc $1;
733 $uport = $2 if defined $2; 782 $uport = $2 if defined $2;
734 783
… …
770 $hdr{"user-agent"} = $USERAGENT unless exists $hdr{"user-agent"}; 819 $hdr{"user-agent"} = $USERAGENT unless exists $hdr{"user-agent"};
771 820
772 $hdr{"content-length"} = length $arg{body} 821 $hdr{"content-length"} = length $arg{body}
773 if length $arg{body} || $method ne "GET"; 822 if length $arg{body} || $method ne "GET";
774 823
775 my $idempotent = $method =~ /^(?:GET|HEAD|PUT|DELETE|OPTIONS|TRACE)$/; 824 my $idempotent = $IDEMPOTENT{$method};
776 825
777 # default value for keepalive is true iff the request is for an idempotent method 826 # default value for keepalive is true iff the request is for an idempotent method
778 my $keepalive = exists $arg{keepalive} ? !!$arg{keepalive} : $idempotent; 827 my $persistent = exists $arg{persistent} ? !!$arg{persistent} : $idempotent;
779 my $keepalive10 = exists $arg{keepalive10} ? $arg{keepalive10} : !$proxy; 828 my $keepalive = exists $arg{keepalive} ? !!$arg{keepalive} : !$proxy;
780 my $keptalive; # true if this is actually a recycled connection 829 my $was_persistent; # true if this is actually a recycled connection
781 830
782 # the key to use in the keepalive cache 831 # the key to use in the keepalive cache
783 my $ka_key = "$uhost\x00$arg{sessionid}"; 832 my $ka_key = "$uscheme\x00$uhost\x00$uport\x00$arg{sessionid}";
784 833
785 $hdr{connection} = ($keepalive ? $keepalive10 ? "keep-alive " : "" : "close ") . "Te"; #1.1 834 $hdr{connection} = ($persistent ? $keepalive ? "keep-alive, " : "" : "close, ") . "Te"; #1.1
786 $hdr{te} = "trailers" unless exists $hdr{te}; #1.1 835 $hdr{te} = "trailers" unless exists $hdr{te}; #1.1
787 836
788 my %state = (connect_guard => 1); 837 my %state = (connect_guard => 1);
789 838
790 my $ae_error = 595; # connecting 839 my $ae_error = 595; # connecting
… …
800 # send request 849 # send request
801 $hdl->push_write ( 850 $hdl->push_write (
802 "$method $rpath HTTP/1.1\015\012" 851 "$method $rpath HTTP/1.1\015\012"
803 . (join "", map "\u$_: $hdr{$_}\015\012", grep defined $hdr{$_}, keys %hdr) 852 . (join "", map "\u$_: $hdr{$_}\015\012", grep defined $hdr{$_}, keys %hdr)
804 . "\015\012" 853 . "\015\012"
805 . (delete $arg{body}) 854 . $arg{body}
806 ); 855 );
807 856
808 # return if error occured during push_write() 857 # return if error occurred during push_write()
809 return unless %state; 858 return unless %state;
810 859
811 # reduce memory usage, save a kitten, also re-use it for the response headers. 860 # reduce memory usage, save a kitten, also re-use it for the response headers.
812 %hdr = (); 861 %hdr = ();
813 862
… …
840 889
841 %hdr = (%$hdr, @pseudo); 890 %hdr = (%$hdr, @pseudo);
842 } 891 }
843 892
844 # redirect handling 893 # redirect handling
845 # microsoft and other shitheads don't give a shit for following standards, 894 # relative uri handling forced by microsoft and other shitheads.
846 # try to support some common forms of broken Location headers. 895 # we give our best and fall back to URI if available.
847 if ($hdr{location} !~ /^(?: $ | [^:\/?\#]+ : )/x) { 896 if (exists $hdr{location}) {
897 my $loc = $hdr{location};
898
899 if ($loc =~ m%^//%) { # //
900 $loc = "$rscheme:$loc";
901
902 } elsif ($loc eq "") {
903 $loc = $url;
904
905 } elsif ($loc !~ /^(?: $ | [^:\/?\#]+ : )/x) { # anything "simple"
848 $hdr{location} =~ s/^\.\/+//; 906 $loc =~ s/^\.\/+//;
849 907
908 if ($loc !~ m%^[.?#]%) {
850 my $url = "$rscheme://$uhost:$uport"; 909 my $prefix = "$rscheme://$uhost:$uport";
851 910
852 unless ($hdr{location} =~ s/^\///) { 911 unless ($loc =~ s/^\///) {
853 $url .= $upath; 912 $prefix .= $upath;
854 $url =~ s/\/[^\/]*$//; 913 $prefix =~ s/\/[^\/]*$//;
914 }
915
916 $loc = "$prefix/$loc";
917
918 } elsif (eval { require URI }) { # uri
919 $loc = URI->new_abs ($loc, $url)->as_string;
920
921 } else {
922 return _error %state, $cb, { @pseudo, Status => 599, Reason => "Cannot parse Location (URI module missing)" };
923 #$hdr{Status} = 599;
924 #$hdr{Reason} = "Unparsable Redirect (URI module missing)";
925 #$recurse = 0;
926 }
855 } 927 }
856 928
857 $hdr{location} = "$url/$hdr{location}"; 929 $hdr{location} = $loc;
858 } 930 }
859 931
860 my $redirect; 932 my $redirect;
861 933
862 if ($recurse) { 934 if ($recurse) {
… …
864 936
865 # industry standard is to redirect POST as GET for 937 # industry standard is to redirect POST as GET for
866 # 301, 302 and 303, in contrast to HTTP/1.0 and 1.1. 938 # 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, 939 # also, the UA should ask the user for 301 and 307 and POST,
868 # industry standard seems to be to simply follow. 940 # industry standard seems to be to simply follow.
869 # we go with the industry standard. 941 # we go with the industry standard. 308 is defined
942 # by rfc7538
870 if ($status == 301 or $status == 302 or $status == 303) { 943 if ($status == 301 or $status == 302 or $status == 303) {
944 $redirect = 1;
871 # HTTP/1.1 is unclear on how to mutate the method 945 # HTTP/1.1 is unclear on how to mutate the method
872 $method = "GET" unless $method eq "HEAD"; 946 unless ($method eq "HEAD") {
873 $redirect = 1; 947 $method = "GET";
948 delete $arg{body};
949 }
874 } elsif ($status == 307) { 950 } elsif ($status == 307 or $status == 308) {
875 $redirect = 1; 951 $redirect = 1;
876 } 952 }
877 } 953 }
878 954
879 my $finish = sub { # ($data, $err_status, $err_reason[, $keepalive]) 955 my $finish = sub { # ($data, $err_status, $err_reason[, $persistent])
880 if ($state{handle}) { 956 if ($state{handle}) {
881 # handle keepalive 957 # handle keepalive
882 if ( 958 if (
883 $keepalive 959 $persistent
884 && $_[3] 960 && $_[3]
885 && ($hdr{HTTPVersion} < 1.1 961 && ($hdr{HTTPVersion} < 1.1
886 ? $hdr{connection} =~ /\bkeep-?alive\b/i 962 ? $hdr{connection} =~ /\bkeep-?alive\b/i
887 : $hdr{connection} !~ /\bclose\b/i) 963 : $hdr{connection} !~ /\bclose\b/i)
888 ) { 964 ) {
… …
907 983
908 if ($redirect && exists $hdr{location}) { 984 if ($redirect && exists $hdr{location}) {
909 # we ignore any errors, as it is very common to receive 985 # we ignore any errors, as it is very common to receive
910 # Content-Length != 0 but no actual body 986 # Content-Length != 0 but no actual body
911 # we also access %hdr, as $_[1] might be an erro 987 # we also access %hdr, as $_[1] might be an erro
988 $state{recurse} =
912 http_request ( 989 http_request (
913 $method => $hdr{location}, 990 $method => $hdr{location},
914 %arg, 991 %arg,
915 recurse => $recurse - 1, 992 recurse => $recurse - 1,
916 Redirect => [$_[0], \%hdr], 993 Redirect => [$_[0], \%hdr],
994 sub {
995 %state = ();
917 $cb 996 &$cb
997 },
918 ); 998 );
919 } else { 999 } else {
920 $cb->($_[0], \%hdr); 1000 $cb->($_[0], \%hdr);
921 } 1001 }
922 }; 1002 };
923 1003
… …
955 my $body = ""; 1035 my $body = "";
956 my $on_body = $arg{on_body} || sub { $body .= shift; 1 }; 1036 my $on_body = $arg{on_body} || sub { $body .= shift; 1 };
957 1037
958 $state{read_chunk} = sub { 1038 $state{read_chunk} = sub {
959 $_[1] =~ /^([0-9a-fA-F]+)/ 1039 $_[1] =~ /^([0-9a-fA-F]+)/
960 or $finish->(undef, $ae_error => "Garbled chunked transfer encoding"); 1040 or return $finish->(undef, $ae_error => "Garbled chunked transfer encoding");
961 1041
962 my $len = hex $1; 1042 my $len = hex $1;
963 1043
964 if ($len) { 1044 if ($len) {
965 $cl += $len; 1045 $cl += $len;
… …
1035 } 1115 }
1036 }; 1116 };
1037 1117
1038 # if keepalive is enabled, then the server closing the connection 1118 # if keepalive is enabled, then the server closing the connection
1039 # before a response can happen legally - we retry on idempotent methods. 1119 # before a response can happen legally - we retry on idempotent methods.
1040 if ($keptalive && $idempotent) { 1120 if ($was_persistent && $idempotent) {
1041 my $old_eof = $hdl->{on_eof}; 1121 my $old_eof = $hdl->{on_eof};
1042 $hdl->{on_eof} = sub { 1122 $hdl->{on_eof} = sub {
1043 _destroy_state %state; 1123 _destroy_state %state;
1044 1124
1125 %state = ();
1126 $state{recurse} =
1045 http_request ( 1127 http_request (
1046 $method => $url, 1128 $method => $url,
1047 %arg, 1129 %arg,
1048 keepalive => 0, 1130 recurse => $recurse - 1,
1131 persistent => 0,
1132 sub {
1133 %state = ();
1049 $cb 1134 &$cb
1135 }
1050 ); 1136 );
1051 }; 1137 };
1052 $hdl->on_read (sub { 1138 $hdl->on_read (sub {
1053 return unless %state; 1139 return unless %state;
1054 1140
1055 # as soon as we receive something, a connection close 1141 # as soon as we receive something, a connection close
… …
1063 }; 1149 };
1064 1150
1065 my $prepare_handle = sub { 1151 my $prepare_handle = sub {
1066 my ($hdl) = $state{handle}; 1152 my ($hdl) = $state{handle};
1067 1153
1068 $hdl->timeout ($timeout);
1069 $hdl->on_error (sub { 1154 $hdl->on_error (sub {
1070 _error %state, $cb, { @pseudo, Status => $ae_error, Reason => $_[2] }; 1155 _error %state, $cb, { @pseudo, Status => $ae_error, Reason => $_[2] };
1071 }); 1156 });
1072 $hdl->on_eof (sub { 1157 $hdl->on_eof (sub {
1073 _error %state, $cb, { @pseudo, Status => $ae_error, Reason => "Unexpected end-of-file" }; 1158 _error %state, $cb, { @pseudo, Status => $ae_error, Reason => "Unexpected end-of-file" };
1074 }); 1159 });
1160 $hdl->timeout_reset;
1161 $hdl->timeout ($timeout);
1075 }; 1162 };
1076 1163
1077 # connected to proxy (or origin server) 1164 # connected to proxy (or origin server)
1078 my $connect_cb = sub { 1165 my $connect_cb = sub {
1079 my $fh = shift 1166 my $fh = shift
… …
1095 1182
1096 # now handle proxy-CONNECT method 1183 # now handle proxy-CONNECT method
1097 if ($proxy && $uscheme eq "https") { 1184 if ($proxy && $uscheme eq "https") {
1098 # oh dear, we have to wrap it into a connect request 1185 # oh dear, we have to wrap it into a connect request
1099 1186
1187 my $auth = exists $hdr{"proxy-authorization"}
1188 ? "proxy-authorization: " . (delete $hdr{"proxy-authorization"}) . "\015\012"
1189 : "";
1190
1100 # maybe re-use $uauthority with patched port? 1191 # maybe re-use $uauthority with patched port?
1101 $state{handle}->push_write ("CONNECT $uhost:$uport HTTP/1.0\015\012\015\012"); 1192 $state{handle}->push_write ("CONNECT $uhost:$uport HTTP/1.0\015\012$auth\015\012");
1102 $state{handle}->push_read (line => $qr_nlnl, sub { 1193 $state{handle}->push_read (line => $qr_nlnl, sub {
1103 $_[1] =~ /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\015\012]*) )?/ix 1194 $_[1] =~ /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\015\012]*) )?/ix
1104 or return _error %state, $cb, { @pseudo, Status => 599, Reason => "Invalid proxy connect response ($_[1])" }; 1195 or return _error %state, $cb, { @pseudo, Status => 599, Reason => "Invalid proxy connect response ($_[1])" };
1105 1196
1106 if ($2 == 200) { 1197 if ($2 == 200) {
… …
1109 } else { 1200 } else {
1110 _error %state, $cb, { @pseudo, Status => $2, Reason => $3 }; 1201 _error %state, $cb, { @pseudo, Status => $2, Reason => $3 };
1111 } 1202 }
1112 }); 1203 });
1113 } else { 1204 } else {
1205 delete $hdr{"proxy-authorization"} unless $proxy;
1206
1114 $handle_actual_request->(); 1207 $handle_actual_request->();
1115 } 1208 }
1116 }; 1209 };
1117 1210
1118 _get_slot $uhost, sub { 1211 _get_slot $uhost, sub {
… …
1120 1213
1121 return unless $state{connect_guard}; 1214 return unless $state{connect_guard};
1122 1215
1123 # try to use an existing keepalive connection, but only if we, ourselves, plan 1216 # try to use an existing keepalive connection, but only if we, ourselves, plan
1124 # on a keepalive request (in theory, this should be a separate config option). 1217 # on a keepalive request (in theory, this should be a separate config option).
1125 if ($keepalive && $KA_CACHE{$ka_key}) { 1218 if ($persistent && $KA_CACHE{$ka_key}) {
1126 $keptalive = 1; 1219 $was_persistent = 1;
1220
1127 $state{handle} = ka_fetch $ka_key; 1221 $state{handle} = ka_fetch $ka_key;
1222 $state{handle}->destroyed
1223 and die "AnyEvent::HTTP: unexpectedly got a destructed handle (1), please report.";#d#
1128 $prepare_handle->(); 1224 $prepare_handle->();
1225 $state{handle}->destroyed
1226 and die "AnyEvent::HTTP: unexpectedly got a destructed handle (2), please report.";#d#
1129 $handle_actual_request->(); 1227 $handle_actual_request->();
1130 1228
1131 } else { 1229 } else {
1132 my $tcp_connect = $arg{tcp_connect} 1230 my $tcp_connect = $arg{tcp_connect}
1133 || do { require AnyEvent::Socket; \&AnyEvent::Socket::tcp_connect }; 1231 || do { require AnyEvent::Socket; \&AnyEvent::Socket::tcp_connect };
… …
1175Sets the default proxy server to use. The proxy-url must begin with a 1273Sets the default proxy server to use. The proxy-url must begin with a
1176string of the form C<http://host:port>, croaks otherwise. 1274string of the form C<http://host:port>, croaks otherwise.
1177 1275
1178To clear an already-set proxy, use C<undef>. 1276To clear an already-set proxy, use C<undef>.
1179 1277
1180When AnyEvent::HTTP is laoded for the first time it will query the 1278When AnyEvent::HTTP is loaded for the first time it will query the
1181default proxy from the operating system, currently by looking at 1279default proxy from the operating system, currently by looking at
1182C<$ENV{http_proxy>}. 1280C<$ENV{http_proxy>}.
1183 1281
1184=item AnyEvent::HTTP::cookie_jar_expire $jar[, $session_end] 1282=item AnyEvent::HTTP::cookie_jar_expire $jar[, $session_end]
1185 1283
… …
1187C<$session_end> is given and true, then additionally remove all session 1285C<$session_end> is given and true, then additionally remove all session
1188cookies. 1286cookies.
1189 1287
1190You should call this function (with a true C<$session_end>) before you 1288You should call this function (with a true C<$session_end>) before you
1191save cookies to disk, and you should call this function after loading them 1289save cookies to disk, and you should call this function after loading them
1192again. If you have a long-running program you can additonally call this 1290again. If you have a long-running program you can additionally call this
1193function from time to time. 1291function from time to time.
1194 1292
1195A cookie jar is initially an empty hash-reference that is managed by this 1293A cookie jar is initially an empty hash-reference that is managed by this
1196module. It's format is subject to change, but currently it is like this: 1294module. Its format is subject to change, but currently it is as follows:
1197 1295
1198The key C<version> has to contain C<1>, otherwise the hash gets 1296The key C<version> has to contain C<1>, otherwise the hash gets
1199emptied. All other keys are hostnames or IP addresses pointing to 1297emptied. All other keys are hostnames or IP addresses pointing to
1200hash-references. The key for these inner hash references is the 1298hash-references. The key for these inner hash references is the
1201server path for which this cookie is meant, and the values are again 1299server path for which this cookie is meant, and the values are again
1202hash-references. The keys of those hash-references is the cookie name, and 1300hash-references. Each key of those hash-references is a cookie name, and
1203the value, you guessed it, is another hash-reference, this time with the 1301the value, you guessed it, is another hash-reference, this time with the
1204key-value pairs from the cookie, except for C<expires> and C<max-age>, 1302key-value pairs from the cookie, except for C<expires> and C<max-age>,
1205which have been replaced by a C<_expires> key that contains the cookie 1303which have been replaced by a C<_expires> key that contains the cookie
1206expiry timestamp. 1304expiry timestamp. Session cookies are indicated by not having an
1305C<_expires> key.
1207 1306
1208Here is an example of a cookie jar with a single cookie, so you have a 1307Here is an example of a cookie jar with a single cookie, so you have a
1209chance of understanding the above paragraph: 1308chance of understanding the above paragraph:
1210 1309
1211 { 1310 {
… …
1235 1334
1236The default value for the C<recurse> request parameter (default: C<10>). 1335The default value for the C<recurse> request parameter (default: C<10>).
1237 1336
1238=item $AnyEvent::HTTP::TIMEOUT 1337=item $AnyEvent::HTTP::TIMEOUT
1239 1338
1240The default timeout for conenction operations (default: C<300>). 1339The default timeout for connection operations (default: C<300>).
1241 1340
1242=item $AnyEvent::HTTP::USERAGENT 1341=item $AnyEvent::HTTP::USERAGENT
1243 1342
1244The default value for the C<User-Agent> header (the default is 1343The default value for the C<User-Agent> header (the default is
1245C<Mozilla/5.0 (compatible; U; AnyEvent-HTTP/$VERSION; +http://software.schmorp.de/pkg/AnyEvent)>). 1344C<Mozilla/5.0 (compatible; U; AnyEvent-HTTP/$VERSION; +http://software.schmorp.de/pkg/AnyEvent)>).
1246 1345
1247=item $AnyEvent::HTTP::MAX_PER_HOST 1346=item $AnyEvent::HTTP::MAX_PER_HOST
1248 1347
1249The maximum number of concurrent connections to the same host (identified 1348The maximum number of concurrent connections to the same host (identified
1250by the hostname). If the limit is exceeded, then the additional requests 1349by the hostname). If the limit is exceeded, then additional requests
1251are queued until previous connections are closed. Both persistent and 1350are queued until previous connections are closed. Both persistent and
1252non-persistent connections are counted in this limit. 1351non-persistent connections are counted in this limit.
1253 1352
1254The default value for this is C<4>, and it is highly advisable to not 1353The default value for this is C<4>, and it is highly advisable to not
1255increase it much. 1354increase it much.
1256 1355
1257For comparison: the RFC's recommend 4 non-persistent or 2 persistent 1356For comparison: the RFC's recommend 4 non-persistent or 2 persistent
1258connections, older browsers used 2, newers (such as firefox 3) typically 1357connections, older browsers used 2, newer ones (such as firefox 3)
1259use 6, and Opera uses 8 because like, they have the fastest browser and 1358typically use 6, and Opera uses 8 because like, they have the fastest
1260give a shit for everybody else on the planet. 1359browser and give a shit for everybody else on the planet.
1261 1360
1262=item $AnyEvent::HTTP::PERSISTENT_TIMEOUT 1361=item $AnyEvent::HTTP::PERSISTENT_TIMEOUT
1263 1362
1264The time after which idle persistent conenctions get closed by 1363The time after which idle persistent connections get closed by
1265AnyEvent::HTTP (default: C<3>). 1364AnyEvent::HTTP (default: C<3>).
1266 1365
1267=item $AnyEvent::HTTP::ACTIVE 1366=item $AnyEvent::HTTP::ACTIVE
1268 1367
1269The number of active connections. This is not the number of currently 1368The number of active connections. This is not the number of currently
… …
1310 # other formats fail in the loop below 1409 # other formats fail in the loop below
1311 1410
1312 for (0..11) { 1411 for (0..11) {
1313 if ($m eq $month[$_]) { 1412 if ($m eq $month[$_]) {
1314 require Time::Local; 1413 require Time::Local;
1315 return Time::Local::timegm ($S, $M, $H, $d, $_, $y); 1414 return eval { Time::Local::timegm ($S, $M, $H, $d, $_, $y) };
1316 } 1415 }
1317 } 1416 }
1318 1417
1319 undef 1418 undef
1320} 1419}
… …
1334 set_proxy $ENV{http_proxy}; 1433 set_proxy $ENV{http_proxy};
1335}; 1434};
1336 1435
1337=head2 SHOWCASE 1436=head2 SHOWCASE
1338 1437
1339This section contaisn some more elaborate "real-world" examples or code 1438This section contains some more elaborate "real-world" examples or code
1340snippets. 1439snippets.
1341 1440
1342=head2 HTTP/1.1 FILE DOWNLOAD 1441=head2 HTTP/1.1 FILE DOWNLOAD
1343 1442
1344Downloading files with HTTP can be quite tricky, especially when something 1443Downloading files with HTTP can be quite tricky, especially when something
… …
1348last modified time to check for file content changes, and works with many 1447last modified time to check for file content changes, and works with many
1349HTTP/1.0 servers as well, and usually falls back to a complete re-download 1448HTTP/1.0 servers as well, and usually falls back to a complete re-download
1350on older servers. 1449on older servers.
1351 1450
1352It calls the completion callback with either C<undef>, which means a 1451It calls the completion callback with either C<undef>, which means a
1353nonretryable error occured, C<0> when the download was partial and should 1452nonretryable error occurred, C<0> when the download was partial and should
1354be retried, and C<1> if it was successful. 1453be retried, and C<1> if it was successful.
1355 1454
1356 use AnyEvent::HTTP; 1455 use AnyEvent::HTTP;
1357 1456
1358 sub download($$$) { 1457 sub download($$$) {
… …
1366 1465
1367 warn stat $fh; 1466 warn stat $fh;
1368 warn -s _; 1467 warn -s _;
1369 if (stat $fh and -s _) { 1468 if (stat $fh and -s _) {
1370 $ofs = -s _; 1469 $ofs = -s _;
1371 warn "-s is ", $ofs;#d# 1470 warn "-s is ", $ofs;
1372 $hdr{"if-unmodified-since"} = AnyEvent::HTTP::format_date +(stat _)[9]; 1471 $hdr{"if-unmodified-since"} = AnyEvent::HTTP::format_date +(stat _)[9];
1373 $hdr{"range"} = "bytes=$ofs-"; 1472 $hdr{"range"} = "bytes=$ofs-";
1374 } 1473 }
1375 1474
1376 http_get $url, 1475 http_get $url,

Diff Legend

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