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.44 by root, Tue Jul 7 00:15:32 2009 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 4.8 ();
43use AnyEvent::Util (); 47use AnyEvent::Util ();
44use AnyEvent::Socket (); 48use AnyEvent::Socket ();
45use AnyEvent::Handle (); 49use AnyEvent::Handle ();
46 50
47use base Exporter::; 51use base Exporter::;
48 52
49our $VERSION = '1.0'; 53our $VERSION = '1.4';
50 54
51our @EXPORT = qw(http_get http_request); 55our @EXPORT = qw(http_get http_post http_head http_request);
52 56
53our $USERAGENT = "Mozilla/5.0 (compatible; AnyEvent::HTTP/$VERSION; +http://software.schmorp.de/pkg/AnyEvent)"; 57our $USERAGENT = "Mozilla/5.0 (compatible; U; AnyEvent-HTTP/$VERSION; +http://software.schmorp.de/pkg/AnyEvent)";
54our $MAX_RECURSE = 10; 58our $MAX_RECURSE = 10;
55our $MAX_PERSISTENT = 8; 59our $MAX_PERSISTENT = 8;
56our $PERSISTENT_TIMEOUT = 2; 60our $PERSISTENT_TIMEOUT = 2;
57our $TIMEOUT = 300; 61our $TIMEOUT = 300;
58 62
59# changing these is evil 63# changing these is evil
60our $MAX_PERSISTENT_PER_HOST = 2; 64our $MAX_PERSISTENT_PER_HOST = 0;
61our $MAX_PER_HOST = 4; 65our $MAX_PER_HOST = 4;
62 66
63our $PROXY; 67our $PROXY;
68our $ACTIVE = 0;
64 69
65my %KA_COUNT; # number of open keep-alive connections per host 70my %KA_COUNT; # number of open keep-alive connections per host
66my %CO_SLOT; # number of open connections, and wait queue, per host 71my %CO_SLOT; # number of open connections, and wait queue, per host
67 72
68=item http_get $url, key => value..., $cb->($data, $headers) 73=item http_get $url, key => value..., $cb->($data, $headers)
69 74
70Executes an HTTP-GET request. See the http_request function for details on 75Executes an HTTP-GET request. See the http_request function for details on
71additional parameters. 76additional parameters and the return value.
72 77
73=item http_head $url, key => value..., $cb->($data, $headers) 78=item http_head $url, key => value..., $cb->($data, $headers)
74 79
75Executes an HTTP-HEAD request. See the http_request function for details on 80Executes an HTTP-HEAD request. See the http_request function for details
76additional parameters. 81on additional parameters and the return value.
77 82
78=item http_post $url, $body, key => value..., $cb->($data, $headers) 83=item http_post $url, $body, key => value..., $cb->($data, $headers)
79 84
80Executes an HTTP-POST request with a request body of C<$bod>. See the 85Executes an HTTP-POST request with a request body of C<$body>. See the
81http_request function for details on additional parameters. 86http_request function for details on additional parameters and the return
87value.
82 88
83=item http_request $method => $url, key => value..., $cb->($data, $headers) 89=item http_request $method => $url, key => value..., $cb->($data, $headers)
84 90
85Executes a HTTP request of type C<$method> (e.g. C<GET>, C<POST>). The URL 91Executes a HTTP request of type C<$method> (e.g. C<GET>, C<POST>). The URL
86must be an absolute http or https URL. 92must be an absolute http or https URL.
87 93
94When called in void context, nothing is returned. In other contexts,
95C<http_request> returns a "cancellation guard" - you have to keep the
96object at least alive until the callback get called. If the object gets
97destroyed before the callbakc is called, the request will be cancelled.
98
88The callback will be called with the response data as first argument 99The 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 100(or C<undef> if an error occured), and a hash-ref with response headers as
90response headers as second argument. 101second argument.
91 102
92All the headers in that hash are lowercased. In addition to the response 103All the headers in that hash are lowercased. In addition to the response
93headers, the three "pseudo-headers" C<HTTPVersion>, C<Status> and 104headers, the "pseudo-headers" C<HTTPVersion>, C<Status> and C<Reason>
94C<Reason> contain the three parts of the HTTP Status-Line of the same 105contain the three parts of the HTTP Status-Line of the same name. The
106pseudo-header C<URL> contains the original URL (which can differ from the
107requested URL when following redirects).
108
95name. If the server sends a header multiple lines, then their contents 109If the server sends a header multiple times, then their contents will be
96will be joined together with C<\x00>. 110joined together with a comma (C<,>), as per the HTTP spec.
97 111
98If an internal error occurs, such as not being able to resolve a hostname, 112If 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> 113then C<$data> will be C<undef>, C<< $headers->{Status} >> will be C<59x>
100and the C<Reason> pseudo-header will contain an error message. 114(usually C<599>) and the C<Reason> pseudo-header will contain an error
115message.
101 116
102A typical callback might look like this: 117A typical callback might look like this:
103 118
104 sub { 119 sub {
105 my ($body, $hdr) = @_; 120 my ($body, $hdr) = @_;
121Whether to recurse requests or not, e.g. on redirects, authentication 136Whether to recurse requests or not, e.g. on redirects, authentication
122retries and so on, and how often to do so. 137retries and so on, and how often to do so.
123 138
124=item headers => hashref 139=item headers => hashref
125 140
126The request headers to use. 141The request headers to use. Currently, C<http_request> may provide its
142own C<Host:>, C<Content-Length:>, C<Connection:> and C<Cookie:> headers
143and will provide defaults for C<User-Agent:> and C<Referer:>.
127 144
128=item timeout => $seconds 145=item timeout => $seconds
129 146
130The time-out to use for various stages - each connect attempt will reset 147The 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. 148the timeout, as will read or write activity. Default timeout is 5 minutes.
149based on the original netscape specification. 166based on the original netscape specification.
150 167
151The C<$hash_ref> must be an (initially empty) hash reference which will 168The C<$hash_ref> must be an (initially empty) hash reference which will
152get updated automatically. It is possible to save the cookie_jar to 169get updated automatically. It is possible to save the cookie_jar to
153persistent storage with something like JSON or Storable, but this is not 170persistent storage with something like JSON or Storable, but this is not
154recommended, as expire times are currently being ignored. 171recommended, as expiry times are currently being ignored.
155 172
156Note that this cookie implementation is not of very high quality, nor 173Note that this cookie implementation is not of very high quality, nor
157meant to be complete. If you want complete cookie management you have to 174meant 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 175do 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 176cookie-using sites working. Cookies are a privacy disaster, do not use
160them unless required to. 177them unless required to.
178
179=item tls_ctx => $scheme | $tls_ctx
180
181Specifies the AnyEvent::TLS context to be used for https connections. This
182parameter follows the same rules as the C<tls_ctx> parameter to
183L<AnyEvent::Handle>, but additionally, the two strings C<low> or
184C<high> can be specified, which give you a predefined low-security (no
185verification, highest compatibility) and high-security (CA and common-name
186verification) TLS context.
187
188The default for this option is C<low>, which could be interpreted as "give
189me the page, no matter what".
190
191=item on_header => $callback->($headers)
192
193When specified, this callback will be called with the header hash as soon
194as headers have been successfully received from the remote server (not on
195locally-generated errors).
196
197It has to return either true (in which case AnyEvent::HTTP will continue),
198or false, in which case AnyEvent::HTTP will cancel the download (and call
199the finish callback with an error code of C<598>).
200
201This callback is useful, among other things, to quickly reject unwanted
202content, which, if it is supposed to be rare, can be faster than first
203doing a C<HEAD> request.
204
205Example: cancel the request unless the content-type is "text/html".
206
207 on_header => sub {
208 $_[0]{"content-type"} =~ /^text\/html\s*(?:;|$)/
209 },
210
211=item on_body => $callback->($partial_body, $headers)
212
213When specified, all body data will be passed to this callback instead of
214to the completion callback. The completion callback will get the empty
215string instead of the body data.
216
217It has to return either true (in which case AnyEvent::HTTP will continue),
218or false, in which case AnyEvent::HTTP will cancel the download (and call
219the completion callback with an error code of C<598>).
220
221This callback is useful when the data is too large to be held in memory
222(so the callback writes it to a file) or when only some information should
223be extracted, or when the body should be processed incrementally.
224
225It is usually preferred over doing your own body handling via
226C<want_body_handle>.
227
228=item want_body_handle => $enable
229
230When enabled (default is disabled), the behaviour of AnyEvent::HTTP
231changes considerably: after parsing the headers, and instead of
232downloading the body (if any), the completion callback will be
233called. Instead of the C<$body> argument containing the body data, the
234callback will receive the L<AnyEvent::Handle> object associated with the
235connection. In error cases, C<undef> will be passed. When there is no body
236(e.g. status C<304>), the empty string will be passed.
237
238The handle object might or might not be in TLS mode, might be connected to
239a proxy, be a persistent connection etc., and configured in unspecified
240ways. The user is responsible for this handle (it will not be used by this
241module anymore).
242
243This is useful with some push-type services, where, after the initial
244headers, an interactive protocol is used (typical example would be the
245push-style twitter API which starts a JSON/XML stream).
246
247If you think you need this, first have a look at C<on_body>, to see if
248that doesn'T solve your problem in a better way.
161 249
162=back 250=back
163 251
164Example: make a simple HTTP GET request for http://www.nethype.de/ 252Example: make a simple HTTP GET request for http://www.nethype.de/
165 253
179 use Data::Dumper; 267 use Data::Dumper;
180 print Dumper $hdr; 268 print Dumper $hdr;
181 } 269 }
182 ; 270 ;
183 271
272Example: make another simple HTTP GET request, but immediately try to
273cancel it.
274
275 my $request = http_request GET => "http://www.nethype.de/", sub {
276 my ($body, $hdr) = @_;
277 print "$body\n";
278 };
279
280 undef $request;
281
184=cut 282=cut
185 283
284sub _slot_schedule;
186sub _slot_schedule($) { 285sub _slot_schedule($) {
187 my $host = shift; 286 my $host = shift;
188 287
189 while ($CO_SLOT{$host}[0] < $MAX_PER_HOST) { 288 while ($CO_SLOT{$host}[0] < $MAX_PER_HOST) {
190 if (my $cb = shift @{ $CO_SLOT{$host}[1] }) { 289 if (my $cb = shift @{ $CO_SLOT{$host}[1] }) {
191 # somebody wnats that slot 290 # somebody wants that slot
192 ++$CO_SLOT{$host}[0]; 291 ++$CO_SLOT{$host}[0];
292 ++$ACTIVE;
193 293
194 $cb->(AnyEvent::Util::guard { 294 $cb->(AnyEvent::Util::guard {
295 --$ACTIVE;
195 --$CO_SLOT{$host}[0]; 296 --$CO_SLOT{$host}[0];
196 _slot_schedule $host; 297 _slot_schedule $host;
197 }); 298 });
198 } else { 299 } else {
199 # nobody wants the slot, maybe we can forget about it 300 # nobody wants the slot, maybe we can forget about it
200 delete $CO_SLOT{$host} unless $CO_SLOT{$host}[0]; 301 delete $CO_SLOT{$host} unless $CO_SLOT{$host}[0];
201 warn "$host deleted" unless $CO_SLOT{$host}[0];#d#
202 last; 302 last;
203 } 303 }
204 } 304 }
205} 305}
206 306
209 push @{ $CO_SLOT{$_[0]}[1] }, $_[1]; 309 push @{ $CO_SLOT{$_[0]}[1] }, $_[1];
210 310
211 _slot_schedule $_[0]; 311 _slot_schedule $_[0];
212} 312}
213 313
314our $qr_nl = qr<\015?\012>;
315our $qr_nlnl = qr<\015?\012\015?\012>;
316
317our $TLS_CTX_LOW = { cache => 1, sslv2 => 1 };
318our $TLS_CTX_HIGH = { cache => 1, verify => 1, verify_peername => "https" };
319
214sub http_request($$$;@) { 320sub http_request($$@) {
215 my $cb = pop; 321 my $cb = pop;
216 my ($method, $url, %arg) = @_; 322 my ($method, $url, %arg) = @_;
217 323
218 my %hdr; 324 my %hdr;
325
326 $arg{tls_ctx} = $TLS_CTX_LOW if $arg{tls_ctx} eq "low" || !exists $arg{tls_ctx};
327 $arg{tls_ctx} = $TLS_CTX_HIGH if $arg{tls_ctx} eq "high";
219 328
220 $method = uc $method; 329 $method = uc $method;
221 330
222 if (my $hdr = $arg{headers}) { 331 if (my $hdr = $arg{headers}) {
223 while (my ($k, $v) = each %$hdr) { 332 while (my ($k, $v) = each %$hdr) {
224 $hdr{lc $k} = $v; 333 $hdr{lc $k} = $v;
225 } 334 }
226 } 335 }
227 336
228 my $recurse = exists $arg{recurse} ? $arg{recurse} : $MAX_RECURSE; 337 my $recurse = exists $arg{recurse} ? delete $arg{recurse} : $MAX_RECURSE;
229 338
230 return $cb->(undef, { Status => 599, Reason => "recursion limit reached" }) 339 return $cb->(undef, { Status => 599, Reason => "Too many redirections", URL => $url })
231 if $recurse < 0; 340 if $recurse < 0;
232 341
233 my $proxy = $arg{proxy} || $PROXY; 342 my $proxy = $arg{proxy} || $PROXY;
234 my $timeout = $arg{timeout} || $TIMEOUT; 343 my $timeout = $arg{timeout} || $TIMEOUT;
235 344
236 $hdr{"user-agent"} ||= $USERAGENT;
237
238 my ($scheme, $authority, $upath, $query, $fragment) = 345 my ($uscheme, $uauthority, $upath, $query, $fragment) =
239 $url =~ m|(?:([^:/?#]+):)?(?://([^/?#]*))?([^?#]*)(?:\?([^#]*))?(?:#(.*))?|; 346 $url =~ m|(?:([^:/?#]+):)?(?://([^/?#]*))?([^?#]*)(?:\?([^#]*))?(?:#(.*))?|;
240 347
241 $scheme = lc $scheme; 348 $uscheme = lc $uscheme;
242 349
243 my $uport = $scheme eq "http" ? 80 350 my $uport = $uscheme eq "http" ? 80
244 : $scheme eq "https" ? 443 351 : $uscheme eq "https" ? 443
245 : return $cb->(undef, { Status => 599, Reason => "only http and https URL schemes supported" }); 352 : return $cb->(undef, { Status => 599, Reason => "Only http and https URL schemes supported", URL => $url });
246 353
247 $authority =~ /^(?: .*\@ )? ([^\@:]+) (?: : (\d+) )?$/x 354 $uauthority =~ /^(?: .*\@ )? ([^\@:]+) (?: : (\d+) )?$/x
248 or return $cb->(undef, { Status => 599, Reason => "unparsable URL" }); 355 or return $cb->(undef, { Status => 599, Reason => "Unparsable URL", URL => $url });
249 356
250 my $uhost = $1; 357 my $uhost = $1;
251 $uport = $2 if defined $2; 358 $uport = $2 if defined $2;
252 359
360 $hdr{host} = defined $2 ? "$uhost:$2" : "$uhost";
361
253 $uhost =~ s/^\[(.*)\]$/$1/; 362 $uhost =~ s/^\[(.*)\]$/$1/;
254 $upath .= "?$query" if length $query; 363 $upath .= "?$query" if length $query;
255 364
256 $upath =~ s%^/?%/%; 365 $upath =~ s%^/?%/%;
257 366
258 # cookie processing 367 # cookie processing
259 if (my $jar = $arg{cookie_jar}) { 368 if (my $jar = $arg{cookie_jar}) {
260 %$jar = () if $jar->{version} < 1; 369 %$jar = () if $jar->{version} != 1;
261 370
262 my @cookie; 371 my @cookie;
263 372
264 while (my ($chost, $v) = each %$jar) { 373 while (my ($chost, $v) = each %$jar) {
374 if ($chost =~ /^\./) {
265 next unless $chost eq substr $uhost, -length $chost; 375 next unless $chost eq substr $uhost, -length $chost;
266 next unless $chost =~ /^\./; 376 } elsif ($chost =~ /\./) {
377 next unless $chost eq $uhost;
378 } else {
379 next;
380 }
267 381
268 while (my ($cpath, $v) = each %$v) { 382 while (my ($cpath, $v) = each %$v) {
269 next unless $cpath eq substr $upath, 0, length $cpath; 383 next unless $cpath eq substr $upath, 0, length $cpath;
270 384
271 while (my ($k, $v) = each %$v) { 385 while (my ($k, $v) = each %$v) {
272 next if $scheme ne "https" && exists $v->{secure}; 386 next if $uscheme ne "https" && exists $v->{secure};
387 my $value = $v->{value};
388 $value =~ s/([\\"])/\\$1/g;
273 push @cookie, "$k=$v->{value}"; 389 push @cookie, "$k=\"$value\"";
274 } 390 }
275 } 391 }
276 } 392 }
277 393
278 $hdr{cookie} = join "; ", @cookie 394 $hdr{cookie} = join "; ", @cookie
279 if @cookie; 395 if @cookie;
280 } 396 }
281 397
282 my ($rhost, $rport, $rpath); # request host, port, path 398 my ($rhost, $rport, $rscheme, $rpath); # request host, port, path
283 399
284 if ($proxy) { 400 if ($proxy) {
285 ($rhost, $rport, $scheme) = @$proxy; 401 ($rpath, $rhost, $rport, $rscheme) = ($url, @$proxy);
286 $rpath = $url; 402
403 # don't support https requests over https-proxy transport,
404 # can't be done with tls as spec'ed, unless you double-encrypt.
405 $rscheme = "http" if $uscheme eq "https" && $rscheme eq "https";
287 } else { 406 } else {
288 ($rhost, $rport, $rpath) = ($uhost, $uport, $upath); 407 ($rhost, $rport, $rscheme, $rpath) = ($uhost, $uport, $uscheme, $upath);
289 $hdr{host} = $uhost;
290 } 408 }
409
410 $hdr{"user-agent"} ||= $USERAGENT;
411 $hdr{referer} ||= "$uscheme://$uauthority$upath"; # leave out fragment and query string, just a heuristic
291 412
292 $hdr{"content-length"} = length $arg{body}; 413 $hdr{"content-length"} = length $arg{body};
293 414
294 my %state = (connect_guard => 1); 415 my %state = (connect_guard => 1);
295 416
298 419
299 return unless $state{connect_guard}; 420 return unless $state{connect_guard};
300 421
301 $state{connect_guard} = AnyEvent::Socket::tcp_connect $rhost, $rport, sub { 422 $state{connect_guard} = AnyEvent::Socket::tcp_connect $rhost, $rport, sub {
302 $state{fh} = shift 423 $state{fh} = shift
424 or do {
425 my $err = "$!";
426 %state = ();
303 or return $cb->(undef, { Status => 599, Reason => "$!" }); 427 return $cb->(undef, { Status => 599, Reason => $err, URL => $url });
428 };
304 429
305 delete $state{connect_guard}; # reduce memory usage, save a tree 430 pop; # free memory, save a tree
431
432 return unless delete $state{connect_guard};
306 433
307 # get handle 434 # get handle
308 $state{handle} = new AnyEvent::Handle 435 $state{handle} = new AnyEvent::Handle
309 fh => $state{fh}, 436 fh => $state{fh},
310 ($scheme eq "https" ? (tls => "connect") : ()); 437 timeout => $timeout,
438 peername => $rhost,
439 tls_ctx => $arg{tls_ctx};
311 440
312 # limit the number of persistent connections 441 # limit the number of persistent connections
442 # keepalive not yet supported
313 if ($KA_COUNT{$_[1]} < $MAX_PERSISTENT_PER_HOST) { 443 if ($KA_COUNT{$_[1]} < $MAX_PERSISTENT_PER_HOST) {
314 ++$KA_COUNT{$_[1]}; 444 ++$KA_COUNT{$_[1]};
315 $state{handle}{ka_count_guard} = AnyEvent::Util::guard { --$KA_COUNT{$_[1]} }; 445 $state{handle}{ka_count_guard} = AnyEvent::Util::guard {
446 --$KA_COUNT{$_[1]}
447 };
316 $hdr{connection} = "keep-alive"; 448 $hdr{connection} = "keep-alive";
317 delete $hdr{connection}; # keep-alive not yet supported
318 } else { 449 } else {
319 delete $hdr{connection}; 450 delete $hdr{connection};
320 } 451 }
321 452
322 # (re-)configure handle 453 # (re-)configure handle
323 $state{handle}->timeout ($timeout);
324 $state{handle}->on_error (sub { 454 $state{handle}->on_error (sub {
325 %state = (); 455 %state = ();
326 $cb->(undef, { Status => 599, Reason => "$!" }); 456 $cb->(undef, { Status => 599, Reason => $_[2], URL => $url });
327 }); 457 });
328 $state{handle}->on_eof (sub { 458 $state{handle}->on_eof (sub {
329 %state = (); 459 %state = ();
330 $cb->(undef, { Status => 599, Reason => "unexpected end-of-file" }); 460 $cb->(undef, { Status => 599, Reason => "Unexpected end-of-file", URL => $url });
331 }); 461 });
332 462
463 $state{handle}->starttls ("connect") if $rscheme eq "https";
464
465 # handle actual, non-tunneled, request
466 my $handle_actual_request = sub {
467 $state{handle}->starttls ("connect") if $uscheme eq "https" && !exists $state{handle}{tls};
468
333 # send request 469 # send request
334 $state{handle}->push_write ( 470 $state{handle}->push_write (
335 "$method $rpath HTTP/1.0\015\012" 471 "$method $rpath HTTP/1.0\015\012"
336 . (join "", map "$_: $hdr{$_}\015\012", keys %hdr) 472 . (join "", map "\u$_: $hdr{$_}\015\012", keys %hdr)
337 . "\015\012" 473 . "\015\012"
338 . (delete $arg{body}) 474 . (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 ); 475 );
353 476
477 %hdr = (); # reduce memory usage, save a kitten
478
479 # status line
480 $state{handle}->push_read (line => $qr_nl, sub {
481 $_[1] =~ /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\015\012]*) )?/ix
482 or return (%state = (), $cb->(undef, { Status => 599, Reason => "Invalid server response ($_[1])", URL => $url }));
483
484 my %hdr = ( # response headers
485 HTTPVersion => ",$1",
486 Status => ",$2",
487 Reason => ",$3",
488 URL => ",$url"
489 );
490
354 # headers, could be optimized a bit 491 # headers, could be optimized a bit
355 $state{handle}->unshift_read (line => qr/\015?\012\015?\012/, sub { 492 $state{handle}->unshift_read (line => $qr_nlnl, sub {
356 for ("$_[1]\012") { 493 for ("$_[1]\012") {
357 # we support spaces in field names, as lotus domino 494 y/\015//d; # weed out any \015, as they show up in the weirdest of places.
358 # creates them. 495
496 # things seen, not parsed:
497 # p3pP="NON CUR OTPi OUR NOR UNI"
498
359 $hdr{lc $1} .= "\x00$2" 499 $hdr{lc $1} .= ",$2"
360 while /\G 500 while /\G
361 ([^:\000-\037]+): 501 ([^:\000-\037]*):
362 [\011\040]* 502 [\011\040]*
363 ((?: [^\015\012]+ | \015?\012[\011\040] )*) 503 ((?: [^\012]+ | \012[\011\040] )*)
364 \015?\012 504 \012
365 /gxc; 505 /gxc;
366 506
367 /\G$/ 507 /\G$/
368 or return (%state = (), $cb->(undef, { Status => 599, Reason => "garbled response headers" })); 508 or return (%state = (), $cb->(undef, { Status => 599, Reason => "Garbled response headers", URL => $url }));
369 } 509 }
370 510
371 substr $_, 0, 1, "" 511 substr $_, 0, 1, ""
372 for values %hdr; 512 for values %hdr;
373 513
374 my $finish = sub { 514 # redirect handling
375 %state = (); 515 # microsoft and other shitheads don't give a shit for following standards,
516 # try to support some common forms of broken Location headers.
517 if ($hdr{location} !~ /^(?: $ | [^:\/?\#]+ : )/x) {
518 $hdr{location} =~ s/^\.\/+//;
376 519
377 # set-cookie processing 520 my $url = "$rscheme://$uhost:$uport";
378 if ($arg{cookie_jar} && exists $hdr{"set-cookie"}) {
379 for (split /\x00/, $hdr{"set-cookie"}) {
380 my ($cookie, @arg) = split /;\s*/;
381 my ($name, $value) = split /=/, $cookie, 2;
382 my %kv = (value => $value, map { split /=/, $_, 2 } @arg);
383
384 my $cdom = (delete $kv{domain}) || $uhost;
385 my $cpath = (delete $kv{path}) || "/";
386
387 $cdom =~ s/^.?/./; # make sure it starts with a "."
388 521
389 next if $cdom =~ /\.$/; 522 unless ($hdr{location} =~ s/^\///) {
390 523 $url .= $upath;
391 # this is not rfc-like and not netscape-like. go figure. 524 $url =~ s/\/[^\/]*$//;
392 my $ndots = $cdom =~ y/.//; 525 }
393 next if $ndots < ($cdom =~ /\.[^.][^.]\.[^.][^.]$/ ? 3 : 2); 526
394 527 $hdr{location} = "$url/$hdr{location}";
528 }
529
530 my $redirect;
531
532 if ($recurse) {
533 if ($hdr{Status} =~ /^30[12]$/ && $method ne "POST") {
534 # apparently, mozilla et al. just change POST to GET here
535 # more research is needed before we do the same
395 # store it 536 $redirect = 1;
396 $arg{cookie_jar}{version} = 1; 537 } elsif ($hdr{Status} == 303) {
397 $arg{cookie_jar}{$cdom}{$cpath}{$name} = \%kv; 538 # even http/1.1 is unclear on how to mutate the method
539 $method = "GET" unless $method eq "HEAD";
540 $redirect = 1;
541 } elsif ($hdr{Status} == 307 && $method =~ /^(?:GET|HEAD)$/) {
542 $redirect = 1;
398 } 543 }
399 } 544 }
400 545
401 if ($_[1]{Status} =~ /^x30[12]$/ && $recurse) { 546 my $finish = sub {
402 # microsoft and other assholes don't give a shit for following standards, 547 $state{handle}->destroy if $state{handle};
403 # try to support a common form of broken Location header. 548 %state = ();
404 $_[1]{location} =~ s%^/%$scheme://$uhost:$uport/%;
405 549
550 # set-cookie processing
551 if ($arg{cookie_jar}) {
552 for ($_[1]{"set-cookie"}) {
553 # parse NAME=VALUE
554 my @kv;
555
556 while (/\G\s* ([^=;,[:space:]]+) \s*=\s* (?: "((?:[^\\"]+|\\.)*)" | ([^=;,[:space:]]*) )/gcxs) {
557 my $name = $1;
558 my $value = $3;
559
560 unless ($value) {
561 $value = $2;
562 $value =~ s/\\(.)/$1/gs;
563 }
564
565 push @kv, $name => $value;
566
567 last unless /\G\s*;/gc;
568 }
569
570 last unless @kv;
571
572 my $name = shift @kv;
573 my %kv = (value => shift @kv, @kv);
574
575 my $cdom;
576 my $cpath = (delete $kv{path}) || "/";
577
578 if (exists $kv{domain}) {
579 $cdom = delete $kv{domain};
580
581 $cdom =~ s/^\.?/./; # make sure it starts with a "."
582
583 next if $cdom =~ /\.$/;
584
585 # this is not rfc-like and not netscape-like. go figure.
586 my $ndots = $cdom =~ y/.//;
587 next if $ndots < ($cdom =~ /\.[^.][^.]\.[^.][^.]$/ ? 3 : 2);
588 } else {
589 $cdom = $uhost;
590 }
591
592 # store it
593 $arg{cookie_jar}{version} = 1;
594 $arg{cookie_jar}{$cdom}{$cpath}{$name} = \%kv;
595
596 redo if /\G\s*,/gc;
597 }
598 }
599
600 if ($redirect) {
601 # we ignore any errors, as it is very common to receive
602 # Content-Length != 0 but no actual body
603 # we also access %hdr, as $_[1] might be an erro
406 http_request ($method, $_[1]{location}, %arg, recurse => $recurse - 1, $cb); 604 http_request ($method => $hdr{location}, %arg, recurse => $recurse - 1, $cb);
605 } else {
606 $cb->($_[0], $_[1]);
607 }
608 };
609
610 my $len = $hdr{"content-length"};
611
612 if (!$redirect && $arg{on_header} && !$arg{on_header}(\%hdr)) {
613 $finish->(undef, { Status => 598, Reason => "Request cancelled by on_header", URL => $url });
614 } elsif (
615 $hdr{Status} =~ /^(?:1..|[23]04)$/
616 or $method eq "HEAD"
617 or (defined $len && !$len)
618 ) {
619 # no body
620 $finish->("", \%hdr);
407 } else { 621 } else {
408 $cb->($_[0], $_[1]); 622 # body handling, four different code paths
623 # for want_body_handle, on_body (2x), normal (2x)
624 # we might read too much here, but it does not matter yet (no pers. connections)
625 if (!$redirect && $arg{want_body_handle}) {
626 $_[0]->on_eof (undef);
627 $_[0]->on_error (undef);
628 $_[0]->on_read (undef);
629
630 $finish->(delete $state{handle}, \%hdr);
631
632 } elsif ($arg{on_body}) {
633 $_[0]->on_error (sub { $finish->(undef, { Status => 599, Reason => $_[2], URL => $url }) });
634 if ($len) {
635 $_[0]->on_eof (undef);
636 $_[0]->on_read (sub {
637 $len -= length $_[0]{rbuf};
638
639 $arg{on_body}(delete $_[0]{rbuf}, \%hdr)
640 or $finish->(undef, { Status => 598, Reason => "Request cancelled by on_body", URL => $url });
641
642 $len > 0
643 or $finish->("", \%hdr);
644 });
645 } else {
646 $_[0]->on_eof (sub {
647 $finish->("", \%hdr);
648 });
649 $_[0]->on_read (sub {
650 $arg{on_body}(delete $_[0]{rbuf}, \%hdr)
651 or $finish->(undef, { Status => 598, Reason => "Request cancelled by on_body", URL => $url });
652 });
653 }
654 } else {
655 $_[0]->on_eof (undef);
656
657 if ($len) {
658 $_[0]->on_error (sub { $finish->(undef, { Status => 599, Reason => $_[2], URL => $url }) });
659 $_[0]->on_read (sub {
660 $finish->((substr delete $_[0]{rbuf}, 0, $len, ""), \%hdr)
661 if $len <= length $_[0]{rbuf};
662 });
663 } else {
664 $_[0]->on_error (sub {
665 $! == Errno::EPIPE || !$!
666 ? $finish->(delete $_[0]{rbuf}, \%hdr)
667 : $finish->(undef, { Status => 599, Reason => $_[2], URL => $url });
668 });
669 $_[0]->on_read (sub { });
670 }
671 }
409 } 672 }
410 }; 673 });
674 });
675 };
411 676
412 if ($hdr{Status} =~ /^(?:1..|204|304)$/ or $method eq "HEAD") { 677 # now handle proxy-CONNECT method
413 $finish->(undef, \%hdr); 678 if ($proxy && $uscheme eq "https") {
679 # oh dear, we have to wrap it into a connect request
680
681 # maybe re-use $uauthority with patched port?
682 $state{handle}->push_write ("CONNECT $uhost:$uport HTTP/1.0\015\012Host: $uhost\015\012\015\012");
683 $state{handle}->push_read (line => $qr_nlnl, sub {
684 $_[1] =~ /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\015\012]*) )?/ix
685 or return (%state = (), $cb->(undef, { Status => 599, Reason => "Invalid proxy connect response ($_[1])", URL => $url }));
686
687 if ($2 == 200) {
688 $rpath = $upath;
689 &$handle_actual_request;
414 } else { 690 } else {
415 if (exists $hdr{"content-length"}) { 691 %state = ();
416 $_[0]->unshift_read (chunk => $hdr{"content-length"}, sub { 692 $cb->(undef, { Status => $2, Reason => $3, URL => $url });
417 # could cache persistent connection now
418 if ($hdr{connection} =~ /\bkeep-alive\b/i) {
419 # but we don't, due to misdesigns, this is annoyingly complex
420 };
421
422 $finish->($_[1], \%hdr);
423 });
424 } 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);
431 $_[0]->on_read (sub { });
432 }
433 } 693 }
434 }); 694 });
695 } else {
696 &$handle_actual_request;
435 }); 697 }
698
436 }, sub { 699 }, sub {
437 $timeout 700 $timeout
438 }; 701 };
439 }; 702 };
440 703
441 defined wantarray && AnyEvent::Util::guard { %state = () } 704 defined wantarray && AnyEvent::Util::guard { %state = () }
442} 705}
443 706
444sub http_get($$;@) { 707sub http_get($@) {
445 unshift @_, "GET"; 708 unshift @_, "GET";
446 &http_request 709 &http_request
447} 710}
448 711
449sub http_head($$;@) { 712sub http_head($@) {
450 unshift @_, "HEAD"; 713 unshift @_, "HEAD";
451 &http_request 714 &http_request
452} 715}
453 716
454sub http_post($$$;@) { 717sub http_post($$@) {
718 my $url = shift;
455 unshift @_, "POST", "body"; 719 unshift @_, "POST", $url, "body";
456 &http_request 720 &http_request
457} 721}
458 722
459=back 723=back
460 724
472The default value for the C<recurse> request parameter (default: C<10>). 736The default value for the C<recurse> request parameter (default: C<10>).
473 737
474=item $AnyEvent::HTTP::USERAGENT 738=item $AnyEvent::HTTP::USERAGENT
475 739
476The default value for the C<User-Agent> header (the default is 740The 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)>). 741C<Mozilla/5.0 (compatible; U; AnyEvent-HTTP/$VERSION; +http://software.schmorp.de/pkg/AnyEvent)>).
478 742
479=item $AnyEvent::HTTP::MAX_PERSISTENT 743=item $AnyEvent::HTTP::MAX_PER_HOST
480 744
481The maximum number of persistent connections to keep open (default: 8). 745The maximum number of concurrent conenctions to the same host (identified
746by the hostname). If the limit is exceeded, then the additional requests
747are queued until previous connections are closed.
482 748
483Not implemented currently. 749The default value for this is C<4>, and it is highly advisable to not
750increase it.
484 751
485=item $AnyEvent::HTTP::PERSISTENT_TIMEOUT 752=item $AnyEvent::HTTP::ACTIVE
486 753
487The maximum time to cache a persistent connection, in seconds (default: 2). 754The number of active connections. This is not the number of currently
488 755running requests, but the number of currently open and non-idle TCP
489Not implemented currently. 756connections. This number of can be useful for load-leveling.
490 757
491=back 758=back
492 759
493=cut 760=cut
494 761
503 770
504L<AnyEvent>. 771L<AnyEvent>.
505 772
506=head1 AUTHOR 773=head1 AUTHOR
507 774
508 Marc Lehmann <schmorp@schmorp.de> 775 Marc Lehmann <schmorp@schmorp.de>
509 http://home.schmorp.de/ 776 http://home.schmorp.de/
777
778With many thanks to Дмитрий Шалашов, who provided countless
779testcases and bugreports.
510 780
511=cut 781=cut
512 782
5131 7831
514 784

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines