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.57 by root, Mon Sep 6 06:31:32 2010 UTC vs.
Revision 1.70 by root, Fri Dec 31 20:31:47 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.46'; 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
369# continue to parse $_ for headers and place them into the arg
370sub parse_hdr() {
371 my %hdr;
372
373 # things seen, not parsed:
374 # p3pP="NON CUR OTPi OUR NOR UNI"
375
376 $hdr{lc $1} .= ",$2"
377 while /\G
378 ([^:\000-\037]*):
379 [\011\040]*
380 ((?: [^\012]+ | \012[\011\040] )*)
381 \012
382 /gxc;
383
384 /\G$/
385 or return;
386
387 # remove the "," prefix we added to all headers above
388 substr $_, 0, 1, ""
389 for values %hdr;
390
391 \%hdr
392}
393
343our $qr_nlnl = qr{(?<![^\012])\015?\012}; 394our $qr_nlnl = qr{(?<![^\012])\015?\012};
344 395
345our $TLS_CTX_LOW = { cache => 1, sslv2 => 1 }; 396our $TLS_CTX_LOW = { cache => 1, sslv2 => 1 };
346our $TLS_CTX_HIGH = { cache => 1, verify => 1, verify_peername => "https" }; 397our $TLS_CTX_HIGH = { cache => 1, verify => 1, verify_peername => "https" };
347 398
… …
366 my @pseudo = (URL => $url); 417 my @pseudo = (URL => $url);
367 push @pseudo, Redirect => delete $arg{Redirect} if exists $arg{Redirect}; 418 push @pseudo, Redirect => delete $arg{Redirect} if exists $arg{Redirect};
368 419
369 my $recurse = exists $arg{recurse} ? delete $arg{recurse} : $MAX_RECURSE; 420 my $recurse = exists $arg{recurse} ? delete $arg{recurse} : $MAX_RECURSE;
370 421
371 return $cb->(undef, { Status => 599, Reason => "Too many redirections", @pseudo }) 422 return $cb->(undef, { @pseudo, Status => 599, Reason => "Too many redirections" })
372 if $recurse < 0; 423 if $recurse < 0;
373 424
374 my $proxy = $arg{proxy} || $PROXY; 425 my $proxy = $arg{proxy} || $PROXY;
375 my $timeout = $arg{timeout} || $TIMEOUT; 426 my $timeout = $arg{timeout} || $TIMEOUT;
376 427
… …
379 430
380 $uscheme = lc $uscheme; 431 $uscheme = lc $uscheme;
381 432
382 my $uport = $uscheme eq "http" ? 80 433 my $uport = $uscheme eq "http" ? 80
383 : $uscheme eq "https" ? 443 434 : $uscheme eq "https" ? 443
384 : return $cb->(undef, { Status => 599, Reason => "Only http and https URL schemes supported", @pseudo }); 435 : return $cb->(undef, { @pseudo, Status => 599, Reason => "Only http and https URL schemes supported" });
385 436
386 $uauthority =~ /^(?: .*\@ )? ([^\@:]+) (?: : (\d+) )?$/x 437 $uauthority =~ /^(?: .*\@ )? ([^\@:]+) (?: : (\d+) )?$/x
387 or return $cb->(undef, { Status => 599, Reason => "Unparsable URL", @pseudo }); 438 or return $cb->(undef, { @pseudo, Status => 599, Reason => "Unparsable URL" });
388 439
389 my $uhost = $1; 440 my $uhost = $1;
390 $uport = $2 if defined $2; 441 $uport = $2 if defined $2;
391 442
392 $hdr{host} = defined $2 ? "$uhost:$2" : "$uhost" 443 $hdr{host} = defined $2 ? "$uhost:$2" : "$uhost"
… …
401 if (my $jar = $arg{cookie_jar}) { 452 if (my $jar = $arg{cookie_jar}) {
402 %$jar = () if $jar->{version} != 1; 453 %$jar = () if $jar->{version} != 1;
403 454
404 my @cookie; 455 my @cookie;
405 456
406 while (my ($chost, $v) = each %$jar) { 457 while (my ($chost, $paths) = each %$jar) {
407 if ($chost =~ /^\./) { 458 if ($chost =~ /^\./) {
408 next unless $chost eq substr $uhost, -length $chost; 459 next unless $chost eq substr $uhost, -length $chost;
409 } elsif ($chost =~ /\./) { 460 } elsif ($chost =~ /\./) {
410 next unless $chost eq $uhost; 461 next unless $chost eq $uhost;
411 } else { 462 } else {
412 next; 463 next;
413 } 464 }
414 465
415 while (my ($cpath, $v) = each %$v) { 466 while (my ($cpath, $cookies) = each %$paths) {
416 next unless $cpath eq substr $upath, 0, length $cpath; 467 next unless $cpath eq substr $upath, 0, length $cpath;
417 468
418 while (my ($k, $v) = each %$v) { 469 while (my ($cookie, $kv) = each %$cookies) {
419 next if $uscheme ne "https" && exists $v->{secure}; 470 next if $uscheme ne "https" && exists $kv->{secure};
471
472 if (exists $kv->{expires}) {
473 if (AE::now > parse_date ($kv->{expires})) {
474 delete $cookies->{$cookie};
475 next;
476 }
477 }
478
420 my $value = $v->{value}; 479 my $value = $kv->{value};
421 $value =~ s/([\\"])/\\$1/g; 480 $value =~ s/([\\"])/\\$1/g;
422 push @cookie, "$k=\"$value\""; 481 push @cookie, "$cookie=\"$value\"";
423 } 482 }
424 } 483 }
425 } 484 }
426 485
427 $hdr{cookie} = join "; ", @cookie 486 $hdr{cookie} = join "; ", @cookie
… …
441 } else { 500 } else {
442 ($rhost, $rport, $rscheme, $rpath) = ($uhost, $uport, $uscheme, $upath); 501 ($rhost, $rport, $rscheme, $rpath) = ($uhost, $uport, $uscheme, $upath);
443 } 502 }
444 503
445 # leave out fragment and query string, just a heuristic 504 # leave out fragment and query string, just a heuristic
446 $hdr{referer} ||= "$uscheme://$uauthority$upath" unless exists $hdr{referer}; 505 $hdr{referer} = "$uscheme://$uauthority$upath" unless exists $hdr{referer};
447 $hdr{"user-agent"} ||= $USERAGENT unless exists $hdr{"user-agent"}; 506 $hdr{"user-agent"} = $USERAGENT unless exists $hdr{"user-agent"};
448 507
449 $hdr{"content-length"} = length $arg{body} 508 $hdr{"content-length"} = length $arg{body}
450 if length $arg{body} || $method ne "GET"; 509 if length $arg{body} || $method ne "GET";
451 510
511 $hdr{connection} = "close TE"; #1.1
512 $hdr{te} = "trailers" unless exists $hdr{te}; #1.1
513
452 my %state = (connect_guard => 1); 514 my %state = (connect_guard => 1);
453 515
454 _get_slot $uhost, sub { 516 _get_slot $uhost, sub {
455 $state{slot_guard} = shift; 517 $state{slot_guard} = shift;
456 518
457 return unless $state{connect_guard}; 519 return unless $state{connect_guard};
458 520
459 $state{connect_guard} = AnyEvent::Socket::tcp_connect $rhost, $rport, sub { 521 my $connect_cb = sub {
460 $state{fh} = shift 522 $state{fh} = shift
461 or do { 523 or do {
462 my $err = "$!"; 524 my $err = "$!";
463 %state = (); 525 %state = ();
464 return $cb->(undef, { Status => 599, Reason => $err, @pseudo }); 526 return $cb->(undef, { @pseudo, Status => 599, Reason => $err });
465 }; 527 };
466 528
467 pop; # free memory, save a tree 529 pop; # free memory, save a tree
468 530
469 return unless delete $state{connect_guard}; 531 return unless delete $state{connect_guard};
… …
475 tls_ctx => $arg{tls_ctx}, 537 tls_ctx => $arg{tls_ctx},
476 # these need to be reconfigured on keepalive handles 538 # these need to be reconfigured on keepalive handles
477 timeout => $timeout, 539 timeout => $timeout,
478 on_error => sub { 540 on_error => sub {
479 %state = (); 541 %state = ();
480 $cb->(undef, { Status => 599, Reason => $_[2], @pseudo }); 542 $cb->(undef, { @pseudo, Status => 599, Reason => $_[2] });
481 }, 543 },
482 on_eof => sub { 544 on_eof => sub {
483 %state = (); 545 %state = ();
484 $cb->(undef, { Status => 599, Reason => "Unexpected end-of-file", @pseudo }); 546 $cb->(undef, { @pseudo, Status => 599, Reason => "Unexpected end-of-file" });
485 }, 547 },
486 ; 548 ;
487 549
488 # limit the number of persistent connections 550 # limit the number of persistent connections
489 # keepalive not yet supported 551 # keepalive not yet supported
… …
491# ++$KA_COUNT{$_[1]}; 553# ++$KA_COUNT{$_[1]};
492# $state{handle}{ka_count_guard} = AnyEvent::Util::guard { 554# $state{handle}{ka_count_guard} = AnyEvent::Util::guard {
493# --$KA_COUNT{$_[1]} 555# --$KA_COUNT{$_[1]}
494# }; 556# };
495# $hdr{connection} = "keep-alive"; 557# $hdr{connection} = "keep-alive";
496# } else {
497 delete $hdr{connection};
498# } 558# }
499 559
500 $state{handle}->starttls ("connect") if $rscheme eq "https"; 560 $state{handle}->starttls ("connect") if $rscheme eq "https";
501 561
502 # handle actual, non-tunneled, request 562 # handle actual, non-tunneled, request
503 my $handle_actual_request = sub { 563 my $handle_actual_request = sub {
504 $state{handle}->starttls ("connect") if $uscheme eq "https" && !exists $state{handle}{tls}; 564 $state{handle}->starttls ("connect") if $uscheme eq "https" && !exists $state{handle}{tls};
505 565
506 # send request 566 # send request
507 $state{handle}->push_write ( 567 $state{handle}->push_write (
508 "$method $rpath HTTP/1.0\015\012" 568 "$method $rpath HTTP/1.1\015\012"
509 . (join "", map "\u$_: $hdr{$_}\015\012", grep defined $hdr{$_}, keys %hdr) 569 . (join "", map "\u$_: $hdr{$_}\015\012", grep defined $hdr{$_}, keys %hdr)
510 . "\015\012" 570 . "\015\012"
511 . (delete $arg{body}) 571 . (delete $arg{body})
512 ); 572 );
513 573
… …
515 return unless %state; 575 return unless %state;
516 576
517 %hdr = (); # reduce memory usage, save a kitten, also make it possible to re-use 577 %hdr = (); # reduce memory usage, save a kitten, also make it possible to re-use
518 578
519 # status line and headers 579 # status line and headers
520 $state{handle}->push_read (line => $qr_nlnl, sub { 580 $state{read_response} = sub {
521 for ("$_[1]") { 581 for ("$_[1]") {
522 y/\015//d; # weed out any \015, as they show up in the weirdest of places. 582 y/\015//d; # weed out any \015, as they show up in the weirdest of places.
523 583
524 /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\015\012]*) )? \015?\012/igxc 584 /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\012]*) )? \012/igxc
525 or return (%state = (), $cb->(undef, { Status => 599, Reason => "Invalid server response", @pseudo })); 585 or return (%state = (), $cb->(undef, { @pseudo, Status => 599, Reason => "Invalid server response" }));
586
587 # 100 Continue handling
588 # should not happen as we don't send expect: 100-continue,
589 # but we handle it just in case.
590 # since we send the request body regardless, if we get an error
591 # we are out of-sync, which we currently do NOT handle correctly.
592 return $state{handle}->push_read (line => $qr_nlnl, $state{read_response})
593 if $2 eq 100;
526 594
527 push @pseudo, 595 push @pseudo,
528 HTTPVersion => $1, 596 HTTPVersion => $1,
529 Status => $2, 597 Status => $2,
530 Reason => $3, 598 Reason => $3,
531 ; 599 ;
532 600
533 # things seen, not parsed: 601 my $hdr = parse_hdr
534 # p3pP="NON CUR OTPi OUR NOR UNI"
535
536 $hdr{lc $1} .= ",$2"
537 while /\G
538 ([^:\000-\037]*):
539 [\011\040]*
540 ((?: [^\012]+ | \012[\011\040] )*)
541 \012
542 /gxc;
543
544 /\G$/
545 or return (%state = (), $cb->(undef, { Status => 599, Reason => "Garbled response headers", @pseudo })); 602 or return (%state = (), $cb->(undef, { @pseudo, Status => 599, Reason => "Garbled response headers" }));
603
604 %hdr = (%$hdr, @pseudo);
546 } 605 }
547
548 # remove the "," prefix we added to all headers above
549 substr $_, 0, 1, ""
550 for values %hdr;
551
552 # patch in all pseudo headers
553 %hdr = (%hdr, @pseudo);
554 606
555 # redirect handling 607 # redirect handling
556 # microsoft and other shitheads don't give a shit for following standards, 608 # microsoft and other shitheads don't give a shit for following standards,
557 # try to support some common forms of broken Location headers. 609 # try to support some common forms of broken Location headers.
558 if ($hdr{location} !~ /^(?: $ | [^:\/?\#]+ : )/x) { 610 if ($hdr{location} !~ /^(?: $ | [^:\/?\#]+ : )/x) {
… …
585 } elsif ($status == 307) { 637 } elsif ($status == 307) {
586 $redirect = 1; 638 $redirect = 1;
587 } 639 }
588 } 640 }
589 641
590 my $finish = sub { 642 my $finish = sub { # ($data, $err_status, $err_reason[, $keepalive])
643 my $keepalive = pop;
644
591 $state{handle}->destroy if $state{handle}; 645 $state{handle}->destroy if $state{handle};
592 %state = (); 646 %state = ();
593 647
648 if (defined $_[1]) {
649 $hdr{OrigStatus} = $hdr{Status}; $hdr{Status} = $_[1];
650 $hdr{OrigReason} = $hdr{Reason}; $hdr{Reason} = $_[2];
651 }
652
594 # set-cookie processing 653 # set-cookie processing
595 if ($arg{cookie_jar}) { 654 if ($arg{cookie_jar}) {
596 for ($_[1]{"set-cookie"}) { 655 for ($hdr{"set-cookie"}) {
597 # parse NAME=VALUE 656 # parse NAME=VALUE
598 my @kv; 657 my @kv;
599 658
659 while (
660 m{
661 \G\s*
662 (?:
663 expires \s*=\s* ([A-Z][a-z][a-z],\ [^,;]+)
600 while (/\G\s* ([^=;,[:space:]]+) \s*=\s* (?: "((?:[^\\"]+|\\.)*)" | ([^=;,[:space:]]*) )/gcxs) { 664 | ([^=;,[:space:]]+) \s*=\s* (?: "((?:[^\\"]+|\\.)*)" | ([^=;,[:space:]]*) )
665 )
666 }gcxsi
667 ) {
601 my $name = $1; 668 my $name = $2;
602 my $value = $3; 669 my $value = $4;
603 670
604 unless ($value) { 671 unless (defined $name) {
672 # expires
673 $name = "expires";
605 $value = $2; 674 $value = $1;
675 } elsif (!defined $value) {
676 # quoted
677 $value = $3;
606 $value =~ s/\\(.)/$1/gs; 678 $value =~ s/\\(.)/$1/gs;
607 } 679 }
608 680
609 push @kv, $name => $value; 681 push @kv, lc $name, $value;
610 682
611 last unless /\G\s*;/gc; 683 last unless /\G\s*;/gc;
612 } 684 }
613 685
614 last unless @kv; 686 last unless @kv;
615 687
616 my $name = shift @kv; 688 my $name = shift @kv;
617 my %kv = (value => shift @kv, @kv); 689 my %kv = (value => shift @kv, @kv);
690
691 $kv{expires} ||= format_date (AE::now + $kv{"max-age"})
692 if exists $kv{"max-age"};
618 693
619 my $cdom; 694 my $cdom;
620 my $cpath = (delete $kv{path}) || "/"; 695 my $cpath = (delete $kv{path}) || "/";
621 696
622 if (exists $kv{domain}) { 697 if (exists $kv{domain}) {
… …
647 # we also access %hdr, as $_[1] might be an erro 722 # we also access %hdr, as $_[1] might be an erro
648 http_request ( 723 http_request (
649 $method => $hdr{location}, 724 $method => $hdr{location},
650 %arg, 725 %arg,
651 recurse => $recurse - 1, 726 recurse => $recurse - 1,
652 Redirect => \@_, 727 Redirect => [$_[0], \%hdr],
653 $cb); 728 $cb);
654 } else { 729 } else {
655 $cb->($_[0], $_[1]); 730 $cb->($_[0], \%hdr);
656 } 731 }
657 }; 732 };
658 733
659 my $len = $hdr{"content-length"}; 734 my $len = $hdr{"content-length"};
660 735
661 if (!$redirect && $arg{on_header} && !$arg{on_header}(\%hdr)) { 736 if (!$redirect && $arg{on_header} && !$arg{on_header}(\%hdr)) {
662 $finish->(undef, { Status => 598, Reason => "Request cancelled by on_header", @pseudo }); 737 $finish->(undef, 598 => "Request cancelled by on_header");
663 } elsif ( 738 } elsif (
664 $hdr{Status} =~ /^(?:1..|[23]04)$/ 739 $hdr{Status} =~ /^(?:1..|204|205|304)$/
665 or $method eq "HEAD" 740 or $method eq "HEAD"
666 or (defined $len && !$len) 741 or (defined $len && !$len)
667 ) { 742 ) {
668 # no body 743 # no body
669 $finish->("", \%hdr); 744 $finish->("", undef, undef, 1);
670 } else { 745 } else {
671 # body handling, four different code paths 746 # body handling, many different code paths
672 # for want_body_handle, on_body (2x), normal (2x) 747 # - no body expected
673 # we might read too much here, but it does not matter yet (no pers. connections) 748 # - want_body_handle
749 # - te chunked
750 # - 2x length known (with or without on_body)
751 # - 2x length not known (with or without on_body)
674 if (!$redirect && $arg{want_body_handle}) { 752 if (!$redirect && $arg{want_body_handle}) {
675 $_[0]->on_eof (undef); 753 $_[0]->on_eof (undef);
676 $_[0]->on_error (undef); 754 $_[0]->on_error (undef);
677 $_[0]->on_read (undef); 755 $_[0]->on_read (undef);
678 756
679 $finish->(delete $state{handle}, \%hdr); 757 $finish->(delete $state{handle});
758
759 } elsif ($hdr{"transfer-encoding"} =~ /\bchunked\b/i) {
760 my $cl = 0;
761 my $body = undef;
762 my $on_body = $arg{on_body} || sub { $body .= shift; 1 };
763
764 $_[0]->on_error (sub { $finish->(undef, 599 => $_[2]) });
765
766 my $read_chunk; $read_chunk = sub {
767 $_[1] =~ /^([0-9a-fA-F]+)/
768 or $finish->(undef, 599 => "Garbled chunked transfer encoding");
769
770 my $len = hex $1;
771
772 if ($len) {
773 $cl += $len;
774
775 $_[0]->push_read (chunk => $len, sub {
776 $on_body->($_[1], \%hdr)
777 or return $finish->(undef, 598 => "Request cancelled by on_body");
778
779 $_[0]->push_read (line => sub {
780 length $_[1]
781 and return $finish->(undef, 599 => "Garbled chunked transfer encoding");
782 $_[0]->push_read (line => $read_chunk);
783 });
784 });
785 } else {
786 $hdr{"content-length"} ||= $cl;
787
788 $_[0]->push_read (line => $qr_nlnl, sub {
789 if (length $_[1]) {
790 for ("$_[1]") {
791 y/\015//d; # weed out any \015, as they show up in the weirdest of places.
792
793 my $hdr = parse_hdr
794 or return $finish->(undef, 599 => "Garbled response trailers");
795
796 %hdr = (%hdr, %$hdr);
797 }
798 }
799
800 $finish->($body, undef, undef, 1);
801 });
802 }
803 };
804
805 $_[0]->push_read (line => $read_chunk);
680 806
681 } elsif ($arg{on_body}) { 807 } elsif ($arg{on_body}) {
682 $_[0]->on_error (sub { $finish->(undef, { Status => 599, Reason => $_[2], @pseudo }) }); 808 $_[0]->on_error (sub { $finish->(undef, 599 => $_[2]) });
809
683 if ($len) { 810 if ($len) {
684 $_[0]->on_eof (undef);
685 $_[0]->on_read (sub { 811 $_[0]->on_read (sub {
686 $len -= length $_[0]{rbuf}; 812 $len -= length $_[0]{rbuf};
687 813
688 $arg{on_body}(delete $_[0]{rbuf}, \%hdr) 814 $arg{on_body}(delete $_[0]{rbuf}, \%hdr)
689 or $finish->(undef, { Status => 598, Reason => "Request cancelled by on_body", @pseudo }); 815 or return $finish->(undef, 598 => "Request cancelled by on_body");
690 816
691 $len > 0 817 $len > 0
692 or $finish->("", \%hdr); 818 or $finish->("", undef, undef, 1);
693 }); 819 });
694 } else { 820 } else {
695 $_[0]->on_eof (sub { 821 $_[0]->on_eof (sub {
696 $finish->("", \%hdr); 822 $finish->("");
697 }); 823 });
698 $_[0]->on_read (sub { 824 $_[0]->on_read (sub {
699 $arg{on_body}(delete $_[0]{rbuf}, \%hdr) 825 $arg{on_body}(delete $_[0]{rbuf}, \%hdr)
700 or $finish->(undef, { Status => 598, Reason => "Request cancelled by on_body", @pseudo }); 826 or $finish->(undef, 598 => "Request cancelled by on_body");
701 }); 827 });
702 } 828 }
703 } else { 829 } else {
704 $_[0]->on_eof (undef); 830 $_[0]->on_eof (undef);
705 831
706 if ($len) { 832 if ($len) {
707 $_[0]->on_error (sub { $finish->(undef, { Status => 599, Reason => $_[2], @pseudo }) }); 833 $_[0]->on_error (sub { $finish->(undef, 599 => $_[2]) });
708 $_[0]->on_read (sub { 834 $_[0]->on_read (sub {
709 $finish->((substr delete $_[0]{rbuf}, 0, $len, ""), \%hdr) 835 $finish->((substr delete $_[0]{rbuf}, 0, $len, ""), undef, undef, 1)
710 if $len <= length $_[0]{rbuf}; 836 if $len <= length $_[0]{rbuf};
711 }); 837 });
712 } else { 838 } else {
713 $_[0]->on_error (sub { 839 $_[0]->on_error (sub {
714 ($! == Errno::EPIPE || !$!) 840 ($! == Errno::EPIPE || !$!)
715 ? $finish->(delete $_[0]{rbuf}, \%hdr) 841 ? $finish->(delete $_[0]{rbuf})
716 : $finish->(undef, { Status => 599, Reason => $_[2], @pseudo }); 842 : $finish->(undef, 599 => $_[2]);
717 }); 843 });
718 $_[0]->on_read (sub { }); 844 $_[0]->on_read (sub { });
719 } 845 }
720 } 846 }
721 } 847 }
722 }); 848 };
849
850 $state{handle}->push_read (line => $qr_nlnl, $state{read_response});
723 }; 851 };
724 852
725 # now handle proxy-CONNECT method 853 # now handle proxy-CONNECT method
726 if ($proxy && $uscheme eq "https") { 854 if ($proxy && $uscheme eq "https") {
727 # oh dear, we have to wrap it into a connect request 855 # oh dear, we have to wrap it into a connect request
728 856
729 # maybe re-use $uauthority with patched port? 857 # maybe re-use $uauthority with patched port?
730 $state{handle}->push_write ("CONNECT $uhost:$uport HTTP/1.0\015\012Host: $uhost\015\012\015\012"); 858 $state{handle}->push_write ("CONNECT $uhost:$uport HTTP/1.0\015\012Host: $uhost\015\012\015\012");
731 $state{handle}->push_read (line => $qr_nlnl, sub { 859 $state{handle}->push_read (line => $qr_nlnl, sub {
732 $_[1] =~ /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\015\012]*) )?/ix 860 $_[1] =~ /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\015\012]*) )?/ix
733 or return (%state = (), $cb->(undef, { Status => 599, Reason => "Invalid proxy connect response ($_[1])", @pseudo })); 861 or return (%state = (), $cb->(undef, { @pseudo, Status => 599, Reason => "Invalid proxy connect response ($_[1])" }));
734 862
735 if ($2 == 200) { 863 if ($2 == 200) {
736 $rpath = $upath; 864 $rpath = $upath;
737 &$handle_actual_request; 865 &$handle_actual_request;
738 } else { 866 } else {
739 %state = (); 867 %state = ();
740 $cb->(undef, { Status => $2, Reason => $3, @pseudo }); 868 $cb->(undef, { @pseudo, Status => $2, Reason => $3 });
741 } 869 }
742 }); 870 });
743 } else { 871 } else {
744 &$handle_actual_request; 872 &$handle_actual_request;
745 } 873 }
874 };
746 875
747 }, $arg{on_prepare} || sub { $timeout }; 876 my $tcp_connect = $arg{tcp_connect}
877 || do { require AnyEvent::Socket; \&AnyEvent::Socket::tcp_connect };
878
879 $state{connect_guard} = $tcp_connect->($rhost, $rport, $connect_cb, $arg{on_prepare} || sub { $timeout });
880
748 }; 881 };
749 882
750 defined wantarray && AnyEvent::Util::guard { %state = () } 883 defined wantarray && AnyEvent::Util::guard { %state = () }
751} 884}
752 885
… …
787string of the form C<http://host:port> (optionally C<https:...>), croaks 920string of the form C<http://host:port> (optionally C<https:...>), croaks
788otherwise. 921otherwise.
789 922
790To clear an already-set proxy, use C<undef>. 923To clear an already-set proxy, use C<undef>.
791 924
925=item $date = AnyEvent::HTTP::format_date $timestamp
926
927Takes a POSIX timestamp (seconds since the epoch) and formats it as a HTTP
928Date (RFC 2616).
929
930=item $timestamp = AnyEvent::HTTP::parse_date $date
931
932Takes a HTTP Date (RFC 2616) or a Cookie date (netscape cookie spec) and
933returns the corresponding POSIX timestamp, or C<undef> if the date cannot
934be parsed.
935
792=item $AnyEvent::HTTP::MAX_RECURSE 936=item $AnyEvent::HTTP::MAX_RECURSE
793 937
794The default value for the C<recurse> request parameter (default: C<10>). 938The default value for the C<recurse> request parameter (default: C<10>).
795 939
796=item $AnyEvent::HTTP::USERAGENT 940=item $AnyEvent::HTTP::USERAGENT
… …
814connections. This number of can be useful for load-leveling. 958connections. This number of can be useful for load-leveling.
815 959
816=back 960=back
817 961
818=cut 962=cut
963
964our @month = qw(Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec);
965our @weekday = qw(Sun Mon Tue Wed Thu Fri Sat);
966
967sub format_date($) {
968 my ($time) = @_;
969
970 # RFC 822/1123 format
971 my ($S, $M, $H, $mday, $mon, $year, $wday, $yday, undef) = gmtime $time;
972
973 sprintf "%s, %02d %s %04d %02d:%02d:%02d GMT",
974 $weekday[$wday], $mday, $month[$mon], $year + 1900,
975 $H, $M, $S;
976}
977
978sub parse_date($) {
979 my ($date) = @_;
980
981 my ($d, $m, $y, $H, $M, $S);
982
983 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$/) {
984 # RFC 822/1123, required by RFC 2616 (with " ")
985 # cookie dates (with "-")
986
987 ($d, $m, $y, $H, $M, $S) = ($1, $2, $3, $4, $5, $6);
988
989 } 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$/) {
990 # RFC 850
991 ($d, $m, $y, $H, $M, $S) = ($1, $2, $3 < 69 ? $3 + 2000 : $3 + 1900, $4, $5, $6);
992
993 } 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])$/) {
994 # ISO C's asctime
995 ($d, $m, $y, $H, $M, $S) = ($2, $1, $6, $3, $4, $5);
996 }
997 # other formats fail in the loop below
998
999 for (0..11) {
1000 if ($m eq $month[$_]) {
1001 require Time::Local;
1002 return Time::Local::timegm ($S, $M, $H, $d, $_, $y);
1003 }
1004 }
1005
1006 undef
1007}
819 1008
820sub set_proxy($) { 1009sub set_proxy($) {
821 if (length $_[0]) { 1010 if (length $_[0]) {
822 $_[0] =~ m%^(https?):// ([^:/]+) (?: : (\d*) )?%ix 1011 $_[0] =~ m%^(https?):// ([^:/]+) (?: : (\d*) )?%ix
823 or Carp::croak "$_[0]: invalid proxy URL"; 1012 or Carp::croak "$_[0]: invalid proxy URL";
… …
830# initialise proxy from environment 1019# initialise proxy from environment
831eval { 1020eval {
832 set_proxy $ENV{http_proxy}; 1021 set_proxy $ENV{http_proxy};
833}; 1022};
834 1023
1024=head2 SOCKS PROXIES
1025
1026Socks proxies are not directly supported by AnyEvent::HTTP. You can
1027compile your perl to support socks, or use an external program such as
1028F<socksify> (dante) or F<tsocks> to make your program use a socks proxy
1029transparently.
1030
1031Alternatively, for AnyEvent::HTTP only, you can use your own
1032C<tcp_connect> function that does the proxy handshake - here is an example
1033that works with socks4a proxies:
1034
1035 use Errno;
1036 use AnyEvent::Util;
1037 use AnyEvent::Socket;
1038 use AnyEvent::Handle;
1039
1040 # host, port and username of/for your socks4a proxy
1041 my $socks_host = "10.0.0.23";
1042 my $socks_port = 9050;
1043 my $socks_user = "";
1044
1045 sub socks4a_connect {
1046 my ($host, $port, $connect_cb, $prepare_cb) = @_;
1047
1048 my $hdl = new AnyEvent::Handle
1049 connect => [$socks_host, $socks_port],
1050 on_prepare => sub { $prepare_cb->($_[0]{fh}) },
1051 on_error => sub { $connect_cb->() },
1052 ;
1053
1054 $hdl->push_write (pack "CCnNZ*Z*", 4, 1, $port, 1, $socks_user, $host);
1055
1056 $hdl->push_read (chunk => 8, sub {
1057 my ($hdl, $chunk) = @_;
1058 my ($status, $port, $ipn) = unpack "xCna4", $chunk;
1059
1060 if ($status == 0x5a) {
1061 $connect_cb->($hdl->{fh}, (format_address $ipn) . ":$port");
1062 } else {
1063 $! = Errno::ENXIO; $connect_cb->();
1064 }
1065 });
1066
1067 $hdl
1068 }
1069
1070Use C<socks4a_connect> instead of C<tcp_connect> when doing C<http_request>s,
1071possibly after switching off other proxy types:
1072
1073 AnyEvent::HTTP::set_proxy undef; # usually you do not want other proxies
1074
1075 http_get 'http://www.google.com', tcp_connect => \&socks4a_connect, sub {
1076 my ($data, $headers) = @_;
1077 ...
1078 };
1079
835=head1 SEE ALSO 1080=head1 SEE ALSO
836 1081
837L<AnyEvent>. 1082L<AnyEvent>.
838 1083
839=head1 AUTHOR 1084=head1 AUTHOR

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines