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.41 by root, Sun Jul 5 23:50:59 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.452 ();
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.12';
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 = 2;
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.
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.
87 98
88The callback will be called with the response data as first argument 99The callback will be called with the response 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 it wasn't available due to errors), and a hash-ref with
90response headers as second argument. 101response headers as second 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->($hdr)
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
205=item on_body => $callback->($data, $hdr)
206
207When specified, all body data will be "filtered" through this callback.
208
209The callback will incrementally receive body data, and is supposed to
210return it or a modified version of it (empty strings are valid returns).
211
212If the callback returns C<undef>, then the request will be cancelled.
213
214This callback is useful when you want to do some processing on the data,
215or the data is too large to be held in memory (so the callback writes it
216to a file and returns the empty string) and so on.
217
218It is usually preferred over doing your own body handling via
219C<want_body_handle>.
220
221=item want_body_handle => $enable
222
223When enabled (default is disabled), the behaviour of AnyEvent::HTTP
224changes considerably: after parsing the headers, and instead of
225downloading the body (if any), the completion callback will be
226called. Instead of the C<$body> argument containing the body data, the
227callback will receive the L<AnyEvent::Handle> object associated with the
228connection. In error cases, C<undef> will be passed. When there is no body
229(e.g. status C<304>), the empty string will be passed.
230
231The handle object might or might not be in TLS mode, might be connected to
232a proxy, be a persistent connection etc., and configured in unspecified
233ways. The user is responsible for this handle (it will not be used by this
234module anymore).
235
236This is useful with some push-type services, where, after the initial
237headers, an interactive protocol is used (typical example would be the
238push-style twitter API which starts a JSON/XML stream).
239
240If you think you need this, first have a look at C<on_body>, to see if
241that doesn'T solve your problem in a better way.
161 242
162=back 243=back
163 244
164Example: make a simple HTTP GET request for http://www.nethype.de/ 245Example: make a simple HTTP GET request for http://www.nethype.de/
165 246
179 use Data::Dumper; 260 use Data::Dumper;
180 print Dumper $hdr; 261 print Dumper $hdr;
181 } 262 }
182 ; 263 ;
183 264
265Example: make another simple HTTP GET request, but immediately try to
266cancel it.
267
268 my $request = http_request GET => "http://www.nethype.de/", sub {
269 my ($body, $hdr) = @_;
270 print "$body\n";
271 };
272
273 undef $request;
274
184=cut 275=cut
185 276
277sub _slot_schedule;
186sub _slot_schedule($) { 278sub _slot_schedule($) {
187 my $host = shift; 279 my $host = shift;
188 280
189 while ($CO_SLOT{$host}[0] < $MAX_PER_HOST) { 281 while ($CO_SLOT{$host}[0] < $MAX_PER_HOST) {
190 if (my $cb = shift @{ $CO_SLOT{$host}[1] }) { 282 if (my $cb = shift @{ $CO_SLOT{$host}[1] }) {
191 # somebody wnats that slot 283 # somebody wants that slot
192 ++$CO_SLOT{$host}[0]; 284 ++$CO_SLOT{$host}[0];
285 ++$ACTIVE;
193 286
194 $cb->(AnyEvent::Util::guard { 287 $cb->(AnyEvent::Util::guard {
288 --$ACTIVE;
195 --$CO_SLOT{$host}[0]; 289 --$CO_SLOT{$host}[0];
196 _slot_schedule $host; 290 _slot_schedule $host;
197 }); 291 });
198 } else { 292 } else {
199 # nobody wants the slot, maybe we can forget about it 293 # nobody wants the slot, maybe we can forget about it
200 delete $CO_SLOT{$host} unless $CO_SLOT{$host}[0]; 294 delete $CO_SLOT{$host} unless $CO_SLOT{$host}[0];
201 warn "$host deleted" unless $CO_SLOT{$host}[0];#d#
202 last; 295 last;
203 } 296 }
204 } 297 }
205} 298}
206 299
209 push @{ $CO_SLOT{$_[0]}[1] }, $_[1]; 302 push @{ $CO_SLOT{$_[0]}[1] }, $_[1];
210 303
211 _slot_schedule $_[0]; 304 _slot_schedule $_[0];
212} 305}
213 306
307our $qr_nl = qr<\015?\012>;
308our $qr_nlnl = qr<\015?\012\015?\012>;
309
310our $TLS_CTX_LOW = { cache => 1, sslv2 => 1 };
311our $TLS_CTX_HIGH = { cache => 1, verify => 1, verify_peername => "https" };
312
214sub http_request($$$;@) { 313sub http_request($$@) {
215 my $cb = pop; 314 my $cb = pop;
216 my ($method, $url, %arg) = @_; 315 my ($method, $url, %arg) = @_;
217 316
218 my %hdr; 317 my %hdr;
318
319 $arg{tls_ctx} = $TLS_CTX_LOW if $arg{tls_ctx} eq "low" || !exists $arg{tls_ctx};
320 $arg{tls_ctx} = $TLS_CTX_HIGH if $arg{tls_ctx} eq "high";
219 321
220 $method = uc $method; 322 $method = uc $method;
221 323
222 if (my $hdr = $arg{headers}) { 324 if (my $hdr = $arg{headers}) {
223 while (my ($k, $v) = each %$hdr) { 325 while (my ($k, $v) = each %$hdr) {
224 $hdr{lc $k} = $v; 326 $hdr{lc $k} = $v;
225 } 327 }
226 } 328 }
227 329
228 my $recurse = exists $arg{recurse} ? $arg{recurse} : $MAX_RECURSE; 330 my $recurse = exists $arg{recurse} ? delete $arg{recurse} : $MAX_RECURSE;
229 331
230 return $cb->(undef, { Status => 599, Reason => "recursion limit reached" }) 332 return $cb->(undef, { Status => 599, Reason => "Too many redirections", URL => $url })
231 if $recurse < 0; 333 if $recurse < 0;
232 334
233 my $proxy = $arg{proxy} || $PROXY; 335 my $proxy = $arg{proxy} || $PROXY;
234 my $timeout = $arg{timeout} || $TIMEOUT; 336 my $timeout = $arg{timeout} || $TIMEOUT;
235 337
236 $hdr{"user-agent"} ||= $USERAGENT;
237
238 my ($scheme, $authority, $upath, $query, $fragment) = 338 my ($uscheme, $uauthority, $upath, $query, $fragment) =
239 $url =~ m|(?:([^:/?#]+):)?(?://([^/?#]*))?([^?#]*)(?:\?([^#]*))?(?:#(.*))?|; 339 $url =~ m|(?:([^:/?#]+):)?(?://([^/?#]*))?([^?#]*)(?:\?([^#]*))?(?:#(.*))?|;
240 340
241 $scheme = lc $scheme; 341 $uscheme = lc $uscheme;
242 342
243 my $uport = $scheme eq "http" ? 80 343 my $uport = $uscheme eq "http" ? 80
244 : $scheme eq "https" ? 443 344 : $uscheme eq "https" ? 443
245 : return $cb->(undef, { Status => 599, Reason => "only http and https URL schemes supported" }); 345 : return $cb->(undef, { Status => 599, Reason => "Only http and https URL schemes supported", URL => $url });
246 346
247 $authority =~ /^(?: .*\@ )? ([^\@:]+) (?: : (\d+) )?$/x 347 $uauthority =~ /^(?: .*\@ )? ([^\@:]+) (?: : (\d+) )?$/x
248 or return $cb->(undef, { Status => 599, Reason => "unparsable URL" }); 348 or return $cb->(undef, { Status => 599, Reason => "Unparsable URL", URL => $url });
249 349
250 my $uhost = $1; 350 my $uhost = $1;
251 $uport = $2 if defined $2; 351 $uport = $2 if defined $2;
252 352
253 $uhost =~ s/^\[(.*)\]$/$1/; 353 $uhost =~ s/^\[(.*)\]$/$1/;
255 355
256 $upath =~ s%^/?%/%; 356 $upath =~ s%^/?%/%;
257 357
258 # cookie processing 358 # cookie processing
259 if (my $jar = $arg{cookie_jar}) { 359 if (my $jar = $arg{cookie_jar}) {
260 %$jar = () if $jar->{version} < 1; 360 %$jar = () if $jar->{version} != 1;
261 361
262 my @cookie; 362 my @cookie;
263 363
264 while (my ($chost, $v) = each %$jar) { 364 while (my ($chost, $v) = each %$jar) {
365 if ($chost =~ /^\./) {
265 next unless $chost eq substr $uhost, -length $chost; 366 next unless $chost eq substr $uhost, -length $chost;
266 next unless $chost =~ /^\./; 367 } elsif ($chost =~ /\./) {
368 next unless $chost eq $uhost;
369 } else {
370 next;
371 }
267 372
268 while (my ($cpath, $v) = each %$v) { 373 while (my ($cpath, $v) = each %$v) {
269 next unless $cpath eq substr $upath, 0, length $cpath; 374 next unless $cpath eq substr $upath, 0, length $cpath;
270 375
271 while (my ($k, $v) = each %$v) { 376 while (my ($k, $v) = each %$v) {
272 next if $scheme ne "https" && exists $v->{secure}; 377 next if $uscheme ne "https" && exists $v->{secure};
378 my $value = $v->{value};
379 $value =~ s/([\\"])/\\$1/g;
273 push @cookie, "$k=$v->{value}"; 380 push @cookie, "$k=\"$value\"";
274 } 381 }
275 } 382 }
276 } 383 }
277 384
278 $hdr{cookie} = join "; ", @cookie 385 $hdr{cookie} = join "; ", @cookie
279 if @cookie; 386 if @cookie;
280 } 387 }
281 388
282 my ($rhost, $rport, $rpath); # request host, port, path 389 my ($rhost, $rport, $rscheme, $rpath); # request host, port, path
283 390
284 if ($proxy) { 391 if ($proxy) {
285 ($rhost, $rport, $scheme) = @$proxy; 392 ($rpath, $rhost, $rport, $rscheme) = ($url, @$proxy);
286 $rpath = $url; 393
394 # don't support https requests over https-proxy transport,
395 # can't be done with tls as spec'ed, unless you double-encrypt.
396 $rscheme = "http" if $uscheme eq "https" && $rscheme eq "https";
287 } else { 397 } else {
288 ($rhost, $rport, $rpath) = ($uhost, $uport, $upath); 398 ($rhost, $rport, $rscheme, $rpath) = ($uhost, $uport, $uscheme, $upath);
289 $hdr{host} = $uhost;
290 } 399 }
291 400
401 $hdr{"user-agent"} ||= $USERAGENT;
402 $hdr{referer} ||= "$uscheme://$uauthority$upath"; # leave out fragment and query string, just a heuristic
403
404 $hdr{host} = "$uhost:$uport";
292 $hdr{"content-length"} = length $arg{body}; 405 $hdr{"content-length"} = length $arg{body};
293 406
294 my %state = (connect_guard => 1); 407 my %state = (connect_guard => 1);
295 408
296 _get_slot $uhost, sub { 409 _get_slot $uhost, sub {
298 411
299 return unless $state{connect_guard}; 412 return unless $state{connect_guard};
300 413
301 $state{connect_guard} = AnyEvent::Socket::tcp_connect $rhost, $rport, sub { 414 $state{connect_guard} = AnyEvent::Socket::tcp_connect $rhost, $rport, sub {
302 $state{fh} = shift 415 $state{fh} = shift
303 or return $cb->(undef, { Status => 599, Reason => "$!" }); 416 or return (%state = (), $cb->(undef, { Status => 599, Reason => "$!", URL => $url }));
417 pop; # free memory, save a tree
304 418
305 delete $state{connect_guard}; # reduce memory usage, save a tree 419 return unless delete $state{connect_guard};
306 420
307 # get handle 421 # get handle
308 $state{handle} = new AnyEvent::Handle 422 $state{handle} = new AnyEvent::Handle
309 fh => $state{fh}, 423 fh => $state{fh},
310 ($scheme eq "https" ? (tls => "connect") : ()); 424 timeout => $timeout,
425 peername => $rhost,
426 tls_ctx => $arg{tls_ctx};
311 427
312 # limit the number of persistent connections 428 # limit the number of persistent connections
429 # keepalive not yet supported
313 if ($KA_COUNT{$_[1]} < $MAX_PERSISTENT_PER_HOST) { 430 if ($KA_COUNT{$_[1]} < $MAX_PERSISTENT_PER_HOST) {
314 ++$KA_COUNT{$_[1]}; 431 ++$KA_COUNT{$_[1]};
315 $state{handle}{ka_count_guard} = AnyEvent::Util::guard { --$KA_COUNT{$_[1]} }; 432 $state{handle}{ka_count_guard} = AnyEvent::Util::guard {
433 --$KA_COUNT{$_[1]}
434 };
316 $hdr{connection} = "keep-alive"; 435 $hdr{connection} = "keep-alive";
317 delete $hdr{connection}; # keep-alive not yet supported
318 } else { 436 } else {
319 delete $hdr{connection}; 437 delete $hdr{connection};
320 } 438 }
321 439
322 # (re-)configure handle 440 # (re-)configure handle
323 $state{handle}->timeout ($timeout);
324 $state{handle}->on_error (sub { 441 $state{handle}->on_error (sub {
325 %state = (); 442 %state = ();
326 $cb->(undef, { Status => 599, Reason => "$!" }); 443 $cb->(undef, { Status => 599, Reason => $_[2], URL => $url });
327 }); 444 });
328 $state{handle}->on_eof (sub { 445 $state{handle}->on_eof (sub {
329 %state = (); 446 %state = ();
330 $cb->(undef, { Status => 599, Reason => "unexpected end-of-file" }); 447 $cb->(undef, { Status => 599, Reason => "Unexpected end-of-file", URL => $url });
331 }); 448 });
332 449
450 $state{handle}->starttls ("connect") if $rscheme eq "https";
451
452 # handle actual, non-tunneled, request
453 my $handle_actual_request = sub {
454 $state{handle}->starttls ("connect") if $uscheme eq "https" && !exists $state{handle}{tls};
455
333 # send request 456 # send request
334 $state{handle}->push_write ( 457 $state{handle}->push_write (
335 "$method $rpath HTTP/1.0\015\012" 458 "$method $rpath HTTP/1.0\015\012"
336 . (join "", map "$_: $hdr{$_}\015\012", keys %hdr) 459 . (join "", map "\u$_: $hdr{$_}\015\012", keys %hdr)
337 . "\015\012" 460 . "\015\012"
338 . (delete $arg{body}) 461 . (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 ); 462 );
353 463
464 %hdr = (); # reduce memory usage, save a kitten
465
466 # status line
467 $state{handle}->push_read (line => $qr_nl, sub {
468 $_[1] =~ /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\015\012]*) )?/ix
469 or return (%state = (), $cb->(undef, { Status => 599, Reason => "Invalid server response ($_[1])", URL => $url }));
470
471 my %hdr = ( # response headers
472 HTTPVersion => ",$1",
473 Status => ",$2",
474 Reason => ",$3",
475 URL => ",$url"
476 );
477
354 # headers, could be optimized a bit 478 # headers, could be optimized a bit
355 $state{handle}->unshift_read (line => qr/\015?\012\015?\012/, sub { 479 $state{handle}->unshift_read (line => $qr_nlnl, sub {
356 for ("$_[1]\012") { 480 for ("$_[1]\012") {
357 # we support spaces in field names, as lotus domino 481 y/\015//d; # weed out any \015, as they show up in the weirdest of places.
358 # creates them. 482
483 # things seen, not parsed:
484 # p3pP="NON CUR OTPi OUR NOR UNI"
485
359 $hdr{lc $1} .= "\x00$2" 486 $hdr{lc $1} .= ",$2"
360 while /\G 487 while /\G
361 ([^:\000-\037]+): 488 ([^:\000-\037]+):
362 [\011\040]* 489 [\011\040]*
363 ((?: [^\015\012]+ | \015?\012[\011\040] )*) 490 ((?: [^\012]+ | \012[\011\040] )*)
364 \015?\012 491 \012
365 /gxc; 492 /gxc;
366 493
367 /\G$/ 494 /\G$/
368 or return (%state = (), $cb->(undef, { Status => 599, Reason => "garbled response headers" })); 495 or return (%state = (), $cb->(undef, { Status => 599, Reason => "Garbled response headers", URL => $url }));
369 } 496 }
370 497
371 substr $_, 0, 1, "" 498 substr $_, 0, 1, ""
372 for values %hdr; 499 for values %hdr;
373 500
374 my $finish = sub { 501 # redirect handling
375 %state = (); 502 # microsoft and other shitheads don't give a shit for following standards,
503 # try to support some common forms of broken Location headers.
504 if ($hdr{location} !~ /^(?: $ | [^:\/?\#]+ : )/x) {
505 $hdr{location} =~ s/^\.\/+//;
376 506
377 # set-cookie processing 507 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 508
389 next if $cdom =~ /\.$/; 509 unless ($hdr{location} =~ s/^\///) {
390 510 $url .= $upath;
391 # this is not rfc-like and not netscape-like. go figure. 511 $url =~ s/\/[^\/]*$//;
392 my $ndots = $cdom =~ y/.//; 512 }
393 next if $ndots < ($cdom =~ /\.[^.][^.]\.[^.][^.]$/ ? 3 : 2); 513
394 514 $hdr{location} = "$url/$hdr{location}";
515 }
516
517 my $redirect;
518
519 if ($recurse) {
520 if ($hdr{Status} =~ /^30[12]$/ && $method ne "POST") {
521 # apparently, mozilla et al. just change POST to GET here
522 # more research is needed before we do the same
395 # store it 523 $redirect = 1;
396 $arg{cookie_jar}{version} = 1; 524 } elsif ($hdr{Status} == 303) {
397 $arg{cookie_jar}{$cdom}{$cpath}{$name} = \%kv; 525 # even http/1.1 is unclear on how to mutate the method
526 $method = "GET" unless $method eq "HEAD";
527 $redirect = 1;
528 } elsif ($hdr{Status} == 307 && $method =~ /^(?:GET|HEAD)$/) {
529 $redirect = 1;
398 } 530 }
399 } 531 }
400 532
401 if ($_[1]{Status} =~ /^x30[12]$/ && $recurse) { 533 my $finish = sub {
402 # microsoft and other assholes don't give a shit for following standards, 534 $state{handle}->destroy if $state{handle};
403 # try to support a common form of broken Location header. 535 %state = ();
404 $_[1]{location} =~ s%^/%$scheme://$uhost:$uport/%;
405 536
537 # set-cookie processing
538 if ($arg{cookie_jar}) {
539 for ($_[1]{"set-cookie"}) {
540 # parse NAME=VALUE
541 my @kv;
542
543 while (/\G\s* ([^=;,[:space:]]+) \s*=\s* (?: "((?:[^\\"]+|\\.)*)" | ([^=;,[:space:]]*) )/gcxs) {
544 my $name = $1;
545 my $value = $3;
546
547 unless ($value) {
548 $value = $2;
549 $value =~ s/\\(.)/$1/gs;
550 }
551
552 push @kv, $name => $value;
553
554 last unless /\G\s*;/gc;
555 }
556
557 last unless @kv;
558
559 my $name = shift @kv;
560 my %kv = (value => shift @kv, @kv);
561
562 my $cdom;
563 my $cpath = (delete $kv{path}) || "/";
564
565 if (exists $kv{domain}) {
566 $cdom = delete $kv{domain};
567
568 $cdom =~ s/^\.?/./; # make sure it starts with a "."
569
570 next if $cdom =~ /\.$/;
571
572 # this is not rfc-like and not netscape-like. go figure.
573 my $ndots = $cdom =~ y/.//;
574 next if $ndots < ($cdom =~ /\.[^.][^.]\.[^.][^.]$/ ? 3 : 2);
575 } else {
576 $cdom = $uhost;
577 }
578
579 # store it
580 $arg{cookie_jar}{version} = 1;
581 $arg{cookie_jar}{$cdom}{$cpath}{$name} = \%kv;
582
583 redo if /\G\s*,/gc;
584 }
585 }
586
587 if ($redirect) {
588 # we ignore any errors, as it is very common to receive
589 # Content-Length != 0 but no actual body
590 # we also access %hdr, as $_[1] might be an erro
406 http_request ($method, $_[1]{location}, %arg, recurse => $recurse - 1, $cb); 591 http_request ($method => $hdr{location}, %arg, recurse => $recurse - 1, $cb);
592 } else {
593 $cb->($_[0], $_[1]);
594 }
595 };
596
597 my $len = $hdr{"content-length"};
598
599 if (!$redirect && $arg{on_header} && !$arg{on_header}(\%hdr)) {
600 $finish->(undef, { Status => 598, Reason => "Request cancelled by on_header", URL => $url });
601 } elsif (
602 $hdr{Status} =~ /^(?:1..|204|304)$/
603 or $method eq "HEAD"
604 or (defined $len && !$len)
605 ) {
606 # no body
607 $finish->("", \%hdr);
407 } else { 608 } else {
408 $cb->($_[0], $_[1]); 609 # body handling, four different code paths
610 # for want_body_handle, on_body (2x), normal (2x)
611 # we might read too much here, but it does not matter yet (no pers. connections)
612 if (!$redirect && $arg{want_body_handle}) {
613 $_[0]->on_eof (undef);
614 $_[0]->on_error (undef);
615 $_[0]->on_read (undef);
616
617 $finish->(delete $state{handle}, \%hdr);
618
619 } elsif ($arg{on_body}) {
620 $_[0]->on_error (sub { $finish->(undef, { Status => 599, Reason => $_[2], URL => $url }) });
621 if ($len) {
622 $_[0]->on_eof (undef);
623 $_[0]->on_read (sub {
624 $len -= length $_[0]{rbuf};
625
626 $arg{on_body}(delete $_[0]{rbuf}, \%hdr)
627 or $finish->(undef, { Status => 598, Reason => "Request cancelled by on_body", URL => $url });
628
629 $len > 0
630 or $finish->("", \%hdr);
631 });
632 } else {
633 $_[0]->on_eof (sub {
634 $finish->("", \%hdr);
635 });
636 $_[0]->on_read (sub {
637 $arg{on_body}(delete $_[0]{rbuf}, \%hdr)
638 or $finish->(undef, { Status => 598, Reason => "Request cancelled by on_body", URL => $url });
639 });
640 }
641 } else {
642 $_[0]->on_eof (undef);
643
644 if ($len) {
645 $_[0]->on_error (sub { $finish->(undef, { Status => 599, Reason => $_[2], URL => $url }) });
646 $_[0]->on_read (sub {
647 $finish->((substr delete $_[0]{rbuf}, 0, $len, ""), \%hdr)
648 if $len <= length $_[0]{rbuf};
649 });
650 } else {
651 $_[0]->on_error (sub {
652 $! == Errno::EPIPE
653 ? $finish->(delete $_[0]{rbuf}, \%hdr)
654 : $finish->(undef, { Status => 599, Reason => $_[2], URL => $url });
655 });
656 $_[0]->on_read (sub { });
657 }
658 }
409 } 659 }
410 }; 660 });
661 });
662 };
411 663
412 if ($hdr{Status} =~ /^(?:1..|204|304)$/ or $method eq "HEAD") { 664 # now handle proxy-CONNECT method
413 $finish->(undef, \%hdr); 665 if ($proxy && $uscheme eq "https") {
666 # oh dear, we have to wrap it into a connect request
667
668 # maybe re-use $uauthority with patched port?
669 $state{handle}->push_write ("CONNECT $uhost:$uport HTTP/1.0\015\012Host: $uhost\015\012\015\012");
670 $state{handle}->push_read (line => $qr_nlnl, sub {
671 $_[1] =~ /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\015\012]*) )?/ix
672 or return (%state = (), $cb->(undef, { Status => 599, Reason => "Invalid proxy connect response ($_[1])", URL => $url }));
673
674 if ($2 == 200) {
675 $rpath = $upath;
676 &$handle_actual_request;
414 } else { 677 } else {
415 if (exists $hdr{"content-length"}) { 678 %state = ();
416 $_[0]->unshift_read (chunk => $hdr{"content-length"}, sub { 679 $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 } 680 }
434 }); 681 });
682 } else {
683 &$handle_actual_request;
435 }); 684 }
685
436 }, sub { 686 }, sub {
437 $timeout 687 $timeout
438 }; 688 };
439 }; 689 };
440 690
441 defined wantarray && AnyEvent::Util::guard { %state = () } 691 defined wantarray && AnyEvent::Util::guard { %state = () }
442} 692}
443 693
444sub http_get($$;@) { 694sub http_get($@) {
445 unshift @_, "GET"; 695 unshift @_, "GET";
446 &http_request 696 &http_request
447} 697}
448 698
449sub http_head($$;@) { 699sub http_head($@) {
450 unshift @_, "HEAD"; 700 unshift @_, "HEAD";
451 &http_request 701 &http_request
452} 702}
453 703
454sub http_post($$$;@) { 704sub http_post($$@) {
705 my $url = shift;
455 unshift @_, "POST", "body"; 706 unshift @_, "POST", $url, "body";
456 &http_request 707 &http_request
457} 708}
458 709
459=back 710=back
460 711
472The default value for the C<recurse> request parameter (default: C<10>). 723The default value for the C<recurse> request parameter (default: C<10>).
473 724
474=item $AnyEvent::HTTP::USERAGENT 725=item $AnyEvent::HTTP::USERAGENT
475 726
476The default value for the C<User-Agent> header (the default is 727The 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)>). 728C<Mozilla/5.0 (compatible; U; AnyEvent-HTTP/$VERSION; +http://software.schmorp.de/pkg/AnyEvent)>).
478 729
479=item $AnyEvent::HTTP::MAX_PERSISTENT 730=item $AnyEvent::HTTP::MAX_PERSISTENT
480 731
481The maximum number of persistent connections to keep open (default: 8). 732The maximum number of persistent connections to keep open (default: 8).
482 733
485=item $AnyEvent::HTTP::PERSISTENT_TIMEOUT 736=item $AnyEvent::HTTP::PERSISTENT_TIMEOUT
486 737
487The maximum time to cache a persistent connection, in seconds (default: 2). 738The maximum time to cache a persistent connection, in seconds (default: 2).
488 739
489Not implemented currently. 740Not implemented currently.
741
742=item $AnyEvent::HTTP::ACTIVE
743
744The number of active connections. This is not the number of currently
745running requests, but the number of currently open and non-idle TCP
746connections. This number of can be useful for load-leveling.
490 747
491=back 748=back
492 749
493=cut 750=cut
494 751
503 760
504L<AnyEvent>. 761L<AnyEvent>.
505 762
506=head1 AUTHOR 763=head1 AUTHOR
507 764
508 Marc Lehmann <schmorp@schmorp.de> 765 Marc Lehmann <schmorp@schmorp.de>
509 http://home.schmorp.de/ 766 http://home.schmorp.de/
767
768With many thanks to Дмитрий Шалашов, who provided countless
769testcases and bugreports.
510 770
511=cut 771=cut
512 772
5131 7731
514 774

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines