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.49 by root, Wed Aug 5 16:23:48 2009 UTC

3AnyEvent::HTTP - simple but non-blocking HTTP/HTTPS client 3AnyEvent::HTTP - simple but non-blocking HTTP/HTTPS client
4 4
5=head1 SYNOPSIS 5=head1 SYNOPSIS
6 6
7 use AnyEvent::HTTP; 7 use AnyEvent::HTTP;
8
9 http_get "http://www.nethype.de/", sub { print $_[1] };
10
11 # ... do something else here
8 12
9=head1 DESCRIPTION 13=head1 DESCRIPTION
10 14
11This module is an L<AnyEvent> user, you need to make sure that you use and 15This module is an L<AnyEvent> user, you need to make sure that you use and
12run a supported event loop. 16run a supported event loop.
13 17
18This module implements a simple, stateless and non-blocking HTTP
19client. It supports GET, POST and other request methods, cookies and more,
20all on a very low level. It can follow redirects supports proxies and
21automatically limits the number of connections to the values specified in
22the RFC.
23
24It should generally be a "good client" that is enough for most HTTP
25tasks. Simple tasks should be simple, but complex tasks should still be
26possible as the user retains control over request and response headers.
27
28The caller is responsible for authentication management, cookies (if
29the simplistic implementation in this module doesn't suffice), referer
30and other high-level protocol details for which this module offers only
31limited support.
32
14=head2 METHODS 33=head2 METHODS
15 34
16=over 4 35=over 4
17 36
18=cut 37=cut
20package AnyEvent::HTTP; 39package AnyEvent::HTTP;
21 40
22use strict; 41use strict;
23no warnings; 42no warnings;
24 43
25use Carp; 44use Errno ();
26 45
27use AnyEvent (); 46use AnyEvent 4.8 ();
28use AnyEvent::Util (); 47use AnyEvent::Util ();
29use AnyEvent::Socket (); 48use AnyEvent::Socket ();
30use AnyEvent::Handle (); 49use AnyEvent::Handle ();
31 50
32use base Exporter::; 51use base Exporter::;
33 52
34our $VERSION = '1.0'; 53our $VERSION = '1.42';
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:> (this can be
144suppressed by using C<undef> for these headers in which case they won't be
145sent at all).
73 146
74=item timeout => $seconds 147=item timeout => $seconds
75 148
76The time-out to use for various stages - each connect attempt will reset 149The time-out to use for various stages - each connect attempt will reset
77the timeout, as will read or write activity. 150the timeout, as will read or write activity. Default timeout is 5 minutes.
151
152=item proxy => [$host, $port[, $scheme]] or undef
153
154Use the given http proxy for all requests. If not specified, then the
155default proxy (as specified by C<$ENV{http_proxy}>) is used.
156
157C<$scheme> must be either missing, C<http> for HTTP or C<https> for
158HTTPS.
159
160=item body => $string
161
162The request body, usually empty. Will be-sent as-is (future versions of
163this module might offer more options).
164
165=item cookie_jar => $hash_ref
166
167Passing this parameter enables (simplified) cookie-processing, loosely
168based on the original netscape specification.
169
170The C<$hash_ref> must be an (initially empty) hash reference which will
171get updated automatically. It is possible to save the cookie_jar to
172persistent storage with something like JSON or Storable, but this is not
173recommended, as expiry times are currently being ignored.
174
175Note that this cookie implementation is not of very high quality, nor
176meant to be complete. If you want complete cookie management you have to
177do that on your own. C<cookie_jar> is meant as a quick fix to get some
178cookie-using sites working. Cookies are a privacy disaster, do not use
179them unless required to.
180
181=item tls_ctx => $scheme | $tls_ctx
182
183Specifies the AnyEvent::TLS context to be used for https connections. This
184parameter follows the same rules as the C<tls_ctx> parameter to
185L<AnyEvent::Handle>, but additionally, the two strings C<low> or
186C<high> can be specified, which give you a predefined low-security (no
187verification, highest compatibility) and high-security (CA and common-name
188verification) TLS context.
189
190The default for this option is C<low>, which could be interpreted as "give
191me the page, no matter what".
192
193=item on_header => $callback->($headers)
194
195When specified, this callback will be called with the header hash as soon
196as headers have been successfully received from the remote server (not on
197locally-generated errors).
198
199It has to return either true (in which case AnyEvent::HTTP will continue),
200or false, in which case AnyEvent::HTTP will cancel the download (and call
201the finish callback with an error code of C<598>).
202
203This callback is useful, among other things, to quickly reject unwanted
204content, which, if it is supposed to be rare, can be faster than first
205doing a C<HEAD> request.
206
207Example: cancel the request unless the content-type is "text/html".
208
209 on_header => sub {
210 $_[0]{"content-type"} =~ /^text\/html\s*(?:;|$)/
211 },
212
213=item on_body => $callback->($partial_body, $headers)
214
215When specified, all body data will be passed to this callback instead of
216to the completion callback. The completion callback will get the empty
217string instead of the body data.
218
219It has to return either true (in which case AnyEvent::HTTP will continue),
220or false, in which case AnyEvent::HTTP will cancel the download (and call
221the completion callback with an error code of C<598>).
222
223This callback is useful when the data is too large to be held in memory
224(so the callback writes it to a file) or when only some information should
225be extracted, or when the body should be processed incrementally.
226
227It is usually preferred over doing your own body handling via
228C<want_body_handle>, but in case of streaming APIs, where HTTP is
229only used to create a connection, C<want_body_handle> is the better
230alternative, as it allows you to install your own event handler, reducing
231resource usage.
232
233=item want_body_handle => $enable
234
235When enabled (default is disabled), the behaviour of AnyEvent::HTTP
236changes considerably: after parsing the headers, and instead of
237downloading the body (if any), the completion callback will be
238called. Instead of the C<$body> argument containing the body data, the
239callback will receive the L<AnyEvent::Handle> object associated with the
240connection. In error cases, C<undef> will be passed. When there is no body
241(e.g. status C<304>), the empty string will be passed.
242
243The handle object might or might not be in TLS mode, might be connected to
244a proxy, be a persistent connection etc., and configured in unspecified
245ways. The user is responsible for this handle (it will not be used by this
246module anymore).
247
248This is useful with some push-type services, where, after the initial
249headers, an interactive protocol is used (typical example would be the
250push-style twitter API which starts a JSON/XML stream).
251
252If you think you need this, first have a look at C<on_body>, to see if
253that doesn't solve your problem in a better way.
78 254
79=back 255=back
80 256
81=back 257Example: make a simple HTTP GET request for http://www.nethype.de/
258
259 http_request GET => "http://www.nethype.de/", sub {
260 my ($body, $hdr) = @_;
261 print "$body\n";
262 };
263
264Example: make a HTTP HEAD request on https://www.google.com/, use a
265timeout of 30 seconds.
266
267 http_request
268 GET => "https://www.google.com",
269 timeout => 30,
270 sub {
271 my ($body, $hdr) = @_;
272 use Data::Dumper;
273 print Dumper $hdr;
274 }
275 ;
276
277Example: make another simple HTTP GET request, but immediately try to
278cancel it.
279
280 my $request = http_request GET => "http://www.nethype.de/", sub {
281 my ($body, $hdr) = @_;
282 print "$body\n";
283 };
284
285 undef $request;
82 286
83=cut 287=cut
84 288
289sub _slot_schedule;
290sub _slot_schedule($) {
291 my $host = shift;
292
293 while ($CO_SLOT{$host}[0] < $MAX_PER_HOST) {
294 if (my $cb = shift @{ $CO_SLOT{$host}[1] }) {
295 # somebody wants that slot
296 ++$CO_SLOT{$host}[0];
297 ++$ACTIVE;
298
299 $cb->(AnyEvent::Util::guard {
300 --$ACTIVE;
301 --$CO_SLOT{$host}[0];
302 _slot_schedule $host;
303 });
304 } else {
305 # nobody wants the slot, maybe we can forget about it
306 delete $CO_SLOT{$host} unless $CO_SLOT{$host}[0];
307 last;
308 }
309 }
310}
311
312# wait for a free slot on host, call callback
313sub _get_slot($$) {
314 push @{ $CO_SLOT{$_[0]}[1] }, $_[1];
315
316 _slot_schedule $_[0];
317}
318
319our $qr_nl = qr{\015?\012};
320our $qr_nlnl = qr{(?<![^\012])\015?\012};
321
322our $TLS_CTX_LOW = { cache => 1, sslv2 => 1 };
323our $TLS_CTX_HIGH = { cache => 1, verify => 1, verify_peername => "https" };
324
85sub http_request($$$;@) { 325sub http_request($$@) {
86 my $cb = pop; 326 my $cb = pop;
87 my ($method, $url, %arg) = @_; 327 my ($method, $url, %arg) = @_;
88 328
89 my %hdr; 329 my %hdr;
90 330
331 $arg{tls_ctx} = $TLS_CTX_LOW if $arg{tls_ctx} eq "low" || !exists $arg{tls_ctx};
332 $arg{tls_ctx} = $TLS_CTX_HIGH if $arg{tls_ctx} eq "high";
333
334 $method = uc $method;
335
91 if (my $hdr = delete $arg{headers}) { 336 if (my $hdr = $arg{headers}) {
92 while (my ($k, $v) = each %$hdr) { 337 while (my ($k, $v) = each %$hdr) {
93 $hdr{lc $k} = $v; 338 $hdr{lc $k} = $v;
94 } 339 }
95 } 340 }
96 341
342 my $recurse = exists $arg{recurse} ? delete $arg{recurse} : $MAX_RECURSE;
343
344 return $cb->(undef, { Status => 599, Reason => "Too many redirections", URL => $url })
345 if $recurse < 0;
346
347 my $proxy = $arg{proxy} || $PROXY;
97 my $timeout = $arg{timeout} || $TIMEOUT; 348 my $timeout = $arg{timeout} || $TIMEOUT;
98 349
99 $hdr{"user-agent"} ||= $USERAGENT;
100
101 my ($scheme, $authority, $path, $query, $fragment) = 350 my ($uscheme, $uauthority, $upath, $query, $fragment) =
102 $url =~ m|(?:([^:/?#]+):)?(?://([^/?#]*))?([^?#]*)(?:\?([^#]*))?(?:#(.*))?|; 351 $url =~ m|(?:([^:/?#]+):)?(?://([^/?#]*))?([^?#]*)(?:\?([^#]*))?(?:#(.*))?|;
103 352
104 $scheme = lc $scheme; 353 $uscheme = lc $uscheme;
354
105 my $port = $scheme eq "http" ? 80 355 my $uport = $uscheme eq "http" ? 80
106 : $scheme eq "https" ? 443 356 : $uscheme eq "https" ? 443
107 : croak "$url: only http and https URLs supported"; 357 : return $cb->(undef, { Status => 599, Reason => "Only http and https URL schemes supported", URL => $url });
108 358
109 $authority =~ /^(?: .*\@ )? ([^\@:]+) (?: : (\d+) )?$/x 359 $uauthority =~ /^(?: .*\@ )? ([^\@:]+) (?: : (\d+) )?$/x
110 or croak "$authority: unparsable URL"; 360 or return $cb->(undef, { Status => 599, Reason => "Unparsable URL", URL => $url });
111 361
112 my $host = $1; 362 my $uhost = $1;
113 $port = $2 if defined $2; 363 $uport = $2 if defined $2;
114 364
365 $hdr{host} = defined $2 ? "$uhost:$2" : "$uhost";
366
115 $host =~ s/^\[(.*)\]$/$1/; 367 $uhost =~ s/^\[(.*)\]$/$1/;
116 $path .= "?$query" if length $query; 368 $upath .= "?$query" if length $query;
117 369
118 $hdr{host} = $host = lc $host; 370 $upath =~ s%^/?%/%;
119 371
120 my %state; 372 # cookie processing
121 373 if (my $jar = $arg{cookie_jar}) {
122 my $body = ""; 374 %$jar = () if $jar->{version} != 1;
123 $state{body} = $body; 375
124 376 my @cookie;
125 $hdr{"content-length"} = length $body; 377
126 378 while (my ($chost, $v) = each %$jar) {
127 $state{connect_guard} = AnyEvent::Socket::tcp_connect $host, $port, sub { 379 if ($chost =~ /^\./) {
128 $state{fh} = shift 380 next unless $chost eq substr $uhost, -length $chost;
129 or return $cb->(undef, { Status => 599, Reason => "$!" }); 381 } elsif ($chost =~ /\./) {
130 382 next unless $chost eq $uhost;
131 delete $state{connect_guard}; # reduce memory usage, save a tree
132
133 # get handle
134 $state{handle} = new AnyEvent::Handle
135 fh => $state{fh},
136 ($scheme eq "https" ? (tls => "connect") : ());
137
138 # limit the number of persistent connections
139 if ($KA_COUNT{$_[1]} < $MAX_PERSISTENT_PER_HOST) {
140 ++$KA_COUNT{$_[1]};
141 $state{handle}{ka_count_guard} = AnyEvent::Util::guard { --$KA_COUNT{$_[1]} };
142 $hdr{connection} = "keep-alive";
143 } else { 383 } else {
144 delete $hdr{connection}; 384 next;
385 }
386
387 while (my ($cpath, $v) = each %$v) {
388 next unless $cpath eq substr $upath, 0, length $cpath;
389
390 while (my ($k, $v) = each %$v) {
391 next if $uscheme ne "https" && exists $v->{secure};
392 my $value = $v->{value};
393 $value =~ s/([\\"])/\\$1/g;
394 push @cookie, "$k=\"$value\"";
395 }
396 }
145 } 397 }
398
399 $hdr{cookie} = join "; ", @cookie
400 if @cookie;
401 }
146 402
147 # (re-)configure handle 403 my ($rhost, $rport, $rscheme, $rpath); # request host, port, path
148 $state{handle}->timeout ($timeout); 404
149 $state{handle}->on_error (sub { 405 if ($proxy) {
406 ($rpath, $rhost, $rport, $rscheme) = ($url, @$proxy);
407
408 $rscheme = "http" unless defined $rscheme;
409
410 # don't support https requests over https-proxy transport,
411 # can't be done with tls as spec'ed, unless you double-encrypt.
412 $rscheme = "http" if $uscheme eq "https" && $rscheme eq "https";
413 } else {
414 ($rhost, $rport, $rscheme, $rpath) = ($uhost, $uport, $uscheme, $upath);
415 }
416
417 # leave out fragment and query string, just a heuristic
418 $hdr{referer} ||= "$uscheme://$uauthority$upath" unless exists $hdr{referer};
419 $hdr{"user-agent"} ||= $USERAGENT unless exists $hdr{"user-agent"};
420
421 $hdr{"content-length"} = length $arg{body};
422
423 my %state = (connect_guard => 1);
424
425 _get_slot $uhost, sub {
426 $state{slot_guard} = shift;
427
428 return unless $state{connect_guard};
429
430 $state{connect_guard} = AnyEvent::Socket::tcp_connect $rhost, $rport, sub {
431 $state{fh} = shift
432 or do {
433 my $err = "$!";
150 %state = (); 434 %state = ();
151 $cb->(undef, { Status => 599, Reason => "$!" }); 435 return $cb->(undef, { Status => 599, Reason => $err, URL => $url });
152 });
153 $state{handle}->on_eof (sub {
154 %state = ();
155 $cb->(undef, { Status => 599, Reason => "unexpected end-of-file" });
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 );
178
179 # headers, could be optimized a bit
180 $state{handle}->unshift_read (line => qr/\015?\012\015?\012/, sub {
181 for ("$_[1]\012") {
182 $hdr{lc $1} .= ",$2"
183 while /\G
184 ([^:\000-\040]+):
185 [\011\040]*
186 ((?: [^\015\012]+ | \015?\012[\011\040] )*)
187 \015?\012
188 /gxc;
189
190 /\G$/
191 or return $cb->(undef, { Status => 599, Reason => "garbled response headers" });
192 } 436 };
193 437
438 pop; # free memory, save a tree
439
440 return unless delete $state{connect_guard};
441
442 # get handle
443 $state{handle} = new AnyEvent::Handle
444 fh => $state{fh},
445 timeout => $timeout,
446 peername => $rhost,
447 tls_ctx => $arg{tls_ctx};
448
449 # limit the number of persistent connections
450 # keepalive not yet supported
451 if ($KA_COUNT{$_[1]} < $MAX_PERSISTENT_PER_HOST) {
452 ++$KA_COUNT{$_[1]};
453 $state{handle}{ka_count_guard} = AnyEvent::Util::guard {
454 --$KA_COUNT{$_[1]}
455 };
456 $hdr{connection} = "keep-alive";
457 } else {
458 delete $hdr{connection};
459 }
460
461 # (re-)configure handle
462 $state{handle}->on_error (sub {
463 %state = ();
464 $cb->(undef, { Status => 599, Reason => $_[2], URL => $url });
465 });
466 $state{handle}->on_eof (sub {
467 %state = ();
468 $cb->(undef, { Status => 599, Reason => "Unexpected end-of-file", URL => $url });
469 });
470
471 $state{handle}->starttls ("connect") if $rscheme eq "https";
472
473 # handle actual, non-tunneled, request
474 my $handle_actual_request = sub {
475 $state{handle}->starttls ("connect") if $uscheme eq "https" && !exists $state{handle}{tls};
476
477 # send request
478 $state{handle}->push_write (
479 "$method $rpath HTTP/1.0\015\012"
480 . (join "", map "\u$_: $hdr{$_}\015\012", grep defined $hdr{$_}, keys %hdr)
481 . "\015\012"
482 . (delete $arg{body})
483 );
484
485 %hdr = (); # reduce memory usage, save a kitten
486
487 # status line
488 $state{handle}->push_read (line => $qr_nl, sub {
489 $_[1] =~ /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\015\012]*) )?/ix
490 or return (%state = (), $cb->(undef, { Status => 599, Reason => "Invalid server response ($_[1])", URL => $url }));
491
492 my %hdr = ( # response headers
493 HTTPVersion => ",$1",
494 Status => ",$2",
495 Reason => ",$3",
496 URL => ",$url"
497 );
498
499 # headers, could be optimized a bit
500 $state{handle}->unshift_read (line => $qr_nlnl, sub {
501 for ("$_[1]") {
502 y/\015//d; # weed out any \015, as they show up in the weirdest of places.
503
504 # things seen, not parsed:
505 # p3pP="NON CUR OTPi OUR NOR UNI"
506
507 $hdr{lc $1} .= ",$2"
508 while /\G
509 ([^:\000-\037]*):
510 [\011\040]*
511 ((?: [^\012]+ | \012[\011\040] )*)
512 \012
513 /gxc;
514
515 /\G$/
516 or return (%state = (), $cb->(undef, { Status => 599, Reason => "Garbled response headers", URL => $url }));
517 }
518
194 substr $_, 0, 1, "" 519 substr $_, 0, 1, ""
195 for values %hdr; 520 for values %hdr;
196 521
197 if (exists $hdr{"content-length"}) { 522 # redirect handling
198 $_[0]->unshift_read (chunk => $hdr{"content-length"}, sub { 523 # microsoft and other shitheads don't give a shit for following standards,
199 # could cache persistent connection now 524 # try to support some common forms of broken Location headers.
200 if ($hdr{connection} =~ /\bkeep-alive\b/i) { 525 if ($hdr{location} !~ /^(?: $ | [^:\/?\#]+ : )/x) {
526 $hdr{location} =~ s/^\.\/+//;
527
528 my $url = "$rscheme://$uhost:$uport";
529
530 unless ($hdr{location} =~ s/^\///) {
531 $url .= $upath;
532 $url =~ s/\/[^\/]*$//;
533 }
534
535 $hdr{location} = "$url/$hdr{location}";
536 }
537
538 my $redirect;
539
540 if ($recurse) {
541 if ($hdr{Status} =~ /^30[12]$/ && $method ne "POST") {
542 # apparently, mozilla et al. just change POST to GET here
543 # more research is needed before we do the same
544 $redirect = 1;
545 } elsif ($hdr{Status} == 303) {
546 # even http/1.1 is unclear on how to mutate the method
547 $method = "GET" unless $method eq "HEAD";
548 $redirect = 1;
549 } elsif ($hdr{Status} == 307 && $method =~ /^(?:GET|HEAD)$/) {
550 $redirect = 1;
551 }
552 }
553
554 my $finish = sub {
555 $state{handle}->destroy if $state{handle};
556 %state = ();
557
558 # set-cookie processing
559 if ($arg{cookie_jar}) {
560 for ($_[1]{"set-cookie"}) {
561 # parse NAME=VALUE
562 my @kv;
563
564 while (/\G\s* ([^=;,[:space:]]+) \s*=\s* (?: "((?:[^\\"]+|\\.)*)" | ([^=;,[:space:]]*) )/gcxs) {
565 my $name = $1;
566 my $value = $3;
567
568 unless ($value) {
569 $value = $2;
570 $value =~ s/\\(.)/$1/gs;
571 }
572
573 push @kv, $name => $value;
574
575 last unless /\G\s*;/gc;
576 }
577
578 last unless @kv;
579
580 my $name = shift @kv;
581 my %kv = (value => shift @kv, @kv);
582
583 my $cdom;
584 my $cpath = (delete $kv{path}) || "/";
585
586 if (exists $kv{domain}) {
587 $cdom = delete $kv{domain};
588
589 $cdom =~ s/^\.?/./; # make sure it starts with a "."
590
591 next if $cdom =~ /\.$/;
592
593 # this is not rfc-like and not netscape-like. go figure.
594 my $ndots = $cdom =~ y/.//;
595 next if $ndots < ($cdom =~ /\.[^.][^.]\.[^.][^.]$/ ? 3 : 2);
596 } else {
597 $cdom = $uhost;
598 }
599
600 # store it
601 $arg{cookie_jar}{version} = 1;
602 $arg{cookie_jar}{$cdom}{$cpath}{$name} = \%kv;
603
604 redo if /\G\s*,/gc;
605 }
606 }
607
608 if ($redirect && exists $hdr{location}) {
609 # we ignore any errors, as it is very common to receive
610 # Content-Length != 0 but no actual body
611 # we also access %hdr, as $_[1] might be an erro
612 http_request ($method => $hdr{location}, %arg, recurse => $recurse - 1, $cb);
613 } else {
614 $cb->($_[0], $_[1]);
615 }
201 }; 616 };
202 617
618 my $len = $hdr{"content-length"};
619
620 if (!$redirect && $arg{on_header} && !$arg{on_header}(\%hdr)) {
621 $finish->(undef, { Status => 598, Reason => "Request cancelled by on_header", URL => $url });
622 } elsif (
623 $hdr{Status} =~ /^(?:1..|[23]04)$/
624 or $method eq "HEAD"
625 or (defined $len && !$len)
626 ) {
627 # no body
628 $finish->("", \%hdr);
629 } else {
630 # body handling, four different code paths
631 # for want_body_handle, on_body (2x), normal (2x)
632 # we might read too much here, but it does not matter yet (no pers. connections)
633 if (!$redirect && $arg{want_body_handle}) {
634 $_[0]->on_eof (undef);
635 $_[0]->on_error (undef);
636 $_[0]->on_read (undef);
637
638 $finish->(delete $state{handle}, \%hdr);
639
640 } elsif ($arg{on_body}) {
641 $_[0]->on_error (sub { $finish->(undef, { Status => 599, Reason => $_[2], URL => $url }) });
642 if ($len) {
643 $_[0]->on_eof (undef);
644 $_[0]->on_read (sub {
645 $len -= length $_[0]{rbuf};
646
647 $arg{on_body}(delete $_[0]{rbuf}, \%hdr)
648 or $finish->(undef, { Status => 598, Reason => "Request cancelled by on_body", URL => $url });
649
650 $len > 0
651 or $finish->("", \%hdr);
652 });
653 } else {
654 $_[0]->on_eof (sub {
655 $finish->("", \%hdr);
656 });
657 $_[0]->on_read (sub {
658 $arg{on_body}(delete $_[0]{rbuf}, \%hdr)
659 or $finish->(undef, { Status => 598, Reason => "Request cancelled by on_body", URL => $url });
660 });
661 }
662 } else {
663 $_[0]->on_eof (undef);
664
665 if ($len) {
666 $_[0]->on_error (sub { $finish->(undef, { Status => 599, Reason => $_[2], URL => $url }) });
667 $_[0]->on_read (sub {
668 $finish->((substr delete $_[0]{rbuf}, 0, $len, ""), \%hdr)
669 if $len <= length $_[0]{rbuf};
670 });
671 } else {
672 $_[0]->on_error (sub {
673 $! == Errno::EPIPE || !$!
674 ? $finish->(delete $_[0]{rbuf}, \%hdr)
675 : $finish->(undef, { Status => 599, Reason => $_[2], URL => $url });
676 });
677 $_[0]->on_read (sub { });
678 }
679 }
680 }
681 });
682 });
683 };
684
685 # now handle proxy-CONNECT method
686 if ($proxy && $uscheme eq "https") {
687 # oh dear, we have to wrap it into a connect request
688
689 # maybe re-use $uauthority with patched port?
690 $state{handle}->push_write ("CONNECT $uhost:$uport HTTP/1.0\015\012Host: $uhost\015\012\015\012");
691 $state{handle}->push_read (line => $qr_nlnl, sub {
692 $_[1] =~ /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\015\012]*) )?/ix
693 or return (%state = (), $cb->(undef, { Status => 599, Reason => "Invalid proxy connect response ($_[1])", URL => $url }));
694
695 if ($2 == 200) {
696 $rpath = $upath;
697 &$handle_actual_request;
698 } else {
203 %state = (); 699 %state = ();
204 $cb->($_[1], \%hdr); 700 $cb->(undef, { Status => $2, Reason => $3, URL => $url });
205 }); 701 }
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 } 702 });
703 } else {
704 &$handle_actual_request;
216 }); 705 }
706
707 }, sub {
708 $timeout
217 }); 709 };
218 }, sub {
219 $timeout
220 }; 710 };
221 711
222 defined wantarray && AnyEvent::Util::guard { %state = () } 712 defined wantarray && AnyEvent::Util::guard { %state = () }
223} 713}
224 714
225sub http_get($$;@) { 715sub http_get($@) {
226 unshift @_, "GET"; 716 unshift @_, "GET";
227 &http_request 717 &http_request
228} 718}
229 719
720sub http_head($@) {
721 unshift @_, "HEAD";
722 &http_request
723}
724
725sub http_post($$@) {
726 my $url = shift;
727 unshift @_, "POST", $url, "body";
728 &http_request
729}
730
731=back
732
230=head2 GLOBAL VARIABLES 733=head2 GLOBAL FUNCTIONS AND VARIABLES
231 734
232=over 4 735=over 4
233 736
737=item AnyEvent::HTTP::set_proxy "proxy-url"
738
739Sets the default proxy server to use. The proxy-url must begin with a
740string of the form C<http://host:port> (optionally C<https:...>).
741
234=item $AnyEvent::HTTP::MAX_REDIRECTS 742=item $AnyEvent::HTTP::MAX_RECURSE
235 743
236The default value for the C<max_redirects> request parameter 744The default value for the C<recurse> request parameter (default: C<10>).
237(default: C<10>).
238 745
239=item $AnyEvent::HTTP::USERAGENT 746=item $AnyEvent::HTTP::USERAGENT
240 747
241The default value for the C<User-Agent> header (the default is 748The 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)>). 749C<Mozilla/5.0 (compatible; U; AnyEvent-HTTP/$VERSION; +http://software.schmorp.de/pkg/AnyEvent)>).
243 750
244=item $AnyEvent::HTTP::MAX_PERSISTENT 751=item $AnyEvent::HTTP::MAX_PER_HOST
245 752
246The maximum number of persistent connections to keep open (default: 8). 753The maximum number of concurrent connections to the same host (identified
754by the hostname). If the limit is exceeded, then the additional requests
755are queued until previous connections are closed.
247 756
248=item $AnyEvent::HTTP::PERSISTENT_TIMEOUT 757The default value for this is C<4>, and it is highly advisable to not
758increase it.
249 759
250The maximum time to cache a persistent connection, in seconds (default: 15). 760=item $AnyEvent::HTTP::ACTIVE
761
762The number of active connections. This is not the number of currently
763running requests, but the number of currently open and non-idle TCP
764connections. This number of can be useful for load-leveling.
251 765
252=back 766=back
253 767
254=cut 768=cut
255 769
770sub set_proxy($) {
771 $PROXY = [$2, $3 || 3128, $1] if $_[0] =~ m%^(https?):// ([^:/]+) (?: : (\d*) )?%ix;
772}
773
774# initialise proxy from environment
775set_proxy $ENV{http_proxy};
776
256=head1 SEE ALSO 777=head1 SEE ALSO
257 778
258L<AnyEvent>. 779L<AnyEvent>.
259 780
260=head1 AUTHOR 781=head1 AUTHOR
261 782
262 Marc Lehmann <schmorp@schmorp.de> 783 Marc Lehmann <schmorp@schmorp.de>
263 http://home.schmorp.de/ 784 http://home.schmorp.de/
785
786With many thanks to Дмитрий Шалашов, who provided countless
787testcases and bugreports.
264 788
265=cut 789=cut
266 790
2671 7911
268 792

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines