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.65 by root, Fri Dec 31 03:47:32 2010 UTC vs.
Revision 1.81 by root, Sun Jan 2 01:20:17 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 %$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 unless (defined $name) {
488 # expires
489 $name = "expires";
490 $value = $1;
491 } elsif (!defined $value) {
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
472 663
473 my $connect_cb = sub { 664 my $connect_cb = sub {
474 $state{fh} = shift 665 $state{fh} = shift
475 or do { 666 or do {
476 my $err = "$!"; 667 my $err = "$!";
477 %state = (); 668 %state = ();
478 return $cb->(undef, { @pseudo, Status => 599, Reason => $err }); 669 return $cb->(undef, { @pseudo, Status => $ae_error, Reason => $err });
479 }; 670 };
480
481 pop; # free memory, save a tree
482 671
483 return unless delete $state{connect_guard}; 672 return unless delete $state{connect_guard};
484 673
485 # get handle 674 # get handle
486 $state{handle} = new AnyEvent::Handle 675 $state{handle} = new AnyEvent::Handle
… …
489 tls_ctx => $arg{tls_ctx}, 678 tls_ctx => $arg{tls_ctx},
490 # these need to be reconfigured on keepalive handles 679 # these need to be reconfigured on keepalive handles
491 timeout => $timeout, 680 timeout => $timeout,
492 on_error => sub { 681 on_error => sub {
493 %state = (); 682 %state = ();
494 $cb->(undef, { @pseudo, Status => 599, Reason => $_[2] }); 683 $cb->(undef, { @pseudo, Status => $ae_error, Reason => $_[2] });
495 }, 684 },
496 on_eof => sub { 685 on_eof => sub {
497 %state = (); 686 %state = ();
498 $cb->(undef, { @pseudo, Status => 599, Reason => "Unexpected end-of-file" }); 687 $cb->(undef, { @pseudo, Status => $ae_error, Reason => "Unexpected end-of-file" });
499 }, 688 },
500 ; 689 ;
501 690
502 # limit the number of persistent connections 691 # limit the number of persistent connections
503 # keepalive not yet supported 692 # keepalive not yet supported
… …
505# ++$KA_COUNT{$_[1]}; 694# ++$KA_COUNT{$_[1]};
506# $state{handle}{ka_count_guard} = AnyEvent::Util::guard { 695# $state{handle}{ka_count_guard} = AnyEvent::Util::guard {
507# --$KA_COUNT{$_[1]} 696# --$KA_COUNT{$_[1]}
508# }; 697# };
509# $hdr{connection} = "keep-alive"; 698# $hdr{connection} = "keep-alive";
510# } else {
511 delete $hdr{connection};
512# } 699# }
513 700
514 $state{handle}->starttls ("connect") if $rscheme eq "https"; 701 $state{handle}->starttls ("connect") if $rscheme eq "https";
515 702
516 # handle actual, non-tunneled, request 703 # handle actual, non-tunneled, request
517 my $handle_actual_request = sub { 704 my $handle_actual_request = sub {
705 $ae_error = 596; # request phase
706
518 $state{handle}->starttls ("connect") if $uscheme eq "https" && !exists $state{handle}{tls}; 707 $state{handle}->starttls ("connect") if $uscheme eq "https" && !exists $state{handle}{tls};
519 708
520 # send request 709 # send request
521 $state{handle}->push_write ( 710 $state{handle}->push_write (
522 "$method $rpath HTTP/1.0\015\012" 711 "$method $rpath HTTP/1.1\015\012"
523 . (join "", map "\u$_: $hdr{$_}\015\012", grep defined $hdr{$_}, keys %hdr) 712 . (join "", map "\u$_: $hdr{$_}\015\012", grep defined $hdr{$_}, keys %hdr)
524 . "\015\012" 713 . "\015\012"
525 . (delete $arg{body}) 714 . (delete $arg{body})
526 ); 715 );
527 716
… …
529 return unless %state; 718 return unless %state;
530 719
531 %hdr = (); # reduce memory usage, save a kitten, also make it possible to re-use 720 %hdr = (); # reduce memory usage, save a kitten, also make it possible to re-use
532 721
533 # status line and headers 722 # status line and headers
534 $state{handle}->push_read (line => $qr_nlnl, sub { 723 $state{read_response} = sub {
535 my $keepalive = pop;
536
537 for ("$_[1]") { 724 for ("$_[1]") {
538 y/\015//d; # weed out any \015, as they show up in the weirdest of places. 725 y/\015//d; # weed out any \015, as they show up in the weirdest of places.
539 726
540 /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\015\012]*) )? \015?\012/igxc 727 /^HTTP\/0*([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\012]*) )? \012/gxci
541 or return (%state = (), $cb->(undef, { @pseudo, Status => 599, Reason => "Invalid server response" })); 728 or return (%state = (), $cb->(undef, { @pseudo, Status => 599, Reason => "Invalid server response" }));
729
730 # 100 Continue handling
731 # should not happen as we don't send expect: 100-continue,
732 # but we handle it just in case.
733 # since we send the request body regardless, if we get an error
734 # we are out of-sync, which we currently do NOT handle correctly.
735 return $state{handle}->push_read (line => $qr_nlnl, $state{read_response})
736 if $2 eq 100;
542 737
543 push @pseudo, 738 push @pseudo,
544 HTTPVersion => $1, 739 HTTPVersion => $1,
545 Status => $2, 740 Status => $2,
546 Reason => $3, 741 Reason => $3,
547 ; 742 ;
548 743
549 # things seen, not parsed: 744 my $hdr = parse_hdr
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" })); 745 or return (%state = (), $cb->(undef, { @pseudo, Status => 599, Reason => "Garbled response headers" }));
746
747 %hdr = (%$hdr, @pseudo);
562 } 748 }
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 749
571 # redirect handling 750 # redirect handling
572 # microsoft and other shitheads don't give a shit for following standards, 751 # microsoft and other shitheads don't give a shit for following standards,
573 # try to support some common forms of broken Location headers. 752 # try to support some common forms of broken Location headers.
574 if ($hdr{location} !~ /^(?: $ | [^:\/?\#]+ : )/x) { 753 if ($hdr{location} !~ /^(?: $ | [^:\/?\#]+ : )/x) {
… …
588 767
589 if ($recurse) { 768 if ($recurse) {
590 my $status = $hdr{Status}; 769 my $status = $hdr{Status};
591 770
592 # industry standard is to redirect POST as GET for 771 # industry standard is to redirect POST as GET for
593 # 301, 302 and 303, in contrast to http/1.0 and 1.1. 772 # 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, 773 # also, the UA should ask the user for 301 and 307 and POST,
595 # industry standard seems to be to simply follow. 774 # industry standard seems to be to simply follow.
596 # we go with the industry standard. 775 # we go with the industry standard.
597 if ($status == 301 or $status == 302 or $status == 303) { 776 if ($status == 301 or $status == 302 or $status == 303) {
598 # HTTP/1.1 is unclear on how to mutate the method 777 # HTTP/1.1 is unclear on how to mutate the method
… …
602 $redirect = 1; 781 $redirect = 1;
603 } 782 }
604 } 783 }
605 784
606 my $finish = sub { # ($data, $err_status, $err_reason[, $keepalive]) 785 my $finish = sub { # ($data, $err_status, $err_reason[, $keepalive])
786 my $may_keep_alive = $_[3];
787
607 $state{handle}->destroy if $state{handle}; 788 $state{handle}->destroy if $state{handle};
608 %state = (); 789 %state = ();
609 790
610 if (defined $_[1]) { 791 if (defined $_[1]) {
611 $hdr{OrigStatus} = $hdr{Status}; $hdr{Status} = $_[1]; 792 $hdr{OrigStatus} = $hdr{Status}; $hdr{Status} = $_[1];
612 $hdr{OrigReason} = $hdr{Reason}; $hdr{Reason} = $_[2]; 793 $hdr{OrigReason} = $hdr{Reason}; $hdr{Reason} = $_[2];
613 } 794 }
614 795
615 # set-cookie processing 796 # set-cookie processing
616 if ($arg{cookie_jar}) { 797 if ($arg{cookie_jar}) {
617 for ($hdr{"set-cookie"}) { 798 cookie_jar_set_cookie $arg{cookie_jar}, $hdr{"set-cookie"}, $uhost, $hdr{date};
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 } 799 }
664 800
665 if ($redirect && exists $hdr{location}) { 801 if ($redirect && exists $hdr{location}) {
666 # we ignore any errors, as it is very common to receive 802 # we ignore any errors, as it is very common to receive
667 # Content-Length != 0 but no actual body 803 # Content-Length != 0 but no actual body
… …
675 } else { 811 } else {
676 $cb->($_[0], \%hdr); 812 $cb->($_[0], \%hdr);
677 } 813 }
678 }; 814 };
679 815
816 $ae_error = 597; # body phase
817
680 my $len = $hdr{"content-length"}; 818 my $len = $hdr{"content-length"};
681 819
682 if (!$redirect && $arg{on_header} && !$arg{on_header}(\%hdr)) { 820 if (!$redirect && $arg{on_header} && !$arg{on_header}(\%hdr)) {
683 $finish->(undef, 598 => "Request cancelled by on_header"); 821 $finish->(undef, 598 => "Request cancelled by on_header");
684 } elsif ( 822 } elsif (
… …
687 or (defined $len && !$len) 825 or (defined $len && !$len)
688 ) { 826 ) {
689 # no body 827 # no body
690 $finish->("", undef, undef, 1); 828 $finish->("", undef, undef, 1);
691 } else { 829 } else {
692 # body handling, four different code paths 830 # body handling, many different code paths
693 # for want_body_handle, on_body (2x), normal (2x) 831 # - no body expected
694 # we might read too much here, but it does not matter yet (no pipelining) 832 # - want_body_handle
833 # - te chunked
834 # - 2x length known (with or without on_body)
835 # - 2x length not known (with or without on_body)
695 if (!$redirect && $arg{want_body_handle}) { 836 if (!$redirect && $arg{want_body_handle}) {
696 $_[0]->on_eof (undef); 837 $_[0]->on_eof (undef);
697 $_[0]->on_error (undef); 838 $_[0]->on_error (undef);
698 $_[0]->on_read (undef); 839 $_[0]->on_read (undef);
699 840
700 $finish->(delete $state{handle}); 841 $finish->(delete $state{handle});
701 842
843 } elsif ($hdr{"transfer-encoding"} =~ /\bchunked\b/i) {
844 my $cl = 0;
845 my $body = undef;
846 my $on_body = $arg{on_body} || sub { $body .= shift; 1 };
847
848 $state{read_chunk} = sub {
849 $_[1] =~ /^([0-9a-fA-F]+)/
850 or $finish->(undef, $ae_error => "Garbled chunked transfer encoding");
851
852 my $len = hex $1;
853
854 if ($len) {
855 $cl += $len;
856
857 $_[0]->push_read (chunk => $len, sub {
858 $on_body->($_[1], \%hdr)
859 or return $finish->(undef, 598 => "Request cancelled by on_body");
860
861 $_[0]->push_read (line => sub {
862 length $_[1]
863 and return $finish->(undef, $ae_error => "Garbled chunked transfer encoding");
864 $_[0]->push_read (line => $state{read_chunk});
865 });
866 });
867 } else {
868 $hdr{"content-length"} ||= $cl;
869
870 $_[0]->push_read (line => $qr_nlnl, sub {
871 if (length $_[1]) {
872 for ("$_[1]") {
873 y/\015//d; # weed out any \015, as they show up in the weirdest of places.
874
875 my $hdr = parse_hdr
876 or return $finish->(undef, $ae_error => "Garbled response trailers");
877
878 %hdr = (%hdr, %$hdr);
879 }
880 }
881
882 $finish->($body, undef, undef, 1);
883 });
884 }
885 };
886
887 $_[0]->push_read (line => $state{read_chunk});
888
702 } elsif ($arg{on_body}) { 889 } elsif ($arg{on_body}) {
703 $_[0]->on_error (sub { $finish->(undef, 599 => $_[2]) });
704 if ($len) { 890 if ($len) {
705 $_[0]->on_read (sub { 891 $_[0]->on_read (sub {
706 $len -= length $_[0]{rbuf}; 892 $len -= length $_[0]{rbuf};
707 893
708 $arg{on_body}(delete $_[0]{rbuf}, \%hdr) 894 $arg{on_body}(delete $_[0]{rbuf}, \%hdr)
709 or $finish->(undef, 598 => "Request cancelled by on_body"); 895 or return $finish->(undef, 598 => "Request cancelled by on_body");
710 896
711 $len > 0 897 $len > 0
712 or $finish->("", undef, undef, 1); 898 or $finish->("", undef, undef, 1);
713 }); 899 });
714 } else { 900 } else {
… …
722 } 908 }
723 } else { 909 } else {
724 $_[0]->on_eof (undef); 910 $_[0]->on_eof (undef);
725 911
726 if ($len) { 912 if ($len) {
727 $_[0]->on_error (sub { $finish->(undef, 599 => $_[2]) });
728 $_[0]->on_read (sub { 913 $_[0]->on_read (sub {
729 $finish->((substr delete $_[0]{rbuf}, 0, $len, ""), undef, undef, 1) 914 $finish->((substr delete $_[0]{rbuf}, 0, $len, ""), undef, undef, 1)
730 if $len <= length $_[0]{rbuf}; 915 if $len <= length $_[0]{rbuf};
731 }); 916 });
732 } else { 917 } else {
733 $_[0]->on_error (sub { 918 $_[0]->on_error (sub {
734 ($! == Errno::EPIPE || !$!) 919 ($! == Errno::EPIPE || !$!)
735 ? $finish->(delete $_[0]{rbuf}) 920 ? $finish->(delete $_[0]{rbuf})
736 : $finish->(undef, 599 => $_[2]); 921 : $finish->(undef, $ae_error => $_[2]);
737 }); 922 });
738 $_[0]->on_read (sub { }); 923 $_[0]->on_read (sub { });
739 } 924 }
740 } 925 }
741 } 926 }
742 }); 927 };
928
929 $state{handle}->push_read (line => $qr_nlnl, $state{read_response});
743 }; 930 };
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
… …
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 };
… …
812string of the form C<http://host:port> (optionally C<https:...>), croaks 999string of the form C<http://host:port> (optionally C<https:...>), croaks
813otherwise. 1000otherwise.
814 1001
815To clear an already-set proxy, use C<undef>. 1002To clear an already-set proxy, use C<undef>.
816 1003
1004=item AnyEvent::HTTP::cookie_jar_expire $jar[, $session_end]
1005
1006Remove all cookies from the cookie jar that have been expired. If
1007C<$session_end> is given and true, then additionally remove all session
1008cookies.
1009
1010You should call this function (with a true C<$session_end>) before you
1011save cookies to disk, and you should call this function after loading them
1012again. If you have a long-running program you can additonally call this
1013function from time to time.
1014
1015A cookie jar is initially an empty hash-reference that is managed by this
1016module. It's format is subject to change, but currently it is like this:
1017
1018The key C<version> has to contain C<1>, otherwise the hash gets
1019emptied. All other keys are hostnames or IP addresses pointing to
1020hash-references. The key for these inner hash references is the
1021server path for which this cookie is meant, and the values are again
1022hash-references. The keys of those hash-references is the cookie name, and
1023the value, you guessed it, is another hash-reference, this time with the
1024key-value pairs from the cookie, except for C<expires> and C<max-age>,
1025which have been replaced by a C<_expires> key that contains the cookie
1026expiry timestamp.
1027
1028Here is an example of a cookie jar with a single cookie, so you have a
1029chance of understanding the above paragraph:
1030
1031 {
1032 version => 1,
1033 "10.0.0.1" => {
1034 "/" => {
1035 "mythweb_id" => {
1036 _expires => 1293917923,
1037 value => "ooRung9dThee3ooyXooM1Ohm",
1038 },
1039 },
1040 },
1041 }
1042
817=item $date = AnyEvent::HTTP::format_date $timestamp 1043=item $date = AnyEvent::HTTP::format_date $timestamp
818 1044
819Takes a POSIX timestamp (seconds since the epoch) and formats it as a HTTP 1045Takes a POSIX timestamp (seconds since the epoch) and formats it as a HTTP
820Date (RFC 2616). 1046Date (RFC 2616).
821 1047
822=item $timestamp = AnyEvent::HTTP::parse_date $date 1048=item $timestamp = AnyEvent::HTTP::parse_date $date
823 1049
824Takes a HTTP Date (RFC 2616) and returns the corresponding POSIX 1050Takes a HTTP Date (RFC 2616) or a Cookie date (netscape cookie spec) or a
1051bunch of minor variations of those, and returns the corresponding POSIX
825timestamp, or C<undef> if the date cannot be parsed. 1052timestamp, or C<undef> if the date cannot be parsed.
826 1053
827=item $AnyEvent::HTTP::MAX_RECURSE 1054=item $AnyEvent::HTTP::MAX_RECURSE
828 1055
829The default value for the C<recurse> request parameter (default: C<10>). 1056The default value for the C<recurse> request parameter (default: C<10>).
… …
869sub parse_date($) { 1096sub parse_date($) {
870 my ($date) = @_; 1097 my ($date) = @_;
871 1098
872 my ($d, $m, $y, $H, $M, $S); 1099 my ($d, $m, $y, $H, $M, $S);
873 1100
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$/) { 1101 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 1102 # RFC 822/1123, required by RFC 2616 (with " ")
1103 # cookie dates (with "-")
1104
876 ($d, $m, $y, $H, $M, $S) = ($1, $2, $3, $4, $5, $6); 1105 ($d, $m, $y, $H, $M, $S) = ($1, $2, $3, $4, $5, $6);
877 1106
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$/) { 1107 } 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 1108 # RFC 850
880 ($d, $m, $y, $H, $M, $S) = ($1, $2, $3 < 69 ? $3 + 2000 : $3 + 1900, $4, $5, $6); 1109 ($d, $m, $y, $H, $M, $S) = ($1, $2, $3 < 69 ? $3 + 2000 : $3 + 1900, $4, $5, $6);
881 1110
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])$/) { 1111 } 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 1112 # ISO C's asctime
884 ($d, $m, $y, $H, $M, $S) = ($2, $1, $6, $3, $4, $5); 1113 ($d, $m, $y, $H, $M, $S) = ($2, $1, $6, $3, $4, $5);
885 } 1114 }
886 # other formats fail in the loop below 1115 # other formats fail in the loop below
887 1116

Diff Legend

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