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.60 by root, Thu Dec 30 02:56:28 2010 UTC vs.
Revision 1.79 by root, Sat Jan 1 20:01:07 2011 UTC

47use AnyEvent::Util (); 47use AnyEvent::Util ();
48use AnyEvent::Handle (); 48use AnyEvent::Handle ();
49 49
50use base Exporter::; 50use base Exporter::;
51 51
52our $VERSION = '1.46'; 52our $VERSION = '1.5';
53 53
54our @EXPORT = qw(http_get http_post http_head http_request); 54our @EXPORT = qw(http_get http_post http_head http_request);
55 55
56our $USERAGENT = "Mozilla/5.0 (compatible; U; AnyEvent-HTTP/$VERSION; +http://software.schmorp.de/pkg/AnyEvent)"; 56our $USERAGENT = "Mozilla/5.0 (compatible; U; AnyEvent-HTTP/$VERSION; +http://software.schmorp.de/pkg/AnyEvent)";
57our $MAX_RECURSE = 10; 57our $MAX_RECURSE = 10;
94C<http_request> returns a "cancellation guard" - you have to keep the 94C<http_request> returns a "cancellation guard" - you have to keep the
95object at least alive until the callback get called. If the object gets 95object at least alive until the callback get called. If the object gets
96destroyed before the callback is called, the request will be cancelled. 96destroyed before the callback is called, the request will be cancelled.
97 97
98The callback will be called with the response body data as first argument 98The callback will be called with the response body data as first argument
99(or C<undef> if an error occured), and a hash-ref with response headers as 99(or C<undef> if an error occured), and a hash-ref with response headers
100second argument. 100(and trailers) as second argument.
101 101
102All the headers in that hash are lowercased. In addition to the response 102All the headers in that hash are lowercased. In addition to the response
103headers, the "pseudo-headers" (uppercase to avoid clashing with possible 103headers, the "pseudo-headers" (uppercase to avoid clashing with possible
104response headers) C<HTTPVersion>, C<Status> and C<Reason> contain the 104response headers) C<HTTPVersion>, C<Status> and C<Reason> contain the
105three parts of the HTTP Status-Line of the same name. 105three parts of the HTTP Status-Line of the same name. If an error occurs
106during the body phase of a request, then the original C<Status> and
107C<Reason> values from the header are available as C<OrigStatus> and
108C<OrigReason>.
106 109
107The pseudo-header C<URL> contains the actual URL (which can differ from 110The pseudo-header C<URL> contains the actual URL (which can differ from
108the requested URL when following redirects - for example, you might get 111the requested URL when following redirects - for example, you might get
109an error that your URL scheme is not supported even though your URL is a 112an error that your URL scheme is not supported even though your URL is a
110valid http URL because it redirected to an ftp URL, in which case you can 113valid http URL because it redirected to an ftp URL, in which case you can
119 122
120If 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
121joined together with a comma (C<,>), as per the HTTP spec. 124joined together with a comma (C<,>), as per the HTTP spec.
122 125
123If 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,
124then 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
125(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
126message. 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
127 144
128A typical callback might look like this: 145A typical callback might look like this:
129 146
130 sub { 147 sub {
131 my ($body, $hdr) = @_; 148 my ($body, $hdr) = @_;
147Whether to recurse requests or not, e.g. on redirects, authentication 164Whether to recurse requests or not, e.g. on redirects, authentication
148retries and so on, and how often to do so. 165retries and so on, and how often to do so.
149 166
150=item headers => hashref 167=item headers => hashref
151 168
152The request headers to use. Currently, C<http_request> may provide its 169The request headers to use. Currently, C<http_request> may provide its own
153own C<Host:>, C<Content-Length:>, C<Connection:> and C<Cookie:> headers 170C<Host:>, C<Content-Length:>, C<Connection:> and C<Cookie:> headers and
154and 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:>
155suppressed 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
156sent at all). 173they won't be sent at all).
157 174
158=item timeout => $seconds 175=item timeout => $seconds
159 176
160The 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
161the 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
171C<$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
172HTTPS. 189HTTPS.
173 190
174=item body => $string 191=item body => $string
175 192
176The 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
177this module might offer more options). 194this module might offer more options).
178 195
179=item cookie_jar => $hash_ref 196=item cookie_jar => $hash_ref
180 197
181Passing this parameter enables (simplified) cookie-processing, loosely 198Passing this parameter enables (simplified) cookie-processing, loosely
182based on the original netscape specification. 199based on the original netscape specification.
183 200
184The C<$hash_ref> must be an (initially empty) hash reference which will 201The C<$hash_ref> must be an (initially empty) hash reference which will
185get updated automatically. It is possible to save the cookie_jar to 202get updated automatically. It is possible to save the cookie jar to
186persistent storage with something like JSON or Storable, but this is not 203persistent storage with something like JSON or Storable, but this is not
187recommended, as expiry times are currently being ignored. 204recommended, as session-only cookies might survive longer than expected.
188 205
189Note that this cookie implementation is not of very high quality, nor 206Note that this cookie implementation is not meant to be complete. If
190meant to be complete. If you want complete cookie management you have to 207you want complete cookie management you have to do that on your
191do that on your own. C<cookie_jar> is meant as a quick fix to get some 208own. C<cookie_jar> is meant as a quick fix to get some cookie-using sites
192cookie-using sites working. Cookies are a privacy disaster, do not use 209working. Cookies are a privacy disaster, do not use them unless required
193them unless required to. 210to.
211
212When cookie processing is enabled, the C<Cookie:> and C<Set-Cookie:>
213headers will be set and handled by this module, otherwise they will be
214left untouched.
194 215
195=item tls_ctx => $scheme | $tls_ctx 216=item tls_ctx => $scheme | $tls_ctx
196 217
197Specifies the AnyEvent::TLS context to be used for https connections. This 218Specifies the AnyEvent::TLS context to be used for https connections. This
198parameter follows the same rules as the C<tls_ctx> parameter to 219parameter follows the same rules as the C<tls_ctx> parameter to
237 258
238This callback is useful, among other things, to quickly reject unwanted 259This callback is useful, among other things, to quickly reject unwanted
239content, which, if it is supposed to be rare, can be faster than first 260content, which, if it is supposed to be rare, can be faster than first
240doing a C<HEAD> request. 261doing a C<HEAD> request.
241 262
263The downside is that cancelling the request makes it impossible to re-use
264the connection. Also, the C<on_header> callback will not receive any
265trailer (headers sent after the response body).
266
242Example: cancel the request unless the content-type is "text/html". 267Example: cancel the request unless the content-type is "text/html".
243 268
244 on_header => sub { 269 on_header => sub {
245 $_[0]{"content-type"} =~ /^text\/html\s*(?:;|$)/ 270 $_[0]{"content-type"} =~ /^text\/html\s*(?:;|$)/
246 }, 271 },
252string instead of the body data. 277string instead of the body data.
253 278
254It has to return either true (in which case AnyEvent::HTTP will continue), 279It has to return either true (in which case AnyEvent::HTTP will continue),
255or false, in which case AnyEvent::HTTP will cancel the download (and call 280or false, in which case AnyEvent::HTTP will cancel the download (and call
256the completion callback with an error code of C<598>). 281the completion callback with an error code of C<598>).
282
283The downside to cancelling the request is that it makes it impossible to
284re-use the connection.
257 285
258This callback is useful when the data is too large to be held in memory 286This callback is useful when the data is too large to be held in memory
259(so the callback writes it to a file) or when only some information should 287(so the callback writes it to a file) or when only some information should
260be extracted, or when the body should be processed incrementally. 288be extracted, or when the body should be processed incrementally.
261 289
287If you think you need this, first have a look at C<on_body>, to see if 315If you think you need this, first have a look at C<on_body>, to see if
288that doesn't solve your problem in a better way. 316that doesn't solve your problem in a better way.
289 317
290=back 318=back
291 319
292Example: make a simple HTTP GET request for http://www.nethype.de/ 320Example: do a simple HTTP GET request for http://www.nethype.de/ and print
321the response body.
293 322
294 http_request GET => "http://www.nethype.de/", sub { 323 http_request GET => "http://www.nethype.de/", sub {
295 my ($body, $hdr) = @_; 324 my ($body, $hdr) = @_;
296 print "$body\n"; 325 print "$body\n";
297 }; 326 };
298 327
299Example: make a HTTP HEAD request on https://www.google.com/, use a 328Example: do a HTTP HEAD request on https://www.google.com/, use a
300timeout of 30 seconds. 329timeout of 30 seconds.
301 330
302 http_request 331 http_request
303 GET => "https://www.google.com", 332 GET => "https://www.google.com",
304 timeout => 30, 333 timeout => 30,
307 use Data::Dumper; 336 use Data::Dumper;
308 print Dumper $hdr; 337 print Dumper $hdr;
309 } 338 }
310 ; 339 ;
311 340
312Example: make another simple HTTP GET request, but immediately try to 341Example: do another simple HTTP GET request, but immediately try to
313cancel it. 342cancel it.
314 343
315 my $request = http_request GET => "http://www.nethype.de/", sub { 344 my $request = http_request GET => "http://www.nethype.de/", sub {
316 my ($body, $hdr) = @_; 345 my ($body, $hdr) = @_;
317 print "$body\n"; 346 print "$body\n";
349 push @{ $CO_SLOT{$_[0]}[1] }, $_[1]; 378 push @{ $CO_SLOT{$_[0]}[1] }, $_[1];
350 379
351 _slot_schedule $_[0]; 380 _slot_schedule $_[0];
352} 381}
353 382
383# extract cookies from jar
384sub cookie_jar_extract($$$$) {
385 my ($jar, $uscheme, $uhost, $upath) = @_;
386
387 %$jar = () if $jar->{version} != 1;
388
389 my @cookies;
390
391 while (my ($chost, $paths) = each %$jar) {
392 next unless ref $paths;
393
394 if ($chost =~ /^\./) {
395 next unless $chost eq substr $uhost, -length $chost;
396 } elsif ($chost =~ /\./) {
397 next unless $chost eq $uhost;
398 } else {
399 next;
400 }
401
402 while (my ($cpath, $cookies) = each %$paths) {
403 next unless $cpath eq substr $upath, 0, length $cpath;
404
405 while (my ($cookie, $kv) = each %$cookies) {
406 next if $uscheme ne "https" && exists $kv->{secure};
407
408 if (exists $kv->{expires}) {
409 if (AE::now > parse_date ($kv->{expires})) {
410 delete $cookies->{$cookie};
411 next;
412 }
413 }
414
415 my $value = $kv->{value};
416
417 if ($value =~ /[=;,[:space:]]/) {
418 $value =~ s/([\\"])/\\$1/g;
419 $value = "\"$value\"";
420 }
421
422 push @cookies, "$cookie=$value";
423 }
424 }
425 }
426
427 \@cookies
428}
429
430# parse set_cookie header into jar
431sub cookie_jar_set_cookie($$$) {
432 my ($jar, $set_cookie, $uhost) = @_;
433
434 for ($set_cookie) {
435 # parse NAME=VALUE
436 my @kv;
437
438 # expires is not http-compliant in the original cookie-spec,
439 # we support the official date format and some extensions
440 while (
441 m{
442 \G\s*
443 (?:
444 expires \s*=\s* ([A-Z][a-z][a-z]+,\ [^,;]+)
445 | ([^=;,[:space:]]+) \s*=\s* (?: "((?:[^\\"]+|\\.)*)" | ([^=;,[:space:]]*) )
446 )
447 }gcxsi
448 ) {
449 my $name = $2;
450 my $value = $4;
451
452 unless (defined $name) {
453 # expires
454 $name = "expires";
455 $value = $1;
456 } elsif (!defined $value) {
457 # quoted
458 $value = $3;
459 $value =~ s/\\(.)/$1/gs;
460 }
461
462 push @kv, lc $name, $value;
463
464 last unless /\G\s*;/gc;
465 }
466
467 last unless @kv;
468
469 my $name = shift @kv;
470 my %kv = (value => shift @kv, @kv);
471
472 $kv{expires} ||= format_date (AE::now + $kv{"max-age"})
473 if exists $kv{"max-age"};
474
475 my $cdom;
476 my $cpath = (delete $kv{path}) || "/";
477
478 if (exists $kv{domain}) {
479 $cdom = delete $kv{domain};
480
481 $cdom =~ s/^\.?/./; # make sure it starts with a "."
482
483 next if $cdom =~ /\.$/;
484
485 # this is not rfc-like and not netscape-like. go figure.
486 my $ndots = $cdom =~ y/.//;
487 next if $ndots < ($cdom =~ /\.[^.][^.]\.[^.][^.]$/ ? 3 : 2);
488 } else {
489 $cdom = $uhost;
490 }
491
492 # store it
493 $jar->{version} = 1;
494 $jar->{$cdom}{$cpath}{$name} = \%kv;
495
496 redo if /\G\s*,/gc;
497 }
498}
499
500# continue to parse $_ for headers and place them into the arg
501sub parse_hdr() {
502 my %hdr;
503
504 # things seen, not parsed:
505 # p3pP="NON CUR OTPi OUR NOR UNI"
506
507 $hdr{lc $1} .= ",$2"
508 while /\G
509 ([^:\000-\037]*):
510 [\011\040]*
511 ((?: [^\012]+ | \012[\011\040] )*)
512 \012
513 /gxc;
514
515 /\G$/
516 or return;
517
518 # remove the "," prefix we added to all headers above
519 substr $_, 0, 1, ""
520 for values %hdr;
521
522 \%hdr
523}
524
354our $qr_nlnl = qr{(?<![^\012])\015?\012}; 525our $qr_nlnl = qr{(?<![^\012])\015?\012};
355 526
356our $TLS_CTX_LOW = { cache => 1, sslv2 => 1 }; 527our $TLS_CTX_LOW = { cache => 1, sslv2 => 1 };
357our $TLS_CTX_HIGH = { cache => 1, verify => 1, verify_peername => "https" }; 528our $TLS_CTX_HIGH = { cache => 1, verify => 1, verify_peername => "https" };
358 529
377 my @pseudo = (URL => $url); 548 my @pseudo = (URL => $url);
378 push @pseudo, Redirect => delete $arg{Redirect} if exists $arg{Redirect}; 549 push @pseudo, Redirect => delete $arg{Redirect} if exists $arg{Redirect};
379 550
380 my $recurse = exists $arg{recurse} ? delete $arg{recurse} : $MAX_RECURSE; 551 my $recurse = exists $arg{recurse} ? delete $arg{recurse} : $MAX_RECURSE;
381 552
382 return $cb->(undef, { Status => 599, Reason => "Too many redirections", @pseudo }) 553 return $cb->(undef, { @pseudo, Status => 599, Reason => "Too many redirections" })
383 if $recurse < 0; 554 if $recurse < 0;
384 555
385 my $proxy = $arg{proxy} || $PROXY; 556 my $proxy = $arg{proxy} || $PROXY;
386 my $timeout = $arg{timeout} || $TIMEOUT; 557 my $timeout = $arg{timeout} || $TIMEOUT;
387 558
390 561
391 $uscheme = lc $uscheme; 562 $uscheme = lc $uscheme;
392 563
393 my $uport = $uscheme eq "http" ? 80 564 my $uport = $uscheme eq "http" ? 80
394 : $uscheme eq "https" ? 443 565 : $uscheme eq "https" ? 443
395 : return $cb->(undef, { Status => 599, Reason => "Only http and https URL schemes supported", @pseudo }); 566 : return $cb->(undef, { @pseudo, Status => 599, Reason => "Only http and https URL schemes supported" });
396 567
397 $uauthority =~ /^(?: .*\@ )? ([^\@:]+) (?: : (\d+) )?$/x 568 $uauthority =~ /^(?: .*\@ )? ([^\@:]+) (?: : (\d+) )?$/x
398 or return $cb->(undef, { Status => 599, Reason => "Unparsable URL", @pseudo }); 569 or return $cb->(undef, { @pseudo, Status => 599, Reason => "Unparsable URL" });
399 570
400 my $uhost = $1; 571 my $uhost = $1;
401 $uport = $2 if defined $2; 572 $uport = $2 if defined $2;
402 573
403 $hdr{host} = defined $2 ? "$uhost:$2" : "$uhost" 574 $hdr{host} = defined $2 ? "$uhost:$2" : "$uhost"
408 579
409 $upath =~ s%^/?%/%; 580 $upath =~ s%^/?%/%;
410 581
411 # cookie processing 582 # cookie processing
412 if (my $jar = $arg{cookie_jar}) { 583 if (my $jar = $arg{cookie_jar}) {
413 %$jar = () if $jar->{version} != 1; 584 my $cookies = cookie_jar_extract $jar, $uscheme, $uhost, $upath;
414 585
415 my @cookie;
416
417 while (my ($chost, $v) = each %$jar) {
418 if ($chost =~ /^\./) {
419 next unless $chost eq substr $uhost, -length $chost;
420 } elsif ($chost =~ /\./) {
421 next unless $chost eq $uhost;
422 } else {
423 next;
424 }
425
426 while (my ($cpath, $v) = each %$v) {
427 next unless $cpath eq substr $upath, 0, length $cpath;
428
429 while (my ($k, $v) = each %$v) {
430 next if $uscheme ne "https" && exists $v->{secure};
431 my $value = $v->{value};
432 $value =~ s/([\\"])/\\$1/g;
433 push @cookie, "$k=\"$value\"";
434 }
435 }
436 }
437
438 $hdr{cookie} = join "; ", @cookie 586 $hdr{cookie} = join "; ", @$cookies
439 if @cookie; 587 if @$cookies;
440 } 588 }
441 589
442 my ($rhost, $rport, $rscheme, $rpath); # request host, port, path 590 my ($rhost, $rport, $rscheme, $rpath); # request host, port, path
443 591
444 if ($proxy) { 592 if ($proxy) {
452 } else { 600 } else {
453 ($rhost, $rport, $rscheme, $rpath) = ($uhost, $uport, $uscheme, $upath); 601 ($rhost, $rport, $rscheme, $rpath) = ($uhost, $uport, $uscheme, $upath);
454 } 602 }
455 603
456 # leave out fragment and query string, just a heuristic 604 # leave out fragment and query string, just a heuristic
457 $hdr{referer} ||= "$uscheme://$uauthority$upath" unless exists $hdr{referer}; 605 $hdr{referer} = "$uscheme://$uauthority$upath" unless exists $hdr{referer};
458 $hdr{"user-agent"} ||= $USERAGENT unless exists $hdr{"user-agent"}; 606 $hdr{"user-agent"} = $USERAGENT unless exists $hdr{"user-agent"};
459 607
460 $hdr{"content-length"} = length $arg{body} 608 $hdr{"content-length"} = length $arg{body}
461 if length $arg{body} || $method ne "GET"; 609 if length $arg{body} || $method ne "GET";
462 610
611 $hdr{connection} = "close TE"; #1.1
612 $hdr{te} = "trailers" unless exists $hdr{te}; #1.1
613
463 my %state = (connect_guard => 1); 614 my %state = (connect_guard => 1);
464 615
465 _get_slot $uhost, sub { 616 _get_slot $uhost, sub {
466 $state{slot_guard} = shift; 617 $state{slot_guard} = shift;
467 618
468 return unless $state{connect_guard}; 619 return unless $state{connect_guard};
469 620
470 my $tcp_connect = $arg{tcp_connect} 621 my $ae_error = 595; # connecting
471 || do { require AnyEvent::Socket; \&AnyEvent::Socket::tcp_connect };
472 622
473 $state{connect_guard} = $tcp_connect->( 623 my $connect_cb = sub {
474 $rhost,
475 $rport,
476 sub {
477 $state{fh} = shift 624 $state{fh} = shift
478 or do { 625 or do {
479 my $err = "$!"; 626 my $err = "$!";
480 %state = (); 627 %state = ();
481 return $cb->(undef, { Status => 599, Reason => $err, @pseudo }); 628 return $cb->(undef, { @pseudo, Status => $ae_error, Reason => $err });
482 }; 629 };
483 630
484 pop; # free memory, save a tree
485
486 return unless delete $state{connect_guard}; 631 return unless delete $state{connect_guard};
487 632
488 # get handle 633 # get handle
489 $state{handle} = new AnyEvent::Handle 634 $state{handle} = new AnyEvent::Handle
490 fh => $state{fh}, 635 fh => $state{fh},
491 peername => $rhost, 636 peername => $rhost,
492 tls_ctx => $arg{tls_ctx}, 637 tls_ctx => $arg{tls_ctx},
493 # these need to be reconfigured on keepalive handles 638 # these need to be reconfigured on keepalive handles
494 timeout => $timeout, 639 timeout => $timeout,
495 on_error => sub { 640 on_error => sub {
496 %state = (); 641 %state = ();
497 $cb->(undef, { Status => 599, Reason => $_[2], @pseudo }); 642 $cb->(undef, { @pseudo, Status => $ae_error, Reason => $_[2] });
498 }, 643 },
499 on_eof => sub { 644 on_eof => sub {
500 %state = (); 645 %state = ();
501 $cb->(undef, { Status => 599, Reason => "Unexpected end-of-file", @pseudo }); 646 $cb->(undef, { @pseudo, Status => $ae_error, Reason => "Unexpected end-of-file" });
502 }, 647 },
503 ; 648 ;
504 649
505 # limit the number of persistent connections 650 # limit the number of persistent connections
506 # keepalive not yet supported 651 # keepalive not yet supported
507# if ($KA_COUNT{$_[1]} < $MAX_PERSISTENT_PER_HOST) { 652# if ($KA_COUNT{$_[1]} < $MAX_PERSISTENT_PER_HOST) {
508# ++$KA_COUNT{$_[1]}; 653# ++$KA_COUNT{$_[1]};
509# $state{handle}{ka_count_guard} = AnyEvent::Util::guard { 654# $state{handle}{ka_count_guard} = AnyEvent::Util::guard {
510# --$KA_COUNT{$_[1]} 655# --$KA_COUNT{$_[1]}
511# }; 656# };
512# $hdr{connection} = "keep-alive"; 657# $hdr{connection} = "keep-alive";
513# } else {
514 delete $hdr{connection};
515# } 658# }
516 659
517 $state{handle}->starttls ("connect") if $rscheme eq "https"; 660 $state{handle}->starttls ("connect") if $rscheme eq "https";
518 661
519 # handle actual, non-tunneled, request 662 # handle actual, non-tunneled, request
520 my $handle_actual_request = sub { 663 my $handle_actual_request = sub {
664 $ae_error = 596; # request phase
665
521 $state{handle}->starttls ("connect") if $uscheme eq "https" && !exists $state{handle}{tls}; 666 $state{handle}->starttls ("connect") if $uscheme eq "https" && !exists $state{handle}{tls};
522 667
523 # send request 668 # send request
524 $state{handle}->push_write ( 669 $state{handle}->push_write (
525 "$method $rpath HTTP/1.0\015\012" 670 "$method $rpath HTTP/1.1\015\012"
526 . (join "", map "\u$_: $hdr{$_}\015\012", grep defined $hdr{$_}, keys %hdr) 671 . (join "", map "\u$_: $hdr{$_}\015\012", grep defined $hdr{$_}, keys %hdr)
527 . "\015\012" 672 . "\015\012"
528 . (delete $arg{body}) 673 . (delete $arg{body})
529 ); 674 );
530 675
531 # return if error occured during push_write() 676 # return if error occured during push_write()
532 return unless %state; 677 return unless %state;
533 678
534 %hdr = (); # reduce memory usage, save a kitten, also make it possible to re-use 679 %hdr = (); # reduce memory usage, save a kitten, also make it possible to re-use
535 680
536 # status line and headers 681 # status line and headers
537 $state{handle}->push_read (line => $qr_nlnl, sub { 682 $state{read_response} = sub {
538 for ("$_[1]") { 683 for ("$_[1]") {
539 y/\015//d; # weed out any \015, as they show up in the weirdest of places. 684 y/\015//d; # weed out any \015, as they show up in the weirdest of places.
540 685
541 /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\015\012]*) )? \015?\012/igxc 686 /^HTTP\/0*([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\012]*) )? \012/gxci
542 or return (%state = (), $cb->(undef, { Status => 599, Reason => "Invalid server response", @pseudo })); 687 or return (%state = (), $cb->(undef, { @pseudo, Status => 599, Reason => "Invalid server response" }));
543 688
689 # 100 Continue handling
690 # should not happen as we don't send expect: 100-continue,
691 # but we handle it just in case.
692 # since we send the request body regardless, if we get an error
693 # we are out of-sync, which we currently do NOT handle correctly.
694 return $state{handle}->push_read (line => $qr_nlnl, $state{read_response})
695 if $2 eq 100;
696
544 push @pseudo, 697 push @pseudo,
545 HTTPVersion => $1, 698 HTTPVersion => $1,
546 Status => $2, 699 Status => $2,
547 Reason => $3, 700 Reason => $3,
548 ; 701 ;
549 702
550 # things seen, not parsed: 703 my $hdr = parse_hdr
551 # p3pP="NON CUR OTPi OUR NOR UNI"
552
553 $hdr{lc $1} .= ",$2"
554 while /\G
555 ([^:\000-\037]*):
556 [\011\040]*
557 ((?: [^\012]+ | \012[\011\040] )*)
558 \012
559 /gxc;
560
561 /\G$/
562 or return (%state = (), $cb->(undef, { Status => 599, Reason => "Garbled response headers", @pseudo })); 704 or return (%state = (), $cb->(undef, { @pseudo, Status => 599, Reason => "Garbled response headers" }));
705
706 %hdr = (%$hdr, @pseudo);
707 }
708
709 # redirect handling
710 # microsoft and other shitheads don't give a shit for following standards,
711 # try to support some common forms of broken Location headers.
712 if ($hdr{location} !~ /^(?: $ | [^:\/?\#]+ : )/x) {
713 $hdr{location} =~ s/^\.\/+//;
714
715 my $url = "$rscheme://$uhost:$uport";
716
717 unless ($hdr{location} =~ s/^\///) {
718 $url .= $upath;
719 $url =~ s/\/[^\/]*$//;
563 } 720 }
564 721
565 # remove the "," prefix we added to all headers above 722 $hdr{location} = "$url/$hdr{location}";
566 substr $_, 0, 1, "" 723 }
567 for values %hdr;
568 724
569 # patch in all pseudo headers 725 my $redirect;
570 %hdr = (%hdr, @pseudo);
571 726
727 if ($recurse) {
728 my $status = $hdr{Status};
729
730 # industry standard is to redirect POST as GET for
731 # 301, 302 and 303, in contrast to HTTP/1.0 and 1.1.
732 # also, the UA should ask the user for 301 and 307 and POST,
733 # industry standard seems to be to simply follow.
734 # we go with the industry standard.
735 if ($status == 301 or $status == 302 or $status == 303) {
736 # HTTP/1.1 is unclear on how to mutate the method
737 $method = "GET" unless $method eq "HEAD";
572 # redirect handling 738 $redirect = 1;
573 # microsoft and other shitheads don't give a shit for following standards, 739 } elsif ($status == 307) {
574 # try to support some common forms of broken Location headers. 740 $redirect = 1;
575 if ($hdr{location} !~ /^(?: $ | [^:\/?\#]+ : )/x) { 741 }
576 $hdr{location} =~ s/^\.\/+//; 742 }
577 743
578 my $url = "$rscheme://$uhost:$uport"; 744 my $finish = sub { # ($data, $err_status, $err_reason[, $keepalive])
745 my $may_keep_alive = $_[3];
579 746
580 unless ($hdr{location} =~ s/^\///) { 747 $state{handle}->destroy if $state{handle};
748 %state = ();
749
750 if (defined $_[1]) {
751 $hdr{OrigStatus} = $hdr{Status}; $hdr{Status} = $_[1];
752 $hdr{OrigReason} = $hdr{Reason}; $hdr{Reason} = $_[2];
753 }
754
755 # set-cookie processing
756 if ($arg{cookie_jar}) {
757 cookie_jar_set_cookie $arg{cookie_jar}, $hdr{"set-cookie"}, $uhost;
758 }
759
760 if ($redirect && exists $hdr{location}) {
761 # we ignore any errors, as it is very common to receive
762 # Content-Length != 0 but no actual body
763 # we also access %hdr, as $_[1] might be an erro
764 http_request (
765 $method => $hdr{location},
766 %arg,
767 recurse => $recurse - 1,
768 Redirect => [$_[0], \%hdr],
769 $cb);
770 } else {
771 $cb->($_[0], \%hdr);
772 }
773 };
774
775 $ae_error = 597; # body phase
776
777 my $len = $hdr{"content-length"};
778
779 if (!$redirect && $arg{on_header} && !$arg{on_header}(\%hdr)) {
780 $finish->(undef, 598 => "Request cancelled by on_header");
781 } elsif (
782 $hdr{Status} =~ /^(?:1..|204|205|304)$/
783 or $method eq "HEAD"
784 or (defined $len && !$len)
785 ) {
786 # no body
787 $finish->("", undef, undef, 1);
788 } else {
789 # body handling, many different code paths
790 # - no body expected
791 # - want_body_handle
792 # - te chunked
793 # - 2x length known (with or without on_body)
794 # - 2x length not known (with or without on_body)
795 if (!$redirect && $arg{want_body_handle}) {
796 $_[0]->on_eof (undef);
797 $_[0]->on_error (undef);
798 $_[0]->on_read (undef);
799
800 $finish->(delete $state{handle});
801
802 } elsif ($hdr{"transfer-encoding"} =~ /\bchunked\b/i) {
803 my $cl = 0;
804 my $body = undef;
805 my $on_body = $arg{on_body} || sub { $body .= shift; 1 };
806
807 my $read_chunk; $read_chunk = sub {
808 $_[1] =~ /^([0-9a-fA-F]+)/
809 or $finish->(undef, $ae_error => "Garbled chunked transfer encoding");
810
811 my $len = hex $1;
812
813 if ($len) {
581 $url .= $upath; 814 $cl += $len;
582 $url =~ s/\/[^\/]*$//; 815
816 $_[0]->push_read (chunk => $len, sub {
817 $on_body->($_[1], \%hdr)
818 or return $finish->(undef, 598 => "Request cancelled by on_body");
819
820 $_[0]->push_read (line => sub {
821 length $_[1]
822 and return $finish->(undef, $ae_error => "Garbled chunked transfer encoding");
823 $_[0]->push_read (line => $read_chunk);
824 });
825 });
826 } else {
827 $hdr{"content-length"} ||= $cl;
828
829 $_[0]->push_read (line => $qr_nlnl, sub {
830 if (length $_[1]) {
831 for ("$_[1]") {
832 y/\015//d; # weed out any \015, as they show up in the weirdest of places.
833
834 my $hdr = parse_hdr
835 or return $finish->(undef, $ae_error => "Garbled response trailers");
836
837 %hdr = (%hdr, %$hdr);
838 }
839 }
840
841 $finish->($body, undef, undef, 1);
842 });
843 }
844 };
845
846 $_[0]->push_read (line => $read_chunk);
847
848 } elsif ($arg{on_body}) {
849 if ($len) {
850 $_[0]->on_read (sub {
851 $len -= length $_[0]{rbuf};
852
853 $arg{on_body}(delete $_[0]{rbuf}, \%hdr)
854 or return $finish->(undef, 598 => "Request cancelled by on_body");
855
856 $len > 0
857 or $finish->("", undef, undef, 1);
858 });
859 } else {
860 $_[0]->on_eof (sub {
861 $finish->("");
862 });
863 $_[0]->on_read (sub {
864 $arg{on_body}(delete $_[0]{rbuf}, \%hdr)
865 or $finish->(undef, 598 => "Request cancelled by on_body");
866 });
583 } 867 }
584
585 $hdr{location} = "$url/$hdr{location}";
586 } 868 } else {
869 $_[0]->on_eof (undef);
587 870
588 my $redirect;
589
590 if ($recurse) { 871 if ($len) {
591 my $status = $hdr{Status}; 872 $_[0]->on_read (sub {
592 873 $finish->((substr delete $_[0]{rbuf}, 0, $len, ""), undef, undef, 1)
593 # industry standard is to redirect POST as GET for 874 if $len <= length $_[0]{rbuf};
594 # 301, 302 and 303, in contrast to http/1.0 and 1.1.
595 # also, the UA should ask the user for 301 and 307 and POST,
596 # industry standard seems to be to simply follow.
597 # we go with the industry standard.
598 if ($status == 301 or $status == 302 or $status == 303) {
599 # HTTP/1.1 is unclear on how to mutate the method
600 $method = "GET" unless $method eq "HEAD";
601 $redirect = 1; 875 });
602 } elsif ($status == 307) { 876 } else {
877 $_[0]->on_error (sub {
878 ($! == Errno::EPIPE || !$!)
879 ? $finish->(delete $_[0]{rbuf})
880 : $finish->(undef, $ae_error => $_[2]);
603 $redirect = 1; 881 });
882 $_[0]->on_read (sub { });
604 } 883 }
605 } 884 }
606
607 my $finish = sub {
608 $state{handle}->destroy if $state{handle};
609 %state = ();
610
611 # set-cookie processing
612 if ($arg{cookie_jar}) {
613 for ($_[1]{"set-cookie"}) {
614 # parse NAME=VALUE
615 my @kv;
616
617 while (/\G\s* ([^=;,[:space:]]+) \s*=\s* (?: "((?:[^\\"]+|\\.)*)" | ([^=;,[:space:]]*) )/gcxs) {
618 my $name = $1;
619 my $value = $3;
620
621 unless ($value) {
622 $value = $2;
623 $value =~ s/\\(.)/$1/gs;
624 }
625
626 push @kv, $name => $value;
627
628 last unless /\G\s*;/gc;
629 }
630
631 last unless @kv;
632
633 my $name = shift @kv;
634 my %kv = (value => shift @kv, @kv);
635
636 my $cdom;
637 my $cpath = (delete $kv{path}) || "/";
638
639 if (exists $kv{domain}) {
640 $cdom = delete $kv{domain};
641
642 $cdom =~ s/^\.?/./; # make sure it starts with a "."
643
644 next if $cdom =~ /\.$/;
645
646 # this is not rfc-like and not netscape-like. go figure.
647 my $ndots = $cdom =~ y/.//;
648 next if $ndots < ($cdom =~ /\.[^.][^.]\.[^.][^.]$/ ? 3 : 2);
649 } else {
650 $cdom = $uhost;
651 }
652
653 # store it
654 $arg{cookie_jar}{version} = 1;
655 $arg{cookie_jar}{$cdom}{$cpath}{$name} = \%kv;
656
657 redo if /\G\s*,/gc;
658 }
659 }
660
661 if ($redirect && exists $hdr{location}) {
662 # we ignore any errors, as it is very common to receive
663 # Content-Length != 0 but no actual body
664 # we also access %hdr, as $_[1] might be an erro
665 http_request (
666 $method => $hdr{location},
667 %arg,
668 recurse => $recurse - 1,
669 Redirect => \@_,
670 $cb);
671 } else {
672 $cb->($_[0], $_[1]);
673 }
674 };
675
676 my $len = $hdr{"content-length"};
677
678 if (!$redirect && $arg{on_header} && !$arg{on_header}(\%hdr)) {
679 $finish->(undef, { Status => 598, Reason => "Request cancelled by on_header", @pseudo });
680 } elsif (
681 $hdr{Status} =~ /^(?:1..|[23]04)$/
682 or $method eq "HEAD"
683 or (defined $len && !$len)
684 ) {
685 # no body
686 $finish->("", \%hdr);
687 } else {
688 # body handling, four different code paths
689 # for want_body_handle, on_body (2x), normal (2x)
690 # we might read too much here, but it does not matter yet (no pers. connections)
691 if (!$redirect && $arg{want_body_handle}) {
692 $_[0]->on_eof (undef);
693 $_[0]->on_error (undef);
694 $_[0]->on_read (undef);
695
696 $finish->(delete $state{handle}, \%hdr);
697
698 } elsif ($arg{on_body}) {
699 $_[0]->on_error (sub { $finish->(undef, { Status => 599, Reason => $_[2], @pseudo }) });
700 if ($len) {
701 $_[0]->on_eof (undef);
702 $_[0]->on_read (sub {
703 $len -= length $_[0]{rbuf};
704
705 $arg{on_body}(delete $_[0]{rbuf}, \%hdr)
706 or $finish->(undef, { Status => 598, Reason => "Request cancelled by on_body", @pseudo });
707
708 $len > 0
709 or $finish->("", \%hdr);
710 });
711 } else {
712 $_[0]->on_eof (sub {
713 $finish->("", \%hdr);
714 });
715 $_[0]->on_read (sub {
716 $arg{on_body}(delete $_[0]{rbuf}, \%hdr)
717 or $finish->(undef, { Status => 598, Reason => "Request cancelled by on_body", @pseudo });
718 });
719 }
720 } else {
721 $_[0]->on_eof (undef);
722
723 if ($len) {
724 $_[0]->on_error (sub { $finish->(undef, { Status => 599, Reason => $_[2], @pseudo }) });
725 $_[0]->on_read (sub {
726 $finish->((substr delete $_[0]{rbuf}, 0, $len, ""), \%hdr)
727 if $len <= length $_[0]{rbuf};
728 });
729 } else {
730 $_[0]->on_error (sub {
731 ($! == Errno::EPIPE || !$!)
732 ? $finish->(delete $_[0]{rbuf}, \%hdr)
733 : $finish->(undef, { Status => 599, Reason => $_[2], @pseudo });
734 });
735 $_[0]->on_read (sub { });
736 }
737 }
738 }
739 }); 885 }
740 }; 886 };
741 887
888 $state{handle}->push_read (line => $qr_nlnl, $state{read_response});
889 };
890
742 # now handle proxy-CONNECT method 891 # now handle proxy-CONNECT method
743 if ($proxy && $uscheme eq "https") { 892 if ($proxy && $uscheme eq "https") {
744 # oh dear, we have to wrap it into a connect request 893 # oh dear, we have to wrap it into a connect request
745 894
746 # maybe re-use $uauthority with patched port? 895 # maybe re-use $uauthority with patched port?
747 $state{handle}->push_write ("CONNECT $uhost:$uport HTTP/1.0\015\012Host: $uhost\015\012\015\012"); 896 $state{handle}->push_write ("CONNECT $uhost:$uport HTTP/1.0\015\012Host: $uhost\015\012\015\012");
748 $state{handle}->push_read (line => $qr_nlnl, sub { 897 $state{handle}->push_read (line => $qr_nlnl, sub {
749 $_[1] =~ /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\015\012]*) )?/ix 898 $_[1] =~ /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\015\012]*) )?/ix
750 or return (%state = (), $cb->(undef, { Status => 599, Reason => "Invalid proxy connect response ($_[1])", @pseudo })); 899 or return (%state = (), $cb->(undef, { @pseudo, Status => 599, Reason => "Invalid proxy connect response ($_[1])" }));
751 900
752 if ($2 == 200) { 901 if ($2 == 200) {
753 $rpath = $upath; 902 $rpath = $upath;
754 &$handle_actual_request; 903 &$handle_actual_request;
755 } else { 904 } else {
756 %state = (); 905 %state = ();
757 $cb->(undef, { Status => $2, Reason => $3, @pseudo }); 906 $cb->(undef, { @pseudo, Status => $2, Reason => $3 });
758 }
759 }); 907 }
908 });
760 } else { 909 } else {
761 &$handle_actual_request; 910 &$handle_actual_request;
762 }
763
764 }, 911 }
765 $arg{on_prepare} || sub { $timeout }
766 ); 912 };
913
914 my $tcp_connect = $arg{tcp_connect}
915 || do { require AnyEvent::Socket; \&AnyEvent::Socket::tcp_connect };
916
917 $state{connect_guard} = $tcp_connect->($rhost, $rport, $connect_cb, $arg{on_prepare} || sub { $timeout });
918
767 }; 919 };
768 920
769 defined wantarray && AnyEvent::Util::guard { %state = () } 921 defined wantarray && AnyEvent::Util::guard { %state = () }
770} 922}
771 923
806string of the form C<http://host:port> (optionally C<https:...>), croaks 958string of the form C<http://host:port> (optionally C<https:...>), croaks
807otherwise. 959otherwise.
808 960
809To clear an already-set proxy, use C<undef>. 961To clear an already-set proxy, use C<undef>.
810 962
963=item $date = AnyEvent::HTTP::format_date $timestamp
964
965Takes a POSIX timestamp (seconds since the epoch) and formats it as a HTTP
966Date (RFC 2616).
967
968=item $timestamp = AnyEvent::HTTP::parse_date $date
969
970Takes a HTTP Date (RFC 2616) or a Cookie date (netscape cookie spec) or a
971bunch of minor variations of those, and returns the corresponding POSIX
972timestamp, or C<undef> if the date cannot be parsed.
973
811=item $AnyEvent::HTTP::MAX_RECURSE 974=item $AnyEvent::HTTP::MAX_RECURSE
812 975
813The default value for the C<recurse> request parameter (default: C<10>). 976The default value for the C<recurse> request parameter (default: C<10>).
814 977
815=item $AnyEvent::HTTP::USERAGENT 978=item $AnyEvent::HTTP::USERAGENT
833connections. This number of can be useful for load-leveling. 996connections. This number of can be useful for load-leveling.
834 997
835=back 998=back
836 999
837=cut 1000=cut
1001
1002our @month = qw(Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec);
1003our @weekday = qw(Sun Mon Tue Wed Thu Fri Sat);
1004
1005sub format_date($) {
1006 my ($time) = @_;
1007
1008 # RFC 822/1123 format
1009 my ($S, $M, $H, $mday, $mon, $year, $wday, $yday, undef) = gmtime $time;
1010
1011 sprintf "%s, %02d %s %04d %02d:%02d:%02d GMT",
1012 $weekday[$wday], $mday, $month[$mon], $year + 1900,
1013 $H, $M, $S;
1014}
1015
1016sub parse_date($) {
1017 my ($date) = @_;
1018
1019 my ($d, $m, $y, $H, $M, $S);
1020
1021 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$/) {
1022 # RFC 822/1123, required by RFC 2616 (with " ")
1023 # cookie dates (with "-")
1024
1025 ($d, $m, $y, $H, $M, $S) = ($1, $2, $3, $4, $5, $6);
1026
1027 } 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$/) {
1028 # RFC 850
1029 ($d, $m, $y, $H, $M, $S) = ($1, $2, $3 < 69 ? $3 + 2000 : $3 + 1900, $4, $5, $6);
1030
1031 } 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])$/) {
1032 # ISO C's asctime
1033 ($d, $m, $y, $H, $M, $S) = ($2, $1, $6, $3, $4, $5);
1034 }
1035 # other formats fail in the loop below
1036
1037 for (0..11) {
1038 if ($m eq $month[$_]) {
1039 require Time::Local;
1040 return Time::Local::timegm ($S, $M, $H, $d, $_, $y);
1041 }
1042 }
1043
1044 undef
1045}
838 1046
839sub set_proxy($) { 1047sub set_proxy($) {
840 if (length $_[0]) { 1048 if (length $_[0]) {
841 $_[0] =~ m%^(https?):// ([^:/]+) (?: : (\d*) )?%ix 1049 $_[0] =~ m%^(https?):// ([^:/]+) (?: : (\d*) )?%ix
842 or Carp::croak "$_[0]: invalid proxy URL"; 1050 or Carp::croak "$_[0]: invalid proxy URL";

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines