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.24 by root, Wed Jul 2 01:30:33 2008 UTC vs.
Revision 1.74 by root, Fri Dec 31 22:40:54 2010 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines