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.11 by root, Thu Jun 5 15:34:00 2008 UTC vs.
Revision 1.64 by root, Fri Dec 31 02:53:29 2010 UTC

3AnyEvent::HTTP - simple but non-blocking HTTP/HTTPS client 3AnyEvent::HTTP - simple but non-blocking HTTP/HTTPS client
4 4
5=head1 SYNOPSIS 5=head1 SYNOPSIS
6 6
7 use AnyEvent::HTTP; 7 use AnyEvent::HTTP;
8
9 http_get "http://www.nethype.de/", sub { print $_[1] };
10
11 # ... do something else here
8 12
9=head1 DESCRIPTION 13=head1 DESCRIPTION
10 14
11This module is an L<AnyEvent> user, you need to make sure that you use and 15This module is an L<AnyEvent> user, you need to make sure that you use and
12run a supported event loop. 16run a supported event loop.
35package AnyEvent::HTTP; 39package AnyEvent::HTTP;
36 40
37use strict; 41use strict;
38no warnings; 42no warnings;
39 43
40use Carp; 44use Errno ();
41 45
42use AnyEvent (); 46use AnyEvent 5.0 ();
43use AnyEvent::Util (); 47use AnyEvent::Util ();
44use AnyEvent::Socket ();
45use AnyEvent::Handle (); 48use AnyEvent::Handle ();
46 49
47use base Exporter::; 50use base Exporter::;
48 51
49our $VERSION = '1.0'; 52our $VERSION = '1.46';
50 53
51our @EXPORT = qw(http_get http_request); 54our @EXPORT = qw(http_get http_post http_head http_request);
52 55
53our $USERAGENT = "Mozilla/5.0 (compatible; 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)";
54our $MAX_RECURSE = 10; 57our $MAX_RECURSE = 10;
55our $MAX_PERSISTENT = 8; 58our $MAX_PERSISTENT = 8;
56our $PERSISTENT_TIMEOUT = 2; 59our $PERSISTENT_TIMEOUT = 2;
57our $TIMEOUT = 300; 60our $TIMEOUT = 300;
58 61
59# changing these is evil 62# changing these is evil
60our $MAX_PERSISTENT_PER_HOST = 2; 63our $MAX_PERSISTENT_PER_HOST = 0;
61our $MAX_PER_HOST = 4; 64our $MAX_PER_HOST = 4;
62 65
63our $PROXY; 66our $PROXY;
67our $ACTIVE = 0;
64 68
65my %KA_COUNT; # number of open keep-alive connections per host 69my %KA_COUNT; # number of open keep-alive connections per host
66my %CO_SLOT; # number of open connections, and wait queue, per host 70my %CO_SLOT; # number of open connections, and wait queue, per host
67 71
68=item http_get $url, key => value..., $cb->($data, $headers) 72=item http_get $url, key => value..., $cb->($data, $headers)
69 73
70Executes an HTTP-GET request. See the http_request function for details on 74Executes an HTTP-GET request. See the http_request function for details on
71additional parameters. 75additional parameters and the return value.
72 76
73=item http_head $url, key => value..., $cb->($data, $headers) 77=item http_head $url, key => value..., $cb->($data, $headers)
74 78
75Executes an HTTP-HEAD request. See the http_request function for details on 79Executes an HTTP-HEAD request. See the http_request function for details
76additional parameters. 80on additional parameters and the return value.
77 81
78=item http_post $url, $body, key => value..., $cb->($data, $headers) 82=item http_post $url, $body, key => value..., $cb->($data, $headers)
79 83
80Executes an HTTP-POST request with a request body of C<$bod>. See the 84Executes an HTTP-POST request with a request body of C<$body>. See the
81http_request function for details on additional parameters. 85http_request function for details on additional parameters and the return
86value.
82 87
83=item http_request $method => $url, key => value..., $cb->($data, $headers) 88=item http_request $method => $url, key => value..., $cb->($data, $headers)
84 89
85Executes a HTTP request of type C<$method> (e.g. C<GET>, C<POST>). The URL 90Executes a HTTP request of type C<$method> (e.g. C<GET>, C<POST>). The URL
86must be an absolute http or https URL. 91must be an absolute http or https URL.
87 92
93When called in void context, nothing is returned. In other contexts,
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
96destroyed before the callback is called, the request will be cancelled.
97
88The callback will be called with the response data as first argument 98The callback will be called with the response body data as first argument
89(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
90response headers as second argument. 100second argument.
91 101
92All 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
93headers, the three "pseudo-headers" C<HTTPVersion>, C<Status> and 103headers, the "pseudo-headers" (uppercase to avoid clashing with possible
94C<Reason> contain the three parts of the HTTP Status-Line of the same 104response headers) C<HTTPVersion>, C<Status> and C<Reason> contain the
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>.
109
110The pseudo-header C<URL> contains the actual URL (which can differ from
111the requested URL when following redirects - for example, you might get
112an error that your URL scheme is not supported even though your URL is a
113valid http URL because it redirected to an ftp URL, in which case you can
114look at the URL pseudo header).
115
116The pseudo-header C<Redirect> only exists when the request was a result
117of an internal redirect. In that case it is an array reference with
118the C<($data, $headers)> from the redirect response. Note that this
119response could in turn be the result of a redirect itself, and C<<
120$headers->{Redirect}[1]{Redirect} >> will then contain the original
121response, and so on.
122
95name. If the server sends a header multiple lines, then their contents 123If the server sends a header multiple times, then their contents will be
96will be joined together with C<\x00>. 124joined together with a comma (C<,>), as per the HTTP spec.
97 125
98If 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,
99then C<$data> will be C<undef>, C<< $headers->{Status} >> will be C<599> 127then C<$data> will be C<undef>, C<< $headers->{Status} >> will be C<59x>
100and the C<Reason> pseudo-header will contain an error message. 128(usually C<599>) and the C<Reason> pseudo-header will contain an error
129message.
101 130
102A typical callback might look like this: 131A typical callback might look like this:
103 132
104 sub { 133 sub {
105 my ($body, $hdr) = @_; 134 my ($body, $hdr) = @_;
121Whether to recurse requests or not, e.g. on redirects, authentication 150Whether to recurse requests or not, e.g. on redirects, authentication
122retries and so on, and how often to do so. 151retries and so on, and how often to do so.
123 152
124=item headers => hashref 153=item headers => hashref
125 154
126The request headers to use. 155The request headers to use. Currently, C<http_request> may provide its
156own C<Host:>, C<Content-Length:>, C<Connection:> and C<Cookie:> headers
157and will provide defaults for C<User-Agent:> and C<Referer:> (this can be
158suppressed by using C<undef> for these headers in which case they won't be
159sent at all).
127 160
128=item timeout => $seconds 161=item timeout => $seconds
129 162
130The 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
131the timeout, as will read or write activity. Default timeout is 5 minutes. 164the timeout, as will read or write activity, i.e. this is not an overall
165timeout.
166
167Default timeout is 5 minutes.
132 168
133=item proxy => [$host, $port[, $scheme]] or undef 169=item proxy => [$host, $port[, $scheme]] or undef
134 170
135Use the given http proxy for all requests. If not specified, then the 171Use the given http proxy for all requests. If not specified, then the
136default proxy (as specified by C<$ENV{http_proxy}>) is used. 172default proxy (as specified by C<$ENV{http_proxy}>) is used.
137 173
138C<$scheme> must be either missing or C<http> for HTTP, or C<https> for 174C<$scheme> must be either missing, C<http> for HTTP or C<https> for
139HTTPS. 175HTTPS.
140 176
141=item body => $string 177=item body => $string
142 178
143The 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
149based on the original netscape specification. 185based on the original netscape specification.
150 186
151The 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
152get updated automatically. It is possible to save the cookie_jar to 188get updated automatically. It is possible to save the cookie_jar to
153persistent storage with something like JSON or Storable, but this is not 189persistent storage with something like JSON or Storable, but this is not
154recommended, as expire times are currently being ignored. 190recommended, as expiry times are currently being ignored.
155 191
156Note that this cookie implementation is not of very high quality, nor 192Note that this cookie implementation is not of very high quality, nor
157meant to be complete. If you want complete cookie management you have to 193meant to be complete. If you want complete cookie management you have to
158do that on your own. C<cookie_jar> is meant as a quick fix to get some 194do that on your own. C<cookie_jar> is meant as a quick fix to get some
159cookie-using sites working. Cookies are a privacy disaster, do not use 195cookie-using sites working. Cookies are a privacy disaster, do not use
160them unless required to. 196them unless required to.
197
198=item tls_ctx => $scheme | $tls_ctx
199
200Specifies the AnyEvent::TLS context to be used for https connections. This
201parameter follows the same rules as the C<tls_ctx> parameter to
202L<AnyEvent::Handle>, but additionally, the two strings C<low> or
203C<high> can be specified, which give you a predefined low-security (no
204verification, highest compatibility) and high-security (CA and common-name
205verification) TLS context.
206
207The default for this option is C<low>, which could be interpreted as "give
208me the page, no matter what".
209
210=item on_prepare => $callback->($fh)
211
212In rare cases you need to "tune" the socket before it is used to
213connect (for exmaple, to bind it on a given IP address). This parameter
214overrides the prepare callback passed to C<AnyEvent::Socket::tcp_connect>
215and behaves exactly the same way (e.g. it has to provide a
216timeout). See the description for the C<$prepare_cb> argument of
217C<AnyEvent::Socket::tcp_connect> for details.
218
219=item tcp_connect => $callback->($host, $service, $connect_cb, $prepare_cb)
220
221In even rarer cases you want total control over how AnyEvent::HTTP
222establishes connections. Normally it uses L<AnyEvent::Socket::tcp_connect>
223to do this, but you can provide your own C<tcp_connect> function -
224obviously, it has to follow the same calling conventions, except that it
225may always return a connection guard object.
226
227There are probably lots of weird uses for this function, starting from
228tracing the hosts C<http_request> actually tries to connect, to (inexact
229but fast) host => IP address caching or even socks protocol support.
230
231=item on_header => $callback->($headers)
232
233When specified, this callback will be called with the header hash as soon
234as headers have been successfully received from the remote server (not on
235locally-generated errors).
236
237It has to return either true (in which case AnyEvent::HTTP will continue),
238or false, in which case AnyEvent::HTTP will cancel the download (and call
239the finish callback with an error code of C<598>).
240
241This callback is useful, among other things, to quickly reject unwanted
242content, which, if it is supposed to be rare, can be faster than first
243doing a C<HEAD> request.
244
245Example: cancel the request unless the content-type is "text/html".
246
247 on_header => sub {
248 $_[0]{"content-type"} =~ /^text\/html\s*(?:;|$)/
249 },
250
251=item on_body => $callback->($partial_body, $headers)
252
253When specified, all body data will be passed to this callback instead of
254to the completion callback. The completion callback will get the empty
255string instead of the body data.
256
257It has to return either true (in which case AnyEvent::HTTP will continue),
258or false, in which case AnyEvent::HTTP will cancel the download (and call
259the completion callback with an error code of C<598>).
260
261This callback is useful when the data is too large to be held in memory
262(so the callback writes it to a file) or when only some information should
263be extracted, or when the body should be processed incrementally.
264
265It is usually preferred over doing your own body handling via
266C<want_body_handle>, but in case of streaming APIs, where HTTP is
267only used to create a connection, C<want_body_handle> is the better
268alternative, as it allows you to install your own event handler, reducing
269resource usage.
270
271=item want_body_handle => $enable
272
273When enabled (default is disabled), the behaviour of AnyEvent::HTTP
274changes considerably: after parsing the headers, and instead of
275downloading the body (if any), the completion callback will be
276called. Instead of the C<$body> argument containing the body data, the
277callback will receive the L<AnyEvent::Handle> object associated with the
278connection. In error cases, C<undef> will be passed. When there is no body
279(e.g. status C<304>), the empty string will be passed.
280
281The handle object might or might not be in TLS mode, might be connected to
282a proxy, be a persistent connection etc., and configured in unspecified
283ways. The user is responsible for this handle (it will not be used by this
284module anymore).
285
286This is useful with some push-type services, where, after the initial
287headers, an interactive protocol is used (typical example would be the
288push-style twitter API which starts a JSON/XML stream).
289
290If you think you need this, first have a look at C<on_body>, to see if
291that doesn't solve your problem in a better way.
161 292
162=back 293=back
163 294
164Example: make a simple HTTP GET request for http://www.nethype.de/ 295Example: make a simple HTTP GET request for http://www.nethype.de/
165 296
179 use Data::Dumper; 310 use Data::Dumper;
180 print Dumper $hdr; 311 print Dumper $hdr;
181 } 312 }
182 ; 313 ;
183 314
315Example: make another simple HTTP GET request, but immediately try to
316cancel it.
317
318 my $request = http_request GET => "http://www.nethype.de/", sub {
319 my ($body, $hdr) = @_;
320 print "$body\n";
321 };
322
323 undef $request;
324
184=cut 325=cut
185 326
327sub _slot_schedule;
186sub _slot_schedule($) { 328sub _slot_schedule($) {
187 my $host = shift; 329 my $host = shift;
188 330
189 while ($CO_SLOT{$host}[0] < $MAX_PER_HOST) { 331 while ($CO_SLOT{$host}[0] < $MAX_PER_HOST) {
190 if (my $cb = shift @{ $CO_SLOT{$host}[1] }) { 332 if (my $cb = shift @{ $CO_SLOT{$host}[1] }) {
191 # somebody wnats that slot 333 # somebody wants that slot
192 ++$CO_SLOT{$host}[0]; 334 ++$CO_SLOT{$host}[0];
335 ++$ACTIVE;
193 336
194 $cb->(AnyEvent::Util::guard { 337 $cb->(AnyEvent::Util::guard {
338 --$ACTIVE;
195 --$CO_SLOT{$host}[0]; 339 --$CO_SLOT{$host}[0];
196 _slot_schedule $host; 340 _slot_schedule $host;
197 }); 341 });
198 } else { 342 } else {
199 # nobody wants the slot, maybe we can forget about it 343 # nobody wants the slot, maybe we can forget about it
200 delete $CO_SLOT{$host} unless $CO_SLOT{$host}[0]; 344 delete $CO_SLOT{$host} unless $CO_SLOT{$host}[0];
201 warn "$host deleted" unless $CO_SLOT{$host}[0];#d#
202 last; 345 last;
203 } 346 }
204 } 347 }
205} 348}
206 349
209 push @{ $CO_SLOT{$_[0]}[1] }, $_[1]; 352 push @{ $CO_SLOT{$_[0]}[1] }, $_[1];
210 353
211 _slot_schedule $_[0]; 354 _slot_schedule $_[0];
212} 355}
213 356
357our $qr_nlnl = qr{(?<![^\012])\015?\012};
358
359our $TLS_CTX_LOW = { cache => 1, sslv2 => 1 };
360our $TLS_CTX_HIGH = { cache => 1, verify => 1, verify_peername => "https" };
361
214sub http_request($$$;@) { 362sub http_request($$@) {
215 my $cb = pop; 363 my $cb = pop;
216 my ($method, $url, %arg) = @_; 364 my ($method, $url, %arg) = @_;
217 365
218 my %hdr; 366 my %hdr;
367
368 $arg{tls_ctx} = $TLS_CTX_LOW if $arg{tls_ctx} eq "low" || !exists $arg{tls_ctx};
369 $arg{tls_ctx} = $TLS_CTX_HIGH if $arg{tls_ctx} eq "high";
219 370
220 $method = uc $method; 371 $method = uc $method;
221 372
222 if (my $hdr = $arg{headers}) { 373 if (my $hdr = $arg{headers}) {
223 while (my ($k, $v) = each %$hdr) { 374 while (my ($k, $v) = each %$hdr) {
224 $hdr{lc $k} = $v; 375 $hdr{lc $k} = $v;
225 } 376 }
226 } 377 }
227 378
379 # pseudo headers for all subsequent responses
380 my @pseudo = (URL => $url);
381 push @pseudo, Redirect => delete $arg{Redirect} if exists $arg{Redirect};
382
228 my $recurse = exists $arg{recurse} ? $arg{recurse} : $MAX_RECURSE; 383 my $recurse = exists $arg{recurse} ? delete $arg{recurse} : $MAX_RECURSE;
229 384
230 return $cb->(undef, { Status => 599, Reason => "recursion limit reached" }) 385 return $cb->(undef, { @pseudo, Status => 599, Reason => "Too many redirections" })
231 if $recurse < 0; 386 if $recurse < 0;
232 387
233 my $proxy = $arg{proxy} || $PROXY; 388 my $proxy = $arg{proxy} || $PROXY;
234 my $timeout = $arg{timeout} || $TIMEOUT; 389 my $timeout = $arg{timeout} || $TIMEOUT;
235 390
236 $hdr{"user-agent"} ||= $USERAGENT;
237
238 my ($scheme, $authority, $upath, $query, $fragment) = 391 my ($uscheme, $uauthority, $upath, $query, $fragment) =
239 $url =~ m|(?:([^:/?#]+):)?(?://([^/?#]*))?([^?#]*)(?:\?([^#]*))?(?:#(.*))?|; 392 $url =~ m|(?:([^:/?#]+):)?(?://([^/?#]*))?([^?#]*)(?:(\?[^#]*))?(?:#(.*))?|;
240 393
241 $scheme = lc $scheme; 394 $uscheme = lc $uscheme;
242 395
243 my $uport = $scheme eq "http" ? 80 396 my $uport = $uscheme eq "http" ? 80
244 : $scheme eq "https" ? 443 397 : $uscheme eq "https" ? 443
245 : return $cb->(undef, { Status => 599, Reason => "only http and https URL schemes supported" }); 398 : return $cb->(undef, { @pseudo, Status => 599, Reason => "Only http and https URL schemes supported" });
246 399
247 $authority =~ /^(?: .*\@ )? ([^\@:]+) (?: : (\d+) )?$/x 400 $uauthority =~ /^(?: .*\@ )? ([^\@:]+) (?: : (\d+) )?$/x
248 or return $cb->(undef, { Status => 599, Reason => "unparsable URL" }); 401 or return $cb->(undef, { @pseudo, Status => 599, Reason => "Unparsable URL" });
249 402
250 my $uhost = $1; 403 my $uhost = $1;
251 $uport = $2 if defined $2; 404 $uport = $2 if defined $2;
252 405
406 $hdr{host} = defined $2 ? "$uhost:$2" : "$uhost"
407 unless exists $hdr{host};
408
253 $uhost =~ s/^\[(.*)\]$/$1/; 409 $uhost =~ s/^\[(.*)\]$/$1/;
254 $upath .= "?$query" if length $query; 410 $upath .= $query if length $query;
255 411
256 $upath =~ s%^/?%/%; 412 $upath =~ s%^/?%/%;
257 413
258 # cookie processing 414 # cookie processing
259 if (my $jar = $arg{cookie_jar}) { 415 if (my $jar = $arg{cookie_jar}) {
260 %$jar = () if $jar->{version} < 1; 416 %$jar = () if $jar->{version} != 1;
261 417
262 my @cookie; 418 my @cookie;
263 419
264 while (my ($chost, $v) = each %$jar) { 420 while (my ($chost, $v) = each %$jar) {
421 if ($chost =~ /^\./) {
265 next unless $chost eq substr $uhost, -length $chost; 422 next unless $chost eq substr $uhost, -length $chost;
266 next unless $chost =~ /^\./; 423 } elsif ($chost =~ /\./) {
424 next unless $chost eq $uhost;
425 } else {
426 next;
427 }
267 428
268 while (my ($cpath, $v) = each %$v) { 429 while (my ($cpath, $v) = each %$v) {
269 next unless $cpath eq substr $upath, 0, length $cpath; 430 next unless $cpath eq substr $upath, 0, length $cpath;
270 431
271 while (my ($k, $v) = each %$v) { 432 while (my ($k, $v) = each %$v) {
272 next if $scheme ne "https" && exists $v->{secure}; 433 next if $uscheme ne "https" && exists $v->{secure};
434 my $value = $v->{value};
435 $value =~ s/([\\"])/\\$1/g;
273 push @cookie, "$k=$v->{value}"; 436 push @cookie, "$k=\"$value\"";
274 } 437 }
275 } 438 }
276 } 439 }
277 440
278 $hdr{cookie} = join "; ", @cookie 441 $hdr{cookie} = join "; ", @cookie
279 if @cookie; 442 if @cookie;
280 } 443 }
281 444
282 my ($rhost, $rport, $rpath); # request host, port, path 445 my ($rhost, $rport, $rscheme, $rpath); # request host, port, path
283 446
284 if ($proxy) { 447 if ($proxy) {
285 ($rhost, $rport, $scheme) = @$proxy; 448 ($rpath, $rhost, $rport, $rscheme) = ($url, @$proxy);
286 $rpath = $url; 449
450 $rscheme = "http" unless defined $rscheme;
451
452 # don't support https requests over https-proxy transport,
453 # can't be done with tls as spec'ed, unless you double-encrypt.
454 $rscheme = "http" if $uscheme eq "https" && $rscheme eq "https";
287 } else { 455 } else {
288 ($rhost, $rport, $rpath) = ($uhost, $uport, $upath); 456 ($rhost, $rport, $rscheme, $rpath) = ($uhost, $uport, $uscheme, $upath);
289 $hdr{host} = $uhost;
290 } 457 }
291 458
459 # leave out fragment and query string, just a heuristic
460 $hdr{referer} ||= "$uscheme://$uauthority$upath" unless exists $hdr{referer};
461 $hdr{"user-agent"} ||= $USERAGENT unless exists $hdr{"user-agent"};
462
292 $hdr{"content-length"} = length $arg{body}; 463 $hdr{"content-length"} = length $arg{body}
464 if length $arg{body} || $method ne "GET";
293 465
294 my %state = (connect_guard => 1); 466 my %state = (connect_guard => 1);
295 467
296 _get_slot $uhost, sub { 468 _get_slot $uhost, sub {
297 $state{slot_guard} = shift; 469 $state{slot_guard} = shift;
298 470
299 return unless $state{connect_guard}; 471 return unless $state{connect_guard};
300 472
301 $state{connect_guard} = AnyEvent::Socket::tcp_connect $rhost, $rport, sub { 473 my $connect_cb = sub {
302 $state{fh} = shift 474 $state{fh} = shift
475 or do {
476 my $err = "$!";
477 %state = ();
303 or return $cb->(undef, { Status => 599, Reason => "$!" }); 478 return $cb->(undef, { @pseudo, Status => 599, Reason => $err });
479 };
304 480
305 delete $state{connect_guard}; # reduce memory usage, save a tree 481 pop; # free memory, save a tree
482
483 return unless delete $state{connect_guard};
306 484
307 # get handle 485 # get handle
308 $state{handle} = new AnyEvent::Handle 486 $state{handle} = new AnyEvent::Handle
309 fh => $state{fh}, 487 fh => $state{fh},
310 ($scheme eq "https" ? (tls => "connect") : ()); 488 peername => $rhost,
489 tls_ctx => $arg{tls_ctx},
490 # these need to be reconfigured on keepalive handles
491 timeout => $timeout,
492 on_error => sub {
493 %state = ();
494 $cb->(undef, { @pseudo, Status => 599, Reason => $_[2] });
495 },
496 on_eof => sub {
497 %state = ();
498 $cb->(undef, { @pseudo, Status => 599, Reason => "Unexpected end-of-file" });
499 },
500 ;
311 501
312 # limit the number of persistent connections 502 # limit the number of persistent connections
503 # keepalive not yet supported
313 if ($KA_COUNT{$_[1]} < $MAX_PERSISTENT_PER_HOST) { 504# if ($KA_COUNT{$_[1]} < $MAX_PERSISTENT_PER_HOST) {
314 ++$KA_COUNT{$_[1]}; 505# ++$KA_COUNT{$_[1]};
315 $state{handle}{ka_count_guard} = AnyEvent::Util::guard { --$KA_COUNT{$_[1]} }; 506# $state{handle}{ka_count_guard} = AnyEvent::Util::guard {
507# --$KA_COUNT{$_[1]}
508# };
316 $hdr{connection} = "keep-alive"; 509# $hdr{connection} = "keep-alive";
317 delete $hdr{connection}; # keep-alive not yet supported
318 } else { 510# } else {
319 delete $hdr{connection}; 511 delete $hdr{connection};
320 } 512# }
321 513
322 # (re-)configure handle 514 $state{handle}->starttls ("connect") if $rscheme eq "https";
323 $state{handle}->timeout ($timeout);
324 $state{handle}->on_error (sub {
325 %state = ();
326 $cb->(undef, { Status => 599, Reason => "$!" });
327 });
328 $state{handle}->on_eof (sub {
329 %state = ();
330 $cb->(undef, { Status => 599, Reason => "unexpected end-of-file" });
331 });
332 515
516 # handle actual, non-tunneled, request
517 my $handle_actual_request = sub {
518 $state{handle}->starttls ("connect") if $uscheme eq "https" && !exists $state{handle}{tls};
519
333 # send request 520 # send request
334 $state{handle}->push_write ( 521 $state{handle}->push_write (
335 "$method $rpath HTTP/1.0\015\012" 522 "$method $rpath HTTP/1.0\015\012"
336 . (join "", map "$_: $hdr{$_}\015\012", keys %hdr) 523 . (join "", map "\u$_: $hdr{$_}\015\012", grep defined $hdr{$_}, keys %hdr)
337 . "\015\012" 524 . "\015\012"
338 . (delete $arg{body}) 525 . (delete $arg{body})
339 );
340
341 %hdr = (); # reduce memory usage, save a kitten
342
343 # status line
344 $state{handle}->push_read (line => qr/\015?\012/, sub {
345 $_[1] =~ /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) \s+ ([^\015\012]+)/ix
346 or return (%state = (), $cb->(undef, { Status => 599, Reason => "invalid server response ($_[1])" }));
347
348 my %hdr = ( # response headers
349 HTTPVersion => "\x00$1",
350 Status => "\x00$2",
351 Reason => "\x00$3",
352 ); 526 );
353 527
354 # headers, could be optimized a bit 528 # return if error occured during push_write()
529 return unless %state;
530
531 %hdr = (); # reduce memory usage, save a kitten, also make it possible to re-use
532
533 # status line and headers
355 $state{handle}->unshift_read (line => qr/\015?\012\015?\012/, sub { 534 $state{handle}->push_read (line => $qr_nlnl, sub {
535 my $keepalive = pop;
536
356 for ("$_[1]\012") { 537 for ("$_[1]") {
357 # we support spaces in field names, as lotus domino 538 y/\015//d; # weed out any \015, as they show up in the weirdest of places.
358 # creates them. 539
540 /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\015\012]*) )? \015?\012/igxc
541 or return (%state = (), $cb->(undef, { @pseudo, Status => 599, Reason => "Invalid server response" }));
542
543 push @pseudo,
544 HTTPVersion => $1,
545 Status => $2,
546 Reason => $3,
547 ;
548
549 # things seen, not parsed:
550 # p3pP="NON CUR OTPi OUR NOR UNI"
551
359 $hdr{lc $1} .= "\x00$2" 552 $hdr{lc $1} .= ",$2"
360 while /\G 553 while /\G
361 ([^:\000-\037]+): 554 ([^:\000-\037]*):
362 [\011\040]* 555 [\011\040]*
363 ((?: [^\015\012]+ | \015?\012[\011\040] )*) 556 ((?: [^\012]+ | \012[\011\040] )*)
364 \015?\012 557 \012
365 /gxc; 558 /gxc;
366 559
367 /\G$/ 560 /\G$/
368 or return (%state = (), $cb->(undef, { Status => 599, Reason => "garbled response headers" })); 561 or return (%state = (), $cb->(undef, { @pseudo, Status => 599, Reason => "Garbled response headers" }));
369 } 562 }
370 563
564 # remove the "," prefix we added to all headers above
371 substr $_, 0, 1, "" 565 substr $_, 0, 1, ""
372 for values %hdr; 566 for values %hdr;
373 567
374 my $finish = sub { 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
606 my $finish = sub { # ($data, $err_status, $err_reason[, $keepalive])
607 $state{handle}->destroy if $state{handle};
375 %state = (); 608 %state = ();
376 609
610 if (defined $_[1]) {
611 $hdr{OrigStatus} = $hdr{Status}; $hdr{Status} = $_[1];
612 $hdr{OrigReason} = $hdr{Reason}; $hdr{Reason} = $_[2];
613 }
614
377 # set-cookie processing 615 # set-cookie processing
378 if ($arg{cookie_jar} && exists $hdr{"set-cookie"}) { 616 if ($arg{cookie_jar}) {
379 for (split /\x00/, $hdr{"set-cookie"}) { 617 for ($hdr{"set-cookie"}) {
380 my ($cookie, @arg) = split /;\s*/; 618 # parse NAME=VALUE
381 my ($name, $value) = split /=/, $cookie, 2; 619 my @kv;
382 my %kv = (value => $value, map { split /=/, $_, 2 } @arg); 620
621 while (/\G\s* ([^=;,[:space:]]+) \s*=\s* (?: "((?:[^\\"]+|\\.)*)" | ([^=;,[:space:]]*) )/gcxs) {
622 my $name = $1;
623 my $value = $3;
624
625 unless ($value) {
626 $value = $2;
627 $value =~ s/\\(.)/$1/gs;
628 }
629
630 push @kv, $name => $value;
631
632 last unless /\G\s*;/gc;
633 }
634
635 last unless @kv;
636
637 my $name = shift @kv;
638 my %kv = (value => shift @kv, @kv);
639
640 my $cdom;
641 my $cpath = (delete $kv{path}) || "/";
642
643 if (exists $kv{domain}) {
644 $cdom = delete $kv{domain};
383 645
384 my $cdom = (delete $kv{domain}) || $uhost;
385 my $cpath = (delete $kv{path}) || "/";
386
387 $cdom =~ s/^.?/./; # make sure it starts with a "." 646 $cdom =~ s/^\.?/./; # make sure it starts with a "."
388 647
389 next if $cdom =~ /\.$/; 648 next if $cdom =~ /\.$/;
390 649
391 # this is not rfc-like and not netscape-like. go figure. 650 # this is not rfc-like and not netscape-like. go figure.
392 my $ndots = $cdom =~ y/.//; 651 my $ndots = $cdom =~ y/.//;
393 next if $ndots < ($cdom =~ /\.[^.][^.]\.[^.][^.]$/ ? 3 : 2); 652 next if $ndots < ($cdom =~ /\.[^.][^.]\.[^.][^.]$/ ? 3 : 2);
653 } else {
654 $cdom = $uhost;
655 }
394 656
395 # store it 657 # store it
396 $arg{cookie_jar}{version} = 1; 658 $arg{cookie_jar}{version} = 1;
397 $arg{cookie_jar}{$cdom}{$cpath}{$name} = \%kv; 659 $arg{cookie_jar}{$cdom}{$cpath}{$name} = \%kv;
660
661 redo if /\G\s*,/gc;
398 } 662 }
399 } 663 }
400 664
401 if ($_[1]{Status} =~ /^x30[12]$/ && $recurse) { 665 if ($redirect && exists $hdr{location}) {
402 # microsoft and other assholes don't give a shit for following standards, 666 # we ignore any errors, as it is very common to receive
403 # try to support a common form of broken Location header. 667 # Content-Length != 0 but no actual body
404 $_[1]{location} =~ s%^/%$scheme://$uhost:$uport/%; 668 # we also access %hdr, as $_[1] might be an erro
405 669 http_request (
406 http_request ($method, $_[1]{location}, %arg, recurse => $recurse - 1, $cb); 670 $method => $hdr{location},
671 %arg,
672 recurse => $recurse - 1,
673 Redirect => [$_[0], \%hdr],
674 $cb);
407 } else { 675 } else {
408 $cb->($_[0], $_[1]); 676 $cb->($_[0], \%hdr);
409 } 677 }
410 }; 678 };
411 679
412 if ($hdr{Status} =~ /^(?:1..|204|304)$/ or $method eq "HEAD") { 680 my $len = $hdr{"content-length"};
681
682 if (!$redirect && $arg{on_header} && !$arg{on_header}(\%hdr)) {
683 $finish->(undef, 598 => "Request cancelled by on_header");
684 } elsif (
685 $hdr{Status} =~ /^(?:1..|204|205|304)$/
686 or $method eq "HEAD"
687 or (defined $len && !$len)
688 ) {
689 # no body
413 $finish->(undef, \%hdr); 690 $finish->("", undef, undef, 1);
414 } else { 691 } else {
415 if (exists $hdr{"content-length"}) { 692 # body handling, four different code paths
416 $_[0]->unshift_read (chunk => $hdr{"content-length"}, sub { 693 # for want_body_handle, on_body (2x), normal (2x)
417 # could cache persistent connection now 694 # we might read too much here, but it does not matter yet (no pipelining)
418 if ($hdr{connection} =~ /\bkeep-alive\b/i) { 695 if (!$redirect && $arg{want_body_handle}) {
419 # but we don't, due to misdesigns, this is annoyingly complex 696 $_[0]->on_eof (undef);
697 $_[0]->on_error (undef);
698 $_[0]->on_read (undef);
699
700 $finish->(delete $state{handle});
701
702 } elsif ($arg{on_body}) {
703 $_[0]->on_error (sub { $finish->(undef, 599 => $_[2]) });
704 if ($len) {
705 $_[0]->on_read (sub {
706 $len -= length $_[0]{rbuf};
707
708 $arg{on_body}(delete $_[0]{rbuf}, \%hdr)
709 or $finish->(undef, 598 => "Request cancelled by on_body");
710
711 $len > 0
712 or $finish->("", undef, undef, 1);
420 }; 713 });
421 714 } else {
715 $_[0]->on_eof (sub {
422 $finish->($_[1], \%hdr); 716 $finish->("");
717 });
718 $_[0]->on_read (sub {
719 $arg{on_body}(delete $_[0]{rbuf}, \%hdr)
720 or $finish->(undef, 598 => "Request cancelled by on_body");
721 });
423 }); 722 }
424 } else { 723 } else {
425 # too bad, need to read until we get an error or EOF,
426 # no way to detect winged data.
427 $_[0]->on_error (sub {
428 $finish->($_[0]{rbuf}, \%hdr);
429 });
430 $_[0]->on_eof (undef); 724 $_[0]->on_eof (undef);
725
726 if ($len) {
727 $_[0]->on_error (sub { $finish->(undef, 599 => $_[2]) });
728 $_[0]->on_read (sub {
729 $finish->((substr delete $_[0]{rbuf}, 0, $len, ""), undef, undef, 1)
730 if $len <= length $_[0]{rbuf};
731 });
732 } else {
733 $_[0]->on_error (sub {
734 ($! == Errno::EPIPE || !$!)
735 ? $finish->(delete $_[0]{rbuf})
736 : $finish->(undef, 599 => $_[2]);
737 });
431 $_[0]->on_read (sub { }); 738 $_[0]->on_read (sub { });
739 }
432 } 740 }
433 } 741 }
434 }); 742 });
435 }); 743 };
436 }, sub { 744
437 $timeout 745 # now handle proxy-CONNECT method
746 if ($proxy && $uscheme eq "https") {
747 # oh dear, we have to wrap it into a connect request
748
749 # maybe re-use $uauthority with patched port?
750 $state{handle}->push_write ("CONNECT $uhost:$uport HTTP/1.0\015\012Host: $uhost\015\012\015\012");
751 $state{handle}->push_read (line => $qr_nlnl, sub {
752 $_[1] =~ /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\015\012]*) )?/ix
753 or return (%state = (), $cb->(undef, { @pseudo, Status => 599, Reason => "Invalid proxy connect response ($_[1])" }));
754
755 if ($2 == 200) {
756 $rpath = $upath;
757 &$handle_actual_request;
758 } else {
759 %state = ();
760 $cb->(undef, { @pseudo, Status => $2, Reason => $3 });
761 }
762 });
763 } else {
764 &$handle_actual_request;
765 }
438 }; 766 };
767
768 my $tcp_connect = $arg{tcp_connect}
769 || do { require AnyEvent::Socket; \&AnyEvent::Socket::tcp_connect };
770
771 $state{connect_guard} = $tcp_connect->($rhost, $rport, $connect_cb, $arg{on_prepare} || sub { $timeout });
772
439 }; 773 };
440 774
441 defined wantarray && AnyEvent::Util::guard { %state = () } 775 defined wantarray && AnyEvent::Util::guard { %state = () }
442} 776}
443 777
444sub http_get($$;@) { 778sub http_get($@) {
445 unshift @_, "GET"; 779 unshift @_, "GET";
446 &http_request 780 &http_request
447} 781}
448 782
449sub http_head($$;@) { 783sub http_head($@) {
450 unshift @_, "HEAD"; 784 unshift @_, "HEAD";
451 &http_request 785 &http_request
452} 786}
453 787
454sub http_post($$$;@) { 788sub http_post($$@) {
789 my $url = shift;
455 unshift @_, "POST", "body"; 790 unshift @_, "POST", $url, "body";
456 &http_request 791 &http_request
457} 792}
458 793
459=back 794=back
460 795
796=head2 DNS CACHING
797
798AnyEvent::HTTP uses the AnyEvent::Socket::tcp_connect function for
799the actual connection, which in turn uses AnyEvent::DNS to resolve
800hostnames. The latter is a simple stub resolver and does no caching
801on its own. If you want DNS caching, you currently have to provide
802your own default resolver (by storing a suitable resolver object in
803C<$AnyEvent::DNS::RESOLVER>).
804
461=head2 GLOBAL FUNCTIONS AND VARIABLES 805=head2 GLOBAL FUNCTIONS AND VARIABLES
462 806
463=over 4 807=over 4
464 808
465=item AnyEvent::HTTP::set_proxy "proxy-url" 809=item AnyEvent::HTTP::set_proxy "proxy-url"
466 810
467Sets the default proxy server to use. The proxy-url must begin with a 811Sets the default proxy server to use. The proxy-url must begin with a
468string of the form C<http://host:port> (optionally C<https:...>). 812string of the form C<http://host:port> (optionally C<https:...>), croaks
813otherwise.
814
815To clear an already-set proxy, use C<undef>.
816
817=item $date = AnyEvent::HTTP::format_date $timestamp
818
819Takes a POSIX timestamp (seconds since the epoch) and formats it as a HTTP
820Date (RFC 2616).
821
822=item $timestamp = AnyEvent::HTTP::parse_date $date
823
824Takes a HTTP Date (RFC 2616) and returns the corresponding POSIX
825timestamp, or C<undef> if the date cannot be parsed.
469 826
470=item $AnyEvent::HTTP::MAX_RECURSE 827=item $AnyEvent::HTTP::MAX_RECURSE
471 828
472The default value for the C<recurse> request parameter (default: C<10>). 829The default value for the C<recurse> request parameter (default: C<10>).
473 830
474=item $AnyEvent::HTTP::USERAGENT 831=item $AnyEvent::HTTP::USERAGENT
475 832
476The default value for the C<User-Agent> header (the default is 833The default value for the C<User-Agent> header (the default is
477C<Mozilla/5.0 (compatible; AnyEvent::HTTP/$VERSION; +http://software.schmorp.de/pkg/AnyEvent)>). 834C<Mozilla/5.0 (compatible; U; AnyEvent-HTTP/$VERSION; +http://software.schmorp.de/pkg/AnyEvent)>).
478 835
479=item $AnyEvent::HTTP::MAX_PERSISTENT 836=item $AnyEvent::HTTP::MAX_PER_HOST
480 837
481The maximum number of persistent connections to keep open (default: 8). 838The maximum number of concurrent connections to the same host (identified
839by the hostname). If the limit is exceeded, then the additional requests
840are queued until previous connections are closed.
482 841
483Not implemented currently. 842The default value for this is C<4>, and it is highly advisable to not
843increase it.
484 844
485=item $AnyEvent::HTTP::PERSISTENT_TIMEOUT 845=item $AnyEvent::HTTP::ACTIVE
486 846
487The maximum time to cache a persistent connection, in seconds (default: 2). 847The number of active connections. This is not the number of currently
488 848running requests, but the number of currently open and non-idle TCP
489Not implemented currently. 849connections. This number of can be useful for load-leveling.
490 850
491=back 851=back
492 852
493=cut 853=cut
494 854
855our @month = qw(Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec);
856our @weekday = qw(Sun Mon Tue Wed Thu Fri Sat);
857
858sub format_date($) {
859 my ($time) = @_;
860
861 # RFC 822/1123 format
862 my ($S, $M, $H, $mday, $mon, $year, $wday, $yday, undef) = gmtime $time;
863
864 sprintf "%s, %02d %s %04d %02d:%02d:%02d GMT",
865 $weekday[$wday], $mday, $month[$mon], $year + 1900,
866 $H, $M, $S;
867}
868
869sub parse_date($) {
870 my ($date) = @_;
871
872 my ($d, $m, $y, $H, $M, $S);
873
874 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$/) {
875 # RFC 822/1123, required by RFC 2616
876 ($d, $m, $y, $H, $M, $S) = ($1, $2, $3, $4, $5, $6);
877
878 } 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$/) {
879 # RFC 850
880 ($d, $m, $y, $H, $M, $S) = ($1, $2, $3 < 69 ? $3 + 2000 : $3 + 1900, $4, $5, $6);
881
882 } 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])$/) {
883 # ISO C's asctime
884 ($d, $m, $y, $H, $M, $S) = ($2, $1, $6, $3, $4, $5);
885 }
886 # other formats fail in the loop below
887
888 for (0..11) {
889 if ($m eq $month[$_]) {
890 require Time::Local;
891 return Time::Local::timegm ($S, $M, $H, $d, $_, $y);
892 }
893 }
894
895 undef
896}
897
495sub set_proxy($) { 898sub set_proxy($) {
899 if (length $_[0]) {
496 $PROXY = [$2, $3 || 3128, $1] if $_[0] =~ m%^(https?):// ([^:/]+) (?: : (\d*) )?%ix; 900 $_[0] =~ m%^(https?):// ([^:/]+) (?: : (\d*) )?%ix
901 or Carp::croak "$_[0]: invalid proxy URL";
902 $PROXY = [$2, $3 || 3128, $1]
903 } else {
904 undef $PROXY;
905 }
497} 906}
498 907
499# initialise proxy from environment 908# initialise proxy from environment
909eval {
500set_proxy $ENV{http_proxy}; 910 set_proxy $ENV{http_proxy};
911};
912
913=head2 SOCKS PROXIES
914
915Socks proxies are not directly supported by AnyEvent::HTTP. You can
916compile your perl to support socks, or use an external program such as
917F<socksify> (dante) or F<tsocks> to make your program use a socks proxy
918transparently.
919
920Alternatively, for AnyEvent::HTTP only, you can use your own
921C<tcp_connect> function that does the proxy handshake - here is an example
922that works with socks4a proxies:
923
924 use Errno;
925 use AnyEvent::Util;
926 use AnyEvent::Socket;
927 use AnyEvent::Handle;
928
929 # host, port and username of/for your socks4a proxy
930 my $socks_host = "10.0.0.23";
931 my $socks_port = 9050;
932 my $socks_user = "";
933
934 sub socks4a_connect {
935 my ($host, $port, $connect_cb, $prepare_cb) = @_;
936
937 my $hdl = new AnyEvent::Handle
938 connect => [$socks_host, $socks_port],
939 on_prepare => sub { $prepare_cb->($_[0]{fh}) },
940 on_error => sub { $connect_cb->() },
941 ;
942
943 $hdl->push_write (pack "CCnNZ*Z*", 4, 1, $port, 1, $socks_user, $host);
944
945 $hdl->push_read (chunk => 8, sub {
946 my ($hdl, $chunk) = @_;
947 my ($status, $port, $ipn) = unpack "xCna4", $chunk;
948
949 if ($status == 0x5a) {
950 $connect_cb->($hdl->{fh}, (format_address $ipn) . ":$port");
951 } else {
952 $! = Errno::ENXIO; $connect_cb->();
953 }
954 });
955
956 $hdl
957 }
958
959Use C<socks4a_connect> instead of C<tcp_connect> when doing C<http_request>s,
960possibly after switching off other proxy types:
961
962 AnyEvent::HTTP::set_proxy undef; # usually you do not want other proxies
963
964 http_get 'http://www.google.com', tcp_connect => \&socks4a_connect, sub {
965 my ($data, $headers) = @_;
966 ...
967 };
501 968
502=head1 SEE ALSO 969=head1 SEE ALSO
503 970
504L<AnyEvent>. 971L<AnyEvent>.
505 972
506=head1 AUTHOR 973=head1 AUTHOR
507 974
508 Marc Lehmann <schmorp@schmorp.de> 975 Marc Lehmann <schmorp@schmorp.de>
509 http://home.schmorp.de/ 976 http://home.schmorp.de/
977
978With many thanks to Дмитрий Шалашов, who provided countless
979testcases and bugreports.
510 980
511=cut 981=cut
512 982
5131 9831
514 984

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines