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.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
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->($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.
242
129=back 243=back
130 244
131=back 245Example: make a simple HTTP GET request for http://www.nethype.de/
246
247 http_request GET => "http://www.nethype.de/", sub {
248 my ($body, $hdr) = @_;
249 print "$body\n";
250 };
251
252Example: make a HTTP HEAD request on https://www.google.com/, use a
253timeout of 30 seconds.
254
255 http_request
256 GET => "https://www.google.com",
257 timeout => 30,
258 sub {
259 my ($body, $hdr) = @_;
260 use Data::Dumper;
261 print Dumper $hdr;
262 }
263 ;
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;
132 274
133=cut 275=cut
134 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
135sub http_request($$$;@) { 313sub http_request($$@) {
136 my $cb = pop; 314 my $cb = pop;
137 my ($method, $url, %arg) = @_; 315 my ($method, $url, %arg) = @_;
138 316
139 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";
140 321
141 $method = uc $method; 322 $method = uc $method;
142 323
143 if (my $hdr = $arg{headers}) { 324 if (my $hdr = $arg{headers}) {
144 while (my ($k, $v) = each %$hdr) { 325 while (my ($k, $v) = each %$hdr) {
145 $hdr{lc $k} = $v; 326 $hdr{lc $k} = $v;
146 } 327 }
147 } 328 }
148 329
149 my $recurse = exists $arg{recurse} ? $arg{recurse} : $MAX_RECURSE; 330 my $recurse = exists $arg{recurse} ? delete $arg{recurse} : $MAX_RECURSE;
150 331
151 return $cb->(undef, { Status => 599, Reason => "recursion limit reached" }) 332 return $cb->(undef, { Status => 599, Reason => "Too many redirections", URL => $url })
152 if $recurse < 0; 333 if $recurse < 0;
153 334
154 my $proxy = $arg{proxy} || $PROXY; 335 my $proxy = $arg{proxy} || $PROXY;
155 my $timeout = $arg{timeout} || $TIMEOUT; 336 my $timeout = $arg{timeout} || $TIMEOUT;
156 337
338 my ($uscheme, $uauthority, $upath, $query, $fragment) =
339 $url =~ m|(?:([^:/?#]+):)?(?://([^/?#]*))?([^?#]*)(?:\?([^#]*))?(?:#(.*))?|;
340
341 $uscheme = lc $uscheme;
342
343 my $uport = $uscheme eq "http" ? 80
344 : $uscheme eq "https" ? 443
345 : return $cb->(undef, { Status => 599, Reason => "Only http and https URL schemes supported", URL => $url });
346
347 $uauthority =~ /^(?: .*\@ )? ([^\@:]+) (?: : (\d+) )?$/x
348 or return $cb->(undef, { Status => 599, Reason => "Unparsable URL", URL => $url });
349
350 my $uhost = $1;
351 $uport = $2 if defined $2;
352
353 $uhost =~ s/^\[(.*)\]$/$1/;
354 $upath .= "?$query" if length $query;
355
356 $upath =~ s%^/?%/%;
357
358 # cookie processing
359 if (my $jar = $arg{cookie_jar}) {
360 %$jar = () if $jar->{version} != 1;
361
362 my @cookie;
363
364 while (my ($chost, $v) = each %$jar) {
365 if ($chost =~ /^\./) {
366 next unless $chost eq substr $uhost, -length $chost;
367 } elsif ($chost =~ /\./) {
368 next unless $chost eq $uhost;
369 } else {
370 next;
371 }
372
373 while (my ($cpath, $v) = each %$v) {
374 next unless $cpath eq substr $upath, 0, length $cpath;
375
376 while (my ($k, $v) = each %$v) {
377 next if $uscheme ne "https" && exists $v->{secure};
378 my $value = $v->{value};
379 $value =~ s/([\\"])/\\$1/g;
380 push @cookie, "$k=\"$value\"";
381 }
382 }
383 }
384
385 $hdr{cookie} = join "; ", @cookie
386 if @cookie;
387 }
388
389 my ($rhost, $rport, $rscheme, $rpath); # request host, port, path
390
391 if ($proxy) {
392 ($rpath, $rhost, $rport, $rscheme) = ($url, @$proxy);
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";
397 } else {
398 ($rhost, $rport, $rscheme, $rpath) = ($uhost, $uport, $uscheme, $upath);
399 }
400
157 $hdr{"user-agent"} ||= $USERAGENT; 401 $hdr{"user-agent"} ||= $USERAGENT;
402 $hdr{referer} ||= "$uscheme://$uauthority$upath"; # leave out fragment and query string, just a heuristic
158 403
159 my ($host, $port, $path, $scheme); 404 $hdr{host} = "$uhost:$uport";
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
190 $hdr{"content-length"} = length $arg{body}; 405 $hdr{"content-length"} = length $arg{body};
191 406
407 my %state = (connect_guard => 1);
408
409 _get_slot $uhost, sub {
410 $state{slot_guard} = shift;
411
412 return unless $state{connect_guard};
413
192 $state{connect_guard} = AnyEvent::Socket::tcp_connect $host, $port, sub { 414 $state{connect_guard} = AnyEvent::Socket::tcp_connect $rhost, $rport, sub {
193 $state{fh} = shift 415 $state{fh} = shift
194 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
195 418
196 delete $state{connect_guard}; # reduce memory usage, save a tree 419 return unless delete $state{connect_guard};
197 420
198 # get handle 421 # get handle
199 $state{handle} = new AnyEvent::Handle 422 $state{handle} = new AnyEvent::Handle
200 fh => $state{fh}, 423 fh => $state{fh},
201 ($scheme eq "https" ? (tls => "connect") : ()); 424 timeout => $timeout,
425 peername => $rhost,
426 tls_ctx => $arg{tls_ctx};
202 427
203 # limit the number of persistent connections 428 # limit the number of persistent connections
429 # keepalive not yet supported
204 if ($KA_COUNT{$_[1]} < $MAX_PERSISTENT_PER_HOST) { 430 if ($KA_COUNT{$_[1]} < $MAX_PERSISTENT_PER_HOST) {
205 ++$KA_COUNT{$_[1]}; 431 ++$KA_COUNT{$_[1]};
206 $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 };
207 $hdr{connection} = "keep-alive"; 435 $hdr{connection} = "keep-alive";
208 delete $hdr{connection}; # keep-alive not yet supported
209 } else { 436 } else {
210 delete $hdr{connection}; 437 delete $hdr{connection};
211 } 438 }
212 439
213 # (re-)configure handle 440 # (re-)configure handle
214 $state{handle}->timeout ($timeout);
215 $state{handle}->on_error (sub { 441 $state{handle}->on_error (sub {
216 %state = (); 442 %state = ();
217 $cb->(undef, { Status => 599, Reason => "$!" }); 443 $cb->(undef, { Status => 599, Reason => $_[2], URL => $url });
218 }); 444 });
219 $state{handle}->on_eof (sub { 445 $state{handle}->on_eof (sub {
220 %state = (); 446 %state = ();
221 $cb->(undef, { Status => 599, Reason => "unexpected end-of-file" }); 447 $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 ); 448 });
244 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
245 # headers, could be optimized a bit 478 # headers, could be optimized a bit
246 $state{handle}->unshift_read (line => qr/\015?\012\015?\012/, sub { 479 $state{handle}->unshift_read (line => $qr_nlnl, sub {
247 for ("$_[1]\012") { 480 for ("$_[1]\012") {
248 # 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.
249 # creates them. 482
483 # things seen, not parsed:
484 # p3pP="NON CUR OTPi OUR NOR UNI"
485
250 $hdr{lc $1} .= ",$2" 486 $hdr{lc $1} .= ",$2"
251 while /\G 487 while /\G
252 ([^:\000-\037]+): 488 ([^:\000-\037]+):
253 [\011\040]* 489 [\011\040]*
254 ((?: [^\015\012]+ | \015?\012[\011\040] )*) 490 ((?: [^\012]+ | \012[\011\040] )*)
255 \015?\012 491 \012
256 /gxc; 492 /gxc;
257 493
258 /\G$/ 494 /\G$/
259 or return $cb->(undef, { Status => 599, Reason => "garbled response headers" }); 495 or return (%state = (), $cb->(undef, { Status => 599, Reason => "Garbled response headers", URL => $url }));
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 });
260 } 661 });
662 };
261 663
262 substr $_, 0, 1, "" 664 # now handle proxy-CONNECT method
263 for values %hdr; 665 if ($proxy && $uscheme eq "https") {
666 # oh dear, we have to wrap it into a connect request
264 667
265 my $finish = sub { 668 # maybe re-use $uauthority with patched port?
266 if ($_[1]{Status} =~ /^30[12]$/ && $recurse) { 669 $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); 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;
268 } else { 677 } else {
269 $cb->($_[0], $_[1]); 678 %state = ();
679 $cb->(undef, { Status => $2, Reason => $3, URL => $url });
270 } 680 }
271 }; 681 });
272
273 if ($hdr{Status} =~ /^(?:1..|204|304)$/ or $method eq "HEAD") {
274 %state = ();
275 $finish->(undef, \%hdr);
276 } else { 682 } else {
277 if (exists $hdr{"content-length"}) { 683 &$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 }); 684 }
685
686 }, sub {
687 $timeout
299 }); 688 };
300 }, sub {
301 $timeout
302 }; 689 };
303 690
304 defined wantarray && AnyEvent::Util::guard { %state = () } 691 defined wantarray && AnyEvent::Util::guard { %state = () }
305} 692}
306 693
307sub http_get($$;@) { 694sub http_get($@) {
308 unshift @_, "GET"; 695 unshift @_, "GET";
309 &http_request 696 &http_request
310} 697}
311 698
312sub http_head($$;@) { 699sub http_head($@) {
313 unshift @_, "HEAD"; 700 unshift @_, "HEAD";
314 &http_request 701 &http_request
315} 702}
316 703
317sub http_post($$$;@) { 704sub http_post($$@) {
705 my $url = shift;
318 unshift @_, "POST", "body"; 706 unshift @_, "POST", $url, "body";
319 &http_request 707 &http_request
320} 708}
321 709
710=back
711
322=head2 GLOBAL FUNCTIONS AND VARIABLES 712=head2 GLOBAL FUNCTIONS AND VARIABLES
323 713
324=over 4 714=over 4
325 715
326=item AnyEvent::HTTP::set_proxy "proxy-url" 716=item AnyEvent::HTTP::set_proxy "proxy-url"
333The default value for the C<recurse> request parameter (default: C<10>). 723The default value for the C<recurse> request parameter (default: C<10>).
334 724
335=item $AnyEvent::HTTP::USERAGENT 725=item $AnyEvent::HTTP::USERAGENT
336 726
337The default value for the C<User-Agent> header (the default is 727The 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)>). 728C<Mozilla/5.0 (compatible; U; AnyEvent-HTTP/$VERSION; +http://software.schmorp.de/pkg/AnyEvent)>).
339 729
340=item $AnyEvent::HTTP::MAX_PERSISTENT 730=item $AnyEvent::HTTP::MAX_PERSISTENT
341 731
342The maximum number of persistent connections to keep open (default: 8). 732The maximum number of persistent connections to keep open (default: 8).
343 733
346=item $AnyEvent::HTTP::PERSISTENT_TIMEOUT 736=item $AnyEvent::HTTP::PERSISTENT_TIMEOUT
347 737
348The maximum time to cache a persistent connection, in seconds (default: 2). 738The maximum time to cache a persistent connection, in seconds (default: 2).
349 739
350Not 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.
351 747
352=back 748=back
353 749
354=cut 750=cut
355 751
364 760
365L<AnyEvent>. 761L<AnyEvent>.
366 762
367=head1 AUTHOR 763=head1 AUTHOR
368 764
369 Marc Lehmann <schmorp@schmorp.de> 765 Marc Lehmann <schmorp@schmorp.de>
370 http://home.schmorp.de/ 766 http://home.schmorp.de/
767
768With many thanks to Дмитрий Шалашов, who provided countless
769testcases and bugreports.
371 770
372=cut 771=cut
373 772
3741 7731
375 774

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines