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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines