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.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.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
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
343our $qr_nlnl = qr{(?<![^\012])\015?\012}; 440our $qr_nlnl = qr{(?<![^\012])\015?\012};
344 441
345our $TLS_CTX_LOW = { cache => 1, sslv2 => 1 }; 442our $TLS_CTX_LOW = { cache => 1, sslv2 => 1 };
346our $TLS_CTX_HIGH = { cache => 1, verify => 1, verify_peername => "https" }; 443our $TLS_CTX_HIGH = { cache => 1, verify => 1, verify_peername => "https" };
347 444
… …
366 my @pseudo = (URL => $url); 463 my @pseudo = (URL => $url);
367 push @pseudo, Redirect => delete $arg{Redirect} if exists $arg{Redirect}; 464 push @pseudo, Redirect => delete $arg{Redirect} if exists $arg{Redirect};
368 465
369 my $recurse = exists $arg{recurse} ? delete $arg{recurse} : $MAX_RECURSE; 466 my $recurse = exists $arg{recurse} ? delete $arg{recurse} : $MAX_RECURSE;
370 467
371 return $cb->(undef, { Status => 599, Reason => "Too many redirections", @pseudo }) 468 return $cb->(undef, { @pseudo, Status => 599, Reason => "Too many redirections" })
372 if $recurse < 0; 469 if $recurse < 0;
373 470
374 my $proxy = $arg{proxy} || $PROXY; 471 my $proxy = $arg{proxy} || $PROXY;
375 my $timeout = $arg{timeout} || $TIMEOUT; 472 my $timeout = $arg{timeout} || $TIMEOUT;
376 473
… …
379 476
380 $uscheme = lc $uscheme; 477 $uscheme = lc $uscheme;
381 478
382 my $uport = $uscheme eq "http" ? 80 479 my $uport = $uscheme eq "http" ? 80
383 : $uscheme eq "https" ? 443 480 : $uscheme eq "https" ? 443
384 : 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" });
385 482
386 $uauthority =~ /^(?: .*\@ )? ([^\@:]+) (?: : (\d+) )?$/x 483 $uauthority =~ /^(?: .*\@ )? ([^\@:]+) (?: : (\d+) )?$/x
387 or return $cb->(undef, { Status => 599, Reason => "Unparsable URL", @pseudo }); 484 or return $cb->(undef, { @pseudo, Status => 599, Reason => "Unparsable URL" });
388 485
389 my $uhost = $1; 486 my $uhost = $1;
390 $uport = $2 if defined $2; 487 $uport = $2 if defined $2;
391 488
392 $hdr{host} = defined $2 ? "$uhost:$2" : "$uhost" 489 $hdr{host} = defined $2 ? "$uhost:$2" : "$uhost"
… …
397 494
398 $upath =~ s%^/?%/%; 495 $upath =~ s%^/?%/%;
399 496
400 # cookie processing 497 # cookie processing
401 if (my $jar = $arg{cookie_jar}) { 498 if (my $jar = $arg{cookie_jar}) {
402 %$jar = () if $jar->{version} != 1; 499 my $cookies = cookie_jar_extract $jar, $uscheme, $uhost, $upath;
403 500
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 501 $hdr{cookie} = join "; ", @$cookies
428 if @cookie; 502 if @$cookies;
429 } 503 }
430 504
431 my ($rhost, $rport, $rscheme, $rpath); # request host, port, path 505 my ($rhost, $rport, $rscheme, $rpath); # request host, port, path
432 506
433 if ($proxy) { 507 if ($proxy) {
… …
441 } else { 515 } else {
442 ($rhost, $rport, $rscheme, $rpath) = ($uhost, $uport, $uscheme, $upath); 516 ($rhost, $rport, $rscheme, $rpath) = ($uhost, $uport, $uscheme, $upath);
443 } 517 }
444 518
445 # leave out fragment and query string, just a heuristic 519 # leave out fragment and query string, just a heuristic
446 $hdr{referer} ||= "$uscheme://$uauthority$upath" unless exists $hdr{referer}; 520 $hdr{referer} = "$uscheme://$uauthority$upath" unless exists $hdr{referer};
447 $hdr{"user-agent"} ||= $USERAGENT unless exists $hdr{"user-agent"}; 521 $hdr{"user-agent"} = $USERAGENT unless exists $hdr{"user-agent"};
448 522
449 $hdr{"content-length"} = length $arg{body} 523 $hdr{"content-length"} = length $arg{body}
450 if length $arg{body} || $method ne "GET"; 524 if length $arg{body} || $method ne "GET";
451 525
526 $hdr{connection} = "close TE"; #1.1
527 $hdr{te} = "trailers" unless exists $hdr{te}; #1.1
528
452 my %state = (connect_guard => 1); 529 my %state = (connect_guard => 1);
453 530
454 _get_slot $uhost, sub { 531 _get_slot $uhost, sub {
455 $state{slot_guard} = shift; 532 $state{slot_guard} = shift;
456 533
457 return unless $state{connect_guard}; 534 return unless $state{connect_guard};
458 535
459 $state{connect_guard} = AnyEvent::Socket::tcp_connect $rhost, $rport, sub { 536 my $connect_cb = sub {
460 $state{fh} = shift 537 $state{fh} = shift
461 or do { 538 or do {
462 my $err = "$!"; 539 my $err = "$!";
463 %state = (); 540 %state = ();
464 return $cb->(undef, { Status => 599, Reason => $err, @pseudo }); 541 return $cb->(undef, { @pseudo, Status => 599, Reason => $err });
465 }; 542 };
466 543
467 pop; # free memory, save a tree 544 pop; # free memory, save a tree
468 545
469 return unless delete $state{connect_guard}; 546 return unless delete $state{connect_guard};
… …
475 tls_ctx => $arg{tls_ctx}, 552 tls_ctx => $arg{tls_ctx},
476 # these need to be reconfigured on keepalive handles 553 # these need to be reconfigured on keepalive handles
477 timeout => $timeout, 554 timeout => $timeout,
478 on_error => sub { 555 on_error => sub {
479 %state = (); 556 %state = ();
480 $cb->(undef, { Status => 599, Reason => $_[2], @pseudo }); 557 $cb->(undef, { @pseudo, Status => 599, Reason => $_[2] });
481 }, 558 },
482 on_eof => sub { 559 on_eof => sub {
483 %state = (); 560 %state = ();
484 $cb->(undef, { Status => 599, Reason => "Unexpected end-of-file", @pseudo }); 561 $cb->(undef, { @pseudo, Status => 599, Reason => "Unexpected end-of-file" });
485 }, 562 },
486 ; 563 ;
487 564
488 # limit the number of persistent connections 565 # limit the number of persistent connections
489 # keepalive not yet supported 566 # keepalive not yet supported
… …
491# ++$KA_COUNT{$_[1]}; 568# ++$KA_COUNT{$_[1]};
492# $state{handle}{ka_count_guard} = AnyEvent::Util::guard { 569# $state{handle}{ka_count_guard} = AnyEvent::Util::guard {
493# --$KA_COUNT{$_[1]} 570# --$KA_COUNT{$_[1]}
494# }; 571# };
495# $hdr{connection} = "keep-alive"; 572# $hdr{connection} = "keep-alive";
496# } else {
497 delete $hdr{connection};
498# } 573# }
499 574
500 $state{handle}->starttls ("connect") if $rscheme eq "https"; 575 $state{handle}->starttls ("connect") if $rscheme eq "https";
501 576
502 # handle actual, non-tunneled, request 577 # handle actual, non-tunneled, request
503 my $handle_actual_request = sub { 578 my $handle_actual_request = sub {
504 $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};
505 580
506 # send request 581 # send request
507 $state{handle}->push_write ( 582 $state{handle}->push_write (
508 "$method $rpath HTTP/1.0\015\012" 583 "$method $rpath HTTP/1.1\015\012"
509 . (join "", map "\u$_: $hdr{$_}\015\012", grep defined $hdr{$_}, keys %hdr) 584 . (join "", map "\u$_: $hdr{$_}\015\012", grep defined $hdr{$_}, keys %hdr)
510 . "\015\012" 585 . "\015\012"
511 . (delete $arg{body}) 586 . (delete $arg{body})
512 ); 587 );
513 588
… …
515 return unless %state; 590 return unless %state;
516 591
517 %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
518 593
519 # status line and headers 594 # status line and headers
520 $state{handle}->push_read (line => $qr_nlnl, sub { 595 $state{read_response} = sub {
521 for ("$_[1]") { 596 for ("$_[1]") {
522 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.
523 598
524 /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\015\012]*) )? \015?\012/igxc 599 /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\012]*) )? \012/igxc
525 or return (%state = (), $cb->(undef, { Status => 599, Reason => "Invalid server response", @pseudo })); 600 or return (%state = (), $cb->(undef, { @pseudo, Status => 599, Reason => "Invalid server response" }));
601
602 # 100 Continue handling
603 # should not happen as we don't send expect: 100-continue,
604 # but we handle it just in case.
605 # since we send the request body regardless, if we get an error
606 # we are out of-sync, which we currently do NOT handle correctly.
607 return $state{handle}->push_read (line => $qr_nlnl, $state{read_response})
608 if $2 eq 100;
526 609
527 push @pseudo, 610 push @pseudo,
528 HTTPVersion => $1, 611 HTTPVersion => $1,
529 Status => $2, 612 Status => $2,
530 Reason => $3, 613 Reason => $3,
531 ; 614 ;
532 615
533 # things seen, not parsed: 616 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 })); 617 or return (%state = (), $cb->(undef, { @pseudo, Status => 599, Reason => "Garbled response headers" }));
618
619 %hdr = (%$hdr, @pseudo);
546 } 620 }
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 621
555 # redirect handling 622 # redirect handling
556 # microsoft and other shitheads don't give a shit for following standards, 623 # microsoft and other shitheads don't give a shit for following standards,
557 # try to support some common forms of broken Location headers. 624 # try to support some common forms of broken Location headers.
558 if ($hdr{location} !~ /^(?: $ | [^:\/?\#]+ : )/x) { 625 if ($hdr{location} !~ /^(?: $ | [^:\/?\#]+ : )/x) {
… …
585 } elsif ($status == 307) { 652 } elsif ($status == 307) {
586 $redirect = 1; 653 $redirect = 1;
587 } 654 }
588 } 655 }
589 656
590 my $finish = sub { 657 my $finish = sub { # ($data, $err_status, $err_reason[, $keepalive])
658 my $keepalive = pop;
659
591 $state{handle}->destroy if $state{handle}; 660 $state{handle}->destroy if $state{handle};
592 %state = (); 661 %state = ();
593 662
663 if (defined $_[1]) {
664 $hdr{OrigStatus} = $hdr{Status}; $hdr{Status} = $_[1];
665 $hdr{OrigReason} = $hdr{Reason}; $hdr{Reason} = $_[2];
666 }
667
594 # set-cookie processing 668 # set-cookie processing
595 if ($arg{cookie_jar}) { 669 if ($arg{cookie_jar}) {
596 for ($_[1]{"set-cookie"}) { 670 for ($hdr{"set-cookie"}) {
597 # parse NAME=VALUE 671 # parse NAME=VALUE
598 my @kv; 672 my @kv;
599 673
674 while (
675 m{
676 \G\s*
677 (?:
678 expires \s*=\s* ([A-Z][a-z][a-z],\ [^,;]+)
600 while (/\G\s* ([^=;,[:space:]]+) \s*=\s* (?: "((?:[^\\"]+|\\.)*)" | ([^=;,[:space:]]*) )/gcxs) { 679 | ([^=;,[:space:]]+) \s*=\s* (?: "((?:[^\\"]+|\\.)*)" | ([^=;,[:space:]]*) )
680 )
681 }gcxsi
682 ) {
601 my $name = $1; 683 my $name = $2;
602 my $value = $3; 684 my $value = $4;
603 685
604 unless ($value) { 686 unless (defined $name) {
687 # expires
688 $name = "expires";
605 $value = $2; 689 $value = $1;
690 } elsif (!defined $value) {
691 # quoted
692 $value = $3;
606 $value =~ s/\\(.)/$1/gs; 693 $value =~ s/\\(.)/$1/gs;
607 } 694 }
608 695
609 push @kv, $name => $value; 696 push @kv, lc $name, $value;
610 697
611 last unless /\G\s*;/gc; 698 last unless /\G\s*;/gc;
612 } 699 }
613 700
614 last unless @kv; 701 last unless @kv;
615 702
616 my $name = shift @kv; 703 my $name = shift @kv;
617 my %kv = (value => shift @kv, @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"};
618 708
619 my $cdom; 709 my $cdom;
620 my $cpath = (delete $kv{path}) || "/"; 710 my $cpath = (delete $kv{path}) || "/";
621 711
622 if (exists $kv{domain}) { 712 if (exists $kv{domain}) {
… …
647 # we also access %hdr, as $_[1] might be an erro 737 # we also access %hdr, as $_[1] might be an erro
648 http_request ( 738 http_request (
649 $method => $hdr{location}, 739 $method => $hdr{location},
650 %arg, 740 %arg,
651 recurse => $recurse - 1, 741 recurse => $recurse - 1,
652 Redirect => \@_, 742 Redirect => [$_[0], \%hdr],
653 $cb); 743 $cb);
654 } else { 744 } else {
655 $cb->($_[0], $_[1]); 745 $cb->($_[0], \%hdr);
656 } 746 }
657 }; 747 };
658 748
659 my $len = $hdr{"content-length"}; 749 my $len = $hdr{"content-length"};
660 750
661 if (!$redirect && $arg{on_header} && !$arg{on_header}(\%hdr)) { 751 if (!$redirect && $arg{on_header} && !$arg{on_header}(\%hdr)) {
662 $finish->(undef, { Status => 598, Reason => "Request cancelled by on_header", @pseudo }); 752 $finish->(undef, 598 => "Request cancelled by on_header");
663 } elsif ( 753 } elsif (
664 $hdr{Status} =~ /^(?:1..|[23]04)$/ 754 $hdr{Status} =~ /^(?:1..|204|205|304)$/
665 or $method eq "HEAD" 755 or $method eq "HEAD"
666 or (defined $len && !$len) 756 or (defined $len && !$len)
667 ) { 757 ) {
668 # no body 758 # no body
669 $finish->("", \%hdr); 759 $finish->("", undef, undef, 1);
670 } else { 760 } else {
671 # body handling, four different code paths 761 # body handling, many different code paths
672 # for want_body_handle, on_body (2x), normal (2x) 762 # - no body expected
673 # 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)
674 if (!$redirect && $arg{want_body_handle}) { 767 if (!$redirect && $arg{want_body_handle}) {
675 $_[0]->on_eof (undef); 768 $_[0]->on_eof (undef);
676 $_[0]->on_error (undef); 769 $_[0]->on_error (undef);
677 $_[0]->on_read (undef); 770 $_[0]->on_read (undef);
678 771
679 $finish->(delete $state{handle}, \%hdr); 772 $finish->(delete $state{handle});
773
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
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
787 if ($len) {
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
794 $_[0]->push_read (line => sub {
795 length $_[1]
796 and return $finish->(undef, 599 => "Garbled chunked transfer encoding");
797 $_[0]->push_read (line => $read_chunk);
798 });
799 });
800 } else {
801 $hdr{"content-length"} ||= $cl;
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 }
813 }
814
815 $finish->($body, undef, undef, 1);
816 });
817 }
818 };
819
820 $_[0]->push_read (line => $read_chunk);
680 821
681 } elsif ($arg{on_body}) { 822 } elsif ($arg{on_body}) {
682 $_[0]->on_error (sub { $finish->(undef, { Status => 599, Reason => $_[2], @pseudo }) }); 823 $_[0]->on_error (sub { $finish->(undef, 599 => $_[2]) });
824
683 if ($len) { 825 if ($len) {
684 $_[0]->on_eof (undef);
685 $_[0]->on_read (sub { 826 $_[0]->on_read (sub {
686 $len -= length $_[0]{rbuf}; 827 $len -= length $_[0]{rbuf};
687 828
688 $arg{on_body}(delete $_[0]{rbuf}, \%hdr) 829 $arg{on_body}(delete $_[0]{rbuf}, \%hdr)
689 or $finish->(undef, { Status => 598, Reason => "Request cancelled by on_body", @pseudo }); 830 or return $finish->(undef, 598 => "Request cancelled by on_body");
690 831
691 $len > 0 832 $len > 0
692 or $finish->("", \%hdr); 833 or $finish->("", undef, undef, 1);
693 }); 834 });
694 } else { 835 } else {
695 $_[0]->on_eof (sub { 836 $_[0]->on_eof (sub {
696 $finish->("", \%hdr); 837 $finish->("");
697 }); 838 });
698 $_[0]->on_read (sub { 839 $_[0]->on_read (sub {
699 $arg{on_body}(delete $_[0]{rbuf}, \%hdr) 840 $arg{on_body}(delete $_[0]{rbuf}, \%hdr)
700 or $finish->(undef, { Status => 598, Reason => "Request cancelled by on_body", @pseudo }); 841 or $finish->(undef, 598 => "Request cancelled by on_body");
701 }); 842 });
702 } 843 }
703 } else { 844 } else {
704 $_[0]->on_eof (undef); 845 $_[0]->on_eof (undef);
705 846
706 if ($len) { 847 if ($len) {
707 $_[0]->on_error (sub { $finish->(undef, { Status => 599, Reason => $_[2], @pseudo }) }); 848 $_[0]->on_error (sub { $finish->(undef, 599 => $_[2]) });
708 $_[0]->on_read (sub { 849 $_[0]->on_read (sub {
709 $finish->((substr delete $_[0]{rbuf}, 0, $len, ""), \%hdr) 850 $finish->((substr delete $_[0]{rbuf}, 0, $len, ""), undef, undef, 1)
710 if $len <= length $_[0]{rbuf}; 851 if $len <= length $_[0]{rbuf};
711 }); 852 });
712 } else { 853 } else {
713 $_[0]->on_error (sub { 854 $_[0]->on_error (sub {
714 ($! == Errno::EPIPE || !$!) 855 ($! == Errno::EPIPE || !$!)
715 ? $finish->(delete $_[0]{rbuf}, \%hdr) 856 ? $finish->(delete $_[0]{rbuf})
716 : $finish->(undef, { Status => 599, Reason => $_[2], @pseudo }); 857 : $finish->(undef, 599 => $_[2]);
717 }); 858 });
718 $_[0]->on_read (sub { }); 859 $_[0]->on_read (sub { });
719 } 860 }
720 } 861 }
721 } 862 }
722 }); 863 };
864
865 $state{handle}->push_read (line => $qr_nlnl, $state{read_response});
723 }; 866 };
724 867
725 # now handle proxy-CONNECT method 868 # now handle proxy-CONNECT method
726 if ($proxy && $uscheme eq "https") { 869 if ($proxy && $uscheme eq "https") {
727 # oh dear, we have to wrap it into a connect request 870 # oh dear, we have to wrap it into a connect request
728 871
729 # maybe re-use $uauthority with patched port? 872 # 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"); 873 $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 { 874 $state{handle}->push_read (line => $qr_nlnl, sub {
732 $_[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
733 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])" }));
734 877
735 if ($2 == 200) { 878 if ($2 == 200) {
736 $rpath = $upath; 879 $rpath = $upath;
737 &$handle_actual_request; 880 &$handle_actual_request;
738 } else { 881 } else {
739 %state = (); 882 %state = ();
740 $cb->(undef, { Status => $2, Reason => $3, @pseudo }); 883 $cb->(undef, { @pseudo, Status => $2, Reason => $3 });
741 } 884 }
742 }); 885 });
743 } else { 886 } else {
744 &$handle_actual_request; 887 &$handle_actual_request;
745 } 888 }
889 };
746 890
747 }, $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
748 }; 896 };
749 897
750 defined wantarray && AnyEvent::Util::guard { %state = () } 898 defined wantarray && AnyEvent::Util::guard { %state = () }
751} 899}
752 900
… …
787string of the form C<http://host:port> (optionally C<https:...>), croaks 935string of the form C<http://host:port> (optionally C<https:...>), croaks
788otherwise. 936otherwise.
789 937
790To clear an already-set proxy, use C<undef>. 938To clear an already-set proxy, use C<undef>.
791 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
792=item $AnyEvent::HTTP::MAX_RECURSE 951=item $AnyEvent::HTTP::MAX_RECURSE
793 952
794The default value for the C<recurse> request parameter (default: C<10>). 953The default value for the C<recurse> request parameter (default: C<10>).
795 954
796=item $AnyEvent::HTTP::USERAGENT 955=item $AnyEvent::HTTP::USERAGENT
… …
814connections. This number of can be useful for load-leveling. 973connections. This number of can be useful for load-leveling.
815 974
816=back 975=back
817 976
818=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}
819 1023
820sub set_proxy($) { 1024sub set_proxy($) {
821 if (length $_[0]) { 1025 if (length $_[0]) {
822 $_[0] =~ m%^(https?):// ([^:/]+) (?: : (\d*) )?%ix 1026 $_[0] =~ m%^(https?):// ([^:/]+) (?: : (\d*) )?%ix
823 or Carp::croak "$_[0]: invalid proxy URL"; 1027 or Carp::croak "$_[0]: invalid proxy URL";
… …
830# initialise proxy from environment 1034# initialise proxy from environment
831eval { 1035eval {
832 set_proxy $ENV{http_proxy}; 1036 set_proxy $ENV{http_proxy};
833}; 1037};
834 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
835=head1 SEE ALSO 1095=head1 SEE ALSO
836 1096
837L<AnyEvent>. 1097L<AnyEvent>.
838 1098
839=head1 AUTHOR 1099=head1 AUTHOR

Diff Legend

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