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.66 by root, Fri Dec 31 06:18:30 2010 UTC vs.
Revision 1.84 by root, Sun Jan 2 05:13:27 2011 UTC

… …
94C<http_request> returns a "cancellation guard" - you have to keep the 94C<http_request> returns a "cancellation guard" - you have to keep the
95object at least alive until the callback get called. If the object gets 95object at least alive until the callback get called. If the object gets
96destroyed before the callback is called, the request will be cancelled. 96destroyed before the callback is called, the request will be cancelled.
97 97
98The callback will be called with the response body data as first argument 98The callback will be called with the response body data as first argument
99(or C<undef> if an error occured), and a hash-ref with response headers as 99(or C<undef> if an error occured), and a hash-ref with response headers
100second argument. 100(and trailers) as second argument.
101 101
102All the headers in that hash are lowercased. In addition to the response 102All the headers in that hash are lowercased. In addition to the response
103headers, the "pseudo-headers" (uppercase to avoid clashing with possible 103headers, the "pseudo-headers" (uppercase to avoid clashing with possible
104response headers) C<HTTPVersion>, C<Status> and C<Reason> contain the 104response headers) C<HTTPVersion>, C<Status> and C<Reason> contain the
105three parts of the HTTP Status-Line of the same name. If an error occurs 105three parts of the HTTP Status-Line of the same name. If an error occurs
… …
122 122
123If the server sends a header multiple times, then their contents will be 123If the server sends a header multiple times, then their contents will be
124joined together with a comma (C<,>), as per the HTTP spec. 124joined together with a comma (C<,>), as per the HTTP spec.
125 125
126If an internal error occurs, such as not being able to resolve a hostname, 126If an internal error occurs, such as not being able to resolve a hostname,
127then C<$data> will be C<undef>, C<< $headers->{Status} >> will be C<59x> 127then C<$data> will be C<undef>, C<< $headers->{Status} >> will be
128(usually C<599>) and the C<Reason> pseudo-header will contain an error 128C<590>-C<599> and the C<Reason> pseudo-header will contain an error
129message. 129message. Currently the following status codes are used:
130
131=over 4
132
133=item 595 - errors during connection etsbalishment, proxy handshake.
134
135=item 596 - errors during TLS negotiation, request sending and header processing.
136
137=item 597 - errors during body receiving or processing.
138
139=item 598 - user aborted request via C<on_header> or C<on_body>.
140
141=item 599 - other, usually nonretryable, errors (garbled URL etc.).
142
143=back
130 144
131A typical callback might look like this: 145A typical callback might look like this:
132 146
133 sub { 147 sub {
134 my ($body, $hdr) = @_; 148 my ($body, $hdr) = @_;
… …
150Whether to recurse requests or not, e.g. on redirects, authentication 164Whether to recurse requests or not, e.g. on redirects, authentication
151retries and so on, and how often to do so. 165retries and so on, and how often to do so.
152 166
153=item headers => hashref 167=item headers => hashref
154 168
155The request headers to use. Currently, C<http_request> may provide its 169The request headers to use. Currently, C<http_request> may provide its own
156own C<Host:>, C<Content-Length:>, C<Connection:> and C<Cookie:> headers 170C<Host:>, C<Content-Length:>, C<Connection:> and C<Cookie:> headers and
157and will provide defaults for C<User-Agent:> and C<Referer:> (this can be 171will provide defaults at least for C<TE:>, C<Referer:> and C<User-Agent:>
158suppressed by using C<undef> for these headers in which case they won't be 172(this can be suppressed by using C<undef> for these headers in which case
159sent at all). 173they won't be sent at all).
160 174
161=item timeout => $seconds 175=item timeout => $seconds
162 176
163The time-out to use for various stages - each connect attempt will reset 177The time-out to use for various stages - each connect attempt will reset
164the timeout, as will read or write activity, i.e. this is not an overall 178the timeout, as will read or write activity, i.e. this is not an overall
… …
174C<$scheme> must be either missing, C<http> for HTTP or C<https> for 188C<$scheme> must be either missing, C<http> for HTTP or C<https> for
175HTTPS. 189HTTPS.
176 190
177=item body => $string 191=item body => $string
178 192
179The request body, usually empty. Will be-sent as-is (future versions of 193The request body, usually empty. Will be sent as-is (future versions of
180this module might offer more options). 194this module might offer more options).
181 195
182=item cookie_jar => $hash_ref 196=item cookie_jar => $hash_ref
183 197
184Passing this parameter enables (simplified) cookie-processing, loosely 198Passing this parameter enables (simplified) cookie-processing, loosely
185based on the original netscape specification. 199based on the original netscape specification.
186 200
187The C<$hash_ref> must be an (initially empty) hash reference which will 201The C<$hash_ref> must be an (initially empty) hash reference which
188get updated automatically. It is possible to save the cookie_jar to 202will get updated automatically. It is possible to save the cookie jar
189persistent storage with something like JSON or Storable, but this is not 203to persistent storage with something like JSON or Storable - see the
190recommended, as expiry times are currently being ignored. 204C<AnyEvent::HTTP::cookie_jar_expire> function if you wish to remove
205expired or session-only cookies, and also for documentation on the format
206of the cookie jar.
191 207
192Note that this cookie implementation is not of very high quality, nor 208Note that this cookie implementation is not meant to be complete. If
193meant to be complete. If you want complete cookie management you have to 209you want complete cookie management you have to do that on your
194do that on your own. C<cookie_jar> is meant as a quick fix to get some 210own. C<cookie_jar> is meant as a quick fix to get most cookie-using sites
195cookie-using sites working. Cookies are a privacy disaster, do not use 211working. Cookies are a privacy disaster, do not use them unless required
196them unless required to. 212to.
213
214When cookie processing is enabled, the C<Cookie:> and C<Set-Cookie:>
215headers will be set and handled by this module, otherwise they will be
216left untouched.
197 217
198=item tls_ctx => $scheme | $tls_ctx 218=item tls_ctx => $scheme | $tls_ctx
199 219
200Specifies the AnyEvent::TLS context to be used for https connections. This 220Specifies the AnyEvent::TLS context to be used for https connections. This
201parameter follows the same rules as the C<tls_ctx> parameter to 221parameter follows the same rules as the C<tls_ctx> parameter to
… …
240 260
241This callback is useful, among other things, to quickly reject unwanted 261This callback is useful, among other things, to quickly reject unwanted
242content, which, if it is supposed to be rare, can be faster than first 262content, which, if it is supposed to be rare, can be faster than first
243doing a C<HEAD> request. 263doing a C<HEAD> request.
244 264
265The downside is that cancelling the request makes it impossible to re-use
266the connection. Also, the C<on_header> callback will not receive any
267trailer (headers sent after the response body).
268
245Example: cancel the request unless the content-type is "text/html". 269Example: cancel the request unless the content-type is "text/html".
246 270
247 on_header => sub { 271 on_header => sub {
248 $_[0]{"content-type"} =~ /^text\/html\s*(?:;|$)/ 272 $_[0]{"content-type"} =~ /^text\/html\s*(?:;|$)/
249 }, 273 },
… …
255string instead of the body data. 279string instead of the body data.
256 280
257It has to return either true (in which case AnyEvent::HTTP will continue), 281It has to return either true (in which case AnyEvent::HTTP will continue),
258or false, in which case AnyEvent::HTTP will cancel the download (and call 282or false, in which case AnyEvent::HTTP will cancel the download (and call
259the completion callback with an error code of C<598>). 283the completion callback with an error code of C<598>).
284
285The downside to cancelling the request is that it makes it impossible to
286re-use the connection.
260 287
261This callback is useful when the data is too large to be held in memory 288This callback is useful when the data is too large to be held in memory
262(so the callback writes it to a file) or when only some information should 289(so the callback writes it to a file) or when only some information should
263be extracted, or when the body should be processed incrementally. 290be extracted, or when the body should be processed incrementally.
264 291
… …
290If you think you need this, first have a look at C<on_body>, to see if 317If you think you need this, first have a look at C<on_body>, to see if
291that doesn't solve your problem in a better way. 318that doesn't solve your problem in a better way.
292 319
293=back 320=back
294 321
295Example: make a simple HTTP GET request for http://www.nethype.de/ 322Example: do a simple HTTP GET request for http://www.nethype.de/ and print
323the response body.
296 324
297 http_request GET => "http://www.nethype.de/", sub { 325 http_request GET => "http://www.nethype.de/", sub {
298 my ($body, $hdr) = @_; 326 my ($body, $hdr) = @_;
299 print "$body\n"; 327 print "$body\n";
300 }; 328 };
301 329
302Example: make a HTTP HEAD request on https://www.google.com/, use a 330Example: do a HTTP HEAD request on https://www.google.com/, use a
303timeout of 30 seconds. 331timeout of 30 seconds.
304 332
305 http_request 333 http_request
306 GET => "https://www.google.com", 334 GET => "https://www.google.com",
307 timeout => 30, 335 timeout => 30,
… …
310 use Data::Dumper; 338 use Data::Dumper;
311 print Dumper $hdr; 339 print Dumper $hdr;
312 } 340 }
313 ; 341 ;
314 342
315Example: make another simple HTTP GET request, but immediately try to 343Example: do another simple HTTP GET request, but immediately try to
316cancel it. 344cancel it.
317 345
318 my $request = http_request GET => "http://www.nethype.de/", sub { 346 my $request = http_request GET => "http://www.nethype.de/", sub {
319 my ($body, $hdr) = @_; 347 my ($body, $hdr) = @_;
320 print "$body\n"; 348 print "$body\n";
… …
352 push @{ $CO_SLOT{$_[0]}[1] }, $_[1]; 380 push @{ $CO_SLOT{$_[0]}[1] }, $_[1];
353 381
354 _slot_schedule $_[0]; 382 _slot_schedule $_[0];
355} 383}
356 384
385#############################################################################
386
387# expire cookies
388sub cookie_jar_expire($;$) {
389 my ($jar, $session_end) = @_;
390
391 %$jar = () if $jar->{version} != 1;
392
393 my $anow = AE::now;
394
395 while (my ($chost, $paths) = each %$jar) {
396 next unless ref $paths;
397
398 while (my ($cpath, $cookies) = each %$paths) {
399 while (my ($cookie, $kv) = each %$cookies) {
400 if (exists $kv->{_expires}) {
401 delete $cookies->{$cookie}
402 if $anow > $kv->{_expires};
403 } elsif ($session_end) {
404 delete $cookies->{$cookie};
405 }
406 }
407
408 delete $paths->{$cpath}
409 unless %$cookies;
410 }
411
412 delete $jar->{$chost}
413 unless %$paths;
414 }
415}
416
417# extract cookies from jar
418sub cookie_jar_extract($$$$) {
419 my ($jar, $uscheme, $uhost, $upath) = @_;
420
421 $uhost = lc $uhost;
422
423 %$jar = () if $jar->{version} != 1;
424
425 my @cookies;
426
427 while (my ($chost, $paths) = each %$jar) {
428 next unless ref $paths;
429
430 if ($chost =~ /^\./) {
431 next unless $chost eq substr $uhost, -length $chost;
432 } elsif ($chost =~ /\./) {
433 next unless $chost eq $uhost;
434 } else {
435 next;
436 }
437
438 while (my ($cpath, $cookies) = each %$paths) {
439 next unless $cpath eq substr $upath, 0, length $cpath;
440
441 while (my ($cookie, $kv) = each %$cookies) {
442 next if $uscheme ne "https" && exists $kv->{secure};
443
444 if (exists $kv->{_expires} and AE::now > $kv->{_expires}) {
445 delete $cookies->{$cookie};
446 next;
447 }
448
449 my $value = $kv->{value};
450
451 if ($value =~ /[=;,[:space:]]/) {
452 $value =~ s/([\\"])/\\$1/g;
453 $value = "\"$value\"";
454 }
455
456 push @cookies, "$cookie=$value";
457 }
458 }
459 }
460
461 \@cookies
462}
463
464# parse set_cookie header into jar
465sub cookie_jar_set_cookie($$$$) {
466 my ($jar, $set_cookie, $uhost, $date) = @_;
467
468 my $anow = int AE::now;
469 my $snow; # server-now
470
471 for ($set_cookie) {
472 # parse NAME=VALUE
473 my @kv;
474
475 # expires is not http-compliant in the original cookie-spec,
476 # we support the official date format and some extensions
477 while (
478 m{
479 \G\s*
480 (?:
481 expires \s*=\s* ([A-Z][a-z][a-z]+,\ [^,;]+)
482 | ([^=;,[:space:]]+) (?: \s*=\s* (?: "((?:[^\\"]+|\\.)*)" | ([^=;,[:space:]]*) ) )?
483 )
484 }gcxsi
485 ) {
486 my $name = $2;
487 my $value = $4;
488
489 if (defined $1) {
490 # expires
491 $name = "expires";
492 $value = $1;
493 } elsif (defined $3) {
494 # quoted
495 $value = $3;
496 $value =~ s/\\(.)/$1/gs;
497 }
498
499 push @kv, lc $name, $value;
500
501 last unless /\G\s*;/gc;
502 }
503
504 last unless @kv;
505
506 my $name = shift @kv;
507 my %kv = (value => shift @kv, @kv);
508
509 if (exists $kv{"max-age"}) {
510 $kv{_expires} = $anow + delete $kv{"max-age"};
511 } elsif (exists $kv{expires}) {
512 $snow ||= parse_date ($date) || $anow;
513 $kv{_expires} = $anow + (parse_date (delete $kv{expires}) - $snow);
514 } else {
515 delete $kv{_expires};
516 }
517
518 my $cdom;
519 my $cpath = (delete $kv{path}) || "/";
520
521 if (exists $kv{domain}) {
522 $cdom = delete $kv{domain};
523
524 $cdom =~ s/^\.?/./; # make sure it starts with a "."
525
526 next if $cdom =~ /\.$/;
527
528 # this is not rfc-like and not netscape-like. go figure.
529 my $ndots = $cdom =~ y/.//;
530 next if $ndots < ($cdom =~ /\.[^.][^.]\.[^.][^.]$/ ? 3 : 2);
531 } else {
532 $cdom = $uhost;
533 }
534
535 # store it
536 $jar->{version} = 1;
537 $jar->{lc $cdom}{$cpath}{$name} = \%kv;
538
539 redo if /\G\s*,/gc;
540 }
541}
542
357# continue to parse $_ for headers and place them into the arg 543# continue to parse $_ for headers and place them into the arg
358sub parse_hdr() { 544sub parse_hdr() {
359 my %hdr; 545 my %hdr;
360 546
361 # things seen, not parsed: 547 # things seen, not parsed:
… …
436 622
437 $upath =~ s%^/?%/%; 623 $upath =~ s%^/?%/%;
438 624
439 # cookie processing 625 # cookie processing
440 if (my $jar = $arg{cookie_jar}) { 626 if (my $jar = $arg{cookie_jar}) {
441 %$jar = () if $jar->{version} != 1; 627 my $cookies = cookie_jar_extract $jar, $uscheme, $uhost, $upath;
442 628
443 my @cookie;
444
445 while (my ($chost, $v) = each %$jar) {
446 if ($chost =~ /^\./) {
447 next unless $chost eq substr $uhost, -length $chost;
448 } elsif ($chost =~ /\./) {
449 next unless $chost eq $uhost;
450 } else {
451 next;
452 }
453
454 while (my ($cpath, $v) = each %$v) {
455 next unless $cpath eq substr $upath, 0, length $cpath;
456
457 while (my ($k, $v) = each %$v) {
458 next if $uscheme ne "https" && exists $v->{secure};
459 my $value = $v->{value};
460 $value =~ s/([\\"])/\\$1/g;
461 push @cookie, "$k=\"$value\"";
462 }
463 }
464 }
465
466 $hdr{cookie} = join "; ", @cookie 629 $hdr{cookie} = join "; ", @$cookies
467 if @cookie; 630 if @$cookies;
468 } 631 }
469 632
470 my ($rhost, $rport, $rscheme, $rpath); # request host, port, path 633 my ($rhost, $rport, $rscheme, $rpath); # request host, port, path
471 634
472 if ($proxy) { 635 if ($proxy) {
… …
486 $hdr{"user-agent"} = $USERAGENT unless exists $hdr{"user-agent"}; 649 $hdr{"user-agent"} = $USERAGENT unless exists $hdr{"user-agent"};
487 650
488 $hdr{"content-length"} = length $arg{body} 651 $hdr{"content-length"} = length $arg{body}
489 if length $arg{body} || $method ne "GET"; 652 if length $arg{body} || $method ne "GET";
490 653
491 $hdr{connection} = "close TE"; 654 $hdr{connection} = "close TE"; #1.1
492 $hdr{te} = "trailers" unless exists $hdr{te}; 655 $hdr{te} = "trailers" unless exists $hdr{te}; #1.1
493 656
494 my %state = (connect_guard => 1); 657 my %state = (connect_guard => 1);
495 658
496 _get_slot $uhost, sub { 659 _get_slot $uhost, sub {
497 $state{slot_guard} = shift; 660 $state{slot_guard} = shift;
498 661
499 return unless $state{connect_guard}; 662 return unless $state{connect_guard};
663
664 my $ae_error = 595; # connecting
665
666 # handle actual, non-tunneled, request
667 my $handle_actual_request = sub {
668 $ae_error = 596; # request phase
669
670 $state{handle}->starttls ("connect") if $uscheme eq "https" && !exists $state{handle}{tls};
671
672 # send request
673 $state{handle}->push_write (
674 "$method $rpath HTTP/1.1\015\012"
675 . (join "", map "\u$_: $hdr{$_}\015\012", grep defined $hdr{$_}, keys %hdr)
676 . "\015\012"
677 . (delete $arg{body})
678 );
679
680 # return if error occured during push_write()
681 return unless %state;
682
683 %hdr = (); # reduce memory usage, save a kitten, also make it possible to re-use
684
685 # status line and headers
686 $state{read_response} = sub {
687 for ("$_[1]") {
688 y/\015//d; # weed out any \015, as they show up in the weirdest of places.
689
690 /^HTTP\/0*([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\012]*) )? \012/gxci
691 or return (%state = (), $cb->(undef, { @pseudo, Status => 599, Reason => "Invalid server response" }));
692
693 # 100 Continue handling
694 # should not happen as we don't send expect: 100-continue,
695 # but we handle it just in case.
696 # since we send the request body regardless, if we get an error
697 # we are out of-sync, which we currently do NOT handle correctly.
698 return $state{handle}->push_read (line => $qr_nlnl, $state{read_response})
699 if $2 eq 100;
700
701 push @pseudo,
702 HTTPVersion => $1,
703 Status => $2,
704 Reason => $3,
705 ;
706
707 my $hdr = parse_hdr
708 or return (%state = (), $cb->(undef, { @pseudo, Status => 599, Reason => "Garbled response headers" }));
709
710 %hdr = (%$hdr, @pseudo);
711 }
712
713 # redirect handling
714 # microsoft and other shitheads don't give a shit for following standards,
715 # try to support some common forms of broken Location headers.
716 if ($hdr{location} !~ /^(?: $ | [^:\/?\#]+ : )/x) {
717 $hdr{location} =~ s/^\.\/+//;
718
719 my $url = "$rscheme://$uhost:$uport";
720
721 unless ($hdr{location} =~ s/^\///) {
722 $url .= $upath;
723 $url =~ s/\/[^\/]*$//;
724 }
725
726 $hdr{location} = "$url/$hdr{location}";
727 }
728
729 my $redirect;
730
731 if ($recurse) {
732 my $status = $hdr{Status};
733
734 # industry standard is to redirect POST as GET for
735 # 301, 302 and 303, in contrast to HTTP/1.0 and 1.1.
736 # also, the UA should ask the user for 301 and 307 and POST,
737 # industry standard seems to be to simply follow.
738 # we go with the industry standard.
739 if ($status == 301 or $status == 302 or $status == 303) {
740 # HTTP/1.1 is unclear on how to mutate the method
741 $method = "GET" unless $method eq "HEAD";
742 $redirect = 1;
743 } elsif ($status == 307) {
744 $redirect = 1;
745 }
746 }
747
748 my $finish = sub { # ($data, $err_status, $err_reason[, $keepalive])
749 my $may_keep_alive = $_[3];
750
751 $state{handle}->destroy if $state{handle};
752 %state = ();
753
754 if (defined $_[1]) {
755 $hdr{OrigStatus} = $hdr{Status}; $hdr{Status} = $_[1];
756 $hdr{OrigReason} = $hdr{Reason}; $hdr{Reason} = $_[2];
757 }
758
759 # set-cookie processing
760 if ($arg{cookie_jar}) {
761 cookie_jar_set_cookie $arg{cookie_jar}, $hdr{"set-cookie"}, $uhost, $hdr{date};
762 }
763
764 if ($redirect && exists $hdr{location}) {
765 # we ignore any errors, as it is very common to receive
766 # Content-Length != 0 but no actual body
767 # we also access %hdr, as $_[1] might be an erro
768 http_request (
769 $method => $hdr{location},
770 %arg,
771 recurse => $recurse - 1,
772 Redirect => [$_[0], \%hdr],
773 $cb);
774 } else {
775 $cb->($_[0], \%hdr);
776 }
777 };
778
779 $ae_error = 597; # body phase
780
781 my $len = $hdr{"content-length"};
782 warn "no content $redirect x<$len>$hdr{Status}\n";#d#
783
784 # body handling, many different code paths
785 # - no body expected
786 # - want_body_handle
787 # - te chunked
788 # - 2x length known (with or without on_body)
789 # - 2x length not known (with or without on_body)
790 if (!$redirect && $arg{on_header} && !$arg{on_header}(\%hdr)) {
791 $finish->(undef, 598 => "Request cancelled by on_header");
792 } elsif (
793 $hdr{Status} =~ /^(?:1..|204|205|304)$/
794 or $method eq "HEAD"
795 or (defined $len && $len == 0) # == 0, not !, because "0 " is true
796 ) {
797 # no body
798 $finish->("", undef, undef, 1);
799
800 } elsif (!$redirect && $arg{want_body_handle}) {
801 $_[0]->on_eof (undef);
802 $_[0]->on_error (undef);
803 $_[0]->on_read (undef);
804
805 $finish->(delete $state{handle});
806
807 } elsif ($hdr{"transfer-encoding"} =~ /\bchunked\b/i) {
808 my $cl = 0;
809 my $body = undef;
810 my $on_body = $arg{on_body} || sub { $body .= shift; 1 };
811
812 $state{read_chunk} = sub {
813 $_[1] =~ /^([0-9a-fA-F]+)/
814 or $finish->(undef, $ae_error => "Garbled chunked transfer encoding");
815
816 my $len = hex $1;
817
818 if ($len) {
819 $cl += $len;
820
821 $_[0]->push_read (chunk => $len, sub {
822 $on_body->($_[1], \%hdr)
823 or return $finish->(undef, 598 => "Request cancelled by on_body");
824
825 $_[0]->push_read (line => sub {
826 length $_[1]
827 and return $finish->(undef, $ae_error => "Garbled chunked transfer encoding");
828 $_[0]->push_read (line => $state{read_chunk});
829 });
830 });
831 } else {
832 $hdr{"content-length"} ||= $cl;
833
834 $_[0]->push_read (line => $qr_nlnl, sub {
835 if (length $_[1]) {
836 for ("$_[1]") {
837 y/\015//d; # weed out any \015, as they show up in the weirdest of places.
838
839 my $hdr = parse_hdr
840 or return $finish->(undef, $ae_error => "Garbled response trailers");
841
842 %hdr = (%hdr, %$hdr);
843 }
844 }
845
846 $finish->($body, undef, undef, 1);
847 });
848 }
849 };
850
851 $_[0]->push_read (line => $state{read_chunk});
852
853 } elsif ($arg{on_body}) {
854 if (defined $len) {
855 $_[0]->on_read (sub {
856 $len -= length $_[0]{rbuf};
857
858 $arg{on_body}(delete $_[0]{rbuf}, \%hdr)
859 or return $finish->(undef, 598 => "Request cancelled by on_body");
860
861 $len > 0
862 or $finish->("", undef, undef, 1);
863 });
864 } else {
865 $_[0]->on_eof (sub {
866 $finish->("");
867 });
868 $_[0]->on_read (sub {
869 $arg{on_body}(delete $_[0]{rbuf}, \%hdr)
870 or $finish->(undef, 598 => "Request cancelled by on_body");
871 });
872 }
873 } else {
874 $_[0]->on_eof (undef);
875
876 if (defined $len) {
877 $_[0]->on_read (sub {
878 $finish->((substr delete $_[0]{rbuf}, 0, $len, ""), undef, undef, 1)
879 if $len <= length $_[0]{rbuf};
880 });
881 } else {
882 $_[0]->on_error (sub {
883 ($! == Errno::EPIPE || !$!)
884 ? $finish->(delete $_[0]{rbuf})
885 : $finish->(undef, $ae_error => $_[2]);
886 });
887 $_[0]->on_read (sub { });
888 }
889 }
890 };
891
892 $state{handle}->push_read (line => $qr_nlnl, $state{read_response});
893 };
500 894
501 my $connect_cb = sub { 895 my $connect_cb = sub {
502 $state{fh} = shift 896 $state{fh} = shift
503 or do { 897 or do {
504 my $err = "$!"; 898 my $err = "$!";
505 %state = (); 899 %state = ();
506 return $cb->(undef, { @pseudo, Status => 599, Reason => $err }); 900 return $cb->(undef, { @pseudo, Status => $ae_error, Reason => $err });
507 }; 901 };
508
509 pop; # free memory, save a tree
510 902
511 return unless delete $state{connect_guard}; 903 return unless delete $state{connect_guard};
512 904
513 # get handle 905 # get handle
514 $state{handle} = new AnyEvent::Handle 906 $state{handle} = new AnyEvent::Handle
… …
517 tls_ctx => $arg{tls_ctx}, 909 tls_ctx => $arg{tls_ctx},
518 # these need to be reconfigured on keepalive handles 910 # these need to be reconfigured on keepalive handles
519 timeout => $timeout, 911 timeout => $timeout,
520 on_error => sub { 912 on_error => sub {
521 %state = (); 913 %state = ();
522 $cb->(undef, { @pseudo, Status => 599, Reason => $_[2] }); 914 $cb->(undef, { @pseudo, Status => $ae_error, Reason => $_[2] });
523 }, 915 },
524 on_eof => sub { 916 on_eof => sub {
525 %state = (); 917 %state = ();
526 $cb->(undef, { @pseudo, Status => 599, Reason => "Unexpected end-of-file" }); 918 $cb->(undef, { @pseudo, Status => $ae_error, Reason => "Unexpected end-of-file" });
527 }, 919 },
528 ; 920 ;
529 921
530 # limit the number of persistent connections 922 # limit the number of persistent connections
531 # keepalive not yet supported 923 # keepalive not yet supported
… …
533# ++$KA_COUNT{$_[1]}; 925# ++$KA_COUNT{$_[1]};
534# $state{handle}{ka_count_guard} = AnyEvent::Util::guard { 926# $state{handle}{ka_count_guard} = AnyEvent::Util::guard {
535# --$KA_COUNT{$_[1]} 927# --$KA_COUNT{$_[1]}
536# }; 928# };
537# $hdr{connection} = "keep-alive"; 929# $hdr{connection} = "keep-alive";
538# } else {
539# delete $hdr{connection};
540# } 930# }
541 931
542 $state{handle}->starttls ("connect") if $rscheme eq "https"; 932 $state{handle}->starttls ("connect") if $rscheme eq "https";
543
544 # handle actual, non-tunneled, request
545 my $handle_actual_request = sub {
546 $state{handle}->starttls ("connect") if $uscheme eq "https" && !exists $state{handle}{tls};
547
548 # send request
549 $state{handle}->push_write (
550 "$method $rpath HTTP/1.1\015\012"
551 . (join "", map "\u$_: $hdr{$_}\015\012", grep defined $hdr{$_}, keys %hdr)
552 . "\015\012"
553 . (delete $arg{body})
554 );
555
556 # return if error occured during push_write()
557 return unless %state;
558
559 %hdr = (); # reduce memory usage, save a kitten, also make it possible to re-use
560
561 # status line and headers
562 $state{handle}->push_read (line => $qr_nlnl, sub {
563 my $keepalive = pop;
564
565 for ("$_[1]") {
566 y/\015//d; # weed out any \015, as they show up in the weirdest of places.
567
568 /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\012]*) )? \012/igxc
569 or return (%state = (), $cb->(undef, { @pseudo, Status => 599, Reason => "Invalid server response" }));
570
571 push @pseudo,
572 HTTPVersion => $1,
573 Status => $2,
574 Reason => $3,
575 ;
576
577 my $hdr = parse_hdr
578 or return (%state = (), $cb->(undef, { @pseudo, Status => 599, Reason => "Garbled response headers" }));
579
580 %hdr = (%$hdr, @pseudo);
581 }
582
583 # redirect handling
584 # microsoft and other shitheads don't give a shit for following standards,
585 # try to support some common forms of broken Location headers.
586 if ($hdr{location} !~ /^(?: $ | [^:\/?\#]+ : )/x) {
587 $hdr{location} =~ s/^\.\/+//;
588
589 my $url = "$rscheme://$uhost:$uport";
590
591 unless ($hdr{location} =~ s/^\///) {
592 $url .= $upath;
593 $url =~ s/\/[^\/]*$//;
594 }
595
596 $hdr{location} = "$url/$hdr{location}";
597 }
598
599 my $redirect;
600
601 if ($recurse) {
602 my $status = $hdr{Status};
603
604 # industry standard is to redirect POST as GET for
605 # 301, 302 and 303, in contrast to http/1.0 and 1.1.
606 # also, the UA should ask the user for 301 and 307 and POST,
607 # industry standard seems to be to simply follow.
608 # we go with the industry standard.
609 if ($status == 301 or $status == 302 or $status == 303) {
610 # HTTP/1.1 is unclear on how to mutate the method
611 $method = "GET" unless $method eq "HEAD";
612 $redirect = 1;
613 } elsif ($status == 307) {
614 $redirect = 1;
615 }
616 }
617
618 my $finish = sub { # ($data, $err_status, $err_reason[, $keepalive])
619 $state{handle}->destroy if $state{handle};
620 %state = ();
621
622 if (defined $_[1]) {
623 $hdr{OrigStatus} = $hdr{Status}; $hdr{Status} = $_[1];
624 $hdr{OrigReason} = $hdr{Reason}; $hdr{Reason} = $_[2];
625 }
626
627 # set-cookie processing
628 if ($arg{cookie_jar}) {
629 for ($hdr{"set-cookie"}) {
630 # parse NAME=VALUE
631 my @kv;
632
633 while (/\G\s* ([^=;,[:space:]]+) \s*=\s* (?: "((?:[^\\"]+|\\.)*)" | ([^=;,[:space:]]*) )/gcxs) {
634 my $name = $1;
635 my $value = $3;
636
637 unless ($value) {
638 $value = $2;
639 $value =~ s/\\(.)/$1/gs;
640 }
641
642 push @kv, $name => $value;
643
644 last unless /\G\s*;/gc;
645 }
646
647 last unless @kv;
648
649 my $name = shift @kv;
650 my %kv = (value => shift @kv, @kv);
651
652 my $cdom;
653 my $cpath = (delete $kv{path}) || "/";
654
655 if (exists $kv{domain}) {
656 $cdom = delete $kv{domain};
657
658 $cdom =~ s/^\.?/./; # make sure it starts with a "."
659
660 next if $cdom =~ /\.$/;
661
662 # this is not rfc-like and not netscape-like. go figure.
663 my $ndots = $cdom =~ y/.//;
664 next if $ndots < ($cdom =~ /\.[^.][^.]\.[^.][^.]$/ ? 3 : 2);
665 } else {
666 $cdom = $uhost;
667 }
668
669 # store it
670 $arg{cookie_jar}{version} = 1;
671 $arg{cookie_jar}{$cdom}{$cpath}{$name} = \%kv;
672
673 redo if /\G\s*,/gc;
674 }
675 }
676
677 if ($redirect && exists $hdr{location}) {
678 # we ignore any errors, as it is very common to receive
679 # Content-Length != 0 but no actual body
680 # we also access %hdr, as $_[1] might be an erro
681 http_request (
682 $method => $hdr{location},
683 %arg,
684 recurse => $recurse - 1,
685 Redirect => [$_[0], \%hdr],
686 $cb);
687 } else {
688 $cb->($_[0], \%hdr);
689 }
690 };
691
692 my $len = $hdr{"content-length"};
693
694 if (!$redirect && $arg{on_header} && !$arg{on_header}(\%hdr)) {
695 $finish->(undef, 598 => "Request cancelled by on_header");
696 } elsif (
697 $hdr{Status} =~ /^(?:1..|204|205|304)$/
698 or $method eq "HEAD"
699 or (defined $len && !$len)
700 ) {
701 # no body
702 $finish->("", undef, undef, 1);
703 } else {
704 # body handling, many different code paths
705 # - no body expected
706 # - want_body_handle
707 # - te chunked
708 # - 2x length known (with or without on_body)
709 # - 2x length not known (with or without on_body)
710 if (!$redirect && $arg{want_body_handle}) {
711 $_[0]->on_eof (undef);
712 $_[0]->on_error (undef);
713 $_[0]->on_read (undef);
714
715 $finish->(delete $state{handle});
716
717 } elsif ($hdr{"transfer-encoding"} =~ /chunked/) {
718 my $body = undef;
719 my $on_body = $arg{on_body} || sub { $body .= shift; 1 };
720
721 $_[0]->on_error (sub { $finish->(undef, 599 => $_[2]) });
722
723 my $read_chunk; $read_chunk = sub {
724 warn $_[1];#d#
725 $_[1] =~ /^([0-9a-fA-F]+)/
726 or $finish->(undef, 599 => "Garbled chunked transfer encoding");
727
728 my $len = hex $1;
729
730 if ($len) {
731 $_[0]->push_read (chunk => hex $1, sub {
732 $on_body->($_[1], \%hdr)
733 or return $finish->(undef, 598 => "Request cancelled by on_body");
734
735 $_[0]->push_read (line => sub {
736 length $_[1]
737 and return $finish->(undef, 599 => "Garbled chunked transfer encoding");
738 $_[0]->push_read (line => $read_chunk);
739 });
740 });
741 } else {
742 $_[0]->push_read (line => $qr_nlnl, sub {
743 if (length $_[1]) {
744 for ("$_[1]") {
745 y/\015//d; # weed out any \015, as they show up in the weirdest of places.
746
747 my $hdr = parse_hdr
748 or return $finish->(undef, 599 => "Garbled response trailers");
749
750 %hdr = (%hdr, %$hdr);
751 }
752 }
753
754 $finish->($body, undef, undef, 1);
755 });
756 }
757 };
758
759 $_[0]->push_read (line => $read_chunk);
760
761 } elsif ($arg{on_body}) {
762 $_[0]->on_error (sub { $finish->(undef, 599 => $_[2]) });
763
764 if ($len) {
765 $_[0]->on_read (sub {
766 $len -= length $_[0]{rbuf};
767
768 $arg{on_body}(delete $_[0]{rbuf}, \%hdr)
769 or return $finish->(undef, 598 => "Request cancelled by on_body");
770
771 $len > 0
772 or $finish->("", undef, undef, 1);
773 });
774 } else {
775 $_[0]->on_eof (sub {
776 $finish->("");
777 });
778 $_[0]->on_read (sub {
779 $arg{on_body}(delete $_[0]{rbuf}, \%hdr)
780 or $finish->(undef, 598 => "Request cancelled by on_body");
781 });
782 }
783 } else {
784 $_[0]->on_eof (undef);
785
786 if ($len) {
787 $_[0]->on_error (sub { $finish->(undef, 599 => $_[2]) });
788 $_[0]->on_read (sub {
789 $finish->((substr delete $_[0]{rbuf}, 0, $len, ""), undef, undef, 1)
790 if $len <= length $_[0]{rbuf};
791 });
792 } else {
793 $_[0]->on_error (sub {
794 ($! == Errno::EPIPE || !$!)
795 ? $finish->(delete $_[0]{rbuf})
796 : $finish->(undef, 599 => $_[2]);
797 });
798 $_[0]->on_read (sub { });
799 }
800 }
801 }
802 });
803 };
804 933
805 # now handle proxy-CONNECT method 934 # now handle proxy-CONNECT method
806 if ($proxy && $uscheme eq "https") { 935 if ($proxy && $uscheme eq "https") {
807 # oh dear, we have to wrap it into a connect request 936 # oh dear, we have to wrap it into a connect request
808 937
… …
812 $_[1] =~ /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\015\012]*) )?/ix 941 $_[1] =~ /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\015\012]*) )?/ix
813 or return (%state = (), $cb->(undef, { @pseudo, Status => 599, Reason => "Invalid proxy connect response ($_[1])" })); 942 or return (%state = (), $cb->(undef, { @pseudo, Status => 599, Reason => "Invalid proxy connect response ($_[1])" }));
814 943
815 if ($2 == 200) { 944 if ($2 == 200) {
816 $rpath = $upath; 945 $rpath = $upath;
817 &$handle_actual_request; 946 $handle_actual_request->();
818 } else { 947 } else {
819 %state = (); 948 %state = ();
820 $cb->(undef, { @pseudo, Status => $2, Reason => $3 }); 949 $cb->(undef, { @pseudo, Status => $2, Reason => $3 });
821 } 950 }
822 }); 951 });
823 } else { 952 } else {
824 &$handle_actual_request; 953 $handle_actual_request->();
825 } 954 }
826 }; 955 };
827 956
828 my $tcp_connect = $arg{tcp_connect} 957 my $tcp_connect = $arg{tcp_connect}
829 || do { require AnyEvent::Socket; \&AnyEvent::Socket::tcp_connect }; 958 || do { require AnyEvent::Socket; \&AnyEvent::Socket::tcp_connect };
830 959
831 $state{connect_guard} = $tcp_connect->($rhost, $rport, $connect_cb, $arg{on_prepare} || sub { $timeout }); 960 $state{connect_guard} = $tcp_connect->($rhost, $rport, $connect_cb, $arg{on_prepare} || sub { $timeout });
832
833 }; 961 };
834 962
835 defined wantarray && AnyEvent::Util::guard { %state = () } 963 defined wantarray && AnyEvent::Util::guard { %state = () }
836} 964}
837 965
… …
872string of the form C<http://host:port> (optionally C<https:...>), croaks 1000string of the form C<http://host:port> (optionally C<https:...>), croaks
873otherwise. 1001otherwise.
874 1002
875To clear an already-set proxy, use C<undef>. 1003To clear an already-set proxy, use C<undef>.
876 1004
1005=item AnyEvent::HTTP::cookie_jar_expire $jar[, $session_end]
1006
1007Remove all cookies from the cookie jar that have been expired. If
1008C<$session_end> is given and true, then additionally remove all session
1009cookies.
1010
1011You should call this function (with a true C<$session_end>) before you
1012save cookies to disk, and you should call this function after loading them
1013again. If you have a long-running program you can additonally call this
1014function from time to time.
1015
1016A cookie jar is initially an empty hash-reference that is managed by this
1017module. It's format is subject to change, but currently it is like this:
1018
1019The key C<version> has to contain C<1>, otherwise the hash gets
1020emptied. All other keys are hostnames or IP addresses pointing to
1021hash-references. The key for these inner hash references is the
1022server path for which this cookie is meant, and the values are again
1023hash-references. The keys of those hash-references is the cookie name, and
1024the value, you guessed it, is another hash-reference, this time with the
1025key-value pairs from the cookie, except for C<expires> and C<max-age>,
1026which have been replaced by a C<_expires> key that contains the cookie
1027expiry timestamp.
1028
1029Here is an example of a cookie jar with a single cookie, so you have a
1030chance of understanding the above paragraph:
1031
1032 {
1033 version => 1,
1034 "10.0.0.1" => {
1035 "/" => {
1036 "mythweb_id" => {
1037 _expires => 1293917923,
1038 value => "ooRung9dThee3ooyXooM1Ohm",
1039 },
1040 },
1041 },
1042 }
1043
877=item $date = AnyEvent::HTTP::format_date $timestamp 1044=item $date = AnyEvent::HTTP::format_date $timestamp
878 1045
879Takes a POSIX timestamp (seconds since the epoch) and formats it as a HTTP 1046Takes a POSIX timestamp (seconds since the epoch) and formats it as a HTTP
880Date (RFC 2616). 1047Date (RFC 2616).
881 1048
882=item $timestamp = AnyEvent::HTTP::parse_date $date 1049=item $timestamp = AnyEvent::HTTP::parse_date $date
883 1050
884Takes a HTTP Date (RFC 2616) and returns the corresponding POSIX 1051Takes a HTTP Date (RFC 2616) or a Cookie date (netscape cookie spec) or a
1052bunch of minor variations of those, and returns the corresponding POSIX
885timestamp, or C<undef> if the date cannot be parsed. 1053timestamp, or C<undef> if the date cannot be parsed.
886 1054
887=item $AnyEvent::HTTP::MAX_RECURSE 1055=item $AnyEvent::HTTP::MAX_RECURSE
888 1056
889The default value for the C<recurse> request parameter (default: C<10>). 1057The default value for the C<recurse> request parameter (default: C<10>).
… …
929sub parse_date($) { 1097sub parse_date($) {
930 my ($date) = @_; 1098 my ($date) = @_;
931 1099
932 my ($d, $m, $y, $H, $M, $S); 1100 my ($d, $m, $y, $H, $M, $S);
933 1101
934 if ($date =~ /^[A-Z][a-z][a-z], ([0-9][0-9]) ([A-Z][a-z][a-z]) ([0-9][0-9][0-9][0-9]) ([0-9][0-9]):([0-9][0-9]):([0-9][0-9]) GMT$/) { 1102 if ($date =~ /^[A-Z][a-z][a-z]+, ([0-9][0-9]?)[\- ]([A-Z][a-z][a-z])[\- ]([0-9][0-9][0-9][0-9]) ([0-9][0-9]?):([0-9][0-9]?):([0-9][0-9]?) GMT$/) {
935 # RFC 822/1123, required by RFC 2616 1103 # RFC 822/1123, required by RFC 2616 (with " ")
1104 # cookie dates (with "-")
1105
936 ($d, $m, $y, $H, $M, $S) = ($1, $2, $3, $4, $5, $6); 1106 ($d, $m, $y, $H, $M, $S) = ($1, $2, $3, $4, $5, $6);
937 1107
938 } elsif ($date =~ /^[A-Z][a-z]+, ([0-9][0-9])-([A-Z][a-z][a-z])-([0-9][0-9]) ([0-9][0-9]):([0-9][0-9]):([0-9][0-9]) GMT$/) { 1108 } elsif ($date =~ /^[A-Z][a-z][a-z]+, ([0-9][0-9]?)-([A-Z][a-z][a-z])-([0-9][0-9]) ([0-9][0-9]?):([0-9][0-9]?):([0-9][0-9]?) GMT$/) {
939 # RFC 850 1109 # RFC 850
940 ($d, $m, $y, $H, $M, $S) = ($1, $2, $3 < 69 ? $3 + 2000 : $3 + 1900, $4, $5, $6); 1110 ($d, $m, $y, $H, $M, $S) = ($1, $2, $3 < 69 ? $3 + 2000 : $3 + 1900, $4, $5, $6);
941 1111
942 } elsif ($date =~ /^[A-Z][a-z][a-z] ([A-Z][a-z][a-z]) ([0-9 ][0-9]) ([0-9][0-9]):([0-9][0-9]):([0-9][0-9]) ([0-9][0-9][0-9][0-9])$/) { 1112 } elsif ($date =~ /^[A-Z][a-z][a-z]+ ([A-Z][a-z][a-z]) ([0-9 ]?[0-9]) ([0-9][0-9]?):([0-9][0-9]?):([0-9][0-9]?) ([0-9][0-9][0-9][0-9])$/) {
943 # ISO C's asctime 1113 # ISO C's asctime
944 ($d, $m, $y, $H, $M, $S) = ($2, $1, $6, $3, $4, $5); 1114 ($d, $m, $y, $H, $M, $S) = ($2, $1, $6, $3, $4, $5);
945 } 1115 }
946 # other formats fail in the loop below 1116 # other formats fail in the loop below
947 1117

Diff Legend

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