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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines