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.59 by root, Wed Dec 29 23:59:36 2010 UTC vs.
Revision 1.68 by root, Fri Dec 31 19:22:18 2010 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
147Whether to recurse requests or not, e.g. on redirects, authentication 150Whether to recurse requests or not, e.g. on redirects, authentication
148retries and so on, and how often to do so. 151retries and so on, and how often to do so.
149 152
150=item headers => hashref 153=item headers => hashref
151 154
152The request headers to use. Currently, C<http_request> may provide its 155The request headers to use. Currently, C<http_request> may provide its own
153own C<Host:>, C<Content-Length:>, C<Connection:> and C<Cookie:> headers 156C<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 157will provide defaults for C<TE:>, C<Referer:> and C<User-Agent:> (this can
155suppressed 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
156sent at all). 159be sent at all).
157 160
158=item timeout => $seconds 161=item timeout => $seconds
159 162
160The 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
161the 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
171C<$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
172HTTPS. 175HTTPS.
173 176
174=item body => $string 177=item body => $string
175 178
176The 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
177this module might offer more options). 180this module might offer more options).
178 181
179=item cookie_jar => $hash_ref 182=item cookie_jar => $hash_ref
180 183
181Passing this parameter enables (simplified) cookie-processing, loosely 184Passing this parameter enables (simplified) cookie-processing, loosely
216=item tcp_connect => $callback->($host, $service, $connect_cb, $prepare_cb) 219=item tcp_connect => $callback->($host, $service, $connect_cb, $prepare_cb)
217 220
218In even rarer cases you want total control over how AnyEvent::HTTP 221In even rarer cases you want total control over how AnyEvent::HTTP
219establishes connections. Normally it uses L<AnyEvent::Socket::tcp_connect> 222establishes connections. Normally it uses L<AnyEvent::Socket::tcp_connect>
220to do this, but you can provide your own C<tcp_connect> function - 223to do this, but you can provide your own C<tcp_connect> function -
221obviously, it has to follow the same calling conventions. 224obviously, it has to follow the same calling conventions, except that it
225may always return a connection guard object.
222 226
223There are probably lots of weird uses for this function, starting from 227There are probably lots of weird uses for this function, starting from
224tracing the hosts C<http_request> actually tries to connect, to (inexact 228tracing the hosts C<http_request> actually tries to connect, to (inexact
225but fast) host => IP address caching or even socks protocol support. 229but fast) host => IP address caching or even socks protocol support.
226 230
236 240
237This callback is useful, among other things, to quickly reject unwanted 241This callback is useful, among other things, to quickly reject unwanted
238content, 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
239doing a C<HEAD> request. 243doing a C<HEAD> request.
240 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
241Example: cancel the request unless the content-type is "text/html". 249Example: cancel the request unless the content-type is "text/html".
242 250
243 on_header => sub { 251 on_header => sub {
244 $_[0]{"content-type"} =~ /^text\/html\s*(?:;|$)/ 252 $_[0]{"content-type"} =~ /^text\/html\s*(?:;|$)/
245 }, 253 },
251string instead of the body data. 259string instead of the body data.
252 260
253It 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),
254or 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
255the 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.
256 267
257This 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
258(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
259be extracted, or when the body should be processed incrementally. 270be extracted, or when the body should be processed incrementally.
260 271
286If 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
287that doesn't solve your problem in a better way. 298that doesn't solve your problem in a better way.
288 299
289=back 300=back
290 301
291Example: 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.
292 304
293 http_request GET => "http://www.nethype.de/", sub { 305 http_request GET => "http://www.nethype.de/", sub {
294 my ($body, $hdr) = @_; 306 my ($body, $hdr) = @_;
295 print "$body\n"; 307 print "$body\n";
296 }; 308 };
297 309
298Example: 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
299timeout of 30 seconds. 311timeout of 30 seconds.
300 312
301 http_request 313 http_request
302 GET => "https://www.google.com", 314 GET => "https://www.google.com",
303 timeout => 30, 315 timeout => 30,
306 use Data::Dumper; 318 use Data::Dumper;
307 print Dumper $hdr; 319 print Dumper $hdr;
308 } 320 }
309 ; 321 ;
310 322
311Example: make another simple HTTP GET request, but immediately try to 323Example: do another simple HTTP GET request, but immediately try to
312cancel it. 324cancel it.
313 325
314 my $request = http_request GET => "http://www.nethype.de/", sub { 326 my $request = http_request GET => "http://www.nethype.de/", sub {
315 my ($body, $hdr) = @_; 327 my ($body, $hdr) = @_;
316 print "$body\n"; 328 print "$body\n";
348 push @{ $CO_SLOT{$_[0]}[1] }, $_[1]; 360 push @{ $CO_SLOT{$_[0]}[1] }, $_[1];
349 361
350 _slot_schedule $_[0]; 362 _slot_schedule $_[0];
351} 363}
352 364
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
353our $qr_nlnl = qr{(?<![^\012])\015?\012}; 390our $qr_nlnl = qr{(?<![^\012])\015?\012};
354 391
355our $TLS_CTX_LOW = { cache => 1, sslv2 => 1 }; 392our $TLS_CTX_LOW = { cache => 1, sslv2 => 1 };
356our $TLS_CTX_HIGH = { cache => 1, verify => 1, verify_peername => "https" }; 393our $TLS_CTX_HIGH = { cache => 1, verify => 1, verify_peername => "https" };
357 394
376 my @pseudo = (URL => $url); 413 my @pseudo = (URL => $url);
377 push @pseudo, Redirect => delete $arg{Redirect} if exists $arg{Redirect}; 414 push @pseudo, Redirect => delete $arg{Redirect} if exists $arg{Redirect};
378 415
379 my $recurse = exists $arg{recurse} ? delete $arg{recurse} : $MAX_RECURSE; 416 my $recurse = exists $arg{recurse} ? delete $arg{recurse} : $MAX_RECURSE;
380 417
381 return $cb->(undef, { Status => 599, Reason => "Too many redirections", @pseudo }) 418 return $cb->(undef, { @pseudo, Status => 599, Reason => "Too many redirections" })
382 if $recurse < 0; 419 if $recurse < 0;
383 420
384 my $proxy = $arg{proxy} || $PROXY; 421 my $proxy = $arg{proxy} || $PROXY;
385 my $timeout = $arg{timeout} || $TIMEOUT; 422 my $timeout = $arg{timeout} || $TIMEOUT;
386 423
389 426
390 $uscheme = lc $uscheme; 427 $uscheme = lc $uscheme;
391 428
392 my $uport = $uscheme eq "http" ? 80 429 my $uport = $uscheme eq "http" ? 80
393 : $uscheme eq "https" ? 443 430 : $uscheme eq "https" ? 443
394 : 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" });
395 432
396 $uauthority =~ /^(?: .*\@ )? ([^\@:]+) (?: : (\d+) )?$/x 433 $uauthority =~ /^(?: .*\@ )? ([^\@:]+) (?: : (\d+) )?$/x
397 or return $cb->(undef, { Status => 599, Reason => "Unparsable URL", @pseudo }); 434 or return $cb->(undef, { @pseudo, Status => 599, Reason => "Unparsable URL" });
398 435
399 my $uhost = $1; 436 my $uhost = $1;
400 $uport = $2 if defined $2; 437 $uport = $2 if defined $2;
401 438
402 $hdr{host} = defined $2 ? "$uhost:$2" : "$uhost" 439 $hdr{host} = defined $2 ? "$uhost:$2" : "$uhost"
451 } else { 488 } else {
452 ($rhost, $rport, $rscheme, $rpath) = ($uhost, $uport, $uscheme, $upath); 489 ($rhost, $rport, $rscheme, $rpath) = ($uhost, $uport, $uscheme, $upath);
453 } 490 }
454 491
455 # leave out fragment and query string, just a heuristic 492 # leave out fragment and query string, just a heuristic
456 $hdr{referer} ||= "$uscheme://$uauthority$upath" unless exists $hdr{referer}; 493 $hdr{referer} = "$uscheme://$uauthority$upath" unless exists $hdr{referer};
457 $hdr{"user-agent"} ||= $USERAGENT unless exists $hdr{"user-agent"}; 494 $hdr{"user-agent"} = $USERAGENT unless exists $hdr{"user-agent"};
458 495
459 $hdr{"content-length"} = length $arg{body} 496 $hdr{"content-length"} = length $arg{body}
460 if length $arg{body} || $method ne "GET"; 497 if length $arg{body} || $method ne "GET";
461 498
499 $hdr{connection} = "close TE"; #1.1
500 $hdr{te} = "trailers" unless exists $hdr{te}; #1.1
501
462 my %state = (connect_guard => 1); 502 my %state = (connect_guard => 1);
463 503
464 _get_slot $uhost, sub { 504 _get_slot $uhost, sub {
465 $state{slot_guard} = shift; 505 $state{slot_guard} = shift;
466 506
467 return unless $state{connect_guard}; 507 return unless $state{connect_guard};
468 508
469 my $tcp_connect = $arg{tcp_connect} 509 my $connect_cb = sub {
470 || do { require AnyEvent::Socket; \&AnyEvent::Socket::tcp_connect };
471
472 $state{connect_guard} = $tcp_connect->(
473 $rhost,
474 $rport,
475 sub {
476 $state{fh} = shift 510 $state{fh} = shift
477 or do { 511 or do {
478 my $err = "$!"; 512 my $err = "$!";
479 %state = (); 513 %state = ();
480 return $cb->(undef, { Status => 599, Reason => $err, @pseudo }); 514 return $cb->(undef, { @pseudo, Status => 599, Reason => $err });
481 }; 515 };
482 516
483 pop; # free memory, save a tree 517 pop; # free memory, save a tree
484 518
485 return unless delete $state{connect_guard}; 519 return unless delete $state{connect_guard};
486 520
487 # get handle 521 # get handle
488 $state{handle} = new AnyEvent::Handle 522 $state{handle} = new AnyEvent::Handle
489 fh => $state{fh}, 523 fh => $state{fh},
490 peername => $rhost, 524 peername => $rhost,
491 tls_ctx => $arg{tls_ctx}, 525 tls_ctx => $arg{tls_ctx},
492 # these need to be reconfigured on keepalive handles 526 # these need to be reconfigured on keepalive handles
493 timeout => $timeout, 527 timeout => $timeout,
494 on_error => sub { 528 on_error => sub {
495 %state = (); 529 %state = ();
496 $cb->(undef, { Status => 599, Reason => $_[2], @pseudo }); 530 $cb->(undef, { @pseudo, Status => 599, Reason => $_[2] });
497 }, 531 },
498 on_eof => sub { 532 on_eof => sub {
499 %state = (); 533 %state = ();
500 $cb->(undef, { Status => 599, Reason => "Unexpected end-of-file", @pseudo }); 534 $cb->(undef, { @pseudo, Status => 599, Reason => "Unexpected end-of-file" });
501 }, 535 },
502 ; 536 ;
503 537
504 # limit the number of persistent connections 538 # limit the number of persistent connections
505 # keepalive not yet supported 539 # keepalive not yet supported
506# if ($KA_COUNT{$_[1]} < $MAX_PERSISTENT_PER_HOST) { 540# if ($KA_COUNT{$_[1]} < $MAX_PERSISTENT_PER_HOST) {
507# ++$KA_COUNT{$_[1]}; 541# ++$KA_COUNT{$_[1]};
508# $state{handle}{ka_count_guard} = AnyEvent::Util::guard { 542# $state{handle}{ka_count_guard} = AnyEvent::Util::guard {
509# --$KA_COUNT{$_[1]} 543# --$KA_COUNT{$_[1]}
510# }; 544# };
511# $hdr{connection} = "keep-alive"; 545# $hdr{connection} = "keep-alive";
512# } else {
513 delete $hdr{connection};
514# } 546# }
515 547
516 $state{handle}->starttls ("connect") if $rscheme eq "https"; 548 $state{handle}->starttls ("connect") if $rscheme eq "https";
517 549
518 # handle actual, non-tunneled, request 550 # handle actual, non-tunneled, request
519 my $handle_actual_request = sub { 551 my $handle_actual_request = sub {
520 $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};
521 553
522 # send request 554 # send request
523 $state{handle}->push_write ( 555 $state{handle}->push_write (
524 "$method $rpath HTTP/1.0\015\012" 556 "$method $rpath HTTP/1.1\015\012"
525 . (join "", map "\u$_: $hdr{$_}\015\012", grep defined $hdr{$_}, keys %hdr) 557 . (join "", map "\u$_: $hdr{$_}\015\012", grep defined $hdr{$_}, keys %hdr)
526 . "\015\012" 558 . "\015\012"
527 . (delete $arg{body}) 559 . (delete $arg{body})
528 ); 560 );
529 561
530 # return if error occured during push_write() 562 # return if error occured during push_write()
531 return unless %state; 563 return unless %state;
532 564
533 %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
534 566
535 # status line and headers 567 # status line and headers
536 $state{handle}->push_read (line => $qr_nlnl, sub { 568 $state{read_response} = sub {
537 for ("$_[1]") { 569 for ("$_[1]") {
538 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.
539 571
540 /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\015\012]*) )? \015?\012/igxc 572 /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\012]*) )? \012/igxc
541 or return (%state = (), $cb->(undef, { Status => 599, Reason => "Invalid server response", @pseudo })); 573 or return (%state = (), $cb->(undef, { @pseudo, Status => 599, Reason => "Invalid server response" }));
542 574
575 # 100 Continue handling
576 # should not happen as we don't send expect: 100-continue,
577 # but we handle it just in case.
578 # since we send the request body regardless, if we get an error
579 # we are out of-sync, which we currently do NOT handle correctly.
580 return $state{handle}->push_read (line => $qr_nlnl, $state{read_response})
581 if $2 eq 100;
582
543 push @pseudo, 583 push @pseudo,
544 HTTPVersion => $1, 584 HTTPVersion => $1,
545 Status => $2, 585 Status => $2,
546 Reason => $3, 586 Reason => $3,
547 ; 587 ;
548 588
549 # things seen, not parsed: 589 my $hdr = parse_hdr
550 # p3pP="NON CUR OTPi OUR NOR UNI"
551
552 $hdr{lc $1} .= ",$2"
553 while /\G
554 ([^:\000-\037]*):
555 [\011\040]*
556 ((?: [^\012]+ | \012[\011\040] )*)
557 \012
558 /gxc;
559
560 /\G$/
561 or return (%state = (), $cb->(undef, { 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/\/[^\/]*$//;
562 } 606 }
563 607
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}"; 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;
585 } 627 }
628 }
586 629
630 my $finish = sub { # ($data, $err_status, $err_reason[, $keepalive])
587 my $redirect; 631 my $keepalive = pop;
588 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
589 if ($recurse) { 642 if ($arg{cookie_jar}) {
590 my $status = $hdr{Status}; 643 for ($hdr{"set-cookie"}) {
644 # parse NAME=VALUE
645 my @kv;
591 646
592 # industry standard is to redirect POST as GET for 647 while (/\G\s* ([^=;,[:space:]]+) \s*=\s* (?: "((?:[^\\"]+|\\.)*)" | ([^=;,[:space:]]*) )/gcxs) {
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; 648 my $name = $1;
601 } elsif ($status == 307) { 649 my $value = $3;
650
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
602 $redirect = 1; 683 # store it
684 $arg{cookie_jar}{version} = 1;
685 $arg{cookie_jar}{$cdom}{$cpath}{$name} = \%kv;
686
687 redo if /\G\s*,/gc;
603 } 688 }
604 } 689 }
605 690
606 my $finish = sub {
607 $state{handle}->destroy if $state{handle};
608 %state = ();
609
610 # set-cookie processing
611 if ($arg{cookie_jar}) {
612 for ($_[1]{"set-cookie"}) {
613 # parse NAME=VALUE
614 my @kv;
615
616 while (/\G\s* ([^=;,[:space:]]+) \s*=\s* (?: "((?:[^\\"]+|\\.)*)" | ([^=;,[:space:]]*) )/gcxs) {
617 my $name = $1;
618 my $value = $3;
619
620 unless ($value) {
621 $value = $2;
622 $value =~ s/\\(.)/$1/gs;
623 }
624
625 push @kv, $name => $value;
626
627 last unless /\G\s*;/gc;
628 }
629
630 last unless @kv;
631
632 my $name = shift @kv;
633 my %kv = (value => shift @kv, @kv);
634
635 my $cdom;
636 my $cpath = (delete $kv{path}) || "/";
637
638 if (exists $kv{domain}) {
639 $cdom = delete $kv{domain};
640
641 $cdom =~ s/^\.?/./; # make sure it starts with a "."
642
643 next if $cdom =~ /\.$/;
644
645 # this is not rfc-like and not netscape-like. go figure.
646 my $ndots = $cdom =~ y/.//;
647 next if $ndots < ($cdom =~ /\.[^.][^.]\.[^.][^.]$/ ? 3 : 2);
648 } else {
649 $cdom = $uhost;
650 }
651
652 # store it
653 $arg{cookie_jar}{version} = 1;
654 $arg{cookie_jar}{$cdom}{$cpath}{$name} = \%kv;
655
656 redo if /\G\s*,/gc;
657 }
658 }
659
660 if ($redirect && exists $hdr{location}) { 691 if ($redirect && exists $hdr{location}) {
661 # we ignore any errors, as it is very common to receive 692 # we ignore any errors, as it is very common to receive
662 # Content-Length != 0 but no actual body 693 # Content-Length != 0 but no actual body
663 # we also access %hdr, as $_[1] might be an erro 694 # we also access %hdr, as $_[1] might be an erro
664 http_request ( 695 http_request (
665 $method => $hdr{location}, 696 $method => $hdr{location},
666 %arg, 697 %arg,
667 recurse => $recurse - 1, 698 recurse => $recurse - 1,
668 Redirect => \@_, 699 Redirect => [$_[0], \%hdr],
669 $cb); 700 $cb);
670 } else {
671 $cb->($_[0], $_[1]);
672 }
673 };
674
675 my $len = $hdr{"content-length"};
676
677 if (!$redirect && $arg{on_header} && !$arg{on_header}(\%hdr)) {
678 $finish->(undef, { Status => 598, Reason => "Request cancelled by on_header", @pseudo });
679 } elsif (
680 $hdr{Status} =~ /^(?:1..|[23]04)$/
681 or $method eq "HEAD"
682 or (defined $len && !$len)
683 ) {
684 # no body
685 $finish->("", \%hdr);
686 } 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 {
687 # body handling, four different code paths 718 # body handling, many different code paths
688 # for want_body_handle, on_body (2x), normal (2x) 719 # - no body expected
689 # 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)
690 if (!$redirect && $arg{want_body_handle}) { 724 if (!$redirect && $arg{want_body_handle}) {
691 $_[0]->on_eof (undef); 725 $_[0]->on_eof (undef);
692 $_[0]->on_error (undef); 726 $_[0]->on_error (undef);
693 $_[0]->on_read (undef); 727 $_[0]->on_read (undef);
694 728
695 $finish->(delete $state{handle}, \%hdr); 729 $finish->(delete $state{handle});
696 730
697 } 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
698 $_[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
699 if ($len) { 744 if ($len) {
700 $_[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
701 $_[0]->on_read (sub { 751 $_[0]->push_read (line => sub {
702 $len -= length $_[0]{rbuf}; 752 length $_[1]
703 753 and return $finish->(undef, 599 => "Garbled chunked transfer encoding");
704 $arg{on_body}(delete $_[0]{rbuf}, \%hdr) 754 $_[0]->push_read (line => $read_chunk);
705 or $finish->(undef, { Status => 598, Reason => "Request cancelled by on_body", @pseudo });
706
707 $len > 0 755 });
708 or $finish->("", \%hdr);
709 }); 756 });
710 } else { 757 } else {
711 $_[0]->on_eof (sub { 758 $hdr{"content-length"} ||= $cl;
712 $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 }
713 }); 770 }
714 $_[0]->on_read (sub { 771
715 $arg{on_body}(delete $_[0]{rbuf}, \%hdr) 772 $finish->($body, undef, undef, 1);
716 or $finish->(undef, { Status => 598, Reason => "Request cancelled by on_body", @pseudo });
717 }); 773 });
718 } 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 });
719 } else { 792 } else {
720 $_[0]->on_eof (undef); 793 $_[0]->on_eof (sub {
721 794 $finish->("");
722 if ($len) { 795 });
723 $_[0]->on_error (sub { $finish->(undef, { Status => 599, Reason => $_[2], @pseudo }) });
724 $_[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 {
725 $finish->((substr delete $_[0]{rbuf}, 0, $len, ""), \%hdr) 807 $finish->((substr delete $_[0]{rbuf}, 0, $len, ""), undef, undef, 1)
726 if $len <= length $_[0]{rbuf}; 808 if $len <= length $_[0]{rbuf};
727 }); 809 });
728 } else { 810 } else {
729 $_[0]->on_error (sub { 811 $_[0]->on_error (sub {
730 ($! == Errno::EPIPE || !$!) 812 ($! == Errno::EPIPE || !$!)
731 ? $finish->(delete $_[0]{rbuf}, \%hdr) 813 ? $finish->(delete $_[0]{rbuf})
732 : $finish->(undef, { Status => 599, Reason => $_[2], @pseudo }); 814 : $finish->(undef, 599 => $_[2]);
733 }); 815 });
734 $_[0]->on_read (sub { }); 816 $_[0]->on_read (sub { });
735 }
736 } 817 }
737 } 818 }
738 }); 819 }
739 }; 820 };
740 821
822 $state{handle}->push_read (line => $qr_nlnl, $state{read_response});
823 };
824
741 # now handle proxy-CONNECT method 825 # now handle proxy-CONNECT method
742 if ($proxy && $uscheme eq "https") { 826 if ($proxy && $uscheme eq "https") {
743 # oh dear, we have to wrap it into a connect request 827 # oh dear, we have to wrap it into a connect request
744 828
745 # maybe re-use $uauthority with patched port? 829 # maybe re-use $uauthority with patched port?
746 $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");
747 $state{handle}->push_read (line => $qr_nlnl, sub { 831 $state{handle}->push_read (line => $qr_nlnl, sub {
748 $_[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
749 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])" }));
750 834
751 if ($2 == 200) { 835 if ($2 == 200) {
752 $rpath = $upath; 836 $rpath = $upath;
753 &$handle_actual_request; 837 &$handle_actual_request;
754 } else { 838 } else {
755 %state = (); 839 %state = ();
756 $cb->(undef, { Status => $2, Reason => $3, @pseudo }); 840 $cb->(undef, { @pseudo, Status => $2, Reason => $3 });
757 }
758 }); 841 }
842 });
759 } else { 843 } else {
760 &$handle_actual_request; 844 &$handle_actual_request;
761 }
762
763 }, 845 }
764 $arg{on_prepare} || sub { $timeout }
765 ); 846 };
847
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
766 }; 853 };
767 854
768 defined wantarray && AnyEvent::Util::guard { %state = () } 855 defined wantarray && AnyEvent::Util::guard { %state = () }
769} 856}
770 857
805string of the form C<http://host:port> (optionally C<https:...>), croaks 892string of the form C<http://host:port> (optionally C<https:...>), croaks
806otherwise. 893otherwise.
807 894
808To clear an already-set proxy, use C<undef>. 895To clear an already-set proxy, use C<undef>.
809 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
810=item $AnyEvent::HTTP::MAX_RECURSE 907=item $AnyEvent::HTTP::MAX_RECURSE
811 908
812The default value for the C<recurse> request parameter (default: C<10>). 909The default value for the C<recurse> request parameter (default: C<10>).
813 910
814=item $AnyEvent::HTTP::USERAGENT 911=item $AnyEvent::HTTP::USERAGENT
832connections. This number of can be useful for load-leveling. 929connections. This number of can be useful for load-leveling.
833 930
834=back 931=back
835 932
836=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}
837 977
838sub set_proxy($) { 978sub set_proxy($) {
839 if (length $_[0]) { 979 if (length $_[0]) {
840 $_[0] =~ m%^(https?):// ([^:/]+) (?: : (\d*) )?%ix 980 $_[0] =~ m%^(https?):// ([^:/]+) (?: : (\d*) )?%ix
841 or Carp::croak "$_[0]: invalid proxy URL"; 981 or Carp::croak "$_[0]: invalid proxy URL";
848# initialise proxy from environment 988# initialise proxy from environment
849eval { 989eval {
850 set_proxy $ENV{http_proxy}; 990 set_proxy $ENV{http_proxy};
851}; 991};
852 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
853=head1 SEE ALSO 1049=head1 SEE ALSO
854 1050
855L<AnyEvent>. 1051L<AnyEvent>.
856 1052
857=head1 AUTHOR 1053=head1 AUTHOR

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines