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.67 by root, Fri Dec 31 06:18:54 2010 UTC vs.
Revision 1.90 by root, Mon Jan 3 00:41:25 2011 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines