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.13 by root, Thu Jun 5 16:43:45 2008 UTC vs.
Revision 1.69 by root, Fri Dec 31 19:32:47 2010 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines