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.27 by root, Thu Jul 24 06:01:10 2008 UTC vs.
Revision 1.65 by root, Fri Dec 31 03:47:32 2010 UTC

39package AnyEvent::HTTP; 39package AnyEvent::HTTP;
40 40
41use strict; 41use strict;
42no warnings; 42no warnings;
43 43
44use Carp; 44use Errno ();
45 45
46use AnyEvent (); 46use AnyEvent 5.0 ();
47use AnyEvent::Util (); 47use AnyEvent::Util ();
48use AnyEvent::Socket ();
49use AnyEvent::Handle (); 48use AnyEvent::Handle ();
50 49
51use base Exporter::; 50use base Exporter::;
52 51
53our $VERSION = '1.04'; 52our $VERSION = '1.5';
54 53
55our @EXPORT = qw(http_get http_post http_head http_request); 54our @EXPORT = qw(http_get http_post http_head http_request);
56 55
57our $USERAGENT = "Mozilla/5.0 (compatible; AnyEvent::HTTP/$VERSION; +http://software.schmorp.de/pkg/AnyEvent)"; 56our $USERAGENT = "Mozilla/5.0 (compatible; U; AnyEvent-HTTP/$VERSION; +http://software.schmorp.de/pkg/AnyEvent)";
58our $MAX_RECURSE = 10; 57our $MAX_RECURSE = 10;
59our $MAX_PERSISTENT = 8; 58our $MAX_PERSISTENT = 8;
60our $PERSISTENT_TIMEOUT = 2; 59our $PERSISTENT_TIMEOUT = 2;
61our $TIMEOUT = 300; 60our $TIMEOUT = 300;
62 61
63# changing these is evil 62# changing these is evil
64our $MAX_PERSISTENT_PER_HOST = 2; 63our $MAX_PERSISTENT_PER_HOST = 0;
65our $MAX_PER_HOST = 4; 64our $MAX_PER_HOST = 4;
66 65
67our $PROXY; 66our $PROXY;
68our $ACTIVE = 0; 67our $ACTIVE = 0;
69 68
71my %CO_SLOT; # number of open connections, and wait queue, per host 70my %CO_SLOT; # number of open connections, and wait queue, per host
72 71
73=item http_get $url, key => value..., $cb->($data, $headers) 72=item http_get $url, key => value..., $cb->($data, $headers)
74 73
75Executes an HTTP-GET request. See the http_request function for details on 74Executes an HTTP-GET request. See the http_request function for details on
76additional parameters. 75additional parameters and the return value.
77 76
78=item http_head $url, key => value..., $cb->($data, $headers) 77=item http_head $url, key => value..., $cb->($data, $headers)
79 78
80Executes an HTTP-HEAD request. See the http_request function for details on 79Executes an HTTP-HEAD request. See the http_request function for details
81additional parameters. 80on additional parameters and the return value.
82 81
83=item http_post $url, $body, key => value..., $cb->($data, $headers) 82=item http_post $url, $body, key => value..., $cb->($data, $headers)
84 83
85Executes an HTTP-POST request with a request body of C<$body>. See the 84Executes an HTTP-POST request with a request body of C<$body>. See the
86http_request function for details on additional parameters. 85http_request function for details on additional parameters and the return
86value.
87 87
88=item http_request $method => $url, key => value..., $cb->($data, $headers) 88=item http_request $method => $url, key => value..., $cb->($data, $headers)
89 89
90Executes a HTTP request of type C<$method> (e.g. C<GET>, C<POST>). The URL 90Executes a HTTP request of type C<$method> (e.g. C<GET>, C<POST>). The URL
91must be an absolute http or https URL. 91must be an absolute http or https URL.
92 92
93When called in void context, nothing is returned. In other contexts,
94C<http_request> returns a "cancellation guard" - you have to keep the
95object at least alive until the callback get called. If the object gets
96destroyed before the callback is called, the request will be cancelled.
97
93The callback will be called with the response data as first argument 98The callback will be called with the response body data as first argument
94(or C<undef> if it wasn't available due to errors), and a hash-ref with 99(or C<undef> if an error occured), and a hash-ref with response headers as
95response headers as second argument. 100second argument.
96 101
97All the headers in that hash are lowercased. In addition to the response 102All the headers in that hash are lowercased. In addition to the response
98headers, the "pseudo-headers" C<HTTPVersion>, C<Status> and C<Reason> 103headers, the "pseudo-headers" (uppercase to avoid clashing with possible
104response headers) C<HTTPVersion>, C<Status> and C<Reason> contain the
99contain the three parts of the HTTP Status-Line of the same name. The 105three parts of the HTTP Status-Line of the same name. If an error occurs
106during the body phase of a request, then the original C<Status> and
107C<Reason> values from the header are available as C<OrigStatus> and
108C<OrigReason>.
109
100pseudo-header C<URL> contains the original URL (which can differ from the 110The pseudo-header C<URL> contains the actual URL (which can differ from
101requested URL when following redirects). 111the requested URL when following redirects - for example, you might get
112an error that your URL scheme is not supported even though your URL is a
113valid http URL because it redirected to an ftp URL, in which case you can
114look at the URL pseudo header).
102 115
116The pseudo-header C<Redirect> only exists when the request was a result
117of an internal redirect. In that case it is an array reference with
118the C<($data, $headers)> from the redirect response. Note that this
119response could in turn be the result of a redirect itself, and C<<
120$headers->{Redirect}[1]{Redirect} >> will then contain the original
121response, and so on.
122
103If the server sends a header multiple lines, then their contents will be 123If the server sends a header multiple times, then their contents will be
104joined together with C<\x00>. 124joined together with a comma (C<,>), as per the HTTP spec.
105 125
106If an internal error occurs, such as not being able to resolve a hostname, 126If an internal error occurs, such as not being able to resolve a hostname,
107then C<$data> will be C<undef>, C<< $headers->{Status} >> will be C<599> 127then C<$data> will be C<undef>, C<< $headers->{Status} >> will be C<59x>
108and the C<Reason> pseudo-header will contain an error message. 128(usually C<599>) and the C<Reason> pseudo-header will contain an error
129message.
109 130
110A typical callback might look like this: 131A typical callback might look like this:
111 132
112 sub { 133 sub {
113 my ($body, $hdr) = @_; 134 my ($body, $hdr) = @_;
131 152
132=item headers => hashref 153=item headers => hashref
133 154
134The request headers to use. Currently, C<http_request> may provide its 155The request headers to use. Currently, C<http_request> may provide its
135own C<Host:>, C<Content-Length:>, C<Connection:> and C<Cookie:> headers 156own C<Host:>, C<Content-Length:>, C<Connection:> and C<Cookie:> headers
136and will provide defaults for C<User-Agent:> and C<Referer:>. 157and will provide defaults for C<User-Agent:> and C<Referer:> (this can be
158suppressed by using C<undef> for these headers in which case they won't be
159sent at all).
137 160
138=item timeout => $seconds 161=item timeout => $seconds
139 162
140The time-out to use for various stages - each connect attempt will reset 163The time-out to use for various stages - each connect attempt will reset
141the timeout, as will read or write activity. Default timeout is 5 minutes. 164the timeout, as will read or write activity, i.e. this is not an overall
165timeout.
166
167Default timeout is 5 minutes.
142 168
143=item proxy => [$host, $port[, $scheme]] or undef 169=item proxy => [$host, $port[, $scheme]] or undef
144 170
145Use the given http proxy for all requests. If not specified, then the 171Use the given http proxy for all requests. If not specified, then the
146default proxy (as specified by C<$ENV{http_proxy}>) is used. 172default proxy (as specified by C<$ENV{http_proxy}>) is used.
147 173
148C<$scheme> must be either missing or C<http> for HTTP, or C<https> for 174C<$scheme> must be either missing, C<http> for HTTP or C<https> for
149HTTPS. 175HTTPS.
150 176
151=item body => $string 177=item body => $string
152 178
153The request body, usually empty. Will be-sent as-is (future versions of 179The request body, usually empty. Will be-sent as-is (future versions of
159based on the original netscape specification. 185based on the original netscape specification.
160 186
161The C<$hash_ref> must be an (initially empty) hash reference which will 187The C<$hash_ref> must be an (initially empty) hash reference which will
162get updated automatically. It is possible to save the cookie_jar to 188get updated automatically. It is possible to save the cookie_jar to
163persistent storage with something like JSON or Storable, but this is not 189persistent storage with something like JSON or Storable, but this is not
164recommended, as expire times are currently being ignored. 190recommended, as expiry times are currently being ignored.
165 191
166Note that this cookie implementation is not of very high quality, nor 192Note that this cookie implementation is not of very high quality, nor
167meant to be complete. If you want complete cookie management you have to 193meant to be complete. If you want complete cookie management you have to
168do that on your own. C<cookie_jar> is meant as a quick fix to get some 194do that on your own. C<cookie_jar> is meant as a quick fix to get some
169cookie-using sites working. Cookies are a privacy disaster, do not use 195cookie-using sites working. Cookies are a privacy disaster, do not use
170them unless required to. 196them unless required to.
197
198=item tls_ctx => $scheme | $tls_ctx
199
200Specifies the AnyEvent::TLS context to be used for https connections. This
201parameter follows the same rules as the C<tls_ctx> parameter to
202L<AnyEvent::Handle>, but additionally, the two strings C<low> or
203C<high> can be specified, which give you a predefined low-security (no
204verification, highest compatibility) and high-security (CA and common-name
205verification) TLS context.
206
207The default for this option is C<low>, which could be interpreted as "give
208me the page, no matter what".
209
210=item on_prepare => $callback->($fh)
211
212In rare cases you need to "tune" the socket before it is used to
213connect (for exmaple, to bind it on a given IP address). This parameter
214overrides the prepare callback passed to C<AnyEvent::Socket::tcp_connect>
215and behaves exactly the same way (e.g. it has to provide a
216timeout). See the description for the C<$prepare_cb> argument of
217C<AnyEvent::Socket::tcp_connect> for details.
218
219=item tcp_connect => $callback->($host, $service, $connect_cb, $prepare_cb)
220
221In even rarer cases you want total control over how AnyEvent::HTTP
222establishes connections. Normally it uses L<AnyEvent::Socket::tcp_connect>
223to do this, but you can provide your own C<tcp_connect> function -
224obviously, it has to follow the same calling conventions, except that it
225may always return a connection guard object.
226
227There are probably lots of weird uses for this function, starting from
228tracing the hosts C<http_request> actually tries to connect, to (inexact
229but fast) host => IP address caching or even socks protocol support.
230
231=item on_header => $callback->($headers)
232
233When specified, this callback will be called with the header hash as soon
234as headers have been successfully received from the remote server (not on
235locally-generated errors).
236
237It has to return either true (in which case AnyEvent::HTTP will continue),
238or false, in which case AnyEvent::HTTP will cancel the download (and call
239the finish callback with an error code of C<598>).
240
241This callback is useful, among other things, to quickly reject unwanted
242content, which, if it is supposed to be rare, can be faster than first
243doing a C<HEAD> request.
244
245Example: cancel the request unless the content-type is "text/html".
246
247 on_header => sub {
248 $_[0]{"content-type"} =~ /^text\/html\s*(?:;|$)/
249 },
250
251=item on_body => $callback->($partial_body, $headers)
252
253When specified, all body data will be passed to this callback instead of
254to the completion callback. The completion callback will get the empty
255string instead of the body data.
256
257It has to return either true (in which case AnyEvent::HTTP will continue),
258or false, in which case AnyEvent::HTTP will cancel the download (and call
259the completion callback with an error code of C<598>).
260
261This callback is useful when the data is too large to be held in memory
262(so the callback writes it to a file) or when only some information should
263be extracted, or when the body should be processed incrementally.
264
265It is usually preferred over doing your own body handling via
266C<want_body_handle>, but in case of streaming APIs, where HTTP is
267only used to create a connection, C<want_body_handle> is the better
268alternative, as it allows you to install your own event handler, reducing
269resource usage.
270
271=item want_body_handle => $enable
272
273When enabled (default is disabled), the behaviour of AnyEvent::HTTP
274changes considerably: after parsing the headers, and instead of
275downloading the body (if any), the completion callback will be
276called. Instead of the C<$body> argument containing the body data, the
277callback will receive the L<AnyEvent::Handle> object associated with the
278connection. In error cases, C<undef> will be passed. When there is no body
279(e.g. status C<304>), the empty string will be passed.
280
281The handle object might or might not be in TLS mode, might be connected to
282a proxy, be a persistent connection etc., and configured in unspecified
283ways. The user is responsible for this handle (it will not be used by this
284module anymore).
285
286This is useful with some push-type services, where, after the initial
287headers, an interactive protocol is used (typical example would be the
288push-style twitter API which starts a JSON/XML stream).
289
290If you think you need this, first have a look at C<on_body>, to see if
291that doesn't solve your problem in a better way.
171 292
172=back 293=back
173 294
174Example: make a simple HTTP GET request for http://www.nethype.de/ 295Example: make a simple HTTP GET request for http://www.nethype.de/
175 296
188 my ($body, $hdr) = @_; 309 my ($body, $hdr) = @_;
189 use Data::Dumper; 310 use Data::Dumper;
190 print Dumper $hdr; 311 print Dumper $hdr;
191 } 312 }
192 ; 313 ;
314
315Example: make another simple HTTP GET request, but immediately try to
316cancel it.
317
318 my $request = http_request GET => "http://www.nethype.de/", sub {
319 my ($body, $hdr) = @_;
320 print "$body\n";
321 };
322
323 undef $request;
193 324
194=cut 325=cut
195 326
196sub _slot_schedule; 327sub _slot_schedule;
197sub _slot_schedule($) { 328sub _slot_schedule($) {
221 push @{ $CO_SLOT{$_[0]}[1] }, $_[1]; 352 push @{ $CO_SLOT{$_[0]}[1] }, $_[1];
222 353
223 _slot_schedule $_[0]; 354 _slot_schedule $_[0];
224} 355}
225 356
357our $qr_nlnl = qr{(?<![^\012])\015?\012};
358
359our $TLS_CTX_LOW = { cache => 1, sslv2 => 1 };
360our $TLS_CTX_HIGH = { cache => 1, verify => 1, verify_peername => "https" };
361
226sub http_request($$@) { 362sub http_request($$@) {
227 my $cb = pop; 363 my $cb = pop;
228 my ($method, $url, %arg) = @_; 364 my ($method, $url, %arg) = @_;
229 365
230 my %hdr; 366 my %hdr;
367
368 $arg{tls_ctx} = $TLS_CTX_LOW if $arg{tls_ctx} eq "low" || !exists $arg{tls_ctx};
369 $arg{tls_ctx} = $TLS_CTX_HIGH if $arg{tls_ctx} eq "high";
231 370
232 $method = uc $method; 371 $method = uc $method;
233 372
234 if (my $hdr = $arg{headers}) { 373 if (my $hdr = $arg{headers}) {
235 while (my ($k, $v) = each %$hdr) { 374 while (my ($k, $v) = each %$hdr) {
236 $hdr{lc $k} = $v; 375 $hdr{lc $k} = $v;
237 } 376 }
238 } 377 }
239 378
379 # pseudo headers for all subsequent responses
380 my @pseudo = (URL => $url);
381 push @pseudo, Redirect => delete $arg{Redirect} if exists $arg{Redirect};
382
240 my $recurse = exists $arg{recurse} ? delete $arg{recurse} : $MAX_RECURSE; 383 my $recurse = exists $arg{recurse} ? delete $arg{recurse} : $MAX_RECURSE;
241 384
242 return $cb->(undef, { Status => 599, Reason => "recursion limit reached", URL => $url }) 385 return $cb->(undef, { @pseudo, Status => 599, Reason => "Too many redirections" })
243 if $recurse < 0; 386 if $recurse < 0;
244 387
245 my $proxy = $arg{proxy} || $PROXY; 388 my $proxy = $arg{proxy} || $PROXY;
246 my $timeout = $arg{timeout} || $TIMEOUT; 389 my $timeout = $arg{timeout} || $TIMEOUT;
247 390
248 $hdr{"user-agent"} ||= $USERAGENT;
249
250 my ($scheme, $authority, $upath, $query, $fragment) = 391 my ($uscheme, $uauthority, $upath, $query, $fragment) =
251 $url =~ m|(?:([^:/?#]+):)?(?://([^/?#]*))?([^?#]*)(?:\?([^#]*))?(?:#(.*))?|; 392 $url =~ m|(?:([^:/?#]+):)?(?://([^/?#]*))?([^?#]*)(?:(\?[^#]*))?(?:#(.*))?|;
252 393
253 $scheme = lc $scheme; 394 $uscheme = lc $uscheme;
254 395
255 my $uport = $scheme eq "http" ? 80 396 my $uport = $uscheme eq "http" ? 80
256 : $scheme eq "https" ? 443 397 : $uscheme eq "https" ? 443
257 : return $cb->(undef, { Status => 599, Reason => "only http and https URL schemes supported", URL => $url }); 398 : return $cb->(undef, { @pseudo, Status => 599, Reason => "Only http and https URL schemes supported" });
258 399
259 $hdr{referer} ||= "$scheme://$authority$upath"; # leave out fragment and query string, just a heuristic
260
261 $authority =~ /^(?: .*\@ )? ([^\@:]+) (?: : (\d+) )?$/x 400 $uauthority =~ /^(?: .*\@ )? ([^\@:]+) (?: : (\d+) )?$/x
262 or return $cb->(undef, { Status => 599, Reason => "unparsable URL", URL => $url }); 401 or return $cb->(undef, { @pseudo, Status => 599, Reason => "Unparsable URL" });
263 402
264 my $uhost = $1; 403 my $uhost = $1;
265 $uport = $2 if defined $2; 404 $uport = $2 if defined $2;
266 405
406 $hdr{host} = defined $2 ? "$uhost:$2" : "$uhost"
407 unless exists $hdr{host};
408
267 $uhost =~ s/^\[(.*)\]$/$1/; 409 $uhost =~ s/^\[(.*)\]$/$1/;
268 $upath .= "?$query" if length $query; 410 $upath .= $query if length $query;
269 411
270 $upath =~ s%^/?%/%; 412 $upath =~ s%^/?%/%;
271 413
272 # cookie processing 414 # cookie processing
273 if (my $jar = $arg{cookie_jar}) { 415 if (my $jar = $arg{cookie_jar}) {
274 %$jar = () if $jar->{version} < 1; 416 %$jar = () if $jar->{version} != 1;
275 417
276 my @cookie; 418 my @cookie;
277 419
278 while (my ($chost, $v) = each %$jar) { 420 while (my ($chost, $v) = each %$jar) {
421 if ($chost =~ /^\./) {
279 next unless $chost eq substr $uhost, -length $chost; 422 next unless $chost eq substr $uhost, -length $chost;
280 next unless $chost =~ /^\./; 423 } elsif ($chost =~ /\./) {
424 next unless $chost eq $uhost;
425 } else {
426 next;
427 }
281 428
282 while (my ($cpath, $v) = each %$v) { 429 while (my ($cpath, $v) = each %$v) {
283 next unless $cpath eq substr $upath, 0, length $cpath; 430 next unless $cpath eq substr $upath, 0, length $cpath;
284 431
285 while (my ($k, $v) = each %$v) { 432 while (my ($k, $v) = each %$v) {
286 next if $scheme ne "https" && exists $v->{secure}; 433 next if $uscheme ne "https" && exists $v->{secure};
434 my $value = $v->{value};
435 $value =~ s/([\\"])/\\$1/g;
287 push @cookie, "$k=$v->{value}"; 436 push @cookie, "$k=\"$value\"";
288 } 437 }
289 } 438 }
290 } 439 }
291 440
292 $hdr{cookie} = join "; ", @cookie 441 $hdr{cookie} = join "; ", @cookie
293 if @cookie; 442 if @cookie;
294 } 443 }
295 444
296 my ($rhost, $rport, $rpath); # request host, port, path 445 my ($rhost, $rport, $rscheme, $rpath); # request host, port, path
297 446
298 if ($proxy) { 447 if ($proxy) {
299 ($rhost, $rport, $scheme) = @$proxy; 448 ($rpath, $rhost, $rport, $rscheme) = ($url, @$proxy);
300 $rpath = $url; 449
450 $rscheme = "http" unless defined $rscheme;
451
452 # don't support https requests over https-proxy transport,
453 # can't be done with tls as spec'ed, unless you double-encrypt.
454 $rscheme = "http" if $uscheme eq "https" && $rscheme eq "https";
301 } else { 455 } else {
302 ($rhost, $rport, $rpath) = ($uhost, $uport, $upath); 456 ($rhost, $rport, $rscheme, $rpath) = ($uhost, $uport, $uscheme, $upath);
303 $hdr{host} = $uhost;
304 } 457 }
305 458
459 # leave out fragment and query string, just a heuristic
460 $hdr{referer} ||= "$uscheme://$uauthority$upath" unless exists $hdr{referer};
461 $hdr{"user-agent"} ||= $USERAGENT unless exists $hdr{"user-agent"};
462
306 $hdr{"content-length"} = length $arg{body}; 463 $hdr{"content-length"} = length $arg{body}
464 if length $arg{body} || $method ne "GET";
307 465
308 my %state = (connect_guard => 1); 466 my %state = (connect_guard => 1);
309 467
310 _get_slot $uhost, sub { 468 _get_slot $uhost, sub {
311 $state{slot_guard} = shift; 469 $state{slot_guard} = shift;
312 470
313 return unless $state{connect_guard}; 471 return unless $state{connect_guard};
314 472
315 $state{connect_guard} = AnyEvent::Socket::tcp_connect $rhost, $rport, sub { 473 my $connect_cb = sub {
316 $state{fh} = shift 474 $state{fh} = shift
475 or do {
476 my $err = "$!";
477 %state = ();
317 or return $cb->(undef, { Status => 599, Reason => "$!", URL => $url }); 478 return $cb->(undef, { @pseudo, Status => 599, Reason => $err });
479 };
318 480
319 delete $state{connect_guard}; # reduce memory usage, save a tree 481 pop; # free memory, save a tree
482
483 return unless delete $state{connect_guard};
320 484
321 # get handle 485 # get handle
322 $state{handle} = new AnyEvent::Handle 486 $state{handle} = new AnyEvent::Handle
323 fh => $state{fh}, 487 fh => $state{fh},
324 ($scheme eq "https" ? (tls => "connect") : ()); 488 peername => $rhost,
489 tls_ctx => $arg{tls_ctx},
490 # these need to be reconfigured on keepalive handles
491 timeout => $timeout,
492 on_error => sub {
493 %state = ();
494 $cb->(undef, { @pseudo, Status => 599, Reason => $_[2] });
495 },
496 on_eof => sub {
497 %state = ();
498 $cb->(undef, { @pseudo, Status => 599, Reason => "Unexpected end-of-file" });
499 },
500 ;
325 501
326 # limit the number of persistent connections 502 # limit the number of persistent connections
503 # keepalive not yet supported
327 if ($KA_COUNT{$_[1]} < $MAX_PERSISTENT_PER_HOST) { 504# if ($KA_COUNT{$_[1]} < $MAX_PERSISTENT_PER_HOST) {
328 ++$KA_COUNT{$_[1]}; 505# ++$KA_COUNT{$_[1]};
329 $state{handle}{ka_count_guard} = AnyEvent::Util::guard { --$KA_COUNT{$_[1]} }; 506# $state{handle}{ka_count_guard} = AnyEvent::Util::guard {
507# --$KA_COUNT{$_[1]}
508# };
330 $hdr{connection} = "keep-alive"; 509# $hdr{connection} = "keep-alive";
331 delete $hdr{connection}; # keep-alive not yet supported
332 } else { 510# } else {
333 delete $hdr{connection}; 511 delete $hdr{connection};
334 } 512# }
335 513
336 # (re-)configure handle 514 $state{handle}->starttls ("connect") if $rscheme eq "https";
337 $state{handle}->timeout ($timeout);
338 $state{handle}->on_error (sub {
339 my $errno = "$!";
340 %state = ();
341 $cb->(undef, { Status => 599, Reason => $errno, URL => $url });
342 });
343 $state{handle}->on_eof (sub {
344 %state = ();
345 $cb->(undef, { Status => 599, Reason => "unexpected end-of-file", URL => $url });
346 });
347 515
516 # handle actual, non-tunneled, request
517 my $handle_actual_request = sub {
518 $state{handle}->starttls ("connect") if $uscheme eq "https" && !exists $state{handle}{tls};
519
348 # send request 520 # send request
349 $state{handle}->push_write ( 521 $state{handle}->push_write (
350 "$method $rpath HTTP/1.0\015\012" 522 "$method $rpath HTTP/1.0\015\012"
351 . (join "", map "$_: $hdr{$_}\015\012", keys %hdr) 523 . (join "", map "\u$_: $hdr{$_}\015\012", grep defined $hdr{$_}, keys %hdr)
352 . "\015\012" 524 . "\015\012"
353 . (delete $arg{body}) 525 . (delete $arg{body})
354 );
355
356 %hdr = (); # reduce memory usage, save a kitten
357
358 # status line
359 $state{handle}->push_read (line => qr/\015?\012/, sub {
360 $_[1] =~ /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\015\012]*) )?/ix
361 or return (%state = (), $cb->(undef, { Status => 599, Reason => "invalid server response ($_[1])", URL => $url }));
362
363 my %hdr = ( # response headers
364 HTTPVersion => "\x00$1",
365 Status => "\x00$2",
366 Reason => "\x00$3",
367 URL => "\x00$url"
368 ); 526 );
369 527
370 # headers, could be optimized a bit 528 # return if error occured during push_write()
529 return unless %state;
530
531 %hdr = (); # reduce memory usage, save a kitten, also make it possible to re-use
532
533 # status line and headers
371 $state{handle}->unshift_read (line => qr/\015?\012\015?\012/, sub { 534 $state{handle}->push_read (line => $qr_nlnl, sub {
535 my $keepalive = pop;
536
372 for ("$_[1]\012") { 537 for ("$_[1]") {
373 # we support spaces in field names, as lotus domino 538 y/\015//d; # weed out any \015, as they show up in the weirdest of places.
374 # creates them. 539
540 /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\015\012]*) )? \015?\012/igxc
541 or return (%state = (), $cb->(undef, { @pseudo, Status => 599, Reason => "Invalid server response" }));
542
543 push @pseudo,
544 HTTPVersion => $1,
545 Status => $2,
546 Reason => $3,
547 ;
548
549 # things seen, not parsed:
550 # p3pP="NON CUR OTPi OUR NOR UNI"
551
375 $hdr{lc $1} .= "\x00$2" 552 $hdr{lc $1} .= ",$2"
376 while /\G 553 while /\G
377 ([^:\000-\037]+): 554 ([^:\000-\037]*):
378 [\011\040]* 555 [\011\040]*
379 ((?: [^\015\012]+ | \015?\012[\011\040] )*) 556 ((?: [^\012]+ | \012[\011\040] )*)
380 \015?\012 557 \012
381 /gxc; 558 /gxc;
382 559
383 /\G$/ 560 /\G$/
384 or return (%state = (), $cb->(undef, { Status => 599, Reason => "garbled response headers", URL => $url })); 561 or return (%state = (), $cb->(undef, { @pseudo, Status => 599, Reason => "Garbled response headers" }));
385 } 562 }
386 563
564 # remove the "," prefix we added to all headers above
387 substr $_, 0, 1, "" 565 substr $_, 0, 1, ""
388 for values %hdr; 566 for values %hdr;
389 567
390 my $finish = sub { 568 # patch in all pseudo headers
569 %hdr = (%hdr, @pseudo);
570
571 # redirect handling
572 # microsoft and other shitheads don't give a shit for following standards,
573 # try to support some common forms of broken Location headers.
574 if ($hdr{location} !~ /^(?: $ | [^:\/?\#]+ : )/x) {
575 $hdr{location} =~ s/^\.\/+//;
576
577 my $url = "$rscheme://$uhost:$uport";
578
579 unless ($hdr{location} =~ s/^\///) {
580 $url .= $upath;
581 $url =~ s/\/[^\/]*$//;
582 }
583
584 $hdr{location} = "$url/$hdr{location}";
585 }
586
587 my $redirect;
588
589 if ($recurse) {
590 my $status = $hdr{Status};
591
592 # industry standard is to redirect POST as GET for
593 # 301, 302 and 303, in contrast to http/1.0 and 1.1.
594 # also, the UA should ask the user for 301 and 307 and POST,
595 # industry standard seems to be to simply follow.
596 # we go with the industry standard.
597 if ($status == 301 or $status == 302 or $status == 303) {
598 # HTTP/1.1 is unclear on how to mutate the method
599 $method = "GET" unless $method eq "HEAD";
600 $redirect = 1;
601 } elsif ($status == 307) {
602 $redirect = 1;
603 }
604 }
605
606 my $finish = sub { # ($data, $err_status, $err_reason[, $keepalive])
607 $state{handle}->destroy if $state{handle};
391 %state = (); 608 %state = ();
392 609
610 if (defined $_[1]) {
611 $hdr{OrigStatus} = $hdr{Status}; $hdr{Status} = $_[1];
612 $hdr{OrigReason} = $hdr{Reason}; $hdr{Reason} = $_[2];
613 }
614
393 # set-cookie processing 615 # set-cookie processing
394 if ($arg{cookie_jar} && exists $hdr{"set-cookie"}) { 616 if ($arg{cookie_jar}) {
395 for (split /\x00/, $hdr{"set-cookie"}) { 617 for ($hdr{"set-cookie"}) {
396 my ($cookie, @arg) = split /;\s*/; 618 # parse NAME=VALUE
397 my ($name, $value) = split /=/, $cookie, 2; 619 my @kv;
398 my %kv = (value => $value, map { split /=/, $_, 2 } @arg); 620
621 while (/\G\s* ([^=;,[:space:]]+) \s*=\s* (?: "((?:[^\\"]+|\\.)*)" | ([^=;,[:space:]]*) )/gcxs) {
622 my $name = $1;
623 my $value = $3;
624
625 unless ($value) {
626 $value = $2;
627 $value =~ s/\\(.)/$1/gs;
628 }
629
630 push @kv, $name => $value;
631
632 last unless /\G\s*;/gc;
633 }
634
635 last unless @kv;
636
637 my $name = shift @kv;
638 my %kv = (value => shift @kv, @kv);
639
640 my $cdom;
641 my $cpath = (delete $kv{path}) || "/";
642
643 if (exists $kv{domain}) {
644 $cdom = delete $kv{domain};
399 645
400 my $cdom = (delete $kv{domain}) || $uhost;
401 my $cpath = (delete $kv{path}) || "/";
402
403 $cdom =~ s/^.?/./; # make sure it starts with a "." 646 $cdom =~ s/^\.?/./; # make sure it starts with a "."
404 647
405 next if $cdom =~ /\.$/; 648 next if $cdom =~ /\.$/;
406 649
407 # this is not rfc-like and not netscape-like. go figure. 650 # this is not rfc-like and not netscape-like. go figure.
408 my $ndots = $cdom =~ y/.//; 651 my $ndots = $cdom =~ y/.//;
409 next if $ndots < ($cdom =~ /\.[^.][^.]\.[^.][^.]$/ ? 3 : 2); 652 next if $ndots < ($cdom =~ /\.[^.][^.]\.[^.][^.]$/ ? 3 : 2);
653 } else {
654 $cdom = $uhost;
655 }
410 656
411 # store it 657 # store it
412 $arg{cookie_jar}{version} = 1; 658 $arg{cookie_jar}{version} = 1;
413 $arg{cookie_jar}{$cdom}{$cpath}{$name} = \%kv; 659 $arg{cookie_jar}{$cdom}{$cpath}{$name} = \%kv;
660
661 redo if /\G\s*,/gc;
414 } 662 }
415 } 663 }
416 664
417 # microsoft and other shitheads don't give a shit for following standards, 665 if ($redirect && exists $hdr{location}) {
418 # try to support some common forms of broken Location headers. 666 # we ignore any errors, as it is very common to receive
419 if ($_[1]{location} !~ /^(?: $ | [^:\/?\#]+ : )/x) { 667 # Content-Length != 0 but no actual body
420 $_[1]{location} =~ s/^\.\/+//; 668 # we also access %hdr, as $_[1] might be an erro
421 669 http_request (
422 my $url = "$scheme://$uhost:$uport"; 670 $method => $hdr{location},
423
424 unless ($_[1]{location} =~ s/^\///) {
425 $url .= $upath;
426 $url =~ s/\/[^\/]*$//;
427 } 671 %arg,
428 672 recurse => $recurse - 1,
429 $_[1]{location} = "$url/$_[1]{location}"; 673 Redirect => [$_[0], \%hdr],
430 } 674 $cb);
431
432 if ($_[1]{Status} =~ /^30[12]$/ && $recurse && $method ne "POST") {
433 # apparently, mozilla et al. just change POST to GET here
434 # more research is needed before we do the same
435 http_request ($method, $_[1]{location}, %arg, recurse => $recurse - 1, $cb);
436 } elsif ($_[1]{Status} == 303 && $recurse) {
437 # even http/1.1 is unlear on how to mutate the method
438 $method = "GET" unless $method eq "HEAD";
439 http_request ($method => $_[1]{location}, %arg, recurse => $recurse - 1, $cb);
440 } elsif ($_[1]{Status} == 307 && $recurse && $method =~ /^(?:GET|HEAD)$/) {
441 http_request ($method => $_[1]{location}, %arg, recurse => $recurse - 1, $cb);
442 } else { 675 } else {
443 $cb->($_[0], $_[1]); 676 $cb->($_[0], \%hdr);
444 } 677 }
445 }; 678 };
446 679
447 if ($hdr{Status} =~ /^(?:1..|204|304)$/ or $method eq "HEAD") { 680 my $len = $hdr{"content-length"};
681
682 if (!$redirect && $arg{on_header} && !$arg{on_header}(\%hdr)) {
683 $finish->(undef, 598 => "Request cancelled by on_header");
684 } elsif (
685 $hdr{Status} =~ /^(?:1..|204|205|304)$/
686 or $method eq "HEAD"
687 or (defined $len && !$len)
688 ) {
689 # no body
448 $finish->(undef, \%hdr); 690 $finish->("", undef, undef, 1);
449 } else { 691 } else {
450 if (exists $hdr{"content-length"}) { 692 # body handling, four different code paths
451 $_[0]->unshift_read (chunk => $hdr{"content-length"}, sub { 693 # for want_body_handle, on_body (2x), normal (2x)
452 # could cache persistent connection now 694 # we might read too much here, but it does not matter yet (no pipelining)
453 if ($hdr{connection} =~ /\bkeep-alive\b/i) { 695 if (!$redirect && $arg{want_body_handle}) {
454 # but we don't, due to misdesigns, this is annoyingly complex 696 $_[0]->on_eof (undef);
697 $_[0]->on_error (undef);
698 $_[0]->on_read (undef);
699
700 $finish->(delete $state{handle});
701
702 } elsif ($arg{on_body}) {
703 $_[0]->on_error (sub { $finish->(undef, 599 => $_[2]) });
704 if ($len) {
705 $_[0]->on_read (sub {
706 $len -= length $_[0]{rbuf};
707
708 $arg{on_body}(delete $_[0]{rbuf}, \%hdr)
709 or $finish->(undef, 598 => "Request cancelled by on_body");
710
711 $len > 0
712 or $finish->("", undef, undef, 1);
455 }; 713 });
456 714 } else {
715 $_[0]->on_eof (sub {
457 $finish->($_[1], \%hdr); 716 $finish->("");
717 });
718 $_[0]->on_read (sub {
719 $arg{on_body}(delete $_[0]{rbuf}, \%hdr)
720 or $finish->(undef, 598 => "Request cancelled by on_body");
721 });
458 }); 722 }
459 } else { 723 } else {
460 # too bad, need to read until we get an error or EOF,
461 # no way to detect winged data.
462 $_[0]->on_error (sub {
463 $finish->($_[0]{rbuf}, \%hdr);
464 });
465 $_[0]->on_eof (undef); 724 $_[0]->on_eof (undef);
725
726 if ($len) {
727 $_[0]->on_error (sub { $finish->(undef, 599 => $_[2]) });
728 $_[0]->on_read (sub {
729 $finish->((substr delete $_[0]{rbuf}, 0, $len, ""), undef, undef, 1)
730 if $len <= length $_[0]{rbuf};
731 });
732 } else {
733 $_[0]->on_error (sub {
734 ($! == Errno::EPIPE || !$!)
735 ? $finish->(delete $_[0]{rbuf})
736 : $finish->(undef, 599 => $_[2]);
737 });
466 $_[0]->on_read (sub { }); 738 $_[0]->on_read (sub { });
739 }
467 } 740 }
468 } 741 }
469 }); 742 });
470 }); 743 };
471 }, sub { 744
472 $timeout 745 # now handle proxy-CONNECT method
746 if ($proxy && $uscheme eq "https") {
747 # oh dear, we have to wrap it into a connect request
748
749 # maybe re-use $uauthority with patched port?
750 $state{handle}->push_write ("CONNECT $uhost:$uport HTTP/1.0\015\012Host: $uhost\015\012\015\012");
751 $state{handle}->push_read (line => $qr_nlnl, sub {
752 $_[1] =~ /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\015\012]*) )?/ix
753 or return (%state = (), $cb->(undef, { @pseudo, Status => 599, Reason => "Invalid proxy connect response ($_[1])" }));
754
755 if ($2 == 200) {
756 $rpath = $upath;
757 &$handle_actual_request;
758 } else {
759 %state = ();
760 $cb->(undef, { @pseudo, Status => $2, Reason => $3 });
761 }
762 });
763 } else {
764 &$handle_actual_request;
765 }
473 }; 766 };
767
768 my $tcp_connect = $arg{tcp_connect}
769 || do { require AnyEvent::Socket; \&AnyEvent::Socket::tcp_connect };
770
771 $state{connect_guard} = $tcp_connect->($rhost, $rport, $connect_cb, $arg{on_prepare} || sub { $timeout });
772
474 }; 773 };
475 774
476 defined wantarray && AnyEvent::Util::guard { %state = () } 775 defined wantarray && AnyEvent::Util::guard { %state = () }
477} 776}
478 777
492 &http_request 791 &http_request
493} 792}
494 793
495=back 794=back
496 795
796=head2 DNS CACHING
797
798AnyEvent::HTTP uses the AnyEvent::Socket::tcp_connect function for
799the actual connection, which in turn uses AnyEvent::DNS to resolve
800hostnames. The latter is a simple stub resolver and does no caching
801on its own. If you want DNS caching, you currently have to provide
802your own default resolver (by storing a suitable resolver object in
803C<$AnyEvent::DNS::RESOLVER>).
804
497=head2 GLOBAL FUNCTIONS AND VARIABLES 805=head2 GLOBAL FUNCTIONS AND VARIABLES
498 806
499=over 4 807=over 4
500 808
501=item AnyEvent::HTTP::set_proxy "proxy-url" 809=item AnyEvent::HTTP::set_proxy "proxy-url"
502 810
503Sets the default proxy server to use. The proxy-url must begin with a 811Sets the default proxy server to use. The proxy-url must begin with a
504string of the form C<http://host:port> (optionally C<https:...>). 812string of the form C<http://host:port> (optionally C<https:...>), croaks
813otherwise.
814
815To clear an already-set proxy, use C<undef>.
816
817=item $date = AnyEvent::HTTP::format_date $timestamp
818
819Takes a POSIX timestamp (seconds since the epoch) and formats it as a HTTP
820Date (RFC 2616).
821
822=item $timestamp = AnyEvent::HTTP::parse_date $date
823
824Takes a HTTP Date (RFC 2616) and returns the corresponding POSIX
825timestamp, or C<undef> if the date cannot be parsed.
505 826
506=item $AnyEvent::HTTP::MAX_RECURSE 827=item $AnyEvent::HTTP::MAX_RECURSE
507 828
508The default value for the C<recurse> request parameter (default: C<10>). 829The default value for the C<recurse> request parameter (default: C<10>).
509 830
510=item $AnyEvent::HTTP::USERAGENT 831=item $AnyEvent::HTTP::USERAGENT
511 832
512The default value for the C<User-Agent> header (the default is 833The default value for the C<User-Agent> header (the default is
513C<Mozilla/5.0 (compatible; AnyEvent::HTTP/$VERSION; +http://software.schmorp.de/pkg/AnyEvent)>). 834C<Mozilla/5.0 (compatible; U; AnyEvent-HTTP/$VERSION; +http://software.schmorp.de/pkg/AnyEvent)>).
514 835
515=item $AnyEvent::HTTP::MAX_PERSISTENT 836=item $AnyEvent::HTTP::MAX_PER_HOST
516 837
517The maximum number of persistent connections to keep open (default: 8). 838The maximum number of concurrent connections to the same host (identified
839by the hostname). If the limit is exceeded, then the additional requests
840are queued until previous connections are closed.
518 841
519Not implemented currently. 842The default value for this is C<4>, and it is highly advisable to not
520 843increase it.
521=item $AnyEvent::HTTP::PERSISTENT_TIMEOUT
522
523The maximum time to cache a persistent connection, in seconds (default: 2).
524
525Not implemented currently.
526 844
527=item $AnyEvent::HTTP::ACTIVE 845=item $AnyEvent::HTTP::ACTIVE
528 846
529The number of active connections. This is not the number of currently 847The number of active connections. This is not the number of currently
530running requests, but the number of currently open and non-idle TCP 848running requests, but the number of currently open and non-idle TCP
532 850
533=back 851=back
534 852
535=cut 853=cut
536 854
855our @month = qw(Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec);
856our @weekday = qw(Sun Mon Tue Wed Thu Fri Sat);
857
858sub format_date($) {
859 my ($time) = @_;
860
861 # RFC 822/1123 format
862 my ($S, $M, $H, $mday, $mon, $year, $wday, $yday, undef) = gmtime $time;
863
864 sprintf "%s, %02d %s %04d %02d:%02d:%02d GMT",
865 $weekday[$wday], $mday, $month[$mon], $year + 1900,
866 $H, $M, $S;
867}
868
869sub parse_date($) {
870 my ($date) = @_;
871
872 my ($d, $m, $y, $H, $M, $S);
873
874 if ($date =~ /^[A-Z][a-z][a-z], ([0-9][0-9]) ([A-Z][a-z][a-z]) ([0-9][0-9][0-9][0-9]) ([0-9][0-9]):([0-9][0-9]):([0-9][0-9]) GMT$/) {
875 # RFC 822/1123, required by RFC 2616
876 ($d, $m, $y, $H, $M, $S) = ($1, $2, $3, $4, $5, $6);
877
878 } elsif ($date =~ /^[A-Z][a-z]+, ([0-9][0-9])-([A-Z][a-z][a-z])-([0-9][0-9]) ([0-9][0-9]):([0-9][0-9]):([0-9][0-9]) GMT$/) {
879 # RFC 850
880 ($d, $m, $y, $H, $M, $S) = ($1, $2, $3 < 69 ? $3 + 2000 : $3 + 1900, $4, $5, $6);
881
882 } elsif ($date =~ /^[A-Z][a-z][a-z] ([A-Z][a-z][a-z]) ([0-9 ][0-9]) ([0-9][0-9]):([0-9][0-9]):([0-9][0-9]) ([0-9][0-9][0-9][0-9])$/) {
883 # ISO C's asctime
884 ($d, $m, $y, $H, $M, $S) = ($2, $1, $6, $3, $4, $5);
885 }
886 # other formats fail in the loop below
887
888 for (0..11) {
889 if ($m eq $month[$_]) {
890 require Time::Local;
891 return Time::Local::timegm ($S, $M, $H, $d, $_, $y);
892 }
893 }
894
895 undef
896}
897
537sub set_proxy($) { 898sub set_proxy($) {
899 if (length $_[0]) {
538 $PROXY = [$2, $3 || 3128, $1] if $_[0] =~ m%^(https?):// ([^:/]+) (?: : (\d*) )?%ix; 900 $_[0] =~ m%^(https?):// ([^:/]+) (?: : (\d*) )?%ix
901 or Carp::croak "$_[0]: invalid proxy URL";
902 $PROXY = [$2, $3 || 3128, $1]
903 } else {
904 undef $PROXY;
905 }
539} 906}
540 907
541# initialise proxy from environment 908# initialise proxy from environment
909eval {
542set_proxy $ENV{http_proxy}; 910 set_proxy $ENV{http_proxy};
911};
912
913=head2 SOCKS PROXIES
914
915Socks proxies are not directly supported by AnyEvent::HTTP. You can
916compile your perl to support socks, or use an external program such as
917F<socksify> (dante) or F<tsocks> to make your program use a socks proxy
918transparently.
919
920Alternatively, for AnyEvent::HTTP only, you can use your own
921C<tcp_connect> function that does the proxy handshake - here is an example
922that works with socks4a proxies:
923
924 use Errno;
925 use AnyEvent::Util;
926 use AnyEvent::Socket;
927 use AnyEvent::Handle;
928
929 # host, port and username of/for your socks4a proxy
930 my $socks_host = "10.0.0.23";
931 my $socks_port = 9050;
932 my $socks_user = "";
933
934 sub socks4a_connect {
935 my ($host, $port, $connect_cb, $prepare_cb) = @_;
936
937 my $hdl = new AnyEvent::Handle
938 connect => [$socks_host, $socks_port],
939 on_prepare => sub { $prepare_cb->($_[0]{fh}) },
940 on_error => sub { $connect_cb->() },
941 ;
942
943 $hdl->push_write (pack "CCnNZ*Z*", 4, 1, $port, 1, $socks_user, $host);
944
945 $hdl->push_read (chunk => 8, sub {
946 my ($hdl, $chunk) = @_;
947 my ($status, $port, $ipn) = unpack "xCna4", $chunk;
948
949 if ($status == 0x5a) {
950 $connect_cb->($hdl->{fh}, (format_address $ipn) . ":$port");
951 } else {
952 $! = Errno::ENXIO; $connect_cb->();
953 }
954 });
955
956 $hdl
957 }
958
959Use C<socks4a_connect> instead of C<tcp_connect> when doing C<http_request>s,
960possibly after switching off other proxy types:
961
962 AnyEvent::HTTP::set_proxy undef; # usually you do not want other proxies
963
964 http_get 'http://www.google.com', tcp_connect => \&socks4a_connect, sub {
965 my ($data, $headers) = @_;
966 ...
967 };
543 968
544=head1 SEE ALSO 969=head1 SEE ALSO
545 970
546L<AnyEvent>. 971L<AnyEvent>.
547 972
548=head1 AUTHOR 973=head1 AUTHOR
549 974
550 Marc Lehmann <schmorp@schmorp.de> 975 Marc Lehmann <schmorp@schmorp.de>
551 http://home.schmorp.de/ 976 http://home.schmorp.de/
552 977
978With many thanks to Дмитрий Шалашов, who provided countless
979testcases and bugreports.
980
553=cut 981=cut
554 982
5551 9831
556 984

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines