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.2 by root, Wed Jun 4 11:37:41 2008 UTC vs.
Revision 1.42 by root, Mon Jul 6 00:08:16 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_REDIRECTS = 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.
77
78=item http_head $url, key => value..., $cb->($data, $headers)
79
80Executes an HTTP-HEAD request. See the http_request function for details
81on additional parameters and the return value.
82
83=item http_post $url, $body, key => value..., $cb->($data, $headers)
84
85Executes an HTTP-POST request with a request body of C<$body>. See the
86http_request function for details on additional parameters and the return
87value.
56 88
57=item http_request $method => $url, key => value..., $cb->($data, $headers) 89=item http_request $method => $url, key => value..., $cb->($data, $headers)
58 90
59Executes 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
60must be an absolute http or https URL. 92must be an absolute http or https URL.
61 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
62The callback will be called with the response data as first argument 99The callback will be called with the response body data as first argument
63(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
64response headers as second argument. 101second argument.
65 102
66All the headers in that has are lowercased. In addition to the response 103All the headers in that hash are lowercased. In addition to the response
67headers, the three "pseudo-headers" C<HTTPVersion>, C<Status> and 104headers, the "pseudo-headers" C<HTTPVersion>, C<Status> and C<Reason>
68C<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
69name. 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.
70 111
71If 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,
72then 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>
73and 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.
116
117A typical callback might look like this:
118
119 sub {
120 my ($body, $hdr) = @_;
121
122 if ($hdr->{Status} =~ /^2/) {
123 ... everything should be ok
124 } else {
125 print "error, $hdr->{Status} $hdr->{Reason}\n";
126 }
127 }
74 128
75Additional parameters are key-value pairs, and are fully optional. They 129Additional parameters are key-value pairs, and are fully optional. They
76include: 130include:
77 131
78=over 4 132=over 4
79 133
80=item recurse => $boolean (default: true) 134=item recurse => $count (default: $MAX_RECURSE)
81 135
82Whether to recurse requests or not, e.g. on redirects, authentication 136Whether to recurse requests or not, e.g. on redirects, authentication
83retries and so on. 137retries and so on, and how often to do so.
84 138
85=item headers => hashref 139=item headers => hashref
86 140
87The 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:>.
88 144
89=item timeout => $seconds 145=item timeout => $seconds
90 146
91The 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
92the 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.
97default proxy (as specified by C<$ENV{http_proxy}>) is used. 153default proxy (as specified by C<$ENV{http_proxy}>) is used.
98 154
99C<$scheme> must be either missing or C<http> for HTTP, or C<https> for 155C<$scheme> must be either missing or C<http> for HTTP, or C<https> for
100HTTPS. 156HTTPS.
101 157
158=item body => $string
159
160The request body, usually empty. Will be-sent as-is (future versions of
161this module might offer more options).
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
102=back 250=back
103 251
104=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;
105 281
106=cut 282=cut
107 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
108sub http_request($$$;@) { 320sub http_request($$@) {
109 my $cb = pop; 321 my $cb = pop;
110 my ($method, $url, %arg) = @_; 322 my ($method, $url, %arg) = @_;
111 323
112 my %hdr; 324 my %hdr;
113 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";
328
329 $method = uc $method;
330
114 if (my $hdr = delete $arg{headers}) { 331 if (my $hdr = $arg{headers}) {
115 while (my ($k, $v) = each %$hdr) { 332 while (my ($k, $v) = each %$hdr) {
116 $hdr{lc $k} = $v; 333 $hdr{lc $k} = $v;
117 } 334 }
118 } 335 }
119 336
337 my $recurse = exists $arg{recurse} ? delete $arg{recurse} : $MAX_RECURSE;
338
339 return $cb->(undef, { Status => 599, Reason => "Too many redirections", URL => $url })
340 if $recurse < 0;
341
120 my $proxy = $arg{proxy} || $PROXY; 342 my $proxy = $arg{proxy} || $PROXY;
121 my $timeout = $arg{timeout} || $TIMEOUT; 343 my $timeout = $arg{timeout} || $TIMEOUT;
122 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 $uhost =~ s/^\[(.*)\]$/$1/;
361 $upath .= "?$query" if length $query;
362
363 $upath =~ s%^/?%/%;
364
365 # cookie processing
366 if (my $jar = $arg{cookie_jar}) {
367 %$jar = () if $jar->{version} != 1;
368
369 my @cookie;
370
371 while (my ($chost, $v) = each %$jar) {
372 if ($chost =~ /^\./) {
373 next unless $chost eq substr $uhost, -length $chost;
374 } elsif ($chost =~ /\./) {
375 next unless $chost eq $uhost;
376 } else {
377 next;
378 }
379
380 while (my ($cpath, $v) = each %$v) {
381 next unless $cpath eq substr $upath, 0, length $cpath;
382
383 while (my ($k, $v) = each %$v) {
384 next if $uscheme ne "https" && exists $v->{secure};
385 my $value = $v->{value};
386 $value =~ s/([\\"])/\\$1/g;
387 push @cookie, "$k=\"$value\"";
388 }
389 }
390 }
391
392 $hdr{cookie} = join "; ", @cookie
393 if @cookie;
394 }
395
396 my ($rhost, $rport, $rscheme, $rpath); # request host, port, path
397
398 if ($proxy) {
399 ($rpath, $rhost, $rport, $rscheme) = ($url, @$proxy);
400
401 # don't support https requests over https-proxy transport,
402 # can't be done with tls as spec'ed, unless you double-encrypt.
403 $rscheme = "http" if $uscheme eq "https" && $rscheme eq "https";
404 } else {
405 ($rhost, $rport, $rscheme, $rpath) = ($uhost, $uport, $uscheme, $upath);
406 }
407
123 $hdr{"user-agent"} ||= $USERAGENT; 408 $hdr{"user-agent"} ||= $USERAGENT;
409 $hdr{referer} ||= "$uscheme://$uauthority$upath"; # leave out fragment and query string, just a heuristic
124 410
125 my ($host, $port, $path, $scheme); 411 $hdr{host} = "$uhost:$uport";
126
127 if ($proxy) {
128 ($host, $port, $scheme) = @$proxy;
129 $path = $url;
130 } else {
131 ($scheme, my $authority, $path, my $query, my $fragment) =
132 $url =~ m|(?:([^:/?#]+):)?(?://([^/?#]*))?([^?#]*)(?:\?([^#]*))?(?:#(.*))?|;
133
134 $port = $scheme eq "http" ? 80
135 : $scheme eq "https" ? 443
136 : croak "$url: only http and https URLs supported";
137
138 $authority =~ /^(?: .*\@ )? ([^\@:]+) (?: : (\d+) )?$/x
139 or croak "$authority: unparsable URL";
140
141 $host = $1;
142 $port = $2 if defined $2;
143
144 $host =~ s/^\[(.*)\]$/$1/;
145 $path .= "?$query" if length $query;
146
147 $path = "/" unless $path;
148
149 $hdr{host} = $host = lc $host;
150 }
151
152 $scheme = lc $scheme;
153
154 my %state;
155
156 my $body = "";
157 $state{body} = $body;
158
159 $hdr{"content-length"} = length $body; 412 $hdr{"content-length"} = length $arg{body};
160 413
414 my %state = (connect_guard => 1);
415
416 _get_slot $uhost, sub {
417 $state{slot_guard} = shift;
418
419 return unless $state{connect_guard};
420
161 $state{connect_guard} = AnyEvent::Socket::tcp_connect $host, $port, sub { 421 $state{connect_guard} = AnyEvent::Socket::tcp_connect $rhost, $rport, sub {
162 $state{fh} = shift 422 $state{fh} = shift
163 or return $cb->(undef, { Status => 599, Reason => "$!" }); 423 or return (%state = (), $cb->(undef, { Status => 599, Reason => "$!", URL => $url }));
424 pop; # free memory, save a tree
164 425
165 delete $state{connect_guard}; # reduce memory usage, save a tree 426 return unless delete $state{connect_guard};
166 427
167 # get handle 428 # get handle
168 $state{handle} = new AnyEvent::Handle 429 $state{handle} = new AnyEvent::Handle
169 fh => $state{fh}, 430 fh => $state{fh},
170 ($scheme eq "https" ? (tls => "connect") : ()); 431 timeout => $timeout,
432 peername => $rhost,
433 tls_ctx => $arg{tls_ctx};
171 434
172 # limit the number of persistent connections 435 # limit the number of persistent connections
436 # keepalive not yet supported
173 if ($KA_COUNT{$_[1]} < $MAX_PERSISTENT_PER_HOST) { 437 if ($KA_COUNT{$_[1]} < $MAX_PERSISTENT_PER_HOST) {
174 ++$KA_COUNT{$_[1]}; 438 ++$KA_COUNT{$_[1]};
175 $state{handle}{ka_count_guard} = AnyEvent::Util::guard { --$KA_COUNT{$_[1]} }; 439 $state{handle}{ka_count_guard} = AnyEvent::Util::guard {
440 --$KA_COUNT{$_[1]}
441 };
176 $hdr{connection} = "keep-alive"; 442 $hdr{connection} = "keep-alive";
177 delete $hdr{connection}; # keep-alive not yet supported
178 } else { 443 } else {
179 delete $hdr{connection}; 444 delete $hdr{connection};
180 } 445 }
181 446
182 # (re-)configure handle 447 # (re-)configure handle
183 $state{handle}->timeout ($timeout);
184 $state{handle}->on_error (sub { 448 $state{handle}->on_error (sub {
185 %state = (); 449 %state = ();
186 $cb->(undef, { Status => 599, Reason => "$!" }); 450 $cb->(undef, { Status => 599, Reason => $_[2], URL => $url });
187 }); 451 });
188 $state{handle}->on_eof (sub { 452 $state{handle}->on_eof (sub {
189 %state = (); 453 %state = ();
190 $cb->(undef, { Status => 599, Reason => "unexpected end-of-file" }); 454 $cb->(undef, { Status => 599, Reason => "Unexpected end-of-file", URL => $url });
191 });
192
193 # send request
194 $state{handle}->push_write (
195 "\U$method\E $path HTTP/1.0\015\012"
196 . (join "", map "$_: $hdr{$_}\015\012", keys %hdr)
197 . "\015\012"
198 . (delete $state{body})
199 );
200
201 %hdr = (); # reduce memory usage, save a kitten
202
203 # status line
204 $state{handle}->push_read (line => qr/\015?\012/, sub {
205 $_[1] =~ /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) \s+ ([^\015\012]+)/ix
206 or return (%state = (), $cb->(undef, { Status => 599, Reason => "invalid server response ($_[1])" }));
207
208 my %hdr = ( # response headers
209 HTTPVersion => ",$1",
210 Status => ",$2",
211 Reason => ",$3",
212 ); 455 });
213 456
457 $state{handle}->starttls ("connect") if $rscheme eq "https";
458
459 # handle actual, non-tunneled, request
460 my $handle_actual_request = sub {
461 $state{handle}->starttls ("connect") if $uscheme eq "https" && !exists $state{handle}{tls};
462
463 # send request
464 $state{handle}->push_write (
465 "$method $rpath HTTP/1.0\015\012"
466 . (join "", map "\u$_: $hdr{$_}\015\012", keys %hdr)
467 . "\015\012"
468 . (delete $arg{body})
469 );
470
471 %hdr = (); # reduce memory usage, save a kitten
472
473 # status line
474 $state{handle}->push_read (line => $qr_nl, sub {
475 $_[1] =~ /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\015\012]*) )?/ix
476 or return (%state = (), $cb->(undef, { Status => 599, Reason => "Invalid server response ($_[1])", URL => $url }));
477
478 my %hdr = ( # response headers
479 HTTPVersion => ",$1",
480 Status => ",$2",
481 Reason => ",$3",
482 URL => ",$url"
483 );
484
214 # headers, could be optimized a bit 485 # headers, could be optimized a bit
215 $state{handle}->unshift_read (line => qr/\015?\012\015?\012/, sub { 486 $state{handle}->unshift_read (line => $qr_nlnl, sub {
216 for ("$_[1]\012") { 487 for ("$_[1]\012") {
217 # we support spaces in field names, as lotus domino 488 y/\015//d; # weed out any \015, as they show up in the weirdest of places.
218 # creates them. 489
490 # things seen, not parsed:
491 # p3pP="NON CUR OTPi OUR NOR UNI"
492
219 $hdr{lc $1} .= ",$2" 493 $hdr{lc $1} .= ",$2"
220 while /\G 494 while /\G
221 ([^:\000-\037]+): 495 ([^:\000-\037]+):
222 [\011\040]* 496 [\011\040]*
223 ((?: [^\015\012]+ | \015?\012[\011\040] )*) 497 ((?: [^\012]+ | \012[\011\040] )*)
224 \015?\012 498 \012
225 /gxc; 499 /gxc;
226 500
227 /\G$/ 501 /\G$/
228 or return $cb->(undef, { Status => 599, Reason => "garbled response headers" }); 502 or return (%state = (), $cb->(undef, { Status => 599, Reason => "Garbled response headers", URL => $url }));
229 } 503 }
230 504
231 substr $_, 0, 1, "" 505 substr $_, 0, 1, ""
232 for values %hdr; 506 for values %hdr;
233 507
234 if (exists $hdr{"content-length"}) { 508 # redirect handling
235 $_[0]->unshift_read (chunk => $hdr{"content-length"}, sub { 509 # microsoft and other shitheads don't give a shit for following standards,
236 # could cache persistent connection now 510 # try to support some common forms of broken Location headers.
237 if ($hdr{connection} =~ /\bkeep-alive\b/i) { 511 if ($hdr{location} !~ /^(?: $ | [^:\/?\#]+ : )/x) {
238 # but we don't, due to misdesigns, this is annoyingly complex 512 $hdr{location} =~ s/^\.\/+//;
513
514 my $url = "$rscheme://$uhost:$uport";
515
516 unless ($hdr{location} =~ s/^\///) {
517 $url .= $upath;
518 $url =~ s/\/[^\/]*$//;
519 }
520
521 $hdr{location} = "$url/$hdr{location}";
522 }
523
524 my $redirect;
525
526 if ($recurse) {
527 if ($hdr{Status} =~ /^30[12]$/ && $method ne "POST") {
528 # apparently, mozilla et al. just change POST to GET here
529 # more research is needed before we do the same
530 $redirect = 1;
531 } elsif ($hdr{Status} == 303) {
532 # even http/1.1 is unclear on how to mutate the method
533 $method = "GET" unless $method eq "HEAD";
534 $redirect = 1;
535 } elsif ($hdr{Status} == 307 && $method =~ /^(?:GET|HEAD)$/) {
536 $redirect = 1;
537 }
538 }
539
540 my $finish = sub {
541 $state{handle}->destroy if $state{handle};
542 %state = ();
543
544 # set-cookie processing
545 if ($arg{cookie_jar}) {
546 for ($_[1]{"set-cookie"}) {
547 # parse NAME=VALUE
548 my @kv;
549
550 while (/\G\s* ([^=;,[:space:]]+) \s*=\s* (?: "((?:[^\\"]+|\\.)*)" | ([^=;,[:space:]]*) )/gcxs) {
551 my $name = $1;
552 my $value = $3;
553
554 unless ($value) {
555 $value = $2;
556 $value =~ s/\\(.)/$1/gs;
557 }
558
559 push @kv, $name => $value;
560
561 last unless /\G\s*;/gc;
562 }
563
564 last unless @kv;
565
566 my $name = shift @kv;
567 my %kv = (value => shift @kv, @kv);
568
569 my $cdom;
570 my $cpath = (delete $kv{path}) || "/";
571
572 if (exists $kv{domain}) {
573 $cdom = delete $kv{domain};
574
575 $cdom =~ s/^\.?/./; # make sure it starts with a "."
576
577 next if $cdom =~ /\.$/;
578
579 # this is not rfc-like and not netscape-like. go figure.
580 my $ndots = $cdom =~ y/.//;
581 next if $ndots < ($cdom =~ /\.[^.][^.]\.[^.][^.]$/ ? 3 : 2);
582 } else {
583 $cdom = $uhost;
584 }
585
586 # store it
587 $arg{cookie_jar}{version} = 1;
588 $arg{cookie_jar}{$cdom}{$cpath}{$name} = \%kv;
589
590 redo if /\G\s*,/gc;
591 }
592 }
593
594 if ($redirect) {
595 # we ignore any errors, as it is very common to receive
596 # Content-Length != 0 but no actual body
597 # we also access %hdr, as $_[1] might be an erro
598 http_request ($method => $hdr{location}, %arg, recurse => $recurse - 1, $cb);
599 } else {
600 $cb->($_[0], $_[1]);
601 }
239 }; 602 };
240 603
604 my $len = $hdr{"content-length"};
605
606 if (!$redirect && $arg{on_header} && !$arg{on_header}(\%hdr)) {
607 $finish->(undef, { Status => 598, Reason => "Request cancelled by on_header", URL => $url });
608 } elsif (
609 $hdr{Status} =~ /^(?:1..|[23]04)$/
610 or $method eq "HEAD"
611 or (defined $len && !$len)
612 ) {
613 # no body
614 $finish->("", \%hdr);
615 } else {
616 # body handling, four different code paths
617 # for want_body_handle, on_body (2x), normal (2x)
618 # we might read too much here, but it does not matter yet (no pers. connections)
619 if (!$redirect && $arg{want_body_handle}) {
620 $_[0]->on_eof (undef);
621 $_[0]->on_error (undef);
622 $_[0]->on_read (undef);
623
624 $finish->(delete $state{handle}, \%hdr);
625
626 } elsif ($arg{on_body}) {
627 $_[0]->on_error (sub { $finish->(undef, { Status => 599, Reason => $_[2], URL => $url }) });
628 if ($len) {
629 $_[0]->on_eof (undef);
630 $_[0]->on_read (sub {
631 $len -= length $_[0]{rbuf};
632
633 $arg{on_body}(delete $_[0]{rbuf}, \%hdr)
634 or $finish->(undef, { Status => 598, Reason => "Request cancelled by on_body", URL => $url });
635
636 $len > 0
637 or $finish->("", \%hdr);
638 });
639 } else {
640 $_[0]->on_eof (sub {
641 $finish->("", \%hdr);
642 });
643 $_[0]->on_read (sub {
644 $arg{on_body}(delete $_[0]{rbuf}, \%hdr)
645 or $finish->(undef, { Status => 598, Reason => "Request cancelled by on_body", URL => $url });
646 });
647 }
648 } else {
649 $_[0]->on_eof (undef);
650
651 if ($len) {
652 $_[0]->on_error (sub { $finish->(undef, { Status => 599, Reason => $_[2], URL => $url }) });
653 $_[0]->on_read (sub {
654 $finish->((substr delete $_[0]{rbuf}, 0, $len, ""), \%hdr)
655 if $len <= length $_[0]{rbuf};
656 });
657 } else {
658 $_[0]->on_error (sub {
659 $! == Errno::EPIPE
660 ? $finish->(delete $_[0]{rbuf}, \%hdr)
661 : $finish->(undef, { Status => 599, Reason => $_[2], URL => $url });
662 });
663 $_[0]->on_read (sub { });
664 }
665 }
666 }
667 });
668 });
669 };
670
671 # now handle proxy-CONNECT method
672 if ($proxy && $uscheme eq "https") {
673 # oh dear, we have to wrap it into a connect request
674
675 # maybe re-use $uauthority with patched port?
676 $state{handle}->push_write ("CONNECT $uhost:$uport HTTP/1.0\015\012Host: $uhost\015\012\015\012");
677 $state{handle}->push_read (line => $qr_nlnl, sub {
678 $_[1] =~ /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\015\012]*) )?/ix
679 or return (%state = (), $cb->(undef, { Status => 599, Reason => "Invalid proxy connect response ($_[1])", URL => $url }));
680
681 if ($2 == 200) {
682 $rpath = $upath;
683 &$handle_actual_request;
684 } else {
241 %state = (); 685 %state = ();
242 $cb->($_[1], \%hdr); 686 $cb->(undef, { Status => $2, Reason => $3, URL => $url });
243 }); 687 }
244 } else {
245 # too bad, need to read until we get an error or EOF,
246 # no way to detect winged data.
247 $_[0]->on_error (sub {
248 %state = ();
249 $cb->($_[0]{rbuf}, \%hdr);
250 });
251 $_[0]->on_eof (undef);
252 $_[0]->on_read (sub { });
253 } 688 });
689 } else {
690 &$handle_actual_request;
254 }); 691 }
692
693 }, sub {
694 $timeout
255 }); 695 };
256 }, sub {
257 $timeout
258 }; 696 };
259 697
260 defined wantarray && AnyEvent::Util::guard { %state = () } 698 defined wantarray && AnyEvent::Util::guard { %state = () }
261} 699}
262 700
263sub http_get($$;@) { 701sub http_get($@) {
264 unshift @_, "GET"; 702 unshift @_, "GET";
265 &http_request 703 &http_request
266} 704}
267 705
706sub http_head($@) {
707 unshift @_, "HEAD";
708 &http_request
709}
710
711sub http_post($$@) {
712 my $url = shift;
713 unshift @_, "POST", $url, "body";
714 &http_request
715}
716
717=back
718
268=head2 GLOBAL FUNCTIONS AND VARIABLES 719=head2 GLOBAL FUNCTIONS AND VARIABLES
269 720
270=over 4 721=over 4
271 722
272=item AnyEvent::HTTP::set_proxy "proxy-url" 723=item AnyEvent::HTTP::set_proxy "proxy-url"
273 724
274Sets the default proxy server to use. The proxy-url must begin with a 725Sets the default proxy server to use. The proxy-url must begin with a
275string of the form C<http://host:port> (optionally C<https:...>). 726string of the form C<http://host:port> (optionally C<https:...>).
276 727
277=item $AnyEvent::HTTP::MAX_REDIRECTS 728=item $AnyEvent::HTTP::MAX_RECURSE
278 729
279The default value for the C<max_redirects> request parameter 730The default value for the C<recurse> request parameter (default: C<10>).
280(default: C<10>).
281 731
282=item $AnyEvent::HTTP::USERAGENT 732=item $AnyEvent::HTTP::USERAGENT
283 733
284The default value for the C<User-Agent> header (the default is 734The default value for the C<User-Agent> header (the default is
285C<Mozilla/5.0 (compatible; AnyEvent::HTTP/$VERSION; +http://software.schmorp.de/pkg/AnyEvent)>). 735C<Mozilla/5.0 (compatible; U; AnyEvent-HTTP/$VERSION; +http://software.schmorp.de/pkg/AnyEvent)>).
286 736
287=item $AnyEvent::HTTP::MAX_PERSISTENT 737=item $AnyEvent::HTTP::MAX_PERSISTENT
288 738
289The maximum number of persistent connections to keep open (default: 8). 739The maximum number of persistent connections to keep open (default: 8).
290 740
741Not implemented currently.
742
291=item $AnyEvent::HTTP::PERSISTENT_TIMEOUT 743=item $AnyEvent::HTTP::PERSISTENT_TIMEOUT
292 744
293The maximum time to cache a persistent connection, in seconds (default: 2). 745The maximum time to cache a persistent connection, in seconds (default: 2).
746
747Not implemented currently.
748
749=item $AnyEvent::HTTP::ACTIVE
750
751The number of active connections. This is not the number of currently
752running requests, but the number of currently open and non-idle TCP
753connections. This number of can be useful for load-leveling.
294 754
295=back 755=back
296 756
297=cut 757=cut
298 758
307 767
308L<AnyEvent>. 768L<AnyEvent>.
309 769
310=head1 AUTHOR 770=head1 AUTHOR
311 771
312 Marc Lehmann <schmorp@schmorp.de> 772 Marc Lehmann <schmorp@schmorp.de>
313 http://home.schmorp.de/ 773 http://home.schmorp.de/
774
775With many thanks to Дмитрий Шалашов, who provided countless
776testcases and bugreports.
314 777
315=cut 778=cut
316 779
3171 7801
318 781

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines