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.10 by root, Thu Jun 5 13:06:43 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.
13 17
18This module implements a simple, stateless and non-blocking HTTP
19client. It supports GET, POST and other request methods, cookies and more,
20all on a very low level. It can follow redirects supports proxies and
21automatically limits the number of connections to the values specified in
22the RFC.
23
24It should generally be a "good client" that is enough for most HTTP
25tasks. Simple tasks should be simple, but complex tasks should still be
26possible as the user retains control over request and response headers.
27
28The caller is responsible for authentication management, cookies (if
29the simplistic implementation in this module doesn't suffice), referer
30and other high-level protocol details for which this module offers only
31limited support.
32
14=head2 METHODS 33=head2 METHODS
15 34
16=over 4 35=over 4
17 36
18=cut 37=cut
20package AnyEvent::HTTP; 39package AnyEvent::HTTP;
21 40
22use strict; 41use strict;
23no warnings; 42no warnings;
24 43
25use Carp; 44use Errno ();
26 45
27use AnyEvent (); 46use AnyEvent 4.452 ();
28use AnyEvent::Util (); 47use AnyEvent::Util ();
29use AnyEvent::Socket (); 48use AnyEvent::Socket ();
30use AnyEvent::Handle (); 49use AnyEvent::Handle ();
31 50
32use base Exporter::; 51use base Exporter::;
33 52
34our $VERSION = '1.0'; 53our $VERSION = '1.12';
35 54
36our @EXPORT = qw(http_get http_request); 55our @EXPORT = qw(http_get http_post http_head http_request);
37 56
38our $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)";
39our $MAX_RECURSE = 10; 58our $MAX_RECURSE = 10;
40our $MAX_PERSISTENT = 8; 59our $MAX_PERSISTENT = 8;
41our $PERSISTENT_TIMEOUT = 2; 60our $PERSISTENT_TIMEOUT = 2;
42our $TIMEOUT = 300; 61our $TIMEOUT = 300;
43 62
44# changing these is evil 63# changing these is evil
45our $MAX_PERSISTENT_PER_HOST = 2; 64our $MAX_PERSISTENT_PER_HOST = 2;
46our $MAX_PER_HOST = 4; # not respected yet :( 65our $MAX_PER_HOST = 4;
47 66
48our $PROXY; 67our $PROXY;
68our $ACTIVE = 0;
49 69
50my %KA_COUNT; # number of open keep-alive connections per host 70my %KA_COUNT; # number of open keep-alive connections per host
71my %CO_SLOT; # number of open connections, and wait queue, per host
51 72
52=item http_get $url, key => value..., $cb->($data, $headers) 73=item http_get $url, key => value..., $cb->($data, $headers)
53 74
54Executes 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
55additional parameters. 76additional parameters and the return value.
56 77
57=item http_head $url, key => value..., $cb->($data, $headers) 78=item http_head $url, key => value..., $cb->($data, $headers)
58 79
59Executes an HTTP-HEAD request. See the http_request function for details on 80Executes an HTTP-HEAD request. See the http_request function for details
60additional parameters. 81on additional parameters and the return value.
61 82
62=item http_post $url, $body, key => value..., $cb->($data, $headers) 83=item http_post $url, $body, key => value..., $cb->($data, $headers)
63 84
64Executes 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
65http_request function for details on additional parameters. 86http_request function for details on additional parameters and the return
87value.
66 88
67=item http_request $method => $url, key => value..., $cb->($data, $headers) 89=item http_request $method => $url, key => value..., $cb->($data, $headers)
68 90
69Executes 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
70must 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.
71 98
72The callback will be called with the response data as first argument 99The callback will be called with the response data as first argument
73(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
74response headers as second argument. 101response headers as second argument.
75 102
76All 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
77headers, the three "pseudo-headers" C<HTTPVersion>, C<Status> and 104headers, the "pseudo-headers" C<HTTPVersion>, C<Status> and C<Reason>
78C<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
79name. If the server sends a header multiple lines, then their contents 109If the server sends a header multiple times, then their contents will be
80will be joined together with C<\x00>. 110joined together with a comma (C<,>), as per the HTTP spec.
81 111
82If 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,
83then 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>
84and 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.
85 116
86A typical callback might look like this: 117A typical callback might look like this:
87 118
88 sub { 119 sub {
89 my ($body, $hdr) = @_; 120 my ($body, $hdr) = @_;
105Whether to recurse requests or not, e.g. on redirects, authentication 136Whether to recurse requests or not, e.g. on redirects, authentication
106retries and so on, and how often to do so. 137retries and so on, and how often to do so.
107 138
108=item headers => hashref 139=item headers => hashref
109 140
110The 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:>.
111 144
112=item timeout => $seconds 145=item timeout => $seconds
113 146
114The 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
115the 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.
133based on the original netscape specification. 166based on the original netscape specification.
134 167
135The 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
136get updated automatically. It is possible to save the cookie_jar to 169get updated automatically. It is possible to save the cookie_jar to
137persistent storage with something like JSON or Storable, but this is not 170persistent storage with something like JSON or Storable, but this is not
138recommended, as expire times are currently being ignored. 171recommended, as expiry times are currently being ignored.
139 172
140Note that this cookie implementation is not of very high quality, nor 173Note that this cookie implementation is not of very high quality, nor
141meant 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
142do 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
143cookie-using sites working. Cookies are a privacy disaster, do not use 176cookie-using sites working. Cookies are a privacy disaster, do not use
144them 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.
145 242
146=back 243=back
147 244
148Example: make a simple HTTP GET request for http://www.nethype.de/ 245Example: make a simple HTTP GET request for http://www.nethype.de/
149 246
163 use Data::Dumper; 260 use Data::Dumper;
164 print Dumper $hdr; 261 print Dumper $hdr;
165 } 262 }
166 ; 263 ;
167 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
168=cut 275=cut
169 276
277sub _slot_schedule;
278sub _slot_schedule($) {
279 my $host = shift;
280
281 while ($CO_SLOT{$host}[0] < $MAX_PER_HOST) {
282 if (my $cb = shift @{ $CO_SLOT{$host}[1] }) {
283 # somebody wants that slot
284 ++$CO_SLOT{$host}[0];
285 ++$ACTIVE;
286
287 $cb->(AnyEvent::Util::guard {
288 --$ACTIVE;
289 --$CO_SLOT{$host}[0];
290 _slot_schedule $host;
291 });
292 } else {
293 # nobody wants the slot, maybe we can forget about it
294 delete $CO_SLOT{$host} unless $CO_SLOT{$host}[0];
295 last;
296 }
297 }
298}
299
300# wait for a free slot on host, call callback
301sub _get_slot($$) {
302 push @{ $CO_SLOT{$_[0]}[1] }, $_[1];
303
304 _slot_schedule $_[0];
305}
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
170sub http_request($$$;@) { 313sub http_request($$@) {
171 my $cb = pop; 314 my $cb = pop;
172 my ($method, $url, %arg) = @_; 315 my ($method, $url, %arg) = @_;
173 316
174 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";
175 321
176 $method = uc $method; 322 $method = uc $method;
177 323
178 if (my $hdr = $arg{headers}) { 324 if (my $hdr = $arg{headers}) {
179 while (my ($k, $v) = each %$hdr) { 325 while (my ($k, $v) = each %$hdr) {
180 $hdr{lc $k} = $v; 326 $hdr{lc $k} = $v;
181 } 327 }
182 } 328 }
183 329
184 my $recurse = exists $arg{recurse} ? $arg{recurse} : $MAX_RECURSE; 330 my $recurse = exists $arg{recurse} ? delete $arg{recurse} : $MAX_RECURSE;
185 331
186 return $cb->(undef, { Status => 599, Reason => "recursion limit reached" }) 332 return $cb->(undef, { Status => 599, Reason => "Too many redirections", URL => $url })
187 if $recurse < 0; 333 if $recurse < 0;
188 334
189 my $proxy = $arg{proxy} || $PROXY; 335 my $proxy = $arg{proxy} || $PROXY;
190 my $timeout = $arg{timeout} || $TIMEOUT; 336 my $timeout = $arg{timeout} || $TIMEOUT;
191 337
192 $hdr{"user-agent"} ||= $USERAGENT;
193
194 my ($scheme, $authority, $upath, $query, $fragment) = 338 my ($uscheme, $uauthority, $upath, $query, $fragment) =
195 $url =~ m|(?:([^:/?#]+):)?(?://([^/?#]*))?([^?#]*)(?:\?([^#]*))?(?:#(.*))?|; 339 $url =~ m|(?:([^:/?#]+):)?(?://([^/?#]*))?([^?#]*)(?:\?([^#]*))?(?:#(.*))?|;
196 340
197 $scheme = lc $scheme; 341 $uscheme = lc $uscheme;
198 342
199 my $uport = $scheme eq "http" ? 80 343 my $uport = $uscheme eq "http" ? 80
200 : $scheme eq "https" ? 443 344 : $uscheme eq "https" ? 443
201 : 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 });
202 346
203 $authority =~ /^(?: .*\@ )? ([^\@:]+) (?: : (\d+) )?$/x 347 $uauthority =~ /^(?: .*\@ )? ([^\@:]+) (?: : (\d+) )?$/x
204 or return $cb->(undef, { Status => 599, Reason => "unparsable URL" }); 348 or return $cb->(undef, { Status => 599, Reason => "Unparsable URL", URL => $url });
205 349
206 my $uhost = $1; 350 my $uhost = $1;
207 $uport = $2 if defined $2; 351 $uport = $2 if defined $2;
208 352
209 $uhost =~ s/^\[(.*)\]$/$1/; 353 $uhost =~ s/^\[(.*)\]$/$1/;
211 355
212 $upath =~ s%^/?%/%; 356 $upath =~ s%^/?%/%;
213 357
214 # cookie processing 358 # cookie processing
215 if (my $jar = $arg{cookie_jar}) { 359 if (my $jar = $arg{cookie_jar}) {
216 %$jar = () if $jar->{version} < 1; 360 %$jar = () if $jar->{version} != 1;
217 361
218 my @cookie; 362 my @cookie;
219 363
220 while (my ($chost, $v) = each %$jar) { 364 while (my ($chost, $v) = each %$jar) {
365 if ($chost =~ /^\./) {
221 next unless $chost eq substr $uhost, -length $chost; 366 next unless $chost eq substr $uhost, -length $chost;
222 next unless $chost =~ /^\./; 367 } elsif ($chost =~ /\./) {
368 next unless $chost eq $uhost;
369 } else {
370 next;
371 }
223 372
224 while (my ($cpath, $v) = each %$v) { 373 while (my ($cpath, $v) = each %$v) {
225 next unless $cpath eq substr $upath, 0, length $cpath; 374 next unless $cpath eq substr $upath, 0, length $cpath;
226 375
227 while (my ($k, $v) = each %$v) { 376 while (my ($k, $v) = each %$v) {
228 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;
229 push @cookie, "$k=$v->{value}"; 380 push @cookie, "$k=\"$value\"";
230 } 381 }
231 } 382 }
232 } 383 }
233 384
234 $hdr{cookie} = join "; ", @cookie 385 $hdr{cookie} = join "; ", @cookie
235 if @cookie; 386 if @cookie;
236 } 387 }
237 388
238 my ($rhost, $rport, $rpath); # request host, port, path 389 my ($rhost, $rport, $rscheme, $rpath); # request host, port, path
239 390
240 if ($proxy) { 391 if ($proxy) {
241 ($rhost, $rport, $scheme) = @$proxy; 392 ($rpath, $rhost, $rport, $rscheme) = ($url, @$proxy);
242 $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";
243 } else { 397 } else {
244 ($rhost, $rport, $rpath) = ($uhost, $uport, $upath); 398 ($rhost, $rport, $rscheme, $rpath) = ($uhost, $uport, $uscheme, $upath);
245 $hdr{host} = $uhost;
246 } 399 }
247 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";
248 $hdr{"content-length"} = length $arg{body}; 405 $hdr{"content-length"} = length $arg{body};
249 406
250 my %state; 407 my %state = (connect_guard => 1);
251 408
409 _get_slot $uhost, sub {
410 $state{slot_guard} = shift;
411
412 return unless $state{connect_guard};
413
252 $state{connect_guard} = AnyEvent::Socket::tcp_connect $rhost, $rport, sub { 414 $state{connect_guard} = AnyEvent::Socket::tcp_connect $rhost, $rport, sub {
253 $state{fh} = shift 415 $state{fh} = shift
254 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
255 418
256 delete $state{connect_guard}; # reduce memory usage, save a tree 419 return unless delete $state{connect_guard};
257 420
258 # get handle 421 # get handle
259 $state{handle} = new AnyEvent::Handle 422 $state{handle} = new AnyEvent::Handle
260 fh => $state{fh}, 423 fh => $state{fh},
261 ($scheme eq "https" ? (tls => "connect") : ()); 424 timeout => $timeout,
425 peername => $rhost,
426 tls_ctx => $arg{tls_ctx};
262 427
263 # limit the number of persistent connections 428 # limit the number of persistent connections
429 # keepalive not yet supported
264 if ($KA_COUNT{$_[1]} < $MAX_PERSISTENT_PER_HOST) { 430 if ($KA_COUNT{$_[1]} < $MAX_PERSISTENT_PER_HOST) {
265 ++$KA_COUNT{$_[1]}; 431 ++$KA_COUNT{$_[1]};
266 $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 };
267 $hdr{connection} = "keep-alive"; 435 $hdr{connection} = "keep-alive";
268 delete $hdr{connection}; # keep-alive not yet supported
269 } else { 436 } else {
270 delete $hdr{connection}; 437 delete $hdr{connection};
271 } 438 }
272 439
273 # (re-)configure handle 440 # (re-)configure handle
274 $state{handle}->timeout ($timeout);
275 $state{handle}->on_error (sub { 441 $state{handle}->on_error (sub {
276 %state = (); 442 %state = ();
277 $cb->(undef, { Status => 599, Reason => "$!" }); 443 $cb->(undef, { Status => 599, Reason => $_[2], URL => $url });
278 }); 444 });
279 $state{handle}->on_eof (sub { 445 $state{handle}->on_eof (sub {
280 %state = (); 446 %state = ();
281 $cb->(undef, { Status => 599, Reason => "unexpected end-of-file" }); 447 $cb->(undef, { Status => 599, Reason => "Unexpected end-of-file", URL => $url });
282 });
283
284 # send request
285 $state{handle}->push_write (
286 "$method $rpath HTTP/1.0\015\012"
287 . (join "", map "$_: $hdr{$_}\015\012", keys %hdr)
288 . "\015\012"
289 . (delete $arg{body})
290 );
291
292 %hdr = (); # reduce memory usage, save a kitten
293
294 # status line
295 $state{handle}->push_read (line => qr/\015?\012/, sub {
296 $_[1] =~ /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) \s+ ([^\015\012]+)/ix
297 or return (%state = (), $cb->(undef, { Status => 599, Reason => "invalid server response ($_[1])" }));
298
299 my %hdr = ( # response headers
300 HTTPVersion => "\x00$1",
301 Status => "\x00$2",
302 Reason => "\x00$3",
303 ); 448 });
304 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
456 # send request
457 $state{handle}->push_write (
458 "$method $rpath HTTP/1.0\015\012"
459 . (join "", map "\u$_: $hdr{$_}\015\012", keys %hdr)
460 . "\015\012"
461 . (delete $arg{body})
462 );
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
305 # headers, could be optimized a bit 478 # headers, could be optimized a bit
306 $state{handle}->unshift_read (line => qr/\015?\012\015?\012/, sub { 479 $state{handle}->unshift_read (line => $qr_nlnl, sub {
307 for ("$_[1]\012") { 480 for ("$_[1]\012") {
308 # 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.
309 # creates them. 482
483 # things seen, not parsed:
484 # p3pP="NON CUR OTPi OUR NOR UNI"
485
310 $hdr{lc $1} .= "\x00$2" 486 $hdr{lc $1} .= ",$2"
311 while /\G 487 while /\G
312 ([^:\000-\037]+): 488 ([^:\000-\037]+):
313 [\011\040]* 489 [\011\040]*
314 ((?: [^\015\012]+ | \015?\012[\011\040] )*) 490 ((?: [^\012]+ | \012[\011\040] )*)
315 \015?\012 491 \012
316 /gxc; 492 /gxc;
317 493
318 /\G$/ 494 /\G$/
319 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 }));
320 }
321
322 substr $_, 0, 1, ""
323 for values %hdr;
324
325 my $finish = sub {
326 %state = ();
327
328 # set-cookie processing
329 if ($arg{cookie_jar} && exists $hdr{"set-cookie"}) {
330 for (split /\x00/, $hdr{"set-cookie"}) {
331 my ($cookie, @arg) = split /;\s*/;
332 my ($name, $value) = split /=/, $cookie, 2;
333 my %kv = (value => $value, map { split /=/, $_, 2 } @arg);
334
335 my $cdom = (delete $kv{domain}) || $uhost;
336 my $cpath = (delete $kv{path}) || "/";
337
338 $cdom =~ s/^.?/./; # make sure it starts with a "."
339
340 my $ndots = $cdom =~ y/.//;
341 next if $ndots < ($cdom =~ /[^.]{3}$/ ? 2 : 3);
342
343 # store it
344 $arg{cookie_jar}{version} = 1;
345 $arg{cookie_jar}{$cdom}{$cpath}{$name} = \%kv;
346 } 496 }
497
498 substr $_, 0, 1, ""
499 for values %hdr;
500
501 # redirect handling
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/^\.\/+//;
506
507 my $url = "$rscheme://$uhost:$uport";
508
509 unless ($hdr{location} =~ s/^\///) {
510 $url .= $upath;
511 $url =~ s/\/[^\/]*$//;
512 }
513
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
523 $redirect = 1;
524 } elsif ($hdr{Status} == 303) {
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;
530 }
531 }
532
533 my $finish = sub {
534 $state{handle}->destroy if $state{handle};
535 %state = ();
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
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);
608 } else {
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 }
659 }
660 });
661 });
662 };
663
664 # now handle proxy-CONNECT method
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;
677 } else {
678 %state = ();
679 $cb->(undef, { Status => $2, Reason => $3, URL => $url });
347 } 680 }
348
349 if ($_[1]{Status} =~ /^x30[12]$/ && $recurse) {
350 # microsoft and other assholes don't give a shit for following standards,
351 # try to support a common form of broken Location header.
352 $_[1]{location} =~ s%^/%$scheme://$uhost:$uport/%;
353
354 http_request ($method, $_[1]{location}, %arg, recurse => $recurse - 1, $cb);
355 } else {
356 $cb->($_[0], $_[1]);
357 }
358 }; 681 });
359
360 if ($hdr{Status} =~ /^(?:1..|204|304)$/ or $method eq "HEAD") {
361 $finish->(undef, \%hdr);
362 } else { 682 } else {
363 if (exists $hdr{"content-length"}) { 683 &$handle_actual_request;
364 $_[0]->unshift_read (chunk => $hdr{"content-length"}, sub {
365 # could cache persistent connection now
366 if ($hdr{connection} =~ /\bkeep-alive\b/i) {
367 # but we don't, due to misdesigns, this is annoyingly complex
368 };
369
370 $finish->($_[1], \%hdr);
371 });
372 } else {
373 # too bad, need to read until we get an error or EOF,
374 # no way to detect winged data.
375 $_[0]->on_error (sub {
376 $finish->($_[0]{rbuf}, \%hdr);
377 });
378 $_[0]->on_eof (undef);
379 $_[0]->on_read (sub { });
380 }
381 }
382 }); 684 }
685
686 }, sub {
687 $timeout
383 }); 688 };
384 }, sub {
385 $timeout
386 }; 689 };
387 690
388 defined wantarray && AnyEvent::Util::guard { %state = () } 691 defined wantarray && AnyEvent::Util::guard { %state = () }
389} 692}
390 693
391sub http_get($$;@) { 694sub http_get($@) {
392 unshift @_, "GET"; 695 unshift @_, "GET";
393 &http_request 696 &http_request
394} 697}
395 698
396sub http_head($$;@) { 699sub http_head($@) {
397 unshift @_, "HEAD"; 700 unshift @_, "HEAD";
398 &http_request 701 &http_request
399} 702}
400 703
401sub http_post($$$;@) { 704sub http_post($$@) {
705 my $url = shift;
402 unshift @_, "POST", "body"; 706 unshift @_, "POST", $url, "body";
403 &http_request 707 &http_request
404} 708}
405 709
406=back 710=back
407 711
419The default value for the C<recurse> request parameter (default: C<10>). 723The default value for the C<recurse> request parameter (default: C<10>).
420 724
421=item $AnyEvent::HTTP::USERAGENT 725=item $AnyEvent::HTTP::USERAGENT
422 726
423The default value for the C<User-Agent> header (the default is 727The default value for the C<User-Agent> header (the default is
424C<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)>).
425 729
426=item $AnyEvent::HTTP::MAX_PERSISTENT 730=item $AnyEvent::HTTP::MAX_PERSISTENT
427 731
428The maximum number of persistent connections to keep open (default: 8). 732The maximum number of persistent connections to keep open (default: 8).
429 733
432=item $AnyEvent::HTTP::PERSISTENT_TIMEOUT 736=item $AnyEvent::HTTP::PERSISTENT_TIMEOUT
433 737
434The maximum time to cache a persistent connection, in seconds (default: 2). 738The maximum time to cache a persistent connection, in seconds (default: 2).
435 739
436Not 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.
437 747
438=back 748=back
439 749
440=cut 750=cut
441 751
450 760
451L<AnyEvent>. 761L<AnyEvent>.
452 762
453=head1 AUTHOR 763=head1 AUTHOR
454 764
455 Marc Lehmann <schmorp@schmorp.de> 765 Marc Lehmann <schmorp@schmorp.de>
456 http://home.schmorp.de/ 766 http://home.schmorp.de/
767
768With many thanks to Дмитрий Шалашов, who provided countless
769testcases and bugreports.
457 770
458=cut 771=cut
459 772
4601 7731
461 774

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines