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.60 by root, Thu Dec 30 02:56:28 2010 UTC vs.
Revision 1.83 by root, Sun Jan 2 05:02:28 2011 UTC

47use AnyEvent::Util (); 47use AnyEvent::Util ();
48use AnyEvent::Handle (); 48use AnyEvent::Handle ();
49 49
50use base Exporter::; 50use base Exporter::;
51 51
52our $VERSION = '1.46'; 52our $VERSION = '1.5';
53 53
54our @EXPORT = qw(http_get http_post http_head http_request); 54our @EXPORT = qw(http_get http_post http_head http_request);
55 55
56our $USERAGENT = "Mozilla/5.0 (compatible; U; AnyEvent-HTTP/$VERSION; +http://software.schmorp.de/pkg/AnyEvent)"; 56our $USERAGENT = "Mozilla/5.0 (compatible; U; AnyEvent-HTTP/$VERSION; +http://software.schmorp.de/pkg/AnyEvent)";
57our $MAX_RECURSE = 10; 57our $MAX_RECURSE = 10;
94C<http_request> returns a "cancellation guard" - you have to keep the 94C<http_request> returns a "cancellation guard" - you have to keep the
95object at least alive until the callback get called. If the object gets 95object at least alive until the callback get called. If the object gets
96destroyed before the callback is called, the request will be cancelled. 96destroyed before the callback is called, the request will be cancelled.
97 97
98The callback will be called with the response body data as first argument 98The callback will be called with the response body data as first argument
99(or C<undef> if an error occured), and a hash-ref with response headers as 99(or C<undef> if an error occured), and a hash-ref with response headers
100second argument. 100(and trailers) as second argument.
101 101
102All the headers in that hash are lowercased. In addition to the response 102All the headers in that hash are lowercased. In addition to the response
103headers, the "pseudo-headers" (uppercase to avoid clashing with possible 103headers, the "pseudo-headers" (uppercase to avoid clashing with possible
104response headers) C<HTTPVersion>, C<Status> and C<Reason> contain the 104response headers) C<HTTPVersion>, C<Status> and C<Reason> contain the
105three parts of the HTTP Status-Line of the same name. 105three parts of the HTTP Status-Line of the same name. If an error occurs
106during the body phase of a request, then the original C<Status> and
107C<Reason> values from the header are available as C<OrigStatus> and
108C<OrigReason>.
106 109
107The pseudo-header C<URL> contains the actual URL (which can differ from 110The pseudo-header C<URL> contains the actual URL (which can differ from
108the requested URL when following redirects - for example, you might get 111the requested URL when following redirects - for example, you might get
109an error that your URL scheme is not supported even though your URL is a 112an error that your URL scheme is not supported even though your URL is a
110valid http URL because it redirected to an ftp URL, in which case you can 113valid http URL because it redirected to an ftp URL, in which case you can
119 122
120If the server sends a header multiple times, then their contents will be 123If the server sends a header multiple times, then their contents will be
121joined together with a comma (C<,>), as per the HTTP spec. 124joined together with a comma (C<,>), as per the HTTP spec.
122 125
123If an internal error occurs, such as not being able to resolve a hostname, 126If an internal error occurs, such as not being able to resolve a hostname,
124then C<$data> will be C<undef>, C<< $headers->{Status} >> will be C<59x> 127then C<$data> will be C<undef>, C<< $headers->{Status} >> will be
125(usually C<599>) and the C<Reason> pseudo-header will contain an error 128C<590>-C<599> and the C<Reason> pseudo-header will contain an error
126message. 129message. Currently the following status codes are used:
130
131=over 4
132
133=item 595 - errors during connection etsbalishment, proxy handshake.
134
135=item 596 - errors during TLS negotiation, request sending and header processing.
136
137=item 597 - errors during body receiving or processing.
138
139=item 598 - user aborted request via C<on_header> or C<on_body>.
140
141=item 599 - other, usually nonretryable, errors (garbled URL etc.).
142
143=back
127 144
128A typical callback might look like this: 145A typical callback might look like this:
129 146
130 sub { 147 sub {
131 my ($body, $hdr) = @_; 148 my ($body, $hdr) = @_;
147Whether to recurse requests or not, e.g. on redirects, authentication 164Whether to recurse requests or not, e.g. on redirects, authentication
148retries and so on, and how often to do so. 165retries and so on, and how often to do so.
149 166
150=item headers => hashref 167=item headers => hashref
151 168
152The request headers to use. Currently, C<http_request> may provide its 169The request headers to use. Currently, C<http_request> may provide its own
153own C<Host:>, C<Content-Length:>, C<Connection:> and C<Cookie:> headers 170C<Host:>, C<Content-Length:>, C<Connection:> and C<Cookie:> headers and
154and will provide defaults for C<User-Agent:> and C<Referer:> (this can be 171will provide defaults at least for C<TE:>, C<Referer:> and C<User-Agent:>
155suppressed by using C<undef> for these headers in which case they won't be 172(this can be suppressed by using C<undef> for these headers in which case
156sent at all). 173they won't be sent at all).
157 174
158=item timeout => $seconds 175=item timeout => $seconds
159 176
160The time-out to use for various stages - each connect attempt will reset 177The time-out to use for various stages - each connect attempt will reset
161the timeout, as will read or write activity, i.e. this is not an overall 178the timeout, as will read or write activity, i.e. this is not an overall
171C<$scheme> must be either missing, C<http> for HTTP or C<https> for 188C<$scheme> must be either missing, C<http> for HTTP or C<https> for
172HTTPS. 189HTTPS.
173 190
174=item body => $string 191=item body => $string
175 192
176The request body, usually empty. Will be-sent as-is (future versions of 193The request body, usually empty. Will be sent as-is (future versions of
177this module might offer more options). 194this module might offer more options).
178 195
179=item cookie_jar => $hash_ref 196=item cookie_jar => $hash_ref
180 197
181Passing this parameter enables (simplified) cookie-processing, loosely 198Passing this parameter enables (simplified) cookie-processing, loosely
182based on the original netscape specification. 199based on the original netscape specification.
183 200
184The C<$hash_ref> must be an (initially empty) hash reference which will 201The C<$hash_ref> must be an (initially empty) hash reference which
185get updated automatically. It is possible to save the cookie_jar to 202will get updated automatically. It is possible to save the cookie jar
186persistent storage with something like JSON or Storable, but this is not 203to persistent storage with something like JSON or Storable - see the
187recommended, as expiry times are currently being ignored. 204C<AnyEvent::HTTP::cookie_jar_expire> function if you wish to remove
205expired or session-only cookies, and also for documentation on the format
206of the cookie jar.
188 207
189Note that this cookie implementation is not of very high quality, nor 208Note that this cookie implementation is not meant to be complete. If
190meant to be complete. If you want complete cookie management you have to 209you want complete cookie management you have to do that on your
191do that on your own. C<cookie_jar> is meant as a quick fix to get some 210own. C<cookie_jar> is meant as a quick fix to get most cookie-using sites
192cookie-using sites working. Cookies are a privacy disaster, do not use 211working. Cookies are a privacy disaster, do not use them unless required
193them unless required to. 212to.
213
214When cookie processing is enabled, the C<Cookie:> and C<Set-Cookie:>
215headers will be set and handled by this module, otherwise they will be
216left untouched.
194 217
195=item tls_ctx => $scheme | $tls_ctx 218=item tls_ctx => $scheme | $tls_ctx
196 219
197Specifies the AnyEvent::TLS context to be used for https connections. This 220Specifies the AnyEvent::TLS context to be used for https connections. This
198parameter follows the same rules as the C<tls_ctx> parameter to 221parameter follows the same rules as the C<tls_ctx> parameter to
237 260
238This callback is useful, among other things, to quickly reject unwanted 261This callback is useful, among other things, to quickly reject unwanted
239content, which, if it is supposed to be rare, can be faster than first 262content, which, if it is supposed to be rare, can be faster than first
240doing a C<HEAD> request. 263doing a C<HEAD> request.
241 264
265The downside is that cancelling the request makes it impossible to re-use
266the connection. Also, the C<on_header> callback will not receive any
267trailer (headers sent after the response body).
268
242Example: cancel the request unless the content-type is "text/html". 269Example: cancel the request unless the content-type is "text/html".
243 270
244 on_header => sub { 271 on_header => sub {
245 $_[0]{"content-type"} =~ /^text\/html\s*(?:;|$)/ 272 $_[0]{"content-type"} =~ /^text\/html\s*(?:;|$)/
246 }, 273 },
252string instead of the body data. 279string instead of the body data.
253 280
254It has to return either true (in which case AnyEvent::HTTP will continue), 281It has to return either true (in which case AnyEvent::HTTP will continue),
255or false, in which case AnyEvent::HTTP will cancel the download (and call 282or false, in which case AnyEvent::HTTP will cancel the download (and call
256the completion callback with an error code of C<598>). 283the completion callback with an error code of C<598>).
284
285The downside to cancelling the request is that it makes it impossible to
286re-use the connection.
257 287
258This callback is useful when the data is too large to be held in memory 288This callback is useful when the data is too large to be held in memory
259(so the callback writes it to a file) or when only some information should 289(so the callback writes it to a file) or when only some information should
260be extracted, or when the body should be processed incrementally. 290be extracted, or when the body should be processed incrementally.
261 291
287If you think you need this, first have a look at C<on_body>, to see if 317If you think you need this, first have a look at C<on_body>, to see if
288that doesn't solve your problem in a better way. 318that doesn't solve your problem in a better way.
289 319
290=back 320=back
291 321
292Example: make a simple HTTP GET request for http://www.nethype.de/ 322Example: do a simple HTTP GET request for http://www.nethype.de/ and print
323the response body.
293 324
294 http_request GET => "http://www.nethype.de/", sub { 325 http_request GET => "http://www.nethype.de/", sub {
295 my ($body, $hdr) = @_; 326 my ($body, $hdr) = @_;
296 print "$body\n"; 327 print "$body\n";
297 }; 328 };
298 329
299Example: make a HTTP HEAD request on https://www.google.com/, use a 330Example: do a HTTP HEAD request on https://www.google.com/, use a
300timeout of 30 seconds. 331timeout of 30 seconds.
301 332
302 http_request 333 http_request
303 GET => "https://www.google.com", 334 GET => "https://www.google.com",
304 timeout => 30, 335 timeout => 30,
307 use Data::Dumper; 338 use Data::Dumper;
308 print Dumper $hdr; 339 print Dumper $hdr;
309 } 340 }
310 ; 341 ;
311 342
312Example: make another simple HTTP GET request, but immediately try to 343Example: do another simple HTTP GET request, but immediately try to
313cancel it. 344cancel it.
314 345
315 my $request = http_request GET => "http://www.nethype.de/", sub { 346 my $request = http_request GET => "http://www.nethype.de/", sub {
316 my ($body, $hdr) = @_; 347 my ($body, $hdr) = @_;
317 print "$body\n"; 348 print "$body\n";
349 push @{ $CO_SLOT{$_[0]}[1] }, $_[1]; 380 push @{ $CO_SLOT{$_[0]}[1] }, $_[1];
350 381
351 _slot_schedule $_[0]; 382 _slot_schedule $_[0];
352} 383}
353 384
385#############################################################################
386
387# expire cookies
388sub cookie_jar_expire($;$) {
389 my ($jar, $session_end) = @_;
390
391 %$jar = () if $jar->{version} != 1;
392
393 my $anow = AE::now;
394
395 while (my ($chost, $paths) = each %$jar) {
396 next unless ref $paths;
397
398 while (my ($cpath, $cookies) = each %$paths) {
399 while (my ($cookie, $kv) = each %$cookies) {
400 if (exists $kv->{_expires}) {
401 delete $cookies->{$cookie}
402 if $anow > $kv->{_expires};
403 } elsif ($session_end) {
404 delete $cookies->{$cookie};
405 }
406 }
407
408 delete $paths->{$cpath}
409 unless %$cookies;
410 }
411
412 delete $jar->{$chost}
413 unless %$paths;
414 }
415}
416
417# extract cookies from jar
418sub cookie_jar_extract($$$$) {
419 my ($jar, $uscheme, $uhost, $upath) = @_;
420
421 $uhost = lc $uhost;
422
423 %$jar = () if $jar->{version} != 1;
424
425 my @cookies;
426
427 while (my ($chost, $paths) = each %$jar) {
428 next unless ref $paths;
429
430 if ($chost =~ /^\./) {
431 next unless $chost eq substr $uhost, -length $chost;
432 } elsif ($chost =~ /\./) {
433 next unless $chost eq $uhost;
434 } else {
435 next;
436 }
437
438 while (my ($cpath, $cookies) = each %$paths) {
439 next unless $cpath eq substr $upath, 0, length $cpath;
440
441 while (my ($cookie, $kv) = each %$cookies) {
442 next if $uscheme ne "https" && exists $kv->{secure};
443
444 if (exists $kv->{_expires} and AE::now > $kv->{_expires}) {
445 delete $cookies->{$cookie};
446 next;
447 }
448
449 my $value = $kv->{value};
450
451 if ($value =~ /[=;,[:space:]]/) {
452 $value =~ s/([\\"])/\\$1/g;
453 $value = "\"$value\"";
454 }
455
456 push @cookies, "$cookie=$value";
457 }
458 }
459 }
460
461 \@cookies
462}
463
464# parse set_cookie header into jar
465sub cookie_jar_set_cookie($$$$) {
466 my ($jar, $set_cookie, $uhost, $date) = @_;
467
468 my $anow = int AE::now;
469 my $snow; # server-now
470
471 for ($set_cookie) {
472 # parse NAME=VALUE
473 my @kv;
474
475 # expires is not http-compliant in the original cookie-spec,
476 # we support the official date format and some extensions
477 while (
478 m{
479 \G\s*
480 (?:
481 expires \s*=\s* ([A-Z][a-z][a-z]+,\ [^,;]+)
482 | ([^=;,[:space:]]+) (?: \s*=\s* (?: "((?:[^\\"]+|\\.)*)" | ([^=;,[:space:]]*) ) )?
483 )
484 }gcxsi
485 ) {
486 my $name = $2;
487 my $value = $4;
488
489 if (defined $1) {
490 # expires
491 $name = "expires";
492 $value = $1;
493 } elsif (defined $3) {
494 # quoted
495 $value = $3;
496 $value =~ s/\\(.)/$1/gs;
497 }
498
499 push @kv, lc $name, $value;
500
501 last unless /\G\s*;/gc;
502 }
503
504 last unless @kv;
505
506 my $name = shift @kv;
507 my %kv = (value => shift @kv, @kv);
508
509 if (exists $kv{"max-age"}) {
510 $kv{_expires} = $anow + delete $kv{"max-age"};
511 } elsif (exists $kv{expires}) {
512 $snow ||= parse_date ($date) || $anow;
513 $kv{_expires} = $anow + (parse_date (delete $kv{expires}) - $snow);
514 } else {
515 delete $kv{_expires};
516 }
517
518 my $cdom;
519 my $cpath = (delete $kv{path}) || "/";
520
521 if (exists $kv{domain}) {
522 $cdom = delete $kv{domain};
523
524 $cdom =~ s/^\.?/./; # make sure it starts with a "."
525
526 next if $cdom =~ /\.$/;
527
528 # this is not rfc-like and not netscape-like. go figure.
529 my $ndots = $cdom =~ y/.//;
530 next if $ndots < ($cdom =~ /\.[^.][^.]\.[^.][^.]$/ ? 3 : 2);
531 } else {
532 $cdom = $uhost;
533 }
534
535 # store it
536 $jar->{version} = 1;
537 $jar->{lc $cdom}{$cpath}{$name} = \%kv;
538
539 redo if /\G\s*,/gc;
540 }
541}
542
543# continue to parse $_ for headers and place them into the arg
544sub parse_hdr() {
545 my %hdr;
546
547 # things seen, not parsed:
548 # p3pP="NON CUR OTPi OUR NOR UNI"
549
550 $hdr{lc $1} .= ",$2"
551 while /\G
552 ([^:\000-\037]*):
553 [\011\040]*
554 ((?: [^\012]+ | \012[\011\040] )*)
555 \012
556 /gxc;
557
558 /\G$/
559 or return;
560
561 # remove the "," prefix we added to all headers above
562 substr $_, 0, 1, ""
563 for values %hdr;
564
565 \%hdr
566}
567
354our $qr_nlnl = qr{(?<![^\012])\015?\012}; 568our $qr_nlnl = qr{(?<![^\012])\015?\012};
355 569
356our $TLS_CTX_LOW = { cache => 1, sslv2 => 1 }; 570our $TLS_CTX_LOW = { cache => 1, sslv2 => 1 };
357our $TLS_CTX_HIGH = { cache => 1, verify => 1, verify_peername => "https" }; 571our $TLS_CTX_HIGH = { cache => 1, verify => 1, verify_peername => "https" };
358 572
377 my @pseudo = (URL => $url); 591 my @pseudo = (URL => $url);
378 push @pseudo, Redirect => delete $arg{Redirect} if exists $arg{Redirect}; 592 push @pseudo, Redirect => delete $arg{Redirect} if exists $arg{Redirect};
379 593
380 my $recurse = exists $arg{recurse} ? delete $arg{recurse} : $MAX_RECURSE; 594 my $recurse = exists $arg{recurse} ? delete $arg{recurse} : $MAX_RECURSE;
381 595
382 return $cb->(undef, { Status => 599, Reason => "Too many redirections", @pseudo }) 596 return $cb->(undef, { @pseudo, Status => 599, Reason => "Too many redirections" })
383 if $recurse < 0; 597 if $recurse < 0;
384 598
385 my $proxy = $arg{proxy} || $PROXY; 599 my $proxy = $arg{proxy} || $PROXY;
386 my $timeout = $arg{timeout} || $TIMEOUT; 600 my $timeout = $arg{timeout} || $TIMEOUT;
387 601
390 604
391 $uscheme = lc $uscheme; 605 $uscheme = lc $uscheme;
392 606
393 my $uport = $uscheme eq "http" ? 80 607 my $uport = $uscheme eq "http" ? 80
394 : $uscheme eq "https" ? 443 608 : $uscheme eq "https" ? 443
395 : return $cb->(undef, { Status => 599, Reason => "Only http and https URL schemes supported", @pseudo }); 609 : return $cb->(undef, { @pseudo, Status => 599, Reason => "Only http and https URL schemes supported" });
396 610
397 $uauthority =~ /^(?: .*\@ )? ([^\@:]+) (?: : (\d+) )?$/x 611 $uauthority =~ /^(?: .*\@ )? ([^\@:]+) (?: : (\d+) )?$/x
398 or return $cb->(undef, { Status => 599, Reason => "Unparsable URL", @pseudo }); 612 or return $cb->(undef, { @pseudo, Status => 599, Reason => "Unparsable URL" });
399 613
400 my $uhost = $1; 614 my $uhost = $1;
401 $uport = $2 if defined $2; 615 $uport = $2 if defined $2;
402 616
403 $hdr{host} = defined $2 ? "$uhost:$2" : "$uhost" 617 $hdr{host} = defined $2 ? "$uhost:$2" : "$uhost"
408 622
409 $upath =~ s%^/?%/%; 623 $upath =~ s%^/?%/%;
410 624
411 # cookie processing 625 # cookie processing
412 if (my $jar = $arg{cookie_jar}) { 626 if (my $jar = $arg{cookie_jar}) {
413 %$jar = () if $jar->{version} != 1; 627 my $cookies = cookie_jar_extract $jar, $uscheme, $uhost, $upath;
414 628
415 my @cookie;
416
417 while (my ($chost, $v) = each %$jar) {
418 if ($chost =~ /^\./) {
419 next unless $chost eq substr $uhost, -length $chost;
420 } elsif ($chost =~ /\./) {
421 next unless $chost eq $uhost;
422 } else {
423 next;
424 }
425
426 while (my ($cpath, $v) = each %$v) {
427 next unless $cpath eq substr $upath, 0, length $cpath;
428
429 while (my ($k, $v) = each %$v) {
430 next if $uscheme ne "https" && exists $v->{secure};
431 my $value = $v->{value};
432 $value =~ s/([\\"])/\\$1/g;
433 push @cookie, "$k=\"$value\"";
434 }
435 }
436 }
437
438 $hdr{cookie} = join "; ", @cookie 629 $hdr{cookie} = join "; ", @$cookies
439 if @cookie; 630 if @$cookies;
440 } 631 }
441 632
442 my ($rhost, $rport, $rscheme, $rpath); # request host, port, path 633 my ($rhost, $rport, $rscheme, $rpath); # request host, port, path
443 634
444 if ($proxy) { 635 if ($proxy) {
452 } else { 643 } else {
453 ($rhost, $rport, $rscheme, $rpath) = ($uhost, $uport, $uscheme, $upath); 644 ($rhost, $rport, $rscheme, $rpath) = ($uhost, $uport, $uscheme, $upath);
454 } 645 }
455 646
456 # leave out fragment and query string, just a heuristic 647 # leave out fragment and query string, just a heuristic
457 $hdr{referer} ||= "$uscheme://$uauthority$upath" unless exists $hdr{referer}; 648 $hdr{referer} = "$uscheme://$uauthority$upath" unless exists $hdr{referer};
458 $hdr{"user-agent"} ||= $USERAGENT unless exists $hdr{"user-agent"}; 649 $hdr{"user-agent"} = $USERAGENT unless exists $hdr{"user-agent"};
459 650
460 $hdr{"content-length"} = length $arg{body} 651 $hdr{"content-length"} = length $arg{body}
461 if length $arg{body} || $method ne "GET"; 652 if length $arg{body} || $method ne "GET";
462 653
654 $hdr{connection} = "close TE"; #1.1
655 $hdr{te} = "trailers" unless exists $hdr{te}; #1.1
656
463 my %state = (connect_guard => 1); 657 my %state = (connect_guard => 1);
464 658
465 _get_slot $uhost, sub { 659 _get_slot $uhost, sub {
466 $state{slot_guard} = shift; 660 $state{slot_guard} = shift;
467 661
468 return unless $state{connect_guard}; 662 return unless $state{connect_guard};
469 663
470 my $tcp_connect = $arg{tcp_connect} 664 my $ae_error = 595; # connecting
471 || do { require AnyEvent::Socket; \&AnyEvent::Socket::tcp_connect };
472 665
473 $state{connect_guard} = $tcp_connect->( 666 # handle actual, non-tunneled, request
474 $rhost, 667 my $handle_actual_request = sub {
475 $rport, 668 $ae_error = 596; # request phase
476 sub { 669
477 $state{fh} = shift 670 $state{handle}->starttls ("connect") if $uscheme eq "https" && !exists $state{handle}{tls};
478 or do { 671
479 my $err = "$!"; 672 # send request
480 %state = (); 673 $state{handle}->push_write (
481 return $cb->(undef, { Status => 599, Reason => $err, @pseudo }); 674 "$method $rpath HTTP/1.1\015\012"
675 . (join "", map "\u$_: $hdr{$_}\015\012", grep defined $hdr{$_}, keys %hdr)
676 . "\015\012"
677 . (delete $arg{body})
678 );
679
680 # return if error occured during push_write()
681 return unless %state;
682
683 %hdr = (); # reduce memory usage, save a kitten, also make it possible to re-use
684
685 # status line and headers
686 $state{read_response} = sub {
687 for ("$_[1]") {
688 y/\015//d; # weed out any \015, as they show up in the weirdest of places.
689
690 /^HTTP\/0*([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\012]*) )? \012/gxci
691 or return (%state = (), $cb->(undef, { @pseudo, Status => 599, Reason => "Invalid server response" }));
692
693 # 100 Continue handling
694 # should not happen as we don't send expect: 100-continue,
695 # but we handle it just in case.
696 # since we send the request body regardless, if we get an error
697 # we are out of-sync, which we currently do NOT handle correctly.
698 return $state{handle}->push_read (line => $qr_nlnl, $state{read_response})
699 if $2 eq 100;
700
701 push @pseudo,
702 HTTPVersion => $1,
703 Status => $2,
704 Reason => $3,
482 }; 705 ;
483 706
484 pop; # free memory, save a tree 707 my $hdr = parse_hdr
708 or return (%state = (), $cb->(undef, { @pseudo, Status => 599, Reason => "Garbled response headers" }));
485 709
710 %hdr = (%$hdr, @pseudo);
711 }
712
713 # redirect handling
714 # microsoft and other shitheads don't give a shit for following standards,
715 # try to support some common forms of broken Location headers.
716 if ($hdr{location} !~ /^(?: $ | [^:\/?\#]+ : )/x) {
717 $hdr{location} =~ s/^\.\/+//;
718
719 my $url = "$rscheme://$uhost:$uport";
720
721 unless ($hdr{location} =~ s/^\///) {
722 $url .= $upath;
723 $url =~ s/\/[^\/]*$//;
724 }
725
726 $hdr{location} = "$url/$hdr{location}";
727 }
728
729 my $redirect;
730
731 if ($recurse) {
732 my $status = $hdr{Status};
733
734 # industry standard is to redirect POST as GET for
735 # 301, 302 and 303, in contrast to HTTP/1.0 and 1.1.
736 # also, the UA should ask the user for 301 and 307 and POST,
737 # industry standard seems to be to simply follow.
738 # we go with the industry standard.
739 if ($status == 301 or $status == 302 or $status == 303) {
740 # HTTP/1.1 is unclear on how to mutate the method
741 $method = "GET" unless $method eq "HEAD";
742 $redirect = 1;
743 } elsif ($status == 307) {
744 $redirect = 1;
745 }
746 }
747
748 my $finish = sub { # ($data, $err_status, $err_reason[, $keepalive])
749 my $may_keep_alive = $_[3];
750
751 $state{handle}->destroy if $state{handle};
752 %state = ();
753
754 if (defined $_[1]) {
755 $hdr{OrigStatus} = $hdr{Status}; $hdr{Status} = $_[1];
756 $hdr{OrigReason} = $hdr{Reason}; $hdr{Reason} = $_[2];
757 }
758
759 # set-cookie processing
760 if ($arg{cookie_jar}) {
761 cookie_jar_set_cookie $arg{cookie_jar}, $hdr{"set-cookie"}, $uhost, $hdr{date};
762 }
763
764 if ($redirect && exists $hdr{location}) {
765 # we ignore any errors, as it is very common to receive
766 # Content-Length != 0 but no actual body
767 # we also access %hdr, as $_[1] might be an erro
768 http_request (
769 $method => $hdr{location},
770 %arg,
771 recurse => $recurse - 1,
772 Redirect => [$_[0], \%hdr],
773 $cb);
774 } else {
775 $cb->($_[0], \%hdr);
776 }
777 };
778
779 $ae_error = 597; # body phase
780
781 my $len = $hdr{"content-length"};
782
783 if (!$redirect && $arg{on_header} && !$arg{on_header}(\%hdr)) {
784 $finish->(undef, 598 => "Request cancelled by on_header");
785 } elsif (
786 $hdr{Status} =~ /^(?:1..|204|205|304)$/
787 or $method eq "HEAD"
788 or (defined $len && !$len)
789 ) {
790 # no body
791 $finish->("", undef, undef, 1);
792 } else {
793 # body handling, many different code paths
794 # - no body expected
795 # - want_body_handle
796 # - te chunked
797 # - 2x length known (with or without on_body)
798 # - 2x length not known (with or without on_body)
799 if (!$redirect && $arg{want_body_handle}) {
800 $_[0]->on_eof (undef);
801 $_[0]->on_error (undef);
802 $_[0]->on_read (undef);
803
804 $finish->(delete $state{handle});
805
806 } elsif ($hdr{"transfer-encoding"} =~ /\bchunked\b/i) {
807 my $cl = 0;
808 my $body = undef;
809 my $on_body = $arg{on_body} || sub { $body .= shift; 1 };
810
811 $state{read_chunk} = sub {
812 $_[1] =~ /^([0-9a-fA-F]+)/
813 or $finish->(undef, $ae_error => "Garbled chunked transfer encoding");
814
815 my $len = hex $1;
816
817 if ($len) {
818 $cl += $len;
819
820 $_[0]->push_read (chunk => $len, sub {
821 $on_body->($_[1], \%hdr)
822 or return $finish->(undef, 598 => "Request cancelled by on_body");
823
824 $_[0]->push_read (line => sub {
825 length $_[1]
826 and return $finish->(undef, $ae_error => "Garbled chunked transfer encoding");
827 $_[0]->push_read (line => $state{read_chunk});
828 });
829 });
830 } else {
831 $hdr{"content-length"} ||= $cl;
832
833 $_[0]->push_read (line => $qr_nlnl, sub {
834 if (length $_[1]) {
835 for ("$_[1]") {
836 y/\015//d; # weed out any \015, as they show up in the weirdest of places.
837
838 my $hdr = parse_hdr
839 or return $finish->(undef, $ae_error => "Garbled response trailers");
840
841 %hdr = (%hdr, %$hdr);
842 }
843 }
844
845 $finish->($body, undef, undef, 1);
846 });
847 }
848 };
849
850 $_[0]->push_read (line => $state{read_chunk});
851
852 } elsif ($arg{on_body}) {
853 if ($len) {
854 $_[0]->on_read (sub {
855 $len -= length $_[0]{rbuf};
856
857 $arg{on_body}(delete $_[0]{rbuf}, \%hdr)
858 or return $finish->(undef, 598 => "Request cancelled by on_body");
859
860 $len > 0
861 or $finish->("", undef, undef, 1);
862 });
863 } else {
864 $_[0]->on_eof (sub {
865 $finish->("");
866 });
867 $_[0]->on_read (sub {
868 $arg{on_body}(delete $_[0]{rbuf}, \%hdr)
869 or $finish->(undef, 598 => "Request cancelled by on_body");
870 });
871 }
872 } else {
873 $_[0]->on_eof (undef);
874
875 if ($len) {
876 $_[0]->on_read (sub {
877 $finish->((substr delete $_[0]{rbuf}, 0, $len, ""), undef, undef, 1)
878 if $len <= length $_[0]{rbuf};
879 });
880 } else {
881 $_[0]->on_error (sub {
882 ($! == Errno::EPIPE || !$!)
883 ? $finish->(delete $_[0]{rbuf})
884 : $finish->(undef, $ae_error => $_[2]);
885 });
886 $_[0]->on_read (sub { });
887 }
888 }
889 }
890 };
891
892 $state{handle}->push_read (line => $qr_nlnl, $state{read_response});
893 };
894
895 my $connect_cb = sub {
896 $state{fh} = shift
897 or do {
898 my $err = "$!";
899 %state = ();
900 return $cb->(undef, { @pseudo, Status => $ae_error, Reason => $err });
901 };
902
486 return unless delete $state{connect_guard}; 903 return unless delete $state{connect_guard};
487 904
488 # get handle 905 # get handle
489 $state{handle} = new AnyEvent::Handle 906 $state{handle} = new AnyEvent::Handle
490 fh => $state{fh}, 907 fh => $state{fh},
491 peername => $rhost, 908 peername => $rhost,
492 tls_ctx => $arg{tls_ctx}, 909 tls_ctx => $arg{tls_ctx},
493 # these need to be reconfigured on keepalive handles 910 # these need to be reconfigured on keepalive handles
494 timeout => $timeout, 911 timeout => $timeout,
495 on_error => sub { 912 on_error => sub {
496 %state = (); 913 %state = ();
497 $cb->(undef, { Status => 599, Reason => $_[2], @pseudo }); 914 $cb->(undef, { @pseudo, Status => $ae_error, Reason => $_[2] });
498 }, 915 },
499 on_eof => sub { 916 on_eof => sub {
500 %state = (); 917 %state = ();
501 $cb->(undef, { Status => 599, Reason => "Unexpected end-of-file", @pseudo }); 918 $cb->(undef, { @pseudo, Status => $ae_error, Reason => "Unexpected end-of-file" });
502 }, 919 },
503 ; 920 ;
504 921
505 # limit the number of persistent connections 922 # limit the number of persistent connections
506 # keepalive not yet supported 923 # keepalive not yet supported
507# if ($KA_COUNT{$_[1]} < $MAX_PERSISTENT_PER_HOST) { 924# if ($KA_COUNT{$_[1]} < $MAX_PERSISTENT_PER_HOST) {
508# ++$KA_COUNT{$_[1]}; 925# ++$KA_COUNT{$_[1]};
509# $state{handle}{ka_count_guard} = AnyEvent::Util::guard { 926# $state{handle}{ka_count_guard} = AnyEvent::Util::guard {
510# --$KA_COUNT{$_[1]} 927# --$KA_COUNT{$_[1]}
511# }; 928# };
512# $hdr{connection} = "keep-alive"; 929# $hdr{connection} = "keep-alive";
513# } else {
514 delete $hdr{connection};
515# } 930# }
516 931
517 $state{handle}->starttls ("connect") if $rscheme eq "https"; 932 $state{handle}->starttls ("connect") if $rscheme eq "https";
518 933
519 # handle actual, non-tunneled, request
520 my $handle_actual_request = sub {
521 $state{handle}->starttls ("connect") if $uscheme eq "https" && !exists $state{handle}{tls};
522
523 # send request
524 $state{handle}->push_write (
525 "$method $rpath HTTP/1.0\015\012"
526 . (join "", map "\u$_: $hdr{$_}\015\012", grep defined $hdr{$_}, keys %hdr)
527 . "\015\012"
528 . (delete $arg{body})
529 );
530
531 # return if error occured during push_write()
532 return unless %state;
533
534 %hdr = (); # reduce memory usage, save a kitten, also make it possible to re-use
535
536 # status line and headers
537 $state{handle}->push_read (line => $qr_nlnl, sub {
538 for ("$_[1]") {
539 y/\015//d; # weed out any \015, as they show up in the weirdest of places.
540
541 /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\015\012]*) )? \015?\012/igxc
542 or return (%state = (), $cb->(undef, { Status => 599, Reason => "Invalid server response", @pseudo }));
543
544 push @pseudo,
545 HTTPVersion => $1,
546 Status => $2,
547 Reason => $3,
548 ;
549
550 # things seen, not parsed:
551 # p3pP="NON CUR OTPi OUR NOR UNI"
552
553 $hdr{lc $1} .= ",$2"
554 while /\G
555 ([^:\000-\037]*):
556 [\011\040]*
557 ((?: [^\012]+ | \012[\011\040] )*)
558 \012
559 /gxc;
560
561 /\G$/
562 or return (%state = (), $cb->(undef, { Status => 599, Reason => "Garbled response headers", @pseudo }));
563 }
564
565 # remove the "," prefix we added to all headers above
566 substr $_, 0, 1, ""
567 for values %hdr;
568
569 # patch in all pseudo headers
570 %hdr = (%hdr, @pseudo);
571
572 # redirect handling
573 # microsoft and other shitheads don't give a shit for following standards,
574 # try to support some common forms of broken Location headers.
575 if ($hdr{location} !~ /^(?: $ | [^:\/?\#]+ : )/x) {
576 $hdr{location} =~ s/^\.\/+//;
577
578 my $url = "$rscheme://$uhost:$uport";
579
580 unless ($hdr{location} =~ s/^\///) {
581 $url .= $upath;
582 $url =~ s/\/[^\/]*$//;
583 }
584
585 $hdr{location} = "$url/$hdr{location}";
586 }
587
588 my $redirect;
589
590 if ($recurse) {
591 my $status = $hdr{Status};
592
593 # industry standard is to redirect POST as GET for
594 # 301, 302 and 303, in contrast to http/1.0 and 1.1.
595 # also, the UA should ask the user for 301 and 307 and POST,
596 # industry standard seems to be to simply follow.
597 # we go with the industry standard.
598 if ($status == 301 or $status == 302 or $status == 303) {
599 # HTTP/1.1 is unclear on how to mutate the method
600 $method = "GET" unless $method eq "HEAD";
601 $redirect = 1;
602 } elsif ($status == 307) {
603 $redirect = 1;
604 }
605 }
606
607 my $finish = sub {
608 $state{handle}->destroy if $state{handle};
609 %state = ();
610
611 # set-cookie processing
612 if ($arg{cookie_jar}) {
613 for ($_[1]{"set-cookie"}) {
614 # parse NAME=VALUE
615 my @kv;
616
617 while (/\G\s* ([^=;,[:space:]]+) \s*=\s* (?: "((?:[^\\"]+|\\.)*)" | ([^=;,[:space:]]*) )/gcxs) {
618 my $name = $1;
619 my $value = $3;
620
621 unless ($value) {
622 $value = $2;
623 $value =~ s/\\(.)/$1/gs;
624 }
625
626 push @kv, $name => $value;
627
628 last unless /\G\s*;/gc;
629 }
630
631 last unless @kv;
632
633 my $name = shift @kv;
634 my %kv = (value => shift @kv, @kv);
635
636 my $cdom;
637 my $cpath = (delete $kv{path}) || "/";
638
639 if (exists $kv{domain}) {
640 $cdom = delete $kv{domain};
641
642 $cdom =~ s/^\.?/./; # make sure it starts with a "."
643
644 next if $cdom =~ /\.$/;
645
646 # this is not rfc-like and not netscape-like. go figure.
647 my $ndots = $cdom =~ y/.//;
648 next if $ndots < ($cdom =~ /\.[^.][^.]\.[^.][^.]$/ ? 3 : 2);
649 } else {
650 $cdom = $uhost;
651 }
652
653 # store it
654 $arg{cookie_jar}{version} = 1;
655 $arg{cookie_jar}{$cdom}{$cpath}{$name} = \%kv;
656
657 redo if /\G\s*,/gc;
658 }
659 }
660
661 if ($redirect && exists $hdr{location}) {
662 # we ignore any errors, as it is very common to receive
663 # Content-Length != 0 but no actual body
664 # we also access %hdr, as $_[1] might be an erro
665 http_request (
666 $method => $hdr{location},
667 %arg,
668 recurse => $recurse - 1,
669 Redirect => \@_,
670 $cb);
671 } else {
672 $cb->($_[0], $_[1]);
673 }
674 };
675
676 my $len = $hdr{"content-length"};
677
678 if (!$redirect && $arg{on_header} && !$arg{on_header}(\%hdr)) {
679 $finish->(undef, { Status => 598, Reason => "Request cancelled by on_header", @pseudo });
680 } elsif (
681 $hdr{Status} =~ /^(?:1..|[23]04)$/
682 or $method eq "HEAD"
683 or (defined $len && !$len)
684 ) {
685 # no body
686 $finish->("", \%hdr);
687 } else {
688 # body handling, four different code paths
689 # for want_body_handle, on_body (2x), normal (2x)
690 # we might read too much here, but it does not matter yet (no pers. connections)
691 if (!$redirect && $arg{want_body_handle}) {
692 $_[0]->on_eof (undef);
693 $_[0]->on_error (undef);
694 $_[0]->on_read (undef);
695
696 $finish->(delete $state{handle}, \%hdr);
697
698 } elsif ($arg{on_body}) {
699 $_[0]->on_error (sub { $finish->(undef, { Status => 599, Reason => $_[2], @pseudo }) });
700 if ($len) {
701 $_[0]->on_eof (undef);
702 $_[0]->on_read (sub {
703 $len -= length $_[0]{rbuf};
704
705 $arg{on_body}(delete $_[0]{rbuf}, \%hdr)
706 or $finish->(undef, { Status => 598, Reason => "Request cancelled by on_body", @pseudo });
707
708 $len > 0
709 or $finish->("", \%hdr);
710 });
711 } else {
712 $_[0]->on_eof (sub {
713 $finish->("", \%hdr);
714 });
715 $_[0]->on_read (sub {
716 $arg{on_body}(delete $_[0]{rbuf}, \%hdr)
717 or $finish->(undef, { Status => 598, Reason => "Request cancelled by on_body", @pseudo });
718 });
719 }
720 } else {
721 $_[0]->on_eof (undef);
722
723 if ($len) {
724 $_[0]->on_error (sub { $finish->(undef, { Status => 599, Reason => $_[2], @pseudo }) });
725 $_[0]->on_read (sub {
726 $finish->((substr delete $_[0]{rbuf}, 0, $len, ""), \%hdr)
727 if $len <= length $_[0]{rbuf};
728 });
729 } else {
730 $_[0]->on_error (sub {
731 ($! == Errno::EPIPE || !$!)
732 ? $finish->(delete $_[0]{rbuf}, \%hdr)
733 : $finish->(undef, { Status => 599, Reason => $_[2], @pseudo });
734 });
735 $_[0]->on_read (sub { });
736 }
737 }
738 }
739 });
740 };
741
742 # now handle proxy-CONNECT method 934 # now handle proxy-CONNECT method
743 if ($proxy && $uscheme eq "https") { 935 if ($proxy && $uscheme eq "https") {
744 # oh dear, we have to wrap it into a connect request 936 # oh dear, we have to wrap it into a connect request
745 937
746 # maybe re-use $uauthority with patched port? 938 # maybe re-use $uauthority with patched port?
747 $state{handle}->push_write ("CONNECT $uhost:$uport HTTP/1.0\015\012Host: $uhost\015\012\015\012"); 939 $state{handle}->push_write ("CONNECT $uhost:$uport HTTP/1.0\015\012Host: $uhost\015\012\015\012");
748 $state{handle}->push_read (line => $qr_nlnl, sub { 940 $state{handle}->push_read (line => $qr_nlnl, sub {
749 $_[1] =~ /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\015\012]*) )?/ix 941 $_[1] =~ /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\015\012]*) )?/ix
750 or return (%state = (), $cb->(undef, { Status => 599, Reason => "Invalid proxy connect response ($_[1])", @pseudo })); 942 or return (%state = (), $cb->(undef, { @pseudo, Status => 599, Reason => "Invalid proxy connect response ($_[1])" }));
751 943
752 if ($2 == 200) { 944 if ($2 == 200) {
753 $rpath = $upath; 945 $rpath = $upath;
754 &$handle_actual_request; 946 $handle_actual_request->();
755 } else { 947 } else {
756 %state = (); 948 %state = ();
757 $cb->(undef, { Status => $2, Reason => $3, @pseudo }); 949 $cb->(undef, { @pseudo, Status => $2, Reason => $3 });
758 }
759 }); 950 }
760 } else {
761 &$handle_actual_request;
762 } 951 });
763 952 } else {
953 $handle_actual_request->();
764 }, 954 }
765 $arg{on_prepare} || sub { $timeout }
766 ); 955 };
956
957 my $tcp_connect = $arg{tcp_connect}
958 || do { require AnyEvent::Socket; \&AnyEvent::Socket::tcp_connect };
959
960 $state{connect_guard} = $tcp_connect->($rhost, $rport, $connect_cb, $arg{on_prepare} || sub { $timeout });
767 }; 961 };
768 962
769 defined wantarray && AnyEvent::Util::guard { %state = () } 963 defined wantarray && AnyEvent::Util::guard { %state = () }
770} 964}
771 965
806string of the form C<http://host:port> (optionally C<https:...>), croaks 1000string of the form C<http://host:port> (optionally C<https:...>), croaks
807otherwise. 1001otherwise.
808 1002
809To clear an already-set proxy, use C<undef>. 1003To clear an already-set proxy, use C<undef>.
810 1004
1005=item AnyEvent::HTTP::cookie_jar_expire $jar[, $session_end]
1006
1007Remove all cookies from the cookie jar that have been expired. If
1008C<$session_end> is given and true, then additionally remove all session
1009cookies.
1010
1011You should call this function (with a true C<$session_end>) before you
1012save cookies to disk, and you should call this function after loading them
1013again. If you have a long-running program you can additonally call this
1014function from time to time.
1015
1016A cookie jar is initially an empty hash-reference that is managed by this
1017module. It's format is subject to change, but currently it is like this:
1018
1019The key C<version> has to contain C<1>, otherwise the hash gets
1020emptied. All other keys are hostnames or IP addresses pointing to
1021hash-references. The key for these inner hash references is the
1022server path for which this cookie is meant, and the values are again
1023hash-references. The keys of those hash-references is the cookie name, and
1024the value, you guessed it, is another hash-reference, this time with the
1025key-value pairs from the cookie, except for C<expires> and C<max-age>,
1026which have been replaced by a C<_expires> key that contains the cookie
1027expiry timestamp.
1028
1029Here is an example of a cookie jar with a single cookie, so you have a
1030chance of understanding the above paragraph:
1031
1032 {
1033 version => 1,
1034 "10.0.0.1" => {
1035 "/" => {
1036 "mythweb_id" => {
1037 _expires => 1293917923,
1038 value => "ooRung9dThee3ooyXooM1Ohm",
1039 },
1040 },
1041 },
1042 }
1043
1044=item $date = AnyEvent::HTTP::format_date $timestamp
1045
1046Takes a POSIX timestamp (seconds since the epoch) and formats it as a HTTP
1047Date (RFC 2616).
1048
1049=item $timestamp = AnyEvent::HTTP::parse_date $date
1050
1051Takes a HTTP Date (RFC 2616) or a Cookie date (netscape cookie spec) or a
1052bunch of minor variations of those, and returns the corresponding POSIX
1053timestamp, or C<undef> if the date cannot be parsed.
1054
811=item $AnyEvent::HTTP::MAX_RECURSE 1055=item $AnyEvent::HTTP::MAX_RECURSE
812 1056
813The default value for the C<recurse> request parameter (default: C<10>). 1057The default value for the C<recurse> request parameter (default: C<10>).
814 1058
815=item $AnyEvent::HTTP::USERAGENT 1059=item $AnyEvent::HTTP::USERAGENT
833connections. This number of can be useful for load-leveling. 1077connections. This number of can be useful for load-leveling.
834 1078
835=back 1079=back
836 1080
837=cut 1081=cut
1082
1083our @month = qw(Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec);
1084our @weekday = qw(Sun Mon Tue Wed Thu Fri Sat);
1085
1086sub format_date($) {
1087 my ($time) = @_;
1088
1089 # RFC 822/1123 format
1090 my ($S, $M, $H, $mday, $mon, $year, $wday, $yday, undef) = gmtime $time;
1091
1092 sprintf "%s, %02d %s %04d %02d:%02d:%02d GMT",
1093 $weekday[$wday], $mday, $month[$mon], $year + 1900,
1094 $H, $M, $S;
1095}
1096
1097sub parse_date($) {
1098 my ($date) = @_;
1099
1100 my ($d, $m, $y, $H, $M, $S);
1101
1102 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$/) {
1103 # RFC 822/1123, required by RFC 2616 (with " ")
1104 # cookie dates (with "-")
1105
1106 ($d, $m, $y, $H, $M, $S) = ($1, $2, $3, $4, $5, $6);
1107
1108 } elsif ($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]?) GMT$/) {
1109 # RFC 850
1110 ($d, $m, $y, $H, $M, $S) = ($1, $2, $3 < 69 ? $3 + 2000 : $3 + 1900, $4, $5, $6);
1111
1112 } 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])$/) {
1113 # ISO C's asctime
1114 ($d, $m, $y, $H, $M, $S) = ($2, $1, $6, $3, $4, $5);
1115 }
1116 # other formats fail in the loop below
1117
1118 for (0..11) {
1119 if ($m eq $month[$_]) {
1120 require Time::Local;
1121 return Time::Local::timegm ($S, $M, $H, $d, $_, $y);
1122 }
1123 }
1124
1125 undef
1126}
838 1127
839sub set_proxy($) { 1128sub set_proxy($) {
840 if (length $_[0]) { 1129 if (length $_[0]) {
841 $_[0] =~ m%^(https?):// ([^:/]+) (?: : (\d*) )?%ix 1130 $_[0] =~ m%^(https?):// ([^:/]+) (?: : (\d*) )?%ix
842 or Carp::croak "$_[0]: invalid proxy URL"; 1131 or Carp::croak "$_[0]: invalid proxy URL";

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines