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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines