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.41 by root, Sun Jul 5 23:50:59 2009 UTC vs.
Revision 1.79 by root, Sat Jan 1 20:01:07 2011 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines