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.64 by root, Fri Dec 31 02:53:29 2010 UTC vs.
Revision 1.82 by root, Sun Jan 2 04:50:40 2011 UTC

… …
47use AnyEvent::Util (); 47use AnyEvent::Util ();
48use AnyEvent::Handle (); 48use AnyEvent::Handle ();
49 49
50use base Exporter::; 50use base Exporter::;
51 51
52our $VERSION = '1.46'; 52our $VERSION = '1.5';
53 53
54our @EXPORT = qw(http_get http_post http_head http_request); 54our @EXPORT = qw(http_get http_post http_head http_request);
55 55
56our $USERAGENT = "Mozilla/5.0 (compatible; U; AnyEvent-HTTP/$VERSION; +http://software.schmorp.de/pkg/AnyEvent)"; 56our $USERAGENT = "Mozilla/5.0 (compatible; U; AnyEvent-HTTP/$VERSION; +http://software.schmorp.de/pkg/AnyEvent)";
57our $MAX_RECURSE = 10; 57our $MAX_RECURSE = 10;
… …
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 %$jar = () if $jar->{version} != 1;
422
423 my @cookies;
424
425 while (my ($chost, $paths) = each %$jar) {
426 next unless ref $paths;
427
428 if ($chost =~ /^\./) {
429 next unless $chost eq substr $uhost, -length $chost;
430 } elsif ($chost =~ /\./) {
431 next unless $chost eq $uhost;
432 } else {
433 next;
434 }
435
436 while (my ($cpath, $cookies) = each %$paths) {
437 next unless $cpath eq substr $upath, 0, length $cpath;
438
439 while (my ($cookie, $kv) = each %$cookies) {
440 next if $uscheme ne "https" && exists $kv->{secure};
441
442 if (exists $kv->{_expires} and AE::now > $kv->{_expires}) {
443 delete $cookies->{$cookie};
444 next;
445 }
446
447 my $value = $kv->{value};
448
449 if ($value =~ /[=;,[:space:]]/) {
450 $value =~ s/([\\"])/\\$1/g;
451 $value = "\"$value\"";
452 }
453
454 push @cookies, "$cookie=$value";
455 }
456 }
457 }
458
459 \@cookies
460}
461
462# parse set_cookie header into jar
463sub cookie_jar_set_cookie($$$$) {
464 my ($jar, $set_cookie, $uhost, $date) = @_;
465
466 my $anow = int AE::now;
467 my $snow; # server-now
468
469 for ($set_cookie) {
470 # parse NAME=VALUE
471 my @kv;
472
473 # expires is not http-compliant in the original cookie-spec,
474 # we support the official date format and some extensions
475 while (
476 m{
477 \G\s*
478 (?:
479 expires \s*=\s* ([A-Z][a-z][a-z]+,\ [^,;]+)
480 | ([^=;,[:space:]]+) (?: \s*=\s* (?: "((?:[^\\"]+|\\.)*)" | ([^=;,[:space:]]*) ) )?
481 )
482 }gcxsi
483 ) {
484 my $name = $2;
485 my $value = $4;
486
487 if (defined $1) {
488 # expires
489 $name = "expires";
490 $value = $1;
491 } elsif (defined $3) {
492 # quoted
493 $value = $3;
494 $value =~ s/\\(.)/$1/gs;
495 }
496
497 push @kv, lc $name, $value;
498
499 last unless /\G\s*;/gc;
500 }
501
502 last unless @kv;
503
504 my $name = shift @kv;
505 my %kv = (value => shift @kv, @kv);
506
507 if (exists $kv{"max-age"}) {
508 $kv{_expires} = $anow + delete $kv{"max-age"};
509 } elsif (exists $kv{expires}) {
510 $snow ||= parse_date ($date) || $anow;
511 $kv{_expires} = $anow + (parse_date (delete $kv{expires}) - $snow);
512 } else {
513 delete $kv{_expires};
514 }
515
516 my $cdom;
517 my $cpath = (delete $kv{path}) || "/";
518
519 if (exists $kv{domain}) {
520 $cdom = delete $kv{domain};
521
522 $cdom =~ s/^\.?/./; # make sure it starts with a "."
523
524 next if $cdom =~ /\.$/;
525
526 # this is not rfc-like and not netscape-like. go figure.
527 my $ndots = $cdom =~ y/.//;
528 next if $ndots < ($cdom =~ /\.[^.][^.]\.[^.][^.]$/ ? 3 : 2);
529 } else {
530 $cdom = $uhost;
531 }
532
533 # store it
534 $jar->{version} = 1;
535 $jar->{$cdom}{$cpath}{$name} = \%kv;
536
537 redo if /\G\s*,/gc;
538 }
539}
540
541# continue to parse $_ for headers and place them into the arg
542sub parse_hdr() {
543 my %hdr;
544
545 # things seen, not parsed:
546 # p3pP="NON CUR OTPi OUR NOR UNI"
547
548 $hdr{lc $1} .= ",$2"
549 while /\G
550 ([^:\000-\037]*):
551 [\011\040]*
552 ((?: [^\012]+ | \012[\011\040] )*)
553 \012
554 /gxc;
555
556 /\G$/
557 or return;
558
559 # remove the "," prefix we added to all headers above
560 substr $_, 0, 1, ""
561 for values %hdr;
562
563 \%hdr
564}
565
357our $qr_nlnl = qr{(?<![^\012])\015?\012}; 566our $qr_nlnl = qr{(?<![^\012])\015?\012};
358 567
359our $TLS_CTX_LOW = { cache => 1, sslv2 => 1 }; 568our $TLS_CTX_LOW = { cache => 1, sslv2 => 1 };
360our $TLS_CTX_HIGH = { cache => 1, verify => 1, verify_peername => "https" }; 569our $TLS_CTX_HIGH = { cache => 1, verify => 1, verify_peername => "https" };
361 570
… …
411 620
412 $upath =~ s%^/?%/%; 621 $upath =~ s%^/?%/%;
413 622
414 # cookie processing 623 # cookie processing
415 if (my $jar = $arg{cookie_jar}) { 624 if (my $jar = $arg{cookie_jar}) {
416 %$jar = () if $jar->{version} != 1; 625 my $cookies = cookie_jar_extract $jar, $uscheme, $uhost, $upath;
417 626
418 my @cookie;
419
420 while (my ($chost, $v) = each %$jar) {
421 if ($chost =~ /^\./) {
422 next unless $chost eq substr $uhost, -length $chost;
423 } elsif ($chost =~ /\./) {
424 next unless $chost eq $uhost;
425 } else {
426 next;
427 }
428
429 while (my ($cpath, $v) = each %$v) {
430 next unless $cpath eq substr $upath, 0, length $cpath;
431
432 while (my ($k, $v) = each %$v) {
433 next if $uscheme ne "https" && exists $v->{secure};
434 my $value = $v->{value};
435 $value =~ s/([\\"])/\\$1/g;
436 push @cookie, "$k=\"$value\"";
437 }
438 }
439 }
440
441 $hdr{cookie} = join "; ", @cookie 627 $hdr{cookie} = join "; ", @$cookies
442 if @cookie; 628 if @$cookies;
443 } 629 }
444 630
445 my ($rhost, $rport, $rscheme, $rpath); # request host, port, path 631 my ($rhost, $rport, $rscheme, $rpath); # request host, port, path
446 632
447 if ($proxy) { 633 if ($proxy) {
… …
455 } else { 641 } else {
456 ($rhost, $rport, $rscheme, $rpath) = ($uhost, $uport, $uscheme, $upath); 642 ($rhost, $rport, $rscheme, $rpath) = ($uhost, $uport, $uscheme, $upath);
457 } 643 }
458 644
459 # leave out fragment and query string, just a heuristic 645 # leave out fragment and query string, just a heuristic
460 $hdr{referer} ||= "$uscheme://$uauthority$upath" unless exists $hdr{referer}; 646 $hdr{referer} = "$uscheme://$uauthority$upath" unless exists $hdr{referer};
461 $hdr{"user-agent"} ||= $USERAGENT unless exists $hdr{"user-agent"}; 647 $hdr{"user-agent"} = $USERAGENT unless exists $hdr{"user-agent"};
462 648
463 $hdr{"content-length"} = length $arg{body} 649 $hdr{"content-length"} = length $arg{body}
464 if length $arg{body} || $method ne "GET"; 650 if length $arg{body} || $method ne "GET";
465 651
652 $hdr{connection} = "close TE"; #1.1
653 $hdr{te} = "trailers" unless exists $hdr{te}; #1.1
654
466 my %state = (connect_guard => 1); 655 my %state = (connect_guard => 1);
467 656
468 _get_slot $uhost, sub { 657 _get_slot $uhost, sub {
469 $state{slot_guard} = shift; 658 $state{slot_guard} = shift;
470 659
471 return unless $state{connect_guard}; 660 return unless $state{connect_guard};
661
662 my $ae_error = 595; # connecting
663
664 # handle actual, non-tunneled, request
665 my $handle_actual_request = sub {
666 $ae_error = 596; # request phase
667
668 $state{handle}->starttls ("connect") if $uscheme eq "https" && !exists $state{handle}{tls};
669
670 # send request
671 $state{handle}->push_write (
672 "$method $rpath HTTP/1.1\015\012"
673 . (join "", map "\u$_: $hdr{$_}\015\012", grep defined $hdr{$_}, keys %hdr)
674 . "\015\012"
675 . (delete $arg{body})
676 );
677
678 # return if error occured during push_write()
679 return unless %state;
680
681 %hdr = (); # reduce memory usage, save a kitten, also make it possible to re-use
682
683 # status line and headers
684 $state{read_response} = sub {
685 for ("$_[1]") {
686 y/\015//d; # weed out any \015, as they show up in the weirdest of places.
687
688 /^HTTP\/0*([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\012]*) )? \012/gxci
689 or return (%state = (), $cb->(undef, { @pseudo, Status => 599, Reason => "Invalid server response" }));
690
691 # 100 Continue handling
692 # should not happen as we don't send expect: 100-continue,
693 # but we handle it just in case.
694 # since we send the request body regardless, if we get an error
695 # we are out of-sync, which we currently do NOT handle correctly.
696 return $state{handle}->push_read (line => $qr_nlnl, $state{read_response})
697 if $2 eq 100;
698
699 push @pseudo,
700 HTTPVersion => $1,
701 Status => $2,
702 Reason => $3,
703 ;
704
705 my $hdr = parse_hdr
706 or return (%state = (), $cb->(undef, { @pseudo, Status => 599, Reason => "Garbled response headers" }));
707
708 %hdr = (%$hdr, @pseudo);
709 }
710
711 # redirect handling
712 # microsoft and other shitheads don't give a shit for following standards,
713 # try to support some common forms of broken Location headers.
714 if ($hdr{location} !~ /^(?: $ | [^:\/?\#]+ : )/x) {
715 $hdr{location} =~ s/^\.\/+//;
716
717 my $url = "$rscheme://$uhost:$uport";
718
719 unless ($hdr{location} =~ s/^\///) {
720 $url .= $upath;
721 $url =~ s/\/[^\/]*$//;
722 }
723
724 $hdr{location} = "$url/$hdr{location}";
725 }
726
727 my $redirect;
728
729 if ($recurse) {
730 my $status = $hdr{Status};
731
732 # industry standard is to redirect POST as GET for
733 # 301, 302 and 303, in contrast to HTTP/1.0 and 1.1.
734 # also, the UA should ask the user for 301 and 307 and POST,
735 # industry standard seems to be to simply follow.
736 # we go with the industry standard.
737 if ($status == 301 or $status == 302 or $status == 303) {
738 # HTTP/1.1 is unclear on how to mutate the method
739 $method = "GET" unless $method eq "HEAD";
740 $redirect = 1;
741 } elsif ($status == 307) {
742 $redirect = 1;
743 }
744 }
745
746 my $finish = sub { # ($data, $err_status, $err_reason[, $keepalive])
747 my $may_keep_alive = $_[3];
748
749 $state{handle}->destroy if $state{handle};
750 %state = ();
751
752 if (defined $_[1]) {
753 $hdr{OrigStatus} = $hdr{Status}; $hdr{Status} = $_[1];
754 $hdr{OrigReason} = $hdr{Reason}; $hdr{Reason} = $_[2];
755 }
756
757 # set-cookie processing
758 if ($arg{cookie_jar}) {
759 cookie_jar_set_cookie $arg{cookie_jar}, $hdr{"set-cookie"}, $uhost, $hdr{date};
760 }
761
762 if ($redirect && exists $hdr{location}) {
763 # we ignore any errors, as it is very common to receive
764 # Content-Length != 0 but no actual body
765 # we also access %hdr, as $_[1] might be an erro
766 http_request (
767 $method => $hdr{location},
768 %arg,
769 recurse => $recurse - 1,
770 Redirect => [$_[0], \%hdr],
771 $cb);
772 } else {
773 $cb->($_[0], \%hdr);
774 }
775 };
776
777 $ae_error = 597; # body phase
778
779 my $len = $hdr{"content-length"};
780
781 if (!$redirect && $arg{on_header} && !$arg{on_header}(\%hdr)) {
782 $finish->(undef, 598 => "Request cancelled by on_header");
783 } elsif (
784 $hdr{Status} =~ /^(?:1..|204|205|304)$/
785 or $method eq "HEAD"
786 or (defined $len && !$len)
787 ) {
788 # no body
789 $finish->("", undef, undef, 1);
790 } else {
791 # body handling, many different code paths
792 # - no body expected
793 # - want_body_handle
794 # - te chunked
795 # - 2x length known (with or without on_body)
796 # - 2x length not known (with or without on_body)
797 if (!$redirect && $arg{want_body_handle}) {
798 $_[0]->on_eof (undef);
799 $_[0]->on_error (undef);
800 $_[0]->on_read (undef);
801
802 $finish->(delete $state{handle});
803
804 } elsif ($hdr{"transfer-encoding"} =~ /\bchunked\b/i) {
805 my $cl = 0;
806 my $body = undef;
807 my $on_body = $arg{on_body} || sub { $body .= shift; 1 };
808
809 $state{read_chunk} = sub {
810 $_[1] =~ /^([0-9a-fA-F]+)/
811 or $finish->(undef, $ae_error => "Garbled chunked transfer encoding");
812
813 my $len = hex $1;
814
815 if ($len) {
816 $cl += $len;
817
818 $_[0]->push_read (chunk => $len, sub {
819 $on_body->($_[1], \%hdr)
820 or return $finish->(undef, 598 => "Request cancelled by on_body");
821
822 $_[0]->push_read (line => sub {
823 length $_[1]
824 and return $finish->(undef, $ae_error => "Garbled chunked transfer encoding");
825 $_[0]->push_read (line => $state{read_chunk});
826 });
827 });
828 } else {
829 $hdr{"content-length"} ||= $cl;
830
831 $_[0]->push_read (line => $qr_nlnl, sub {
832 if (length $_[1]) {
833 for ("$_[1]") {
834 y/\015//d; # weed out any \015, as they show up in the weirdest of places.
835
836 my $hdr = parse_hdr
837 or return $finish->(undef, $ae_error => "Garbled response trailers");
838
839 %hdr = (%hdr, %$hdr);
840 }
841 }
842
843 $finish->($body, undef, undef, 1);
844 });
845 }
846 };
847
848 $_[0]->push_read (line => $state{read_chunk});
849
850 } elsif ($arg{on_body}) {
851 if ($len) {
852 $_[0]->on_read (sub {
853 $len -= length $_[0]{rbuf};
854
855 $arg{on_body}(delete $_[0]{rbuf}, \%hdr)
856 or return $finish->(undef, 598 => "Request cancelled by on_body");
857
858 $len > 0
859 or $finish->("", undef, undef, 1);
860 });
861 } else {
862 $_[0]->on_eof (sub {
863 $finish->("");
864 });
865 $_[0]->on_read (sub {
866 $arg{on_body}(delete $_[0]{rbuf}, \%hdr)
867 or $finish->(undef, 598 => "Request cancelled by on_body");
868 });
869 }
870 } else {
871 $_[0]->on_eof (undef);
872
873 if ($len) {
874 $_[0]->on_read (sub {
875 $finish->((substr delete $_[0]{rbuf}, 0, $len, ""), undef, undef, 1)
876 if $len <= length $_[0]{rbuf};
877 });
878 } else {
879 $_[0]->on_error (sub {
880 ($! == Errno::EPIPE || !$!)
881 ? $finish->(delete $_[0]{rbuf})
882 : $finish->(undef, $ae_error => $_[2]);
883 });
884 $_[0]->on_read (sub { });
885 }
886 }
887 }
888 };
889
890 $state{handle}->push_read (line => $qr_nlnl, $state{read_response});
891 };
472 892
473 my $connect_cb = sub { 893 my $connect_cb = sub {
474 $state{fh} = shift 894 $state{fh} = shift
475 or do { 895 or do {
476 my $err = "$!"; 896 my $err = "$!";
477 %state = (); 897 %state = ();
478 return $cb->(undef, { @pseudo, Status => 599, Reason => $err }); 898 return $cb->(undef, { @pseudo, Status => $ae_error, Reason => $err });
479 }; 899 };
480
481 pop; # free memory, save a tree
482 900
483 return unless delete $state{connect_guard}; 901 return unless delete $state{connect_guard};
484 902
485 # get handle 903 # get handle
486 $state{handle} = new AnyEvent::Handle 904 $state{handle} = new AnyEvent::Handle
… …
489 tls_ctx => $arg{tls_ctx}, 907 tls_ctx => $arg{tls_ctx},
490 # these need to be reconfigured on keepalive handles 908 # these need to be reconfigured on keepalive handles
491 timeout => $timeout, 909 timeout => $timeout,
492 on_error => sub { 910 on_error => sub {
493 %state = (); 911 %state = ();
494 $cb->(undef, { @pseudo, Status => 599, Reason => $_[2] }); 912 $cb->(undef, { @pseudo, Status => $ae_error, Reason => $_[2] });
495 }, 913 },
496 on_eof => sub { 914 on_eof => sub {
497 %state = (); 915 %state = ();
498 $cb->(undef, { @pseudo, Status => 599, Reason => "Unexpected end-of-file" }); 916 $cb->(undef, { @pseudo, Status => $ae_error, Reason => "Unexpected end-of-file" });
499 }, 917 },
500 ; 918 ;
501 919
502 # limit the number of persistent connections 920 # limit the number of persistent connections
503 # keepalive not yet supported 921 # keepalive not yet supported
… …
505# ++$KA_COUNT{$_[1]}; 923# ++$KA_COUNT{$_[1]};
506# $state{handle}{ka_count_guard} = AnyEvent::Util::guard { 924# $state{handle}{ka_count_guard} = AnyEvent::Util::guard {
507# --$KA_COUNT{$_[1]} 925# --$KA_COUNT{$_[1]}
508# }; 926# };
509# $hdr{connection} = "keep-alive"; 927# $hdr{connection} = "keep-alive";
510# } else {
511 delete $hdr{connection};
512# } 928# }
513 929
514 $state{handle}->starttls ("connect") if $rscheme eq "https"; 930 $state{handle}->starttls ("connect") if $rscheme eq "https";
515
516 # handle actual, non-tunneled, request
517 my $handle_actual_request = sub {
518 $state{handle}->starttls ("connect") if $uscheme eq "https" && !exists $state{handle}{tls};
519
520 # send request
521 $state{handle}->push_write (
522 "$method $rpath HTTP/1.0\015\012"
523 . (join "", map "\u$_: $hdr{$_}\015\012", grep defined $hdr{$_}, keys %hdr)
524 . "\015\012"
525 . (delete $arg{body})
526 );
527
528 # return if error occured during push_write()
529 return unless %state;
530
531 %hdr = (); # reduce memory usage, save a kitten, also make it possible to re-use
532
533 # status line and headers
534 $state{handle}->push_read (line => $qr_nlnl, sub {
535 my $keepalive = pop;
536
537 for ("$_[1]") {
538 y/\015//d; # weed out any \015, as they show up in the weirdest of places.
539
540 /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\015\012]*) )? \015?\012/igxc
541 or return (%state = (), $cb->(undef, { @pseudo, Status => 599, Reason => "Invalid server response" }));
542
543 push @pseudo,
544 HTTPVersion => $1,
545 Status => $2,
546 Reason => $3,
547 ;
548
549 # things seen, not parsed:
550 # p3pP="NON CUR OTPi OUR NOR UNI"
551
552 $hdr{lc $1} .= ",$2"
553 while /\G
554 ([^:\000-\037]*):
555 [\011\040]*
556 ((?: [^\012]+ | \012[\011\040] )*)
557 \012
558 /gxc;
559
560 /\G$/
561 or return (%state = (), $cb->(undef, { @pseudo, Status => 599, Reason => "Garbled response headers" }));
562 }
563
564 # remove the "," prefix we added to all headers above
565 substr $_, 0, 1, ""
566 for values %hdr;
567
568 # patch in all pseudo headers
569 %hdr = (%hdr, @pseudo);
570
571 # redirect handling
572 # microsoft and other shitheads don't give a shit for following standards,
573 # try to support some common forms of broken Location headers.
574 if ($hdr{location} !~ /^(?: $ | [^:\/?\#]+ : )/x) {
575 $hdr{location} =~ s/^\.\/+//;
576
577 my $url = "$rscheme://$uhost:$uport";
578
579 unless ($hdr{location} =~ s/^\///) {
580 $url .= $upath;
581 $url =~ s/\/[^\/]*$//;
582 }
583
584 $hdr{location} = "$url/$hdr{location}";
585 }
586
587 my $redirect;
588
589 if ($recurse) {
590 my $status = $hdr{Status};
591
592 # industry standard is to redirect POST as GET for
593 # 301, 302 and 303, in contrast to http/1.0 and 1.1.
594 # also, the UA should ask the user for 301 and 307 and POST,
595 # industry standard seems to be to simply follow.
596 # we go with the industry standard.
597 if ($status == 301 or $status == 302 or $status == 303) {
598 # HTTP/1.1 is unclear on how to mutate the method
599 $method = "GET" unless $method eq "HEAD";
600 $redirect = 1;
601 } elsif ($status == 307) {
602 $redirect = 1;
603 }
604 }
605
606 my $finish = sub { # ($data, $err_status, $err_reason[, $keepalive])
607 $state{handle}->destroy if $state{handle};
608 %state = ();
609
610 if (defined $_[1]) {
611 $hdr{OrigStatus} = $hdr{Status}; $hdr{Status} = $_[1];
612 $hdr{OrigReason} = $hdr{Reason}; $hdr{Reason} = $_[2];
613 }
614
615 # set-cookie processing
616 if ($arg{cookie_jar}) {
617 for ($hdr{"set-cookie"}) {
618 # parse NAME=VALUE
619 my @kv;
620
621 while (/\G\s* ([^=;,[:space:]]+) \s*=\s* (?: "((?:[^\\"]+|\\.)*)" | ([^=;,[:space:]]*) )/gcxs) {
622 my $name = $1;
623 my $value = $3;
624
625 unless ($value) {
626 $value = $2;
627 $value =~ s/\\(.)/$1/gs;
628 }
629
630 push @kv, $name => $value;
631
632 last unless /\G\s*;/gc;
633 }
634
635 last unless @kv;
636
637 my $name = shift @kv;
638 my %kv = (value => shift @kv, @kv);
639
640 my $cdom;
641 my $cpath = (delete $kv{path}) || "/";
642
643 if (exists $kv{domain}) {
644 $cdom = delete $kv{domain};
645
646 $cdom =~ s/^\.?/./; # make sure it starts with a "."
647
648 next if $cdom =~ /\.$/;
649
650 # this is not rfc-like and not netscape-like. go figure.
651 my $ndots = $cdom =~ y/.//;
652 next if $ndots < ($cdom =~ /\.[^.][^.]\.[^.][^.]$/ ? 3 : 2);
653 } else {
654 $cdom = $uhost;
655 }
656
657 # store it
658 $arg{cookie_jar}{version} = 1;
659 $arg{cookie_jar}{$cdom}{$cpath}{$name} = \%kv;
660
661 redo if /\G\s*,/gc;
662 }
663 }
664
665 if ($redirect && exists $hdr{location}) {
666 # we ignore any errors, as it is very common to receive
667 # Content-Length != 0 but no actual body
668 # we also access %hdr, as $_[1] might be an erro
669 http_request (
670 $method => $hdr{location},
671 %arg,
672 recurse => $recurse - 1,
673 Redirect => [$_[0], \%hdr],
674 $cb);
675 } else {
676 $cb->($_[0], \%hdr);
677 }
678 };
679
680 my $len = $hdr{"content-length"};
681
682 if (!$redirect && $arg{on_header} && !$arg{on_header}(\%hdr)) {
683 $finish->(undef, 598 => "Request cancelled by on_header");
684 } elsif (
685 $hdr{Status} =~ /^(?:1..|204|205|304)$/
686 or $method eq "HEAD"
687 or (defined $len && !$len)
688 ) {
689 # no body
690 $finish->("", undef, undef, 1);
691 } else {
692 # body handling, four different code paths
693 # for want_body_handle, on_body (2x), normal (2x)
694 # we might read too much here, but it does not matter yet (no pipelining)
695 if (!$redirect && $arg{want_body_handle}) {
696 $_[0]->on_eof (undef);
697 $_[0]->on_error (undef);
698 $_[0]->on_read (undef);
699
700 $finish->(delete $state{handle});
701
702 } elsif ($arg{on_body}) {
703 $_[0]->on_error (sub { $finish->(undef, 599 => $_[2]) });
704 if ($len) {
705 $_[0]->on_read (sub {
706 $len -= length $_[0]{rbuf};
707
708 $arg{on_body}(delete $_[0]{rbuf}, \%hdr)
709 or $finish->(undef, 598 => "Request cancelled by on_body");
710
711 $len > 0
712 or $finish->("", undef, undef, 1);
713 });
714 } else {
715 $_[0]->on_eof (sub {
716 $finish->("");
717 });
718 $_[0]->on_read (sub {
719 $arg{on_body}(delete $_[0]{rbuf}, \%hdr)
720 or $finish->(undef, 598 => "Request cancelled by on_body");
721 });
722 }
723 } else {
724 $_[0]->on_eof (undef);
725
726 if ($len) {
727 $_[0]->on_error (sub { $finish->(undef, 599 => $_[2]) });
728 $_[0]->on_read (sub {
729 $finish->((substr delete $_[0]{rbuf}, 0, $len, ""), undef, undef, 1)
730 if $len <= length $_[0]{rbuf};
731 });
732 } else {
733 $_[0]->on_error (sub {
734 ($! == Errno::EPIPE || !$!)
735 ? $finish->(delete $_[0]{rbuf})
736 : $finish->(undef, 599 => $_[2]);
737 });
738 $_[0]->on_read (sub { });
739 }
740 }
741 }
742 });
743 };
744 931
745 # now handle proxy-CONNECT method 932 # now handle proxy-CONNECT method
746 if ($proxy && $uscheme eq "https") { 933 if ($proxy && $uscheme eq "https") {
747 # oh dear, we have to wrap it into a connect request 934 # oh dear, we have to wrap it into a connect request
748 935
… …
752 $_[1] =~ /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\015\012]*) )?/ix 939 $_[1] =~ /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\015\012]*) )?/ix
753 or return (%state = (), $cb->(undef, { @pseudo, Status => 599, Reason => "Invalid proxy connect response ($_[1])" })); 940 or return (%state = (), $cb->(undef, { @pseudo, Status => 599, Reason => "Invalid proxy connect response ($_[1])" }));
754 941
755 if ($2 == 200) { 942 if ($2 == 200) {
756 $rpath = $upath; 943 $rpath = $upath;
757 &$handle_actual_request; 944 $handle_actual_request->();
758 } else { 945 } else {
759 %state = (); 946 %state = ();
760 $cb->(undef, { @pseudo, Status => $2, Reason => $3 }); 947 $cb->(undef, { @pseudo, Status => $2, Reason => $3 });
761 } 948 }
762 }); 949 });
763 } else { 950 } else {
764 &$handle_actual_request; 951 $handle_actual_request->();
765 } 952 }
766 }; 953 };
767 954
768 my $tcp_connect = $arg{tcp_connect} 955 my $tcp_connect = $arg{tcp_connect}
769 || do { require AnyEvent::Socket; \&AnyEvent::Socket::tcp_connect }; 956 || do { require AnyEvent::Socket; \&AnyEvent::Socket::tcp_connect };
770 957
771 $state{connect_guard} = $tcp_connect->($rhost, $rport, $connect_cb, $arg{on_prepare} || sub { $timeout }); 958 $state{connect_guard} = $tcp_connect->($rhost, $rport, $connect_cb, $arg{on_prepare} || sub { $timeout });
772
773 }; 959 };
774 960
775 defined wantarray && AnyEvent::Util::guard { %state = () } 961 defined wantarray && AnyEvent::Util::guard { %state = () }
776} 962}
777 963
… …
812string of the form C<http://host:port> (optionally C<https:...>), croaks 998string of the form C<http://host:port> (optionally C<https:...>), croaks
813otherwise. 999otherwise.
814 1000
815To clear an already-set proxy, use C<undef>. 1001To clear an already-set proxy, use C<undef>.
816 1002
1003=item AnyEvent::HTTP::cookie_jar_expire $jar[, $session_end]
1004
1005Remove all cookies from the cookie jar that have been expired. If
1006C<$session_end> is given and true, then additionally remove all session
1007cookies.
1008
1009You should call this function (with a true C<$session_end>) before you
1010save cookies to disk, and you should call this function after loading them
1011again. If you have a long-running program you can additonally call this
1012function from time to time.
1013
1014A cookie jar is initially an empty hash-reference that is managed by this
1015module. It's format is subject to change, but currently it is like this:
1016
1017The key C<version> has to contain C<1>, otherwise the hash gets
1018emptied. All other keys are hostnames or IP addresses pointing to
1019hash-references. The key for these inner hash references is the
1020server path for which this cookie is meant, and the values are again
1021hash-references. The keys of those hash-references is the cookie name, and
1022the value, you guessed it, is another hash-reference, this time with the
1023key-value pairs from the cookie, except for C<expires> and C<max-age>,
1024which have been replaced by a C<_expires> key that contains the cookie
1025expiry timestamp.
1026
1027Here is an example of a cookie jar with a single cookie, so you have a
1028chance of understanding the above paragraph:
1029
1030 {
1031 version => 1,
1032 "10.0.0.1" => {
1033 "/" => {
1034 "mythweb_id" => {
1035 _expires => 1293917923,
1036 value => "ooRung9dThee3ooyXooM1Ohm",
1037 },
1038 },
1039 },
1040 }
1041
817=item $date = AnyEvent::HTTP::format_date $timestamp 1042=item $date = AnyEvent::HTTP::format_date $timestamp
818 1043
819Takes a POSIX timestamp (seconds since the epoch) and formats it as a HTTP 1044Takes a POSIX timestamp (seconds since the epoch) and formats it as a HTTP
820Date (RFC 2616). 1045Date (RFC 2616).
821 1046
822=item $timestamp = AnyEvent::HTTP::parse_date $date 1047=item $timestamp = AnyEvent::HTTP::parse_date $date
823 1048
824Takes a HTTP Date (RFC 2616) and returns the corresponding POSIX 1049Takes a HTTP Date (RFC 2616) or a Cookie date (netscape cookie spec) or a
1050bunch of minor variations of those, and returns the corresponding POSIX
825timestamp, or C<undef> if the date cannot be parsed. 1051timestamp, or C<undef> if the date cannot be parsed.
826 1052
827=item $AnyEvent::HTTP::MAX_RECURSE 1053=item $AnyEvent::HTTP::MAX_RECURSE
828 1054
829The default value for the C<recurse> request parameter (default: C<10>). 1055The default value for the C<recurse> request parameter (default: C<10>).
… …
869sub parse_date($) { 1095sub parse_date($) {
870 my ($date) = @_; 1096 my ($date) = @_;
871 1097
872 my ($d, $m, $y, $H, $M, $S); 1098 my ($d, $m, $y, $H, $M, $S);
873 1099
874 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$/) { 1100 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$/) {
875 # RFC 822/1123, required by RFC 2616 1101 # RFC 822/1123, required by RFC 2616 (with " ")
1102 # cookie dates (with "-")
1103
876 ($d, $m, $y, $H, $M, $S) = ($1, $2, $3, $4, $5, $6); 1104 ($d, $m, $y, $H, $M, $S) = ($1, $2, $3, $4, $5, $6);
877 1105
878 } 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$/) { 1106 } 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$/) {
879 # RFC 850 1107 # RFC 850
880 ($d, $m, $y, $H, $M, $S) = ($1, $2, $3 < 69 ? $3 + 2000 : $3 + 1900, $4, $5, $6); 1108 ($d, $m, $y, $H, $M, $S) = ($1, $2, $3 < 69 ? $3 + 2000 : $3 + 1900, $4, $5, $6);
881 1109
882 } 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])$/) { 1110 } 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])$/) {
883 # ISO C's asctime 1111 # ISO C's asctime
884 ($d, $m, $y, $H, $M, $S) = ($2, $1, $6, $3, $4, $5); 1112 ($d, $m, $y, $H, $M, $S) = ($2, $1, $6, $3, $4, $5);
885 } 1113 }
886 # other formats fail in the loop below 1114 # other formats fail in the loop below
887 1115

Diff Legend

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