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.24 by root, Wed Jul 2 01:30:33 2008 UTC vs.
Revision 1.67 by root, Fri Dec 31 06:18:54 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.03'; 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<$bod>. 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
357# continue to parse $_ for headers and place them into the arg
358sub parse_hdr() {
359 my %hdr;
360
361 # things seen, not parsed:
362 # p3pP="NON CUR OTPi OUR NOR UNI"
363
364 $hdr{lc $1} .= ",$2"
365 while /\G
366 ([^:\000-\037]*):
367 [\011\040]*
368 ((?: [^\012]+ | \012[\011\040] )*)
369 \012
370 /gxc;
371
372 /\G$/
373 or return;
374
375 # remove the "," prefix we added to all headers above
376 substr $_, 0, 1, ""
377 for values %hdr;
378
379 \%hdr
380}
381
382our $qr_nlnl = qr{(?<![^\012])\015?\012};
383
384our $TLS_CTX_LOW = { cache => 1, sslv2 => 1 };
385our $TLS_CTX_HIGH = { cache => 1, verify => 1, verify_peername => "https" };
386
226sub http_request($$@) { 387sub http_request($$@) {
227 my $cb = pop; 388 my $cb = pop;
228 my ($method, $url, %arg) = @_; 389 my ($method, $url, %arg) = @_;
229 390
230 my %hdr; 391 my %hdr;
392
393 $arg{tls_ctx} = $TLS_CTX_LOW if $arg{tls_ctx} eq "low" || !exists $arg{tls_ctx};
394 $arg{tls_ctx} = $TLS_CTX_HIGH if $arg{tls_ctx} eq "high";
231 395
232 $method = uc $method; 396 $method = uc $method;
233 397
234 if (my $hdr = $arg{headers}) { 398 if (my $hdr = $arg{headers}) {
235 while (my ($k, $v) = each %$hdr) { 399 while (my ($k, $v) = each %$hdr) {
236 $hdr{lc $k} = $v; 400 $hdr{lc $k} = $v;
237 } 401 }
238 } 402 }
239 403
404 # pseudo headers for all subsequent responses
405 my @pseudo = (URL => $url);
406 push @pseudo, Redirect => delete $arg{Redirect} if exists $arg{Redirect};
407
240 my $recurse = exists $arg{recurse} ? delete $arg{recurse} : $MAX_RECURSE; 408 my $recurse = exists $arg{recurse} ? delete $arg{recurse} : $MAX_RECURSE;
241 409
242 return $cb->(undef, { Status => 599, Reason => "recursion limit reached", URL => $url }) 410 return $cb->(undef, { @pseudo, Status => 599, Reason => "Too many redirections" })
243 if $recurse < 0; 411 if $recurse < 0;
244 412
245 my $proxy = $arg{proxy} || $PROXY; 413 my $proxy = $arg{proxy} || $PROXY;
246 my $timeout = $arg{timeout} || $TIMEOUT; 414 my $timeout = $arg{timeout} || $TIMEOUT;
247 415
248 $hdr{"user-agent"} ||= $USERAGENT;
249
250 my ($scheme, $authority, $upath, $query, $fragment) = 416 my ($uscheme, $uauthority, $upath, $query, $fragment) =
251 $url =~ m|(?:([^:/?#]+):)?(?://([^/?#]*))?([^?#]*)(?:\?([^#]*))?(?:#(.*))?|; 417 $url =~ m|(?:([^:/?#]+):)?(?://([^/?#]*))?([^?#]*)(?:(\?[^#]*))?(?:#(.*))?|;
252 418
253 $scheme = lc $scheme; 419 $uscheme = lc $uscheme;
254 420
255 my $uport = $scheme eq "http" ? 80 421 my $uport = $uscheme eq "http" ? 80
256 : $scheme eq "https" ? 443 422 : $uscheme eq "https" ? 443
257 : return $cb->(undef, { Status => 599, Reason => "only http and https URL schemes supported", URL => $url }); 423 : return $cb->(undef, { @pseudo, Status => 599, Reason => "Only http and https URL schemes supported" });
258 424
259 $hdr{referer} ||= "$scheme://$authority$upath"; # leave out fragment and query string, just a heuristic
260
261 $authority =~ /^(?: .*\@ )? ([^\@:]+) (?: : (\d+) )?$/x 425 $uauthority =~ /^(?: .*\@ )? ([^\@:]+) (?: : (\d+) )?$/x
262 or return $cb->(undef, { Status => 599, Reason => "unparsable URL", URL => $url }); 426 or return $cb->(undef, { @pseudo, Status => 599, Reason => "Unparsable URL" });
263 427
264 my $uhost = $1; 428 my $uhost = $1;
265 $uport = $2 if defined $2; 429 $uport = $2 if defined $2;
266 430
431 $hdr{host} = defined $2 ? "$uhost:$2" : "$uhost"
432 unless exists $hdr{host};
433
267 $uhost =~ s/^\[(.*)\]$/$1/; 434 $uhost =~ s/^\[(.*)\]$/$1/;
268 $upath .= "?$query" if length $query; 435 $upath .= $query if length $query;
269 436
270 $upath =~ s%^/?%/%; 437 $upath =~ s%^/?%/%;
271 438
272 # cookie processing 439 # cookie processing
273 if (my $jar = $arg{cookie_jar}) { 440 if (my $jar = $arg{cookie_jar}) {
274 %$jar = () if $jar->{version} < 1; 441 %$jar = () if $jar->{version} != 1;
275 442
276 my @cookie; 443 my @cookie;
277 444
278 while (my ($chost, $v) = each %$jar) { 445 while (my ($chost, $v) = each %$jar) {
446 if ($chost =~ /^\./) {
279 next unless $chost eq substr $uhost, -length $chost; 447 next unless $chost eq substr $uhost, -length $chost;
280 next unless $chost =~ /^\./; 448 } elsif ($chost =~ /\./) {
449 next unless $chost eq $uhost;
450 } else {
451 next;
452 }
281 453
282 while (my ($cpath, $v) = each %$v) { 454 while (my ($cpath, $v) = each %$v) {
283 next unless $cpath eq substr $upath, 0, length $cpath; 455 next unless $cpath eq substr $upath, 0, length $cpath;
284 456
285 while (my ($k, $v) = each %$v) { 457 while (my ($k, $v) = each %$v) {
286 next if $scheme ne "https" && exists $v->{secure}; 458 next if $uscheme ne "https" && exists $v->{secure};
459 my $value = $v->{value};
460 $value =~ s/([\\"])/\\$1/g;
287 push @cookie, "$k=$v->{value}"; 461 push @cookie, "$k=\"$value\"";
288 } 462 }
289 } 463 }
290 } 464 }
291 465
292 $hdr{cookie} = join "; ", @cookie 466 $hdr{cookie} = join "; ", @cookie
293 if @cookie; 467 if @cookie;
294 } 468 }
295 469
296 my ($rhost, $rport, $rpath); # request host, port, path 470 my ($rhost, $rport, $rscheme, $rpath); # request host, port, path
297 471
298 if ($proxy) { 472 if ($proxy) {
299 ($rhost, $rport, $scheme) = @$proxy; 473 ($rpath, $rhost, $rport, $rscheme) = ($url, @$proxy);
300 $rpath = $url; 474
475 $rscheme = "http" unless defined $rscheme;
476
477 # don't support https requests over https-proxy transport,
478 # can't be done with tls as spec'ed, unless you double-encrypt.
479 $rscheme = "http" if $uscheme eq "https" && $rscheme eq "https";
301 } else { 480 } else {
302 ($rhost, $rport, $rpath) = ($uhost, $uport, $upath); 481 ($rhost, $rport, $rscheme, $rpath) = ($uhost, $uport, $uscheme, $upath);
303 $hdr{host} = $uhost;
304 } 482 }
305 483
484 # leave out fragment and query string, just a heuristic
485 $hdr{referer} = "$uscheme://$uauthority$upath" unless exists $hdr{referer};
486 $hdr{"user-agent"} = $USERAGENT unless exists $hdr{"user-agent"};
487
306 $hdr{"content-length"} = length $arg{body}; 488 $hdr{"content-length"} = length $arg{body}
489 if length $arg{body} || $method ne "GET";
490
491 $hdr{connection} = "close TE";
492 $hdr{te} = "trailers" unless exists $hdr{te};
307 493
308 my %state = (connect_guard => 1); 494 my %state = (connect_guard => 1);
309 495
310 _get_slot $uhost, sub { 496 _get_slot $uhost, sub {
311 $state{slot_guard} = shift; 497 $state{slot_guard} = shift;
312 498
313 return unless $state{connect_guard}; 499 return unless $state{connect_guard};
314 500
315 $state{connect_guard} = AnyEvent::Socket::tcp_connect $rhost, $rport, sub { 501 my $connect_cb = sub {
316 $state{fh} = shift 502 $state{fh} = shift
503 or do {
504 my $err = "$!";
505 %state = ();
317 or return $cb->(undef, { Status => 599, Reason => "$!", URL => $url }); 506 return $cb->(undef, { @pseudo, Status => 599, Reason => $err });
507 };
318 508
319 delete $state{connect_guard}; # reduce memory usage, save a tree 509 pop; # free memory, save a tree
510
511 return unless delete $state{connect_guard};
320 512
321 # get handle 513 # get handle
322 $state{handle} = new AnyEvent::Handle 514 $state{handle} = new AnyEvent::Handle
323 fh => $state{fh}, 515 fh => $state{fh},
324 ($scheme eq "https" ? (tls => "connect") : ()); 516 peername => $rhost,
517 tls_ctx => $arg{tls_ctx},
518 # these need to be reconfigured on keepalive handles
519 timeout => $timeout,
520 on_error => sub {
521 %state = ();
522 $cb->(undef, { @pseudo, Status => 599, Reason => $_[2] });
523 },
524 on_eof => sub {
525 %state = ();
526 $cb->(undef, { @pseudo, Status => 599, Reason => "Unexpected end-of-file" });
527 },
528 ;
325 529
326 # limit the number of persistent connections 530 # limit the number of persistent connections
531 # keepalive not yet supported
327 if ($KA_COUNT{$_[1]} < $MAX_PERSISTENT_PER_HOST) { 532# if ($KA_COUNT{$_[1]} < $MAX_PERSISTENT_PER_HOST) {
328 ++$KA_COUNT{$_[1]}; 533# ++$KA_COUNT{$_[1]};
329 $state{handle}{ka_count_guard} = AnyEvent::Util::guard { --$KA_COUNT{$_[1]} }; 534# $state{handle}{ka_count_guard} = AnyEvent::Util::guard {
535# --$KA_COUNT{$_[1]}
536# };
330 $hdr{connection} = "keep-alive"; 537# $hdr{connection} = "keep-alive";
331 delete $hdr{connection}; # keep-alive not yet supported
332 } else { 538# } else {
333 delete $hdr{connection}; 539# delete $hdr{connection};
334 } 540# }
335 541
336 # (re-)configure handle 542 $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 543
544 # handle actual, non-tunneled, request
545 my $handle_actual_request = sub {
546 $state{handle}->starttls ("connect") if $uscheme eq "https" && !exists $state{handle}{tls};
547
348 # send request 548 # send request
349 $state{handle}->push_write ( 549 $state{handle}->push_write (
350 "$method $rpath HTTP/1.0\015\012" 550 "$method $rpath HTTP/1.1\015\012"
351 . (join "", map "$_: $hdr{$_}\015\012", keys %hdr) 551 . (join "", map "\u$_: $hdr{$_}\015\012", grep defined $hdr{$_}, keys %hdr)
352 . "\015\012" 552 . "\015\012"
353 . (delete $arg{body}) 553 . (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 ); 554 );
369 555
370 # headers, could be optimized a bit 556 # return if error occured during push_write()
557 return unless %state;
558
559 %hdr = (); # reduce memory usage, save a kitten, also make it possible to re-use
560
561 # status line and headers
371 $state{handle}->unshift_read (line => qr/\015?\012\015?\012/, sub { 562 $state{handle}->push_read (line => $qr_nlnl, sub {
563 my $keepalive = pop;
564
372 for ("$_[1]\012") { 565 for ("$_[1]") {
373 # we support spaces in field names, as lotus domino 566 y/\015//d; # weed out any \015, as they show up in the weirdest of places.
374 # creates them.
375 $hdr{lc $1} .= "\x00$2"
376 while /\G
377 ([^:\000-\037]+):
378 [\011\040]*
379 ((?: [^\015\012]+ | \015?\012[\011\040] )*)
380 \015?\012
381 /gxc;
382 567
568 /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\012]*) )? \012/igxc
569 or return (%state = (), $cb->(undef, { @pseudo, Status => 599, Reason => "Invalid server response" }));
570
571 push @pseudo,
572 HTTPVersion => $1,
573 Status => $2,
574 Reason => $3,
383 /\G$/ 575 ;
576
577 my $hdr = parse_hdr
384 or return (%state = (), $cb->(undef, { Status => 599, Reason => "garbled response headers", URL => $url })); 578 or return (%state = (), $cb->(undef, { @pseudo, Status => 599, Reason => "Garbled response headers" }));
579
580 %hdr = (%$hdr, @pseudo);
385 } 581 }
386 582
387 substr $_, 0, 1, "" 583 # redirect handling
388 for values %hdr; 584 # microsoft and other shitheads don't give a shit for following standards,
585 # try to support some common forms of broken Location headers.
586 if ($hdr{location} !~ /^(?: $ | [^:\/?\#]+ : )/x) {
587 $hdr{location} =~ s/^\.\/+//;
389 588
390 my $finish = sub { 589 my $url = "$rscheme://$uhost:$uport";
590
591 unless ($hdr{location} =~ s/^\///) {
592 $url .= $upath;
593 $url =~ s/\/[^\/]*$//;
594 }
595
596 $hdr{location} = "$url/$hdr{location}";
597 }
598
599 my $redirect;
600
601 if ($recurse) {
602 my $status = $hdr{Status};
603
604 # industry standard is to redirect POST as GET for
605 # 301, 302 and 303, in contrast to http/1.0 and 1.1.
606 # also, the UA should ask the user for 301 and 307 and POST,
607 # industry standard seems to be to simply follow.
608 # we go with the industry standard.
609 if ($status == 301 or $status == 302 or $status == 303) {
610 # HTTP/1.1 is unclear on how to mutate the method
611 $method = "GET" unless $method eq "HEAD";
612 $redirect = 1;
613 } elsif ($status == 307) {
614 $redirect = 1;
615 }
616 }
617
618 my $finish = sub { # ($data, $err_status, $err_reason[, $keepalive])
619 $state{handle}->destroy if $state{handle};
391 %state = (); 620 %state = ();
392 621
622 if (defined $_[1]) {
623 $hdr{OrigStatus} = $hdr{Status}; $hdr{Status} = $_[1];
624 $hdr{OrigReason} = $hdr{Reason}; $hdr{Reason} = $_[2];
625 }
626
393 # set-cookie processing 627 # set-cookie processing
394 if ($arg{cookie_jar} && exists $hdr{"set-cookie"}) { 628 if ($arg{cookie_jar}) {
395 for (split /\x00/, $hdr{"set-cookie"}) { 629 for ($hdr{"set-cookie"}) {
396 my ($cookie, @arg) = split /;\s*/; 630 # parse NAME=VALUE
397 my ($name, $value) = split /=/, $cookie, 2; 631 my @kv;
398 my %kv = (value => $value, map { split /=/, $_, 2 } @arg); 632
633 while (/\G\s* ([^=;,[:space:]]+) \s*=\s* (?: "((?:[^\\"]+|\\.)*)" | ([^=;,[:space:]]*) )/gcxs) {
634 my $name = $1;
635 my $value = $3;
636
637 unless ($value) {
638 $value = $2;
639 $value =~ s/\\(.)/$1/gs;
640 }
641
642 push @kv, $name => $value;
643
644 last unless /\G\s*;/gc;
645 }
646
647 last unless @kv;
648
649 my $name = shift @kv;
650 my %kv = (value => shift @kv, @kv);
651
652 my $cdom;
653 my $cpath = (delete $kv{path}) || "/";
654
655 if (exists $kv{domain}) {
656 $cdom = delete $kv{domain};
399 657
400 my $cdom = (delete $kv{domain}) || $uhost;
401 my $cpath = (delete $kv{path}) || "/";
402
403 $cdom =~ s/^.?/./; # make sure it starts with a "." 658 $cdom =~ s/^\.?/./; # make sure it starts with a "."
404 659
405 next if $cdom =~ /\.$/; 660 next if $cdom =~ /\.$/;
406 661
407 # this is not rfc-like and not netscape-like. go figure. 662 # this is not rfc-like and not netscape-like. go figure.
408 my $ndots = $cdom =~ y/.//; 663 my $ndots = $cdom =~ y/.//;
409 next if $ndots < ($cdom =~ /\.[^.][^.]\.[^.][^.]$/ ? 3 : 2); 664 next if $ndots < ($cdom =~ /\.[^.][^.]\.[^.][^.]$/ ? 3 : 2);
665 } else {
666 $cdom = $uhost;
667 }
410 668
411 # store it 669 # store it
412 $arg{cookie_jar}{version} = 1; 670 $arg{cookie_jar}{version} = 1;
413 $arg{cookie_jar}{$cdom}{$cpath}{$name} = \%kv; 671 $arg{cookie_jar}{$cdom}{$cpath}{$name} = \%kv;
672
673 redo if /\G\s*,/gc;
414 } 674 }
415 } 675 }
416 676
417 # microsoft and other assholes don't give a shit for following standards, 677 if ($redirect && exists $hdr{location}) {
418 # try to support a common form of broken Location header. 678 # we ignore any errors, as it is very common to receive
419 $_[1]{location} =~ s%^/%$scheme://$uhost:$uport/% 679 # Content-Length != 0 but no actual body
420 if exists $_[1]{location}; 680 # we also access %hdr, as $_[1] might be an erro
421 681 http_request (
422 if ($_[1]{Status} =~ /^30[12]$/ && $recurse && $method ne "POST") { 682 $method => $hdr{location},
423 # apparently, mozilla et al. just change POST to GET here 683 %arg,
424 # more research is needed before we do the same 684 recurse => $recurse - 1,
425 http_request ($method, $_[1]{location}, %arg, recurse => $recurse - 1, $cb); 685 Redirect => [$_[0], \%hdr],
426 } elsif ($_[1]{Status} == 303 && $recurse) { 686 $cb);
427 # even http/1.1 is unlear on how to mutate the method
428 $method = "GET" unless $method eq "HEAD";
429 http_request ($method => $_[1]{location}, %arg, recurse => $recurse - 1, $cb);
430 } elsif ($_[1]{Status} == 307 && $recurse && $method =~ /^(?:GET|HEAD)$/) {
431 http_request ($method => $_[1]{location}, %arg, recurse => $recurse - 1, $cb);
432 } else { 687 } else {
433 $cb->($_[0], $_[1]); 688 $cb->($_[0], \%hdr);
434 } 689 }
435 }; 690 };
436 691
437 if ($hdr{Status} =~ /^(?:1..|204|304)$/ or $method eq "HEAD") { 692 my $len = $hdr{"content-length"};
693
694 if (!$redirect && $arg{on_header} && !$arg{on_header}(\%hdr)) {
695 $finish->(undef, 598 => "Request cancelled by on_header");
696 } elsif (
697 $hdr{Status} =~ /^(?:1..|204|205|304)$/
698 or $method eq "HEAD"
699 or (defined $len && !$len)
700 ) {
701 # no body
438 $finish->(undef, \%hdr); 702 $finish->("", undef, undef, 1);
439 } else { 703 } else {
440 if (exists $hdr{"content-length"}) { 704 # body handling, many different code paths
441 $_[0]->unshift_read (chunk => $hdr{"content-length"}, sub { 705 # - no body expected
442 # could cache persistent connection now 706 # - want_body_handle
443 if ($hdr{connection} =~ /\bkeep-alive\b/i) { 707 # - te chunked
444 # but we don't, due to misdesigns, this is annoyingly complex 708 # - 2x length known (with or without on_body)
709 # - 2x length not known (with or without on_body)
710 if (!$redirect && $arg{want_body_handle}) {
711 $_[0]->on_eof (undef);
712 $_[0]->on_error (undef);
713 $_[0]->on_read (undef);
714
715 $finish->(delete $state{handle});
716
717 } elsif ($hdr{"transfer-encoding"} =~ /chunked/) {
718 my $body = undef;
719 my $on_body = $arg{on_body} || sub { $body .= shift; 1 };
720
721 $_[0]->on_error (sub { $finish->(undef, 599 => $_[2]) });
722
723 my $read_chunk; $read_chunk = sub {
724 $_[1] =~ /^([0-9a-fA-F]+)/
725 or $finish->(undef, 599 => "Garbled chunked transfer encoding");
726
727 my $len = hex $1;
728
729 if ($len) {
730 $_[0]->push_read (chunk => hex $1, sub {
731 $on_body->($_[1], \%hdr)
732 or return $finish->(undef, 598 => "Request cancelled by on_body");
733
734 $_[0]->push_read (line => sub {
735 length $_[1]
736 and return $finish->(undef, 599 => "Garbled chunked transfer encoding");
737 $_[0]->push_read (line => $read_chunk);
738 });
739 });
740 } else {
741 $_[0]->push_read (line => $qr_nlnl, sub {
742 if (length $_[1]) {
743 for ("$_[1]") {
744 y/\015//d; # weed out any \015, as they show up in the weirdest of places.
745
746 my $hdr = parse_hdr
747 or return $finish->(undef, 599 => "Garbled response trailers");
748
749 %hdr = (%hdr, %$hdr);
750 }
751 }
752
753 $finish->($body, undef, undef, 1);
754 });
755 }
756 };
757
758 $_[0]->push_read (line => $read_chunk);
759
760 } elsif ($arg{on_body}) {
761 $_[0]->on_error (sub { $finish->(undef, 599 => $_[2]) });
762
763 if ($len) {
764 $_[0]->on_read (sub {
765 $len -= length $_[0]{rbuf};
766
767 $arg{on_body}(delete $_[0]{rbuf}, \%hdr)
768 or return $finish->(undef, 598 => "Request cancelled by on_body");
769
770 $len > 0
771 or $finish->("", undef, undef, 1);
445 }; 772 });
446 773 } else {
774 $_[0]->on_eof (sub {
447 $finish->($_[1], \%hdr); 775 $finish->("");
776 });
777 $_[0]->on_read (sub {
778 $arg{on_body}(delete $_[0]{rbuf}, \%hdr)
779 or $finish->(undef, 598 => "Request cancelled by on_body");
780 });
448 }); 781 }
449 } else { 782 } else {
450 # too bad, need to read until we get an error or EOF,
451 # no way to detect winged data.
452 $_[0]->on_error (sub {
453 $finish->($_[0]{rbuf}, \%hdr);
454 });
455 $_[0]->on_eof (undef); 783 $_[0]->on_eof (undef);
784
785 if ($len) {
786 $_[0]->on_error (sub { $finish->(undef, 599 => $_[2]) });
787 $_[0]->on_read (sub {
788 $finish->((substr delete $_[0]{rbuf}, 0, $len, ""), undef, undef, 1)
789 if $len <= length $_[0]{rbuf};
790 });
791 } else {
792 $_[0]->on_error (sub {
793 ($! == Errno::EPIPE || !$!)
794 ? $finish->(delete $_[0]{rbuf})
795 : $finish->(undef, 599 => $_[2]);
796 });
456 $_[0]->on_read (sub { }); 797 $_[0]->on_read (sub { });
798 }
457 } 799 }
458 } 800 }
459 }); 801 });
460 }); 802 };
461 }, sub { 803
462 $timeout 804 # now handle proxy-CONNECT method
805 if ($proxy && $uscheme eq "https") {
806 # oh dear, we have to wrap it into a connect request
807
808 # maybe re-use $uauthority with patched port?
809 $state{handle}->push_write ("CONNECT $uhost:$uport HTTP/1.0\015\012Host: $uhost\015\012\015\012");
810 $state{handle}->push_read (line => $qr_nlnl, sub {
811 $_[1] =~ /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\015\012]*) )?/ix
812 or return (%state = (), $cb->(undef, { @pseudo, Status => 599, Reason => "Invalid proxy connect response ($_[1])" }));
813
814 if ($2 == 200) {
815 $rpath = $upath;
816 &$handle_actual_request;
817 } else {
818 %state = ();
819 $cb->(undef, { @pseudo, Status => $2, Reason => $3 });
820 }
821 });
822 } else {
823 &$handle_actual_request;
824 }
463 }; 825 };
826
827 my $tcp_connect = $arg{tcp_connect}
828 || do { require AnyEvent::Socket; \&AnyEvent::Socket::tcp_connect };
829
830 $state{connect_guard} = $tcp_connect->($rhost, $rport, $connect_cb, $arg{on_prepare} || sub { $timeout });
831
464 }; 832 };
465 833
466 defined wantarray && AnyEvent::Util::guard { %state = () } 834 defined wantarray && AnyEvent::Util::guard { %state = () }
467} 835}
468 836
482 &http_request 850 &http_request
483} 851}
484 852
485=back 853=back
486 854
855=head2 DNS CACHING
856
857AnyEvent::HTTP uses the AnyEvent::Socket::tcp_connect function for
858the actual connection, which in turn uses AnyEvent::DNS to resolve
859hostnames. The latter is a simple stub resolver and does no caching
860on its own. If you want DNS caching, you currently have to provide
861your own default resolver (by storing a suitable resolver object in
862C<$AnyEvent::DNS::RESOLVER>).
863
487=head2 GLOBAL FUNCTIONS AND VARIABLES 864=head2 GLOBAL FUNCTIONS AND VARIABLES
488 865
489=over 4 866=over 4
490 867
491=item AnyEvent::HTTP::set_proxy "proxy-url" 868=item AnyEvent::HTTP::set_proxy "proxy-url"
492 869
493Sets the default proxy server to use. The proxy-url must begin with a 870Sets the default proxy server to use. The proxy-url must begin with a
494string of the form C<http://host:port> (optionally C<https:...>). 871string of the form C<http://host:port> (optionally C<https:...>), croaks
872otherwise.
873
874To clear an already-set proxy, use C<undef>.
875
876=item $date = AnyEvent::HTTP::format_date $timestamp
877
878Takes a POSIX timestamp (seconds since the epoch) and formats it as a HTTP
879Date (RFC 2616).
880
881=item $timestamp = AnyEvent::HTTP::parse_date $date
882
883Takes a HTTP Date (RFC 2616) and returns the corresponding POSIX
884timestamp, or C<undef> if the date cannot be parsed.
495 885
496=item $AnyEvent::HTTP::MAX_RECURSE 886=item $AnyEvent::HTTP::MAX_RECURSE
497 887
498The default value for the C<recurse> request parameter (default: C<10>). 888The default value for the C<recurse> request parameter (default: C<10>).
499 889
500=item $AnyEvent::HTTP::USERAGENT 890=item $AnyEvent::HTTP::USERAGENT
501 891
502The default value for the C<User-Agent> header (the default is 892The default value for the C<User-Agent> header (the default is
503C<Mozilla/5.0 (compatible; AnyEvent::HTTP/$VERSION; +http://software.schmorp.de/pkg/AnyEvent)>). 893C<Mozilla/5.0 (compatible; U; AnyEvent-HTTP/$VERSION; +http://software.schmorp.de/pkg/AnyEvent)>).
504 894
505=item $AnyEvent::HTTP::MAX_PERSISTENT 895=item $AnyEvent::HTTP::MAX_PER_HOST
506 896
507The maximum number of persistent connections to keep open (default: 8). 897The maximum number of concurrent connections to the same host (identified
898by the hostname). If the limit is exceeded, then the additional requests
899are queued until previous connections are closed.
508 900
509Not implemented currently. 901The default value for this is C<4>, and it is highly advisable to not
510 902increase it.
511=item $AnyEvent::HTTP::PERSISTENT_TIMEOUT
512
513The maximum time to cache a persistent connection, in seconds (default: 2).
514
515Not implemented currently.
516 903
517=item $AnyEvent::HTTP::ACTIVE 904=item $AnyEvent::HTTP::ACTIVE
518 905
519The number of active connections. This is not the number of currently 906The number of active connections. This is not the number of currently
520running requests, but the number of currently open and non-idle TCP 907running requests, but the number of currently open and non-idle TCP
522 909
523=back 910=back
524 911
525=cut 912=cut
526 913
914our @month = qw(Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec);
915our @weekday = qw(Sun Mon Tue Wed Thu Fri Sat);
916
917sub format_date($) {
918 my ($time) = @_;
919
920 # RFC 822/1123 format
921 my ($S, $M, $H, $mday, $mon, $year, $wday, $yday, undef) = gmtime $time;
922
923 sprintf "%s, %02d %s %04d %02d:%02d:%02d GMT",
924 $weekday[$wday], $mday, $month[$mon], $year + 1900,
925 $H, $M, $S;
926}
927
928sub parse_date($) {
929 my ($date) = @_;
930
931 my ($d, $m, $y, $H, $M, $S);
932
933 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$/) {
934 # RFC 822/1123, required by RFC 2616
935 ($d, $m, $y, $H, $M, $S) = ($1, $2, $3, $4, $5, $6);
936
937 } 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$/) {
938 # RFC 850
939 ($d, $m, $y, $H, $M, $S) = ($1, $2, $3 < 69 ? $3 + 2000 : $3 + 1900, $4, $5, $6);
940
941 } 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])$/) {
942 # ISO C's asctime
943 ($d, $m, $y, $H, $M, $S) = ($2, $1, $6, $3, $4, $5);
944 }
945 # other formats fail in the loop below
946
947 for (0..11) {
948 if ($m eq $month[$_]) {
949 require Time::Local;
950 return Time::Local::timegm ($S, $M, $H, $d, $_, $y);
951 }
952 }
953
954 undef
955}
956
527sub set_proxy($) { 957sub set_proxy($) {
958 if (length $_[0]) {
528 $PROXY = [$2, $3 || 3128, $1] if $_[0] =~ m%^(https?):// ([^:/]+) (?: : (\d*) )?%ix; 959 $_[0] =~ m%^(https?):// ([^:/]+) (?: : (\d*) )?%ix
960 or Carp::croak "$_[0]: invalid proxy URL";
961 $PROXY = [$2, $3 || 3128, $1]
962 } else {
963 undef $PROXY;
964 }
529} 965}
530 966
531# initialise proxy from environment 967# initialise proxy from environment
968eval {
532set_proxy $ENV{http_proxy}; 969 set_proxy $ENV{http_proxy};
970};
971
972=head2 SOCKS PROXIES
973
974Socks proxies are not directly supported by AnyEvent::HTTP. You can
975compile your perl to support socks, or use an external program such as
976F<socksify> (dante) or F<tsocks> to make your program use a socks proxy
977transparently.
978
979Alternatively, for AnyEvent::HTTP only, you can use your own
980C<tcp_connect> function that does the proxy handshake - here is an example
981that works with socks4a proxies:
982
983 use Errno;
984 use AnyEvent::Util;
985 use AnyEvent::Socket;
986 use AnyEvent::Handle;
987
988 # host, port and username of/for your socks4a proxy
989 my $socks_host = "10.0.0.23";
990 my $socks_port = 9050;
991 my $socks_user = "";
992
993 sub socks4a_connect {
994 my ($host, $port, $connect_cb, $prepare_cb) = @_;
995
996 my $hdl = new AnyEvent::Handle
997 connect => [$socks_host, $socks_port],
998 on_prepare => sub { $prepare_cb->($_[0]{fh}) },
999 on_error => sub { $connect_cb->() },
1000 ;
1001
1002 $hdl->push_write (pack "CCnNZ*Z*", 4, 1, $port, 1, $socks_user, $host);
1003
1004 $hdl->push_read (chunk => 8, sub {
1005 my ($hdl, $chunk) = @_;
1006 my ($status, $port, $ipn) = unpack "xCna4", $chunk;
1007
1008 if ($status == 0x5a) {
1009 $connect_cb->($hdl->{fh}, (format_address $ipn) . ":$port");
1010 } else {
1011 $! = Errno::ENXIO; $connect_cb->();
1012 }
1013 });
1014
1015 $hdl
1016 }
1017
1018Use C<socks4a_connect> instead of C<tcp_connect> when doing C<http_request>s,
1019possibly after switching off other proxy types:
1020
1021 AnyEvent::HTTP::set_proxy undef; # usually you do not want other proxies
1022
1023 http_get 'http://www.google.com', tcp_connect => \&socks4a_connect, sub {
1024 my ($data, $headers) = @_;
1025 ...
1026 };
533 1027
534=head1 SEE ALSO 1028=head1 SEE ALSO
535 1029
536L<AnyEvent>. 1030L<AnyEvent>.
537 1031
538=head1 AUTHOR 1032=head1 AUTHOR
539 1033
540 Marc Lehmann <schmorp@schmorp.de> 1034 Marc Lehmann <schmorp@schmorp.de>
541 http://home.schmorp.de/ 1035 http://home.schmorp.de/
542 1036
1037With many thanks to Дмитрий Шалашов, who provided countless
1038testcases and bugreports.
1039
543=cut 1040=cut
544 1041
5451 10421
546 1043

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines