… | |
… | |
46 | use AnyEvent::Util (); |
46 | use AnyEvent::Util (); |
47 | use AnyEvent::Handle (); |
47 | use AnyEvent::Handle (); |
48 | |
48 | |
49 | use base Exporter::; |
49 | use base Exporter::; |
50 | |
50 | |
51 | our $VERSION = '2.15'; |
51 | our $VERSION = 2.2; |
52 | |
52 | |
53 | our @EXPORT = qw(http_get http_post http_head http_request); |
53 | our @EXPORT = qw(http_get http_post http_head http_request); |
54 | |
54 | |
55 | our $USERAGENT = "Mozilla/5.0 (compatible; U; AnyEvent-HTTP/$VERSION; +http://software.schmorp.de/pkg/AnyEvent)"; |
55 | our $USERAGENT = "Mozilla/5.0 (compatible; U; AnyEvent-HTTP/$VERSION; +http://software.schmorp.de/pkg/AnyEvent)"; |
56 | our $MAX_RECURSE = 10; |
56 | our $MAX_RECURSE = 10; |
… | |
… | |
89 | C<http_request> returns a "cancellation guard" - you have to keep the |
89 | C<http_request> returns a "cancellation guard" - you have to keep the |
90 | object at least alive until the callback get called. If the object gets |
90 | object at least alive until the callback get called. If the object gets |
91 | destroyed before the callback is called, the request will be cancelled. |
91 | destroyed before the callback is called, the request will be cancelled. |
92 | |
92 | |
93 | The callback will be called with the response body data as first argument |
93 | The 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 | |
97 | All the headers in that hash are lowercased. In addition to the response |
97 | All the headers in that hash are lowercased. In addition to the response |
98 | headers, the "pseudo-headers" (uppercase to avoid clashing with possible |
98 | headers, the "pseudo-headers" (uppercase to avoid clashing with possible |
99 | response headers) C<HTTPVersion>, C<Status> and C<Reason> contain the |
99 | response headers) C<HTTPVersion>, C<Status> and C<Reason> contain the |
… | |
… | |
157 | =item recurse => $count (default: $MAX_RECURSE) |
157 | =item recurse => $count (default: $MAX_RECURSE) |
158 | |
158 | |
159 | Whether to recurse requests or not, e.g. on redirects, authentication and |
159 | Whether to recurse requests or not, e.g. on redirects, authentication and |
160 | other retries and so on, and how often to do so. |
160 | other retries and so on, and how often to do so. |
161 | |
161 | |
|
|
162 | Only redirects to http and https URLs are supported. While most common |
|
|
163 | redirection forms are handled entirely within this module, some require |
|
|
164 | the use of the optional L<URI> module. If it is required but missing, then |
|
|
165 | the request will fail with an error. |
|
|
166 | |
162 | =item headers => hashref |
167 | =item headers => hashref |
163 | |
168 | |
164 | The request headers to use. Currently, C<http_request> may provide its own |
169 | The request headers to use. Currently, C<http_request> may provide its own |
165 | C<Host:>, C<Content-Length:>, C<Connection:> and C<Cookie:> headers and |
170 | C<Host:>, C<Content-Length:>, C<Connection:> and C<Cookie:> headers and |
166 | will provide defaults at least for C<TE:>, C<Referer:> and C<User-Agent:> |
171 | will provide defaults at least for C<TE:>, C<Referer:> and C<User-Agent:> |
… | |
… | |
242 | context) - only connections using the same unique ID will be reused. |
247 | context) - only connections using the same unique ID will be reused. |
243 | |
248 | |
244 | =item on_prepare => $callback->($fh) |
249 | =item on_prepare => $callback->($fh) |
245 | |
250 | |
246 | In rare cases you need to "tune" the socket before it is used to |
251 | In rare cases you need to "tune" the socket before it is used to |
247 | connect (for exmaple, to bind it on a given IP address). This parameter |
252 | connect (for example, to bind it on a given IP address). This parameter |
248 | overrides the prepare callback passed to C<AnyEvent::Socket::tcp_connect> |
253 | overrides the prepare callback passed to C<AnyEvent::Socket::tcp_connect> |
249 | and behaves exactly the same way (e.g. it has to provide a |
254 | and behaves exactly the same way (e.g. it has to provide a |
250 | timeout). See the description for the C<$prepare_cb> argument of |
255 | timeout). See the description for the C<$prepare_cb> argument of |
251 | C<AnyEvent::Socket::tcp_connect> for details. |
256 | C<AnyEvent::Socket::tcp_connect> for details. |
252 | |
257 | |
… | |
… | |
689 | |
694 | |
690 | $cb->(undef, $hdr); |
695 | $cb->(undef, $hdr); |
691 | () |
696 | () |
692 | } |
697 | } |
693 | |
698 | |
|
|
699 | our %IDEMPOTENT = ( |
|
|
700 | DELETE => 1, |
|
|
701 | GET => 1, |
|
|
702 | HEAD => 1, |
|
|
703 | OPTIONS => 1, |
|
|
704 | PUT => 1, |
|
|
705 | TRACE => 1, |
|
|
706 | |
|
|
707 | ACL => 1, |
|
|
708 | "BASELINE-CONTROL" => 1, |
|
|
709 | BIND => 1, |
|
|
710 | CHECKIN => 1, |
|
|
711 | CHECKOUT => 1, |
|
|
712 | COPY => 1, |
|
|
713 | LABEL => 1, |
|
|
714 | LINK => 1, |
|
|
715 | MERGE => 1, |
|
|
716 | MKACTIVITY => 1, |
|
|
717 | MKCALENDAR => 1, |
|
|
718 | MKCOL => 1, |
|
|
719 | MKREDIRECTREF => 1, |
|
|
720 | MKWORKSPACE => 1, |
|
|
721 | MOVE => 1, |
|
|
722 | ORDERPATCH => 1, |
|
|
723 | PROPFIND => 1, |
|
|
724 | PROPPATCH => 1, |
|
|
725 | REBIND => 1, |
|
|
726 | REPORT => 1, |
|
|
727 | SEARCH => 1, |
|
|
728 | UNBIND => 1, |
|
|
729 | UNCHECKOUT => 1, |
|
|
730 | UNLINK => 1, |
|
|
731 | UNLOCK => 1, |
|
|
732 | UPDATE => 1, |
|
|
733 | UPDATEREDIRECTREF => 1, |
|
|
734 | "VERSION-CONTROL" => 1, |
|
|
735 | ); |
|
|
736 | |
694 | sub http_request($$@) { |
737 | sub http_request($$@) { |
695 | my $cb = pop; |
738 | my $cb = pop; |
696 | my ($method, $url, %arg) = @_; |
739 | my ($method, $url, %arg) = @_; |
697 | |
740 | |
698 | my %hdr; |
741 | my %hdr; |
… | |
… | |
773 | $hdr{"user-agent"} = $USERAGENT unless exists $hdr{"user-agent"}; |
816 | $hdr{"user-agent"} = $USERAGENT unless exists $hdr{"user-agent"}; |
774 | |
817 | |
775 | $hdr{"content-length"} = length $arg{body} |
818 | $hdr{"content-length"} = length $arg{body} |
776 | if length $arg{body} || $method ne "GET"; |
819 | if length $arg{body} || $method ne "GET"; |
777 | |
820 | |
778 | my $idempotent = $method =~ /^(?:GET|HEAD|PUT|DELETE|OPTIONS|TRACE)$/; |
821 | my $idempotent = $IDEMPOTENT{$method}; |
779 | |
822 | |
780 | # default value for keepalive is true iff the request is for an idempotent method |
823 | # default value for keepalive is true iff the request is for an idempotent method |
781 | my $persistent = exists $arg{persistent} ? !!$arg{persistent} : $idempotent; |
824 | my $persistent = exists $arg{persistent} ? !!$arg{persistent} : $idempotent; |
782 | my $keepalive = exists $arg{keepalive} ? !!$arg{keepalive} : !$proxy; |
825 | my $keepalive = exists $arg{keepalive} ? !!$arg{keepalive} : !$proxy; |
783 | my $was_persistent; # true if this is actually a recycled connection |
826 | my $was_persistent; # true if this is actually a recycled connection |
784 | |
827 | |
785 | # the key to use in the keepalive cache |
828 | # the key to use in the keepalive cache |
786 | my $ka_key = "$uscheme\x00$uhost\x00$uport\x00$arg{sessionid}"; |
829 | my $ka_key = "$uscheme\x00$uhost\x00$uport\x00$arg{sessionid}"; |
787 | |
830 | |
788 | $hdr{connection} = ($persistent ? $keepalive ? "keep-alive " : "" : "close ") . "Te"; #1.1 |
831 | $hdr{connection} = ($persistent ? $keepalive ? "keep-alive, " : "" : "close, ") . "Te"; #1.1 |
789 | $hdr{te} = "trailers" unless exists $hdr{te}; #1.1 |
832 | $hdr{te} = "trailers" unless exists $hdr{te}; #1.1 |
790 | |
833 | |
791 | my %state = (connect_guard => 1); |
834 | my %state = (connect_guard => 1); |
792 | |
835 | |
793 | my $ae_error = 595; # connecting |
836 | my $ae_error = 595; # connecting |
… | |
… | |
806 | . (join "", map "\u$_: $hdr{$_}\015\012", grep defined $hdr{$_}, keys %hdr) |
849 | . (join "", map "\u$_: $hdr{$_}\015\012", grep defined $hdr{$_}, keys %hdr) |
807 | . "\015\012" |
850 | . "\015\012" |
808 | . (delete $arg{body}) |
851 | . (delete $arg{body}) |
809 | ); |
852 | ); |
810 | |
853 | |
811 | # return if error occured during push_write() |
854 | # return if error occurred during push_write() |
812 | return unless %state; |
855 | return unless %state; |
813 | |
856 | |
814 | # reduce memory usage, save a kitten, also re-use it for the response headers. |
857 | # reduce memory usage, save a kitten, also re-use it for the response headers. |
815 | %hdr = (); |
858 | %hdr = (); |
816 | |
859 | |
… | |
… | |
843 | |
886 | |
844 | %hdr = (%$hdr, @pseudo); |
887 | %hdr = (%$hdr, @pseudo); |
845 | } |
888 | } |
846 | |
889 | |
847 | # redirect handling |
890 | # redirect handling |
848 | # microsoft and other shitheads don't give a shit for following standards, |
891 | # relative uri handling forced by microsoft and other shitheads. |
849 | # try to support some common forms of broken Location headers. |
892 | # we give our best and fall back to URI if available. |
850 | if ($hdr{location} !~ /^(?: $ | [^:\/?\#]+ : )/x) { |
893 | if (exists $hdr{location}) { |
|
|
894 | my $loc = $hdr{location}; |
|
|
895 | |
|
|
896 | if ($loc =~ m%^//%) { # // |
|
|
897 | $loc = "$rscheme:$loc"; |
|
|
898 | |
|
|
899 | } elsif ($loc eq "") { |
|
|
900 | $loc = $url; |
|
|
901 | |
|
|
902 | } elsif ($loc !~ /^(?: $ | [^:\/?\#]+ : )/x) { # anything "simple" |
851 | $hdr{location} =~ s/^\.\/+//; |
903 | $loc =~ s/^\.\/+//; |
852 | |
904 | |
|
|
905 | if ($loc !~ m%^[.?#]%) { |
853 | my $url = "$rscheme://$uhost:$uport"; |
906 | my $prefix = "$rscheme://$uhost:$uport"; |
854 | |
907 | |
855 | unless ($hdr{location} =~ s/^\///) { |
908 | unless ($loc =~ s/^\///) { |
856 | $url .= $upath; |
909 | $prefix .= $upath; |
857 | $url =~ s/\/[^\/]*$//; |
910 | $prefix =~ s/\/[^\/]*$//; |
|
|
911 | } |
|
|
912 | |
|
|
913 | $loc = "$prefix/$loc"; |
|
|
914 | |
|
|
915 | } elsif (eval { require URI }) { # uri |
|
|
916 | $loc = URI->new_abs ($loc, $url)->as_string; |
|
|
917 | |
|
|
918 | } else { |
|
|
919 | return _error %state, $cb, { @pseudo, Status => 599, Reason => "Cannot parse Location (URI module missing)" }; |
|
|
920 | #$hdr{Status} = 599; |
|
|
921 | #$hdr{Reason} = "Unparsable Redirect (URI module missing)"; |
|
|
922 | #$recurse = 0; |
|
|
923 | } |
858 | } |
924 | } |
859 | |
925 | |
860 | $hdr{location} = "$url/$hdr{location}"; |
926 | $hdr{location} = $loc; |
861 | } |
927 | } |
862 | |
928 | |
863 | my $redirect; |
929 | my $redirect; |
864 | |
930 | |
865 | if ($recurse) { |
931 | if ($recurse) { |
… | |
… | |
867 | |
933 | |
868 | # industry standard is to redirect POST as GET for |
934 | # industry standard is to redirect POST as GET for |
869 | # 301, 302 and 303, in contrast to HTTP/1.0 and 1.1. |
935 | # 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, |
936 | # also, the UA should ask the user for 301 and 307 and POST, |
871 | # industry standard seems to be to simply follow. |
937 | # industry standard seems to be to simply follow. |
872 | # we go with the industry standard. |
938 | # we go with the industry standard. 308 is defined |
|
|
939 | # by rfc7238 |
873 | if ($status == 301 or $status == 302 or $status == 303) { |
940 | if ($status == 301 or $status == 302 or $status == 303) { |
874 | # HTTP/1.1 is unclear on how to mutate the method |
941 | # HTTP/1.1 is unclear on how to mutate the method |
875 | $method = "GET" unless $method eq "HEAD"; |
942 | $method = "GET" unless $method eq "HEAD"; |
876 | $redirect = 1; |
943 | $redirect = 1; |
877 | } elsif ($status == 307) { |
944 | } elsif ($status == 307 or $status == 308) { |
878 | $redirect = 1; |
945 | $redirect = 1; |
879 | } |
946 | } |
880 | } |
947 | } |
881 | |
948 | |
882 | my $finish = sub { # ($data, $err_status, $err_reason[, $persistent]) |
949 | my $finish = sub { # ($data, $err_status, $err_reason[, $persistent]) |
… | |
… | |
1206 | C<$session_end> is given and true, then additionally remove all session |
1273 | C<$session_end> is given and true, then additionally remove all session |
1207 | cookies. |
1274 | cookies. |
1208 | |
1275 | |
1209 | You should call this function (with a true C<$session_end>) before you |
1276 | You should call this function (with a true C<$session_end>) before you |
1210 | save cookies to disk, and you should call this function after loading them |
1277 | save cookies to disk, and you should call this function after loading them |
1211 | again. If you have a long-running program you can additonally call this |
1278 | again. If you have a long-running program you can additionally call this |
1212 | function from time to time. |
1279 | function from time to time. |
1213 | |
1280 | |
1214 | A cookie jar is initially an empty hash-reference that is managed by this |
1281 | A cookie jar is initially an empty hash-reference that is managed by this |
1215 | module. It's format is subject to change, but currently it is like this: |
1282 | module. It's format is subject to change, but currently it is like this: |
1216 | |
1283 | |
… | |
… | |
1273 | |
1340 | |
1274 | The default value for this is C<4>, and it is highly advisable to not |
1341 | The default value for this is C<4>, and it is highly advisable to not |
1275 | increase it much. |
1342 | increase it much. |
1276 | |
1343 | |
1277 | For comparison: the RFC's recommend 4 non-persistent or 2 persistent |
1344 | For comparison: the RFC's recommend 4 non-persistent or 2 persistent |
1278 | connections, older browsers used 2, newers (such as firefox 3) typically |
1345 | connections, older browsers used 2, newer ones (such as firefox 3) |
1279 | use 6, and Opera uses 8 because like, they have the fastest browser and |
1346 | typically use 6, and Opera uses 8 because like, they have the fastest |
1280 | give a shit for everybody else on the planet. |
1347 | browser and give a shit for everybody else on the planet. |
1281 | |
1348 | |
1282 | =item $AnyEvent::HTTP::PERSISTENT_TIMEOUT |
1349 | =item $AnyEvent::HTTP::PERSISTENT_TIMEOUT |
1283 | |
1350 | |
1284 | The time after which idle persistent conenctions get closed by |
1351 | The time after which idle persistent connections get closed by |
1285 | AnyEvent::HTTP (default: C<3>). |
1352 | AnyEvent::HTTP (default: C<3>). |
1286 | |
1353 | |
1287 | =item $AnyEvent::HTTP::ACTIVE |
1354 | =item $AnyEvent::HTTP::ACTIVE |
1288 | |
1355 | |
1289 | The number of active connections. This is not the number of currently |
1356 | The number of active connections. This is not the number of currently |
… | |
… | |
1354 | set_proxy $ENV{http_proxy}; |
1421 | set_proxy $ENV{http_proxy}; |
1355 | }; |
1422 | }; |
1356 | |
1423 | |
1357 | =head2 SHOWCASE |
1424 | =head2 SHOWCASE |
1358 | |
1425 | |
1359 | This section contaisn some more elaborate "real-world" examples or code |
1426 | This section contains some more elaborate "real-world" examples or code |
1360 | snippets. |
1427 | snippets. |
1361 | |
1428 | |
1362 | =head2 HTTP/1.1 FILE DOWNLOAD |
1429 | =head2 HTTP/1.1 FILE DOWNLOAD |
1363 | |
1430 | |
1364 | Downloading files with HTTP can be quite tricky, especially when something |
1431 | Downloading files with HTTP can be quite tricky, especially when something |
… | |
… | |
1368 | last modified time to check for file content changes, and works with many |
1435 | last modified time to check for file content changes, and works with many |
1369 | HTTP/1.0 servers as well, and usually falls back to a complete re-download |
1436 | HTTP/1.0 servers as well, and usually falls back to a complete re-download |
1370 | on older servers. |
1437 | on older servers. |
1371 | |
1438 | |
1372 | It calls the completion callback with either C<undef>, which means a |
1439 | It calls the completion callback with either C<undef>, which means a |
1373 | nonretryable error occured, C<0> when the download was partial and should |
1440 | nonretryable error occurred, C<0> when the download was partial and should |
1374 | be retried, and C<1> if it was successful. |
1441 | be retried, and C<1> if it was successful. |
1375 | |
1442 | |
1376 | use AnyEvent::HTTP; |
1443 | use AnyEvent::HTTP; |
1377 | |
1444 | |
1378 | sub download($$$) { |
1445 | sub download($$$) { |