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.56 by root, Mon Sep 6 05:30:54 2010 UTC vs.
Revision 1.68 by root, Fri Dec 31 19:22:18 2010 UTC

43 43
44use Errno (); 44use Errno ();
45 45
46use AnyEvent 5.0 (); 46use AnyEvent 5.0 ();
47use AnyEvent::Util (); 47use AnyEvent::Util ();
48use AnyEvent::Socket ();
49use AnyEvent::Handle (); 48use AnyEvent::Handle ();
50 49
51use base Exporter::; 50use base Exporter::;
52 51
53our $VERSION = '1.45'; 52our $VERSION = '1.5';
54 53
55our @EXPORT = qw(http_get http_post http_head http_request); 54our @EXPORT = qw(http_get http_post http_head http_request);
56 55
57our $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)";
58our $MAX_RECURSE = 10; 57our $MAX_RECURSE = 10;
92must be an absolute http or https URL. 91must be an absolute http or https URL.
93 92
94When called in void context, nothing is returned. In other contexts, 93When called in void context, nothing is returned. In other contexts,
95C<http_request> returns a "cancellation guard" - you have to keep the 94C<http_request> returns a "cancellation guard" - you have to keep the
96object 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
97destroyed before the callbakc is called, the request will be cancelled. 96destroyed before the callback is called, the request will be cancelled.
98 97
99The 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
100(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
101second argument. 100(and trailers) as second argument.
102 101
103All 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
104headers, the "pseudo-headers" (uppercase to avoid clashing with possible 103headers, the "pseudo-headers" (uppercase to avoid clashing with possible
105response headers) C<HTTPVersion>, C<Status> and C<Reason> contain the 104response headers) C<HTTPVersion>, C<Status> and C<Reason> contain the
106three 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>.
107 109
108The 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
109the requested URL when following redirects - for example, you might get 111the requested URL when following redirects - for example, you might get
110an 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
111valid 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
148Whether to recurse requests or not, e.g. on redirects, authentication 150Whether to recurse requests or not, e.g. on redirects, authentication
149retries and so on, and how often to do so. 151retries and so on, and how often to do so.
150 152
151=item headers => hashref 153=item headers => hashref
152 154
153The request headers to use. Currently, C<http_request> may provide its 155The request headers to use. Currently, C<http_request> may provide its own
154own C<Host:>, C<Content-Length:>, C<Connection:> and C<Cookie:> headers 156C<Host:>, C<Content-Length:>, C<Connection:> and C<Cookie:> headers and
155and will provide defaults for C<User-Agent:> and C<Referer:> (this can be 157will provide defaults for C<TE:>, C<Referer:> and C<User-Agent:> (this can
156suppressed by using C<undef> for these headers in which case they won't be 158be suppressed by using C<undef> for these headers in which case they won't
157sent at all). 159be sent at all).
158 160
159=item timeout => $seconds 161=item timeout => $seconds
160 162
161The time-out to use for various stages - each connect attempt will reset 163The time-out to use for various stages - each connect attempt will reset
162the timeout, as will read or write activity, i.e. this is not an overall 164the timeout, as will read or write activity, i.e. this is not an overall
172C<$scheme> must be either missing, C<http> for HTTP or C<https> for 174C<$scheme> must be either missing, C<http> for HTTP or C<https> for
173HTTPS. 175HTTPS.
174 176
175=item body => $string 177=item body => $string
176 178
177The request body, usually empty. Will be-sent as-is (future versions of 179The request body, usually empty. Will be sent as-is (future versions of
178this module might offer more options). 180this module might offer more options).
179 181
180=item cookie_jar => $hash_ref 182=item cookie_jar => $hash_ref
181 183
182Passing this parameter enables (simplified) cookie-processing, loosely 184Passing this parameter enables (simplified) cookie-processing, loosely
212overrides the prepare callback passed to C<AnyEvent::Socket::tcp_connect> 214overrides the prepare callback passed to C<AnyEvent::Socket::tcp_connect>
213and behaves exactly the same way (e.g. it has to provide a 215and behaves exactly the same way (e.g. it has to provide a
214timeout). See the description for the C<$prepare_cb> argument of 216timeout). See the description for the C<$prepare_cb> argument of
215C<AnyEvent::Socket::tcp_connect> for details. 217C<AnyEvent::Socket::tcp_connect> for details.
216 218
219=item tcp_connect => $callback->($host, $service, $connect_cb, $prepare_cb)
220
221In even rarer cases you want total control over how AnyEvent::HTTP
222establishes connections. Normally it uses L<AnyEvent::Socket::tcp_connect>
223to do this, but you can provide your own C<tcp_connect> function -
224obviously, it has to follow the same calling conventions, except that it
225may always return a connection guard object.
226
227There are probably lots of weird uses for this function, starting from
228tracing the hosts C<http_request> actually tries to connect, to (inexact
229but fast) host => IP address caching or even socks protocol support.
230
217=item on_header => $callback->($headers) 231=item on_header => $callback->($headers)
218 232
219When specified, this callback will be called with the header hash as soon 233When specified, this callback will be called with the header hash as soon
220as headers have been successfully received from the remote server (not on 234as headers have been successfully received from the remote server (not on
221locally-generated errors). 235locally-generated errors).
226 240
227This callback is useful, among other things, to quickly reject unwanted 241This callback is useful, among other things, to quickly reject unwanted
228content, which, if it is supposed to be rare, can be faster than first 242content, which, if it is supposed to be rare, can be faster than first
229doing a C<HEAD> request. 243doing a C<HEAD> request.
230 244
245The downside is that cancelling the request makes it impossible to re-use
246the connection. Also, the C<on_header> callback will not receive any
247trailer (headers sent after the response body).
248
231Example: cancel the request unless the content-type is "text/html". 249Example: cancel the request unless the content-type is "text/html".
232 250
233 on_header => sub { 251 on_header => sub {
234 $_[0]{"content-type"} =~ /^text\/html\s*(?:;|$)/ 252 $_[0]{"content-type"} =~ /^text\/html\s*(?:;|$)/
235 }, 253 },
241string instead of the body data. 259string instead of the body data.
242 260
243It has to return either true (in which case AnyEvent::HTTP will continue), 261It has to return either true (in which case AnyEvent::HTTP will continue),
244or false, in which case AnyEvent::HTTP will cancel the download (and call 262or false, in which case AnyEvent::HTTP will cancel the download (and call
245the completion callback with an error code of C<598>). 263the completion callback with an error code of C<598>).
264
265The downside to cancelling the request is that it makes it impossible to
266re-use the connection.
246 267
247This callback is useful when the data is too large to be held in memory 268This callback is useful when the data is too large to be held in memory
248(so the callback writes it to a file) or when only some information should 269(so the callback writes it to a file) or when only some information should
249be extracted, or when the body should be processed incrementally. 270be extracted, or when the body should be processed incrementally.
250 271
276If you think you need this, first have a look at C<on_body>, to see if 297If you think you need this, first have a look at C<on_body>, to see if
277that doesn't solve your problem in a better way. 298that doesn't solve your problem in a better way.
278 299
279=back 300=back
280 301
281Example: make a simple HTTP GET request for http://www.nethype.de/ 302Example: do a simple HTTP GET request for http://www.nethype.de/ and print
303the response body.
282 304
283 http_request GET => "http://www.nethype.de/", sub { 305 http_request GET => "http://www.nethype.de/", sub {
284 my ($body, $hdr) = @_; 306 my ($body, $hdr) = @_;
285 print "$body\n"; 307 print "$body\n";
286 }; 308 };
287 309
288Example: make a HTTP HEAD request on https://www.google.com/, use a 310Example: do a HTTP HEAD request on https://www.google.com/, use a
289timeout of 30 seconds. 311timeout of 30 seconds.
290 312
291 http_request 313 http_request
292 GET => "https://www.google.com", 314 GET => "https://www.google.com",
293 timeout => 30, 315 timeout => 30,
296 use Data::Dumper; 318 use Data::Dumper;
297 print Dumper $hdr; 319 print Dumper $hdr;
298 } 320 }
299 ; 321 ;
300 322
301Example: make another simple HTTP GET request, but immediately try to 323Example: do another simple HTTP GET request, but immediately try to
302cancel it. 324cancel it.
303 325
304 my $request = http_request GET => "http://www.nethype.de/", sub { 326 my $request = http_request GET => "http://www.nethype.de/", sub {
305 my ($body, $hdr) = @_; 327 my ($body, $hdr) = @_;
306 print "$body\n"; 328 print "$body\n";
338 push @{ $CO_SLOT{$_[0]}[1] }, $_[1]; 360 push @{ $CO_SLOT{$_[0]}[1] }, $_[1];
339 361
340 _slot_schedule $_[0]; 362 _slot_schedule $_[0];
341} 363}
342 364
343our $qr_nl = qr{\015?\012}; 365# continue to parse $_ for headers and place them into the arg
366sub parse_hdr() {
367 my %hdr;
368
369 # things seen, not parsed:
370 # p3pP="NON CUR OTPi OUR NOR UNI"
371
372 $hdr{lc $1} .= ",$2"
373 while /\G
374 ([^:\000-\037]*):
375 [\011\040]*
376 ((?: [^\012]+ | \012[\011\040] )*)
377 \012
378 /gxc;
379
380 /\G$/
381 or return;
382
383 # remove the "," prefix we added to all headers above
384 substr $_, 0, 1, ""
385 for values %hdr;
386
387 \%hdr
388}
389
344our $qr_nlnl = qr{(?<![^\012])\015?\012}; 390our $qr_nlnl = qr{(?<![^\012])\015?\012};
345 391
346our $TLS_CTX_LOW = { cache => 1, sslv2 => 1 }; 392our $TLS_CTX_LOW = { cache => 1, sslv2 => 1 };
347our $TLS_CTX_HIGH = { cache => 1, verify => 1, verify_peername => "https" }; 393our $TLS_CTX_HIGH = { cache => 1, verify => 1, verify_peername => "https" };
348 394
367 my @pseudo = (URL => $url); 413 my @pseudo = (URL => $url);
368 push @pseudo, Redirect => delete $arg{Redirect} if exists $arg{Redirect}; 414 push @pseudo, Redirect => delete $arg{Redirect} if exists $arg{Redirect};
369 415
370 my $recurse = exists $arg{recurse} ? delete $arg{recurse} : $MAX_RECURSE; 416 my $recurse = exists $arg{recurse} ? delete $arg{recurse} : $MAX_RECURSE;
371 417
372 return $cb->(undef, { Status => 599, Reason => "Too many redirections", @pseudo }) 418 return $cb->(undef, { @pseudo, Status => 599, Reason => "Too many redirections" })
373 if $recurse < 0; 419 if $recurse < 0;
374 420
375 my $proxy = $arg{proxy} || $PROXY; 421 my $proxy = $arg{proxy} || $PROXY;
376 my $timeout = $arg{timeout} || $TIMEOUT; 422 my $timeout = $arg{timeout} || $TIMEOUT;
377 423
380 426
381 $uscheme = lc $uscheme; 427 $uscheme = lc $uscheme;
382 428
383 my $uport = $uscheme eq "http" ? 80 429 my $uport = $uscheme eq "http" ? 80
384 : $uscheme eq "https" ? 443 430 : $uscheme eq "https" ? 443
385 : return $cb->(undef, { Status => 599, Reason => "Only http and https URL schemes supported", @pseudo }); 431 : return $cb->(undef, { @pseudo, Status => 599, Reason => "Only http and https URL schemes supported" });
386 432
387 $uauthority =~ /^(?: .*\@ )? ([^\@:]+) (?: : (\d+) )?$/x 433 $uauthority =~ /^(?: .*\@ )? ([^\@:]+) (?: : (\d+) )?$/x
388 or return $cb->(undef, { Status => 599, Reason => "Unparsable URL", @pseudo }); 434 or return $cb->(undef, { @pseudo, Status => 599, Reason => "Unparsable URL" });
389 435
390 my $uhost = $1; 436 my $uhost = $1;
391 $uport = $2 if defined $2; 437 $uport = $2 if defined $2;
392 438
393 $hdr{host} = defined $2 ? "$uhost:$2" : "$uhost" 439 $hdr{host} = defined $2 ? "$uhost:$2" : "$uhost"
442 } else { 488 } else {
443 ($rhost, $rport, $rscheme, $rpath) = ($uhost, $uport, $uscheme, $upath); 489 ($rhost, $rport, $rscheme, $rpath) = ($uhost, $uport, $uscheme, $upath);
444 } 490 }
445 491
446 # leave out fragment and query string, just a heuristic 492 # leave out fragment and query string, just a heuristic
447 $hdr{referer} ||= "$uscheme://$uauthority$upath" unless exists $hdr{referer}; 493 $hdr{referer} = "$uscheme://$uauthority$upath" unless exists $hdr{referer};
448 $hdr{"user-agent"} ||= $USERAGENT unless exists $hdr{"user-agent"}; 494 $hdr{"user-agent"} = $USERAGENT unless exists $hdr{"user-agent"};
449 495
450 $hdr{"content-length"} = length $arg{body} 496 $hdr{"content-length"} = length $arg{body}
451 if length $arg{body} || $method ne "GET"; 497 if length $arg{body} || $method ne "GET";
452 498
499 $hdr{connection} = "close TE"; #1.1
500 $hdr{te} = "trailers" unless exists $hdr{te}; #1.1
501
453 my %state = (connect_guard => 1); 502 my %state = (connect_guard => 1);
454 503
455 _get_slot $uhost, sub { 504 _get_slot $uhost, sub {
456 $state{slot_guard} = shift; 505 $state{slot_guard} = shift;
457 506
458 return unless $state{connect_guard}; 507 return unless $state{connect_guard};
459 508
460 $state{connect_guard} = AnyEvent::Socket::tcp_connect $rhost, $rport, sub { 509 my $connect_cb = sub {
461 $state{fh} = shift 510 $state{fh} = shift
462 or do { 511 or do {
463 my $err = "$!"; 512 my $err = "$!";
464 %state = (); 513 %state = ();
465 return $cb->(undef, { Status => 599, Reason => $err, @pseudo }); 514 return $cb->(undef, { @pseudo, Status => 599, Reason => $err });
466 }; 515 };
467 516
468 pop; # free memory, save a tree 517 pop; # free memory, save a tree
469 518
470 return unless delete $state{connect_guard}; 519 return unless delete $state{connect_guard};
476 tls_ctx => $arg{tls_ctx}, 525 tls_ctx => $arg{tls_ctx},
477 # these need to be reconfigured on keepalive handles 526 # these need to be reconfigured on keepalive handles
478 timeout => $timeout, 527 timeout => $timeout,
479 on_error => sub { 528 on_error => sub {
480 %state = (); 529 %state = ();
481 $cb->(undef, { Status => 599, Reason => $_[2], @pseudo }); 530 $cb->(undef, { @pseudo, Status => 599, Reason => $_[2] });
482 }, 531 },
483 on_eof => sub { 532 on_eof => sub {
484 %state = (); 533 %state = ();
485 $cb->(undef, { Status => 599, Reason => "Unexpected end-of-file", @pseudo }); 534 $cb->(undef, { @pseudo, Status => 599, Reason => "Unexpected end-of-file" });
486 }, 535 },
487 ; 536 ;
488 537
489 # limit the number of persistent connections 538 # limit the number of persistent connections
490 # keepalive not yet supported 539 # keepalive not yet supported
492# ++$KA_COUNT{$_[1]}; 541# ++$KA_COUNT{$_[1]};
493# $state{handle}{ka_count_guard} = AnyEvent::Util::guard { 542# $state{handle}{ka_count_guard} = AnyEvent::Util::guard {
494# --$KA_COUNT{$_[1]} 543# --$KA_COUNT{$_[1]}
495# }; 544# };
496# $hdr{connection} = "keep-alive"; 545# $hdr{connection} = "keep-alive";
497# } else {
498 delete $hdr{connection};
499# } 546# }
500 547
501 $state{handle}->starttls ("connect") if $rscheme eq "https"; 548 $state{handle}->starttls ("connect") if $rscheme eq "https";
502 549
503 # handle actual, non-tunneled, request 550 # handle actual, non-tunneled, request
504 my $handle_actual_request = sub { 551 my $handle_actual_request = sub {
505 $state{handle}->starttls ("connect") if $uscheme eq "https" && !exists $state{handle}{tls}; 552 $state{handle}->starttls ("connect") if $uscheme eq "https" && !exists $state{handle}{tls};
506 553
507 # send request 554 # send request
508 $state{handle}->push_write ( 555 $state{handle}->push_write (
509 "$method $rpath HTTP/1.0\015\012" 556 "$method $rpath HTTP/1.1\015\012"
510 . (join "", map "\u$_: $hdr{$_}\015\012", grep defined $hdr{$_}, keys %hdr) 557 . (join "", map "\u$_: $hdr{$_}\015\012", grep defined $hdr{$_}, keys %hdr)
511 . "\015\012" 558 . "\015\012"
512 . (delete $arg{body}) 559 . (delete $arg{body})
513 ); 560 );
514 561
515 # return if error occured during push_write() 562 # return if error occured during push_write()
516 return unless %state; 563 return unless %state;
517 564
518 %hdr = (); # reduce memory usage, save a kitten, also make it possible to re-use 565 %hdr = (); # reduce memory usage, save a kitten, also make it possible to re-use
519 566
520 # status line 567 # status line and headers
521 $state{handle}->push_read (line => $qr_nl, sub { 568 $state{read_response} = sub {
522 $_[1] =~ /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\015\012]*) )?/ix
523 or return (%state = (), $cb->(undef, { Status => 599, Reason => "Invalid server response ($_[1])", @pseudo }));
524
525 push @pseudo,
526 HTTPVersion => $1,
527 Status => $2,
528 Reason => $3,
529 ;
530
531 # headers, could be optimized a bit
532 $state{handle}->unshift_read (line => $qr_nlnl, sub {
533 for ("$_[1]") { 569 for ("$_[1]") {
534 y/\015//d; # weed out any \015, as they show up in the weirdest of places. 570 y/\015//d; # weed out any \015, as they show up in the weirdest of places.
535 571
536 # things seen, not parsed: 572 /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\012]*) )? \012/igxc
537 # p3pP="NON CUR OTPi OUR NOR UNI" 573 or return (%state = (), $cb->(undef, { @pseudo, Status => 599, Reason => "Invalid server response" }));
538 574
539 $hdr{lc $1} .= ",$2" 575 # 100 Continue handling
540 while /\G 576 # should not happen as we don't send expect: 100-continue,
541 ([^:\000-\037]*): 577 # but we handle it just in case.
542 [\011\040]* 578 # since we send the request body regardless, if we get an error
543 ((?: [^\012]+ | \012[\011\040] )*) 579 # we are out of-sync, which we currently do NOT handle correctly.
544 \012 580 return $state{handle}->push_read (line => $qr_nlnl, $state{read_response})
545 /gxc; 581 if $2 eq 100;
546 582
583 push @pseudo,
584 HTTPVersion => $1,
585 Status => $2,
586 Reason => $3,
547 /\G$/ 587 ;
588
589 my $hdr = parse_hdr
548 or return (%state = (), $cb->(undef, { Status => 599, Reason => "Garbled response headers", @pseudo })); 590 or return (%state = (), $cb->(undef, { @pseudo, Status => 599, Reason => "Garbled response headers" }));
591
592 %hdr = (%$hdr, @pseudo);
593 }
594
595 # redirect handling
596 # microsoft and other shitheads don't give a shit for following standards,
597 # try to support some common forms of broken Location headers.
598 if ($hdr{location} !~ /^(?: $ | [^:\/?\#]+ : )/x) {
599 $hdr{location} =~ s/^\.\/+//;
600
601 my $url = "$rscheme://$uhost:$uport";
602
603 unless ($hdr{location} =~ s/^\///) {
604 $url .= $upath;
605 $url =~ s/\/[^\/]*$//;
549 } 606 }
550 607
551 # remove the "," prefix we added to all headers above
552 substr $_, 0, 1, ""
553 for values %hdr;
554
555 # patch in all pseudo headers
556 %hdr = (%hdr, @pseudo);
557
558 # redirect handling
559 # microsoft and other shitheads don't give a shit for following standards,
560 # try to support some common forms of broken Location headers.
561 if ($hdr{location} !~ /^(?: $ | [^:\/?\#]+ : )/x) {
562 $hdr{location} =~ s/^\.\/+//;
563
564 my $url = "$rscheme://$uhost:$uport";
565
566 unless ($hdr{location} =~ s/^\///) {
567 $url .= $upath;
568 $url =~ s/\/[^\/]*$//;
569 }
570
571 $hdr{location} = "$url/$hdr{location}"; 608 $hdr{location} = "$url/$hdr{location}";
609 }
610
611 my $redirect;
612
613 if ($recurse) {
614 my $status = $hdr{Status};
615
616 # industry standard is to redirect POST as GET for
617 # 301, 302 and 303, in contrast to http/1.0 and 1.1.
618 # also, the UA should ask the user for 301 and 307 and POST,
619 # industry standard seems to be to simply follow.
620 # we go with the industry standard.
621 if ($status == 301 or $status == 302 or $status == 303) {
622 # HTTP/1.1 is unclear on how to mutate the method
623 $method = "GET" unless $method eq "HEAD";
624 $redirect = 1;
625 } elsif ($status == 307) {
626 $redirect = 1;
572 } 627 }
628 }
573 629
630 my $finish = sub { # ($data, $err_status, $err_reason[, $keepalive])
574 my $redirect; 631 my $keepalive = pop;
575 632
633 $state{handle}->destroy if $state{handle};
634 %state = ();
635
636 if (defined $_[1]) {
637 $hdr{OrigStatus} = $hdr{Status}; $hdr{Status} = $_[1];
638 $hdr{OrigReason} = $hdr{Reason}; $hdr{Reason} = $_[2];
639 }
640
641 # set-cookie processing
576 if ($recurse) { 642 if ($arg{cookie_jar}) {
577 my $status = $hdr{Status}; 643 for ($hdr{"set-cookie"}) {
644 # parse NAME=VALUE
645 my @kv;
578 646
579 if (($status == 301 || $status == 302) && $method ne "POST") { 647 while (/\G\s* ([^=;,[:space:]]+) \s*=\s* (?: "((?:[^\\"]+|\\.)*)" | ([^=;,[:space:]]*) )/gcxs) {
580 # apparently, mozilla et al. just change POST to GET here
581 # more research is needed before we do the same
582 $redirect = 1; 648 my $name = $1;
583 } elsif ($status == 303) { 649 my $value = $3;
584 # even http/1.1 is unclear on how to mutate the method 650
585 $method = "GET" unless $method eq "HEAD"; 651 unless ($value) {
652 $value = $2;
653 $value =~ s/\\(.)/$1/gs;
654 }
655
656 push @kv, $name => $value;
657
658 last unless /\G\s*;/gc;
659 }
660
661 last unless @kv;
662
663 my $name = shift @kv;
664 my %kv = (value => shift @kv, @kv);
665
666 my $cdom;
667 my $cpath = (delete $kv{path}) || "/";
668
669 if (exists $kv{domain}) {
670 $cdom = delete $kv{domain};
671
672 $cdom =~ s/^\.?/./; # make sure it starts with a "."
673
674 next if $cdom =~ /\.$/;
675
676 # this is not rfc-like and not netscape-like. go figure.
677 my $ndots = $cdom =~ y/.//;
678 next if $ndots < ($cdom =~ /\.[^.][^.]\.[^.][^.]$/ ? 3 : 2);
679 } else {
680 $cdom = $uhost;
681 }
682
586 $redirect = 1; 683 # store it
587 } elsif ($status == 307 && $method =~ /^(?:GET|HEAD)$/) { 684 $arg{cookie_jar}{version} = 1;
588 $redirect = 1; 685 $arg{cookie_jar}{$cdom}{$cpath}{$name} = \%kv;
686
687 redo if /\G\s*,/gc;
589 } 688 }
590 } 689 }
591 690
592 my $finish = sub {
593 $state{handle}->destroy if $state{handle};
594 %state = ();
595
596 # set-cookie processing
597 if ($arg{cookie_jar}) {
598 for ($_[1]{"set-cookie"}) {
599 # parse NAME=VALUE
600 my @kv;
601
602 while (/\G\s* ([^=;,[:space:]]+) \s*=\s* (?: "((?:[^\\"]+|\\.)*)" | ([^=;,[:space:]]*) )/gcxs) {
603 my $name = $1;
604 my $value = $3;
605
606 unless ($value) {
607 $value = $2;
608 $value =~ s/\\(.)/$1/gs;
609 }
610
611 push @kv, $name => $value;
612
613 last unless /\G\s*;/gc;
614 }
615
616 last unless @kv;
617
618 my $name = shift @kv;
619 my %kv = (value => shift @kv, @kv);
620
621 my $cdom;
622 my $cpath = (delete $kv{path}) || "/";
623
624 if (exists $kv{domain}) {
625 $cdom = delete $kv{domain};
626
627 $cdom =~ s/^\.?/./; # make sure it starts with a "."
628
629 next if $cdom =~ /\.$/;
630
631 # this is not rfc-like and not netscape-like. go figure.
632 my $ndots = $cdom =~ y/.//;
633 next if $ndots < ($cdom =~ /\.[^.][^.]\.[^.][^.]$/ ? 3 : 2);
634 } else {
635 $cdom = $uhost;
636 }
637
638 # store it
639 $arg{cookie_jar}{version} = 1;
640 $arg{cookie_jar}{$cdom}{$cpath}{$name} = \%kv;
641
642 redo if /\G\s*,/gc;
643 }
644 }
645
646 if ($redirect && exists $hdr{location}) { 691 if ($redirect && exists $hdr{location}) {
647 # we ignore any errors, as it is very common to receive 692 # we ignore any errors, as it is very common to receive
648 # Content-Length != 0 but no actual body 693 # Content-Length != 0 but no actual body
649 # we also access %hdr, as $_[1] might be an erro 694 # we also access %hdr, as $_[1] might be an erro
650 http_request ( 695 http_request (
651 $method => $hdr{location}, 696 $method => $hdr{location},
652 %arg, 697 %arg,
653 recurse => $recurse - 1, 698 recurse => $recurse - 1,
654 Redirect => \@_, 699 Redirect => [$_[0], \%hdr],
655 $cb); 700 $cb);
656 } else {
657 $cb->($_[0], $_[1]);
658 }
659 };
660
661 my $len = $hdr{"content-length"};
662
663 if (!$redirect && $arg{on_header} && !$arg{on_header}(\%hdr)) {
664 $finish->(undef, { Status => 598, Reason => "Request cancelled by on_header", @pseudo });
665 } elsif (
666 $hdr{Status} =~ /^(?:1..|[23]04)$/
667 or $method eq "HEAD"
668 or (defined $len && !$len)
669 ) {
670 # no body
671 $finish->("", \%hdr);
672 } else { 701 } else {
702 $cb->($_[0], \%hdr);
703 }
704 };
705
706 my $len = $hdr{"content-length"};
707
708 if (!$redirect && $arg{on_header} && !$arg{on_header}(\%hdr)) {
709 $finish->(undef, 598 => "Request cancelled by on_header");
710 } elsif (
711 $hdr{Status} =~ /^(?:1..|204|205|304)$/
712 or $method eq "HEAD"
713 or (defined $len && !$len)
714 ) {
715 # no body
716 $finish->("", undef, undef, 1);
717 } else {
673 # body handling, four different code paths 718 # body handling, many different code paths
674 # for want_body_handle, on_body (2x), normal (2x) 719 # - no body expected
675 # we might read too much here, but it does not matter yet (no pers. connections) 720 # - want_body_handle
721 # - te chunked
722 # - 2x length known (with or without on_body)
723 # - 2x length not known (with or without on_body)
676 if (!$redirect && $arg{want_body_handle}) { 724 if (!$redirect && $arg{want_body_handle}) {
677 $_[0]->on_eof (undef); 725 $_[0]->on_eof (undef);
678 $_[0]->on_error (undef); 726 $_[0]->on_error (undef);
679 $_[0]->on_read (undef); 727 $_[0]->on_read (undef);
680 728
681 $finish->(delete $state{handle}, \%hdr); 729 $finish->(delete $state{handle});
682 730
683 } elsif ($arg{on_body}) { 731 } elsif ($hdr{"transfer-encoding"} =~ /\bchunked\b/i) {
732 my $cl = 0;
733 my $body = undef;
734 my $on_body = $arg{on_body} || sub { $body .= shift; 1 };
735
684 $_[0]->on_error (sub { $finish->(undef, { Status => 599, Reason => $_[2], @pseudo }) }); 736 $_[0]->on_error (sub { $finish->(undef, 599 => $_[2]) });
737
738 my $read_chunk; $read_chunk = sub {
739 $_[1] =~ /^([0-9a-fA-F]+)/
740 or $finish->(undef, 599 => "Garbled chunked transfer encoding");
741
742 my $len = hex $1;
743
685 if ($len) { 744 if ($len) {
686 $_[0]->on_eof (undef); 745 $cl += $len;
746
747 $_[0]->push_read (chunk => $len, sub {
748 $on_body->($_[1], \%hdr)
749 or return $finish->(undef, 598 => "Request cancelled by on_body");
750
687 $_[0]->on_read (sub { 751 $_[0]->push_read (line => sub {
688 $len -= length $_[0]{rbuf}; 752 length $_[1]
689 753 and return $finish->(undef, 599 => "Garbled chunked transfer encoding");
690 $arg{on_body}(delete $_[0]{rbuf}, \%hdr) 754 $_[0]->push_read (line => $read_chunk);
691 or $finish->(undef, { Status => 598, Reason => "Request cancelled by on_body", @pseudo });
692
693 $len > 0 755 });
694 or $finish->("", \%hdr);
695 }); 756 });
696 } else { 757 } else {
697 $_[0]->on_eof (sub { 758 $hdr{"content-length"} ||= $cl;
698 $finish->("", \%hdr); 759
760 $_[0]->push_read (line => $qr_nlnl, sub {
761 if (length $_[1]) {
762 for ("$_[1]") {
763 y/\015//d; # weed out any \015, as they show up in the weirdest of places.
764
765 my $hdr = parse_hdr
766 or return $finish->(undef, 599 => "Garbled response trailers");
767
768 %hdr = (%hdr, %$hdr);
769 }
699 }); 770 }
700 $_[0]->on_read (sub { 771
701 $arg{on_body}(delete $_[0]{rbuf}, \%hdr) 772 $finish->($body, undef, undef, 1);
702 or $finish->(undef, { Status => 598, Reason => "Request cancelled by on_body", @pseudo });
703 }); 773 });
704 } 774 }
775 };
776
777 $_[0]->push_read (line => $read_chunk);
778
779 } elsif ($arg{on_body}) {
780 $_[0]->on_error (sub { $finish->(undef, 599 => $_[2]) });
781
782 if ($len) {
783 $_[0]->on_read (sub {
784 $len -= length $_[0]{rbuf};
785
786 $arg{on_body}(delete $_[0]{rbuf}, \%hdr)
787 or return $finish->(undef, 598 => "Request cancelled by on_body");
788
789 $len > 0
790 or $finish->("", undef, undef, 1);
791 });
705 } else { 792 } else {
706 $_[0]->on_eof (undef); 793 $_[0]->on_eof (sub {
707 794 $finish->("");
708 if ($len) { 795 });
709 $_[0]->on_error (sub { $finish->(undef, { Status => 599, Reason => $_[2], @pseudo }) });
710 $_[0]->on_read (sub { 796 $_[0]->on_read (sub {
797 $arg{on_body}(delete $_[0]{rbuf}, \%hdr)
798 or $finish->(undef, 598 => "Request cancelled by on_body");
799 });
800 }
801 } else {
802 $_[0]->on_eof (undef);
803
804 if ($len) {
805 $_[0]->on_error (sub { $finish->(undef, 599 => $_[2]) });
806 $_[0]->on_read (sub {
711 $finish->((substr delete $_[0]{rbuf}, 0, $len, ""), \%hdr) 807 $finish->((substr delete $_[0]{rbuf}, 0, $len, ""), undef, undef, 1)
712 if $len <= length $_[0]{rbuf}; 808 if $len <= length $_[0]{rbuf};
713 }); 809 });
714 } else { 810 } else {
715 $_[0]->on_error (sub { 811 $_[0]->on_error (sub {
716 $! == Errno::EPIPE || !$! 812 ($! == Errno::EPIPE || !$!)
717 ? $finish->(delete $_[0]{rbuf}, \%hdr) 813 ? $finish->(delete $_[0]{rbuf})
718 : $finish->(undef, { Status => 599, Reason => $_[2], @pseudo }); 814 : $finish->(undef, 599 => $_[2]);
719 }); 815 });
720 $_[0]->on_read (sub { }); 816 $_[0]->on_read (sub { });
721 }
722 } 817 }
723 } 818 }
724 }); 819 }
725 }); 820 };
821
822 $state{handle}->push_read (line => $qr_nlnl, $state{read_response});
726 }; 823 };
727 824
728 # now handle proxy-CONNECT method 825 # now handle proxy-CONNECT method
729 if ($proxy && $uscheme eq "https") { 826 if ($proxy && $uscheme eq "https") {
730 # oh dear, we have to wrap it into a connect request 827 # oh dear, we have to wrap it into a connect request
731 828
732 # maybe re-use $uauthority with patched port? 829 # maybe re-use $uauthority with patched port?
733 $state{handle}->push_write ("CONNECT $uhost:$uport HTTP/1.0\015\012Host: $uhost\015\012\015\012"); 830 $state{handle}->push_write ("CONNECT $uhost:$uport HTTP/1.0\015\012Host: $uhost\015\012\015\012");
734 $state{handle}->push_read (line => $qr_nlnl, sub { 831 $state{handle}->push_read (line => $qr_nlnl, sub {
735 $_[1] =~ /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\015\012]*) )?/ix 832 $_[1] =~ /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\015\012]*) )?/ix
736 or return (%state = (), $cb->(undef, { Status => 599, Reason => "Invalid proxy connect response ($_[1])", @pseudo })); 833 or return (%state = (), $cb->(undef, { @pseudo, Status => 599, Reason => "Invalid proxy connect response ($_[1])" }));
737 834
738 if ($2 == 200) { 835 if ($2 == 200) {
739 $rpath = $upath; 836 $rpath = $upath;
740 &$handle_actual_request; 837 &$handle_actual_request;
741 } else { 838 } else {
742 %state = (); 839 %state = ();
743 $cb->(undef, { Status => $2, Reason => $3, @pseudo }); 840 $cb->(undef, { @pseudo, Status => $2, Reason => $3 });
744 } 841 }
745 }); 842 });
746 } else { 843 } else {
747 &$handle_actual_request; 844 &$handle_actual_request;
748 } 845 }
846 };
749 847
750 }, $arg{on_prepare} || sub { $timeout }; 848 my $tcp_connect = $arg{tcp_connect}
849 || do { require AnyEvent::Socket; \&AnyEvent::Socket::tcp_connect };
850
851 $state{connect_guard} = $tcp_connect->($rhost, $rport, $connect_cb, $arg{on_prepare} || sub { $timeout });
852
751 }; 853 };
752 854
753 defined wantarray && AnyEvent::Util::guard { %state = () } 855 defined wantarray && AnyEvent::Util::guard { %state = () }
754} 856}
755 857
790string of the form C<http://host:port> (optionally C<https:...>), croaks 892string of the form C<http://host:port> (optionally C<https:...>), croaks
791otherwise. 893otherwise.
792 894
793To clear an already-set proxy, use C<undef>. 895To clear an already-set proxy, use C<undef>.
794 896
897=item $date = AnyEvent::HTTP::format_date $timestamp
898
899Takes a POSIX timestamp (seconds since the epoch) and formats it as a HTTP
900Date (RFC 2616).
901
902=item $timestamp = AnyEvent::HTTP::parse_date $date
903
904Takes a HTTP Date (RFC 2616) and returns the corresponding POSIX
905timestamp, or C<undef> if the date cannot be parsed.
906
795=item $AnyEvent::HTTP::MAX_RECURSE 907=item $AnyEvent::HTTP::MAX_RECURSE
796 908
797The default value for the C<recurse> request parameter (default: C<10>). 909The default value for the C<recurse> request parameter (default: C<10>).
798 910
799=item $AnyEvent::HTTP::USERAGENT 911=item $AnyEvent::HTTP::USERAGENT
817connections. This number of can be useful for load-leveling. 929connections. This number of can be useful for load-leveling.
818 930
819=back 931=back
820 932
821=cut 933=cut
934
935our @month = qw(Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec);
936our @weekday = qw(Sun Mon Tue Wed Thu Fri Sat);
937
938sub format_date($) {
939 my ($time) = @_;
940
941 # RFC 822/1123 format
942 my ($S, $M, $H, $mday, $mon, $year, $wday, $yday, undef) = gmtime $time;
943
944 sprintf "%s, %02d %s %04d %02d:%02d:%02d GMT",
945 $weekday[$wday], $mday, $month[$mon], $year + 1900,
946 $H, $M, $S;
947}
948
949sub parse_date($) {
950 my ($date) = @_;
951
952 my ($d, $m, $y, $H, $M, $S);
953
954 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$/) {
955 # RFC 822/1123, required by RFC 2616
956 ($d, $m, $y, $H, $M, $S) = ($1, $2, $3, $4, $5, $6);
957
958 } 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$/) {
959 # RFC 850
960 ($d, $m, $y, $H, $M, $S) = ($1, $2, $3 < 69 ? $3 + 2000 : $3 + 1900, $4, $5, $6);
961
962 } 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])$/) {
963 # ISO C's asctime
964 ($d, $m, $y, $H, $M, $S) = ($2, $1, $6, $3, $4, $5);
965 }
966 # other formats fail in the loop below
967
968 for (0..11) {
969 if ($m eq $month[$_]) {
970 require Time::Local;
971 return Time::Local::timegm ($S, $M, $H, $d, $_, $y);
972 }
973 }
974
975 undef
976}
822 977
823sub set_proxy($) { 978sub set_proxy($) {
824 if (length $_[0]) { 979 if (length $_[0]) {
825 $_[0] =~ m%^(https?):// ([^:/]+) (?: : (\d*) )?%ix 980 $_[0] =~ m%^(https?):// ([^:/]+) (?: : (\d*) )?%ix
826 or Carp::croak "$_[0]: invalid proxy URL"; 981 or Carp::croak "$_[0]: invalid proxy URL";
833# initialise proxy from environment 988# initialise proxy from environment
834eval { 989eval {
835 set_proxy $ENV{http_proxy}; 990 set_proxy $ENV{http_proxy};
836}; 991};
837 992
993=head2 SOCKS PROXIES
994
995Socks proxies are not directly supported by AnyEvent::HTTP. You can
996compile your perl to support socks, or use an external program such as
997F<socksify> (dante) or F<tsocks> to make your program use a socks proxy
998transparently.
999
1000Alternatively, for AnyEvent::HTTP only, you can use your own
1001C<tcp_connect> function that does the proxy handshake - here is an example
1002that works with socks4a proxies:
1003
1004 use Errno;
1005 use AnyEvent::Util;
1006 use AnyEvent::Socket;
1007 use AnyEvent::Handle;
1008
1009 # host, port and username of/for your socks4a proxy
1010 my $socks_host = "10.0.0.23";
1011 my $socks_port = 9050;
1012 my $socks_user = "";
1013
1014 sub socks4a_connect {
1015 my ($host, $port, $connect_cb, $prepare_cb) = @_;
1016
1017 my $hdl = new AnyEvent::Handle
1018 connect => [$socks_host, $socks_port],
1019 on_prepare => sub { $prepare_cb->($_[0]{fh}) },
1020 on_error => sub { $connect_cb->() },
1021 ;
1022
1023 $hdl->push_write (pack "CCnNZ*Z*", 4, 1, $port, 1, $socks_user, $host);
1024
1025 $hdl->push_read (chunk => 8, sub {
1026 my ($hdl, $chunk) = @_;
1027 my ($status, $port, $ipn) = unpack "xCna4", $chunk;
1028
1029 if ($status == 0x5a) {
1030 $connect_cb->($hdl->{fh}, (format_address $ipn) . ":$port");
1031 } else {
1032 $! = Errno::ENXIO; $connect_cb->();
1033 }
1034 });
1035
1036 $hdl
1037 }
1038
1039Use C<socks4a_connect> instead of C<tcp_connect> when doing C<http_request>s,
1040possibly after switching off other proxy types:
1041
1042 AnyEvent::HTTP::set_proxy undef; # usually you do not want other proxies
1043
1044 http_get 'http://www.google.com', tcp_connect => \&socks4a_connect, sub {
1045 my ($data, $headers) = @_;
1046 ...
1047 };
1048
838=head1 SEE ALSO 1049=head1 SEE ALSO
839 1050
840L<AnyEvent>. 1051L<AnyEvent>.
841 1052
842=head1 AUTHOR 1053=head1 AUTHOR

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines