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.40 by root, Sun Jul 5 01:45:01 2009 UTC vs.
Revision 1.59 by root, Wed Dec 29 23:59:36 2010 UTC

39package AnyEvent::HTTP; 39package AnyEvent::HTTP;
40 40
41use strict; 41use strict;
42no warnings; 42no warnings;
43 43
44use Carp; 44use Errno ();
45 45
46use AnyEvent 4.452 (); 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.12'; 52our $VERSION = '1.46';
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;
59our $MAX_PERSISTENT = 8; 58our $MAX_PERSISTENT = 8;
60our $PERSISTENT_TIMEOUT = 2; 59our $PERSISTENT_TIMEOUT = 2;
61our $TIMEOUT = 300; 60our $TIMEOUT = 300;
62 61
63# changing these is evil 62# changing these is evil
64our $MAX_PERSISTENT_PER_HOST = 2; 63our $MAX_PERSISTENT_PER_HOST = 0;
65our $MAX_PER_HOST = 4; 64our $MAX_PER_HOST = 4;
66 65
67our $PROXY; 66our $PROXY;
68our $ACTIVE = 0; 67our $ACTIVE = 0;
69 68
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 data as first argument 98The callback will be called with the response body data as first argument
100(or C<undef> if it wasn't available due to errors), and a hash-ref with 99(or C<undef> if an error occured), and a hash-ref with response headers as
101response headers as second argument. 100second 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" C<HTTPVersion>, C<Status> and C<Reason> 103headers, the "pseudo-headers" (uppercase to avoid clashing with possible
104response headers) C<HTTPVersion>, C<Status> and C<Reason> contain the
105contain the three parts of the HTTP Status-Line of the same name. The 105three parts of the HTTP Status-Line of the same name.
106
106pseudo-header C<URL> contains the original URL (which can differ from the 107The pseudo-header C<URL> contains the actual URL (which can differ from
107requested URL when following redirects). 108the 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
110valid http URL because it redirected to an ftp URL, in which case you can
111look at the URL pseudo header).
112
113The pseudo-header C<Redirect> only exists when the request was a result
114of an internal redirect. In that case it is an array reference with
115the C<($data, $headers)> from the redirect response. Note that this
116response could in turn be the result of a redirect itself, and C<<
117$headers->{Redirect}[1]{Redirect} >> will then contain the original
118response, and so on.
108 119
109If the server sends a header multiple times, then their contents will be 120If the server sends a header multiple times, then their contents will be
110joined together with a comma (C<,>), as per the HTTP spec. 121joined together with a comma (C<,>), as per the HTTP spec.
111 122
112If an internal error occurs, such as not being able to resolve a hostname, 123If an internal error occurs, such as not being able to resolve a hostname,
113then C<$data> will be C<undef>, C<< $headers->{Status} >> will be C<599> 124then C<$data> will be C<undef>, C<< $headers->{Status} >> will be C<59x>
114and the C<Reason> pseudo-header will contain an error message. 125(usually C<599>) and the C<Reason> pseudo-header will contain an error
126message.
115 127
116A typical callback might look like this: 128A typical callback might look like this:
117 129
118 sub { 130 sub {
119 my ($body, $hdr) = @_; 131 my ($body, $hdr) = @_;
137 149
138=item headers => hashref 150=item headers => hashref
139 151
140The request headers to use. Currently, C<http_request> may provide its 152The request headers to use. Currently, C<http_request> may provide its
141own C<Host:>, C<Content-Length:>, C<Connection:> and C<Cookie:> headers 153own C<Host:>, C<Content-Length:>, C<Connection:> and C<Cookie:> headers
142and will provide defaults for C<User-Agent:> and C<Referer:>. 154and will provide defaults for C<User-Agent:> and C<Referer:> (this can be
155suppressed by using C<undef> for these headers in which case they won't be
156sent at all).
143 157
144=item timeout => $seconds 158=item timeout => $seconds
145 159
146The time-out to use for various stages - each connect attempt will reset 160The time-out to use for various stages - each connect attempt will reset
147the timeout, as will read or write activity. Default timeout is 5 minutes. 161the timeout, as will read or write activity, i.e. this is not an overall
162timeout.
163
164Default timeout is 5 minutes.
148 165
149=item proxy => [$host, $port[, $scheme]] or undef 166=item proxy => [$host, $port[, $scheme]] or undef
150 167
151Use the given http proxy for all requests. If not specified, then the 168Use the given http proxy for all requests. If not specified, then the
152default proxy (as specified by C<$ENV{http_proxy}>) is used. 169default proxy (as specified by C<$ENV{http_proxy}>) is used.
153 170
154C<$scheme> must be either missing or C<http> for HTTP, or C<https> for 171C<$scheme> must be either missing, C<http> for HTTP or C<https> for
155HTTPS. 172HTTPS.
156 173
157=item body => $string 174=item body => $string
158 175
159The request body, usually empty. Will be-sent as-is (future versions of 176The request body, usually empty. Will be-sent as-is (future versions of
184verification, highest compatibility) and high-security (CA and common-name 201verification, highest compatibility) and high-security (CA and common-name
185verification) TLS context. 202verification) TLS context.
186 203
187The default for this option is C<low>, which could be interpreted as "give 204The default for this option is C<low>, which could be interpreted as "give
188me the page, no matter what". 205me the page, no matter what".
206
207=item on_prepare => $callback->($fh)
208
209In rare cases you need to "tune" the socket before it is used to
210connect (for exmaple, to bind it on a given IP address). This parameter
211overrides the prepare callback passed to C<AnyEvent::Socket::tcp_connect>
212and behaves exactly the same way (e.g. it has to provide a
213timeout). See the description for the C<$prepare_cb> argument of
214C<AnyEvent::Socket::tcp_connect> for details.
215
216=item tcp_connect => $callback->($host, $service, $connect_cb, $prepare_cb)
217
218In even rarer cases you want total control over how AnyEvent::HTTP
219establishes connections. Normally it uses L<AnyEvent::Socket::tcp_connect>
220to do this, but you can provide your own C<tcp_connect> function -
221obviously, it has to follow the same calling conventions.
222
223There are probably lots of weird uses for this function, starting from
224tracing the hosts C<http_request> actually tries to connect, to (inexact
225but fast) host => IP address caching or even socks protocol support.
226
227=item on_header => $callback->($headers)
228
229When specified, this callback will be called with the header hash as soon
230as headers have been successfully received from the remote server (not on
231locally-generated errors).
232
233It has to return either true (in which case AnyEvent::HTTP will continue),
234or false, in which case AnyEvent::HTTP will cancel the download (and call
235the finish callback with an error code of C<598>).
236
237This callback is useful, among other things, to quickly reject unwanted
238content, which, if it is supposed to be rare, can be faster than first
239doing a C<HEAD> request.
240
241Example: cancel the request unless the content-type is "text/html".
242
243 on_header => sub {
244 $_[0]{"content-type"} =~ /^text\/html\s*(?:;|$)/
245 },
246
247=item on_body => $callback->($partial_body, $headers)
248
249When specified, all body data will be passed to this callback instead of
250to the completion callback. The completion callback will get the empty
251string instead of the body data.
252
253It has to return either true (in which case AnyEvent::HTTP will continue),
254or false, in which case AnyEvent::HTTP will cancel the download (and call
255the completion callback with an error code of C<598>).
256
257This callback is useful when the data is too large to be held in memory
258(so the callback writes it to a file) or when only some information should
259be extracted, or when the body should be processed incrementally.
260
261It is usually preferred over doing your own body handling via
262C<want_body_handle>, but in case of streaming APIs, where HTTP is
263only used to create a connection, C<want_body_handle> is the better
264alternative, as it allows you to install your own event handler, reducing
265resource usage.
266
267=item want_body_handle => $enable
268
269When enabled (default is disabled), the behaviour of AnyEvent::HTTP
270changes considerably: after parsing the headers, and instead of
271downloading the body (if any), the completion callback will be
272called. Instead of the C<$body> argument containing the body data, the
273callback will receive the L<AnyEvent::Handle> object associated with the
274connection. In error cases, C<undef> will be passed. When there is no body
275(e.g. status C<304>), the empty string will be passed.
276
277The handle object might or might not be in TLS mode, might be connected to
278a proxy, be a persistent connection etc., and configured in unspecified
279ways. The user is responsible for this handle (it will not be used by this
280module anymore).
281
282This is useful with some push-type services, where, after the initial
283headers, an interactive protocol is used (typical example would be the
284push-style twitter API which starts a JSON/XML stream).
285
286If you think you need this, first have a look at C<on_body>, to see if
287that doesn't solve your problem in a better way.
189 288
190=back 289=back
191 290
192Example: make a simple HTTP GET request for http://www.nethype.de/ 291Example: make a simple HTTP GET request for http://www.nethype.de/
193 292
249 push @{ $CO_SLOT{$_[0]}[1] }, $_[1]; 348 push @{ $CO_SLOT{$_[0]}[1] }, $_[1];
250 349
251 _slot_schedule $_[0]; 350 _slot_schedule $_[0];
252} 351}
253 352
254our $qr_nl = qr<\015?\012>; 353our $qr_nlnl = qr{(?<![^\012])\015?\012};
255our $qr_nlnl = qr<\015?\012\015?\012>;
256 354
257our $TLS_CTX_LOW = { cache => 1, dh => undef, sslv2 => 1 }; 355our $TLS_CTX_LOW = { cache => 1, sslv2 => 1 };
258our $TLS_CTX_HIGH = { cache => 1, verify => 1, verify_cn => "https", dh => "skip4096" }; 356our $TLS_CTX_HIGH = { cache => 1, verify => 1, verify_peername => "https" };
259 357
260sub http_request($$@) { 358sub http_request($$@) {
261 my $cb = pop; 359 my $cb = pop;
262 my ($method, $url, %arg) = @_; 360 my ($method, $url, %arg) = @_;
263 361
272 while (my ($k, $v) = each %$hdr) { 370 while (my ($k, $v) = each %$hdr) {
273 $hdr{lc $k} = $v; 371 $hdr{lc $k} = $v;
274 } 372 }
275 } 373 }
276 374
375 # pseudo headers for all subsequent responses
376 my @pseudo = (URL => $url);
377 push @pseudo, Redirect => delete $arg{Redirect} if exists $arg{Redirect};
378
277 my $recurse = exists $arg{recurse} ? delete $arg{recurse} : $MAX_RECURSE; 379 my $recurse = exists $arg{recurse} ? delete $arg{recurse} : $MAX_RECURSE;
278 380
279 return $cb->(undef, { Status => 599, Reason => "Too many redirections", URL => $url }) 381 return $cb->(undef, { Status => 599, Reason => "Too many redirections", @pseudo })
280 if $recurse < 0; 382 if $recurse < 0;
281 383
282 my $proxy = $arg{proxy} || $PROXY; 384 my $proxy = $arg{proxy} || $PROXY;
283 my $timeout = $arg{timeout} || $TIMEOUT; 385 my $timeout = $arg{timeout} || $TIMEOUT;
284 386
285 $hdr{"user-agent"} ||= $USERAGENT;
286
287 my ($uscheme, $uauthority, $upath, $query, $fragment) = 387 my ($uscheme, $uauthority, $upath, $query, $fragment) =
288 $url =~ m|(?:([^:/?#]+):)?(?://([^/?#]*))?([^?#]*)(?:\?([^#]*))?(?:#(.*))?|; 388 $url =~ m|(?:([^:/?#]+):)?(?://([^/?#]*))?([^?#]*)(?:(\?[^#]*))?(?:#(.*))?|;
289 389
290 $uscheme = lc $uscheme; 390 $uscheme = lc $uscheme;
291 391
292 my $uport = $uscheme eq "http" ? 80 392 my $uport = $uscheme eq "http" ? 80
293 : $uscheme eq "https" ? 443 393 : $uscheme eq "https" ? 443
294 : return $cb->(undef, { Status => 599, Reason => "Only http and https URL schemes supported (not '$uscheme')", URL => $url }); 394 : return $cb->(undef, { Status => 599, Reason => "Only http and https URL schemes supported", @pseudo });
295
296 $hdr{referer} ||= "$uscheme://$uauthority$upath"; # leave out fragment and query string, just a heuristic
297 395
298 $uauthority =~ /^(?: .*\@ )? ([^\@:]+) (?: : (\d+) )?$/x 396 $uauthority =~ /^(?: .*\@ )? ([^\@:]+) (?: : (\d+) )?$/x
299 or return $cb->(undef, { Status => 599, Reason => "Unparsable URL", URL => $url }); 397 or return $cb->(undef, { Status => 599, Reason => "Unparsable URL", @pseudo });
300 398
301 my $uhost = $1; 399 my $uhost = $1;
302 $uport = $2 if defined $2; 400 $uport = $2 if defined $2;
303 401
402 $hdr{host} = defined $2 ? "$uhost:$2" : "$uhost"
403 unless exists $hdr{host};
404
304 $uhost =~ s/^\[(.*)\]$/$1/; 405 $uhost =~ s/^\[(.*)\]$/$1/;
305 $upath .= "?$query" if length $query; 406 $upath .= $query if length $query;
306 407
307 $upath =~ s%^/?%/%; 408 $upath =~ s%^/?%/%;
308 409
309 # cookie processing 410 # cookie processing
310 if (my $jar = $arg{cookie_jar}) { 411 if (my $jar = $arg{cookie_jar}) {
340 my ($rhost, $rport, $rscheme, $rpath); # request host, port, path 441 my ($rhost, $rport, $rscheme, $rpath); # request host, port, path
341 442
342 if ($proxy) { 443 if ($proxy) {
343 ($rpath, $rhost, $rport, $rscheme) = ($url, @$proxy); 444 ($rpath, $rhost, $rport, $rscheme) = ($url, @$proxy);
344 445
446 $rscheme = "http" unless defined $rscheme;
447
345 # don't support https requests over https-proxy transport, 448 # don't support https requests over https-proxy transport,
346 # can't be done with tls as spec'ed, unless you double-encrypt. 449 # can't be done with tls as spec'ed, unless you double-encrypt.
347 $rscheme = "http" if $uscheme eq "https" && $rscheme eq "https"; 450 $rscheme = "http" if $uscheme eq "https" && $rscheme eq "https";
348 } else { 451 } else {
349 ($rhost, $rport, $rscheme, $rpath) = ($uhost, $uport, $uscheme, $upath); 452 ($rhost, $rport, $rscheme, $rpath) = ($uhost, $uport, $uscheme, $upath);
350 } 453 }
351 454
352 $hdr{host} = $uhost; 455 # leave out fragment and query string, just a heuristic
456 $hdr{referer} ||= "$uscheme://$uauthority$upath" unless exists $hdr{referer};
457 $hdr{"user-agent"} ||= $USERAGENT unless exists $hdr{"user-agent"};
458
353 $hdr{"content-length"} = length $arg{body}; 459 $hdr{"content-length"} = length $arg{body}
460 if length $arg{body} || $method ne "GET";
354 461
355 my %state = (connect_guard => 1); 462 my %state = (connect_guard => 1);
356 463
357 _get_slot $uhost, sub { 464 _get_slot $uhost, sub {
358 $state{slot_guard} = shift; 465 $state{slot_guard} = shift;
359 466
360 return unless $state{connect_guard}; 467 return unless $state{connect_guard};
361 468
362 $state{connect_guard} = AnyEvent::Socket::tcp_connect $rhost, $rport, sub { 469 my $tcp_connect = $arg{tcp_connect}
470 || do { require AnyEvent::Socket; \&AnyEvent::Socket::tcp_connect };
471
472 $state{connect_guard} = $tcp_connect->(
473 $rhost,
474 $rport,
475 sub {
363 $state{fh} = shift 476 $state{fh} = shift
477 or do {
478 my $err = "$!";
479 %state = ();
364 or return (%state = (), $cb->(undef, { Status => 599, Reason => "$!", URL => $url })); 480 return $cb->(undef, { Status => 599, Reason => $err, @pseudo });
481 };
482
365 pop; # free memory, save a tree 483 pop; # free memory, save a tree
366 484
367 return unless delete $state{connect_guard}; 485 return unless delete $state{connect_guard};
368 486
369 # get handle 487 # get handle
370 $state{handle} = new AnyEvent::Handle 488 $state{handle} = new AnyEvent::Handle
371 fh => $state{fh}, 489 fh => $state{fh},
490 peername => $rhost,
491 tls_ctx => $arg{tls_ctx},
492 # these need to be reconfigured on keepalive handles
372 timeout => $timeout, 493 timeout => $timeout,
373 peername => $rhost, 494 on_error => sub {
374 tls_ctx => $arg{tls_ctx}; 495 %state = ();
496 $cb->(undef, { Status => 599, Reason => $_[2], @pseudo });
497 },
498 on_eof => sub {
499 %state = ();
500 $cb->(undef, { Status => 599, Reason => "Unexpected end-of-file", @pseudo });
501 },
502 ;
375 503
376 # limit the number of persistent connections 504 # limit the number of persistent connections
377 # keepalive not yet supported 505 # keepalive not yet supported
378 if ($KA_COUNT{$_[1]} < $MAX_PERSISTENT_PER_HOST) { 506# if ($KA_COUNT{$_[1]} < $MAX_PERSISTENT_PER_HOST) {
379 ++$KA_COUNT{$_[1]}; 507# ++$KA_COUNT{$_[1]};
380 $state{handle}{ka_count_guard} = AnyEvent::Util::guard { 508# $state{handle}{ka_count_guard} = AnyEvent::Util::guard {
381 --$KA_COUNT{$_[1]} 509# --$KA_COUNT{$_[1]}
382 }; 510# };
383 $hdr{connection} = "keep-alive"; 511# $hdr{connection} = "keep-alive";
384 } else { 512# } else {
385 delete $hdr{connection}; 513 delete $hdr{connection};
386 } 514# }
387 515
388 # (re-)configure handle
389 $state{handle}->on_error (sub {
390 %state = ();
391 $cb->(undef, { Status => 599, Reason => $_[2], URL => $url });
392 });
393 $state{handle}->on_eof (sub {
394 %state = ();
395 $cb->(undef, { Status => 599, Reason => "Unexpected end-of-file", URL => $url });
396 });
397
398 $state{handle}->starttls ("connect") if $rscheme eq "https"; 516 $state{handle}->starttls ("connect") if $rscheme eq "https";
399 517
400 # handle actual, non-tunneled, request 518 # handle actual, non-tunneled, request
401 my $handle_actual_request = sub { 519 my $handle_actual_request = sub {
402 $state{handle}->starttls ("connect") if $uscheme eq "https" && !exists $state{handle}{tls}; 520 $state{handle}->starttls ("connect") if $uscheme eq "https" && !exists $state{handle}{tls};
403 521
404 # send request 522 # send request
405 $state{handle}->push_write ( 523 $state{handle}->push_write (
406 "$method $rpath HTTP/1.0\015\012" 524 "$method $rpath HTTP/1.0\015\012"
407 . (join "", map "\u$_: $hdr{$_}\015\012", keys %hdr) 525 . (join "", map "\u$_: $hdr{$_}\015\012", grep defined $hdr{$_}, keys %hdr)
408 . "\015\012" 526 . "\015\012"
409 . (delete $arg{body}) 527 . (delete $arg{body})
410 );
411
412 %hdr = (); # reduce memory usage, save a kitten
413
414 # status line
415 $state{handle}->push_read (line => $qr_nl, sub {
416 $_[1] =~ /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\015\012]*) )?/ix
417 or return (%state = (), $cb->(undef, { Status => 599, Reason => "Invalid server response ($_[1])", URL => $url }));
418
419 my %hdr = ( # response headers
420 HTTPVersion => ",$1",
421 Status => ",$2",
422 Reason => ",$3",
423 URL => ",$url"
424 ); 528 );
425 529
426 # headers, could be optimized a bit 530 # return if error occured during push_write()
531 return unless %state;
532
533 %hdr = (); # reduce memory usage, save a kitten, also make it possible to re-use
534
535 # status line and headers
427 $state{handle}->unshift_read (line => $qr_nlnl, sub { 536 $state{handle}->push_read (line => $qr_nlnl, sub {
428 for ("$_[1]\012") { 537 for ("$_[1]") {
429 y/\015//d; # weed out any \015, as they show up in the weirdest of places. 538 y/\015//d; # weed out any \015, as they show up in the weirdest of places.
539
540 /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\015\012]*) )? \015?\012/igxc
541 or return (%state = (), $cb->(undef, { Status => 599, Reason => "Invalid server response", @pseudo }));
542
543 push @pseudo,
544 HTTPVersion => $1,
545 Status => $2,
546 Reason => $3,
547 ;
430 548
431 # things seen, not parsed: 549 # things seen, not parsed:
432 # p3pP="NON CUR OTPi OUR NOR UNI" 550 # p3pP="NON CUR OTPi OUR NOR UNI"
433 551
434 $hdr{lc $1} .= ",$2" 552 $hdr{lc $1} .= ",$2"
435 while /\G 553 while /\G
436 ([^:\000-\037]+): 554 ([^:\000-\037]*):
437 [\011\040]* 555 [\011\040]*
438 ((?: [^\012]+ | \012[\011\040] )*) 556 ((?: [^\012]+ | \012[\011\040] )*)
439 \012 557 \012
440 /gxc; 558 /gxc;
441 559
442 /\G$/ 560 /\G$/
443 or return (%state = (), $cb->(undef, { Status => 599, Reason => "Garbled response headers", URL => $url })); 561 or return (%state = (), $cb->(undef, { Status => 599, Reason => "Garbled response headers", @pseudo }));
444 } 562 }
445 563
564 # remove the "," prefix we added to all headers above
446 substr $_, 0, 1, "" 565 substr $_, 0, 1, ""
447 for values %hdr; 566 for values %hdr;
448 567
568 # patch in all pseudo headers
569 %hdr = (%hdr, @pseudo);
570
571 # redirect handling
572 # microsoft and other shitheads don't give a shit for following standards,
573 # try to support some common forms of broken Location headers.
574 if ($hdr{location} !~ /^(?: $ | [^:\/?\#]+ : )/x) {
575 $hdr{location} =~ s/^\.\/+//;
576
577 my $url = "$rscheme://$uhost:$uport";
578
579 unless ($hdr{location} =~ s/^\///) {
580 $url .= $upath;
581 $url =~ s/\/[^\/]*$//;
582 }
583
584 $hdr{location} = "$url/$hdr{location}";
585 }
586
587 my $redirect;
588
589 if ($recurse) {
590 my $status = $hdr{Status};
591
592 # industry standard is to redirect POST as GET for
593 # 301, 302 and 303, in contrast to http/1.0 and 1.1.
594 # also, the UA should ask the user for 301 and 307 and POST,
595 # industry standard seems to be to simply follow.
596 # we go with the industry standard.
597 if ($status == 301 or $status == 302 or $status == 303) {
598 # HTTP/1.1 is unclear on how to mutate the method
599 $method = "GET" unless $method eq "HEAD";
600 $redirect = 1;
601 } elsif ($status == 307) {
602 $redirect = 1;
603 }
604 }
605
449 my $finish = sub { 606 my $finish = sub {
450 $state{handle}->destroy; 607 $state{handle}->destroy if $state{handle};
451 %state = (); 608 %state = ();
452 609
453 # set-cookie processing 610 # set-cookie processing
454 if ($arg{cookie_jar}) { 611 if ($arg{cookie_jar}) {
455 for ($hdr{"set-cookie"}) { 612 for ($_[1]{"set-cookie"}) {
456 # parse NAME=VALUE 613 # parse NAME=VALUE
457 my @kv; 614 my @kv;
458 615
459 while (/\G\s* ([^=;,[:space:]]+) \s*=\s* (?: "((?:[^\\"]+|\\.)*)" | ([^=;,[:space:]]*) )/gcxs) { 616 while (/\G\s* ([^=;,[:space:]]+) \s*=\s* (?: "((?:[^\\"]+|\\.)*)" | ([^=;,[:space:]]*) )/gcxs) {
460 my $name = $1; 617 my $name = $1;
498 655
499 redo if /\G\s*,/gc; 656 redo if /\G\s*,/gc;
500 } 657 }
501 } 658 }
502 659
503 # microsoft and other shitheads don't give a shit for following standards, 660 if ($redirect && exists $hdr{location}) {
504 # try to support some common forms of broken Location headers. 661 # we ignore any errors, as it is very common to receive
505 if ($_[1]{location} !~ /^(?: $ | [^:\/?\#]+ : )/x) { 662 # Content-Length != 0 but no actual body
506 $_[1]{location} =~ s/^\.\/+//; 663 # we also access %hdr, as $_[1] might be an erro
507 664 http_request (
508 my $url = "$rscheme://$uhost:$uport"; 665 $method => $hdr{location},
509
510 unless ($_[1]{location} =~ s/^\///) {
511 $url .= $upath;
512 $url =~ s/\/[^\/]*$//;
513 } 666 %arg,
514 667 recurse => $recurse - 1,
515 $_[1]{location} = "$url/$_[1]{location}"; 668 Redirect => \@_,
516 } 669 $cb);
517
518 if ($_[1]{Status} =~ /^30[12]$/ && $recurse && $method ne "POST") {
519 # apparently, mozilla et al. just change POST to GET here
520 # more research is needed before we do the same
521 http_request ($method => $_[1]{location}, %arg, recurse => $recurse - 1, $cb);
522 } elsif ($_[1]{Status} == 303 && $recurse) {
523 # even http/1.1 is unclear on how to mutate the method
524 $method = "GET" unless $method eq "HEAD";
525 http_request ($method => $_[1]{location}, %arg, recurse => $recurse - 1, $cb);
526 } elsif ($_[1]{Status} == 307 && $recurse && $method =~ /^(?:GET|HEAD)$/) {
527 http_request ($method => $_[1]{location}, %arg, recurse => $recurse - 1, $cb);
528 } else { 670 } else {
529 $cb->($_[0], $_[1]); 671 $cb->($_[0], $_[1]);
530 } 672 }
531 }; 673 };
532 674
533 if ($hdr{Status} =~ /^(?:1..|204|304)$/ or $method eq "HEAD") { 675 my $len = $hdr{"content-length"};
676
677 if (!$redirect && $arg{on_header} && !$arg{on_header}(\%hdr)) {
678 $finish->(undef, { Status => 598, Reason => "Request cancelled by on_header", @pseudo });
679 } elsif (
680 $hdr{Status} =~ /^(?:1..|[23]04)$/
681 or $method eq "HEAD"
682 or (defined $len && !$len)
683 ) {
684 # no body
534 $finish->(undef, \%hdr); 685 $finish->("", \%hdr);
535 } else { 686 } else {
536 if (exists $hdr{"content-length"}) { 687 # body handling, four different code paths
537 $_[0]->unshift_read (chunk => $hdr{"content-length"}, sub { 688 # for want_body_handle, on_body (2x), normal (2x)
538 # could cache persistent connection now 689 # we might read too much here, but it does not matter yet (no pers. connections)
539 if ($hdr{connection} =~ /\bkeep-alive\b/i) { 690 if (!$redirect && $arg{want_body_handle}) {
540 # but we don't, due to misdesigns, this is annoyingly complex 691 $_[0]->on_eof (undef);
692 $_[0]->on_error (undef);
693 $_[0]->on_read (undef);
694
695 $finish->(delete $state{handle}, \%hdr);
696
697 } elsif ($arg{on_body}) {
698 $_[0]->on_error (sub { $finish->(undef, { Status => 599, Reason => $_[2], @pseudo }) });
699 if ($len) {
700 $_[0]->on_eof (undef);
701 $_[0]->on_read (sub {
702 $len -= length $_[0]{rbuf};
703
704 $arg{on_body}(delete $_[0]{rbuf}, \%hdr)
705 or $finish->(undef, { Status => 598, Reason => "Request cancelled by on_body", @pseudo });
706
707 $len > 0
708 or $finish->("", \%hdr);
541 }; 709 });
542 710 } else {
711 $_[0]->on_eof (sub {
543 $finish->($_[1], \%hdr); 712 $finish->("", \%hdr);
713 });
714 $_[0]->on_read (sub {
715 $arg{on_body}(delete $_[0]{rbuf}, \%hdr)
716 or $finish->(undef, { Status => 598, Reason => "Request cancelled by on_body", @pseudo });
717 });
544 }); 718 }
545 } else { 719 } else {
546 # too bad, need to read until we get an error or EOF,
547 # no way to detect winged data.
548 $_[0]->on_error (sub {
549 # delete ought to be more efficient, as we would have to make
550 # a copy otherwise as $_[0] gets destroyed.
551 $finish->(delete $_[0]{rbuf}, \%hdr);
552 });
553 $_[0]->on_eof (undef); 720 $_[0]->on_eof (undef);
721
722 if ($len) {
723 $_[0]->on_error (sub { $finish->(undef, { Status => 599, Reason => $_[2], @pseudo }) });
724 $_[0]->on_read (sub {
725 $finish->((substr delete $_[0]{rbuf}, 0, $len, ""), \%hdr)
726 if $len <= length $_[0]{rbuf};
727 });
728 } else {
729 $_[0]->on_error (sub {
730 ($! == Errno::EPIPE || !$!)
731 ? $finish->(delete $_[0]{rbuf}, \%hdr)
732 : $finish->(undef, { Status => 599, Reason => $_[2], @pseudo });
733 });
554 $_[0]->on_read (sub { }); 734 $_[0]->on_read (sub { });
735 }
555 } 736 }
556 } 737 }
557 }); 738 });
558 }); 739 };
559 };
560 740
561 # now handle proxy-CONNECT method 741 # now handle proxy-CONNECT method
562 if ($proxy && $uscheme eq "https") { 742 if ($proxy && $uscheme eq "https") {
563 # oh dear, we have to wrap it into a connect request 743 # oh dear, we have to wrap it into a connect request
564 744
565 # maybe re-use $uauthority with patched port? 745 # maybe re-use $uauthority with patched port?
566 $state{handle}->push_write ("CONNECT $uhost:$uport HTTP/1.0\015\012Host: $uhost\015\012\015\012"); 746 $state{handle}->push_write ("CONNECT $uhost:$uport HTTP/1.0\015\012Host: $uhost\015\012\015\012");
567 $state{handle}->push_read (line => $qr_nlnl, sub { 747 $state{handle}->push_read (line => $qr_nlnl, sub {
568 $_[1] =~ /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\015\012]*) )?/ix 748 $_[1] =~ /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\015\012]*) )?/ix
569 or return (%state = (), $cb->(undef, { Status => 599, Reason => "Invalid proxy connect response ($_[1])", URL => $url })); 749 or return (%state = (), $cb->(undef, { Status => 599, Reason => "Invalid proxy connect response ($_[1])", @pseudo }));
570 750
571 if ($2 == 200) { 751 if ($2 == 200) {
572 $rpath = $upath; 752 $rpath = $upath;
573 &$handle_actual_request; 753 &$handle_actual_request;
574 } else { 754 } else {
575 %state = (); 755 %state = ();
576 $cb->(undef, { Status => $2, Reason => $3, URL => $url }); 756 $cb->(undef, { Status => $2, Reason => $3, @pseudo });
757 }
577 } 758 });
578 });
579 } else { 759 } else {
580 &$handle_actual_request; 760 &$handle_actual_request;
761 }
762
581 } 763 },
582 764 $arg{on_prepare} || sub { $timeout }
583 }, sub {
584 $timeout
585 }; 765 );
586 }; 766 };
587 767
588 defined wantarray && AnyEvent::Util::guard { %state = () } 768 defined wantarray && AnyEvent::Util::guard { %state = () }
589} 769}
590 770
604 &http_request 784 &http_request
605} 785}
606 786
607=back 787=back
608 788
789=head2 DNS CACHING
790
791AnyEvent::HTTP uses the AnyEvent::Socket::tcp_connect function for
792the actual connection, which in turn uses AnyEvent::DNS to resolve
793hostnames. The latter is a simple stub resolver and does no caching
794on its own. If you want DNS caching, you currently have to provide
795your own default resolver (by storing a suitable resolver object in
796C<$AnyEvent::DNS::RESOLVER>).
797
609=head2 GLOBAL FUNCTIONS AND VARIABLES 798=head2 GLOBAL FUNCTIONS AND VARIABLES
610 799
611=over 4 800=over 4
612 801
613=item AnyEvent::HTTP::set_proxy "proxy-url" 802=item AnyEvent::HTTP::set_proxy "proxy-url"
614 803
615Sets the default proxy server to use. The proxy-url must begin with a 804Sets the default proxy server to use. The proxy-url must begin with a
616string of the form C<http://host:port> (optionally C<https:...>). 805string of the form C<http://host:port> (optionally C<https:...>), croaks
806otherwise.
807
808To clear an already-set proxy, use C<undef>.
617 809
618=item $AnyEvent::HTTP::MAX_RECURSE 810=item $AnyEvent::HTTP::MAX_RECURSE
619 811
620The default value for the C<recurse> request parameter (default: C<10>). 812The default value for the C<recurse> request parameter (default: C<10>).
621 813
622=item $AnyEvent::HTTP::USERAGENT 814=item $AnyEvent::HTTP::USERAGENT
623 815
624The default value for the C<User-Agent> header (the default is 816The default value for the C<User-Agent> header (the default is
625C<Mozilla/5.0 (compatible; U; AnyEvent-HTTP/$VERSION; +http://software.schmorp.de/pkg/AnyEvent)>). 817C<Mozilla/5.0 (compatible; U; AnyEvent-HTTP/$VERSION; +http://software.schmorp.de/pkg/AnyEvent)>).
626 818
627=item $AnyEvent::HTTP::MAX_PERSISTENT 819=item $AnyEvent::HTTP::MAX_PER_HOST
628 820
629The maximum number of persistent connections to keep open (default: 8). 821The maximum number of concurrent connections to the same host (identified
822by the hostname). If the limit is exceeded, then the additional requests
823are queued until previous connections are closed.
630 824
631Not implemented currently. 825The default value for this is C<4>, and it is highly advisable to not
632 826increase it.
633=item $AnyEvent::HTTP::PERSISTENT_TIMEOUT
634
635The maximum time to cache a persistent connection, in seconds (default: 2).
636
637Not implemented currently.
638 827
639=item $AnyEvent::HTTP::ACTIVE 828=item $AnyEvent::HTTP::ACTIVE
640 829
641The number of active connections. This is not the number of currently 830The number of active connections. This is not the number of currently
642running requests, but the number of currently open and non-idle TCP 831running requests, but the number of currently open and non-idle TCP
645=back 834=back
646 835
647=cut 836=cut
648 837
649sub set_proxy($) { 838sub set_proxy($) {
839 if (length $_[0]) {
650 $PROXY = [$2, $3 || 3128, $1] if $_[0] =~ m%^(https?):// ([^:/]+) (?: : (\d*) )?%ix; 840 $_[0] =~ m%^(https?):// ([^:/]+) (?: : (\d*) )?%ix
841 or Carp::croak "$_[0]: invalid proxy URL";
842 $PROXY = [$2, $3 || 3128, $1]
843 } else {
844 undef $PROXY;
845 }
651} 846}
652 847
653# initialise proxy from environment 848# initialise proxy from environment
849eval {
654set_proxy $ENV{http_proxy}; 850 set_proxy $ENV{http_proxy};
851};
655 852
656=head1 SEE ALSO 853=head1 SEE ALSO
657 854
658L<AnyEvent>. 855L<AnyEvent>.
659 856

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines