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.71 by root, Fri Dec 31 20:50:58 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
369sub cookie_jar_extract($$$$) {
370 my ($jar, $uscheme, $uhost, $upath) = @_;
371
372 %$jar = () if $jar->{version} != 1;
373
374 my @cookies;
375
376 while (my ($chost, $paths) = each %$jar) {
377 next unless ref $paths;
378
379 if ($chost =~ /^\./) {
380 next unless $chost eq substr $uhost, -length $chost;
381 } elsif ($chost =~ /\./) {
382 next unless $chost eq $uhost;
383 } else {
384 next;
385 }
386
387 while (my ($cpath, $cookies) = each %$paths) {
388 next unless $cpath eq substr $upath, 0, length $cpath;
389
390 while (my ($cookie, $kv) = each %$cookies) {
391 next if $uscheme ne "https" && exists $kv->{secure};
392
393 if (exists $kv->{expires}) {
394 if (AE::now > parse_date ($kv->{expires})) {
395 delete $cookies->{$cookie};
396 next;
397 }
398 }
399
400 my $value = $kv->{value};
401
402 if ($value =~ /[=;,[:space:]]/) {
403 $value =~ s/([\\"])/\\$1/g;
404 $value = "\"$value\"";
405 }
406
407 push @cookies, "$cookie=$value";
408 }
409 }
410 }
411
412 \@cookies
413}
414
415# continue to parse $_ for headers and place them into the arg
416sub parse_hdr() {
417 my %hdr;
418
419 # things seen, not parsed:
420 # p3pP="NON CUR OTPi OUR NOR UNI"
421
422 $hdr{lc $1} .= ",$2"
423 while /\G
424 ([^:\000-\037]*):
425 [\011\040]*
426 ((?: [^\012]+ | \012[\011\040] )*)
427 \012
428 /gxc;
429
430 /\G$/
431 or return;
432
433 # remove the "," prefix we added to all headers above
434 substr $_, 0, 1, ""
435 for values %hdr;
436
437 \%hdr
438}
439
440our $qr_nlnl = qr{(?<![^\012])\015?\012};
441
442our $TLS_CTX_LOW = { cache => 1, sslv2 => 1 };
443our $TLS_CTX_HIGH = { cache => 1, verify => 1, verify_peername => "https" };
444
170sub http_request($$$;@) { 445sub http_request($$@) {
171 my $cb = pop; 446 my $cb = pop;
172 my ($method, $url, %arg) = @_; 447 my ($method, $url, %arg) = @_;
173 448
174 my %hdr; 449 my %hdr;
450
451 $arg{tls_ctx} = $TLS_CTX_LOW if $arg{tls_ctx} eq "low" || !exists $arg{tls_ctx};
452 $arg{tls_ctx} = $TLS_CTX_HIGH if $arg{tls_ctx} eq "high";
175 453
176 $method = uc $method; 454 $method = uc $method;
177 455
178 if (my $hdr = $arg{headers}) { 456 if (my $hdr = $arg{headers}) {
179 while (my ($k, $v) = each %$hdr) { 457 while (my ($k, $v) = each %$hdr) {
180 $hdr{lc $k} = $v; 458 $hdr{lc $k} = $v;
181 } 459 }
182 } 460 }
183 461
462 # pseudo headers for all subsequent responses
463 my @pseudo = (URL => $url);
464 push @pseudo, Redirect => delete $arg{Redirect} if exists $arg{Redirect};
465
184 my $recurse = exists $arg{recurse} ? $arg{recurse} : $MAX_RECURSE; 466 my $recurse = exists $arg{recurse} ? delete $arg{recurse} : $MAX_RECURSE;
185 467
186 return $cb->(undef, { Status => 599, Reason => "recursion limit reached" }) 468 return $cb->(undef, { @pseudo, Status => 599, Reason => "Too many redirections" })
187 if $recurse < 0; 469 if $recurse < 0;
188 470
189 my $proxy = $arg{proxy} || $PROXY; 471 my $proxy = $arg{proxy} || $PROXY;
190 my $timeout = $arg{timeout} || $TIMEOUT; 472 my $timeout = $arg{timeout} || $TIMEOUT;
191 473
192 $hdr{"user-agent"} ||= $USERAGENT;
193
194 my ($scheme, $authority, $upath, $query, $fragment) = 474 my ($uscheme, $uauthority, $upath, $query, $fragment) =
195 $url =~ m|(?:([^:/?#]+):)?(?://([^/?#]*))?([^?#]*)(?:\?([^#]*))?(?:#(.*))?|; 475 $url =~ m|(?:([^:/?#]+):)?(?://([^/?#]*))?([^?#]*)(?:(\?[^#]*))?(?:#(.*))?|;
196 476
197 $scheme = lc $scheme; 477 $uscheme = lc $uscheme;
198 478
199 my $uport = $scheme eq "http" ? 80 479 my $uport = $uscheme eq "http" ? 80
200 : $scheme eq "https" ? 443 480 : $uscheme eq "https" ? 443
201 : return $cb->(undef, { Status => 599, Reason => "only http and https URL schemes supported" }); 481 : return $cb->(undef, { @pseudo, Status => 599, Reason => "Only http and https URL schemes supported" });
202 482
203 $authority =~ /^(?: .*\@ )? ([^\@:]+) (?: : (\d+) )?$/x 483 $uauthority =~ /^(?: .*\@ )? ([^\@:]+) (?: : (\d+) )?$/x
204 or return $cb->(undef, { Status => 599, Reason => "unparsable URL" }); 484 or return $cb->(undef, { @pseudo, Status => 599, Reason => "Unparsable URL" });
205 485
206 my $uhost = $1; 486 my $uhost = $1;
207 $uport = $2 if defined $2; 487 $uport = $2 if defined $2;
208 488
489 $hdr{host} = defined $2 ? "$uhost:$2" : "$uhost"
490 unless exists $hdr{host};
491
209 $uhost =~ s/^\[(.*)\]$/$1/; 492 $uhost =~ s/^\[(.*)\]$/$1/;
210 $upath .= "?$query" if length $query; 493 $upath .= $query if length $query;
211 494
212 $upath =~ s%^/?%/%; 495 $upath =~ s%^/?%/%;
213 496
214 # cookie processing 497 # cookie processing
215 if (my $jar = $arg{cookie_jar}) { 498 if (my $jar = $arg{cookie_jar}) {
216 %$jar = () if $jar->{version} < 1; 499 my $cookies = cookie_jar_extract $jar, $uscheme, $uhost, $upath;
217 500
218 my @cookie;
219
220 while (my ($chost, $v) = each %$jar) {
221 next unless $chost eq substr $uhost, -length $chost;
222 next unless $chost =~ /^\./;
223
224 while (my ($cpath, $v) = each %$v) {
225 next unless $cpath eq substr $upath, 0, length $cpath;
226
227 while (my ($k, $v) = each %$v) {
228 next if $scheme ne "https" && exists $v->{secure};
229 push @cookie, "$k=$v->{value}";
230 }
231 }
232 }
233
234 $hdr{cookie} = join "; ", @cookie 501 $hdr{cookie} = join "; ", @$cookies
235 if @cookie; 502 if @$cookies;
236 } 503 }
237 504
238 my ($rhost, $rport, $rpath); # request host, port, path 505 my ($rhost, $rport, $rscheme, $rpath); # request host, port, path
239 506
240 if ($proxy) { 507 if ($proxy) {
241 ($rhost, $rport, $scheme) = @$proxy; 508 ($rpath, $rhost, $rport, $rscheme) = ($url, @$proxy);
242 $rpath = $url; 509
510 $rscheme = "http" unless defined $rscheme;
511
512 # don't support https requests over https-proxy transport,
513 # can't be done with tls as spec'ed, unless you double-encrypt.
514 $rscheme = "http" if $uscheme eq "https" && $rscheme eq "https";
243 } else { 515 } else {
244 ($rhost, $rport, $rpath) = ($uhost, $uport, $upath); 516 ($rhost, $rport, $rscheme, $rpath) = ($uhost, $uport, $uscheme, $upath);
245 $hdr{host} = $uhost;
246 } 517 }
247 518
519 # leave out fragment and query string, just a heuristic
520 $hdr{referer} = "$uscheme://$uauthority$upath" unless exists $hdr{referer};
521 $hdr{"user-agent"} = $USERAGENT unless exists $hdr{"user-agent"};
522
248 $hdr{"content-length"} = length $arg{body}; 523 $hdr{"content-length"} = length $arg{body}
524 if length $arg{body} || $method ne "GET";
249 525
250 my %state; 526 $hdr{connection} = "close TE"; #1.1
527 $hdr{te} = "trailers" unless exists $hdr{te}; #1.1
251 528
252 $state{connect_guard} = AnyEvent::Socket::tcp_connect $rhost, $rport, sub { 529 my %state = (connect_guard => 1);
530
531 _get_slot $uhost, sub {
532 $state{slot_guard} = shift;
533
534 return unless $state{connect_guard};
535
536 my $connect_cb = sub {
253 $state{fh} = shift 537 $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 } 538 or do {
321 539 my $err = "$!";
322 substr $_, 0, 1, ""
323 for values %hdr;
324
325 my $finish = sub {
326 %state = (); 540 %state = ();
541 return $cb->(undef, { @pseudo, Status => 599, Reason => $err });
542 };
327 543
328 # set-cookie processing 544 pop; # free memory, save a tree
329 if ($arg{cookie_jar} && exists $hdr{"set-cookie"}) { 545
330 for (split /\x00/, $hdr{"set-cookie"}) { 546 return unless delete $state{connect_guard};
331 my ($cookie, @arg) = split /;\s*/; 547
332 my ($name, $value) = split /=/, $cookie, 2; 548 # get handle
333 my %kv = (value => $value, map { split /=/, $_, 2 } @arg); 549 $state{handle} = new AnyEvent::Handle
334 550 fh => $state{fh},
335 my $cdom = (delete $kv{domain}) || $uhost; 551 peername => $rhost,
336 my $cpath = (delete $kv{path}) || "/"; 552 tls_ctx => $arg{tls_ctx},
337 553 # these need to be reconfigured on keepalive handles
338 $cdom =~ s/^.?/./; # make sure it starts with a "." 554 timeout => $timeout,
339 555 on_error => sub {
340 my $ndots = $cdom =~ y/.//; 556 %state = ();
341 next if $ndots < ($cdom =~ /[^.]{3}$/ ? 2 : 3); 557 $cb->(undef, { @pseudo, Status => 599, Reason => $_[2] });
342 558 },
559 on_eof => sub {
560 %state = ();
561 $cb->(undef, { @pseudo, Status => 599, Reason => "Unexpected end-of-file" });
562 },
563 ;
564
565 # limit the number of persistent connections
566 # keepalive not yet supported
567# if ($KA_COUNT{$_[1]} < $MAX_PERSISTENT_PER_HOST) {
568# ++$KA_COUNT{$_[1]};
569# $state{handle}{ka_count_guard} = AnyEvent::Util::guard {
570# --$KA_COUNT{$_[1]}
571# };
572# $hdr{connection} = "keep-alive";
573# }
574
575 $state{handle}->starttls ("connect") if $rscheme eq "https";
576
577 # handle actual, non-tunneled, request
578 my $handle_actual_request = sub {
579 $state{handle}->starttls ("connect") if $uscheme eq "https" && !exists $state{handle}{tls};
580
581 # send request
582 $state{handle}->push_write (
583 "$method $rpath HTTP/1.1\015\012"
584 . (join "", map "\u$_: $hdr{$_}\015\012", grep defined $hdr{$_}, keys %hdr)
585 . "\015\012"
586 . (delete $arg{body})
587 );
588
589 # return if error occured during push_write()
590 return unless %state;
591
592 %hdr = (); # reduce memory usage, save a kitten, also make it possible to re-use
593
594 # status line and headers
595 $state{read_response} = sub {
596 for ("$_[1]") {
597 y/\015//d; # weed out any \015, as they show up in the weirdest of places.
598
599 /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\012]*) )? \012/igxc
600 or return (%state = (), $cb->(undef, { @pseudo, Status => 599, Reason => "Invalid server response" }));
601
602 # 100 Continue handling
603 # should not happen as we don't send expect: 100-continue,
604 # but we handle it just in case.
605 # since we send the request body regardless, if we get an error
606 # we are out of-sync, which we currently do NOT handle correctly.
607 return $state{handle}->push_read (line => $qr_nlnl, $state{read_response})
608 if $2 eq 100;
609
610 push @pseudo,
611 HTTPVersion => $1,
612 Status => $2,
613 Reason => $3,
614 ;
615
616 my $hdr = parse_hdr
617 or return (%state = (), $cb->(undef, { @pseudo, Status => 599, Reason => "Garbled response headers" }));
618
619 %hdr = (%$hdr, @pseudo);
620 }
621
622 # redirect handling
623 # microsoft and other shitheads don't give a shit for following standards,
624 # try to support some common forms of broken Location headers.
625 if ($hdr{location} !~ /^(?: $ | [^:\/?\#]+ : )/x) {
626 $hdr{location} =~ s/^\.\/+//;
627
628 my $url = "$rscheme://$uhost:$uport";
629
630 unless ($hdr{location} =~ s/^\///) {
631 $url .= $upath;
632 $url =~ s/\/[^\/]*$//;
633 }
634
635 $hdr{location} = "$url/$hdr{location}";
636 }
637
638 my $redirect;
639
640 if ($recurse) {
641 my $status = $hdr{Status};
642
643 # industry standard is to redirect POST as GET for
644 # 301, 302 and 303, in contrast to http/1.0 and 1.1.
645 # also, the UA should ask the user for 301 and 307 and POST,
646 # industry standard seems to be to simply follow.
647 # we go with the industry standard.
648 if ($status == 301 or $status == 302 or $status == 303) {
649 # HTTP/1.1 is unclear on how to mutate the method
650 $method = "GET" unless $method eq "HEAD";
343 # store it 651 $redirect = 1;
344 $arg{cookie_jar}{version} = 1; 652 } elsif ($status == 307) {
345 $arg{cookie_jar}{$cdom}{$cpath}{$name} = \%kv; 653 $redirect = 1;
346 } 654 }
347 } 655 }
348 656
349 if ($_[1]{Status} =~ /^x30[12]$/ && $recurse) { 657 my $finish = sub { # ($data, $err_status, $err_reason[, $keepalive])
350 # microsoft and other assholes don't give a shit for following standards, 658 my $keepalive = pop;
351 # try to support a common form of broken Location header.
352 $_[1]{location} =~ s%^/%$scheme://$uhost:$uport/%;
353 659
354 http_request ($method, $_[1]{location}, %arg, recurse => $recurse - 1, $cb); 660 $state{handle}->destroy if $state{handle};
661 %state = ();
662
663 if (defined $_[1]) {
664 $hdr{OrigStatus} = $hdr{Status}; $hdr{Status} = $_[1];
665 $hdr{OrigReason} = $hdr{Reason}; $hdr{Reason} = $_[2];
666 }
667
668 # set-cookie processing
669 if ($arg{cookie_jar}) {
670 for ($hdr{"set-cookie"}) {
671 # parse NAME=VALUE
672 my @kv;
673
674 while (
675 m{
676 \G\s*
677 (?:
678 expires \s*=\s* ([A-Z][a-z][a-z],\ [^,;]+)
679 | ([^=;,[:space:]]+) \s*=\s* (?: "((?:[^\\"]+|\\.)*)" | ([^=;,[:space:]]*) )
680 )
681 }gcxsi
682 ) {
683 my $name = $2;
684 my $value = $4;
685
686 unless (defined $name) {
687 # expires
688 $name = "expires";
689 $value = $1;
690 } elsif (!defined $value) {
691 # quoted
692 $value = $3;
693 $value =~ s/\\(.)/$1/gs;
694 }
695
696 push @kv, lc $name, $value;
697
698 last unless /\G\s*;/gc;
699 }
700
701 last unless @kv;
702
703 my $name = shift @kv;
704 my %kv = (value => shift @kv, @kv);
705
706 $kv{expires} ||= format_date (AE::now + $kv{"max-age"})
707 if exists $kv{"max-age"};
708
709 my $cdom;
710 my $cpath = (delete $kv{path}) || "/";
711
712 if (exists $kv{domain}) {
713 $cdom = delete $kv{domain};
714
715 $cdom =~ s/^\.?/./; # make sure it starts with a "."
716
717 next if $cdom =~ /\.$/;
718
719 # this is not rfc-like and not netscape-like. go figure.
720 my $ndots = $cdom =~ y/.//;
721 next if $ndots < ($cdom =~ /\.[^.][^.]\.[^.][^.]$/ ? 3 : 2);
722 } else {
723 $cdom = $uhost;
724 }
725
726 # store it
727 $arg{cookie_jar}{version} = 1;
728 $arg{cookie_jar}{$cdom}{$cpath}{$name} = \%kv;
729
730 redo if /\G\s*,/gc;
731 }
732 }
733
734 if ($redirect && exists $hdr{location}) {
735 # we ignore any errors, as it is very common to receive
736 # Content-Length != 0 but no actual body
737 # we also access %hdr, as $_[1] might be an erro
738 http_request (
739 $method => $hdr{location},
740 %arg,
741 recurse => $recurse - 1,
742 Redirect => [$_[0], \%hdr],
743 $cb);
744 } else {
745 $cb->($_[0], \%hdr);
746 }
747 };
748
749 my $len = $hdr{"content-length"};
750
751 if (!$redirect && $arg{on_header} && !$arg{on_header}(\%hdr)) {
752 $finish->(undef, 598 => "Request cancelled by on_header");
753 } elsif (
754 $hdr{Status} =~ /^(?:1..|204|205|304)$/
755 or $method eq "HEAD"
756 or (defined $len && !$len)
757 ) {
758 # no body
759 $finish->("", undef, undef, 1);
355 } else { 760 } else {
356 $cb->($_[0], $_[1]); 761 # body handling, many different code paths
762 # - no body expected
763 # - want_body_handle
764 # - te chunked
765 # - 2x length known (with or without on_body)
766 # - 2x length not known (with or without on_body)
767 if (!$redirect && $arg{want_body_handle}) {
768 $_[0]->on_eof (undef);
769 $_[0]->on_error (undef);
770 $_[0]->on_read (undef);
771
772 $finish->(delete $state{handle});
773
774 } elsif ($hdr{"transfer-encoding"} =~ /\bchunked\b/i) {
775 my $cl = 0;
776 my $body = undef;
777 my $on_body = $arg{on_body} || sub { $body .= shift; 1 };
778
779 $_[0]->on_error (sub { $finish->(undef, 599 => $_[2]) });
780
781 my $read_chunk; $read_chunk = sub {
782 $_[1] =~ /^([0-9a-fA-F]+)/
783 or $finish->(undef, 599 => "Garbled chunked transfer encoding");
784
785 my $len = hex $1;
786
787 if ($len) {
788 $cl += $len;
789
790 $_[0]->push_read (chunk => $len, sub {
791 $on_body->($_[1], \%hdr)
792 or return $finish->(undef, 598 => "Request cancelled by on_body");
793
794 $_[0]->push_read (line => sub {
795 length $_[1]
796 and return $finish->(undef, 599 => "Garbled chunked transfer encoding");
797 $_[0]->push_read (line => $read_chunk);
798 });
799 });
800 } else {
801 $hdr{"content-length"} ||= $cl;
802
803 $_[0]->push_read (line => $qr_nlnl, sub {
804 if (length $_[1]) {
805 for ("$_[1]") {
806 y/\015//d; # weed out any \015, as they show up in the weirdest of places.
807
808 my $hdr = parse_hdr
809 or return $finish->(undef, 599 => "Garbled response trailers");
810
811 %hdr = (%hdr, %$hdr);
812 }
813 }
814
815 $finish->($body, undef, undef, 1);
816 });
817 }
818 };
819
820 $_[0]->push_read (line => $read_chunk);
821
822 } elsif ($arg{on_body}) {
823 $_[0]->on_error (sub { $finish->(undef, 599 => $_[2]) });
824
825 if ($len) {
826 $_[0]->on_read (sub {
827 $len -= length $_[0]{rbuf};
828
829 $arg{on_body}(delete $_[0]{rbuf}, \%hdr)
830 or return $finish->(undef, 598 => "Request cancelled by on_body");
831
832 $len > 0
833 or $finish->("", undef, undef, 1);
834 });
835 } else {
836 $_[0]->on_eof (sub {
837 $finish->("");
838 });
839 $_[0]->on_read (sub {
840 $arg{on_body}(delete $_[0]{rbuf}, \%hdr)
841 or $finish->(undef, 598 => "Request cancelled by on_body");
842 });
843 }
844 } else {
845 $_[0]->on_eof (undef);
846
847 if ($len) {
848 $_[0]->on_error (sub { $finish->(undef, 599 => $_[2]) });
849 $_[0]->on_read (sub {
850 $finish->((substr delete $_[0]{rbuf}, 0, $len, ""), undef, undef, 1)
851 if $len <= length $_[0]{rbuf};
852 });
853 } else {
854 $_[0]->on_error (sub {
855 ($! == Errno::EPIPE || !$!)
856 ? $finish->(delete $_[0]{rbuf})
857 : $finish->(undef, 599 => $_[2]);
858 });
859 $_[0]->on_read (sub { });
860 }
861 }
357 } 862 }
358 }; 863 };
359 864
360 if ($hdr{Status} =~ /^(?:1..|204|304)$/ or $method eq "HEAD") { 865 $state{handle}->push_read (line => $qr_nlnl, $state{read_response});
361 $finish->(undef, \%hdr); 866 };
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 867
370 $finish->($_[1], \%hdr); 868 # now handle proxy-CONNECT method
371 }); 869 if ($proxy && $uscheme eq "https") {
870 # oh dear, we have to wrap it into a connect request
871
872 # maybe re-use $uauthority with patched port?
873 $state{handle}->push_write ("CONNECT $uhost:$uport HTTP/1.0\015\012Host: $uhost\015\012\015\012");
874 $state{handle}->push_read (line => $qr_nlnl, sub {
875 $_[1] =~ /^HTTP\/([0-9\.]+) \s+ ([0-9]{3}) (?: \s+ ([^\015\012]*) )?/ix
876 or return (%state = (), $cb->(undef, { @pseudo, Status => 599, Reason => "Invalid proxy connect response ($_[1])" }));
877
878 if ($2 == 200) {
879 $rpath = $upath;
880 &$handle_actual_request;
372 } else { 881 } 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 }); 882 %state = ();
378 $_[0]->on_eof (undef); 883 $cb->(undef, { @pseudo, Status => $2, Reason => $3 });
379 $_[0]->on_read (sub { });
380 } 884 }
381 } 885 });
886 } else {
887 &$handle_actual_request;
382 }); 888 }
383 }); 889 };
384 }, sub { 890
385 $timeout 891 my $tcp_connect = $arg{tcp_connect}
892 || do { require AnyEvent::Socket; \&AnyEvent::Socket::tcp_connect };
893
894 $state{connect_guard} = $tcp_connect->($rhost, $rport, $connect_cb, $arg{on_prepare} || sub { $timeout });
895
386 }; 896 };
387 897
388 defined wantarray && AnyEvent::Util::guard { %state = () } 898 defined wantarray && AnyEvent::Util::guard { %state = () }
389} 899}
390 900
391sub http_get($$;@) { 901sub http_get($@) {
392 unshift @_, "GET"; 902 unshift @_, "GET";
393 &http_request 903 &http_request
394} 904}
395 905
396sub http_head($$;@) { 906sub http_head($@) {
397 unshift @_, "HEAD"; 907 unshift @_, "HEAD";
398 &http_request 908 &http_request
399} 909}
400 910
401sub http_post($$$;@) { 911sub http_post($$@) {
912 my $url = shift;
402 unshift @_, "POST", "body"; 913 unshift @_, "POST", $url, "body";
403 &http_request 914 &http_request
404} 915}
405 916
406=back 917=back
407 918
919=head2 DNS CACHING
920
921AnyEvent::HTTP uses the AnyEvent::Socket::tcp_connect function for
922the actual connection, which in turn uses AnyEvent::DNS to resolve
923hostnames. The latter is a simple stub resolver and does no caching
924on its own. If you want DNS caching, you currently have to provide
925your own default resolver (by storing a suitable resolver object in
926C<$AnyEvent::DNS::RESOLVER>).
927
408=head2 GLOBAL FUNCTIONS AND VARIABLES 928=head2 GLOBAL FUNCTIONS AND VARIABLES
409 929
410=over 4 930=over 4
411 931
412=item AnyEvent::HTTP::set_proxy "proxy-url" 932=item AnyEvent::HTTP::set_proxy "proxy-url"
413 933
414Sets the default proxy server to use. The proxy-url must begin with a 934Sets the default proxy server to use. The proxy-url must begin with a
415string of the form C<http://host:port> (optionally C<https:...>). 935string of the form C<http://host:port> (optionally C<https:...>), croaks
936otherwise.
937
938To clear an already-set proxy, use C<undef>.
939
940=item $date = AnyEvent::HTTP::format_date $timestamp
941
942Takes a POSIX timestamp (seconds since the epoch) and formats it as a HTTP
943Date (RFC 2616).
944
945=item $timestamp = AnyEvent::HTTP::parse_date $date
946
947Takes a HTTP Date (RFC 2616) or a Cookie date (netscape cookie spec) and
948returns the corresponding POSIX timestamp, or C<undef> if the date cannot
949be parsed.
416 950
417=item $AnyEvent::HTTP::MAX_RECURSE 951=item $AnyEvent::HTTP::MAX_RECURSE
418 952
419The default value for the C<recurse> request parameter (default: C<10>). 953The default value for the C<recurse> request parameter (default: C<10>).
420 954
421=item $AnyEvent::HTTP::USERAGENT 955=item $AnyEvent::HTTP::USERAGENT
422 956
423The default value for the C<User-Agent> header (the default is 957The 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)>). 958C<Mozilla/5.0 (compatible; U; AnyEvent-HTTP/$VERSION; +http://software.schmorp.de/pkg/AnyEvent)>).
425 959
426=item $AnyEvent::HTTP::MAX_PERSISTENT 960=item $AnyEvent::HTTP::MAX_PER_HOST
427 961
428The maximum number of persistent connections to keep open (default: 8). 962The maximum number of concurrent connections to the same host (identified
963by the hostname). If the limit is exceeded, then the additional requests
964are queued until previous connections are closed.
429 965
430Not implemented currently. 966The default value for this is C<4>, and it is highly advisable to not
967increase it.
431 968
432=item $AnyEvent::HTTP::PERSISTENT_TIMEOUT 969=item $AnyEvent::HTTP::ACTIVE
433 970
434The maximum time to cache a persistent connection, in seconds (default: 2). 971The number of active connections. This is not the number of currently
435 972running requests, but the number of currently open and non-idle TCP
436Not implemented currently. 973connections. This number of can be useful for load-leveling.
437 974
438=back 975=back
439 976
440=cut 977=cut
441 978
979our @month = qw(Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec);
980our @weekday = qw(Sun Mon Tue Wed Thu Fri Sat);
981
982sub format_date($) {
983 my ($time) = @_;
984
985 # RFC 822/1123 format
986 my ($S, $M, $H, $mday, $mon, $year, $wday, $yday, undef) = gmtime $time;
987
988 sprintf "%s, %02d %s %04d %02d:%02d:%02d GMT",
989 $weekday[$wday], $mday, $month[$mon], $year + 1900,
990 $H, $M, $S;
991}
992
993sub parse_date($) {
994 my ($date) = @_;
995
996 my ($d, $m, $y, $H, $M, $S);
997
998 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$/) {
999 # RFC 822/1123, required by RFC 2616 (with " ")
1000 # cookie dates (with "-")
1001
1002 ($d, $m, $y, $H, $M, $S) = ($1, $2, $3, $4, $5, $6);
1003
1004 } 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$/) {
1005 # RFC 850
1006 ($d, $m, $y, $H, $M, $S) = ($1, $2, $3 < 69 ? $3 + 2000 : $3 + 1900, $4, $5, $6);
1007
1008 } 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])$/) {
1009 # ISO C's asctime
1010 ($d, $m, $y, $H, $M, $S) = ($2, $1, $6, $3, $4, $5);
1011 }
1012 # other formats fail in the loop below
1013
1014 for (0..11) {
1015 if ($m eq $month[$_]) {
1016 require Time::Local;
1017 return Time::Local::timegm ($S, $M, $H, $d, $_, $y);
1018 }
1019 }
1020
1021 undef
1022}
1023
442sub set_proxy($) { 1024sub set_proxy($) {
1025 if (length $_[0]) {
443 $PROXY = [$2, $3 || 3128, $1] if $_[0] =~ m%^(https?):// ([^:/]+) (?: : (\d*) )?%ix; 1026 $_[0] =~ m%^(https?):// ([^:/]+) (?: : (\d*) )?%ix
1027 or Carp::croak "$_[0]: invalid proxy URL";
1028 $PROXY = [$2, $3 || 3128, $1]
1029 } else {
1030 undef $PROXY;
1031 }
444} 1032}
445 1033
446# initialise proxy from environment 1034# initialise proxy from environment
1035eval {
447set_proxy $ENV{http_proxy}; 1036 set_proxy $ENV{http_proxy};
1037};
1038
1039=head2 SOCKS PROXIES
1040
1041Socks proxies are not directly supported by AnyEvent::HTTP. You can
1042compile your perl to support socks, or use an external program such as
1043F<socksify> (dante) or F<tsocks> to make your program use a socks proxy
1044transparently.
1045
1046Alternatively, for AnyEvent::HTTP only, you can use your own
1047C<tcp_connect> function that does the proxy handshake - here is an example
1048that works with socks4a proxies:
1049
1050 use Errno;
1051 use AnyEvent::Util;
1052 use AnyEvent::Socket;
1053 use AnyEvent::Handle;
1054
1055 # host, port and username of/for your socks4a proxy
1056 my $socks_host = "10.0.0.23";
1057 my $socks_port = 9050;
1058 my $socks_user = "";
1059
1060 sub socks4a_connect {
1061 my ($host, $port, $connect_cb, $prepare_cb) = @_;
1062
1063 my $hdl = new AnyEvent::Handle
1064 connect => [$socks_host, $socks_port],
1065 on_prepare => sub { $prepare_cb->($_[0]{fh}) },
1066 on_error => sub { $connect_cb->() },
1067 ;
1068
1069 $hdl->push_write (pack "CCnNZ*Z*", 4, 1, $port, 1, $socks_user, $host);
1070
1071 $hdl->push_read (chunk => 8, sub {
1072 my ($hdl, $chunk) = @_;
1073 my ($status, $port, $ipn) = unpack "xCna4", $chunk;
1074
1075 if ($status == 0x5a) {
1076 $connect_cb->($hdl->{fh}, (format_address $ipn) . ":$port");
1077 } else {
1078 $! = Errno::ENXIO; $connect_cb->();
1079 }
1080 });
1081
1082 $hdl
1083 }
1084
1085Use C<socks4a_connect> instead of C<tcp_connect> when doing C<http_request>s,
1086possibly after switching off other proxy types:
1087
1088 AnyEvent::HTTP::set_proxy undef; # usually you do not want other proxies
1089
1090 http_get 'http://www.google.com', tcp_connect => \&socks4a_connect, sub {
1091 my ($data, $headers) = @_;
1092 ...
1093 };
448 1094
449=head1 SEE ALSO 1095=head1 SEE ALSO
450 1096
451L<AnyEvent>. 1097L<AnyEvent>.
452 1098
453=head1 AUTHOR 1099=head1 AUTHOR
454 1100
455 Marc Lehmann <schmorp@schmorp.de> 1101 Marc Lehmann <schmorp@schmorp.de>
456 http://home.schmorp.de/ 1102 http://home.schmorp.de/
1103
1104With many thanks to Дмитрий Шалашов, who provided countless
1105testcases and bugreports.
457 1106
458=cut 1107=cut
459 1108
4601 11091
461 1110

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines