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.79 by root, Sat Jan 1 20:01:07 2011 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
114and the C<Reason> pseudo-header will contain an error message. 128C<590>-C<599> and the C<Reason> pseudo-header will contain an error
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
115 144
116A typical callback might look like this: 145A typical callback might look like this:
117 146
118 sub { 147 sub {
119 my ($body, $hdr) = @_; 148 my ($body, $hdr) = @_;
135Whether to recurse requests or not, e.g. on redirects, authentication 164Whether to recurse requests or not, e.g. on redirects, authentication
136retries and so on, and how often to do so. 165retries and so on, and how often to do so.
137 166
138=item headers => hashref 167=item headers => hashref
139 168
140The request headers to use. Currently, C<http_request> may provide its 169The request headers to use. Currently, C<http_request> may provide its own
141own C<Host:>, C<Content-Length:>, C<Connection:> and C<Cookie:> headers 170C<Host:>, C<Content-Length:>, C<Connection:> and C<Cookie:> headers and
142and 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).
143 174
144=item timeout => $seconds 175=item timeout => $seconds
145 176
146The 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
147the 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.
148 182
149=item proxy => [$host, $port[, $scheme]] or undef 183=item proxy => [$host, $port[, $scheme]] or undef
150 184
151Use 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
152default proxy (as specified by C<$ENV{http_proxy}>) is used. 186default proxy (as specified by C<$ENV{http_proxy}>) is used.
153 187
154C<$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
155HTTPS. 189HTTPS.
156 190
157=item body => $string 191=item body => $string
158 192
159The 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
160this module might offer more options). 194this module might offer more options).
161 195
162=item cookie_jar => $hash_ref 196=item cookie_jar => $hash_ref
163 197
164Passing this parameter enables (simplified) cookie-processing, loosely 198Passing this parameter enables (simplified) cookie-processing, loosely
165based on the original netscape specification. 199based on the original netscape specification.
166 200
167The 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
168get updated automatically. It is possible to save the cookie_jar to 202get updated automatically. It is possible to save the cookie jar to
169persistent storage with something like JSON or Storable, but this is not 203persistent storage with something like JSON or Storable, but this is not
170recommended, as expire times are currently being ignored. 204recommended, as session-only cookies might survive longer than expected.
171 205
172Note that this cookie implementation is not of very high quality, nor 206Note that this cookie implementation is not meant to be complete. If
173meant to be complete. If you want complete cookie management you have to 207you want complete cookie management you have to do that on your
174do 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
175cookie-using sites working. Cookies are a privacy disaster, do not use 209working. Cookies are a privacy disaster, do not use them unless required
176them 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.
215
216=item tls_ctx => $scheme | $tls_ctx
217
218Specifies the AnyEvent::TLS context to be used for https connections. This
219parameter follows the same rules as the C<tls_ctx> parameter to
220L<AnyEvent::Handle>, but additionally, the two strings C<low> or
221C<high> can be specified, which give you a predefined low-security (no
222verification, highest compatibility) and high-security (CA and common-name
223verification) TLS context.
224
225The default for this option is C<low>, which could be interpreted as "give
226me the page, no matter what".
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
249=item on_header => $callback->($headers)
250
251When specified, this callback will be called with the header hash as soon
252as headers have been successfully received from the remote server (not on
253locally-generated errors).
254
255It has to return either true (in which case AnyEvent::HTTP will continue),
256or false, in which case AnyEvent::HTTP will cancel the download (and call
257the finish callback with an error code of C<598>).
258
259This callback is useful, among other things, to quickly reject unwanted
260content, which, if it is supposed to be rare, can be faster than first
261doing a C<HEAD> request.
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
273=item on_body => $callback->($partial_body, $headers)
274
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.
278
279It has to return either true (in which case AnyEvent::HTTP will continue),
280or false, in which case AnyEvent::HTTP will cancel the download (and call
281the completion callback with an error code of C<598>).
282
283The downside to cancelling the request is that it makes it impossible to
284re-use the connection.
285
286This callback is useful when the data is too large to be held in memory
287(so the callback writes it to a file) or when only some information should
288be extracted, or when the body should be processed incrementally.
289
290It is usually preferred over doing your own body handling via
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.
295
296=item want_body_handle => $enable
297
298When enabled (default is disabled), the behaviour of AnyEvent::HTTP
299changes considerably: after parsing the headers, and instead of
300downloading the body (if any), the completion callback will be
301called. Instead of the C<$body> argument containing the body data, the
302callback will receive the L<AnyEvent::Handle> object associated with the
303connection. In error cases, C<undef> will be passed. When there is no body
304(e.g. status C<304>), the empty string will be passed.
305
306The handle object might or might not be in TLS mode, might be connected to
307a proxy, be a persistent connection etc., and configured in unspecified
308ways. The user is responsible for this handle (it will not be used by this
309module anymore).
310
311This is useful with some push-type services, where, after the initial
312headers, an interactive protocol is used (typical example would be the
313push-style twitter API which starts a JSON/XML stream).
314
315If you think you need this, first have a look at C<on_body>, to see if
316that doesn't solve your problem in a better way.
177 317
178=back 318=back
179 319
180Example: 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.
181 322
182 http_request GET => "http://www.nethype.de/", sub { 323 http_request GET => "http://www.nethype.de/", sub {
183 my ($body, $hdr) = @_; 324 my ($body, $hdr) = @_;
184 print "$body\n"; 325 print "$body\n";
185 }; 326 };
186 327
187Example: 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
188timeout of 30 seconds. 329timeout of 30 seconds.
189 330
190 http_request 331 http_request
191 GET => "https://www.google.com", 332 GET => "https://www.google.com",
192 timeout => 30, 333 timeout => 30,
195 use Data::Dumper; 336 use Data::Dumper;
196 print Dumper $hdr; 337 print Dumper $hdr;
197 } 338 }
198 ; 339 ;
199 340
200Example: make another simple HTTP GET request, but immediately try to 341Example: do another simple HTTP GET request, but immediately try to
201cancel it. 342cancel it.
202 343
203 my $request = http_request GET => "http://www.nethype.de/", sub { 344 my $request = http_request GET => "http://www.nethype.de/", sub {
204 my ($body, $hdr) = @_; 345 my ($body, $hdr) = @_;
205 print "$body\n"; 346 print "$body\n";
237 push @{ $CO_SLOT{$_[0]}[1] }, $_[1]; 378 push @{ $CO_SLOT{$_[0]}[1] }, $_[1];
238 379
239 _slot_schedule $_[0]; 380 _slot_schedule $_[0];
240} 381}
241 382
383# extract cookies from jar
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};
526
527our $TLS_CTX_LOW = { cache => 1, sslv2 => 1 };
528our $TLS_CTX_HIGH = { cache => 1, verify => 1, verify_peername => "https" };
529
242sub http_request($$@) { 530sub http_request($$@) {
243 my $cb = pop; 531 my $cb = pop;
244 my ($method, $url, %arg) = @_; 532 my ($method, $url, %arg) = @_;
245 533
246 my %hdr; 534 my %hdr;
535
536 $arg{tls_ctx} = $TLS_CTX_LOW if $arg{tls_ctx} eq "low" || !exists $arg{tls_ctx};
537 $arg{tls_ctx} = $TLS_CTX_HIGH if $arg{tls_ctx} eq "high";
247 538
248 $method = uc $method; 539 $method = uc $method;
249 540
250 if (my $hdr = $arg{headers}) { 541 if (my $hdr = $arg{headers}) {
251 while (my ($k, $v) = each %$hdr) { 542 while (my ($k, $v) = each %$hdr) {
252 $hdr{lc $k} = $v; 543 $hdr{lc $k} = $v;
253 } 544 }
254 } 545 }
255 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
256 my $recurse = exists $arg{recurse} ? delete $arg{recurse} : $MAX_RECURSE; 551 my $recurse = exists $arg{recurse} ? delete $arg{recurse} : $MAX_RECURSE;
257 552
258 return $cb->(undef, { Status => 599, Reason => "recursion limit reached", URL => $url }) 553 return $cb->(undef, { @pseudo, Status => 599, Reason => "Too many redirections" })
259 if $recurse < 0; 554 if $recurse < 0;
260 555
261 my $proxy = $arg{proxy} || $PROXY; 556 my $proxy = $arg{proxy} || $PROXY;
262 my $timeout = $arg{timeout} || $TIMEOUT; 557 my $timeout = $arg{timeout} || $TIMEOUT;
263 558
264 $hdr{"user-agent"} ||= $USERAGENT;
265
266 my ($scheme, $authority, $upath, $query, $fragment) = 559 my ($uscheme, $uauthority, $upath, $query, $fragment) =
267 $url =~ m|(?:([^:/?#]+):)?(?://([^/?#]*))?([^?#]*)(?:\?([^#]*))?(?:#(.*))?|; 560 $url =~ m|(?:([^:/?#]+):)?(?://([^/?#]*))?([^?#]*)(?:(\?[^#]*))?(?:#(.*))?|;
268 561
269 $scheme = lc $scheme; 562 $uscheme = lc $uscheme;
270 563
271 my $uport = $scheme eq "http" ? 80 564 my $uport = $uscheme eq "http" ? 80
272 : $scheme eq "https" ? 443 565 : $uscheme eq "https" ? 443
273 : 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" });
274 567
275 $hdr{referer} ||= "$scheme://$authority$upath"; # leave out fragment and query string, just a heuristic
276
277 $authority =~ /^(?: .*\@ )? ([^\@:]+) (?: : (\d+) )?$/x 568 $uauthority =~ /^(?: .*\@ )? ([^\@:]+) (?: : (\d+) )?$/x
278 or return $cb->(undef, { Status => 599, Reason => "unparsable URL", URL => $url }); 569 or return $cb->(undef, { @pseudo, Status => 599, Reason => "Unparsable URL" });
279 570
280 my $uhost = $1; 571 my $uhost = $1;
281 $uport = $2 if defined $2; 572 $uport = $2 if defined $2;
282 573
574 $hdr{host} = defined $2 ? "$uhost:$2" : "$uhost"
575 unless exists $hdr{host};
576
283 $uhost =~ s/^\[(.*)\]$/$1/; 577 $uhost =~ s/^\[(.*)\]$/$1/;
284 $upath .= "?$query" if length $query; 578 $upath .= $query if length $query;
285 579
286 $upath =~ s%^/?%/%; 580 $upath =~ s%^/?%/%;
287 581
288 # cookie processing 582 # cookie processing
289 if (my $jar = $arg{cookie_jar}) { 583 if (my $jar = $arg{cookie_jar}) {
290 %$jar = () if $jar->{version} < 1; 584 my $cookies = cookie_jar_extract $jar, $uscheme, $uhost, $upath;
291 585
292 my @cookie;
293
294 while (my ($chost, $v) = each %$jar) {
295 if ($chost =~ /^\./) {
296 next unless $chost eq substr $uhost, -length $chost;
297 } elsif ($chost =~ /\./) {
298 next unless $chost eq $uhost;
299 } else {
300 next;
301 }
302
303 while (my ($cpath, $v) = each %$v) {
304 next unless $cpath eq substr $upath, 0, length $cpath;
305
306 while (my ($k, $v) = each %$v) {
307 next if $scheme ne "https" && exists $v->{secure};
308 push @cookie, "$k=$v->{value}";
309 }
310 }
311 }
312
313 $hdr{cookie} = join "; ", @cookie 586 $hdr{cookie} = join "; ", @$cookies
314 if @cookie; 587 if @$cookies;
315 } 588 }
316 589
317 my ($rhost, $rport, $rpath); # request host, port, path 590 my ($rhost, $rport, $rscheme, $rpath); # request host, port, path
318 591
319 if ($proxy) { 592 if ($proxy) {
320 ($rhost, $rport, $scheme) = @$proxy; 593 ($rpath, $rhost, $rport, $rscheme) = ($url, @$proxy);
321 $rpath = $url; 594
595 $rscheme = "http" unless defined $rscheme;
596
597 # don't support https requests over https-proxy transport,
598 # can't be done with tls as spec'ed, unless you double-encrypt.
599 $rscheme = "http" if $uscheme eq "https" && $rscheme eq "https";
322 } else { 600 } else {
323 ($rhost, $rport, $rpath) = ($uhost, $uport, $upath); 601 ($rhost, $rport, $rscheme, $rpath) = ($uhost, $uport, $uscheme, $upath);
324 $hdr{host} = $uhost;
325 } 602 }
326 603
604 # 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"};
607
327 $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
328 613
329 my %state = (connect_guard => 1); 614 my %state = (connect_guard => 1);
330 615
331 _get_slot $uhost, sub { 616 _get_slot $uhost, sub {
332 $state{slot_guard} = shift; 617 $state{slot_guard} = shift;
333 618
334 return unless $state{connect_guard}; 619 return unless $state{connect_guard};
335 620
336 $state{connect_guard} = AnyEvent::Socket::tcp_connect $rhost, $rport, sub { 621 my $ae_error = 595; # connecting
622
623 my $connect_cb = sub {
337 $state{fh} = shift 624 $state{fh} = shift
625 or do {
626 my $err = "$!";
627 %state = ();
338 or return $cb->(undef, { Status => 599, Reason => "$!", URL => $url }); 628 return $cb->(undef, { @pseudo, Status => $ae_error, Reason => $err });
629 };
339 630
340 delete $state{connect_guard}; # reduce memory usage, save a tree 631 return unless delete $state{connect_guard};
341 632
342 # get handle 633 # get handle
343 $state{handle} = new AnyEvent::Handle 634 $state{handle} = new AnyEvent::Handle
344 fh => $state{fh}, 635 fh => $state{fh},
345 ($scheme eq "https" ? (tls => "connect") : ()); 636 peername => $rhost,
637 tls_ctx => $arg{tls_ctx},
638 # these need to be reconfigured on keepalive handles
639 timeout => $timeout,
640 on_error => sub {
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 ;
346 649
347 # limit the number of persistent connections 650 # limit the number of persistent connections
651 # keepalive not yet supported
348 if ($KA_COUNT{$_[1]} < $MAX_PERSISTENT_PER_HOST) { 652# if ($KA_COUNT{$_[1]} < $MAX_PERSISTENT_PER_HOST) {
349 ++$KA_COUNT{$_[1]}; 653# ++$KA_COUNT{$_[1]};
350 $state{handle}{ka_count_guard} = AnyEvent::Util::guard { --$KA_COUNT{$_[1]} }; 654# $state{handle}{ka_count_guard} = AnyEvent::Util::guard {
655# --$KA_COUNT{$_[1]}
656# };
351 $hdr{connection} = "keep-alive"; 657# $hdr{connection} = "keep-alive";
352 delete $hdr{connection}; # keep-alive not yet supported
353 } else {
354 delete $hdr{connection};
355 } 658# }
356 659
357 # (re-)configure handle 660 $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 661
662 # handle actual, non-tunneled, request
663 my $handle_actual_request = sub {
664 $ae_error = 596; # request phase
665
666 $state{handle}->starttls ("connect") if $uscheme eq "https" && !exists $state{handle}{tls};
667
369 # send request 668 # send request
370 $state{handle}->push_write ( 669 $state{handle}->push_write (
371 "$method $rpath HTTP/1.0\015\012" 670 "$method $rpath HTTP/1.1\015\012"
372 . (join "", map "$_: $hdr{$_}\015\012", keys %hdr) 671 . (join "", map "\u$_: $hdr{$_}\015\012", grep defined $hdr{$_}, keys %hdr)
373 . "\015\012" 672 . "\015\012"
374 . (delete $arg{body}) 673 . (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 ); 674 );
390 675
391 # headers, could be optimized a bit 676 # return if error occured during push_write()
392 $state{handle}->unshift_read (line => qr/\015?\012\015?\012/, sub { 677 return unless %state;
678
679 %hdr = (); # reduce memory usage, save a kitten, also make it possible to re-use
680
681 # status line and headers
682 $state{read_response} = sub {
393 for ("$_[1]\012") { 683 for ("$_[1]") {
394 # we support spaces in field names, as lotus domino 684 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 685
686 /^HTTP\/0*([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\012]*) )? \012/gxci
687 or return (%state = (), $cb->(undef, { @pseudo, Status => 599, Reason => "Invalid server response" }));
688
689 # 100 Continue handling
690 # should not happen as we don't send expect: 100-continue,
691 # but we handle it just in case.
692 # since we send the request body regardless, if we get an error
693 # we are out of-sync, which we currently do NOT handle correctly.
694 return $state{handle}->push_read (line => $qr_nlnl, $state{read_response})
695 if $2 eq 100;
696
697 push @pseudo,
698 HTTPVersion => $1,
699 Status => $2,
700 Reason => $3,
405 /\G$/ 701 ;
702
703 my $hdr = parse_hdr
406 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);
407 } 707 }
408 708
409 substr $_, 0, 1, "" 709 # redirect handling
410 for values %hdr; 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/^\.\/+//;
411 714
412 my $finish = sub { 715 my $url = "$rscheme://$uhost:$uport";
413 # TODO: use destroy method, when/if available 716
717 unless ($hdr{location} =~ s/^\///) {
718 $url .= $upath;
719 $url =~ s/\/[^\/]*$//;
720 }
721
722 $hdr{location} = "$url/$hdr{location}";
723 }
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";
738 $redirect = 1;
739 } elsif ($status == 307) {
740 $redirect = 1;
741 }
742 }
743
744 my $finish = sub { # ($data, $err_status, $err_reason[, $keepalive])
745 my $may_keep_alive = $_[3];
746
414 #$state{handle}->destroy; 747 $state{handle}->destroy if $state{handle};
415 $state{handle}->on_eof (undef);
416 $state{handle}->on_error (undef);
417 %state = (); 748 %state = ();
418 749
750 if (defined $_[1]) {
751 $hdr{OrigStatus} = $hdr{Status}; $hdr{Status} = $_[1];
752 $hdr{OrigReason} = $hdr{Reason}; $hdr{Reason} = $_[2];
753 }
754
419 # set-cookie processing 755 # set-cookie processing
420 if ($arg{cookie_jar} && exists $hdr{"set-cookie"}) { 756 if ($arg{cookie_jar}) {
421 for (split /\x00/, $hdr{"set-cookie"}) { 757 cookie_jar_set_cookie $arg{cookie_jar}, $hdr{"set-cookie"}, $uhost;
422 my ($cookie, @arg) = split /;\s*/; 758 }
423 my ($name, $value) = split /=/, $cookie, 2; 759
424 my %kv = (value => $value, map { split /=/, $_, 2 } @arg); 760 if ($redirect && exists $hdr{location}) {
425 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],
426 my $cdom; 769 $cb);
427 my $cpath = (delete $kv{path}) || "/"; 770 } else {
771 $cb->($_[0], \%hdr);
772 }
773 };
428 774
429 if (exists $kv{domain}) { 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) {
430 $cdom = delete $kv{domain}; 814 $cl += $len;
431
432 $cdom =~ s/^\.?/./; # make sure it starts with a "."
433 815
434 next if $cdom =~ /\.$/; 816 $_[0]->push_read (chunk => $len, sub {
435 817 $on_body->($_[1], \%hdr)
436 # this is not rfc-like and not netscape-like. go figure. 818 or return $finish->(undef, 598 => "Request cancelled by on_body");
437 my $ndots = $cdom =~ y/.//; 819
438 next if $ndots < ($cdom =~ /\.[^.][^.]\.[^.][^.]$/ ? 3 : 2); 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 });
439 } else { 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);
440 $cdom = $uhost; 842 });
441 } 843 }
442 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);
443 # store it 858 });
444 $arg{cookie_jar}{version} = 1; 859 } else {
445 $arg{cookie_jar}{$cdom}{$cpath}{$name} = \%kv; 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 });
867 }
868 } else {
869 $_[0]->on_eof (undef);
870
871 if ($len) {
872 $_[0]->on_read (sub {
873 $finish->((substr delete $_[0]{rbuf}, 0, $len, ""), undef, undef, 1)
874 if $len <= length $_[0]{rbuf};
875 });
876 } else {
877 $_[0]->on_error (sub {
878 ($! == Errno::EPIPE || !$!)
879 ? $finish->(delete $_[0]{rbuf})
880 : $finish->(undef, $ae_error => $_[2]);
881 });
882 $_[0]->on_read (sub { });
446 } 883 }
447 } 884 }
448
449 # microsoft and other shitheads don't give a shit for following standards,
450 # try to support some common forms of broken Location headers.
451 if ($_[1]{location} !~ /^(?: $ | [^:\/?\#]+ : )/x) {
452 $_[1]{location} =~ s/^\.\/+//;
453
454 my $url = "$scheme://$uhost:$uport";
455
456 unless ($_[1]{location} =~ s/^\///) {
457 $url .= $upath;
458 $url =~ s/\/[^\/]*$//;
459 }
460
461 $_[1]{location} = "$url/$_[1]{location}";
462 }
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 {
475 $cb->($_[0], $_[1]);
476 }
477 }; 885 }
886 };
478 887
479 if ($hdr{Status} =~ /^(?:1..|204|304)$/ or $method eq "HEAD") { 888 $state{handle}->push_read (line => $qr_nlnl, $state{read_response});
480 $finish->(undef, \%hdr); 889 };
890
891 # now handle proxy-CONNECT method
892 if ($proxy && $uscheme eq "https") {
893 # oh dear, we have to wrap it into a connect request
894
895 # maybe re-use $uauthority with patched port?
896 $state{handle}->push_write ("CONNECT $uhost:$uport HTTP/1.0\015\012Host: $uhost\015\012\015\012");
897 $state{handle}->push_read (line => $qr_nlnl, sub {
898 $_[1] =~ /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\015\012]*) )?/ix
899 or return (%state = (), $cb->(undef, { @pseudo, Status => 599, Reason => "Invalid proxy connect response ($_[1])" }));
900
901 if ($2 == 200) {
902 $rpath = $upath;
903 &$handle_actual_request;
481 } else { 904 } else {
482 if (exists $hdr{"content-length"}) { 905 %state = ();
483 $_[0]->unshift_read (chunk => $hdr{"content-length"}, sub { 906 $cb->(undef, { @pseudo, Status => $2, Reason => $3 });
484 # could cache persistent connection now
485 if ($hdr{connection} =~ /\bkeep-alive\b/i) {
486 # but we don't, due to misdesigns, this is annoyingly complex
487 };
488
489 $finish->($_[1], \%hdr);
490 });
491 } 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);
498 $_[0]->on_read (sub { });
499 }
500 } 907 }
501 }); 908 });
909 } else {
910 &$handle_actual_request;
502 }); 911 }
503 }, sub {
504 $timeout
505 }; 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
506 }; 919 };
507 920
508 defined wantarray && AnyEvent::Util::guard { %state = () } 921 defined wantarray && AnyEvent::Util::guard { %state = () }
509} 922}
510 923
524 &http_request 937 &http_request
525} 938}
526 939
527=back 940=back
528 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
529=head2 GLOBAL FUNCTIONS AND VARIABLES 951=head2 GLOBAL FUNCTIONS AND VARIABLES
530 952
531=over 4 953=over 4
532 954
533=item AnyEvent::HTTP::set_proxy "proxy-url" 955=item AnyEvent::HTTP::set_proxy "proxy-url"
534 956
535Sets 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
536string 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.
537 973
538=item $AnyEvent::HTTP::MAX_RECURSE 974=item $AnyEvent::HTTP::MAX_RECURSE
539 975
540The default value for the C<recurse> request parameter (default: C<10>). 976The default value for the C<recurse> request parameter (default: C<10>).
541 977
542=item $AnyEvent::HTTP::USERAGENT 978=item $AnyEvent::HTTP::USERAGENT
543 979
544The default value for the C<User-Agent> header (the default is 980The 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)>). 981C<Mozilla/5.0 (compatible; U; AnyEvent-HTTP/$VERSION; +http://software.schmorp.de/pkg/AnyEvent)>).
546 982
547=item $AnyEvent::HTTP::MAX_PERSISTENT 983=item $AnyEvent::HTTP::MAX_PER_HOST
548 984
549The 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.
550 988
551Not implemented currently. 989The default value for this is C<4>, and it is highly advisable to not
552 990increase 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 991
559=item $AnyEvent::HTTP::ACTIVE 992=item $AnyEvent::HTTP::ACTIVE
560 993
561The number of active connections. This is not the number of currently 994The number of active connections. This is not the number of currently
562running requests, but the number of currently open and non-idle TCP 995running requests, but the number of currently open and non-idle TCP
564 997
565=back 998=back
566 999
567=cut 1000=cut
568 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
569sub set_proxy($) { 1047sub set_proxy($) {
1048 if (length $_[0]) {
570 $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 }
571} 1055}
572 1056
573# initialise proxy from environment 1057# initialise proxy from environment
1058eval {
574set_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 };
575 1117
576=head1 SEE ALSO 1118=head1 SEE ALSO
577 1119
578L<AnyEvent>. 1120L<AnyEvent>.
579 1121
580=head1 AUTHOR 1122=head1 AUTHOR
581 1123
582 Marc Lehmann <schmorp@schmorp.de> 1124 Marc Lehmann <schmorp@schmorp.de>
583 http://home.schmorp.de/ 1125 http://home.schmorp.de/
584 1126
1127With many thanks to Дмитрий Шалашов, who provided countless
1128testcases and bugreports.
1129
585=cut 1130=cut
586 1131
5871 11321
588 1133

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines