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.137 by root, Mon Apr 27 12:14:12 2020 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.25;
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.
202
203Note that this module will prefer an existing persistent connection,
204even if that connection was made using another proxy. If you need to
205ensure that a new connection is made in this case, you can either force
206C<persistent> to false or e.g. use the proxy address in your C<sessionid>.
191 207
192=item body => $string 208=item body => $string
193 209
194The request body, usually empty. Will be sent as-is (future versions of 210The request body, usually empty. Will be sent as-is (future versions of
195this module might offer more options). 211this module might offer more options).
… …
228The default for this option is C<low>, which could be interpreted as "give 244The default for this option is C<low>, which could be interpreted as "give
229me the page, no matter what". 245me the page, no matter what".
230 246
231See also the C<sessionid> parameter. 247See also the C<sessionid> parameter.
232 248
233=item session => $string 249=item sessionid => $string
234 250
235The module might reuse connections to the same host internally. Sometimes 251The module might reuse connections to the same host internally (regardless
236(e.g. when using TLS), you do not want to reuse connections from other 252of other settings, such as C<tcp_connect> or C<proxy>). Sometimes (e.g.
253when using TLS or a specfic proxy), you do not want to reuse connections
237sessions. This can be achieved by setting this parameter to some unique 254from other sessions. This can be achieved by setting this parameter to
238ID (such as the address of an object storing your state data, or the TLS 255some unique ID (such as the address of an object storing your state data
239context) - only connections using the same unique ID will be reused. 256or the TLS context, or the proxy IP) - only connections using the same
257unique ID will be reused.
240 258
241=item on_prepare => $callback->($fh) 259=item on_prepare => $callback->($fh)
242 260
243In rare cases you need to "tune" the socket before it is used to 261In 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 262connect (for example, to bind it on a given IP address). This parameter
245overrides the prepare callback passed to C<AnyEvent::Socket::tcp_connect> 263overrides the prepare callback passed to C<AnyEvent::Socket::tcp_connect>
246and behaves exactly the same way (e.g. it has to provide a 264and behaves exactly the same way (e.g. it has to provide a
247timeout). See the description for the C<$prepare_cb> argument of 265timeout). See the description for the C<$prepare_cb> argument of
248C<AnyEvent::Socket::tcp_connect> for details. 266C<AnyEvent::Socket::tcp_connect> for details.
249 267
… …
252In even rarer cases you want total control over how AnyEvent::HTTP 270In even rarer cases you want total control over how AnyEvent::HTTP
253establishes connections. Normally it uses L<AnyEvent::Socket::tcp_connect> 271establishes connections. Normally it uses L<AnyEvent::Socket::tcp_connect>
254to do this, but you can provide your own C<tcp_connect> function - 272to do this, but you can provide your own C<tcp_connect> function -
255obviously, it has to follow the same calling conventions, except that it 273obviously, it has to follow the same calling conventions, except that it
256may always return a connection guard object. 274may always return a connection guard object.
275
276The connections made by this hook will be treated as equivalent to
277connections made the built-in way, specifically, they will be put into
278and taken from the persistent connection cache. If your C<$tcp_connect>
279function is incompatible with this kind of re-use, consider switching off
280C<persistent> connections and/or providing a C<sessionid> identifier.
257 281
258There are probably lots of weird uses for this function, starting from 282There are probably lots of weird uses for this function, starting from
259tracing the hosts C<http_request> actually tries to connect, to (inexact 283tracing the hosts C<http_request> actually tries to connect, to (inexact
260but fast) host => IP address caching or even socks protocol support. 284but fast) host => IP address caching or even socks protocol support.
261 285
… …
331=item persistent => $boolean 355=item persistent => $boolean
332 356
333Try to create/reuse a persistent connection. When this flag is set 357Try to create/reuse a persistent connection. When this flag is set
334(default: true for idempotent requests, false for all others), then 358(default: true for idempotent requests, false for all others), then
335C<http_request> tries to re-use an existing (previously-created) 359C<http_request> tries to re-use an existing (previously-created)
336persistent connection to the host and, failing that, tries to create a new 360persistent connection to same host (i.e. identical URL scheme, hostname,
337one. 361port and sessionid) and, failing that, tries to create a new one.
338 362
339Requests failing in certain ways will be automatically retried once, which 363Requests failing in certain ways will be automatically retried once, which
340is dangerous for non-idempotent requests, which is why it defaults to off 364is dangerous for non-idempotent requests, which is why it defaults to off
341for them. The reason for this is because the bozos who designed HTTP/1.1 365for them. The reason for this is because the bozos who designed HTTP/1.1
342made it impossible to distinguish between a fatal error and a normal 366made it impossible to distinguish between a fatal error and a normal
343connection timeout, so you never know whether there was a problem with 367connection timeout, so you never know whether there was a problem with
344your request or not. 368your request or not.
345 369
346When reusing an existent connection, many parameters (such as TLS context) 370When reusing an existent connection, many parameters (such as TLS context)
347will be ignored. See the C<session> parameter for a workaround. 371will be ignored. See the C<sessionid> parameter for a workaround.
348 372
349=item keepalive => $boolean 373=item keepalive => $boolean
350 374
351Only used when C<persistent> is also true. This parameter decides whether 375Only used when C<persistent> is also true. This parameter decides whether
352C<http_request> tries to handshake a HTTP/1.0-style keep-alive connection 376C<http_request> tries to handshake a HTTP/1.0-style keep-alive connection
… …
381 405
382Example: do a HTTP HEAD request on https://www.google.com/, use a 406Example: do a HTTP HEAD request on https://www.google.com/, use a
383timeout of 30 seconds. 407timeout of 30 seconds.
384 408
385 http_request 409 http_request
386 GET => "https://www.google.com", 410 HEAD => "https://www.google.com",
387 headers => { "user-agent" => "MySearchClient 1.0" }, 411 headers => { "user-agent" => "MySearchClient 1.0" },
388 timeout => 30, 412 timeout => 30,
389 sub { 413 sub {
390 my ($body, $hdr) = @_; 414 my ($body, $hdr) = @_;
391 use Data::Dumper; 415 use Data::Dumper;
… …
443 467
444# expire cookies 468# expire cookies
445sub cookie_jar_expire($;$) { 469sub cookie_jar_expire($;$) {
446 my ($jar, $session_end) = @_; 470 my ($jar, $session_end) = @_;
447 471
448 %$jar = () if $jar->{version} != 1; 472 %$jar = () if $jar->{version} != 2;
449 473
450 my $anow = AE::now; 474 my $anow = AE::now;
451 475
452 while (my ($chost, $paths) = each %$jar) { 476 while (my ($chost, $paths) = each %$jar) {
453 next unless ref $paths; 477 next unless ref $paths;
… …
473 497
474# extract cookies from jar 498# extract cookies from jar
475sub cookie_jar_extract($$$$) { 499sub cookie_jar_extract($$$$) {
476 my ($jar, $scheme, $host, $path) = @_; 500 my ($jar, $scheme, $host, $path) = @_;
477 501
478 %$jar = () if $jar->{version} != 1; 502 %$jar = () if $jar->{version} != 2;
503
504 $host = AnyEvent::Util::idn_to_ascii $host
505 if $host =~ /[^\x00-\x7f]/;
479 506
480 my @cookies; 507 my @cookies;
481 508
482 while (my ($chost, $paths) = each %$jar) { 509 while (my ($chost, $paths) = each %$jar) {
483 next unless ref $paths; 510 next unless ref $paths;
484 511
485 if ($chost =~ /^\./) { 512 # exact match or suffix including . match
486 next unless $chost eq substr $host, -length $chost; 513 $chost eq $host or ".$chost" eq substr $host, -1 - length $chost
487 } elsif ($chost =~ /\./) {
488 next unless $chost eq $host;
489 } else {
490 next; 514 or next;
491 }
492 515
493 while (my ($cpath, $cookies) = each %$paths) { 516 while (my ($cpath, $cookies) = each %$paths) {
494 next unless $cpath eq substr $path, 0, length $cpath; 517 next unless $cpath eq substr $path, 0, length $cpath;
495 518
496 while (my ($cookie, $kv) = each %$cookies) { 519 while (my ($cookie, $kv) = each %$cookies) {
… …
517} 540}
518 541
519# parse set_cookie header into jar 542# parse set_cookie header into jar
520sub cookie_jar_set_cookie($$$$) { 543sub cookie_jar_set_cookie($$$$) {
521 my ($jar, $set_cookie, $host, $date) = @_; 544 my ($jar, $set_cookie, $host, $date) = @_;
545
546 %$jar = () if $jar->{version} != 2;
522 547
523 my $anow = int AE::now; 548 my $anow = int AE::now;
524 my $snow; # server-now 549 my $snow; # server-now
525 550
526 for ($set_cookie) { 551 for ($set_cookie) {
… …
572 597
573 my $cdom; 598 my $cdom;
574 my $cpath = (delete $kv{path}) || "/"; 599 my $cpath = (delete $kv{path}) || "/";
575 600
576 if (exists $kv{domain}) { 601 if (exists $kv{domain}) {
577 $cdom = delete $kv{domain}; 602 $cdom = $kv{domain};
578 603
579 $cdom =~ s/^\.?/./; # make sure it starts with a "." 604 $cdom =~ s/^\.?/./; # make sure it starts with a "."
580 605
581 next if $cdom =~ /\.$/; 606 next if $cdom =~ /\.$/;
582 607
583 # this is not rfc-like and not netscape-like. go figure. 608 # this is not rfc-like and not netscape-like. go figure.
584 my $ndots = $cdom =~ y/.//; 609 my $ndots = $cdom =~ y/.//;
585 next if $ndots < ($cdom =~ /\.[^.][^.]\.[^.][^.]$/ ? 3 : 2); 610 next if $ndots < ($cdom =~ /\.[^.][^.]\.[^.][^.]$/ ? 3 : 2);
611
612 $cdom = substr $cdom, 1; # remove initial .
586 } else { 613 } else {
587 $cdom = $host; 614 $cdom = $host;
588 } 615 }
589 616
590 # store it 617 # store it
591 $jar->{version} = 1; 618 $jar->{version} = 2;
592 $jar->{lc $cdom}{$cpath}{$name} = \%kv; 619 $jar->{lc $cdom}{$cpath}{$name} = \%kv;
593 620
594 redo if /\G\s*,/gc; 621 redo if /\G\s*,/gc;
595 } 622 }
596} 623}
… …
686 713
687 $cb->(undef, $hdr); 714 $cb->(undef, $hdr);
688 () 715 ()
689} 716}
690 717
718our %IDEMPOTENT = (
719 DELETE => 1,
720 GET => 1,
721 HEAD => 1,
722 OPTIONS => 1,
723 PUT => 1,
724 TRACE => 1,
725
726 ACL => 1,
727 "BASELINE-CONTROL" => 1,
728 BIND => 1,
729 CHECKIN => 1,
730 CHECKOUT => 1,
731 COPY => 1,
732 LABEL => 1,
733 LINK => 1,
734 MERGE => 1,
735 MKACTIVITY => 1,
736 MKCALENDAR => 1,
737 MKCOL => 1,
738 MKREDIRECTREF => 1,
739 MKWORKSPACE => 1,
740 MOVE => 1,
741 ORDERPATCH => 1,
742 PROPFIND => 1,
743 PROPPATCH => 1,
744 REBIND => 1,
745 REPORT => 1,
746 SEARCH => 1,
747 UNBIND => 1,
748 UNCHECKOUT => 1,
749 UNLINK => 1,
750 UNLOCK => 1,
751 UPDATE => 1,
752 UPDATEREDIRECTREF => 1,
753 "VERSION-CONTROL" => 1,
754);
755
691sub http_request($$@) { 756sub http_request($$@) {
692 my $cb = pop; 757 my $cb = pop;
693 my ($method, $url, %arg) = @_; 758 my ($method, $url, %arg) = @_;
694 759
695 my %hdr; 760 my %hdr;
… …
724 789
725 my $uport = $uscheme eq "http" ? 80 790 my $uport = $uscheme eq "http" ? 80
726 : $uscheme eq "https" ? 443 791 : $uscheme eq "https" ? 443
727 : return $cb->(undef, { @pseudo, Status => 599, Reason => "Only http and https URL schemes supported" }); 792 : return $cb->(undef, { @pseudo, Status => 599, Reason => "Only http and https URL schemes supported" });
728 793
729 $uauthority =~ /^(?: .*\@ )? ([^\@:]+) (?: : (\d+) )?$/x 794 $uauthority =~ /^(?: .*\@ )? ([^\@]+?) (?: : (\d+) )?$/x
730 or return $cb->(undef, { @pseudo, Status => 599, Reason => "Unparsable URL" }); 795 or return $cb->(undef, { @pseudo, Status => 599, Reason => "Unparsable URL" });
731 796
732 my $uhost = lc $1; 797 my $uhost = lc $1;
733 $uport = $2 if defined $2; 798 $uport = $2 if defined $2;
734 799
… …
770 $hdr{"user-agent"} = $USERAGENT unless exists $hdr{"user-agent"}; 835 $hdr{"user-agent"} = $USERAGENT unless exists $hdr{"user-agent"};
771 836
772 $hdr{"content-length"} = length $arg{body} 837 $hdr{"content-length"} = length $arg{body}
773 if length $arg{body} || $method ne "GET"; 838 if length $arg{body} || $method ne "GET";
774 839
775 my $idempotent = $method =~ /^(?:GET|HEAD|PUT|DELETE|OPTIONS|TRACE)$/; 840 my $idempotent = $IDEMPOTENT{$method};
776 841
777 # default value for keepalive is true iff the request is for an idempotent method 842 # default value for keepalive is true iff the request is for an idempotent method
778 my $persistent = exists $arg{persistent} ? !!$arg{persistent} : $idempotent; 843 my $persistent = exists $arg{persistent} ? !!$arg{persistent} : $idempotent;
779 my $keepalive = exists $arg{keepalive} ? !!$arg{keepalive} : !$proxy; 844 my $keepalive = exists $arg{keepalive} ? !!$arg{keepalive} : !$proxy;
780 my $was_persistent; # true if this is actually a recycled connection 845 my $was_persistent; # true if this is actually a recycled connection
781 846
782 # the key to use in the keepalive cache 847 # the key to use in the keepalive cache
783 my $ka_key = "$uhost\x00$arg{sessionid}"; 848 my $ka_key = "$uscheme\x00$uhost\x00$uport\x00$arg{sessionid}";
784 849
785 $hdr{connection} = ($persistent ? $keepalive ? "keep-alive " : "" : "close ") . "Te"; #1.1 850 $hdr{connection} = ($persistent ? $keepalive ? "keep-alive, " : "" : "close, ") . "Te"; #1.1
786 $hdr{te} = "trailers" unless exists $hdr{te}; #1.1 851 $hdr{te} = "trailers" unless exists $hdr{te}; #1.1
787 852
788 my %state = (connect_guard => 1); 853 my %state = (connect_guard => 1);
789 854
790 my $ae_error = 595; # connecting 855 my $ae_error = 595; # connecting
… …
800 # send request 865 # send request
801 $hdl->push_write ( 866 $hdl->push_write (
802 "$method $rpath HTTP/1.1\015\012" 867 "$method $rpath HTTP/1.1\015\012"
803 . (join "", map "\u$_: $hdr{$_}\015\012", grep defined $hdr{$_}, keys %hdr) 868 . (join "", map "\u$_: $hdr{$_}\015\012", grep defined $hdr{$_}, keys %hdr)
804 . "\015\012" 869 . "\015\012"
805 . (delete $arg{body}) 870 . $arg{body}
806 ); 871 );
807 872
808 # return if error occured during push_write() 873 # return if error occurred during push_write()
809 return unless %state; 874 return unless %state;
810 875
811 # reduce memory usage, save a kitten, also re-use it for the response headers. 876 # reduce memory usage, save a kitten, also re-use it for the response headers.
812 %hdr = (); 877 %hdr = ();
813 878
… …
840 905
841 %hdr = (%$hdr, @pseudo); 906 %hdr = (%$hdr, @pseudo);
842 } 907 }
843 908
844 # redirect handling 909 # redirect handling
845 # microsoft and other shitheads don't give a shit for following standards, 910 # relative uri handling forced by microsoft and other shitheads.
846 # try to support some common forms of broken Location headers. 911 # we give our best and fall back to URI if available.
847 if ($hdr{location} !~ /^(?: $ | [^:\/?\#]+ : )/x) { 912 if (exists $hdr{location}) {
913 my $loc = $hdr{location};
914
915 if ($loc =~ m%^//%) { # //
916 $loc = "$uscheme:$loc";
917
918 } elsif ($loc eq "") {
919 $loc = $url;
920
921 } elsif ($loc !~ /^(?: $ | [^:\/?\#]+ : )/x) { # anything "simple"
848 $hdr{location} =~ s/^\.\/+//; 922 $loc =~ s/^\.\/+//;
849 923
850 my $url = "$rscheme://$uhost:$uport"; 924 if ($loc !~ m%^[.?#]%) {
925 my $prefix = "$uscheme://$uauthority";
851 926
852 unless ($hdr{location} =~ s/^\///) { 927 unless ($loc =~ s/^\///) {
853 $url .= $upath; 928 $prefix .= $upath;
854 $url =~ s/\/[^\/]*$//; 929 $prefix =~ s/\/[^\/]*$//;
930 }
931
932 $loc = "$prefix/$loc";
933
934 } elsif (eval { require URI }) { # uri
935 $loc = URI->new_abs ($loc, $url)->as_string;
936
937 } else {
938 return _error %state, $cb, { @pseudo, Status => 599, Reason => "Cannot parse Location (URI module missing)" };
939 #$hdr{Status} = 599;
940 #$hdr{Reason} = "Unparsable Redirect (URI module missing)";
941 #$recurse = 0;
942 }
855 } 943 }
856 944
857 $hdr{location} = "$url/$hdr{location}"; 945 $hdr{location} = $loc;
858 } 946 }
859 947
860 my $redirect; 948 my $redirect;
861 949
862 if ($recurse) { 950 if ($recurse) {
… …
864 952
865 # industry standard is to redirect POST as GET for 953 # industry standard is to redirect POST as GET for
866 # 301, 302 and 303, in contrast to HTTP/1.0 and 1.1. 954 # 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, 955 # also, the UA should ask the user for 301 and 307 and POST,
868 # industry standard seems to be to simply follow. 956 # industry standard seems to be to simply follow.
869 # we go with the industry standard. 957 # we go with the industry standard. 308 is defined
958 # by rfc7538
870 if ($status == 301 or $status == 302 or $status == 303) { 959 if ($status == 301 or $status == 302 or $status == 303) {
960 $redirect = 1;
871 # HTTP/1.1 is unclear on how to mutate the method 961 # HTTP/1.1 is unclear on how to mutate the method
872 $method = "GET" unless $method eq "HEAD"; 962 unless ($method eq "HEAD") {
873 $redirect = 1; 963 $method = "GET";
964 delete $arg{body};
965 }
874 } elsif ($status == 307) { 966 } elsif ($status == 307 or $status == 308) {
875 $redirect = 1; 967 $redirect = 1;
876 } 968 }
877 } 969 }
878 970
879 my $finish = sub { # ($data, $err_status, $err_reason[, $persistent]) 971 my $finish = sub { # ($data, $err_status, $err_reason[, $persistent])
… …
955 $finish->(delete $state{handle}); 1047 $finish->(delete $state{handle});
956 1048
957 } elsif ($chunked) { 1049 } elsif ($chunked) {
958 my $cl = 0; 1050 my $cl = 0;
959 my $body = ""; 1051 my $body = "";
960 my $on_body = $arg{on_body} || sub { $body .= shift; 1 }; 1052 my $on_body = (!$redirect && $arg{on_body}) || sub { $body .= shift; 1 };
961 1053
962 $state{read_chunk} = sub { 1054 $state{read_chunk} = sub {
963 $_[1] =~ /^([0-9a-fA-F]+)/ 1055 $_[1] =~ /^([0-9a-fA-F]+)/
964 or $finish->(undef, $ae_error => "Garbled chunked transfer encoding"); 1056 or return $finish->(undef, $ae_error => "Garbled chunked transfer encoding");
965 1057
966 my $len = hex $1; 1058 my $len = hex $1;
967 1059
968 if ($len) { 1060 if ($len) {
969 $cl += $len; 1061 $cl += $len;
… …
998 } 1090 }
999 }; 1091 };
1000 1092
1001 $_[0]->push_read (line => $state{read_chunk}); 1093 $_[0]->push_read (line => $state{read_chunk});
1002 1094
1003 } elsif ($arg{on_body}) { 1095 } elsif (!$redirect && $arg{on_body}) {
1004 if (defined $len) { 1096 if (defined $len) {
1005 $_[0]->on_read (sub { 1097 $_[0]->on_read (sub {
1006 $len -= length $_[0]{rbuf}; 1098 $len -= length $_[0]{rbuf};
1007 1099
1008 $arg{on_body}(delete $_[0]{rbuf}, \%hdr) 1100 $arg{on_body}(delete $_[0]{rbuf}, \%hdr)
… …
1047 _destroy_state %state; 1139 _destroy_state %state;
1048 1140
1049 %state = (); 1141 %state = ();
1050 $state{recurse} = 1142 $state{recurse} =
1051 http_request ( 1143 http_request (
1052 $method => $url, 1144 $method => $url,
1053 %arg, 1145 %arg,
1146 recurse => $recurse - 1,
1054 keepalive => 0, 1147 persistent => 0,
1055 sub { 1148 sub {
1056 %state = (); 1149 %state = ();
1057 &$cb 1150 &$cb
1058 } 1151 }
1059 ); 1152 );
… …
1105 1198
1106 # now handle proxy-CONNECT method 1199 # now handle proxy-CONNECT method
1107 if ($proxy && $uscheme eq "https") { 1200 if ($proxy && $uscheme eq "https") {
1108 # oh dear, we have to wrap it into a connect request 1201 # oh dear, we have to wrap it into a connect request
1109 1202
1203 my $auth = exists $hdr{"proxy-authorization"}
1204 ? "proxy-authorization: " . (delete $hdr{"proxy-authorization"}) . "\015\012"
1205 : "";
1206
1110 # maybe re-use $uauthority with patched port? 1207 # maybe re-use $uauthority with patched port?
1111 $state{handle}->push_write ("CONNECT $uhost:$uport HTTP/1.0\015\012\015\012"); 1208 $state{handle}->push_write ("CONNECT $uhost:$uport HTTP/1.0\015\012$auth\015\012");
1112 $state{handle}->push_read (line => $qr_nlnl, sub { 1209 $state{handle}->push_read (line => $qr_nlnl, sub {
1113 $_[1] =~ /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\015\012]*) )?/ix 1210 $_[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])" }; 1211 or return _error %state, $cb, { @pseudo, Status => 599, Reason => "Invalid proxy connect response ($_[1])" };
1115 1212
1116 if ($2 == 200) { 1213 if ($2 == 200) {
… …
1119 } else { 1216 } else {
1120 _error %state, $cb, { @pseudo, Status => $2, Reason => $3 }; 1217 _error %state, $cb, { @pseudo, Status => $2, Reason => $3 };
1121 } 1218 }
1122 }); 1219 });
1123 } else { 1220 } else {
1221 delete $hdr{"proxy-authorization"} unless $proxy;
1222
1124 $handle_actual_request->(); 1223 $handle_actual_request->();
1125 } 1224 }
1126 }; 1225 };
1127 1226
1128 _get_slot $uhost, sub { 1227 _get_slot $uhost, sub {
… …
1134 # on a keepalive request (in theory, this should be a separate config option). 1233 # on a keepalive request (in theory, this should be a separate config option).
1135 if ($persistent && $KA_CACHE{$ka_key}) { 1234 if ($persistent && $KA_CACHE{$ka_key}) {
1136 $was_persistent = 1; 1235 $was_persistent = 1;
1137 1236
1138 $state{handle} = ka_fetch $ka_key; 1237 $state{handle} = ka_fetch $ka_key;
1139 $state{handle}->destroyed 1238# $state{handle}->destroyed
1140 and die "got a destructed habndle. pah\n";#d# 1239# and die "AnyEvent::HTTP: unexpectedly got a destructed handle (1), please report.";#d#
1141 $prepare_handle->(); 1240 $prepare_handle->();
1142 $state{handle}->destroyed 1241# $state{handle}->destroyed
1143 and die "got a destructed habndle. pa2\n";#d# 1242# and die "AnyEvent::HTTP: unexpectedly got a destructed handle (2), please report.";#d#
1243 $rpath = $upath;
1144 $handle_actual_request->(); 1244 $handle_actual_request->();
1145 $state{handle}->destroyed
1146 and die "got a destructed habndle. pa3\n";#d#
1147 1245
1148 } else { 1246 } else {
1149 my $tcp_connect = $arg{tcp_connect} 1247 my $tcp_connect = $arg{tcp_connect}
1150 || do { require AnyEvent::Socket; \&AnyEvent::Socket::tcp_connect }; 1248 || do { require AnyEvent::Socket; \&AnyEvent::Socket::tcp_connect };
1151 1249
… …
1192Sets the default proxy server to use. The proxy-url must begin with a 1290Sets the default proxy server to use. The proxy-url must begin with a
1193string of the form C<http://host:port>, croaks otherwise. 1291string of the form C<http://host:port>, croaks otherwise.
1194 1292
1195To clear an already-set proxy, use C<undef>. 1293To clear an already-set proxy, use C<undef>.
1196 1294
1197When AnyEvent::HTTP is laoded for the first time it will query the 1295When AnyEvent::HTTP is loaded for the first time it will query the
1198default proxy from the operating system, currently by looking at 1296default proxy from the operating system, currently by looking at
1199C<$ENV{http_proxy>}. 1297C<$ENV{http_proxy>}.
1200 1298
1201=item AnyEvent::HTTP::cookie_jar_expire $jar[, $session_end] 1299=item AnyEvent::HTTP::cookie_jar_expire $jar[, $session_end]
1202 1300
… …
1204C<$session_end> is given and true, then additionally remove all session 1302C<$session_end> is given and true, then additionally remove all session
1205cookies. 1303cookies.
1206 1304
1207You should call this function (with a true C<$session_end>) before you 1305You 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 1306save 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 1307again. If you have a long-running program you can additionally call this
1210function from time to time. 1308function from time to time.
1211 1309
1212A cookie jar is initially an empty hash-reference that is managed by this 1310A 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: 1311module. Its format is subject to change, but currently it is as follows:
1214 1312
1215The key C<version> has to contain C<1>, otherwise the hash gets 1313The key C<version> has to contain C<2>, otherwise the hash gets
1216emptied. All other keys are hostnames or IP addresses pointing to 1314cleared. All other keys are hostnames or IP addresses pointing to
1217hash-references. The key for these inner hash references is the 1315hash-references. The key for these inner hash references is the
1218server path for which this cookie is meant, and the values are again 1316server 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 1317hash-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 1318the 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>, 1319key-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 1320which have been replaced by a C<_expires> key that contains the cookie
1223expiry timestamp. 1321expiry timestamp. Session cookies are indicated by not having an
1322C<_expires> key.
1224 1323
1225Here is an example of a cookie jar with a single cookie, so you have a 1324Here is an example of a cookie jar with a single cookie, so you have a
1226chance of understanding the above paragraph: 1325chance of understanding the above paragraph:
1227 1326
1228 { 1327 {
1229 version => 1, 1328 version => 2,
1230 "10.0.0.1" => { 1329 "10.0.0.1" => {
1231 "/" => { 1330 "/" => {
1232 "mythweb_id" => { 1331 "mythweb_id" => {
1233 _expires => 1293917923, 1332 _expires => 1293917923,
1234 value => "ooRung9dThee3ooyXooM1Ohm", 1333 value => "ooRung9dThee3ooyXooM1Ohm",
… …
1252 1351
1253The default value for the C<recurse> request parameter (default: C<10>). 1352The default value for the C<recurse> request parameter (default: C<10>).
1254 1353
1255=item $AnyEvent::HTTP::TIMEOUT 1354=item $AnyEvent::HTTP::TIMEOUT
1256 1355
1257The default timeout for conenction operations (default: C<300>). 1356The default timeout for connection operations (default: C<300>).
1258 1357
1259=item $AnyEvent::HTTP::USERAGENT 1358=item $AnyEvent::HTTP::USERAGENT
1260 1359
1261The default value for the C<User-Agent> header (the default is 1360The 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)>). 1361C<Mozilla/5.0 (compatible; U; AnyEvent-HTTP/$VERSION; +http://software.schmorp.de/pkg/AnyEvent)>).
1263 1362
1264=item $AnyEvent::HTTP::MAX_PER_HOST 1363=item $AnyEvent::HTTP::MAX_PER_HOST
1265 1364
1266The maximum number of concurrent connections to the same host (identified 1365The maximum number of concurrent connections to the same host (identified
1267by the hostname). If the limit is exceeded, then the additional requests 1366by the hostname). If the limit is exceeded, then additional requests
1268are queued until previous connections are closed. Both persistent and 1367are queued until previous connections are closed. Both persistent and
1269non-persistent connections are counted in this limit. 1368non-persistent connections are counted in this limit.
1270 1369
1271The default value for this is C<4>, and it is highly advisable to not 1370The default value for this is C<4>, and it is highly advisable to not
1272increase it much. 1371increase it much.
1273 1372
1274For comparison: the RFC's recommend 4 non-persistent or 2 persistent 1373For comparison: the RFC's recommend 4 non-persistent or 2 persistent
1275connections, older browsers used 2, newers (such as firefox 3) typically 1374connections, older browsers used 2, newer ones (such as firefox 3)
1276use 6, and Opera uses 8 because like, they have the fastest browser and 1375typically use 6, and Opera uses 8 because like, they have the fastest
1277give a shit for everybody else on the planet. 1376browser and give a shit for everybody else on the planet.
1278 1377
1279=item $AnyEvent::HTTP::PERSISTENT_TIMEOUT 1378=item $AnyEvent::HTTP::PERSISTENT_TIMEOUT
1280 1379
1281The time after which idle persistent conenctions get closed by 1380The time after which idle persistent connections get closed by
1282AnyEvent::HTTP (default: C<3>). 1381AnyEvent::HTTP (default: C<3>).
1283 1382
1284=item $AnyEvent::HTTP::ACTIVE 1383=item $AnyEvent::HTTP::ACTIVE
1285 1384
1286The number of active connections. This is not the number of currently 1385The number of active connections. This is not the number of currently
… …
1327 # other formats fail in the loop below 1426 # other formats fail in the loop below
1328 1427
1329 for (0..11) { 1428 for (0..11) {
1330 if ($m eq $month[$_]) { 1429 if ($m eq $month[$_]) {
1331 require Time::Local; 1430 require Time::Local;
1332 return Time::Local::timegm ($S, $M, $H, $d, $_, $y); 1431 return eval { Time::Local::timegm ($S, $M, $H, $d, $_, $y) };
1333 } 1432 }
1334 } 1433 }
1335 1434
1336 undef 1435 undef
1337} 1436}
… …
1351 set_proxy $ENV{http_proxy}; 1450 set_proxy $ENV{http_proxy};
1352}; 1451};
1353 1452
1354=head2 SHOWCASE 1453=head2 SHOWCASE
1355 1454
1356This section contaisn some more elaborate "real-world" examples or code 1455This section contains some more elaborate "real-world" examples or code
1357snippets. 1456snippets.
1358 1457
1359=head2 HTTP/1.1 FILE DOWNLOAD 1458=head2 HTTP/1.1 FILE DOWNLOAD
1360 1459
1361Downloading files with HTTP can be quite tricky, especially when something 1460Downloading files with HTTP can be quite tricky, especially when something
… …
1365last modified time to check for file content changes, and works with many 1464last 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 1465HTTP/1.0 servers as well, and usually falls back to a complete re-download
1367on older servers. 1466on older servers.
1368 1467
1369It calls the completion callback with either C<undef>, which means a 1468It calls the completion callback with either C<undef>, which means a
1370nonretryable error occured, C<0> when the download was partial and should 1469nonretryable error occurred, C<0> when the download was partial and should
1371be retried, and C<1> if it was successful. 1470be retried, and C<1> if it was successful.
1372 1471
1373 use AnyEvent::HTTP; 1472 use AnyEvent::HTTP;
1374 1473
1375 sub download($$$) { 1474 sub download($$$) {
… …
1379 or die "$file: $!"; 1478 or die "$file: $!";
1380 1479
1381 my %hdr; 1480 my %hdr;
1382 my $ofs = 0; 1481 my $ofs = 0;
1383 1482
1384 warn stat $fh;
1385 warn -s _;
1386 if (stat $fh and -s _) { 1483 if (stat $fh and -s _) {
1387 $ofs = -s _; 1484 $ofs = -s _;
1388 warn "-s is ", $ofs;#d# 1485 warn "-s is ", $ofs;
1389 $hdr{"if-unmodified-since"} = AnyEvent::HTTP::format_date +(stat _)[9]; 1486 $hdr{"if-unmodified-since"} = AnyEvent::HTTP::format_date +(stat _)[9];
1390 $hdr{"range"} = "bytes=$ofs-"; 1487 $hdr{"range"} = "bytes=$ofs-";
1391 } 1488 }
1392 1489
1393 http_get $url, 1490 http_get $url,
… …
1418 my (undef, $hdr) = @_; 1515 my (undef, $hdr) = @_;
1419 1516
1420 my $status = $hdr->{Status}; 1517 my $status = $hdr->{Status};
1421 1518
1422 if (my $time = AnyEvent::HTTP::parse_date $hdr->{"last-modified"}) { 1519 if (my $time = AnyEvent::HTTP::parse_date $hdr->{"last-modified"}) {
1423 utime $fh, $time, $time; 1520 utime $time, $time, $fh;
1424 } 1521 }
1425 1522
1426 if ($status == 200 || $status == 206 || $status == 416) { 1523 if ($status == 200 || $status == 206 || $status == 416) {
1427 # download ok || resume ok || file already fully downloaded 1524 # download ok || resume ok || file already fully downloaded
1428 $cb->(1, $hdr); 1525 $cb->(1, $hdr);

Diff Legend

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