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.8 by root, Wed Jun 4 12:32:30 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.
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.8 ();
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.4';
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 = 0;
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.
71 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
72The callback will be called with the response data as first argument 99The callback will be called with the response body 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 an error occured), and a hash-ref with response headers as
74response headers as second argument. 101second 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
79name. 106pseudo-header C<URL> contains the original URL (which can differ from the
107requested URL when following redirects).
108
109If the server sends a header multiple times, then their contents will be
110joined together with a comma (C<,>), as per the HTTP spec.
80 111
81If 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,
82then 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>
83and 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.
84 116
85A typical callback might look like this: 117A typical callback might look like this:
86 118
87 sub { 119 sub {
88 my ($body, $hdr) = @_; 120 my ($body, $hdr) = @_;
104Whether to recurse requests or not, e.g. on redirects, authentication 136Whether to recurse requests or not, e.g. on redirects, authentication
105retries and so on, and how often to do so. 137retries and so on, and how often to do so.
106 138
107=item headers => hashref 139=item headers => hashref
108 140
109The 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:>.
110 144
111=item timeout => $seconds 145=item timeout => $seconds
112 146
113The 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
114the 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.
124=item body => $string 158=item body => $string
125 159
126The request body, usually empty. Will be-sent as-is (future versions of 160The request body, usually empty. Will be-sent as-is (future versions of
127this module might offer more options). 161this module might offer more options).
128 162
163=item cookie_jar => $hash_ref
164
165Passing this parameter enables (simplified) cookie-processing, loosely
166based on the original netscape specification.
167
168The C<$hash_ref> must be an (initially empty) hash reference which will
169get updated automatically. It is possible to save the cookie_jar to
170persistent storage with something like JSON or Storable, but this is not
171recommended, as expiry times are currently being ignored.
172
173Note that this cookie implementation is not of very high quality, nor
174meant to be complete. If you want complete cookie management you have to
175do that on your own. C<cookie_jar> is meant as a quick fix to get some
176cookie-using sites working. Cookies are a privacy disaster, do not use
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.
249
129=back 250=back
130 251
131=back 252Example: make a simple HTTP GET request for http://www.nethype.de/
253
254 http_request GET => "http://www.nethype.de/", sub {
255 my ($body, $hdr) = @_;
256 print "$body\n";
257 };
258
259Example: make a HTTP HEAD request on https://www.google.com/, use a
260timeout of 30 seconds.
261
262 http_request
263 GET => "https://www.google.com",
264 timeout => 30,
265 sub {
266 my ($body, $hdr) = @_;
267 use Data::Dumper;
268 print Dumper $hdr;
269 }
270 ;
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;
132 281
133=cut 282=cut
134 283
284sub _slot_schedule;
285sub _slot_schedule($) {
286 my $host = shift;
287
288 while ($CO_SLOT{$host}[0] < $MAX_PER_HOST) {
289 if (my $cb = shift @{ $CO_SLOT{$host}[1] }) {
290 # somebody wants that slot
291 ++$CO_SLOT{$host}[0];
292 ++$ACTIVE;
293
294 $cb->(AnyEvent::Util::guard {
295 --$ACTIVE;
296 --$CO_SLOT{$host}[0];
297 _slot_schedule $host;
298 });
299 } else {
300 # nobody wants the slot, maybe we can forget about it
301 delete $CO_SLOT{$host} unless $CO_SLOT{$host}[0];
302 last;
303 }
304 }
305}
306
307# wait for a free slot on host, call callback
308sub _get_slot($$) {
309 push @{ $CO_SLOT{$_[0]}[1] }, $_[1];
310
311 _slot_schedule $_[0];
312}
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
135sub http_request($$$;@) { 320sub http_request($$@) {
136 my $cb = pop; 321 my $cb = pop;
137 my ($method, $url, %arg) = @_; 322 my ($method, $url, %arg) = @_;
138 323
139 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";
140 328
141 $method = uc $method; 329 $method = uc $method;
142 330
143 if (my $hdr = $arg{headers}) { 331 if (my $hdr = $arg{headers}) {
144 while (my ($k, $v) = each %$hdr) { 332 while (my ($k, $v) = each %$hdr) {
145 $hdr{lc $k} = $v; 333 $hdr{lc $k} = $v;
146 } 334 }
147 } 335 }
148 336
149 my $recurse = exists $arg{recurse} ? $arg{recurse} : $MAX_RECURSE; 337 my $recurse = exists $arg{recurse} ? delete $arg{recurse} : $MAX_RECURSE;
150 338
151 return $cb->(undef, { Status => 599, Reason => "recursion limit reached" }) 339 return $cb->(undef, { Status => 599, Reason => "Too many redirections", URL => $url })
152 if $recurse < 0; 340 if $recurse < 0;
153 341
154 my $proxy = $arg{proxy} || $PROXY; 342 my $proxy = $arg{proxy} || $PROXY;
155 my $timeout = $arg{timeout} || $TIMEOUT; 343 my $timeout = $arg{timeout} || $TIMEOUT;
156 344
345 my ($uscheme, $uauthority, $upath, $query, $fragment) =
346 $url =~ m|(?:([^:/?#]+):)?(?://([^/?#]*))?([^?#]*)(?:\?([^#]*))?(?:#(.*))?|;
347
348 $uscheme = lc $uscheme;
349
350 my $uport = $uscheme eq "http" ? 80
351 : $uscheme eq "https" ? 443
352 : return $cb->(undef, { Status => 599, Reason => "Only http and https URL schemes supported", URL => $url });
353
354 $uauthority =~ /^(?: .*\@ )? ([^\@:]+) (?: : (\d+) )?$/x
355 or return $cb->(undef, { Status => 599, Reason => "Unparsable URL", URL => $url });
356
357 my $uhost = $1;
358 $uport = $2 if defined $2;
359
360 $hdr{host} = defined $2 ? "$uhost:$2" : "$uhost";
361
362 $uhost =~ s/^\[(.*)\]$/$1/;
363 $upath .= "?$query" if length $query;
364
365 $upath =~ s%^/?%/%;
366
367 # cookie processing
368 if (my $jar = $arg{cookie_jar}) {
369 %$jar = () if $jar->{version} != 1;
370
371 my @cookie;
372
373 while (my ($chost, $v) = each %$jar) {
374 if ($chost =~ /^\./) {
375 next unless $chost eq substr $uhost, -length $chost;
376 } elsif ($chost =~ /\./) {
377 next unless $chost eq $uhost;
378 } else {
379 next;
380 }
381
382 while (my ($cpath, $v) = each %$v) {
383 next unless $cpath eq substr $upath, 0, length $cpath;
384
385 while (my ($k, $v) = each %$v) {
386 next if $uscheme ne "https" && exists $v->{secure};
387 my $value = $v->{value};
388 $value =~ s/([\\"])/\\$1/g;
389 push @cookie, "$k=\"$value\"";
390 }
391 }
392 }
393
394 $hdr{cookie} = join "; ", @cookie
395 if @cookie;
396 }
397
398 my ($rhost, $rport, $rscheme, $rpath); # request host, port, path
399
400 if ($proxy) {
401 ($rpath, $rhost, $rport, $rscheme) = ($url, @$proxy);
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";
406 } else {
407 ($rhost, $rport, $rscheme, $rpath) = ($uhost, $uport, $uscheme, $upath);
408 }
409
157 $hdr{"user-agent"} ||= $USERAGENT; 410 $hdr{"user-agent"} ||= $USERAGENT;
158 411 $hdr{referer} ||= "$uscheme://$uauthority$upath"; # leave out fragment and query string, just a heuristic
159 my ($host, $port, $path, $scheme);
160
161 if ($proxy) {
162 ($host, $port, $scheme) = @$proxy;
163 $path = $url;
164 } else {
165 ($scheme, my $authority, $path, my $query, my $fragment) =
166 $url =~ m|(?:([^:/?#]+):)?(?://([^/?#]*))?([^?#]*)(?:\?([^#]*))?(?:#(.*))?|;
167
168 $port = $scheme eq "http" ? 80
169 : $scheme eq "https" ? 443
170 : return $cb->(undef, { Status => 599, Reason => "$url: only http and https URLs supported" });
171
172 $authority =~ /^(?: .*\@ )? ([^\@:]+) (?: : (\d+) )?$/x
173 or return $cb->(undef, { Status => 599, Reason => "$url: unparsable URL" });
174
175 $host = $1;
176 $port = $2 if defined $2;
177
178 $host =~ s/^\[(.*)\]$/$1/;
179 $path .= "?$query" if length $query;
180
181 $path = "/" unless $path;
182
183 $hdr{host} = $host = lc $host;
184 }
185
186 $scheme = lc $scheme;
187
188 my %state;
189 412
190 $hdr{"content-length"} = length $arg{body}; 413 $hdr{"content-length"} = length $arg{body};
191 414
415 my %state = (connect_guard => 1);
416
417 _get_slot $uhost, sub {
418 $state{slot_guard} = shift;
419
420 return unless $state{connect_guard};
421
192 $state{connect_guard} = AnyEvent::Socket::tcp_connect $host, $port, sub { 422 $state{connect_guard} = AnyEvent::Socket::tcp_connect $rhost, $rport, sub {
193 $state{fh} = shift 423 $state{fh} = shift
424 or do {
425 my $err = "$!";
426 %state = ();
194 or return $cb->(undef, { Status => 599, Reason => "$!" }); 427 return $cb->(undef, { Status => 599, Reason => $err, URL => $url });
428 };
195 429
196 delete $state{connect_guard}; # reduce memory usage, save a tree 430 pop; # free memory, save a tree
197 431
432 return unless delete $state{connect_guard};
433
198 # get handle 434 # get handle
199 $state{handle} = new AnyEvent::Handle 435 $state{handle} = new AnyEvent::Handle
200 fh => $state{fh}, 436 fh => $state{fh},
201 ($scheme eq "https" ? (tls => "connect") : ()); 437 timeout => $timeout,
438 peername => $rhost,
439 tls_ctx => $arg{tls_ctx};
202 440
203 # limit the number of persistent connections 441 # limit the number of persistent connections
442 # keepalive not yet supported
204 if ($KA_COUNT{$_[1]} < $MAX_PERSISTENT_PER_HOST) { 443 if ($KA_COUNT{$_[1]} < $MAX_PERSISTENT_PER_HOST) {
205 ++$KA_COUNT{$_[1]}; 444 ++$KA_COUNT{$_[1]};
206 $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 };
207 $hdr{connection} = "keep-alive"; 448 $hdr{connection} = "keep-alive";
208 delete $hdr{connection}; # keep-alive not yet supported
209 } else { 449 } else {
210 delete $hdr{connection}; 450 delete $hdr{connection};
211 } 451 }
212 452
213 # (re-)configure handle 453 # (re-)configure handle
214 $state{handle}->timeout ($timeout);
215 $state{handle}->on_error (sub { 454 $state{handle}->on_error (sub {
216 %state = (); 455 %state = ();
217 $cb->(undef, { Status => 599, Reason => "$!" }); 456 $cb->(undef, { Status => 599, Reason => $_[2], URL => $url });
218 }); 457 });
219 $state{handle}->on_eof (sub { 458 $state{handle}->on_eof (sub {
220 %state = (); 459 %state = ();
221 $cb->(undef, { Status => 599, Reason => "unexpected end-of-file" }); 460 $cb->(undef, { Status => 599, Reason => "Unexpected end-of-file", URL => $url });
222 });
223
224 # send request
225 $state{handle}->push_write (
226 "$method $path HTTP/1.0\015\012"
227 . (join "", map "$_: $hdr{$_}\015\012", keys %hdr)
228 . "\015\012"
229 . (delete $arg{body})
230 );
231
232 %hdr = (); # reduce memory usage, save a kitten
233
234 # status line
235 $state{handle}->push_read (line => qr/\015?\012/, sub {
236 $_[1] =~ /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) \s+ ([^\015\012]+)/ix
237 or return (%state = (), $cb->(undef, { Status => 599, Reason => "invalid server response ($_[1])" }));
238
239 my %hdr = ( # response headers
240 HTTPVersion => ",$1",
241 Status => ",$2",
242 Reason => ",$3",
243 ); 461 });
244 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
469 # send request
470 $state{handle}->push_write (
471 "$method $rpath HTTP/1.0\015\012"
472 . (join "", map "\u$_: $hdr{$_}\015\012", keys %hdr)
473 . "\015\012"
474 . (delete $arg{body})
475 );
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
245 # headers, could be optimized a bit 491 # headers, could be optimized a bit
246 $state{handle}->unshift_read (line => qr/\015?\012\015?\012/, sub { 492 $state{handle}->unshift_read (line => $qr_nlnl, sub {
247 for ("$_[1]\012") { 493 for ("$_[1]\012") {
248 # 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.
249 # creates them. 495
496 # things seen, not parsed:
497 # p3pP="NON CUR OTPi OUR NOR UNI"
498
250 $hdr{lc $1} .= ",$2" 499 $hdr{lc $1} .= ",$2"
251 while /\G 500 while /\G
252 ([^:\000-\037]+): 501 ([^:\000-\037]*):
253 [\011\040]* 502 [\011\040]*
254 ((?: [^\015\012]+ | \015?\012[\011\040] )*) 503 ((?: [^\012]+ | \012[\011\040] )*)
255 \015?\012 504 \012
256 /gxc; 505 /gxc;
257 506
258 /\G$/ 507 /\G$/
259 or return $cb->(undef, { Status => 599, Reason => "garbled response headers" }); 508 or return (%state = (), $cb->(undef, { Status => 599, Reason => "Garbled response headers", URL => $url }));
509 }
510
511 substr $_, 0, 1, ""
512 for values %hdr;
513
514 # redirect handling
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/^\.\/+//;
519
520 my $url = "$rscheme://$uhost:$uport";
521
522 unless ($hdr{location} =~ s/^\///) {
523 $url .= $upath;
524 $url =~ s/\/[^\/]*$//;
525 }
526
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
536 $redirect = 1;
537 } elsif ($hdr{Status} == 303) {
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;
543 }
544 }
545
546 my $finish = sub {
547 $state{handle}->destroy if $state{handle};
548 %state = ();
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
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);
621 } else {
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 }
672 }
673 });
260 } 674 });
675 };
261 676
262 substr $_, 0, 1, "" 677 # now handle proxy-CONNECT method
263 for values %hdr; 678 if ($proxy && $uscheme eq "https") {
679 # oh dear, we have to wrap it into a connect request
264 680
265 my $finish = sub { 681 # maybe re-use $uauthority with patched port?
266 if ($_[1]{Status} =~ /^30[12]$/ && $recurse) { 682 $state{handle}->push_write ("CONNECT $uhost:$uport HTTP/1.0\015\012Host: $uhost\015\012\015\012");
267 http_request ($method, $_[1]{location}, %arg, recurse => $recurse - 1, $cb); 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;
268 } else { 690 } else {
269 $cb->($_[0], $_[1]); 691 %state = ();
692 $cb->(undef, { Status => $2, Reason => $3, URL => $url });
270 } 693 }
271 }; 694 });
272
273 if ($hdr{Status} =~ /^(?:1..|204|304)$/ or $method eq "HEAD") {
274 %state = ();
275 $finish->(undef, \%hdr);
276 } else { 695 } else {
277 if (exists $hdr{"content-length"}) { 696 &$handle_actual_request;
278 $_[0]->unshift_read (chunk => $hdr{"content-length"}, sub {
279 # could cache persistent connection now
280 if ($hdr{connection} =~ /\bkeep-alive\b/i) {
281 # but we don't, due to misdesigns, this is annoyingly complex
282 };
283
284 %state = ();
285 $finish->($_[1], \%hdr);
286 });
287 } else {
288 # too bad, need to read until we get an error or EOF,
289 # no way to detect winged data.
290 $_[0]->on_error (sub {
291 %state = ();
292 $finish->($_[0]{rbuf}, \%hdr);
293 });
294 $_[0]->on_eof (undef);
295 $_[0]->on_read (sub { });
296 }
297 }
298 }); 697 }
698
699 }, sub {
700 $timeout
299 }); 701 };
300 }, sub {
301 $timeout
302 }; 702 };
303 703
304 defined wantarray && AnyEvent::Util::guard { %state = () } 704 defined wantarray && AnyEvent::Util::guard { %state = () }
305} 705}
306 706
307sub http_get($$;@) { 707sub http_get($@) {
308 unshift @_, "GET"; 708 unshift @_, "GET";
309 &http_request 709 &http_request
310} 710}
311 711
312sub http_head($$;@) { 712sub http_head($@) {
313 unshift @_, "HEAD"; 713 unshift @_, "HEAD";
314 &http_request 714 &http_request
315} 715}
316 716
317sub http_post($$$;@) { 717sub http_post($$@) {
718 my $url = shift;
318 unshift @_, "POST", "body"; 719 unshift @_, "POST", $url, "body";
319 &http_request 720 &http_request
320} 721}
321 722
723=back
724
322=head2 GLOBAL FUNCTIONS AND VARIABLES 725=head2 GLOBAL FUNCTIONS AND VARIABLES
323 726
324=over 4 727=over 4
325 728
326=item AnyEvent::HTTP::set_proxy "proxy-url" 729=item AnyEvent::HTTP::set_proxy "proxy-url"
333The default value for the C<recurse> request parameter (default: C<10>). 736The default value for the C<recurse> request parameter (default: C<10>).
334 737
335=item $AnyEvent::HTTP::USERAGENT 738=item $AnyEvent::HTTP::USERAGENT
336 739
337The default value for the C<User-Agent> header (the default is 740The default value for the C<User-Agent> header (the default is
338C<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)>).
339 742
340=item $AnyEvent::HTTP::MAX_PERSISTENT 743=item $AnyEvent::HTTP::MAX_PER_HOST
341 744
342The 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.
343 748
344Not implemented currently. 749The default value for this is C<4>, and it is highly advisable to not
750increase it.
345 751
346=item $AnyEvent::HTTP::PERSISTENT_TIMEOUT 752=item $AnyEvent::HTTP::ACTIVE
347 753
348The maximum time to cache a persistent connection, in seconds (default: 2). 754The number of active connections. This is not the number of currently
349 755running requests, but the number of currently open and non-idle TCP
350Not implemented currently. 756connections. This number of can be useful for load-leveling.
351 757
352=back 758=back
353 759
354=cut 760=cut
355 761
364 770
365L<AnyEvent>. 771L<AnyEvent>.
366 772
367=head1 AUTHOR 773=head1 AUTHOR
368 774
369 Marc Lehmann <schmorp@schmorp.de> 775 Marc Lehmann <schmorp@schmorp.de>
370 http://home.schmorp.de/ 776 http://home.schmorp.de/
777
778With many thanks to Дмитрий Шалашов, who provided countless
779testcases and bugreports.
371 780
372=cut 781=cut
373 782
3741 7831
375 784

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines