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

Diff Legend

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