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.71 by root, Fri Dec 31 20:50:58 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 at least for C<TE:>, C<Referer:> and C<User-Agent:>
156suppressed by using C<undef> for these headers in which case they won't be 158(this can be suppressed by using C<undef> for these headers in which case
157sent at all). 159they won't be 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
183based on the original netscape specification. 185based on the original netscape specification.
184 186
185The C<$hash_ref> must be an (initially empty) hash reference which will 187The C<$hash_ref> must be an (initially empty) hash reference which will
186get updated automatically. It is possible to save the cookie_jar to 188get updated automatically. It is possible to save the cookie jar to
187persistent storage with something like JSON or Storable, but this is not 189persistent storage with something like JSON or Storable, but this is not
188recommended, as expiry times are currently being ignored. 190recommended, as session-only cookies might survive longer than expected.
189 191
190Note that this cookie implementation is not of very high quality, nor 192Note that this cookie implementation is not meant to be complete. If
191meant to be complete. If you want complete cookie management you have to 193you want complete cookie management you have to do that on your
192do that on your own. C<cookie_jar> is meant as a quick fix to get some 194own. C<cookie_jar> is meant as a quick fix to get some cookie-using sites
193cookie-using sites working. Cookies are a privacy disaster, do not use 195working. Cookies are a privacy disaster, do not use them unless required
194them unless required to. 196to.
197
198When cookie processing is enabled, the C<Cookie:> and C<Set-Cookie:>
199headers will be set and handled by this module, otherwise they will be
200left untouched.
195 201
196=item tls_ctx => $scheme | $tls_ctx 202=item tls_ctx => $scheme | $tls_ctx
197 203
198Specifies the AnyEvent::TLS context to be used for https connections. This 204Specifies the AnyEvent::TLS context to be used for https connections. This
199parameter follows the same rules as the C<tls_ctx> parameter to 205parameter follows the same rules as the C<tls_ctx> parameter to
212overrides the prepare callback passed to C<AnyEvent::Socket::tcp_connect> 218overrides the prepare callback passed to C<AnyEvent::Socket::tcp_connect>
213and behaves exactly the same way (e.g. it has to provide a 219and behaves exactly the same way (e.g. it has to provide a
214timeout). See the description for the C<$prepare_cb> argument of 220timeout). See the description for the C<$prepare_cb> argument of
215C<AnyEvent::Socket::tcp_connect> for details. 221C<AnyEvent::Socket::tcp_connect> for details.
216 222
223=item tcp_connect => $callback->($host, $service, $connect_cb, $prepare_cb)
224
225In even rarer cases you want total control over how AnyEvent::HTTP
226establishes connections. Normally it uses L<AnyEvent::Socket::tcp_connect>
227to do this, but you can provide your own C<tcp_connect> function -
228obviously, it has to follow the same calling conventions, except that it
229may always return a connection guard object.
230
231There are probably lots of weird uses for this function, starting from
232tracing the hosts C<http_request> actually tries to connect, to (inexact
233but fast) host => IP address caching or even socks protocol support.
234
217=item on_header => $callback->($headers) 235=item on_header => $callback->($headers)
218 236
219When specified, this callback will be called with the header hash as soon 237When specified, this callback will be called with the header hash as soon
220as headers have been successfully received from the remote server (not on 238as headers have been successfully received from the remote server (not on
221locally-generated errors). 239locally-generated errors).
226 244
227This callback is useful, among other things, to quickly reject unwanted 245This callback is useful, among other things, to quickly reject unwanted
228content, which, if it is supposed to be rare, can be faster than first 246content, which, if it is supposed to be rare, can be faster than first
229doing a C<HEAD> request. 247doing a C<HEAD> request.
230 248
249The downside is that cancelling the request makes it impossible to re-use
250the connection. Also, the C<on_header> callback will not receive any
251trailer (headers sent after the response body).
252
231Example: cancel the request unless the content-type is "text/html". 253Example: cancel the request unless the content-type is "text/html".
232 254
233 on_header => sub { 255 on_header => sub {
234 $_[0]{"content-type"} =~ /^text\/html\s*(?:;|$)/ 256 $_[0]{"content-type"} =~ /^text\/html\s*(?:;|$)/
235 }, 257 },
241string instead of the body data. 263string instead of the body data.
242 264
243It has to return either true (in which case AnyEvent::HTTP will continue), 265It 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 266or false, in which case AnyEvent::HTTP will cancel the download (and call
245the completion callback with an error code of C<598>). 267the completion callback with an error code of C<598>).
268
269The downside to cancelling the request is that it makes it impossible to
270re-use the connection.
246 271
247This callback is useful when the data is too large to be held in memory 272This 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 273(so the callback writes it to a file) or when only some information should
249be extracted, or when the body should be processed incrementally. 274be extracted, or when the body should be processed incrementally.
250 275
276If you think you need this, first have a look at C<on_body>, to see if 301If 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. 302that doesn't solve your problem in a better way.
278 303
279=back 304=back
280 305
281Example: make a simple HTTP GET request for http://www.nethype.de/ 306Example: do a simple HTTP GET request for http://www.nethype.de/ and print
307the response body.
282 308
283 http_request GET => "http://www.nethype.de/", sub { 309 http_request GET => "http://www.nethype.de/", sub {
284 my ($body, $hdr) = @_; 310 my ($body, $hdr) = @_;
285 print "$body\n"; 311 print "$body\n";
286 }; 312 };
287 313
288Example: make a HTTP HEAD request on https://www.google.com/, use a 314Example: do a HTTP HEAD request on https://www.google.com/, use a
289timeout of 30 seconds. 315timeout of 30 seconds.
290 316
291 http_request 317 http_request
292 GET => "https://www.google.com", 318 GET => "https://www.google.com",
293 timeout => 30, 319 timeout => 30,
296 use Data::Dumper; 322 use Data::Dumper;
297 print Dumper $hdr; 323 print Dumper $hdr;
298 } 324 }
299 ; 325 ;
300 326
301Example: make another simple HTTP GET request, but immediately try to 327Example: do another simple HTTP GET request, but immediately try to
302cancel it. 328cancel it.
303 329
304 my $request = http_request GET => "http://www.nethype.de/", sub { 330 my $request = http_request GET => "http://www.nethype.de/", sub {
305 my ($body, $hdr) = @_; 331 my ($body, $hdr) = @_;
306 print "$body\n"; 332 print "$body\n";
338 push @{ $CO_SLOT{$_[0]}[1] }, $_[1]; 364 push @{ $CO_SLOT{$_[0]}[1] }, $_[1];
339 365
340 _slot_schedule $_[0]; 366 _slot_schedule $_[0];
341} 367}
342 368
343our $qr_nl = qr{\015?\012}; 369sub cookie_jar_extract($$$$) {
370 my ($jar, $uscheme, $uhost, $upath) = @_;
371
372 %$jar = () if $jar->{version} != 1;
373
374 my @cookies;
375
376 while (my ($chost, $paths) = each %$jar) {
377 next unless ref $paths;
378
379 if ($chost =~ /^\./) {
380 next unless $chost eq substr $uhost, -length $chost;
381 } elsif ($chost =~ /\./) {
382 next unless $chost eq $uhost;
383 } else {
384 next;
385 }
386
387 while (my ($cpath, $cookies) = each %$paths) {
388 next unless $cpath eq substr $upath, 0, length $cpath;
389
390 while (my ($cookie, $kv) = each %$cookies) {
391 next if $uscheme ne "https" && exists $kv->{secure};
392
393 if (exists $kv->{expires}) {
394 if (AE::now > parse_date ($kv->{expires})) {
395 delete $cookies->{$cookie};
396 next;
397 }
398 }
399
400 my $value = $kv->{value};
401
402 if ($value =~ /[=;,[:space:]]/) {
403 $value =~ s/([\\"])/\\$1/g;
404 $value = "\"$value\"";
405 }
406
407 push @cookies, "$cookie=$value";
408 }
409 }
410 }
411
412 \@cookies
413}
414
415# continue to parse $_ for headers and place them into the arg
416sub parse_hdr() {
417 my %hdr;
418
419 # things seen, not parsed:
420 # p3pP="NON CUR OTPi OUR NOR UNI"
421
422 $hdr{lc $1} .= ",$2"
423 while /\G
424 ([^:\000-\037]*):
425 [\011\040]*
426 ((?: [^\012]+ | \012[\011\040] )*)
427 \012
428 /gxc;
429
430 /\G$/
431 or return;
432
433 # remove the "," prefix we added to all headers above
434 substr $_, 0, 1, ""
435 for values %hdr;
436
437 \%hdr
438}
439
344our $qr_nlnl = qr{(?<![^\012])\015?\012}; 440our $qr_nlnl = qr{(?<![^\012])\015?\012};
345 441
346our $TLS_CTX_LOW = { cache => 1, sslv2 => 1 }; 442our $TLS_CTX_LOW = { cache => 1, sslv2 => 1 };
347our $TLS_CTX_HIGH = { cache => 1, verify => 1, verify_peername => "https" }; 443our $TLS_CTX_HIGH = { cache => 1, verify => 1, verify_peername => "https" };
348 444
367 my @pseudo = (URL => $url); 463 my @pseudo = (URL => $url);
368 push @pseudo, Redirect => delete $arg{Redirect} if exists $arg{Redirect}; 464 push @pseudo, Redirect => delete $arg{Redirect} if exists $arg{Redirect};
369 465
370 my $recurse = exists $arg{recurse} ? delete $arg{recurse} : $MAX_RECURSE; 466 my $recurse = exists $arg{recurse} ? delete $arg{recurse} : $MAX_RECURSE;
371 467
372 return $cb->(undef, { Status => 599, Reason => "Too many redirections", @pseudo }) 468 return $cb->(undef, { @pseudo, Status => 599, Reason => "Too many redirections" })
373 if $recurse < 0; 469 if $recurse < 0;
374 470
375 my $proxy = $arg{proxy} || $PROXY; 471 my $proxy = $arg{proxy} || $PROXY;
376 my $timeout = $arg{timeout} || $TIMEOUT; 472 my $timeout = $arg{timeout} || $TIMEOUT;
377 473
380 476
381 $uscheme = lc $uscheme; 477 $uscheme = lc $uscheme;
382 478
383 my $uport = $uscheme eq "http" ? 80 479 my $uport = $uscheme eq "http" ? 80
384 : $uscheme eq "https" ? 443 480 : $uscheme eq "https" ? 443
385 : return $cb->(undef, { Status => 599, Reason => "Only http and https URL schemes supported", @pseudo }); 481 : return $cb->(undef, { @pseudo, Status => 599, Reason => "Only http and https URL schemes supported" });
386 482
387 $uauthority =~ /^(?: .*\@ )? ([^\@:]+) (?: : (\d+) )?$/x 483 $uauthority =~ /^(?: .*\@ )? ([^\@:]+) (?: : (\d+) )?$/x
388 or return $cb->(undef, { Status => 599, Reason => "Unparsable URL", @pseudo }); 484 or return $cb->(undef, { @pseudo, Status => 599, Reason => "Unparsable URL" });
389 485
390 my $uhost = $1; 486 my $uhost = $1;
391 $uport = $2 if defined $2; 487 $uport = $2 if defined $2;
392 488
393 $hdr{host} = defined $2 ? "$uhost:$2" : "$uhost" 489 $hdr{host} = defined $2 ? "$uhost:$2" : "$uhost"
398 494
399 $upath =~ s%^/?%/%; 495 $upath =~ s%^/?%/%;
400 496
401 # cookie processing 497 # cookie processing
402 if (my $jar = $arg{cookie_jar}) { 498 if (my $jar = $arg{cookie_jar}) {
403 %$jar = () if $jar->{version} != 1; 499 my $cookies = cookie_jar_extract $jar, $uscheme, $uhost, $upath;
404 500
405 my @cookie;
406
407 while (my ($chost, $v) = each %$jar) {
408 if ($chost =~ /^\./) {
409 next unless $chost eq substr $uhost, -length $chost;
410 } elsif ($chost =~ /\./) {
411 next unless $chost eq $uhost;
412 } else {
413 next;
414 }
415
416 while (my ($cpath, $v) = each %$v) {
417 next unless $cpath eq substr $upath, 0, length $cpath;
418
419 while (my ($k, $v) = each %$v) {
420 next if $uscheme ne "https" && exists $v->{secure};
421 my $value = $v->{value};
422 $value =~ s/([\\"])/\\$1/g;
423 push @cookie, "$k=\"$value\"";
424 }
425 }
426 }
427
428 $hdr{cookie} = join "; ", @cookie 501 $hdr{cookie} = join "; ", @$cookies
429 if @cookie; 502 if @$cookies;
430 } 503 }
431 504
432 my ($rhost, $rport, $rscheme, $rpath); # request host, port, path 505 my ($rhost, $rport, $rscheme, $rpath); # request host, port, path
433 506
434 if ($proxy) { 507 if ($proxy) {
442 } else { 515 } else {
443 ($rhost, $rport, $rscheme, $rpath) = ($uhost, $uport, $uscheme, $upath); 516 ($rhost, $rport, $rscheme, $rpath) = ($uhost, $uport, $uscheme, $upath);
444 } 517 }
445 518
446 # leave out fragment and query string, just a heuristic 519 # leave out fragment and query string, just a heuristic
447 $hdr{referer} ||= "$uscheme://$uauthority$upath" unless exists $hdr{referer}; 520 $hdr{referer} = "$uscheme://$uauthority$upath" unless exists $hdr{referer};
448 $hdr{"user-agent"} ||= $USERAGENT unless exists $hdr{"user-agent"}; 521 $hdr{"user-agent"} = $USERAGENT unless exists $hdr{"user-agent"};
449 522
450 $hdr{"content-length"} = length $arg{body} 523 $hdr{"content-length"} = length $arg{body}
451 if length $arg{body} || $method ne "GET"; 524 if length $arg{body} || $method ne "GET";
452 525
526 $hdr{connection} = "close TE"; #1.1
527 $hdr{te} = "trailers" unless exists $hdr{te}; #1.1
528
453 my %state = (connect_guard => 1); 529 my %state = (connect_guard => 1);
454 530
455 _get_slot $uhost, sub { 531 _get_slot $uhost, sub {
456 $state{slot_guard} = shift; 532 $state{slot_guard} = shift;
457 533
458 return unless $state{connect_guard}; 534 return unless $state{connect_guard};
459 535
460 $state{connect_guard} = AnyEvent::Socket::tcp_connect $rhost, $rport, sub { 536 my $connect_cb = sub {
461 $state{fh} = shift 537 $state{fh} = shift
462 or do { 538 or do {
463 my $err = "$!"; 539 my $err = "$!";
464 %state = (); 540 %state = ();
465 return $cb->(undef, { Status => 599, Reason => $err, @pseudo }); 541 return $cb->(undef, { @pseudo, Status => 599, Reason => $err });
466 }; 542 };
467 543
468 pop; # free memory, save a tree 544 pop; # free memory, save a tree
469 545
470 return unless delete $state{connect_guard}; 546 return unless delete $state{connect_guard};
476 tls_ctx => $arg{tls_ctx}, 552 tls_ctx => $arg{tls_ctx},
477 # these need to be reconfigured on keepalive handles 553 # these need to be reconfigured on keepalive handles
478 timeout => $timeout, 554 timeout => $timeout,
479 on_error => sub { 555 on_error => sub {
480 %state = (); 556 %state = ();
481 $cb->(undef, { Status => 599, Reason => $_[2], @pseudo }); 557 $cb->(undef, { @pseudo, Status => 599, Reason => $_[2] });
482 }, 558 },
483 on_eof => sub { 559 on_eof => sub {
484 %state = (); 560 %state = ();
485 $cb->(undef, { Status => 599, Reason => "Unexpected end-of-file", @pseudo }); 561 $cb->(undef, { @pseudo, Status => 599, Reason => "Unexpected end-of-file" });
486 }, 562 },
487 ; 563 ;
488 564
489 # limit the number of persistent connections 565 # limit the number of persistent connections
490 # keepalive not yet supported 566 # keepalive not yet supported
492# ++$KA_COUNT{$_[1]}; 568# ++$KA_COUNT{$_[1]};
493# $state{handle}{ka_count_guard} = AnyEvent::Util::guard { 569# $state{handle}{ka_count_guard} = AnyEvent::Util::guard {
494# --$KA_COUNT{$_[1]} 570# --$KA_COUNT{$_[1]}
495# }; 571# };
496# $hdr{connection} = "keep-alive"; 572# $hdr{connection} = "keep-alive";
497# } else {
498 delete $hdr{connection};
499# } 573# }
500 574
501 $state{handle}->starttls ("connect") if $rscheme eq "https"; 575 $state{handle}->starttls ("connect") if $rscheme eq "https";
502 576
503 # handle actual, non-tunneled, request 577 # handle actual, non-tunneled, request
504 my $handle_actual_request = sub { 578 my $handle_actual_request = sub {
505 $state{handle}->starttls ("connect") if $uscheme eq "https" && !exists $state{handle}{tls}; 579 $state{handle}->starttls ("connect") if $uscheme eq "https" && !exists $state{handle}{tls};
506 580
507 # send request 581 # send request
508 $state{handle}->push_write ( 582 $state{handle}->push_write (
509 "$method $rpath HTTP/1.0\015\012" 583 "$method $rpath HTTP/1.1\015\012"
510 . (join "", map "\u$_: $hdr{$_}\015\012", grep defined $hdr{$_}, keys %hdr) 584 . (join "", map "\u$_: $hdr{$_}\015\012", grep defined $hdr{$_}, keys %hdr)
511 . "\015\012" 585 . "\015\012"
512 . (delete $arg{body}) 586 . (delete $arg{body})
513 ); 587 );
514 588
515 # return if error occured during push_write() 589 # return if error occured during push_write()
516 return unless %state; 590 return unless %state;
517 591
518 %hdr = (); # reduce memory usage, save a kitten, also make it possible to re-use 592 %hdr = (); # reduce memory usage, save a kitten, also make it possible to re-use
519 593
520 # status line 594 # status line and headers
521 $state{handle}->push_read (line => $qr_nl, sub { 595 $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]") { 596 for ("$_[1]") {
534 y/\015//d; # weed out any \015, as they show up in the weirdest of places. 597 y/\015//d; # weed out any \015, as they show up in the weirdest of places.
535 598
536 # things seen, not parsed: 599 /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\012]*) )? \012/igxc
537 # p3pP="NON CUR OTPi OUR NOR UNI" 600 or return (%state = (), $cb->(undef, { @pseudo, Status => 599, Reason => "Invalid server response" }));
538 601
539 $hdr{lc $1} .= ",$2" 602 # 100 Continue handling
540 while /\G 603 # should not happen as we don't send expect: 100-continue,
541 ([^:\000-\037]*): 604 # but we handle it just in case.
542 [\011\040]* 605 # since we send the request body regardless, if we get an error
543 ((?: [^\012]+ | \012[\011\040] )*) 606 # we are out of-sync, which we currently do NOT handle correctly.
544 \012 607 return $state{handle}->push_read (line => $qr_nlnl, $state{read_response})
545 /gxc; 608 if $2 eq 100;
546 609
610 push @pseudo,
611 HTTPVersion => $1,
612 Status => $2,
613 Reason => $3,
547 /\G$/ 614 ;
615
616 my $hdr = parse_hdr
548 or return (%state = (), $cb->(undef, { Status => 599, Reason => "Garbled response headers", @pseudo })); 617 or return (%state = (), $cb->(undef, { @pseudo, Status => 599, Reason => "Garbled response headers" }));
618
619 %hdr = (%$hdr, @pseudo);
620 }
621
622 # redirect handling
623 # microsoft and other shitheads don't give a shit for following standards,
624 # try to support some common forms of broken Location headers.
625 if ($hdr{location} !~ /^(?: $ | [^:\/?\#]+ : )/x) {
626 $hdr{location} =~ s/^\.\/+//;
627
628 my $url = "$rscheme://$uhost:$uport";
629
630 unless ($hdr{location} =~ s/^\///) {
631 $url .= $upath;
632 $url =~ s/\/[^\/]*$//;
549 } 633 }
550 634
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}"; 635 $hdr{location} = "$url/$hdr{location}";
636 }
637
638 my $redirect;
639
640 if ($recurse) {
641 my $status = $hdr{Status};
642
643 # industry standard is to redirect POST as GET for
644 # 301, 302 and 303, in contrast to http/1.0 and 1.1.
645 # also, the UA should ask the user for 301 and 307 and POST,
646 # industry standard seems to be to simply follow.
647 # we go with the industry standard.
648 if ($status == 301 or $status == 302 or $status == 303) {
649 # HTTP/1.1 is unclear on how to mutate the method
650 $method = "GET" unless $method eq "HEAD";
651 $redirect = 1;
652 } elsif ($status == 307) {
653 $redirect = 1;
572 } 654 }
655 }
573 656
657 my $finish = sub { # ($data, $err_status, $err_reason[, $keepalive])
574 my $redirect; 658 my $keepalive = pop;
575 659
660 $state{handle}->destroy if $state{handle};
661 %state = ();
662
663 if (defined $_[1]) {
664 $hdr{OrigStatus} = $hdr{Status}; $hdr{Status} = $_[1];
665 $hdr{OrigReason} = $hdr{Reason}; $hdr{Reason} = $_[2];
666 }
667
668 # set-cookie processing
576 if ($recurse) { 669 if ($arg{cookie_jar}) {
577 my $status = $hdr{Status}; 670 for ($hdr{"set-cookie"}) {
671 # parse NAME=VALUE
672 my @kv;
578 673
579 if (($status == 301 || $status == 302) && $method ne "POST") { 674 while (
580 # apparently, mozilla et al. just change POST to GET here 675 m{
581 # more research is needed before we do the same 676 \G\s*
677 (?:
678 expires \s*=\s* ([A-Z][a-z][a-z],\ [^,;]+)
679 | ([^=;,[:space:]]+) \s*=\s* (?: "((?:[^\\"]+|\\.)*)" | ([^=;,[:space:]]*) )
680 )
681 }gcxsi
682 ) {
683 my $name = $2;
684 my $value = $4;
685
686 unless (defined $name) {
687 # expires
688 $name = "expires";
689 $value = $1;
690 } elsif (!defined $value) {
691 # quoted
692 $value = $3;
693 $value =~ s/\\(.)/$1/gs;
694 }
695
696 push @kv, lc $name, $value;
697
698 last unless /\G\s*;/gc;
699 }
700
701 last unless @kv;
702
703 my $name = shift @kv;
704 my %kv = (value => shift @kv, @kv);
705
706 $kv{expires} ||= format_date (AE::now + $kv{"max-age"})
707 if exists $kv{"max-age"};
708
709 my $cdom;
710 my $cpath = (delete $kv{path}) || "/";
711
712 if (exists $kv{domain}) {
713 $cdom = delete $kv{domain};
714
715 $cdom =~ s/^\.?/./; # make sure it starts with a "."
716
717 next if $cdom =~ /\.$/;
718
719 # this is not rfc-like and not netscape-like. go figure.
720 my $ndots = $cdom =~ y/.//;
721 next if $ndots < ($cdom =~ /\.[^.][^.]\.[^.][^.]$/ ? 3 : 2);
722 } else {
723 $cdom = $uhost;
724 }
725
582 $redirect = 1; 726 # store it
583 } elsif ($status == 303) { 727 $arg{cookie_jar}{version} = 1;
584 # even http/1.1 is unclear on how to mutate the method 728 $arg{cookie_jar}{$cdom}{$cpath}{$name} = \%kv;
585 $method = "GET" unless $method eq "HEAD"; 729
586 $redirect = 1; 730 redo if /\G\s*,/gc;
587 } elsif ($status == 307 && $method =~ /^(?:GET|HEAD)$/) {
588 $redirect = 1;
589 } 731 }
590 } 732 }
591 733
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}) { 734 if ($redirect && exists $hdr{location}) {
647 # we ignore any errors, as it is very common to receive 735 # we ignore any errors, as it is very common to receive
648 # Content-Length != 0 but no actual body 736 # Content-Length != 0 but no actual body
649 # we also access %hdr, as $_[1] might be an erro 737 # we also access %hdr, as $_[1] might be an erro
650 http_request ( 738 http_request (
651 $method => $hdr{location}, 739 $method => $hdr{location},
652 %arg, 740 %arg,
653 recurse => $recurse - 1, 741 recurse => $recurse - 1,
654 Redirect => \@_, 742 Redirect => [$_[0], \%hdr],
655 $cb); 743 $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 { 744 } else {
745 $cb->($_[0], \%hdr);
746 }
747 };
748
749 my $len = $hdr{"content-length"};
750
751 if (!$redirect && $arg{on_header} && !$arg{on_header}(\%hdr)) {
752 $finish->(undef, 598 => "Request cancelled by on_header");
753 } elsif (
754 $hdr{Status} =~ /^(?:1..|204|205|304)$/
755 or $method eq "HEAD"
756 or (defined $len && !$len)
757 ) {
758 # no body
759 $finish->("", undef, undef, 1);
760 } else {
673 # body handling, four different code paths 761 # body handling, many different code paths
674 # for want_body_handle, on_body (2x), normal (2x) 762 # - no body expected
675 # we might read too much here, but it does not matter yet (no pers. connections) 763 # - want_body_handle
764 # - te chunked
765 # - 2x length known (with or without on_body)
766 # - 2x length not known (with or without on_body)
676 if (!$redirect && $arg{want_body_handle}) { 767 if (!$redirect && $arg{want_body_handle}) {
677 $_[0]->on_eof (undef); 768 $_[0]->on_eof (undef);
678 $_[0]->on_error (undef); 769 $_[0]->on_error (undef);
679 $_[0]->on_read (undef); 770 $_[0]->on_read (undef);
680 771
681 $finish->(delete $state{handle}, \%hdr); 772 $finish->(delete $state{handle});
682 773
683 } elsif ($arg{on_body}) { 774 } elsif ($hdr{"transfer-encoding"} =~ /\bchunked\b/i) {
775 my $cl = 0;
776 my $body = undef;
777 my $on_body = $arg{on_body} || sub { $body .= shift; 1 };
778
684 $_[0]->on_error (sub { $finish->(undef, { Status => 599, Reason => $_[2], @pseudo }) }); 779 $_[0]->on_error (sub { $finish->(undef, 599 => $_[2]) });
780
781 my $read_chunk; $read_chunk = sub {
782 $_[1] =~ /^([0-9a-fA-F]+)/
783 or $finish->(undef, 599 => "Garbled chunked transfer encoding");
784
785 my $len = hex $1;
786
685 if ($len) { 787 if ($len) {
686 $_[0]->on_eof (undef); 788 $cl += $len;
789
790 $_[0]->push_read (chunk => $len, sub {
791 $on_body->($_[1], \%hdr)
792 or return $finish->(undef, 598 => "Request cancelled by on_body");
793
687 $_[0]->on_read (sub { 794 $_[0]->push_read (line => sub {
688 $len -= length $_[0]{rbuf}; 795 length $_[1]
689 796 and return $finish->(undef, 599 => "Garbled chunked transfer encoding");
690 $arg{on_body}(delete $_[0]{rbuf}, \%hdr) 797 $_[0]->push_read (line => $read_chunk);
691 or $finish->(undef, { Status => 598, Reason => "Request cancelled by on_body", @pseudo });
692
693 $len > 0 798 });
694 or $finish->("", \%hdr);
695 }); 799 });
696 } else { 800 } else {
697 $_[0]->on_eof (sub { 801 $hdr{"content-length"} ||= $cl;
698 $finish->("", \%hdr); 802
803 $_[0]->push_read (line => $qr_nlnl, sub {
804 if (length $_[1]) {
805 for ("$_[1]") {
806 y/\015//d; # weed out any \015, as they show up in the weirdest of places.
807
808 my $hdr = parse_hdr
809 or return $finish->(undef, 599 => "Garbled response trailers");
810
811 %hdr = (%hdr, %$hdr);
812 }
699 }); 813 }
700 $_[0]->on_read (sub { 814
701 $arg{on_body}(delete $_[0]{rbuf}, \%hdr) 815 $finish->($body, undef, undef, 1);
702 or $finish->(undef, { Status => 598, Reason => "Request cancelled by on_body", @pseudo });
703 }); 816 });
704 } 817 }
818 };
819
820 $_[0]->push_read (line => $read_chunk);
821
822 } elsif ($arg{on_body}) {
823 $_[0]->on_error (sub { $finish->(undef, 599 => $_[2]) });
824
825 if ($len) {
826 $_[0]->on_read (sub {
827 $len -= length $_[0]{rbuf};
828
829 $arg{on_body}(delete $_[0]{rbuf}, \%hdr)
830 or return $finish->(undef, 598 => "Request cancelled by on_body");
831
832 $len > 0
833 or $finish->("", undef, undef, 1);
834 });
705 } else { 835 } else {
706 $_[0]->on_eof (undef); 836 $_[0]->on_eof (sub {
707 837 $finish->("");
708 if ($len) { 838 });
709 $_[0]->on_error (sub { $finish->(undef, { Status => 599, Reason => $_[2], @pseudo }) });
710 $_[0]->on_read (sub { 839 $_[0]->on_read (sub {
840 $arg{on_body}(delete $_[0]{rbuf}, \%hdr)
841 or $finish->(undef, 598 => "Request cancelled by on_body");
842 });
843 }
844 } else {
845 $_[0]->on_eof (undef);
846
847 if ($len) {
848 $_[0]->on_error (sub { $finish->(undef, 599 => $_[2]) });
849 $_[0]->on_read (sub {
711 $finish->((substr delete $_[0]{rbuf}, 0, $len, ""), \%hdr) 850 $finish->((substr delete $_[0]{rbuf}, 0, $len, ""), undef, undef, 1)
712 if $len <= length $_[0]{rbuf}; 851 if $len <= length $_[0]{rbuf};
713 }); 852 });
714 } else { 853 } else {
715 $_[0]->on_error (sub { 854 $_[0]->on_error (sub {
716 $! == Errno::EPIPE || !$! 855 ($! == Errno::EPIPE || !$!)
717 ? $finish->(delete $_[0]{rbuf}, \%hdr) 856 ? $finish->(delete $_[0]{rbuf})
718 : $finish->(undef, { Status => 599, Reason => $_[2], @pseudo }); 857 : $finish->(undef, 599 => $_[2]);
719 }); 858 });
720 $_[0]->on_read (sub { }); 859 $_[0]->on_read (sub { });
721 }
722 } 860 }
723 } 861 }
724 }); 862 }
725 }); 863 };
864
865 $state{handle}->push_read (line => $qr_nlnl, $state{read_response});
726 }; 866 };
727 867
728 # now handle proxy-CONNECT method 868 # now handle proxy-CONNECT method
729 if ($proxy && $uscheme eq "https") { 869 if ($proxy && $uscheme eq "https") {
730 # oh dear, we have to wrap it into a connect request 870 # oh dear, we have to wrap it into a connect request
731 871
732 # maybe re-use $uauthority with patched port? 872 # 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"); 873 $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 { 874 $state{handle}->push_read (line => $qr_nlnl, sub {
735 $_[1] =~ /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\015\012]*) )?/ix 875 $_[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 })); 876 or return (%state = (), $cb->(undef, { @pseudo, Status => 599, Reason => "Invalid proxy connect response ($_[1])" }));
737 877
738 if ($2 == 200) { 878 if ($2 == 200) {
739 $rpath = $upath; 879 $rpath = $upath;
740 &$handle_actual_request; 880 &$handle_actual_request;
741 } else { 881 } else {
742 %state = (); 882 %state = ();
743 $cb->(undef, { Status => $2, Reason => $3, @pseudo }); 883 $cb->(undef, { @pseudo, Status => $2, Reason => $3 });
744 } 884 }
745 }); 885 });
746 } else { 886 } else {
747 &$handle_actual_request; 887 &$handle_actual_request;
748 } 888 }
889 };
749 890
750 }, $arg{on_prepare} || sub { $timeout }; 891 my $tcp_connect = $arg{tcp_connect}
892 || do { require AnyEvent::Socket; \&AnyEvent::Socket::tcp_connect };
893
894 $state{connect_guard} = $tcp_connect->($rhost, $rport, $connect_cb, $arg{on_prepare} || sub { $timeout });
895
751 }; 896 };
752 897
753 defined wantarray && AnyEvent::Util::guard { %state = () } 898 defined wantarray && AnyEvent::Util::guard { %state = () }
754} 899}
755 900
790string of the form C<http://host:port> (optionally C<https:...>), croaks 935string of the form C<http://host:port> (optionally C<https:...>), croaks
791otherwise. 936otherwise.
792 937
793To clear an already-set proxy, use C<undef>. 938To clear an already-set proxy, use C<undef>.
794 939
940=item $date = AnyEvent::HTTP::format_date $timestamp
941
942Takes a POSIX timestamp (seconds since the epoch) and formats it as a HTTP
943Date (RFC 2616).
944
945=item $timestamp = AnyEvent::HTTP::parse_date $date
946
947Takes a HTTP Date (RFC 2616) or a Cookie date (netscape cookie spec) and
948returns the corresponding POSIX timestamp, or C<undef> if the date cannot
949be parsed.
950
795=item $AnyEvent::HTTP::MAX_RECURSE 951=item $AnyEvent::HTTP::MAX_RECURSE
796 952
797The default value for the C<recurse> request parameter (default: C<10>). 953The default value for the C<recurse> request parameter (default: C<10>).
798 954
799=item $AnyEvent::HTTP::USERAGENT 955=item $AnyEvent::HTTP::USERAGENT
817connections. This number of can be useful for load-leveling. 973connections. This number of can be useful for load-leveling.
818 974
819=back 975=back
820 976
821=cut 977=cut
978
979our @month = qw(Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec);
980our @weekday = qw(Sun Mon Tue Wed Thu Fri Sat);
981
982sub format_date($) {
983 my ($time) = @_;
984
985 # RFC 822/1123 format
986 my ($S, $M, $H, $mday, $mon, $year, $wday, $yday, undef) = gmtime $time;
987
988 sprintf "%s, %02d %s %04d %02d:%02d:%02d GMT",
989 $weekday[$wday], $mday, $month[$mon], $year + 1900,
990 $H, $M, $S;
991}
992
993sub parse_date($) {
994 my ($date) = @_;
995
996 my ($d, $m, $y, $H, $M, $S);
997
998 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$/) {
999 # RFC 822/1123, required by RFC 2616 (with " ")
1000 # cookie dates (with "-")
1001
1002 ($d, $m, $y, $H, $M, $S) = ($1, $2, $3, $4, $5, $6);
1003
1004 } 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$/) {
1005 # RFC 850
1006 ($d, $m, $y, $H, $M, $S) = ($1, $2, $3 < 69 ? $3 + 2000 : $3 + 1900, $4, $5, $6);
1007
1008 } 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])$/) {
1009 # ISO C's asctime
1010 ($d, $m, $y, $H, $M, $S) = ($2, $1, $6, $3, $4, $5);
1011 }
1012 # other formats fail in the loop below
1013
1014 for (0..11) {
1015 if ($m eq $month[$_]) {
1016 require Time::Local;
1017 return Time::Local::timegm ($S, $M, $H, $d, $_, $y);
1018 }
1019 }
1020
1021 undef
1022}
822 1023
823sub set_proxy($) { 1024sub set_proxy($) {
824 if (length $_[0]) { 1025 if (length $_[0]) {
825 $_[0] =~ m%^(https?):// ([^:/]+) (?: : (\d*) )?%ix 1026 $_[0] =~ m%^(https?):// ([^:/]+) (?: : (\d*) )?%ix
826 or Carp::croak "$_[0]: invalid proxy URL"; 1027 or Carp::croak "$_[0]: invalid proxy URL";
833# initialise proxy from environment 1034# initialise proxy from environment
834eval { 1035eval {
835 set_proxy $ENV{http_proxy}; 1036 set_proxy $ENV{http_proxy};
836}; 1037};
837 1038
1039=head2 SOCKS PROXIES
1040
1041Socks proxies are not directly supported by AnyEvent::HTTP. You can
1042compile your perl to support socks, or use an external program such as
1043F<socksify> (dante) or F<tsocks> to make your program use a socks proxy
1044transparently.
1045
1046Alternatively, for AnyEvent::HTTP only, you can use your own
1047C<tcp_connect> function that does the proxy handshake - here is an example
1048that works with socks4a proxies:
1049
1050 use Errno;
1051 use AnyEvent::Util;
1052 use AnyEvent::Socket;
1053 use AnyEvent::Handle;
1054
1055 # host, port and username of/for your socks4a proxy
1056 my $socks_host = "10.0.0.23";
1057 my $socks_port = 9050;
1058 my $socks_user = "";
1059
1060 sub socks4a_connect {
1061 my ($host, $port, $connect_cb, $prepare_cb) = @_;
1062
1063 my $hdl = new AnyEvent::Handle
1064 connect => [$socks_host, $socks_port],
1065 on_prepare => sub { $prepare_cb->($_[0]{fh}) },
1066 on_error => sub { $connect_cb->() },
1067 ;
1068
1069 $hdl->push_write (pack "CCnNZ*Z*", 4, 1, $port, 1, $socks_user, $host);
1070
1071 $hdl->push_read (chunk => 8, sub {
1072 my ($hdl, $chunk) = @_;
1073 my ($status, $port, $ipn) = unpack "xCna4", $chunk;
1074
1075 if ($status == 0x5a) {
1076 $connect_cb->($hdl->{fh}, (format_address $ipn) . ":$port");
1077 } else {
1078 $! = Errno::ENXIO; $connect_cb->();
1079 }
1080 });
1081
1082 $hdl
1083 }
1084
1085Use C<socks4a_connect> instead of C<tcp_connect> when doing C<http_request>s,
1086possibly after switching off other proxy types:
1087
1088 AnyEvent::HTTP::set_proxy undef; # usually you do not want other proxies
1089
1090 http_get 'http://www.google.com', tcp_connect => \&socks4a_connect, sub {
1091 my ($data, $headers) = @_;
1092 ...
1093 };
1094
838=head1 SEE ALSO 1095=head1 SEE ALSO
839 1096
840L<AnyEvent>. 1097L<AnyEvent>.
841 1098
842=head1 AUTHOR 1099=head1 AUTHOR

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines