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.30 by root, Thu Oct 23 02:46:20 2008 UTC vs.
Revision 1.68 by root, Fri Dec 31 19:22:18 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.05'; 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
92must be an absolute http or https URL. 91must be an absolute http or https URL.
93 92
94When called in void context, nothing is returned. In other contexts, 93When called in void context, nothing is returned. In other contexts,
95C<http_request> returns a "cancellation guard" - you have to keep the 94C<http_request> returns a "cancellation guard" - you have to keep the
96object at least alive until the callback get called. If the object gets 95object at least alive until the callback get called. If the object gets
97destroyed before the callbakc is called, the request will be cancelled. 96destroyed before the callback is called, the request will be cancelled.
98 97
99The callback will be called with the response data as first argument 98The callback will be called with the response body data as first argument
100(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
101response headers as second argument. 100(and trailers) as second argument.
102 101
103All 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
104headers, 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
105contain 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
106pseudo-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
107requested 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).
108 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
109If 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
110joined together with C<\x00>. 124joined together with a comma (C<,>), as per the HTTP spec.
111 125
112If 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,
113then 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>
114and 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.
115 130
116A typical callback might look like this: 131A typical callback might look like this:
117 132
118 sub { 133 sub {
119 my ($body, $hdr) = @_; 134 my ($body, $hdr) = @_;
135Whether to recurse requests or not, e.g. on redirects, authentication 150Whether to recurse requests or not, e.g. on redirects, authentication
136retries and so on, and how often to do so. 151retries and so on, and how often to do so.
137 152
138=item headers => hashref 153=item headers => hashref
139 154
140The request headers to use. Currently, C<http_request> may provide its 155The request headers to use. Currently, C<http_request> may provide its own
141own C<Host:>, C<Content-Length:>, C<Connection:> and C<Cookie:> headers 156C<Host:>, C<Content-Length:>, C<Connection:> and C<Cookie:> headers and
142and will provide defaults for C<User-Agent:> and C<Referer:>. 157will provide defaults for C<TE:>, C<Referer:> and C<User-Agent:> (this can
158be suppressed by using C<undef> for these headers in which case they won't
159be sent at all).
143 160
144=item timeout => $seconds 161=item timeout => $seconds
145 162
146The 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
147the 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.
148 168
149=item proxy => [$host, $port[, $scheme]] or undef 169=item proxy => [$host, $port[, $scheme]] or undef
150 170
151Use 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
152default proxy (as specified by C<$ENV{http_proxy}>) is used. 172default proxy (as specified by C<$ENV{http_proxy}>) is used.
153 173
154C<$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
155HTTPS. 175HTTPS.
156 176
157=item body => $string 177=item body => $string
158 178
159The 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
160this module might offer more options). 180this module might offer more options).
161 181
162=item cookie_jar => $hash_ref 182=item cookie_jar => $hash_ref
163 183
164Passing this parameter enables (simplified) cookie-processing, loosely 184Passing this parameter enables (simplified) cookie-processing, loosely
165based on the original netscape specification. 185based on the original netscape specification.
166 186
167The 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
168get updated automatically. It is possible to save the cookie_jar to 188get updated automatically. It is possible to save the cookie_jar to
169persistent storage with something like JSON or Storable, but this is not 189persistent storage with something like JSON or Storable, but this is not
170recommended, as expire times are currently being ignored. 190recommended, as expiry times are currently being ignored.
171 191
172Note that this cookie implementation is not of very high quality, nor 192Note that this cookie implementation is not of very high quality, nor
173meant 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
174do 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
175cookie-using sites working. Cookies are a privacy disaster, do not use 195cookie-using sites working. Cookies are a privacy disaster, do not use
176them unless required to. 196them unless required to.
177 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
245The downside is that cancelling the request makes it impossible to re-use
246the connection. Also, the C<on_header> callback will not receive any
247trailer (headers sent after the response body).
248
249Example: cancel the request unless the content-type is "text/html".
250
251 on_header => sub {
252 $_[0]{"content-type"} =~ /^text\/html\s*(?:;|$)/
253 },
254
255=item on_body => $callback->($partial_body, $headers)
256
257When specified, all body data will be passed to this callback instead of
258to the completion callback. The completion callback will get the empty
259string instead of the body data.
260
261It has to return either true (in which case AnyEvent::HTTP will continue),
262or false, in which case AnyEvent::HTTP will cancel the download (and call
263the completion callback with an error code of C<598>).
264
265The downside to cancelling the request is that it makes it impossible to
266re-use the connection.
267
268This callback is useful when the data is too large to be held in memory
269(so the callback writes it to a file) or when only some information should
270be extracted, or when the body should be processed incrementally.
271
272It is usually preferred over doing your own body handling via
273C<want_body_handle>, but in case of streaming APIs, where HTTP is
274only used to create a connection, C<want_body_handle> is the better
275alternative, as it allows you to install your own event handler, reducing
276resource usage.
277
278=item want_body_handle => $enable
279
280When enabled (default is disabled), the behaviour of AnyEvent::HTTP
281changes considerably: after parsing the headers, and instead of
282downloading the body (if any), the completion callback will be
283called. Instead of the C<$body> argument containing the body data, the
284callback will receive the L<AnyEvent::Handle> object associated with the
285connection. In error cases, C<undef> will be passed. When there is no body
286(e.g. status C<304>), the empty string will be passed.
287
288The handle object might or might not be in TLS mode, might be connected to
289a proxy, be a persistent connection etc., and configured in unspecified
290ways. The user is responsible for this handle (it will not be used by this
291module anymore).
292
293This is useful with some push-type services, where, after the initial
294headers, an interactive protocol is used (typical example would be the
295push-style twitter API which starts a JSON/XML stream).
296
297If you think you need this, first have a look at C<on_body>, to see if
298that doesn't solve your problem in a better way.
299
178=back 300=back
179 301
180Example: make a simple HTTP GET request for http://www.nethype.de/ 302Example: do a simple HTTP GET request for http://www.nethype.de/ and print
303the response body.
181 304
182 http_request GET => "http://www.nethype.de/", sub { 305 http_request GET => "http://www.nethype.de/", sub {
183 my ($body, $hdr) = @_; 306 my ($body, $hdr) = @_;
184 print "$body\n"; 307 print "$body\n";
185 }; 308 };
186 309
187Example: make a HTTP HEAD request on https://www.google.com/, use a 310Example: do a HTTP HEAD request on https://www.google.com/, use a
188timeout of 30 seconds. 311timeout of 30 seconds.
189 312
190 http_request 313 http_request
191 GET => "https://www.google.com", 314 GET => "https://www.google.com",
192 timeout => 30, 315 timeout => 30,
195 use Data::Dumper; 318 use Data::Dumper;
196 print Dumper $hdr; 319 print Dumper $hdr;
197 } 320 }
198 ; 321 ;
199 322
200Example: make another simple HTTP GET request, but immediately try to 323Example: do another simple HTTP GET request, but immediately try to
201cancel it. 324cancel it.
202 325
203 my $request = http_request GET => "http://www.nethype.de/", sub { 326 my $request = http_request GET => "http://www.nethype.de/", sub {
204 my ($body, $hdr) = @_; 327 my ($body, $hdr) = @_;
205 print "$body\n"; 328 print "$body\n";
237 push @{ $CO_SLOT{$_[0]}[1] }, $_[1]; 360 push @{ $CO_SLOT{$_[0]}[1] }, $_[1];
238 361
239 _slot_schedule $_[0]; 362 _slot_schedule $_[0];
240} 363}
241 364
365# continue to parse $_ for headers and place them into the arg
366sub parse_hdr() {
367 my %hdr;
368
369 # things seen, not parsed:
370 # p3pP="NON CUR OTPi OUR NOR UNI"
371
372 $hdr{lc $1} .= ",$2"
373 while /\G
374 ([^:\000-\037]*):
375 [\011\040]*
376 ((?: [^\012]+ | \012[\011\040] )*)
377 \012
378 /gxc;
379
380 /\G$/
381 or return;
382
383 # remove the "," prefix we added to all headers above
384 substr $_, 0, 1, ""
385 for values %hdr;
386
387 \%hdr
388}
389
390our $qr_nlnl = qr{(?<![^\012])\015?\012};
391
392our $TLS_CTX_LOW = { cache => 1, sslv2 => 1 };
393our $TLS_CTX_HIGH = { cache => 1, verify => 1, verify_peername => "https" };
394
242sub http_request($$@) { 395sub http_request($$@) {
243 my $cb = pop; 396 my $cb = pop;
244 my ($method, $url, %arg) = @_; 397 my ($method, $url, %arg) = @_;
245 398
246 my %hdr; 399 my %hdr;
400
401 $arg{tls_ctx} = $TLS_CTX_LOW if $arg{tls_ctx} eq "low" || !exists $arg{tls_ctx};
402 $arg{tls_ctx} = $TLS_CTX_HIGH if $arg{tls_ctx} eq "high";
247 403
248 $method = uc $method; 404 $method = uc $method;
249 405
250 if (my $hdr = $arg{headers}) { 406 if (my $hdr = $arg{headers}) {
251 while (my ($k, $v) = each %$hdr) { 407 while (my ($k, $v) = each %$hdr) {
252 $hdr{lc $k} = $v; 408 $hdr{lc $k} = $v;
253 } 409 }
254 } 410 }
255 411
412 # pseudo headers for all subsequent responses
413 my @pseudo = (URL => $url);
414 push @pseudo, Redirect => delete $arg{Redirect} if exists $arg{Redirect};
415
256 my $recurse = exists $arg{recurse} ? delete $arg{recurse} : $MAX_RECURSE; 416 my $recurse = exists $arg{recurse} ? delete $arg{recurse} : $MAX_RECURSE;
257 417
258 return $cb->(undef, { Status => 599, Reason => "recursion limit reached", URL => $url }) 418 return $cb->(undef, { @pseudo, Status => 599, Reason => "Too many redirections" })
259 if $recurse < 0; 419 if $recurse < 0;
260 420
261 my $proxy = $arg{proxy} || $PROXY; 421 my $proxy = $arg{proxy} || $PROXY;
262 my $timeout = $arg{timeout} || $TIMEOUT; 422 my $timeout = $arg{timeout} || $TIMEOUT;
263 423
264 $hdr{"user-agent"} ||= $USERAGENT;
265
266 my ($scheme, $authority, $upath, $query, $fragment) = 424 my ($uscheme, $uauthority, $upath, $query, $fragment) =
267 $url =~ m|(?:([^:/?#]+):)?(?://([^/?#]*))?([^?#]*)(?:\?([^#]*))?(?:#(.*))?|; 425 $url =~ m|(?:([^:/?#]+):)?(?://([^/?#]*))?([^?#]*)(?:(\?[^#]*))?(?:#(.*))?|;
268 426
269 $scheme = lc $scheme; 427 $uscheme = lc $uscheme;
270 428
271 my $uport = $scheme eq "http" ? 80 429 my $uport = $uscheme eq "http" ? 80
272 : $scheme eq "https" ? 443 430 : $uscheme eq "https" ? 443
273 : return $cb->(undef, { Status => 599, Reason => "only http and https URL schemes supported", URL => $url }); 431 : return $cb->(undef, { @pseudo, Status => 599, Reason => "Only http and https URL schemes supported" });
274 432
275 $hdr{referer} ||= "$scheme://$authority$upath"; # leave out fragment and query string, just a heuristic
276
277 $authority =~ /^(?: .*\@ )? ([^\@:]+) (?: : (\d+) )?$/x 433 $uauthority =~ /^(?: .*\@ )? ([^\@:]+) (?: : (\d+) )?$/x
278 or return $cb->(undef, { Status => 599, Reason => "unparsable URL", URL => $url }); 434 or return $cb->(undef, { @pseudo, Status => 599, Reason => "Unparsable URL" });
279 435
280 my $uhost = $1; 436 my $uhost = $1;
281 $uport = $2 if defined $2; 437 $uport = $2 if defined $2;
282 438
439 $hdr{host} = defined $2 ? "$uhost:$2" : "$uhost"
440 unless exists $hdr{host};
441
283 $uhost =~ s/^\[(.*)\]$/$1/; 442 $uhost =~ s/^\[(.*)\]$/$1/;
284 $upath .= "?$query" if length $query; 443 $upath .= $query if length $query;
285 444
286 $upath =~ s%^/?%/%; 445 $upath =~ s%^/?%/%;
287 446
288 # cookie processing 447 # cookie processing
289 if (my $jar = $arg{cookie_jar}) { 448 if (my $jar = $arg{cookie_jar}) {
290 %$jar = () if $jar->{version} < 1; 449 %$jar = () if $jar->{version} != 1;
291 450
292 my @cookie; 451 my @cookie;
293 452
294 while (my ($chost, $v) = each %$jar) { 453 while (my ($chost, $v) = each %$jar) {
295 if ($chost =~ /^\./) { 454 if ($chost =~ /^\./) {
302 461
303 while (my ($cpath, $v) = each %$v) { 462 while (my ($cpath, $v) = each %$v) {
304 next unless $cpath eq substr $upath, 0, length $cpath; 463 next unless $cpath eq substr $upath, 0, length $cpath;
305 464
306 while (my ($k, $v) = each %$v) { 465 while (my ($k, $v) = each %$v) {
307 next if $scheme ne "https" && exists $v->{secure}; 466 next if $uscheme ne "https" && exists $v->{secure};
467 my $value = $v->{value};
468 $value =~ s/([\\"])/\\$1/g;
308 push @cookie, "$k=$v->{value}"; 469 push @cookie, "$k=\"$value\"";
309 } 470 }
310 } 471 }
311 } 472 }
312 473
313 $hdr{cookie} = join "; ", @cookie 474 $hdr{cookie} = join "; ", @cookie
314 if @cookie; 475 if @cookie;
315 } 476 }
316 477
317 my ($rhost, $rport, $rpath); # request host, port, path 478 my ($rhost, $rport, $rscheme, $rpath); # request host, port, path
318 479
319 if ($proxy) { 480 if ($proxy) {
320 ($rhost, $rport, $scheme) = @$proxy; 481 ($rpath, $rhost, $rport, $rscheme) = ($url, @$proxy);
321 $rpath = $url; 482
483 $rscheme = "http" unless defined $rscheme;
484
485 # don't support https requests over https-proxy transport,
486 # can't be done with tls as spec'ed, unless you double-encrypt.
487 $rscheme = "http" if $uscheme eq "https" && $rscheme eq "https";
322 } else { 488 } else {
323 ($rhost, $rport, $rpath) = ($uhost, $uport, $upath); 489 ($rhost, $rport, $rscheme, $rpath) = ($uhost, $uport, $uscheme, $upath);
324 $hdr{host} = $uhost;
325 } 490 }
326 491
492 # leave out fragment and query string, just a heuristic
493 $hdr{referer} = "$uscheme://$uauthority$upath" unless exists $hdr{referer};
494 $hdr{"user-agent"} = $USERAGENT unless exists $hdr{"user-agent"};
495
327 $hdr{"content-length"} = length $arg{body}; 496 $hdr{"content-length"} = length $arg{body}
497 if length $arg{body} || $method ne "GET";
498
499 $hdr{connection} = "close TE"; #1.1
500 $hdr{te} = "trailers" unless exists $hdr{te}; #1.1
328 501
329 my %state = (connect_guard => 1); 502 my %state = (connect_guard => 1);
330 503
331 _get_slot $uhost, sub { 504 _get_slot $uhost, sub {
332 $state{slot_guard} = shift; 505 $state{slot_guard} = shift;
333 506
334 return unless $state{connect_guard}; 507 return unless $state{connect_guard};
335 508
336 $state{connect_guard} = AnyEvent::Socket::tcp_connect $rhost, $rport, sub { 509 my $connect_cb = sub {
337 $state{fh} = shift 510 $state{fh} = shift
511 or do {
512 my $err = "$!";
513 %state = ();
338 or return $cb->(undef, { Status => 599, Reason => "$!", URL => $url }); 514 return $cb->(undef, { @pseudo, Status => 599, Reason => $err });
515 };
339 516
340 delete $state{connect_guard}; # reduce memory usage, save a tree 517 pop; # free memory, save a tree
518
519 return unless delete $state{connect_guard};
341 520
342 # get handle 521 # get handle
343 $state{handle} = new AnyEvent::Handle 522 $state{handle} = new AnyEvent::Handle
344 fh => $state{fh}, 523 fh => $state{fh},
345 ($scheme eq "https" ? (tls => "connect") : ()); 524 peername => $rhost,
525 tls_ctx => $arg{tls_ctx},
526 # these need to be reconfigured on keepalive handles
527 timeout => $timeout,
528 on_error => sub {
529 %state = ();
530 $cb->(undef, { @pseudo, Status => 599, Reason => $_[2] });
531 },
532 on_eof => sub {
533 %state = ();
534 $cb->(undef, { @pseudo, Status => 599, Reason => "Unexpected end-of-file" });
535 },
536 ;
346 537
347 # limit the number of persistent connections 538 # limit the number of persistent connections
539 # keepalive not yet supported
348 if ($KA_COUNT{$_[1]} < $MAX_PERSISTENT_PER_HOST) { 540# if ($KA_COUNT{$_[1]} < $MAX_PERSISTENT_PER_HOST) {
349 ++$KA_COUNT{$_[1]}; 541# ++$KA_COUNT{$_[1]};
350 $state{handle}{ka_count_guard} = AnyEvent::Util::guard { --$KA_COUNT{$_[1]} }; 542# $state{handle}{ka_count_guard} = AnyEvent::Util::guard {
543# --$KA_COUNT{$_[1]}
544# };
351 $hdr{connection} = "keep-alive"; 545# $hdr{connection} = "keep-alive";
352 delete $hdr{connection}; # keep-alive not yet supported
353 } else {
354 delete $hdr{connection};
355 } 546# }
356 547
357 # (re-)configure handle 548 $state{handle}->starttls ("connect") if $rscheme eq "https";
358 $state{handle}->timeout ($timeout);
359 $state{handle}->on_error (sub {
360 my $errno = "$!";
361 %state = ();
362 $cb->(undef, { Status => 599, Reason => $errno, URL => $url });
363 });
364 $state{handle}->on_eof (sub {
365 %state = ();
366 $cb->(undef, { Status => 599, Reason => "unexpected end-of-file", URL => $url });
367 });
368 549
550 # handle actual, non-tunneled, request
551 my $handle_actual_request = sub {
552 $state{handle}->starttls ("connect") if $uscheme eq "https" && !exists $state{handle}{tls};
553
369 # send request 554 # send request
370 $state{handle}->push_write ( 555 $state{handle}->push_write (
371 "$method $rpath HTTP/1.0\015\012" 556 "$method $rpath HTTP/1.1\015\012"
372 . (join "", map "$_: $hdr{$_}\015\012", keys %hdr) 557 . (join "", map "\u$_: $hdr{$_}\015\012", grep defined $hdr{$_}, keys %hdr)
373 . "\015\012" 558 . "\015\012"
374 . (delete $arg{body}) 559 . (delete $arg{body})
375 );
376
377 %hdr = (); # reduce memory usage, save a kitten
378
379 # status line
380 $state{handle}->push_read (line => qr/\015?\012/, sub {
381 $_[1] =~ /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\015\012]*) )?/ix
382 or return (%state = (), $cb->(undef, { Status => 599, Reason => "invalid server response ($_[1])", URL => $url }));
383
384 my %hdr = ( # response headers
385 HTTPVersion => "\x00$1",
386 Status => "\x00$2",
387 Reason => "\x00$3",
388 URL => "\x00$url"
389 ); 560 );
390 561
391 # headers, could be optimized a bit 562 # return if error occured during push_write()
392 $state{handle}->unshift_read (line => qr/\015?\012\015?\012/, sub { 563 return unless %state;
564
565 %hdr = (); # reduce memory usage, save a kitten, also make it possible to re-use
566
567 # status line and headers
568 $state{read_response} = sub {
393 for ("$_[1]\012") { 569 for ("$_[1]") {
394 # we support spaces in field names, as lotus domino 570 y/\015//d; # weed out any \015, as they show up in the weirdest of places.
395 # creates them (actually spaces around seperators
396 # are strictly allowed in http, they are a security issue).
397 $hdr{lc $1} .= "\x00$2"
398 while /\G
399 ([^:\000-\037]+):
400 [\011\040]*
401 ((?: [^\015\012]+ | \015?\012[\011\040] )*)
402 \015?\012
403 /gxc;
404 571
572 /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\012]*) )? \012/igxc
573 or return (%state = (), $cb->(undef, { @pseudo, Status => 599, Reason => "Invalid server response" }));
574
575 # 100 Continue handling
576 # should not happen as we don't send expect: 100-continue,
577 # but we handle it just in case.
578 # since we send the request body regardless, if we get an error
579 # we are out of-sync, which we currently do NOT handle correctly.
580 return $state{handle}->push_read (line => $qr_nlnl, $state{read_response})
581 if $2 eq 100;
582
583 push @pseudo,
584 HTTPVersion => $1,
585 Status => $2,
586 Reason => $3,
405 /\G$/ 587 ;
588
589 my $hdr = parse_hdr
406 or return (%state = (), $cb->(undef, { Status => 599, Reason => "garbled response headers", URL => $url })); 590 or return (%state = (), $cb->(undef, { @pseudo, Status => 599, Reason => "Garbled response headers" }));
591
592 %hdr = (%$hdr, @pseudo);
407 } 593 }
408 594
409 substr $_, 0, 1, "" 595 # redirect handling
410 for values %hdr; 596 # microsoft and other shitheads don't give a shit for following standards,
597 # try to support some common forms of broken Location headers.
598 if ($hdr{location} !~ /^(?: $ | [^:\/?\#]+ : )/x) {
599 $hdr{location} =~ s/^\.\/+//;
411 600
412 my $finish = sub { 601 my $url = "$rscheme://$uhost:$uport";
413 # TODO: use destroy method, when/if available 602
603 unless ($hdr{location} =~ s/^\///) {
604 $url .= $upath;
605 $url =~ s/\/[^\/]*$//;
606 }
607
608 $hdr{location} = "$url/$hdr{location}";
609 }
610
611 my $redirect;
612
613 if ($recurse) {
614 my $status = $hdr{Status};
615
616 # industry standard is to redirect POST as GET for
617 # 301, 302 and 303, in contrast to http/1.0 and 1.1.
618 # also, the UA should ask the user for 301 and 307 and POST,
619 # industry standard seems to be to simply follow.
620 # we go with the industry standard.
621 if ($status == 301 or $status == 302 or $status == 303) {
622 # HTTP/1.1 is unclear on how to mutate the method
623 $method = "GET" unless $method eq "HEAD";
624 $redirect = 1;
625 } elsif ($status == 307) {
626 $redirect = 1;
627 }
628 }
629
630 my $finish = sub { # ($data, $err_status, $err_reason[, $keepalive])
631 my $keepalive = pop;
632
414 #$state{handle}->destroy; 633 $state{handle}->destroy if $state{handle};
415 $state{handle}->on_eof (undef);
416 $state{handle}->on_error (undef);
417 %state = (); 634 %state = ();
418 635
636 if (defined $_[1]) {
637 $hdr{OrigStatus} = $hdr{Status}; $hdr{Status} = $_[1];
638 $hdr{OrigReason} = $hdr{Reason}; $hdr{Reason} = $_[2];
639 }
640
419 # set-cookie processing 641 # set-cookie processing
420 if ($arg{cookie_jar} && exists $hdr{"set-cookie"}) { 642 if ($arg{cookie_jar}) {
421 for (split /\x00/, $hdr{"set-cookie"}) { 643 for ($hdr{"set-cookie"}) {
422 my ($cookie, @arg) = split /;\s*/; 644 # parse NAME=VALUE
423 my ($name, $value) = split /=/, $cookie, 2; 645 my @kv;
424 my %kv = (value => $value, map { split /=/, $_, 2 } @arg); 646
425 647 while (/\G\s* ([^=;,[:space:]]+) \s*=\s* (?: "((?:[^\\"]+|\\.)*)" | ([^=;,[:space:]]*) )/gcxs) {
648 my $name = $1;
649 my $value = $3;
650
651 unless ($value) {
652 $value = $2;
653 $value =~ s/\\(.)/$1/gs;
654 }
655
656 push @kv, $name => $value;
657
658 last unless /\G\s*;/gc;
659 }
660
661 last unless @kv;
662
663 my $name = shift @kv;
664 my %kv = (value => shift @kv, @kv);
665
426 my $cdom; 666 my $cdom;
427 my $cpath = (delete $kv{path}) || "/"; 667 my $cpath = (delete $kv{path}) || "/";
428 668
429 if (exists $kv{domain}) { 669 if (exists $kv{domain}) {
430 $cdom = delete $kv{domain}; 670 $cdom = delete $kv{domain};
431 671
432 $cdom =~ s/^\.?/./; # make sure it starts with a "." 672 $cdom =~ s/^\.?/./; # make sure it starts with a "."
441 } 681 }
442 682
443 # store it 683 # store it
444 $arg{cookie_jar}{version} = 1; 684 $arg{cookie_jar}{version} = 1;
445 $arg{cookie_jar}{$cdom}{$cpath}{$name} = \%kv; 685 $arg{cookie_jar}{$cdom}{$cpath}{$name} = \%kv;
686
687 redo if /\G\s*,/gc;
446 } 688 }
447 } 689 }
448 690
449 # microsoft and other shitheads don't give a shit for following standards, 691 if ($redirect && exists $hdr{location}) {
450 # try to support some common forms of broken Location headers. 692 # we ignore any errors, as it is very common to receive
451 if ($_[1]{location} !~ /^(?: $ | [^:\/?\#]+ : )/x) { 693 # Content-Length != 0 but no actual body
452 $_[1]{location} =~ s/^\.\/+//; 694 # we also access %hdr, as $_[1] might be an erro
453 695 http_request (
454 my $url = "$scheme://$uhost:$uport"; 696 $method => $hdr{location},
455
456 unless ($_[1]{location} =~ s/^\///) {
457 $url .= $upath;
458 $url =~ s/\/[^\/]*$//;
459 } 697 %arg,
460 698 recurse => $recurse - 1,
461 $_[1]{location} = "$url/$_[1]{location}"; 699 Redirect => [$_[0], \%hdr],
462 } 700 $cb);
463
464 if ($_[1]{Status} =~ /^30[12]$/ && $recurse && $method ne "POST") {
465 # apparently, mozilla et al. just change POST to GET here
466 # more research is needed before we do the same
467 http_request ($method, $_[1]{location}, %arg, recurse => $recurse - 1, $cb);
468 } elsif ($_[1]{Status} == 303 && $recurse) {
469 # even http/1.1 is unclear on how to mutate the method
470 $method = "GET" unless $method eq "HEAD";
471 http_request ($method => $_[1]{location}, %arg, recurse => $recurse - 1, $cb);
472 } elsif ($_[1]{Status} == 307 && $recurse && $method =~ /^(?:GET|HEAD)$/) {
473 http_request ($method => $_[1]{location}, %arg, recurse => $recurse - 1, $cb);
474 } else { 701 } else {
475 $cb->($_[0], $_[1]); 702 $cb->($_[0], \%hdr);
476 } 703 }
477 }; 704 };
478 705
479 if ($hdr{Status} =~ /^(?:1..|204|304)$/ or $method eq "HEAD") { 706 my $len = $hdr{"content-length"};
707
708 if (!$redirect && $arg{on_header} && !$arg{on_header}(\%hdr)) {
709 $finish->(undef, 598 => "Request cancelled by on_header");
710 } elsif (
711 $hdr{Status} =~ /^(?:1..|204|205|304)$/
712 or $method eq "HEAD"
713 or (defined $len && !$len)
714 ) {
715 # no body
480 $finish->(undef, \%hdr); 716 $finish->("", undef, undef, 1);
481 } else { 717 } else {
482 if (exists $hdr{"content-length"}) { 718 # body handling, many different code paths
719 # - no body expected
720 # - want_body_handle
721 # - te chunked
722 # - 2x length known (with or without on_body)
723 # - 2x length not known (with or without on_body)
724 if (!$redirect && $arg{want_body_handle}) {
725 $_[0]->on_eof (undef);
726 $_[0]->on_error (undef);
727 $_[0]->on_read (undef);
728
729 $finish->(delete $state{handle});
730
731 } elsif ($hdr{"transfer-encoding"} =~ /\bchunked\b/i) {
732 my $cl = 0;
733 my $body = undef;
734 my $on_body = $arg{on_body} || sub { $body .= shift; 1 };
735
736 $_[0]->on_error (sub { $finish->(undef, 599 => $_[2]) });
737
738 my $read_chunk; $read_chunk = sub {
739 $_[1] =~ /^([0-9a-fA-F]+)/
740 or $finish->(undef, 599 => "Garbled chunked transfer encoding");
741
742 my $len = hex $1;
743
744 if ($len) {
745 $cl += $len;
746
483 $_[0]->unshift_read (chunk => $hdr{"content-length"}, sub { 747 $_[0]->push_read (chunk => $len, sub {
484 # could cache persistent connection now 748 $on_body->($_[1], \%hdr)
485 if ($hdr{connection} =~ /\bkeep-alive\b/i) { 749 or return $finish->(undef, 598 => "Request cancelled by on_body");
486 # but we don't, due to misdesigns, this is annoyingly complex 750
751 $_[0]->push_read (line => sub {
752 length $_[1]
753 and return $finish->(undef, 599 => "Garbled chunked transfer encoding");
754 $_[0]->push_read (line => $read_chunk);
755 });
756 });
757 } else {
758 $hdr{"content-length"} ||= $cl;
759
760 $_[0]->push_read (line => $qr_nlnl, sub {
761 if (length $_[1]) {
762 for ("$_[1]") {
763 y/\015//d; # weed out any \015, as they show up in the weirdest of places.
764
765 my $hdr = parse_hdr
766 or return $finish->(undef, 599 => "Garbled response trailers");
767
768 %hdr = (%hdr, %$hdr);
769 }
770 }
771
772 $finish->($body, undef, undef, 1);
773 });
774 }
775 };
776
777 $_[0]->push_read (line => $read_chunk);
778
779 } elsif ($arg{on_body}) {
780 $_[0]->on_error (sub { $finish->(undef, 599 => $_[2]) });
781
782 if ($len) {
783 $_[0]->on_read (sub {
784 $len -= length $_[0]{rbuf};
785
786 $arg{on_body}(delete $_[0]{rbuf}, \%hdr)
787 or return $finish->(undef, 598 => "Request cancelled by on_body");
788
789 $len > 0
790 or $finish->("", undef, undef, 1);
487 }; 791 });
488 792 } else {
793 $_[0]->on_eof (sub {
489 $finish->($_[1], \%hdr); 794 $finish->("");
795 });
796 $_[0]->on_read (sub {
797 $arg{on_body}(delete $_[0]{rbuf}, \%hdr)
798 or $finish->(undef, 598 => "Request cancelled by on_body");
799 });
490 }); 800 }
491 } else { 801 } else {
492 # too bad, need to read until we get an error or EOF,
493 # no way to detect winged data.
494 $_[0]->on_error (sub {
495 $finish->($_[0]{rbuf}, \%hdr);
496 });
497 $_[0]->on_eof (undef); 802 $_[0]->on_eof (undef);
803
804 if ($len) {
805 $_[0]->on_error (sub { $finish->(undef, 599 => $_[2]) });
806 $_[0]->on_read (sub {
807 $finish->((substr delete $_[0]{rbuf}, 0, $len, ""), undef, undef, 1)
808 if $len <= length $_[0]{rbuf};
809 });
810 } else {
811 $_[0]->on_error (sub {
812 ($! == Errno::EPIPE || !$!)
813 ? $finish->(delete $_[0]{rbuf})
814 : $finish->(undef, 599 => $_[2]);
815 });
498 $_[0]->on_read (sub { }); 816 $_[0]->on_read (sub { });
817 }
499 } 818 }
500 } 819 }
820 };
821
822 $state{handle}->push_read (line => $qr_nlnl, $state{read_response});
823 };
824
825 # now handle proxy-CONNECT method
826 if ($proxy && $uscheme eq "https") {
827 # oh dear, we have to wrap it into a connect request
828
829 # maybe re-use $uauthority with patched port?
830 $state{handle}->push_write ("CONNECT $uhost:$uport HTTP/1.0\015\012Host: $uhost\015\012\015\012");
831 $state{handle}->push_read (line => $qr_nlnl, sub {
832 $_[1] =~ /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\015\012]*) )?/ix
833 or return (%state = (), $cb->(undef, { @pseudo, Status => 599, Reason => "Invalid proxy connect response ($_[1])" }));
834
835 if ($2 == 200) {
836 $rpath = $upath;
837 &$handle_actual_request;
838 } else {
839 %state = ();
840 $cb->(undef, { @pseudo, Status => $2, Reason => $3 });
841 }
501 }); 842 });
843 } else {
844 &$handle_actual_request;
502 }); 845 }
503 }, sub {
504 $timeout
505 }; 846 };
847
848 my $tcp_connect = $arg{tcp_connect}
849 || do { require AnyEvent::Socket; \&AnyEvent::Socket::tcp_connect };
850
851 $state{connect_guard} = $tcp_connect->($rhost, $rport, $connect_cb, $arg{on_prepare} || sub { $timeout });
852
506 }; 853 };
507 854
508 defined wantarray && AnyEvent::Util::guard { %state = () } 855 defined wantarray && AnyEvent::Util::guard { %state = () }
509} 856}
510 857
524 &http_request 871 &http_request
525} 872}
526 873
527=back 874=back
528 875
876=head2 DNS CACHING
877
878AnyEvent::HTTP uses the AnyEvent::Socket::tcp_connect function for
879the actual connection, which in turn uses AnyEvent::DNS to resolve
880hostnames. The latter is a simple stub resolver and does no caching
881on its own. If you want DNS caching, you currently have to provide
882your own default resolver (by storing a suitable resolver object in
883C<$AnyEvent::DNS::RESOLVER>).
884
529=head2 GLOBAL FUNCTIONS AND VARIABLES 885=head2 GLOBAL FUNCTIONS AND VARIABLES
530 886
531=over 4 887=over 4
532 888
533=item AnyEvent::HTTP::set_proxy "proxy-url" 889=item AnyEvent::HTTP::set_proxy "proxy-url"
534 890
535Sets the default proxy server to use. The proxy-url must begin with a 891Sets the default proxy server to use. The proxy-url must begin with a
536string of the form C<http://host:port> (optionally C<https:...>). 892string of the form C<http://host:port> (optionally C<https:...>), croaks
893otherwise.
894
895To clear an already-set proxy, use C<undef>.
896
897=item $date = AnyEvent::HTTP::format_date $timestamp
898
899Takes a POSIX timestamp (seconds since the epoch) and formats it as a HTTP
900Date (RFC 2616).
901
902=item $timestamp = AnyEvent::HTTP::parse_date $date
903
904Takes a HTTP Date (RFC 2616) and returns the corresponding POSIX
905timestamp, or C<undef> if the date cannot be parsed.
537 906
538=item $AnyEvent::HTTP::MAX_RECURSE 907=item $AnyEvent::HTTP::MAX_RECURSE
539 908
540The default value for the C<recurse> request parameter (default: C<10>). 909The default value for the C<recurse> request parameter (default: C<10>).
541 910
542=item $AnyEvent::HTTP::USERAGENT 911=item $AnyEvent::HTTP::USERAGENT
543 912
544The default value for the C<User-Agent> header (the default is 913The default value for the C<User-Agent> header (the default is
545C<Mozilla/5.0 (compatible; AnyEvent::HTTP/$VERSION; +http://software.schmorp.de/pkg/AnyEvent)>). 914C<Mozilla/5.0 (compatible; U; AnyEvent-HTTP/$VERSION; +http://software.schmorp.de/pkg/AnyEvent)>).
546 915
547=item $AnyEvent::HTTP::MAX_PERSISTENT 916=item $AnyEvent::HTTP::MAX_PER_HOST
548 917
549The maximum number of persistent connections to keep open (default: 8). 918The maximum number of concurrent connections to the same host (identified
919by the hostname). If the limit is exceeded, then the additional requests
920are queued until previous connections are closed.
550 921
551Not implemented currently. 922The default value for this is C<4>, and it is highly advisable to not
552 923increase it.
553=item $AnyEvent::HTTP::PERSISTENT_TIMEOUT
554
555The maximum time to cache a persistent connection, in seconds (default: 2).
556
557Not implemented currently.
558 924
559=item $AnyEvent::HTTP::ACTIVE 925=item $AnyEvent::HTTP::ACTIVE
560 926
561The number of active connections. This is not the number of currently 927The number of active connections. This is not the number of currently
562running requests, but the number of currently open and non-idle TCP 928running requests, but the number of currently open and non-idle TCP
564 930
565=back 931=back
566 932
567=cut 933=cut
568 934
935our @month = qw(Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec);
936our @weekday = qw(Sun Mon Tue Wed Thu Fri Sat);
937
938sub format_date($) {
939 my ($time) = @_;
940
941 # RFC 822/1123 format
942 my ($S, $M, $H, $mday, $mon, $year, $wday, $yday, undef) = gmtime $time;
943
944 sprintf "%s, %02d %s %04d %02d:%02d:%02d GMT",
945 $weekday[$wday], $mday, $month[$mon], $year + 1900,
946 $H, $M, $S;
947}
948
949sub parse_date($) {
950 my ($date) = @_;
951
952 my ($d, $m, $y, $H, $M, $S);
953
954 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$/) {
955 # RFC 822/1123, required by RFC 2616
956 ($d, $m, $y, $H, $M, $S) = ($1, $2, $3, $4, $5, $6);
957
958 } 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$/) {
959 # RFC 850
960 ($d, $m, $y, $H, $M, $S) = ($1, $2, $3 < 69 ? $3 + 2000 : $3 + 1900, $4, $5, $6);
961
962 } 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])$/) {
963 # ISO C's asctime
964 ($d, $m, $y, $H, $M, $S) = ($2, $1, $6, $3, $4, $5);
965 }
966 # other formats fail in the loop below
967
968 for (0..11) {
969 if ($m eq $month[$_]) {
970 require Time::Local;
971 return Time::Local::timegm ($S, $M, $H, $d, $_, $y);
972 }
973 }
974
975 undef
976}
977
569sub set_proxy($) { 978sub set_proxy($) {
979 if (length $_[0]) {
570 $PROXY = [$2, $3 || 3128, $1] if $_[0] =~ m%^(https?):// ([^:/]+) (?: : (\d*) )?%ix; 980 $_[0] =~ m%^(https?):// ([^:/]+) (?: : (\d*) )?%ix
981 or Carp::croak "$_[0]: invalid proxy URL";
982 $PROXY = [$2, $3 || 3128, $1]
983 } else {
984 undef $PROXY;
985 }
571} 986}
572 987
573# initialise proxy from environment 988# initialise proxy from environment
989eval {
574set_proxy $ENV{http_proxy}; 990 set_proxy $ENV{http_proxy};
991};
992
993=head2 SOCKS PROXIES
994
995Socks proxies are not directly supported by AnyEvent::HTTP. You can
996compile your perl to support socks, or use an external program such as
997F<socksify> (dante) or F<tsocks> to make your program use a socks proxy
998transparently.
999
1000Alternatively, for AnyEvent::HTTP only, you can use your own
1001C<tcp_connect> function that does the proxy handshake - here is an example
1002that works with socks4a proxies:
1003
1004 use Errno;
1005 use AnyEvent::Util;
1006 use AnyEvent::Socket;
1007 use AnyEvent::Handle;
1008
1009 # host, port and username of/for your socks4a proxy
1010 my $socks_host = "10.0.0.23";
1011 my $socks_port = 9050;
1012 my $socks_user = "";
1013
1014 sub socks4a_connect {
1015 my ($host, $port, $connect_cb, $prepare_cb) = @_;
1016
1017 my $hdl = new AnyEvent::Handle
1018 connect => [$socks_host, $socks_port],
1019 on_prepare => sub { $prepare_cb->($_[0]{fh}) },
1020 on_error => sub { $connect_cb->() },
1021 ;
1022
1023 $hdl->push_write (pack "CCnNZ*Z*", 4, 1, $port, 1, $socks_user, $host);
1024
1025 $hdl->push_read (chunk => 8, sub {
1026 my ($hdl, $chunk) = @_;
1027 my ($status, $port, $ipn) = unpack "xCna4", $chunk;
1028
1029 if ($status == 0x5a) {
1030 $connect_cb->($hdl->{fh}, (format_address $ipn) . ":$port");
1031 } else {
1032 $! = Errno::ENXIO; $connect_cb->();
1033 }
1034 });
1035
1036 $hdl
1037 }
1038
1039Use C<socks4a_connect> instead of C<tcp_connect> when doing C<http_request>s,
1040possibly after switching off other proxy types:
1041
1042 AnyEvent::HTTP::set_proxy undef; # usually you do not want other proxies
1043
1044 http_get 'http://www.google.com', tcp_connect => \&socks4a_connect, sub {
1045 my ($data, $headers) = @_;
1046 ...
1047 };
575 1048
576=head1 SEE ALSO 1049=head1 SEE ALSO
577 1050
578L<AnyEvent>. 1051L<AnyEvent>.
579 1052
580=head1 AUTHOR 1053=head1 AUTHOR
581 1054
582 Marc Lehmann <schmorp@schmorp.de> 1055 Marc Lehmann <schmorp@schmorp.de>
583 http://home.schmorp.de/ 1056 http://home.schmorp.de/
584 1057
1058With many thanks to Дмитрий Шалашов, who provided countless
1059testcases and bugreports.
1060
585=cut 1061=cut
586 1062
5871 10631
588 1064

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines