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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines